Create Entity Snapshot

post

https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot/entity

You can create file-based snapshot for all the campaign entities for an advertiser using this method.

Note: There is no limit on number of snapshot requests for an advertiser.

Body Params

snapshot request

advertiserId

int32

required

The ID of the advertiser.

entityStatus

string

enum

required

Status of the entities to include in the snapshot.

Note: The default status is enabled. Disabled entities will not be part of the snapshot unless you request disabled and or all.

Allowed:

entityTypes

array of strings

required

The type of entity for which the snapshot should be generated.

entityTypes*

format

string

enum

Choose the format type for your snapshot.

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.

Allowed:

Headers

WM_SEC.AUTH_SIGNATURE

string

required

Auth signature as an API key.

WM_CONSUMER.ID

string

required

We will provide you the consumer ID to access the API. It is same for all advertisers you access through the API.

WM_SEC.KEY_VERSION

integer

required

We will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API.

WM_CONSUMER.intimestamp

integer

required

Timestamp for which the auth signature is generated. Use Unix epoch format.

Authorization

string

required

The token will provide you the access to the API. It is same for all advertisers you access through the API.

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200successful operation