Ordexs API v1 Get an API key

Products

Add a variant

POSThttps://api.ordexs.com/v1/products/{product_id}/variants

Adds a variant for a new combination of the product's options. A value an option doesn't have yet is added to it.

Path parameters

  • product_idstringRequired

    starts with prod_

Body

  • optionsobjectRequired

    Option name → value, one for each of the product's options.

  • pricestringRequired

    An amount as a decimal string in the store's currency, with no more decimals than the currency has ("3500.00" in DZD, "12.500" in TND).

  • compare_at_pricestring

    An amount as a decimal string in the store's currency, with no more decimals than the currency has ("3500.00" in DZD, "12.500" in TND).

  • coststring

    An amount as a decimal string in the store's currency, with no more decimals than the currency has ("3500.00" in DZD, "12.500" in TND).

  • skustring

    up to 100 characters

  • barcodestring

    up to 100 characters

  • inventory_quantityinteger

    0–1000000

  • inventory_trackedboolean

Returns

201 Created · The new variant. Variant

  • idstringRequired

    starts with var_

  • objectstringRequired

    always "variant"

  • product_idstringRequired
  • titlestringRequired

    The option values joined, e.g. "Black / M". "Default" for a product without options.

  • optionsobjectRequired

    Option name → value.

  • skustring or null
  • barcodestring or null
  • priceMoneyRequired

    An amount of money. amount is a decimal STRING with exactly the currency's number of decimals ("1250.00" in DZD, "12.500" in TND) — never parse it into a float.

    2 child fields
    • amountstringRequired
    • currencystringRequired
  • compare_at_priceMoney or null
    2 child fields
    • amountstringRequired
    • currencystringRequired
  • costMoney or null

    Only present when the key has the products:read_costs scope.

    2 child fields
    • amountstringRequired
    • currencystringRequired
  • inventory_quantityintegerRequired

    Units in stock. Negative when units are owed to pre-orders.

  • inventory_trackedboolean
  • incoming_quantityinteger

    Units on their way from a supplier.

  • incoming_due_atstring or null

    When the incoming delivery is expected.

    ISO 8601 date-time, UTC

  • allow_preorderboolean

    Orderable past zero

  • allow_backorderboolean

    Orderable past zero without limit; the merchant owes the units.

  • at_courierinteger

    Units kept at the courier's warehouse.

  • image_urlstring or null
  • livemodebooleanRequired
  • created_atstringRequired

    ISO 8601 date-time, UTC

  • updated_atstringRequired

    ISO 8601 date-time, UTC

Errors

Every error has the same shape. This endpoint can answer with: