v1

latestOpenAPI 3.0.12026-07-2412502.6 MB

Discounts

Get a discount

Specify a discount ID to get details for a single discount, including discount settings and configuration.

get/discounts/{discount_id}

Query parameters

with'discount_cycles' | 'discount_offers'

Expand on the information returned by including 'with' in the query parameters. For multiple attributes, separate with a comma (example : with=discount_cycles,discount_offers)

Response

discount_idinteger

discount_namestring

discount_type_id1 | 2

1 - One Time Code
2 - Recurring Code

discount_application_type_id1 | 2

1 - Offer Level
2 - Cart Level

shipping_onlyboolean

discount_category_idinteger nullable

discount_codestring

discount_descriptionstring nullable

discount_activeboolean

discount_expiration_datestring date-time nullable

discount_one_per_customerboolean

discount_notesstring nullable

Example response

{
  "discount_expiration_date": "2023-04-01 00:00:00",
  "discount_offers": [
    {
      "date_created": "2023-04-01 00:00:00",
      "date_modified": "2023-04-01 00:00:00",
      "offer_cycles": [
        {
          "date_created": "2023-04-01 00:00:00",
          "date_modified": "2023-04-01 00:00:00",
          "offer_cycle_items": [
            {
              "date_created": "2023-04-01 00:00:00",
              "date_modified": "2023-04-01 00:00:00"
            }
          ],
          "charge_timeframe": {
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00"
          }
        }
      ],
      "offer_timeframes": [
        {
          "date_created": "2023-04-01 00:00:00",
          "date_modified": "2023-04-01 00:00:00"
        }
      ],
      "offer_swap_options": [
        {
          "date_created": "2023-04-01 00:00:00",
          "date_modified": "2023-04-01 00:00:00"
        }
      ]
    }
  ]
}