Core API
...
Core API Docs
Products
Update a Product Variant
PATCH
PATH PARAMETERS
id
string
*Either the Internal or External ID
HEADER PARAMETERS
Site-Id
string
*Example: jones-climbing
Spark Layer Site ID
BODY PARAMETERS
body
ProductVariant
*product_id
string
Example: pp_123
SparkLayer Parent Product ID
id
string
Example: pv_234
SparkLayer Variant Product ID (always prefixed with pv_)
created_at
string<date-time>
updated_at
string<date-time>
external_id
string
Example: IDV001
External ID (cannot start with pv_ and must be unique)
sku
string
Example: IDV001
SKU
weight_in_grams
number
Product weight in grams
tax_type
number
Tax type ID - to be replaced with a more permanent solution
position
number
Position
cart_image_url
string
to be replaced with a more permanent solution
rrp
ProductVariantRRP[]
RRP price (single item per `currency_code`)
options
ProductVariantOptions[]
Product Options (item per `group`)
status
string<pending | discontinued | suspended | live>
Example: live
Status - only `live` products are available frontend
settings
ProductVariantSettings[]
Variant Settings (item per `customer_group`)
stock
ProductStock-2[]
RESPONSES
200
Successful response
ProductVariant
product_id
string
Example: pp_123
SparkLayer Parent Product ID
id
string
Example: pv_234
SparkLayer Variant Product ID (always prefixed with pv_)
created_at
string<date-time>
updated_at
string<date-time>
external_id
string
Example: IDV001
External ID (cannot start with pv_ and must be unique)
sku
string
Example: IDV001
SKU
weight_in_grams
number
Product weight in grams
tax_type
number
Tax type ID - to be replaced with a more permanent solution
position
number
Position
cart_image_url
string
to be replaced with a more permanent solution
rrp
ProductVariantRRP[]
RRP price (single item per `currency_code`)
options
ProductVariantOptions[]
Product Options (item per `group`)
status
string<pending | discontinued | suspended | live>
Example: live
Status - only `live` products are available frontend
settings
ProductVariantSettings[]
Variant Settings (item per `customer_group`)
stock
ProductStock-2[]
default
Error Response
Updated 18 Sep 2023
Did this page help you?