Retail Templates

Get retail templates (POST)

Returns retail templates matching the request. The API accepts query parameters via ParamInfo (e.g. offset, limit) and a request body for search and filter criteria (e.g. searchText, labelId, assetSourceType)

Path Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the account.

Query Parameters

Name	Data Type	Requirement	Parameter Type	Description
offset	integer	Optional	query	Pagination offset (e.g. 0).
limit	integer	Optional	query	Number of items per page (e.g. 25).

Parameters

The API accepts a structured JSON body de-serialized into RetailTemplateFilters (com.jivox.metadata.model.campaigns.RetailTemplateFilters). All fields are optional and act as filters.

Field	Data Type	Description
campaignName	string	Filter by template campaign name.
ownership	enum (string)	Filter by ownership. Values: `System`, `Custom`
isBookmarked	boolean	Filter to show only bookmarked templates.
retailerId	integer	Filter by retailer ID.
inventoryType	enum (string)	Filter by inventory type. Values: `offsite`, `onsite`
adFormat	string	Filter by ad format.
sourceOfProductInformation	enum (string)	Filter by product information source. Values: `Upload Your Own Assets`, `Retailer Product Feed`, `Hybrid`, `Dynamic`
productSelectionMethod	enum (string)	Filter by product selection method. Values: `Fixed Product Selection`, `Dynamic Product Selection`
creativeStyle	array of enum	Filter by creative style(s). Values: `Static Banner`, `Animated Banner`, `Animated Carousel`, `Video`, `Social`, `REC`
category	array of string	Filter by category name(s).
templateType	array of enum	Filter by template type(s). Values: `Standard`, `Dynamic`, `Carousel`, `Offer Feed`, `Geo Feed`, `Custom`

Sample Request

HTTP
    
 
POST https://jivoxapis.api.jivox.com/v2/accounts/:accountId/retail-campaigns/retail-templates
Copy

Pagination and other options are passed via ParamInfo (e.g. query: offset, limit).

Request Body

JSON
    
 
{  "campaignName": "Summer Sale",  "ownership": "System",  "isBookmarked": true,  "retailerId": 42,  "inventoryType": "onsite",  "adFormat": "banner",  "sourceOfProductInformation": "Retailer Product Feed",  "productSelectionMethod": "Dynamic Product Selection",  "creativeStyle": ["Static Banner", "Video"],  "category": ["Electronics", "Apparel"],  "templateType": ["Standard", "Carousel"]}
Copy

Sample Response

Paginated list of retail templates (structure depends on ParamInfo).

Last updated on

Was this page helpful?