Skip to main content
POST
Create

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
saved_item
object

Response

200 - application/json

Success

id
string | null

The UUID of the specific object.

object
string

A string describing the object type returned.

ad_hoc_amount
integer | null

The amount to use for this item when the associated price is ad_hoc=true.

bundle_component_variants
object

A hash mapping bundle component product UUIDs (keys) to the selected variant UUIDs (values). Picks may be incomplete while saved; every component with variants needs one when the item moves into a checkout.

note
string | null

A custom note for this item.

quantity
integer

The quantity saved. Saving the same product, price, variant and bundle picks again adds to this quantity.

live_mode
boolean

Set to true if this item belongs to a live mode customer.

price

Expandable – The associated price ID.

price_changed
boolean

Set to true when the price has a newer version than the one pinned when the item was saved.

product

Expandable – The associated product ID.

purchasable_status
string

Whether this item can move into a checkout and, if not, why. Possible values are price_missing, price_gone, price_old_version, variant_missing, variant_gone, variant_old_version, out_of_stock, exceeds_purchase_limit, or purchasable. For a bundle, the status of the first blocking component is reported.

saved_list

Expandable – The associated saved list ID.

variant

Expandable – The associated variant ID.

variant_changed
boolean

Set to true when the variant has a newer version than the one pinned when the item was saved.

created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.