Catalog
- GETRetrieve all products
- POSTCreate product
- GETRetrieve skus
- GETRetrieve product details
- PUTUpdate product details
- DELDelete product
- GETRetrieve product variants
- POSTCreate variant
- POSTUpdate variants in bulk
- GETRetrieve a variant details
- PUTUpdate a variant
- DELDelete a variant
- GETRetrieve product inventory
- POSTUpdate product inventory
- GETRetrieve product inventory activities
- PUTUpdate product inventory activities
- POSTCreate product inventory activities
- GETRetrieve product reviews
- GETRetrieve product review
- PUTUpdate product review
- DELDelete product review
- GETRetrieve all categories
- POSTCreate category
- GETRetrieve category
- PUTUpdate category
- DELDelete category
- GETRetrieve all attributes
- POSTCreate attribute
- GETRetrieve attribute
- PUTUpdate attribute
- DELDelete attribute
- POSTAdd product pricing
- PUTUpdate product pricing
- DELDelete product pricing
- POSTAdd product image
- PUTUpdate product image
- DELDelete product image
- GETRetrive sku detail
Auth
- PUTActivate user account
- PUTDeactivate user account
- GETCheck domain availability
- GETRetrieve all roles
- POSTCreate new role
- PUTUpdate role
- DELDelete role
- GETRetrieve all permissions of a role
- POSTAdd permission to role
- DELRemove permission from role
- GETRetrieve all members
- POSTCreate new member
- GETRetrieve member detail
- PUTUpdate member details
- DELDelete member
- GETRetrieve all roles of a member
- POSTAssigne role to member
- DELRemove role from member
Coupons & promotions API
- GETList all coupons
- POSTCreate coupon
- GETRetrieve coupon details
- PUTUpdate coupon
- DELDelete coupon
- GETList all coupon codes
- POSTAdd coupon code
- GETList all coupon customers
- GETRetrieve coupon usage
- GETList all promotions
- POSTCreate promotion
- GETRetrieve promotion details
- PUTUpdate promotion
- DELDelete promotion
- GETList all promotion usage
- GETList all promotion customers
Warehouse
Orders API
Shipping API
Customers API
Segments API
Payments API
Media Gallery API
Catalog
Update a variant
PUT
/
catalog
/
products
/
{id}
/
variants
/
{variant-id}
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
id
string
*
id
Required
string
product id
variant-id
string
*
variant-id
Required
string
variant id
object
name
string
name
string
variant name
active
boolean
active
boolean
stock_available
boolean
stock_available
boolean
short_description
string
short_description
string
description
string
description
string
metadata
array
metadata
array
associated_options
object
associated_options
object
sku
string
sku
string
variant sku
pricing
array
pricing
array
images
array
images
array
shipping
object
shipping
object
is_free_shipping
boolean
is_free_shipping
boolean
is_fixed_cost_shipping
boolean
is_fixed_cost_shipping
boolean
fixed_cost_shipping_price
number
fixed_cost_shipping_price
number
is_shipping_price_include_tax
boolean
is_shipping_price_include_tax
boolean
availability_description
string
availability_description
string
ships_internationally
boolean
ships_internationally
boolean
mid_code
string
mid_code
string
country_of_origin
string
country_of_origin
string
packaging
object
packaging
object
pack_width
number
pack_width
number
pack_height
number
pack_height
number
pack_length
number
pack_length
number
pack_dry_weight
number
pack_dry_weight
number
units_per_pack
integer
units_per_pack
integer
vertical_rotation
boolean
vertical_rotation
boolean
shipper_width
number
shipper_width
number
shipper_height
number
shipper_height
number
shipper_length
number
shipper_length
number
shipper_dry_weight
number
shipper_dry_weight
number
units_per_shipper
integer
units_per_shipper
integer
promotions
array
promotions
array
subscriptions
array
subscriptions
array
sales_channels
array
sales_channels
array
seo
object
seo
object
meta_title
string
meta_title
string
meta_description
string
meta_description
string
meta_keywords
array
meta_keywords
array
slug
string
slug
string
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
id
string
requiredproduct id
variant-id
string
requiredvariant id
Body
application/json
name
string
variant name
active
boolean
stock_available
boolean
short_description
string
description
string
metadata
object[]
associated_options
object
sku
string
variant sku
pricing
object[]
images
object[]
shipping
object
packaging
object
promotions
object[]
subscriptions
object[]
sales_channels
object[]
seo
object
Response
200 - application/json
message
string
success
boolean
content
object