Description: You can place a request for item or keyword recommendations by providing advertiser ID, recommendation type and format

URL: POST/api/v1/snapshot/recommendations

Request Parameters

Parameter	Notes	Type	Required	Possible Values
advertiserId	The id of advertiser	integer	Y	The advertiser Id for which the recommendation is to be retrieved
recommendationType	The type of the recommendation required	string	Y	Values of recommendation type: keywordRecommendations matchTypeKeywordRecommendations
format	Choose the format type for your snapshot	string	Y	Types of formats: gzip, zip Note: gzip allows decompression while file is being transferred over the network, hence it is a faster and simpler way to download the reports

Headers

Header Name	Description	Required	Values
Authorization	The token will provide you the access to the API. It is same for all advertisers you access through the API.	Y	Please utilize the generated `auth_token` shared with you at the time of partner onboarding from the Getting Started Guide
WM_CONSUMER.ID	We will provide you the consumer ID to access the API. It is same for all advertisers you access through the API.	Y	Please use the generated `ConsumerId` shared with you at the time of partner onboarding. Refer to the Getting Started Guide for more information
WM_SEC.AUTH_SIGNATURE	Auth signature as an API key.	Y	Use the signature generator code from Getting Started Guide to generate this value
WM_SEC.KEY_VERSION	We will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API.	Y	1
WM_CONSUMER.intimestamp	Timestamp for which the auth signature is generated. Use Unix epoch format for the timestamp.	Y	Use the signature generator code from Getting Started Guide to generate this value

Sample Request for Keyword Recommendations

curl -X POST 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot/recommendations' --header 'Authorization: Bearer <auth_token>' \ --header 'accept: application/json' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_SEC.KEY_VERSION: 1' \ --header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \
--header 'WM_CONSUMER.intimestamp: 1565309779' \
--header 'Content-Type: application/json' \
--data '{ "advertiserId" : "600002", "recommendationType": "keywordRecommendations", "format": "gzip" }'

Sample Request for Match Type Keyword Recommendations

curl -X POST 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot/recommendations' --header 'Authorization: Bearer <auth_token>' \ --header 'accept: application/json' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_SEC.KEY_VERSION: 1' \ --header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \
--header 'WM_CONSUMER.intimestamp: 1565309779' \
--header 'Content-Type: application/json' \
--data '{ "advertiserId" : "600002", "recommendationType": "matchTypeKeywordRecommendations", "format": "gzip" }'

Response

Element	Description	Type
code	The response code can have following values: `success`, `failure`	string
details	Details of the error if value of response code is `failure`	string
snapshotId	ID of the snapshot	string
jobStatus	It is an indicator to confirm status of snapshot generation. The possible values of jobStatus are: `pending`, `processing`, `done`, `failed`, `expired`	string

Sample Response for Keyword Recommendations

[ { "code": "success", "snapshotId": "09815467655-92ef-490d-a2c8-0157990f57f867", "details": " ", " jobStatus ": "pending" }
]

Sample Response for Match Type Keyword Recommendations

[ { "code": "success", "snapshotId": "676515467655-89ef-670d-a2c8-0157990f57f854", "details": " ", " jobStatus ": "pending" }
]