PATCH
/
v1
/
retailers
/
{retailer_pk}
/
variants
/
{id}
/

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer
required

Variant ID

retailer_pk
number
required

Retailer ID

Body

application/json
name
string | null

Variant name

Maximum length: 200
parent_identifier
string | null

Parent identifier of variant

Maximum length: 100
parent_name
string | null

Parent name of variant

Maximum length: 200
brand
object
identifier
string | null

Stock Keeping Unit (SKU), unique identifier of a product

Maximum length: 128
upc
string

Universal product code (UPC) is a 12-digit combination of numbers assigned to each product in your dropshipping store.

Maximum length: 64
color
string | null

Variant color

Maximum length: 128
style
string | null

Variant style

Maximum length: 128
size
string | null

Variant size

Maximum length: 128
active_permit
object
inventory
object
proposal_variant
object
retailer_categories
object

Response

200 - application/json
id
integer

Variant ID

name
string | null

Variant name

Maximum length: 200
brand_identifier
string

Brand identifier

Minimum length: 1
parent_identifier
string | null

Parent identifier of variant

Maximum length: 100
parent_name
string | null

Parent name of variant

Maximum length: 200
attributes
object[]
brand
object
identifier
string | null

Stock Keeping Unit (SKU), unique identifier of a product

Maximum length: 128
product_id
string

Product ID

cartons
object[]
upc
string

Universal product code (UPC) is a 12-digit combination of numbers assigned to each product in your dropshipping store.

Maximum length: 64
color
string | null

Variant color

Maximum length: 128
style
string | null

Variant style

Maximum length: 128
size
string | null

Variant size

Maximum length: 128
active_permit
object
permits
object[]
permits_count
integer

Count of permits

inventory_policy
string

Inventory policy

inventory
object
media
object[]
ruleset_variants
object[]
ruleset_variant_summary
string

Summary of ruleset variant

is_compatible
string

true: variant is compatible <br /> false: variant is not compatible

proposal_variant
object
retailer_identifiers
object[]
retailer_categories
object

Was this page helpful?

List productsGet variants