📘
URL: POST/api/v2/creatives/metadata

Request Parameters

Parameter	Description	Type	Required	Possible Values
advertiserId	The ID for the specific advertiser	integer	Y	A valid advertiser ID
creativeId	The ID of the creative	string	Y	A valid creative ID

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/v2/creatives/metadata' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <auth_token>' \
--header 'WM_CONSUMER.ID: <consumerId>' \
--header 'WM_SEC.KEY_VERSION: 1' \
--header 'WM_CONSUMER.INTIMESTAMP: 0000000000000' \
--header 'WM_SEC.AUTH_SIGNATURE: '**************' \
--data '{ "advertiserId": 190001, "creativeId": "aaaa3333-aa33-aa33-aa33-aaaaaa333333" }' \

Response

Element	Description	Type
response	`advertiserId` `metadata` `name` `folderId` `templateId` `templateName`: `ONSITE_DISPLAY_TEMPLATE` for standard Display banner creatives, `VIDEO_DISPLAY_TEMPLATE` for Display video creatives subscribeEnabled: Indicates whether the Subscribe option was enabled for the creative. Boolean datatype associatedItems: List of item IDs that are associated with the creative. Array datatype `adUnits`: Each object within `adUnits` contains the following fields: `adUnitName`: name of the ad unit Desktop ad units: `marqueeDesktop`, `brandboxDesktop`, `galleryDesktop`, `tileDesktop`, `skylineDesktop`, `skylineDesktopV2`, `skylineDesktopV3` App ad units: `marqueeApp`, `tileApp`, `brandboxApp`, `galleryApp`, `skylineApp`, `skylineAppV2`, `skylineAppV3` Tablet ad units: `marqueeTablet` `headline`: String. `subhead`: String. `cta`: Call to action. String. `imageAltText`: Field to provide description of what’s visually represented in your ad. String. `logoAltText`: Field to provide description to logo image. String. `legalDisclaimerText`: String. `backgroundColorHex`: Color hex is always "#" followed by 6 digits between 0 and F on the hexadecimal scale. This field only applies to Skyline v3 ad units and is optional `textColor`: ENUM [gray, white] This field only applies to Skyline v3 ad units and is optional	JSON object
totalResults	Number of responses returned by the API that match the request criteria	integer

Note: Please refer to Appendix to verify what assets are used for building each ad Unit

Sample Response

Note: The values for the fields headline, cta, legalDisclaimerText, legalDisclaimerLabel, and
legalDisclaimerPopUpCopy in the ad unit marqueeTablet are inherited from the corresponding fields in marqueeDesktop, as marqueeTablet is not configured with its own versions of these properties.

{ "response": [ { "advertiserId": 190001, "metadata": { "name": "vc onsite 2025103013", "folderId": "3a4866a8-be91-421e-b388-5b7e347a582b", "templateName": "ONSITE_DISPLAY_TEMPLATE", "templateId": 436, "subscribeEnabled": true, "associatedItems": ["15680957"] }, "adUnits": [ { "adUnitName": "marqueeApp", "headline": "Sample Headline", "imageAltText": "Sample image alt text", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerText": "Sample disclaimer text", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "marqueeDesktop", "headline": "Sample Headline", "subhead": "Sample Subhead", "cta": "Click Here", "imageAltText": "Sample image alt text", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerText": "Sample disclaimer text", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" },
{ "adUnitName": "marqueeTablet", "headline": "Sample Headline", "cta": "Click Here", "imageAltText": "A picture of our product", "logoAltText": "Our company logo", "legalDisclaimerLabel": "Sample label", "legalDisclaimerText": "Sample disclaimer text", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "brandboxDesktop", "headline": "Sample Headline", "subhead": "Sample Subhead", "cta": "Click Here", "imageAltText": "Sample image alt text", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerText": "Sample disclaimer text", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "skylineAppV2", "headline": "Sample Headline", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "skylineAppV3", "headline": "Sample Headline", "imageAltText": "Sample image alt text", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy", "backgroundColorHex": "#FFFFFF", "textColor": "gray" }, { "adUnitName": "tileDesktop", "headline": "Sample Headline", "subhead": "Sample Subhead", "cta": "Click Here", "imageAltText": "Sample image alt text", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerText": "Sample disclaimer text" }, { "adUnitName": "brandboxApp", "headline": "Sample Headline", "subhead": "Sample Subhead", "imageAltText": "Sample image alt text", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerText": "Sample disclaimer text", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "galleryDesktop", "headline": "Sample Headline", "subhead": "Sample Subhead", "cta": "Click Here", "imageAltText": "Sample image alt text", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerText": "Sample disclaimer text", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "skylineDesktopV2", "headline": "Sample Headline", "subhead": "Sample Subhead", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerText": "Sample disclaimer text", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "tileApp", "headline": "Sample Headline", "subhead": "Sample Subhead", "cta": "Click Here", "imageAltText": "Sample image alt text", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerText": "Sample disclaimer text", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "skylineDesktopV3", "headline": "Sample Headline", "subhead": "Sample Subhead", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy", "backgroundColorHex": "#FFFFFF", "textColor": "white" }, { "adUnitName": "skylineDesktop", "headline": "Sample Headline", "subhead": "Sample Subhead", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerText": "Sample disclaimer text", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "galleryApp", "headline": "Sample Headline", "cta": "Click Here", "imageAltText": "Sample image alt text", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerText": "Sample disclaimer text", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "skylineApp", "headline": "Sample Headline", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "brandboxDesktopVideo", "headline": "A valid Headline", "subhead": "A valid Subhead", "cta": "A valid CTA", "logoAltText": "image", "legalDisclaimerLabel": "A valid legal disclaimer label", "legalDisclaimerPopUpCopy": "A valid legal disclaimer pop up copy", "videos": [ { "name": "mainVideo", "assetId": "00000000-0000-0000-0000-000000000005" } ] }, { "adUnitName": "checkInVideo", "legalDisclaimerLabel": "A valid legal disclaimer label", "legalDisclaimerPopUpCopy": "A valid legal disclaimer pop up copy", "videos": [ { "name": "mainVideo", "assetId": "00000000-0000-0000-0000-000000000005" } ] }, { "adUnitName": "brandboxAppVideo", "headline": "A valid Headline", "subhead": "A valid Subhead", "cta": "A valid CTA", "logoAltText": "image", "legalDisclaimerLabel": "A valid legal disclaimer label", "legalDisclaimerPopUpCopy": "A valid legal disclaimer pop up copy", "videos": [ { "name": "mainVideo", "assetId": "00000000-0000-0000-0000-000000000005" } ] } ], "totalResults": 1
}

Sample Response 2 - Video Response

{ "response": [ { "advertiserId": 190001, "metadata": { "name": "A valid creative name1", "folderId": "abc-123", "templateName": "VIDEO_DISPLAY_TEMPLATE", "subscribeEnabled": false }, "adUnits": [ { "adUnitName": "brandboxDesktopVideo", "headline": "A valid Headline", "subhead": "A valid Subhead", "cta": "A valid CTA", "logoAltText": "image", "legalDisclaimerLabel": "A valid legal disclaimer label", "legalDisclaimerPopUpCopy": "A valid legal disclaimer pop up copy", "videos": [ { "name": "mainVideo", "assetId": "00000000-0000-0000-0000-000000000005" } ] }, { "adUnitName": "checkInVideo", "legalDisclaimerLabel": "A valid legal disclaimer label", "legalDisclaimerPopUpCopy": "A valid legal disclaimer pop up copy", "videos": [ { "name": "mainVideo", "assetId": "00000000-0000-0000-0000-000000000005" } ] }, { "adUnitName": "brandboxAppVideo", "headline": "A valid Headline", "subhead": "A valid Subhead", "cta": "A valid CTA", "logoAltText": "image", "legalDisclaimerLabel": "A valid legal disclaimer label", "legalDisclaimerPopUpCopy": "A valid legal disclaimer pop up copy", "videos": [ { "name": "mainVideo", "assetId": "00000000-0000-0000-0000-000000000005" } ] } ] } ], "totalResults": 1
}