Ordexs API v1 Get an API key

Collections

Preview automated conditions

POSThttps://api.ordexs.com/v1/collections/preview

How many products a set of conditions matches, and the first 12 of them, without saving anything.

Body

  • rulesarray of CollectionRulesRequired

    up to 30 items · at least 1 item

    3 child fields
    • fieldstringRequired

      One of title, vendor, product_type, category, status, tag, price, compare_at_price, inventory

    • opstringRequired

      One of eq, neq, contains, not_contains, starts_with, ends_with, is_set, is_not_set, gt, lt

    • valuestring

      up to 200 characters

  • rules_matchstring

    One of all, any
    default "all"

Returns

200 OK · The match. CollectionPreview

  • objectstring

    always "collection_preview"

  • match_countinteger
  • samplearray of objects
    6 child fields
    • idstring
    • titlestring
    • handlestring
    • statusstring
    • image_urlstring or null
    • priceMoney

      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

Errors

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