Sign in

v1

latestOpenAPI 3.0.12026-07-2412502.6 MB
Offers

Get an offer

 

get/offers/{offer_id}

Query parameters

with'initial_item_options' | 'offer_cycles' | 'offer_timeframes' | 'primary_offer_category' | 'secondary_offer_category' | 'offer_swap_options'

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

Response

OK

offer_idinteger
offer_namestring
offer_titlestring nullable
offer_codestring nullable
primary_offer_category_idinteger nullable
secondary_offer_category_idinteger nullable
offer_type_id1 | 2
  • 1 - One Time Sale
  • 2 - Recurring
offer_configurationstring nullable
offer_pricestring

Returns the price for the initial cycle of the offer. If null, then the offer has multiple items associated with it, to get full pricing for the offer, pass “with=offer_cycles”

offer_descriptionstring nullable
offer_globalboolean
offer_urlstring nullable
initial_item_idinteger nullable
offer_notesstring nullable
offer_activeboolean
date_createdstring date-time
created_byinteger
date_modifiedstring date-time
modified_byinteger

Example response

{
  "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"
    }
  ]
}