Skip to main content
GET
/
consumers
/
{consumer_id}
/
commerce
/
variants
/
{variant_id}
Get one specific product variant
curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/commerce/variants/{variant_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "source_ref": {
    "id": "<string>",
    "model": "<string>"
  },
  "parent_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "description_html": "<string>",
  "categories": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "created_on": "2023-11-07T05:31:56Z",
  "sku": "<string>",
  "barcode": "<string>",
  "available_quantity": 123,
  "prices": [
    {
      "currency": "<string>",
      "price": 123
    }
  ],
  "unit_cost": {
    "amount": 123,
    "currency": "<string>"
  },
  "unit_of_measure": "<string>",
  "weight": 123,
  "weight_unit": "<string>",
  "status": "unknown",
  "inventory_details": [
    {
      "location": {
        "id": "<string>",
        "name": "<string>"
      },
      "available_quantity": 123
    }
  ],
  "common_attributes": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "variant_attributes": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "common_images": [
    {
      "id": "<string>",
      "main_image": true,
      "url": "<string>"
    }
  ],
  "variant_images": [
    {
      "id": "<string>",
      "main_image": true,
      "url": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

consumer_id
string<uuid>
required
variant_id
string
required

Response

Successful Response

id
string
required

Technical id in Chift

source_ref
object
required

Technical id in the target software

parent_id
string
required

Technical id of the parent product in Chift

name
string
required
description
string | null
description_html
string | null
categories
ProductCategoryItem · object[] | null
created_on
string<date-time> | null
sku
string | null
barcode
string | null
available_quantity
number | null
default:0
prices
ProductPriceItem · object[] | null
unit_cost
object | null
unit_of_measure
string | null
weight
number | null
default:0
weight_unit
string | null
status
enum<string> | null
Available options:
unknown,
archived,
unpublished,
published
inventory_details
InventoryDetailsItem · object[] | null
common_attributes
CommonAttributeItem · object[] | null

List of attributes that are shared by all variants of the product.

variant_attributes
VariantAttributeItem · object[] | null

List of attributes that are specific to the variant of the product.

common_images
ImageItem · object[] | null

List of images that are shared by all variants of the product.

variant_images
ImageItem · object[] | null

List of images that are specific to the variant of the product.

I