Histories

Attributes

  • id

  • number

  • creationDate

  • expiryDate

  • productionDate

  • releaseDate

  • locationName

  • shelfName

  • warehouseName

  • carrierName

  • binName

  • xStep

  • yStep

Endpoints

List Histories

get /api/histories

Arguments

  • limit integer

    A limit on the number of objects to be returned. Limit can range between 1 and 1000, and the default is 250.

  • offset integer

    Will return items, but only those after the integer amount.

  • orderBy string, array

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

  • countOnly boolean

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

  • createdAfter datetime

    Only return histories that were created after a certain date.

  • createdBefore datetime

    Only return histories that were created before a certain date.

  • name string

    Only return histories that have the given name.

  • [dynamic_field]

    Any dynamic fields that have been set up can be used as a filter.

Request with curl
curl "http://[Your IP]/api/histories" \ -X get \-H "Content-Type: application/json" \-H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "histories": [{ "id": "", "number": "", "creationDate": "", "expiryDate": "", "productionDate": "", "releaseDate": "", "locationName": "", "shelfName": "", "warehouseName": "", "carrierName": "", "binName": "", "xStep": "", "yStep": "", }] }] }

Show History

get /api/histories/[id]

Get a specific history from the PPG database and return a JSON response.

Request with curl
curl "http://[Your IP]/api/histories/[id]" \ -X get \-H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "history": { "id": , "number": , "creationDate": , "expiryDate": , "productionDate": , "releaseDate": , "locationName": , "shelfName": , "warehouseName": , "carrierName": , "binName": , "xStep": , "yStep": , } }