Get a variant

GET/products/{product_id}/variants/{id}

Authorization

AuthorizationBearer token (JWT) · headerrequired

Path parameters

product_idstringrequired

idstringrequired

Variant ID or SKU

Responses

200

Variant details

_linksHalLinks

idinteger

product_idinteger

namestring

Display name, computed from option1/option2/option3.

positioninteger

Ordering position within the product. Lower comes first. For products with chained_variants enabled this drives which variant stays visible (lowest position, then cheapest, then lowest id).

statusstring

Allowed:visiblehidden

skustring

barcode_numberstring

option1string

option2string

option3string

currency_codestring

regular_priceinteger

Regular price in cents

sale_priceinteger | null

Sale price in cents

priceinteger

Effective price in cents (sale_price if set, else regular_price)

online_stockinteger

all_stockinteger

available_if_no_stockboolean

weight_in_gramsinteger

unit_quantitynumber

colorstring

costinteger

profitinteger

stocksobject[]

Per-location stock breakdown

Show properties

Array of object

location_idinteger

available_unitsinteger

total_unitsinteger

404

Variant not found

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

product_idpath*idpath*Variant ID or SKU

Request

curl -X GET 'https://api.onbolder.com/v2/products/string/variants/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.onbolder.com/v2/products/string/variants/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.onbolder.com/v2/products/string/variants/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "id": 201,
  "product_id": 101,
  "name": "Small",
  "sku": "WH-001-S",
  "regular_price": 8999,
  "price": 8999,
  "online_stock": 10
}