The SKU option object
A comprehensive list of the SKU option resource's attributes and relationships
A SKU option object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/sku_options endpoint.
Fields
type
string
sku_options
id
string
The SKU option unique identifier
links.self
string
The SKU option endpoint URL
attributes.name
string
The SKU option's internal name.
attributes.currency_code
string
The international 3-letter currency code as defined by the ISO 4217 standard.
attributes.description
string
An internal description of the SKU option.
attributes.price_amount_cents
integer
The price of this shipping method, in cents.
attributes.price_amount_float
float
The price of this shipping method, float.
attributes.formatted_price_amount
string
The price of this shipping method, formatted.
attributes.delay_hours
integer
The delay time (in hours) that should be added to the delivery lead time when this option is purchased.
attributes.delay_days
integer
The delay time, in days (rounded).
attributes.sku_code_regex
string
The regex that will be evaluated to match the SKU codes, max size is 5000.
attributes._add_tags
string
Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
attributes._remove_tags
string
Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
attributes.created_at
string
Time at which the resource was created.
attributes.updated_at
string
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.attachments
array
The associated attachments.
relationships.events
array
The associated events.
relationships.tags
array
The associated tags. Cannot be passed by sales channels.
relationships.event_stores
array
The associated event stores.
meta.mode
string
The resource environment (can be one of test or live)
Last updated