Warehouses

Attributes

  • id string

    Unique identifier for the object.

  • name string

    Non-unique name of the warehouse.

  • address1 string

  • address2 string

  • address3 string

  • address4 string

  • address5 string

Endpoints

List Warehouses

get /api/warehouses

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

Arguments

  • name string

  • id uuid

    Unique identifier for the object.

  • 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/warehouses" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "warehouses": [{ "id": " 8126B842-3EDF-4A2D-B11E-2679219FA5A6 ", "name": " Warehouse 1 ", "address1": " string ", "address2": " string ", "address3": " string ", "address4": " string ", "address5": " string ", }] }] }

Show Warehouse

get /api/warehouse/[id]

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

Arguments

  • id uuid

    Unique identifier for an object.

  • name String

    Only return warehouses that have the given name.

Request with curl
curl "http://[Your IP] /api/warehouse/[id]" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "warehouses": [{ "id": " 8126B842-3EDF-4A2D-B11E-2679219FA5A6 ", "name": " Warehouse 1 ", "address1": " string ", "address2": " string ", "address3": " string ", "address4": " string ", "address5": " string ", }] }] }