Retail settings

AI Tools

The various methods for Retail Settings are listed below:

Get retail settings

Returns the retail settings for a given account, including approval configuration, brand values, Amazon seller details, and media channel settings.

Path Parameters

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

Sample Response

Returns a JSON object of type RetailSettingsResponse serialized via Jackson.

Field	Data Type	Description
allApproversRequired	boolean/null	Whether all approvers must approve before activation.
approvers	array	List of preview approvers.
approvers[].name	string	Name of the approver.
approvers[].emailId	string	Email address of the approver.
brandValues	array of string	List of brand values configured for the account.
amzSellerDetails	array	List of Amazon seller detail objects.
amzSellerDetails[].id	string	Amazon seller ID.
amzSellerDetails[].countryCode	string	Country code for the seller (e.g. `US`).
amzSellerDetails[].sellerAuthKey	string	Authentication key for the seller.
amzSellerDetails[].brands	array of string	List of brands associated with this seller.
mediaChannelSettings	array	List of media channel settings objects.
mediaChannelSettings[].mediaChannelIdx	integer	Index of the media channel.
mediaChannelSettings[].accountId	string	Account ID associated with this media channel setting.
mediaChannelSettings[].accountName	string	Account name associated with this media channel setting.
mediaChannelSettings[].profileId	string	Profile ID for the media channel.
mediaChannelSettings[].agencyFeesApplied	boolean/null	Whether agency fees are applied.
mediaChannelSettings[].agencyFees	float	Agency fee percentage.
mediaChannelSettings[].countryCode	string	Country code for this media channel setting (e.g. `US`).
mediaChannelSettings[].domain	string	Domain associated with this media channel setting.
mediaChannelSettings[].isUpdated	boolean/null	Whether the settings have been updated.
mediaChannelSettings[].isUsed	boolean/null	Whether this media channel is currently in use.

Sample Request

GET https://jivoxapis.api.jivox.com/v2/accounts/:accountId/retail-settings

Request Body

{ "allApproversRequired": false, "approvers": [ { "name": "John Doe", "emailId": "john.doe@example.com" } ], "brandValues": ["BrandA", "BrandB"], "amzSellerDetails": [ { "id": "SELLER123", "countryCode": "US", "sellerAuthKey": "auth-key-abc", "brands": ["Nike", "Adidas"] } ], "mediaChannelSettings": [ { "mediaChannelIdx": 101, "accountId": "acc-001", "accountName": "Acme Corp", "profileId": "profile-xyz", "agencyFeesApplied": true, "agencyFees": 5.0, "countryCode": "US", "domain": "acme.com", "isUpdated": false, "isUsed": true } ] }

Update retail settings

Updates one setting section at a time for a given account. The updatedSettingsName field is mandatory and determines which section is updated — only the fields relevant to that section need to be included in the request. Requires AdvertiserSettings_Create permission.

Path Parameters

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

Parameters

Field	Data Type	Requirement	Description
updatedSettingsName	string	Mandatory	Identifies which setting section to update. Allowed values: `"allApproversRequired"`, `"approverEmails"`, `"brandFilter"`, `"amzSellerDetails"`, `"mediaChannels"`.

Sample Request

POST https://jivoxapis.api.jivox.com/v2/accounts/:accountId/retail-settings

Values of updatedSettingsName

Depending on the value of updatedSettingsName, include only the corresponding fields for:

1.updatedSettingsName: "allApproversRequired"

2.updatedSettingsName: "approverEmails"

3.updatedSettingsName: "brandFilter"

4.updatedSettingsName: "amzSellerDetails"

5.updatedSettingsName: "mediaChannels"

1.updatedSettingsName: "allApproversRequired"

Updates only the flag that controls whether all approvers must approve before activation.

Parameters

Field	Data Type	Requirement	Description
allApproversRequired	boolean	Mandatory	Whether all listed approvers must approve before activation.

Request Body

{ "updatedSettingsName": "allApproversRequired", "allApproversRequired": true }

2.updatedSettingsName: "approverEmails"

Updates the list of approver email addresses (also persists the current allApproversRequired flag).

Parameters

Field	Data Type	Requirement	Description
approvers	array of string	Optional	List of approver email addresses. Pass an empty array to clear all approvers.
allApproversRequired	boolean	Optional	Whether all listed approvers must approve before activation.

Request Body

{ "updatedSettingsName": "approverEmails", "approvers": ["john.doe@example.com", "jane.doe@example.com"], "allApproversRequired": true }

3.updatedSettingsName: "brandFilter"

Updates the list of brand values configured for the account.

Parameters

Field	Data Type	Requirement	Description
brandValues	array of string	Mandatory	List of brand values to save for this account.

Request Body

{ "updatedSettingsName": "brandFilter", "brandValues": ["BrandA", "BrandB", "BrandC"] }

4.updatedSettingsName: "amzSellerDetails"

Updates the Amazon seller details for the account.

Parameters

Field	Data Type	Requirement	Description
amzSellerDetails	array	Mandatory	List of Amazon seller detail objects.
amzSellerDetails[].id	string	Optional	Amazon seller ID.
amzSellerDetails[].countryCode	string	Optional	Country code for the seller (e.g. `US`).
amzSellerDetails[].sellerAuthKey	string	Optional	Authentication key for the seller.
amzSellerDetails[].brands	array of string	Optional	List of brands associated with this seller.

Request Body

{ "updatedSettingsName": "amzSellerDetails", "amzSellerDetails": [ { "id": "SELLER123", "countryCode": "US", "sellerAuthKey": "auth-key-abc", "brands": ["Nike", "Adidas"] } ] }

5.updatedSettingsName: "mediaChannels"

Updates the media channel settings for the account.

Parameters

Field	Data Type	Requirement	Description
mediaChannelSettings	array	Mandatory	List of media channel settings objects.
mediaChannelSettings[].mediaChannelIdx	integer	Mandatory	Index of the media channel.
mediaChannelSettings[].accountId	string	Optional	Account ID associated with this media channel setting.
mediaChannelSettings[].accountName	string	Optional	Account name associated with this media channel setting.
mediaChannelSettings[].profileId	string	Optional	Profile ID for the media channel.
mediaChannelSettings[].agencyFeesApplied	boolean	Optional	Whether agency fees are applied.
mediaChannelSettings[].agencyFees	float	Optional	Agency fee percentage.
mediaChannelSettings[].countryCode	string	Optional	Country code for this media channel setting (e.g. `US`).
mediaChannelSettings[].domain	string	Optional	Domain associated with this media channel setting.
mediaChannelSettings[].isUpdated	boolean	Optional	Whether the settings have been updated.
mediaChannelSettings[].isUsed	boolean	Optional	Whether this media channel is currently in use.

Request Body

{ "updatedSettingsName": "mediaChannels", "mediaChannelSettings": [ { "mediaChannelIdx": 101, "accountId": "acc-001", "accountName": "Acme Corp", "profileId": "profile-xyz", "agencyFeesApplied": true, "agencyFees": 5.0, "countryCode": "US", "domain": "acme.com", "isUpdated": true, "isUsed": true } ] }

Sample Response

{ "msg": "Settings updated successfully." }

List Brands from Asset Source

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.

Info Parameters:

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

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

Sample Response

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

Last updated on

Was this page helpful?