Create the Folder
Create folder for a specific advertiser
URL: POST/api/v1/folders
Request Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | The ID of the specific advertiser | integer | Y | A valid advertisers ID |
| name | Name of folder | string | Y | Valid name Note: The maximum length of the name is 255 characters |
| folderId | ID of the folder where new folder is to be created | string | N | A valid folder 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 |
| WM_CONSUMER.ID | 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 | Auth signature as an API key. | Y | Use the signature generator code from Getting Started Guide to generate this value |
| WM_SEC.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' \ --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, "name": "New Folder" , "folderId": "6571ca63-382a-11ec-9b0d-0242c0a8f002"
}
Response
| Element | Description | Type |
|---|---|---|
| code | Possible values of response code:
| string |
| details | Details of the error if the response code is failure | string |
| folderId | ID of the folder | string |
Sample Response
[ { "code": "success", "details": ["success"], "folderId": "e02a09b2-1e3c-2g22-bf47-8a123c35002a" } ]
Updated 8 months ago