The in stock subscription object
A comprehensive list of the in stock subscription resource's attributes and relationships
An in stock subscription object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/in_stock_subscriptions endpoint.
Fields
type
string
in_stock_subscriptions
id
string
The in stock subscription unique identifier
links.self
string
The in stock subscription endpoint URL
attributes.status
string
The subscription status. One of 'active' (default), 'inactive', or 'notified'.
attributes.customer_email
string
The email of the associated customer, replace the relationship.
attributes.sku_code
string
The code of the associated SKU, replace the relationship.
attributes.stock_threshold
integer
The threshold at which to trigger the back in stock notification.
attributes._activate
boolean
Send this attribute if you want to activate an inactive subscription.
attributes._deactivate
boolean
Send this attribute if you want to dactivate an active subscription.
attributes.created_at
datetime
Time at which the resource was created.
attributes.updated_at
datetime
Time at which the resource was last updated.
attributes.reference
string
A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
attributes.reference_origin
string
Any identifier of the third party system that defines the reference code.
attributes.metadata
object
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
relationships.market
object
The associated market.
relationships.customer
object
The associated customer.
relationships.sku
object
The associated SKU.
relationships.events
array
The associated events.
relationships.versions
array
The associated changes.
meta.mode
string
The resource environment (can be one of test or live)
Last updated