List all the Folders
Retrieve list of folders
Request Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | The ID of the specific advertiser | integer | Y | A valid advertisers ID |
| Filter[folderId] | Folder ID to fetch subfolders for a single folder | string | N | Valid folder ID |
| Filter[search] | String to search folder id, names, and users by | string | N | Valid search text |
| startIndex | You 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 | integer | N | Valid integer value |
| count | You 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 | 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 \
'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
| Element | Description | Type |
|---|---|---|
| totalResults | Total number of folders returned | integer |
| response | Response is an array holding the following elements:
|
Error Response
| Field | Description | Optional field/Nullable? | Type | Possible values |
|---|---|---|---|---|
| code | Code=failure Click here for more information about Status Codes and Errors | N | string | failure |
| details | List of error codes associated with the request. Use these codes for programmatic error handling. | N | array | Refer to this link for detailed error messages |
| message | High-level summary of the error, when available. | Y | string | |
| errors | Detailed information about one or more errors, including the affected field (when applicable), error code, and a human-readable description. | Y | array<object> |
errors Array Object Details
| Field | Description | Optional field/Nullable? | Type | Possible values |
|---|---|---|---|---|
| field | Omitted if the error applies to the request as a whole. | Y | string | |
| errorType | Machine-readable error code that uniquely identifies the error condition. Applications should use this value for error handling logic. | N | string | |
| description | Human-readable explanation of the error, including why the request failed and, when possible, how to resolve it | N | string |
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" } ] } Sample Response - Failure
[ { "code": "failure", "details": [ "string" ], "message": "string",
"errors": [ { "field": "string", "errorType": "string", "description": "string" } ] }
]Updated 19 days ago
Did this page help you?
