What’s New
In this new release, we introduce a series of new endpoints for preferred deals campaign types only. For a copy of these documents, please reach out to your account representative.Category Search
Product categories allow retailers to create a hierarchal structure that helps narrow down products into unique groups or sub-groups based on shared characteristics. With the API you can now easily search for a retailer product based on a particular category name, or categories belonging to a retailer.GET | Category by Category ID | Search for categories based on category ID |
GET | Categories by Retailer | Search for retailer categories and filter down by a specific category name |
Creatives for Commerce Display
In v2022.10 we are also introducing a set of new API endpoints that allows building commerce display creatives completely through the API. With the new endpoints you will be able to: ✔️ Upload creative image assets✔️ View available retailer creative templates
✔️ Build new creatives using either one of our built-in templates or using a custom template
✔️ Associate the product SKUs you wish to display on each creative
Step 1 - Creative Asset Uploads
Upload creatives asset files using a new POST call:POST | Upload Image Asset | Upload creative asset image file |
Step 2 - Creative Builder
Construct new creative assets for preferred deals line items. Here we introduced four new endpoints:GET | Retailer Templates | Get a list of available creative templates for a specified retailer |
POST | Create Creative | Create a new account creative |
GET | Get Creative by Creative ID | Get account creative by creative id |
PUT | Update an Existing Creative | Update an existing creative |
Step 3 - Creative Product SKU Collection
Launching commerce onsite display creatives requires associating product SKUs with the creative before activating a line item. To support this functionality we introduce the following new endpoints:GET | Get Product SKUs by Line-Item-Id | Get a single Product SKU collection (product button) |
GET | Get Product SKUs by Line Item Id and Product SKU Collection Id | Get all the Product SKU collection (product buttons) associated with a line item |
POST | Create Product SKU Collection to Line Item | Create a new Product SKU collection (product buttons) on a line item |
PUT | Update Line Item Product SKU Collection | Update a Product SKU collection (product button) |
DELETE | Delete Product SKU Collection from a Line Item Id | Delete a Product SKU collection (Product Button) |