Skip to main content
PATCH
Update attributes of a variant

Authorizations

Authorization
string
header
required

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 string length: 200
Example:

"T-Shirt, Blue, L"

parent_identifier
string | null

Parent identifier of variant

Maximum string length: 100
Example:

"1000-BL"

parent_name
string | null

Parent name of variant

Maximum string length: 200
Example:

"T-Shirt, Blue"

brand
object
identifier
string | null

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

Maximum string length: 128
Example:

"1000-BL-L"

upc
string

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

Maximum string length: 64
Example:

"9119119111"

color
string | null

Variant color

Maximum string length: 128
Example:

"Blue"

style
string | null

Variant style

Maximum string length: 128
Example:

"print"

size
string | null

Variant size

Maximum string length: 128
Example:

"Medium"

active_permit
object
inventory
object
proposal_variant
object
retailer_categories
object

Response

200 - application/json

OK

id
integer
read-only

Variant ID

Example:

100024

name
string | null

Variant name

Maximum string length: 200
Example:

"T-Shirt, Blue, L"

brand_identifier
string
read-only

Brand identifier

Minimum string length: 1
Example:

"1000-BL-L"

parent_identifier
string | null

Parent identifier of variant

Maximum string length: 100
Example:

"1000-BL"

parent_name
string | null

Parent name of variant

Maximum string length: 200
Example:

"T-Shirt, Blue"

attributes
object[]
read-only
brand
object
identifier
string | null

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

Maximum string length: 128
Example:

"1000-BL-L"

product_id
string
read-only

Product ID

Example:

"4511"

cartons
object[]
read-only
upc
string

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

Maximum string length: 64
Example:

"9119119111"

color
string | null

Variant color

Maximum string length: 128
Example:

"Blue"

style
string | null

Variant style

Maximum string length: 128
Example:

"print"

size
string | null

Variant size

Maximum string length: 128
Example:

"Medium"

active_permit
object
permits
object[]
read-only
permits_count
integer
read-only

Count of permits

Example:

1

inventory_policy
string
read-only

Inventory policy

Example:

"Managed"

inventory
object
media
object[]
read-only
ruleset_variants
object[]
read-only
ruleset_variant_summary
string
read-only

Summary of ruleset variant

is_compatible
string
read-only

true: variant is compatible
false: variant is not compatible

Example:

true

proposal_variant
object
retailer_identifiers
object[]
read-only
retailer_categories
object