Ordexs API v1 Get an API key

Offers

Retrieve a discount

GEThttps://api.ordexs.com/v1/discounts/{discount_id}

Path parameters

  • discount_idstringRequired

    starts with dsc_

Returns

200 OK · The discount. Discount

  • 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: