Description

You can submit an insight report with specified retail metrics using this API

URL: POST/api/v1/snapshot/insight

Request Parameters

Parameter	Description	Type	Required	Possible Values
advertiserId	The id of the advertiser	string	Y	Unique numeric identifier for the advertiser. This is the advertising account id
format	Format of the downloadable file	string	Y	`zip`, `gzip`
insightType	The type of insight report requested	string	Y	advancedInsights
reportMetrics	Choose the metrics type for your snapshot	string	Y	Please refer to Definition of Columns in the Advanced Insights Report for detailed information on report metrics

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

curl -X POST \
'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot/insight' \
--header 'Authorization: Bearer <auth_token>' \ --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 'accept: application/json' \ --data '{ "advertiserId": "600001", "insightType": "advancedInsights", "reportMetrics": ["reportDate", "catalogItemId", "price", "buyboxWinnerPrice", "publishedStatus", "inventoryCount"], "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

[ { "code": "success", "snapshotId": "10", "details": "", "jobStatus": "pending" }
]