POST /custom-field-variants.json

application/json

Body Required

customFieldId integer(int32) Required

Custom field
object object | null | array | boolean | integer | number | string

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null

Object

Object

Object

Object

Object

Object
source string | null Required

Source

Values are manual, inventory_feed, or channel. Default value is manual.
value string | null

Value
values array[string] | null

Values
variantId integer(int32) Required

Variant

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- createdAt string(date-time)
  
  Created at
- customFieldId integer(int32) Required
  
  Custom field
- id integer(int32)
  
  Id
- object object | null | array | boolean | integer | number | string
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
  
  Object
  
  Object
  
  Object
  
  Object
  
  Object
  
  Object
- source string | null Required
  
  Source
  
  Values are manual, inventory_feed, or channel. Default value is manual.
- updatedAt string(date-time)
  
  Updated at
- value string | null
  
  Value
- values array[string] | null
  
  Values
- variantId integer(int32) Required
  
  Variant

POST /custom-field-variants.json

curl \
 -X POST http://api.example.com/v1/custom-field-variants.json \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"customFieldId":42,"object":{},"source":"manual","value":"string","values":["string"],"variantId":42}'

Request example

{
  "customFieldId": 42,
  "object": {},
  "source": "manual",
  "value": "string",
  "values": [
    "string"
  ],
  "variantId": 42
}

Response examples (200)

{
  "createdAt": "2024-05-04T09:42:00+00:00",
  "customFieldId": 42,
  "id": 42,
  "object": {},
  "source": "manual",
  "updatedAt": "2024-05-04T09:42:00+00:00",
  "value": "string",
  "values": [
    "string"
  ],
  "variantId": 42
}

POST /custom-field-variants.json

Body Required

object object | null | array | boolean | integer | number | string

Responses

object object | null | array | boolean | integer | number | string