Warehouse GET
URI
https://{DATACENTER}.brightpearlconnect.com/public-api/{ACCOUNT}
/warehouse-service/warehouse/{ID-SET}
Refer to our documentation on URI syntax for more information on how to construct URIs.
Description
Returns the
Example 1
Retrieve all warehouses
Request URI
/warehouse
Response
{
"response": [
{
"name": "Second warehouse",
"typeCode": "warehouse",
"typeDescription": "Warehouse",
"id": 2,
"address": {
"addressId": 2
},
"clickAndCollectEnabled": false
},
{
"name": "Glasgow Central",
"id": 3,
"typeCode": "warehouse",
"typeDescription": "Warehouse",
"address": {
"addressId": 2
},
"clickAndCollectEnabled": true,
"weeklyOperatingPeriods": {
"timeZone": "Europe/London",
"periods": [
{
"dayOfWeek": 1,
"openingHours": "09:00:00",
"closingHours": "17:30:00"
},
{
"dayOfWeek": 2,
"openingHours": "09:00:00",
"closingHours": "17:30:00"
},
{
"dayOfWeek": 3,
"openingHours": "00:00:00",
"closingHours": "00:00:00"
},
{
"dayOfWeek": 4,
"openingHours": "00:00:00",
"closingHours": "00:00:00"
},
{
"dayOfWeek": 5,
"openingHours": "10:00:00",
"closingHours": "18:00:00"
},
{
"dayOfWeek": 6,
"openingHours": "09:00:00",
"closingHours": "17:30:00"
},
{
"dayOfWeek": 7,
"openingHours": "09:00:00",
"closingHours": "17:30:00"
}
]
},
"collectionSla": {
"value": 2,
"timeUnits": "HOURS"
},
"externalTransferSlas": [
{
"warehouseId": 4,
"value": 2,
"timeUnits": "DAYS"
},
{
"warehouseId": 5,
"value": 4,
"timeUnits": "WORKING_DAYS"
},
{
"warehouseId": 0,
"value": 6,
"timeUnits": "WORKING_DAYS"
}
]
}
]
}
Example 2
Retrieve warehouses with ID 2 or ID 3
Request URI
/warehouse/2,3
Response
{
"response": [
{
"name": "Main warehouse",
"id": 2,
"typeCode": "warehouse",
"typeDescription": "Warehouse",
"address": {
"addressId": 0
},
"clickAndCollectEnabled": false
},
{
"name": "Glasgow Central",
"id": 3,
"typeCode": "warehouse",
"typeDescription": "Warehouse",
"address": {
"addressId": 1,
"customerId": 1
},
"clickAndCollectEnabled": true,
"weeklyOperatingPeriods": {
"timeZone": "Europe/London",
"periods": [
{
"dayOfWeek": 1,
"openingHours": "09:00:00",
"closingHours": "17:30:00"
},
{
"dayOfWeek": 2,
"openingHours": "09:00:00",
"closingHours": "17:30:00"
},
{
"dayOfWeek": 3,
"openingHours": "00:00:00",
"closingHours": "00:00:00"
},
{
"dayOfWeek": 4,
"openingHours": "00:00:00",
"closingHours": "00:00:00"
},
{
"dayOfWeek": 5,
"openingHours": "10:00:00",
"closingHours": "18:00:00"
},
{
"dayOfWeek": 6,
"openingHours": "09:00:00",
"closingHours": "17:30:00"
},
{
"dayOfWeek": 7,
"openingHours": "09:00:00",
"closingHours": "17:30:00"
}
]
},
"collectionSla": {
"value": 2,
"timeUnits": "HOURS"
},
"externalTransferSlas": [
{
"warehouseId": 4,
"value": 2,
"timeUnits": "DAYS"
},
{
"warehouseId": 5,
"value": 4,
"timeUnits": "WORKING_DAYS"
},
{
"warehouseId": 0,
"value": 6,
"timeUnits": "WORKING_DAYS"
}
]
}
]
}