Ordexs API v1 Get an API key

Offers

List discounts

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

Discount codes and automatic discounts, newest first. A store has at most 50. Look one code up with code.

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

  • statusstring

    One of active, paused

  • kindstring

    One of code, automatic

  • codestring

    Exactly this code (letter case ignored).

    up to 20 characters

Returns

200 OK · A page of discounts. DiscountList

  • objectstringRequired

    always "list"

  • has_morebooleanRequired
  • next_cursorstring or nullRequired

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

  • dataarray of DiscountsRequired
    19 child fields
    • idstring

      starts with dsc_

    • objectstring

      always "discount"

    • namestring
    • codestring or null
    • kindstring

      One of code, automatic

    • discountDiscountValue

      percent: value is a percentage up to 90 ("10", "12.5"). fixed: value is an amount in the store's currency ("500.00").

      2 child fields
      • typestringRequired

        One of percent, fixed

      • valuestringRequired
    • applies_tostring

      One of store, collection, product

    • product_idsarray of strings
    • collection_idsarray of strings
    • starts_atstring or null

      ISO 8601 date-time, UTC

    • ends_atstring or null

      ISO 8601 date-time, UTC

    • usage_limitinteger or null
    • per_customer_limitinteger or null
    • times_usedinteger
    • statusstring

      One of active, paused

    • statestring

      One of active, scheduled, expired, used_up, paused

    • created_atstring

      ISO 8601 date-time, UTC

    • updated_atstring

      ISO 8601 date-time, UTC

    • livemodeboolean

Errors

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