XM
Members
Retrieve Default Warehouse
This documentation is now outdated, please find the latest docs for this endpoint here
Path:
1
GET https://{baseurl}/api-inventory/warehouse/default
Copied!
Retrieves details of the default warehouse. This API is secured by x-api-key.

Headers

Content-Type : application/json
x-site-context : { "date": "2020-08-28T02:35:27.787Z", "channel": 12, "account": 5f493c9f30ec2a0007a94fc8", "stage": "sandbox" }
x-api-key : d41d8cd98f00b204e9800998ecf8427e
Parameters []

Sample Request

1
GET https://{baseurl}/api-inventory/warehouse/default
Copied!

Sample Response

Response Code: 200
Message: OK
Description: You will see this message when the warehouse details are retrieved successfully.
1
{
2
"_id": "5f46c5e728539eb8e069178a",
3
"channel": [
4
12,
5
13
6
],
7
"isActive": true,
8
"isDefault": true,
9
"name": "Bellevue Warehouse Main22",
10
"address": {
11
"attention": "John Smith",
12
"street1": "10400 NE 4th St",
13
"street2": "Suite 2500",
14
"city": "Bellevue",
15
"state": "Washington",
16
"country": "US",
17
"zipCode": "98005",
18
"phone": [
19
{
20
"_id": "5f46d1b628539eb8e069178c",
21
"number": "555-555-5555",
22
"kind": "mobile",
23
"id": "5f46d1b628539eb8e069178c"
24
}
25
],
26
"email": "[email protected]",
27
"kind": "Main Docks"
28
},
29
"kind": "Warehouse",
30
"locationId": 109,
31
"createdAt": "2020-08-26T20:28:23.070Z",
32
"updatedAt": "2020-08-26T21:18:46.640Z",
33
"__v": 0,
34
"shortName": "TAG_ABC1234"
35
}
Copied!
Error Code: 404
Message: Not Found
Description: You will see this error when the default warehouse details are not found.
1
{
2
"code": "NO_DEFAULT_LOCATION",
3
"message": "Location not found"
4
}
Copied!
Error Code: 500
Message: Internal Server Error
Description: You will see this error when the account number is incorrect in the x-site-context (for a multi-tenent client).

Changelog

  • Last updated - June 2021
Last modified 1mo ago
Copy link
Contents
Changelog