Retrieve Snapshots
You can retrieve the Advertiser Attributes Report by providing the generated snapshot ID.
URL: GET/api/v1/snapshot
Note:
- The output is generated in a “zip/gzip” file depending upon requested format
- The output file is in JSON format
Query Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| snapshotId | The ID of the snapshot | string | Y | Unique numeric identifier |
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 GET\
'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot?snapshotId=1' \
--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 | URL of the snapshot file once jobStatus reaches to state “done” | string |
| code | The response code can have following values: success, failure | string |
Sample Response 1
[ { "code" : "success", "snapshotId". : "1", "details" : "https://advertising.walmart.com/file/1 ", "jobStatus" : "done" }
]
Example of the content of snapshot with ID “1”. The file format is “json”:
[ { "advertiserId": 121, "advertiserName": "TEST ADVERTISERS 1", "advertiserType": "1p", "accountSpendLimitReached": "N/A", "sellerName": null, "sellerId": 0, "apiAccessType": "read", "accessGrantTimestamp": " 2018-04-01T15:20:15Z", "reportDate": "2022-10-06" }, { "advertiserId": 122, "advertiserName": "TEST ADVERTISERS 2", "advertiserType": "3p", "accountSpendLimitReached": "1", "sellerName": "TEST SELLER 2", "sellerId": 132, "apiAccessType": "write", "accessGrantTimestamp": " 2018-04-01T15:20:15Z", "reportDate": "2022-10-06" }
]
Sample Response #2
[ { "code" : "success", "snapshotId". : "1", "details" : "https://advertising.walmart.com/file/1 ", "jobStatus" : "done" }
]
Example of the content of snapshot with ID “2”. The file format is “json”:
[{ "advertiserID": 564, "advertiserName": "TEST ADVERTISERS 1", "advertiserType": "3p", "sellerName": "TEST SELLER 1", "sellerId": 131, "approvedBrandNames": ["brand1"], "organizationID": 1456, "organizationName": "Organization 1", "accountSpendLimitReached": "0", "advertiserAccess": [ { "permissionType": "Edit", "resourceGroupName": "REPORTING", "grantTimestamp": "2024-03-03 00:00:00" }, { "permissionType": "View only", "resourceGroupName": "CAMPAIGN_MANAGER", "grantTimestamp": "2024-03-03 00:00:00" }, { "permissionType": "Edit", "resourceGroupName": "CREATIVE_HUB", "grantTimestamp": "2024-03-03 00:00:00" } ], "reportDate": "2024-03-12" }, { "advertiserID": 740, "advertiserName": "TEST ADVERTISERS 2", "advertiserType": "3p", "sellerName": "TEST SELLER 1", "sellerId": 131, "accountSpendLimitReached": "0", "approvedBrandNames": ["brand2", "brand3"] "advertiserAccess": [ { "permissionType": "View only", "resourceGroupName": "REPORTING", "grantTimestamp": "2024-03-03 00:00:00" } ] "organizationId": 1456 "organizationName": "Organization 2" "reportDate": "2024-03-12"
},
{ "advertiserID": 800, "advertiserName": "TEST ADVERTISERS 3", "advertiserType": "1p", "sellerName":null , "sellerId": 0, "accountSpendLimitReached": "N/A", "approvedBrandNames": [] "advertiserAccess": [ { "permissionType": "View only", "resourceGroupName": "REPORTING", "grantTimestamp": "2024-03-03 00:00:00" } ] "organizationId": 1459 "organizationName": "Organization 3" "reportDate": "2024-03-12" }
]
Updated 1 day ago