Title
Page icon
Create new category
Edit page index title
Edit category
Edit link
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: |
isBookmarked | boolean | Filter to show only bookmarked templates. |
retailerId | integer | Filter by retailer ID. |
inventoryType | enum (string) | Filter by inventory type. Values: |
adFormat | string | Filter by ad format. |
sourceOfProductInformation | enum (string) | Filter by product information source. Values: |
productSelectionMethod | enum (string) | Filter by product selection method. Values: |
creativeStyle | array of enum | Filter by creative style(s). Values: |
category | array of string | Filter by category name(s). |
templateType | array of enum | Filter by template type(s). Values: |
Sample Request
Pagination and other options are passed via ParamInfo (e.g. query: offset, limit).
Request Body
Sample Response
Paginated list of retail templates (structure depends on ParamInfo).