Warehouse
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v202206/warehouses | Retrieve warehouse list |
[NEW] v202608 Patch (2026-09): Existing GET /api/v202206/warehousesresponse now includes a newshipping_servicesfield (list of shipping channels enabled at the warehouse).Existing GET /api/v202206/warehousesquery params now supportcarrierandcarrier_service(filter by carrier / service name).The additions below are new in this patch.
Header
| Key | Value |
|---|---|
| Authorization | Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi ... |
GET /api/v202206/warehouses (Retrieve warehouse list)
Request
Params
| Type | Name | Description | Required/Optional | Schema |
|---|---|---|---|---|
| query | api | The API type Available Values: index.by-default | required | enum |
Request Example
GET /api/v202206/warehouses?api=index.by-defaultResponse
| Key | Value |
|---|---|
| errcode | 0/4000 |
| errmsg | ok/Error Info |
| data | Data Properties |
Data Properties
| Name | Description | Schema |
|---|---|---|
| warehouse_id | The warehouse id | integer |
| warehouse_name | The warehouse name | string |
| address1 | The street address (line 1) | string |
| address2 | The street address (line 2) | string |
| country | The country | string |
| state | The state / province | string |
| zip | The zip code | string |
| city | The city | string |
| phone | The contact number | string |
| fax | The contact fax | string |
| shipping_services | [NEW] v202608 Array of shipping channels currently enabled at this warehouse (empty array if none enabled) | array |
[NEW] v202608 shipping_services sub-structure
| Name | Description | Schema |
|---|---|---|
| carrier | Carrier name Examples: FedEx / UPS / USPS / DHL | string |
| carrier_service | Carrier service name Examples: FedEx Ground / FedEx Ground Home Delivery / UPS Next Day Air | string |
Response Example
{
"errcode": 0,
"errmsg": "ok",
"data": {
"items": [
{
"warehouse_id": 100,
"warehouse_name": "SG-MDW1",
"address1": "460 Gibraltar Drive",
"address2": null,
"state": "IL",
"zip": "60440",
"city": "Bolingbrook",
"phone": "888-566-8826",
"fax": "8885081917",
"country": "US",
"shipping_services": [
{ "carrier": "FedEx", "carrier_service": "FedEx Ground" },
{ "carrier": "FedEx", "carrier_service": "FedEx Ground Home Delivery" },
{ "carrier": "UPS", "carrier_service": "UPS Next Day Air" }
]
},
{
"warehouse_id": 101,
"warehouse_name": "SG-SMF1",
"address1": "2900 N MacArthur Dr Suite 150",
"address2": null,
"state": "CA",
"zip": "95376",
"city": "Tracy",
"phone": "888-566-8826",
"fax": "8885081917",
"country": "US",
"shipping_services": [
{ "carrier": "FedEx", "carrier_service": "FedEx Ground" }
]
},
{
"warehouse_id": 103,
"warehouse_name": "SG-MEM1",
"address1": "8835 Commerce Dr Suite 103",
"address2": null,
"state": "MS",
"zip": "38671",
"city": "Southaven",
"phone": "888-566-8826",
"fax": "6625366226",
"country": "US",
"shipping_services": []
},
{
"warehouse_id": 109,
"warehouse_name": "SG-ABE1",
"address1": "7185 Ambassador Dr",
"address2": null,
"state": "PA",
"zip": "18106",
"city": "Allentown",
"phone": "888-566-8826",
"fax": "8885081917",
"country": "US",
"shipping_services": []
},
{
"warehouse_id": 112,
"warehouse_name": "SG-ATL1",
"address1": "495 Horizon Dr. suite 300",
"address2": "",
"state": "GA",
"zip": "30024",
"city": "Suwanee",
"phone": "888-566-8826",
"fax": "",
"country": "US",
"shipping_services": []
},
{
"warehouse_id": 117,
"warehouse_name": "SG-ONT3",
"address1": "11310 Harrel St Dock1",
"address2": "",
"state": "CA",
"zip": "91752",
"city": "Jurupa Valley",
"phone": "888-566-8826",
"fax": "",
"country": "US",
"shipping_services": []
}
]
}
}Modified at 2026-09-23 06:55:28