id
string
required
name
string
required
brand
object
required
subtitle
string | null

A description of this product.

subtitle_short
string | null

An optional one-line description of this product. When provided, it overrides the subtitle when displayed in areas with less space. Not always provided.

recipient_description
string | null

An optional description of this product with custom verbiage for recipients. When provided, it overrides the subtitle for the product when displayed to the recipient. Falls back to the subtitle.

variants_label
string | null

The label for the variants of this product, e.g. "Size" or "Color".

variants_num_selectable
integer | null

The number of variants that can be selected for this product. For example, if this is a t-shirt, then this would be 1, since you can only select one size. If this were a build-a-box of chocolates, this could be 3 if you could select 3 flavor variants.

variants
object[]
required
images
object[]
required
price
integer
required

The price of the product, in cents.

price_is_variable
boolean
required

Whether the price of this product is variable. If true, then the price can be set by the sender.

price_min
integer | null

The minimum price of the product, in cents. Only used if price_is_variable is true.

price_max
integer | null

The maximum price of the product, in cents. Only used if price_is_variable is true.

restricted_states
string[]
required
attributes
object[]

An array of attributes that describe this product.

reserved_options
object | null

For approved API partners only.

ShipmentBrand