List Creatives

post

https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/creatives/list

Retrieve list of creatives associated with a specific advertiser to determine the creatives that are approved for use.

Body Params

advertiserId

int64

required

The ID of the specific advertiser. All creatives for this advertiser account will be returned in response.

startIndex

int32

You can use this parameter to fetch specific number of creatives from a list.
This indicates the starting position of the list.

Note: To return the first ten creatives, set startIndex to 0 and count to 10.

count

int32

You can use this parameter in combination with startIndex to fetch specific number of creatives from a list.

Note: To return the first ten creatives, set startIndex to 0 and count to 10.

Filter[creativeId]

array of strings

Returns response for specific creative IDs listed.
If not specified, returns list of all creatives in the advertiser account.

Note: This will accept only a single value in the list, as multiple creative IDs are not supported.

Filter[creativeId]

Filter[folderId]

array of strings

Folder ID to search for creatives within a folder.

Note: This will accept only one folder ID, as multiple folder IDs are not supported.

Filter[folderId]

Filter[name]

string

Returns response for specific creative names listed.
If not specified, returns list of all creatives in the advertiser account.

Filter[lastModifiedDate]

date-time

Provide a date to fetch the details of only those creatives which were created/modified on or after the date specified.

Filter[associatedItems]

array of strings

Returns creatives that are associated with any of the listed items.

Filter[associatedItems]

Filter[status]

array of strings

Optional. Creative statuses to filter by. Case-insensitive on input (values are normalized to upper case before being forwarded downstream). Omit to skip status filtering.

Filter[status]

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.

Responses

200successful operation

400Invalid request parameters supplied

401Unauthorized

403Forbidden

500Internal Error