Zone PATCH

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/warehouse-service/warehouse/{ID}/zone/{ZONE-ID}

Refer to our documentation on URI syntax for more information on how to construct URIs.

Description

Use zone PATCH to update zone name.

A zone name may not be PATCHed if new name exceeds its maximum allowed length or results in duplicate entry within that warehouse.

The response to a successful request will be the new state of the zone.

Example

Updating zone 4 within warehouse 2, set zone name to 'Quarantine'

Request URI

/warehouse/2/zone/4

Request body

[
	{
		"op": "replace",
		"path": "/name",
		"value": "Quarantine"
	}
]

Response

{
	"response": {
		"id": 4,
		"name": "Quarantine",
		"warehouseId": 2
	}
}