HomeGuidesAPI Reference
Guides

List all the Folders

Retrieve list of folders

📘

URL: POST/api/v1/folders/list

Request Parameters

ParameterDescriptionTypeRequiredPossible Values
advertiserIdThe ID of the specific advertiserintegerYA valid advertisers ID
Filter[folderId]Folder ID to fetch subfolders for a single folderstringNValid folder ID
Filter[search]String to search folder id, names, and users bystringNValid search text
startIndexYou can use this parameter to fetch specific number of folders from a list. This indicates the starting position of the list
Note: To return the first ten folders, set startIndex=0 and count=10		integerNValid integer value
countYou can use this parameter in combination with startIndex to fetch specific number of folders from a list.
Note: To return the first ten folders, set startIndex=0 and count=10		integerNValid integer value

Headers

Header NameDescriptionRequiredValues
AuthorizationThe token will provide you the access to the API. It is same for all advertisers you access through the API.YPlease utilize the generated auth_token shared with you at the time of partner onboarding from the Getting Started Guide
WM_CONSUMER.IDWe will provide you the consumer ID to access the API. It is same for all advertisers you access through the API.   YPlease 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_SIGNATUREAuth signature as an API key.YUse the signature generator code from Getting Started Guide to generate this value
WM_SEC.KEY_VERSIONWe will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API.Y1
WM_CONSUMER.intimestampTimestamp for which the auth signature is generated. Use Unix epoch format for the timestamp.YUse the signature generator code from Getting Started Guide to generate this value

Sample Request

curl -X POST \
'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/folders/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[folderId]": "6571ca63-382a-11ec-9b0d-0242c0a8f002",    "Filter[search]": "Test", "count": 1, "startIndex": 0 }"

Response

ElementDescriptionType
totalResultsTotal number of folders returnedinteger
responseResponse is an array holding the following elements:
  • folderId: ID of the folder, data type string
  • parentFolderId: ID of the parent folder where the retrieved folders are located, data type string
  • advertiserId: ID of the advertiser, data type integer
  • type: Type of folder, data type string. The value is FOLDER
  • name: Name of folder, data type string
  • creationDate: Date when the folder was created. data type date
  • lastUpdatedDate: Date when folder was subjected to update last. data type date

Sample Response

{ "totalResults": 1, "response": [ { "folderId": "6571ca63-382a-11ec-9b0d-0242c0a8f002", "parentFolderId": "1ca63-n982aDF-11ec567-5n1g-6244g0a8f096", "advertiserId": 123, "type": "FOLDER", "name": "Creative Group Test", "creationDate": "2021-10-28T20:05:28+00:00", "lastUpdatedDate": "2021-11-30T03:03:07+00:00" } ] }

Updated 27 days ago