List All the Creatives
Retrieve list of creatives associated with a specific advertiser to determine the creatives that are approved for use
URL: POST/api/v1/creatives/list
Request Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | The ID of the specific advertiser. All creatives for this advertiser account will be returned in response | integer | Y | A valid advertiser ID |
| Filter[creativeId] | 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 | array | N | Valid creative ID |
| Filter[folderId] | Folder ID to search for creatives within a folder Note: This will accept only one folder ID, as multiple folder IDs are not supported | array | N | Valid folder ID |
| Filter[name] | returns response for specific creative names listed. If not specified, returns list of all creatives in the advertiser account | string | N | Valid creative name |
| Filter[lastModifiedDate] | Provide a date to fetch the details of only those creatives which were created/modified on or after the date specified | date | N | Date should be in format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
| Filter[associatedItems] | Returns creatives that are associated with any of the listed items | array | N | Valid item IDs |
| startIndex | 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=0 and count=10 | integer | N | Valid integer value |
| count | 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=0 and count=10 | integer | N | Valid integer value |
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 |
| Content-Type | Format of the message body | Y | application/json |
| WM_CONSUMER.ID | Unique ID for consumer. 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 | Signature for authentication | Y | Use the signature generator code from Getting Started Guide to generate this value |
| WM_SEC.KEY_VERSION | 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 POST \
--location 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/creatives/list' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <auth_token>'
--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": 123, "Filter[creativeId]": ["abcd-1234"], "Filter[folderId]": ["abcd-1234"], "Filter[name]": "Test", "Filter[lastModifiedDate]": "2023-12-01T12:00:00Z", "Filter[associatedItems]": [“0000000”, “1111111”, “2222222"], "startIndex": 0, "count": 10
} '
Response
| Element | Description | Type |
|---|---|---|
| totalResults | Total number of creatives returned for specific campaign | integer |
| response | See table below for list and description of responsefields. | json |
response Object
| Field | Type | Description | Possible Values / Notes |
|---|---|---|---|
creativeId | string | ID of the creative | Valid creative ID |
advertiserId | integer | ID of the advertiser | Valid advertiser ID |
type | string | Type of creative | CREATIVE |
name | string | Name of creative | |
detailedStatus | string | Detailed status of the creative | CREATIVE_REVIEW, NEEDS_MORE_INFORMATION, ESCALATION_REVIEW |
status | string | Specified status of creative | DRAFT, PENDING_APPROVAL, APPROVED, REJECTED |
link | string | Link to creative | May not appear if produced by Walmart or cloned from a Walmart-produced creative. |
creationDate | date | Date when the creative was created | |
lastUpdatedDate | date | Date when the creative was last updated | |
folderId | string | Folder ID associated with the creative | |
templateName | string | Template name used for the creative | |
eligibleBadges | array[string] | Badges the creative is eligible to display during serving (does not guarantee serving) | ROLLBACK, ROLLBACKS_AND_MORE, ROLLBACK_WITH_PRICE, EXPRESS_DELIVERY, PRICE |
adUnits | string | Ad units supported on creative platform | marqueeDesktop, marqueeApp, marqueeTablet, skylineDesktop, skylineApp, skylineDesktopV2, skylineAppV2, skylineDesktopV3, skylineAppV3, brandboxDesktop, brandboxApp, galleryDesktop, galleryApp, tileDesktop, tileApp, checkinVideo, brandboxVideoDesktop, brandboxVideoApp, f4Video |
reviewComments | array[object] | All unresolved comments related to the creative | Each object includes: • id (string)• asset (integer)• adUnit (string)• message (string) |
subscribeEnabled | boolean | Indicates whether Subscribe option was enabled | Applicable only after creative is submitted for moderation |
associatedItems | array | List of item IDs associated with the creative | Applicable only after creative is submitted for moderation |
hpStatus | string enum | Eligibility to be served on the homepage. | APPROVED: above and below the foldAPPROVED_BTF: below the fold onlyNOT_APPROVED: not eligible for the homepage: not eligible for the homepage |
Sample Response
{ "totalResults": 1, "response": [ { "creativeId": "abcd-1234", "name": "Test Creative 1", "type": "string", "detailedStatus": "CREATIVE_REVIEW", "status": "REJECTED", "link": "string", "advertiserId": 1, "creationDate": "string", "lastUpdatedDate": "string", "folderId": "string", "templateName": "ONSITE_DISPLAY_TEMPLATE", "eligibleBadges": [ "ROLLBACK", "ROLLBACKS_AND_MORE", "ROLLBACK_WITH_PRICE", "PRICE", "EXPRESS_DELIVERY" ], "adUnits": [ "marqueeDesktop", "marqueeApp", "marqueeTablet", "skylineDesktop", "skylineApp", "skylineDesktopV2", "skylineAppV2", "skylineDesktopV3", "skylineAppV3", "brandboxDesktop", "brandboxApp", "galleryDesktop", "galleryApp", "tileDesktop", "tileApp", "f4Video" ], "reviewComments": [ { "id": "string", "asset": "cta", "adUnit": "1232x178_MarqueeDesktopGlass", "message": "test reject" }, { "id": "string", "asset": "cta", "adUnit": "all", "message": "test reject1" } ], "subscribeEnabled": "true", "associatedItems": [ "0000000", "1111111", "2222222" ], "hpStatus": "APPROVED" } ]
}
Updated 11 days ago