Note: For more details on this endpoint and the other possible filter options it can take, please refer to the API Reference
include
string
default: sku_dimensions
Response default - application/json
ID of the parent Offer that this Sku is a child of.
ID of the Merchant that originated the Sku.
Sale Price of the Sku. This is the actual sale cost when the Sku is purchased.
The base currency of this Sku.
Available options:
PHYSICAL
,
DIGITAL
,
VIRTUAL
,
BUNDLED
The ID of the Sku in the merchants external store.
Amazon Standard Identification Number
International Standard Book Number
Is the Sku in stock in the merchants external store.
The total quantity of this Sku available for purchase.
Is the Sku's inventory tracked in the merchants system. Untracked inventory can be oversold even when the available quantity is 0.
Retail Price of the Sku. This is the recommended or common price of the Sku and is typically not what the customer will be charged..
The presented currency of this Sku.
Available options:
DEFAULT
,
APPAREL
,
SERVICE
Available options:
OFFER
,
SKU
The ID of the media in the merchants store.
The unique ID of hosted cloud entity. Only present on media from self-hosted platforms.
The URL that should be used when displaying media within your app. For cloud hosted commerce platforms that provide a CDN this will often be the same as the source_url
property. For self-hosted platforms this will typically be a Violet CDN URL.
The original URL from the merchants system.
Available options:
IMAGE
,
VIDEO
albums.media. display_order
The order in which the merchant displayed the media in relation to other media in the same collection.
Text describing the media. This value is sourced from the merchant.
Maximum length: 512
If the media is the primary or default image in the merchants store for an Offer or Sku. This is typically the cover image on a product details page.
albums.primary_media. album_id
albums.primary_media. external_id
The ID of the media in the merchants store.
albums.primary_media. cloud_id
The unique ID of hosted cloud entity. Only present on media from self-hosted platforms.
The URL that should be used when displaying media within your app. For cloud hosted commerce platforms that provide a CDN this will often be the same as the source_url
property. For self-hosted platforms this will typically be a Violet CDN URL.
albums.primary_media. source_url
The original URL from the merchants system.
albums.primary_media. type
Available options:
IMAGE
,
VIDEO
albums.primary_media. display_order
The order in which the merchant displayed the media in relation to other media in the same collection.
albums.primary_media. alt_text
Text describing the media. This value is sourced from the merchant.
Maximum length: 512
albums.primary_media. primary
If the media is the primary or default image in the merchants store for an Offer or Sku. This is typically the cover image on a product details page.
Variant Values that apply to this SKU
Available options:
UNAVAILABLE
,
AVAILABLE
,
DISABLED_UNAVAILABLE
,
DISABLED_AVAILABLE
,
FOR_DELETION
,
ARCHIVED
Date when the Sku was first created in Violet.
Date when the Sku was last updated in Violet.
Individual Sku Dimensions
ID of SKU Dimensions Belong To
Available options:
SKU
,
SHIPPING
Individual Sku Dimensions
shipping_dimensions. sku_id
ID of SKU Dimensions Belong To
shipping_dimensions. weight
shipping_dimensions. height
shipping_dimensions. width
shipping_dimensions. length
Available options:
SKU
,
SHIPPING
The order that the merchant has chosen to display this Sku in relation to other Sku's that are children of the same Offer.