Skip to main content
GET
/
v1
/
skus
/
{skuId}
Get SKU
curl --request GET \
  --url https://{cluster}.voucherify.io/v1/skus/{skuId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'
{
  "id": "sku_0b1621b2f25248b79c",
  "source_id": "sku_source_id_1",
  "product_id": "prod_0b15f6b9f650c16990",
  "sku": "Extra Small Blue Shirt",
  "price": 1300,
  "currency": "USD",
  "attributes": {
    "size": "XS",
    "color": "blue",
    "ranking": 1
  },
  "image_url": "",
  "metadata": {},
  "created_at": "2022-05-17T10:36:30.057Z",
  "updated_at": "2022-07-01T05:34:16.822Z",
  "object": "sku"
}

Authorizations

​
X-App-Id
string
header
required
​
X-App-Token
string
header
required
​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
skuId
string
required

A Voucherify SKU identifier or SKU source ID.

Example:

"sku_0b661e41eccd35a8e9"

Response

Returns requested SKU object.

Response body schema for GET v1/skus/{skuId}. This is an object representing a product SKU.

​
id
string
required

A unique identifier that represents the SKU and is assigned by Voucherify.

Example:

"sku_0b1621b319d248b79f"

​
source_id
string | null
required

A unique SKU identifier from your inventory system.

Example:

"sku_source_id_4"

​
product_id
string
required

The parent product's unique ID.

Example:

"prod_0b15f6b9f650c16990"

​
sku
string | null
required

Unique user-defined SKU name.

Example:

"Large Pink Shirt"

​
price
integer | null
required

Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as $100.00 being expressed as 10000.

​
attributes
object
required

The attributes object stores values for all custom attributes inherited by the SKU from the parent product. A set of key/value pairs that are attached to a SKU object and are unique to each SKU within a product family.

​
image_url
string | null
required

The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image.

​
metadata
object
required

The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format. It can be used to create product collections.

​
created_at
string<date-time>
required

Timestamp representing the date and time when the SKU was created. The value is shown in the ISO 8601 format.

Example:

"2022-05-17T10:36:30.187Z"

​
updated_at
string<date-time> | null
required

Timestamp representing the date and time when the SKU was updated. The value is shown in the ISO 8601 format.

Example:

"2022-05-17T10:55:09.137Z"

​
object
enum<string>
default:sku
required

The type of the object represented by JSON. This object stores information about the SKU.

Available options:
sku
​
currency
string | null

SKU price currency.

Example:

"USD"

⌘I