Zone POST
URI
https://{DATACENTER}.brightpearlconnect.com/public-api/{ACCOUNT}
/warehouse-service/warehouse/{ID}/zone/
Refer to our documentation on URI syntax for more information on how to construct URIs.
Description
This method enables you to create new warehouse zone.
-
URI Parameters:
- warehouse ID - The ID of the warehouse you wish to create a new zone within.
Fields
Field | Description | Required | Notes |
---|---|---|---|
name | Name of the zone | True | Maximum length of 32 characters. Zone name must be unique within given warehouse. Zone names are case insensitive, i.e. upper- and lowercase letters are treated as the same. In result, zone named "Quarantine" is considered the same as "quarantine". |
The return from the method is the ID of the newly created zone if successful.
Example
Simplest use of the create zone method.
This will create a new zone with name 'Shipping'.
Request URI
/warehouse/2/zone/
Request body
{
"name": "Shipping"
}
Response
{
"response": 13
}