Sign in

v1

latestOpenAPI 3.0.12026-07-2412502.6 MB
Campaigns

Get a campaign item

Get all details for a specific item within a campaign, including item settings and configuration.

get/campaigns/{campaign_id}/items/{campaign_item_id}

Query parameters

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)

Response

OK

item_idinteger
item_namestring
item_category_idinteger nullable
item_descriptionstring nullable
item_imagestring nullable
item_activeboolean
item_pricestring nullable
item_msrpstring nullable
item_coststring nullable
item_shippableboolean
item_skustring nullable
item_weightstring nullable
item_upcstring nullable
item_slugstring nullable
item_quantityinteger
connection_idinteger nullable
out_of_stock_blockboolean
item_turnaround_timeinteger
item_additional_descriptionstring nullable
item_ingredientsstring nullable
item_videostring nullable
item_sales_pagestring nullable
item_perishableboolean
item_tax_codestring nullable
item_additional_details_1string nullable
item_additional_details_2string nullable
item_additional_details_3string nullable
item_additional_details_4string nullable
item_additional_details_5string nullable
date_createdstring date-time
created_byinteger
date_modifiedstring date-time
modified_byinteger
item_notesstring nullable
campaign_item_idinteger
campaign_item_hideboolean
campaign_item_slugstring nullable
campaign_item_templatestring
item_category_namestring nullable
item_category_slugstring nullable
campaign_item_jsstring nullable
campaign_item_cssstring nullable
campaign_item_seo_titlestring nullable
campaign_item_seo_keywordsstring nullable
campaign_item_seo_descriptionstring nullable
campaign_item_date_createdstring date-time
campaign_item_created_byinteger
campaign_item_date_modifiedstring date-time
campaign_item_modified_byinteger

Example response

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