Zones

Attributes

id string
Unique identifier for the object.
name string
type integer
color string
putType integer
pickType integer
abcClass integer
warehouseId string
The ID to the warehouse this zone belongs to.

Endpoints

List Zones

get /api/zones

List all zones.

Arguments

name string
Only return zones that have the given name.
warehouse string
Only return zones that have the given warehouse name.
type integer
Only return zones that have the given type.
color
Only return zones that have the given color.
putType integer
Only return zones that have the given put type.
pickType integer
Only return zones that have the given pick type.
limit integer
A limit on the number of objects to be returned. Limit can range between 1 and 1000.

Default value: 250
page integer
Page-numbering is based on the value of the "limit" argument. If limit=20, then page=0 will display the hits from 1 to 20. (Page numbers are zero-based.) Using page without a limit returns all items.
countOnly boolean
When "true", will only return a count of the amount of items in the query.

Default value: false

Request with curl

curl "http://[Your IP] /api/zones" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"

Example Response

{ "zones": [{ "id": " string ", "name": " string ", "type": " integer ", "color": " string ", "putType": " integer ", "pickType": " integer ", "abcClass": " integer ", "warehouseId": " string ", }] }] }

Show Zone

get /api/zones/[id]

Get a specific zones from the PPG database and return a JSON response. The zone will be pulled from the Zone table.

Arguments

Request with curl

curl "http://[Your IP] /api/zones/[id]" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"

Example Response