Retail settings

The various methods for Feed Settings are listed below:

Update Brand Values

This will Update brands configured for the account.

Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the advertiser account created on the platform.

Sample Request

HTTP
    
 
PUT http://demo.stub.api.jivox.com/v2/accounts/<accountId>/retail-feed-settings/brands
Copy

Request Body

JSON
    
 
{  brandValues: ["Dove", "Aveeno"]}
Copy

This will list brands configured for the account in the retail media app.

Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the advertiser account created on the platform.

Sample Request

HTTP
    
 
GET http://demo.stub.api.jivox.com/v2/accounts/<accountId>/retail-feed-settings/brands
Copy

Sample Response

JSON
    
 
{  brandValues: ["Dove", "Aveeno"]}
Copy

This will list all the brands available to be passed in the brand filter.

Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the advertiser account created on the platform.

accountId: Current account Id

query: The search query input by the user

limit: The limit of elements in the list

offset: The no. of elements to skip

Sample Request

HTTP
    
GET http://demo.stub.api.jivox.com/v2/accounts/:accountId/retail-feed-settings/list/brands?query=searchQuery&limit=10&offset=0
Copy

Sample Response

JSON
    
 
{  values: ["Dove Soap", "Dove Conditioner", "Dove Shampoo"]}
Copy

Last updated on

Was this page helpful?