POST
Update a Product

Authorizations

Authorization
string
header
required

sk_test_ / sk_live_ / rk_test_ / rk_live_ keys

Headers

Shipping-Version
string
Shipping-Account
string

Act on behalf of a connected account (acct_...)

If-Match
string

Product version for optimistic concurrency

Path Parameters

id
string
required

Body

application/json
status
enum<string>
Available options:
active,
archived,
draft
sku
string
title
string
description
string
variant_of
string | null
options
object
category
string
brand
string
material
string
origin_country
string
manufacturer
object
unit_value
object
unit_net_weight
object
unit_gross_weight
object
unit_dimensions
object
hs_codes
object
classification
object | null
compliance
object | null
dangerous_goods
object | null
barcodes
object[]
product_url
string
image_url
string
external_ids
object[]
user_metadata
object

Client-writable. Up to 50 string key/value pairs. Never sent to carriers.

Response

OK

id
string
required

Prefixed prod_

Example:

"prod_1Q2w3E4r"

object
enum<string>
required
Available options:
product
livemode
boolean
required
created
integer<unix-time>
required

Unix timestamp (seconds)

status
enum<string>
required
Available options:
active,
archived,
draft
sku
string
required
updated
integer<unix-time>

Unix timestamp (seconds)

title
string
description
string
variant_of
string | null
options
object
category
string
brand
string
material
string
origin_country
string
manufacturer
object
unit_value
object
unit_net_weight
object
unit_gross_weight
object
unit_dimensions
object
hs_codes
object
classification
object | null
compliance
object | null
dangerous_goods
object | null
barcodes
object[]
product_url
string
image_url
string
external_ids
object[]
restrictions
object[]
version
integer
user_metadata
object

Client-writable. Up to 50 string key/value pairs. Never sent to carriers.

carrier_metadata
object
read-only

Read-only. Carrier-returned data not modelled by the spec (routing codes, internal IDs). Untrusted and unversioned; keys may change with the carrier's API.

system_metadata
object
read-only

Read-only. Implementer provenance. Implementer-specific keys are prefixed x_.