Batches

A Batch (also called a Lot) is a group of work order lines that are associated with each other, either for easy picking or for historical records.

Attributes

  • id string

  • name string

  • type integer

  • priority integer

Endpoints

Create Batch

put /api/batches

Create a batch and get a response.

Body Parameters

  • name string REQUIRED

    The name of the material.

  • id UUID REQUIRED

  • type integer

Request with curl
curl "http://[Your IP] /api/batches" \ -X put \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]" \ -d '{ "name": "string", "id": "UUID", }'
Example Response
{ "batch": { "id": " string ", "name": " string ", "type": " integer ", "priority": " integer ", } }

List Batches

get /api/batches

Get the batches from the PPG database and return a JSON response.

Arguments

  • name string

  • limit integer

  • offset integer

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

  • countOnly boolean

  • id uuid

    Unique identifier for the batch.

Request with curl
curl "http://[Your IP] /api/batches" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "batches": [{ "id": " string ", "name": " string ", "type": " integer ", "priority": " integer ", }] }] }

Show Batch

get /api/batches/[id]

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

Request with curl
curl "http://[Your IP] /api/batches/[id]" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "batches": [{ "id": " string ", "name": " string ", "type": " integer ", "priority": " integer ", }] }] }

Update Batch

put /api/batches/[id]

Arguments

Request with curl
curl "http://[Your IP] /api/batches/[id]" \ -X put \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "batch": { "id": " string ", "name": " string ", "type": " integer ", "priority": " integer ", } }

Delete Batch

get /api/batches/[id]/delete

Delete a specific batch from the PPG database and return a JSON response.

You cannot delete a batch unless there are no work order lines assigned to it, so you may either need to reassign the work orderlines separately, or deallocate the order lines they belong to.

Arguments

Request with curl
curl "http://[Your IP] /api/batches/[id]/delete" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "deleted": "true" }