Sign in

v1

latestOpenAPI 3.0.12026-07-2412502.6 MB
Offers

Search offers

 

get/offers

Query parameters

offer_idstring

Search for specific offer ID(s). Comma separate for multiple.

offer_namestring

Search for offers by the offer name.

offer_type_id1 | 2
  • 1 - One Time Sale
  • 2 - Recurring

Search for specific types of offers.

  • 1 - One Time Sale
  • 2 - Recurring
primary_offer_category_idinteger

Filter results using the Primary Category ID configured when setting up an offer. This value can be found on the Offer Category page in Vrio.

secondary_offer_category_idinteger

Filter results using the Secondary Category ID configured when setting up an offer. This value can be found on the Offer Category page in Vrio.

dunning_idinteger

Search for offers that use a specific dunning schedule.

upsell_profile_idinteger

Search for offers by the In Cart upsell profile.

post_upsell_profile_idinteger

Search for offers by the Post Cart upsell profile.

recurring_upsell_profile_idinteger

Search for offers by the Recurring upsell profile.

connection_idinteger

Search for offers that belong to a specific connection.

campaign_idinteger

Search for offers that are associated with a specific campaign.

offer_activeboolean

Return offers with a specific active status.

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)

limitinteger

Limit the number of results. Default: 25, max: 200.

offsetinteger

Offset the results

sort_bystring

Field to sort result by

order'asc' | 'desc'

Order by asc or desc

Response

OK

totalinteger

Example response

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