Submit Entity Snapshot Request

post

https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/snapshot/entity

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

Body Params

advertiserId

int64

required

Id of advertiser for which report is to be requested.

entityStatus

string

enum

required

The status of the entity.

Allowed:

entityTypes

array of strings

required

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

entityTypes*

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. The allowed value is 1.

WM_CONSUMER.intimestamp

integer

required

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

Authorization

string

required

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

x-targeting-format

string

enum

Specifies the JSON schema used to evaluate and return the targeting object.
To ensure backward compatibility, omitting this header defaults to the legacy expression structure.

Note: This header is applicable only for the Line Item entity snapshot.

Allowed:

Responses

200successful operation

400Invalid request parameters supplied

401Unauthorized

403Forbidden

500Internal Error