Retrieve Recommendations Snapshots
You can retrieve item recommendations and keyword recommendations snapshots by providing snapshot id and advertiser id for an advertiser.
Note:
- The output is generated in a “zip/gzip” file depending upon format chosen
- The file type enclosed in zip is CSV. You can request the following type of snapshots:
- Item Recommendations
- Keyword Recommendations
URL: GET/api/v1/snapshot
Query Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | The ID of the advertiser | integer | Y | Unique numeric identifier |
| snapshotId | The ID of the snapshot | string | Y | Unique alpha numeric identifier |
Sample Request 1
curl -X GET\
'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot?advertiserId=600001&snapshotId=15467655-92ef-490d-a2c8-0157990f57f8' \
--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' \
Sample Request 2
curl -X GET\
'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot?advertiserId=600002&snapshotId=09815467655-92ef-490d-a2c8-0157990f57f867' \
--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' \ Response
| Element | Description | Type |
|---|---|---|
| snapshotId | Id of the snapshot to be retrieved | string |
| jobStatus | It is an indicator to confirm status of snapshot generation. The possible values of jobStatus are: pending, processing, done, failed, expired | string |
| details | provides download URL when processed (once jobStatus reaches to state “done”) | string |
| code | The response code can have following values: success, failure | string |
Sample Response – Item Recommendations Snapshot
[ { "code" : "success", "snapshotId": "15467655-92ef-490d-a2c8-0157990f57f8", "details" : "https://advertising.walmart.com/qa/file/15467655-92ef-490d-a2c8-0157990f57f8 ", " jobStatus ": "done" }
]
The snapshot file is zipped CSV file format.
The response would be captured in one zip/gzip file as requested.
Example of the content of snapshot with id “15467655-92ef-490d-a2c8-0157990f57f8”. The file format is “CSV”:
reportDate, itemId, itemName, suggestedBid, brandName, superDepartName, departmentName, category, subCategory 2022-05-15, 1, TestItem1, 1, Brand1, SuperDepartment1, Department1, Category1, SubCategory1 2022-05-15, 2, TestItem2, 2, Brand2, SuperDepartment2, Department2, Category2, SubCategory2 2022-05-15, 3, TestItem3, 3, Brand3, SuperDpartmnt3, Departmnt3, Category3, SubCategory3
Updated 7 months ago