Catalogus-API2026-11Preview

Varianten

Eén optie van een product, een maat, een kleur of een telefoonmodel, gekoppeld aan de SKU van de verkoper die we kopen en aan de variant die je winkel verkoopt.

Het Variant-object

idstring
Begint met var_.
skustring
De SKU van de verkoper, zoals wij hem lezen. Wat we kopen.
label, options
De optiewaarden, als één label en per optienaam.
costmoney
Wat de verkoper voor één stuk rekent, in CN¥, zoals laatst gelezen.
pricemoney
Je verkoopprijs.
in_stockboolean
Of de verkoper het kan verkopen, zoals laatst gelezen.
unitsinteger
Hoeveel we kopen voor elk stuk dat je verkoopt: een 3-pack in je winkel koopt er 3.
weight_ginteger
Het verpakte gewicht dat je voor één stuk opgaf, gebruikt om de verzending te schatten.
external_variant_idstring|null
De variant van je winkel. Een bestelling ervoor koopt deze SKU; een bestelling voor een niet-toegewezen variant wordt geweigerd.
variant
{
  "id": "var_41hz",
  "product": "prd_8f2k",
  "sku": "5187209554",
  "label": "Black / M",
  "options": { "Color": "Black", "Size": "M" },
  "image": "https://media.ninjabuy.com/listings/weidian-7750970856/sku-black.webp",
  "cost": { "amount": "38.00", "currency": "CNY" },
  "price": { "amount": "49.99", "currency": "USD" },
  "in_stock": true,
  "units": 1,
  "weight_g": 180,
  "external_variant_id": "gid://shopify/ProductVariant/44100231",
  "updated_at": "2026-11-04T09:20:03Z"
}

De varianten van een product opvragen

GET/v1/products/{id}/variants

Elke variant met de kosten, jouw prijs, voorraad en toewijzing.

Scopeproducts:read

Padparameters

idstringverplicht
De id van het product.

Queryparameters

limit, cursor
Pagination

Fouten

StatusTypeWanneer
404not-foundDit product bestaat niet op dit account.
curl "https://www.ninjabuy.com/api/v1/products/prd_8f2k/variants" \
  -H "Authorization: Bearer $NINJABUY_API_KEY" \
  -H "NinjaBuy-Version: 2026-11"
Response 200
HTTP/2 200 OK

{
  "data": [
    {
      "id": "var_41hz",
      "product": "prd_8f2k",
      "sku": "5187209554",
      "label": "Black / M",
      "options": { "Color": "Black", "Size": "M" },
      "image": "https://media.ninjabuy.com/listings/weidian-7750970856/sku-black.webp",
      "cost": { "amount": "38.00", "currency": "CNY" },
      "price": { "amount": "49.99", "currency": "USD" },
      "in_stock": true,
      "units": 1,
      "weight_g": 180,
      "external_variant_id": "gid://shopify/ProductVariant/44100231",
      "updated_at": "2026-11-04T09:20:03Z"
    },
    {
      "id": "var_41j0",
      "product": "prd_8f2k",
      "sku": "5187209555",
      "label": "Black / L",
      "options": { "Color": "Black", "Size": "M" },
      "image": "https://media.ninjabuy.com/listings/weidian-7750970856/sku-black.webp",
      "cost": { "amount": "38.00", "currency": "CNY" },
      "price": { "amount": "49.99", "currency": "USD" },
      "in_stock": false,
      "units": 1,
      "weight_g": 180,
      "external_variant_id": null,
      "updated_at": "2026-11-04T09:20:03Z"
    }
  ],
  "has_more": false,
  "cursor": null
}

Een variant ophalen

GET/v1/variants/{id}

Eén variant.

Scopeproducts:read

Padparameters

idstringverplicht
De id van de variant.

Fouten

StatusTypeWanneer
404not-foundDeze variant bestaat niet op dit account.
curl "https://www.ninjabuy.com/api/v1/variants/var_41hz" \
  -H "Authorization: Bearer $NINJABUY_API_KEY" \
  -H "NinjaBuy-Version: 2026-11"
Response 200
HTTP/2 200 OK

{
  "id": "var_41hz",
  "product": "prd_8f2k",
  "sku": "5187209554",
  "label": "Black / M",
  "options": { "Color": "Black", "Size": "M" },
  "image": "https://media.ninjabuy.com/listings/weidian-7750970856/sku-black.webp",
  "cost": { "amount": "38.00", "currency": "CNY" },
  "price": { "amount": "49.99", "currency": "USD" },
  "in_stock": true,
  "units": 1,
  "weight_g": 180,
  "external_variant_id": "gid://shopify/ProductVariant/44100231",
  "updated_at": "2026-11-04T09:20:03Z"
}

Een variant bijwerken

PATCH/v1/variants/{id}

Stel de prijs in, de stuks die per verkoop worden gekocht, het gewicht, of de winkelvariant waar hij voor staat. Stuur alleen wat verandert.

Scopeproducts:write

Padparameters

idstringverplicht
De id van de variant.

Body

pricemoney
Optioneel. Je verkoopprijs.
unitsinteger
Optioneel. 1 tot 50.
weight_ginteger
Optioneel. Verpakt gewicht van één stuk, in gram.
external_variant_idstring|null
Optioneel. Wijs hem toe aan een variant in je winkel, of null om de toewijzing op te heffen.

Fouten

StatusTypeWanneer
404not-foundDeze variant bestaat niet op dit account.
409invalid-stateDie winkelvariant staat al voor een andere SKU.
curl -X PATCH "https://www.ninjabuy.com/api/v1/variants/var_41hz" \
  -H "Authorization: Bearer $NINJABUY_API_KEY" \
  -H "NinjaBuy-Version: 2026-11" \
  -H "Content-Type: application/json" \
  -d '{
    "units": 2,
    "price": { "amount": "89.99", "currency": "USD" }
  }'
Response 200
HTTP/2 200 OK

{
  "id": "var_41hz",
  "product": "prd_8f2k",
  "sku": "5187209554",
  "label": "Black / M",
  "options": { "Color": "Black", "Size": "M" },
  "image": "https://media.ninjabuy.com/listings/weidian-7750970856/sku-black.webp",
  "cost": { "amount": "38.00", "currency": "CNY" },
  "price": { "amount": "89.99", "currency": "USD" },
  "in_stock": true,
  "units": 2,
  "weight_g": 180,
  "external_variant_id": "gid://shopify/ProductVariant/44100231",
  "updated_at": "2026-11-04T09:20:03Z"
}