Get Sku by ID

GET

catalog

skus

{sku_id}

curl --request GET \
  --url https://sandbox-api.violet.io/v1/catalog/skus/{sku_id}

{
  "id": 123,
  "offer_id": 123,
  "merchant_id": 123,
  "external_id": "<string>",
  "name": "<string>",
  "asin": "<string>",
  "gtin": "<string>",
  "upc": "<string>",
  "ean": "<string>",
  "isbn": "<string>",
  "in_stock": true,
  "quantity_available": 123,
  "inventory_tracked": true,
  "sale_price": 123,
  "retail_price": 123,
  "currency": "<string>",
  "presented_currency": "<string>",
  "taxable": true,
  "tax_type": "DEFAULT",
  "albums": [
    {
      "id": 123,
      "parent_id": 123,
      "type": "OFFER",
      "name": "<string>",
      "media": [
        {
          "id": 123,
          "album_id": 123,
          "external_id": "<string>",
          "cloud_id": "<string>",
          "url": "<string>",
          "source_url": "<string>",
          "type": "IMAGE",
          "display_order": 123,
          "alt_text": "<string>",
          "primary": true
        }
      ],
      "primary_media": {
        "id": 123,
        "album_id": 123,
        "external_id": "<string>",
        "cloud_id": "<string>",
        "url": "<string>",
        "source_url": "<string>",
        "type": "IMAGE",
        "display_order": 123,
        "alt_text": "<string>",
        "primary": true
      }
    }
  ],
  "variant_values": [
    {
      "variant": "<string>",
      "value": "<string>"
    }
  ],
  "type": "PHYSICAL",
  "status": "UNAVAILABLE",
  "date_created": "2023-11-07T05:31:56Z",
  "date_last_modified": "2023-11-07T05:31:56Z",
  "sku_dimensions": {
    "sku_id": 123,
    "weight": 123,
    "height": 123,
    "width": 123,
    "length": 123,
    "type": "SKU"
  },
  "shipping_dimensions": {
    "sku_id": 123,
    "weight": 123,
    "height": 123,
    "width": 123,
    "length": 123,
    "type": "SKU"
  },
  "display_order": 123
}

Retrieve information about a specific SKU given the sku_id.

Headers

X-Violet-Token

string

X-Violet-App-Secret

string

X-Violet-App-Id

integer

Path Parameters

sku_id

integer

required

Query Parameters

base_currency

string

default:

USD

include

string

default:

sku_dimensions

use_presentment_currency

boolean

default:

false

Response

default - application/json

default response

Stock Keeping Unit

offer_id

integer

required

ID of the parent Offer that this Sku is a child of.

merchant_id

integer

required

ID of the Merchant that originated the Sku.

name

string

required

Name of the Sku. This often a combination of the Offer name and the Variant Values unique to this Sku.

sale_price

integer

required

Sale Price of the Sku. This is the actual sale cost when the Sku is purchased.

currency

string

required

The base currency of this Sku.

type

enum<string>

required

Available options:

PHYSICAL,

DIGITAL,

VIRTUAL,

BUNDLED

integer

The unique ID of the Sku.

external_id

string

The ID of the Sku in the merchants external store.

asin

string | null

Amazon Standard Identification Number

gtin

string | null

Global Trade Item Number

upc

string | null

Universal Product Code

ean

string | null

European Article Number

isbn

string | null

International Standard Book Number

in_stock

boolean

Is the Sku in stock in the merchants external store.

quantity_available

integer

The total quantity of this Sku available for purchase.

inventory_tracked

boolean

Is the Sku's inventory tracked in the merchants system. Untracked inventory can be oversold even when the available quantity is 0.

retail_price

integer

Retail Price of the Sku. This is often a "Compare-To" or "MSRP" type price and is typically not what the customer will be charged.

presented_currency

string

The presented currency of this Sku.

taxable

boolean

Is the Sku taxable.

tax_type

enum<string>

Type of Tax on this Sku.

Available options:

DEFAULT,

APPAREL,

SERVICE

albums

object[] | null

Sku Albums

Product Image Container

albums.parent_id

integer

required

ID of the parent entity

albums.type

enum<string>

required

Parent Type

Available options:

OFFER,

SKU

albums.id

integer

albums.name

string

Name of Album

albums.media

object[]

Album media

Product and SKU Media

albums.primary_media

object

Product and SKU Media

variant_values

array | null

Variant Values that apply to this SKU

Individual Variation Value for a Sku

status

enum<string>

SKU Status

Available options:

UNAVAILABLE,

AVAILABLE,

DISABLED_UNAVAILABLE,

DISABLED_AVAILABLE,

FOR_DELETION,

ARCHIVED

date_created

string

Date when the Sku was first created in Violet.

date_last_modified

string

Date when the Sku was last updated in Violet.

sku_dimensions

object | null

Individual Sku Dimensions

shipping_dimensions

object | null

Individual Sku Dimensions

display_order

integer

The order that the merchant has chosen to display this Sku in relation to other Sku's that are children of the same Offer.

Was this page helpful?

Search Offers Get Categories

curl --request GET \
  --url https://sandbox-api.violet.io/v1/catalog/skus/{sku_id}

{
  "id": 123,
  "offer_id": 123,
  "merchant_id": 123,
  "external_id": "<string>",
  "name": "<string>",
  "asin": "<string>",
  "gtin": "<string>",
  "upc": "<string>",
  "ean": "<string>",
  "isbn": "<string>",
  "in_stock": true,
  "quantity_available": 123,
  "inventory_tracked": true,
  "sale_price": 123,
  "retail_price": 123,
  "currency": "<string>",
  "presented_currency": "<string>",
  "taxable": true,
  "tax_type": "DEFAULT",
  "albums": [
    {
      "id": 123,
      "parent_id": 123,
      "type": "OFFER",
      "name": "<string>",
      "media": [
        {
          "id": 123,
          "album_id": 123,
          "external_id": "<string>",
          "cloud_id": "<string>",
          "url": "<string>",
          "source_url": "<string>",
          "type": "IMAGE",
          "display_order": 123,
          "alt_text": "<string>",
          "primary": true
        }
      ],
      "primary_media": {
        "id": 123,
        "album_id": 123,
        "external_id": "<string>",
        "cloud_id": "<string>",
        "url": "<string>",
        "source_url": "<string>",
        "type": "IMAGE",
        "display_order": 123,
        "alt_text": "<string>",
        "primary": true
      }
    }
  ],
  "variant_values": [
    {
      "variant": "<string>",
      "value": "<string>"
    }
  ],
  "type": "PHYSICAL",
  "status": "UNAVAILABLE",
  "date_created": "2023-11-07T05:31:56Z",
  "date_last_modified": "2023-11-07T05:31:56Z",
  "sku_dimensions": {
    "sku_id": 123,
    "weight": 123,
    "height": 123,
    "width": 123,
    "length": 123,
    "type": "SKU"
  },
  "shipping_dimensions": {
    "sku_id": 123,
    "weight": 123,
    "height": 123,
    "width": 123,
    "length": 123,
    "type": "SKU"
  },
  "display_order": 123
}

Overview

Login

Merchants

Catalog

Orders & Checkout

Events

Apps

Operations

Relay

Ecom Syncs

Headers

Path Parameters

Query Parameters

Response