1. Resource Central
  2. arrow-right
  3. Warehouses

Warehouses

Power Pick warehouses.

Attributes

  • name string

    Non-unique name of the warehouse.

  • id string

    Unique identifier for the object.

Endpoints

List Warehouses /api/warehouses
get

Get the list of warehouses from the PPG database and return a JSON response.

Body Parameters

  • name string

    The name of the warehouse.

  • countOnly boolean

    When "true", will only return a count of the amount of items in the query.

    Default value:

    false

  • 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.

  • orderBy string, array

    Order the response by the selected field. Multiple values can be passed, separated by a comma.

Request with curl
curl "http://[subdomain.itempath.com or IP]/api/warehouses" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]" -d '{ }'
Example Response
{ "warehouses": [{ "name": " Warehouse 1 ", "id": " 8126B842-3EDF-4A2D-B11E-2679219FA5A6 ", }] }] }
Show Warehouse /api/warehouse/[id]
get

Get a single warehouse from the PPG database and return a JSON response.

Body Parameters

  • id uuid

    Unique identifier for an object.

  • name String

    Only return warehouses that have the given name.

Request with curl
curl "http://[subdomain.itempath.com or IP]/api/warehouse/[id]" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]" -d '{ }'
Example Response
{ "warehouses": [{ "name": " Warehouse 1 ", "id": " 8126B842-3EDF-4A2D-B11E-2679219FA5A6 ", }] }] }