Create Campaign Recommendations Request

post

https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/snapshot/recommendations

Campaign Recommendations endpoint will provide recommendations on eligible campaigns for a particular recommendationType. Supported recommendation types are outOfBudget and itemAlerts.

Body Params

advertiserId

integer

required

The ID of the advertiser.

recommendationType

string

enum

required

The type of the recommendation required.

Allowed:

reportMetrics

array of strings

required

List of report metrics to be displayed for the selected recommendation report.

Note: Please see the table for the possible report metrics.

reportMetrics*

Headers

WM_SEC.AUTH_SIGNATURE

string

required

Auth signature as an API key.

WM_CONSUMER.ID

string

required

We will provide you the consumer ID to access the API. It is same for all advertisers you access through the API.

WM_SEC.KEY_VERSION

integer

required

We will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API.

WM_CONSUMER.intimestamp

integer

required

Timestamp for which the auth signature is generated. Use Unix epoch format.

Authorization

string

required

The token will provide you the access to the API. It is same for all advertisers you access through the API.

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200successful operation