Ordexs API v1 Get an API key

Collections

List collections

GEThttps://api.ordexs.com/v1/collections

Query parameters

  • limitinteger

    How many objects to return, 1–100. Default 25.

    1–100

  • cursorstring

    The next_cursor from the previous page. Repeat the same filters with it.

    up to 512 characters

  • updated_sincestring

    Only objects changed at or after this moment (ISO-8601). Switches the order to oldest change first, so you can store the last updated_at you saw and resume from it. Objects changed in the same second may be returned again — de-duplicate by id.

    ISO 8601 date-time, UTC

  • created_sincestring

    Only objects created at or after this moment (ISO-8601).

    ISO 8601 date-time, UTC

  • statusstring

    One of active, draft

  • kindstring

    One of manual, smart

Returns

200 OK · A page of collections. CollectionList

  • objectstringRequired

    always "list"

  • has_morebooleanRequired
  • next_cursorstring or nullRequired

    Pass as cursor to get the next page. null on the last page.

  • dataarray of CollectionsRequired
    17 child fields
    • idstring

      starts with col_

    • objectstring

      always "collection"

    • titlestring
    • handlestring
    • descriptionstring or null
    • image_urlstring or null
    • statusstring

      One of active, draft

    • kindstring

      One of manual, smart

    • rulesarray of CollectionRules
      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

    • sort_modestring
    • positioninteger
    • product_countinteger
    • seoobject
      2 child fields
      • titlestring or null
      • descriptionstring or null
    • livemodeboolean
    • created_atstring

      ISO 8601 date-time, UTC

    • updated_atstring

      ISO 8601 date-time, UTC

Errors

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