Overview
In order to get information for many warehouses in a single request, then you can consume the endpoint presented in this article. However in order to do that, you must:
- Be authenticated user
For information on how you can authenticate, see: Authentication
As soon as you do authentication and receive a valid token, it needs to be passed on the call for getting warehouses information.
- You can provide page number and page size and some filtering information
Endpoint
Example for such endpoint for TT server:
https://tt.api.sellercloud.com/rest/api/Warehouses?pageNumber=1&pageSize=1
For your server endpoint will be:
https://{your_server_id}.api.sellercloud.com/rest/api/Warehouses?pageNumber=1&pageSize=1
Request
Information about expected request parameters can be found on swagger UI https://tt/api.sellercloud.com/rest/swagger.
- Method Type: HttpGet
- Authorization: Use Bearer Token + token received from token authentication
- Header info: Content-Type: application/json
- Parameters:
| Parameters | Data Type | Description | Is Required |
| pageNumber | integer | Number of page | yes |
| pageSize | integer | Number of customers per page | yes |
| warehouseIds | List | Warehouse Ids | No |
| name | string | Name of warehouse | No |
| warehouseType | enumeration | Type of warehouse:
Normal = 0 FBA = 1 Un_Tested = 2 Interim = 3 DropShip = 4 NewEgg = 5 |
No |
| isDefault | enumeration | Is default warehouse:
All = 0 Yes = 1 No = 2 |
No |
| isSellable | enumeration | Is sellable warehouse:
All = 0 Yes = 1 No = 2 |
No |
Response
- If user is authenticated and provides a valid page number and page size, then response will be Status Code 200 => OK and orders metadata in JSON format
{
"Items": [
{
"Name": "Default Warehose",
"IsDefault": true,
"WarehouseType": 0,
"IsSellAble": true,
"QBWarehouseName": "",
"CreatedBy": -1,
"CreatedOn": "2010-06-25T14:09:04.78",
"CreatedByUsername": "",
"CreatedByFirstName": "",
"CreatedByLastName": "",
"EnforceBins": false,
"WarehouseAddress": {
"Address": "520 James Street",
"FirstName": "Default",
"LastName": "Name",
"MiddleName": "Warehouse",
"ZipCode": "08701",
"City": "Lakewood",
"Country": "US",
"ContactName": "",
"Business": "Default Business",
"Address2": "Unit 3A",
"Fax": "",
"Region": "NJ",
"State": "NJ",
"Phone": ""
},
"ID": 40
}
],
"TotalResults": 1
}
- If user is not authenticated, then response will be Status Code 401 => Not Valid Token
- On server response => Status Code 500 => Internal Server Error