Ordexs API v1 Get an API key

Products

Create a product

POSThttps://api.ordexs.com/v1/products

Creates a product with its options and variants. Every variant names one value for each option. Prices are decimal strings in the store's currency. Images can't be uploaded through the API yet.

Body

  • titlestringRequired

    1–255 characters

  • description_htmlstring

    up to 100000 characters

  • statusstring

    Default draft.

    One of draft, published

  • handlestring

    The product's address in the storefront. Made from the title when left out.

  • product_typestring

    up to 100 characters

  • vendorstring

    up to 100 characters

  • categorystring

    up to 100 characters

  • tagsarray of strings

    up to 50 items

  • weight_gramsinteger

    0–1000000

  • optionsarray of ProductOptionIns

    up to 3 items

    3 child fields
    • namestringRequired

      1–60 characters

    • typestring

      How the storefront shows it.

      One of color, size, text

    • valuesarray of stringsRequired

      up to 100 items · at least 1 item

  • variantsarray of objectsRequired

    With no options, exactly one variant whose options is {}.

    up to 100 items · at least 1 item

    8 child fields
    • 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 product. Product

  • idstringRequired

    starts with prod_

  • objectstringRequired

    always "product"

  • titlestringRequired
  • handlestringRequired

    The product's address in the storefront.

  • description_htmlstring or null
  • statusstringRequired

    One of draft, published, archived

  • product_typestring or null
  • vendorstring or null
  • categorystring or null
  • tagsarray of strings
  • weight_gramsinteger or null
  • optionsarray of objectsRequired
    3 child fields
    • namestring
    • typestring

      How the option is shown, e.g. color, size or text.

    • valuesarray of strings
  • variantsarray of VariantsRequired
    21 child fields
    • 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

  • imagesarray of objectsRequired
    4 child fields
    • idstring

      starts with img_

    • urlstring
    • altstring or null
    • positioninteger
  • urlstring or null

    The product's page in the storefront. Null while it isn't published, and in test mode.

  • livemodebooleanRequired
  • created_atstringRequired

    ISO 8601 date-time, UTC

  • updated_atstringRequired

    Also moves when a variant's stock or price changes.

    ISO 8601 date-time, UTC

Errors

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