Sign in

v1

latestOpenAPI 3.0.12026-07-2412502.6 MB
Campaigns

Get campaign items

Returns all items for a specific campaign, including item settings and configuration.

get/campaigns/{campaign_id}/items

Query parameters

item_idinteger

Limit results to items with a specfic item ID.

item_namestring

Limit results to only an item with a specific name.

campaign_item_idinteger

Limit results to a specific campaign item ID.

item_category_idinteger

Find items on a campaign that belong to a specific item category ID.

item_category_slugstring

Find items on a campaign that belong to a specific item category slug.

item_tagstring

Find items on a campaign that have a specific tag.

campaign_item_hideboolean

Return items based on if they are hidden or not.

item_activeboolean

Return campaign items based on if the item is active or not.

with'item_images' | 'item_tags' | 'item_offers' | 'item_options' | 'item_option_variations' | 'item_swap_options' | 'linked_items' | 'related_items'

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

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

{
  "campaign_items": [
    {
      "date_created": "2023-04-01 00:00:00",
      "date_modified": "2023-04-01 00:00:00",
      "campaign_item_date_created": "2023-04-01 00:00:00",
      "campaign_item_date_modified": "2023-04-01 00:00:00",
      "linked_items": [
        {
          "date_created": "2023-04-01 00:00:00",
          "date_modified": "2023-04-01 00:00:00",
          "campaign_item_date_created": "2023-04-01 00:00:00",
          "campaign_item_date_modified": "2023-04-01 00:00:00"
        }
      ],
      "related_items": [
        {
          "date_created": "2023-04-01 00:00:00",
          "date_modified": "2023-04-01 00:00:00",
          "campaign_item_date_created": "2023-04-01 00:00:00",
          "campaign_item_date_modified": "2023-04-01 00:00:00"
        }
      ]
    }
  ]
}