Create Entity Snapshot
You can create file-based snapshot for all the campaign entities for an advertiser using this method.
URL: POST/api/v1/snapshot/entity
Query Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | The ID of the advertiser | integer | Y | Unique numeric identifier |
| entityStatus | The status of the entity Note: The default status is “enabled”. Disabled entities won’t be part of the snapshot unless you request “disabled” and/or “all” | string | Y | Possible values: enabled, disabled, all |
| entityTypes | The type of entity for which the snapshot should be generated. | string array | Y | Possible values:
|
| format | Choose the format type for your snapshot | string | N | Types of Format: 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. You will receive snapshot in zip format if no specific format is selected |
Note: There is no limit on number of snapshot requests for an advertiser.
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 |
| Content-Type | Format of the message body | Y | application/json |
Sample Request 1
curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot/entity' \
--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' \
--data '{ "advertiserId": 600001, "entityStatus": "enabled", "entityTypes": ["campaign", " adGroup"], "format": "zip" }'Sample Request 2
curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot/entity' \
--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' \
--data '{ "advertiserId": 600003, "entityStatus": "enabled", "entityTypes" : ["bidMultiplier" , "adItem"] }'Sample Request 3
curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot/entity' \
--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' \
--data '{ "advertiserId": 600004, "entityStatus": "enabled", "entityTypes" : ["campaign", "adGroup", "keyword", "adItem", "bidMultiplier", "placement"], "format": "gzip" }'Sample Request 4
curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot/entity' \
--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' \
--data '{ "advertiserId": 600004, "entityStatus": "enabled", "entityTypes" : ["campaign", "adGroup", "keyword", "adItem", "bidMultiplier", "placement"], "format": "gzip" }' Sample Request 5
curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot/entity' \
--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' \
--data '{ "advertiserId": 600005, "entityStatus": "enabled", "entityTypes" : ["category", "sbaProfile"], "format": "gzip" }'Sample Request 6
curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot/entity' \
--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' \
--data '{ "advertiserId": 600005, "entityStatus": "enabled", "entityTypes" : [ "campaign","adGroup","keyword","adItem", "adGroupMedia"], "format": "gzip" }' Sample Request 7
curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot/entity' \
--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' \
--data '{ "advertiserId": 600005, "entityStatus": "enabled", "entityTypes" : ["negativeKeywords"], "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 1
{ "code": "success", "snapshotId": "1", "details": "", "jobStatus": "pending" }Sample Response 2
{ "code": "success", "snapshotId": "2", "details": "", "jobStatus": "pending" }Sample Response 3
{ "code": "success", "snapshotId": "3", "details": "", "jobStatus": "pending" }Sample Response 4
{ "code": "success", "snapshotId": "4", "details": "", "jobStatus": "pending" }Sample Response 5
{ "code": "success", "snapshotId": "5", "details": "", "jobStatus": "pending" }Sample Response 6
{ "code" : "success", "snapshotId": "6", "details" : "", "jobStatus": "pending" }
Sample Response 7
{ "code" : "success", "snapshotId": "7", "details" : "", "jobStatus": "pending" }
Updated 1 day ago
Did this page help you?