Orders

Orders are a group of items that are picked or put into the storage system. When creating and updating orders, the changes need to be verified and updated asynchronously by PowerPick.

Attributes

  • id string

    Unique identifier for the object.

  • orderNumber string

    Non-unique name for the order.

  • status string

    If the material has been updated or created successfully.

  • priority integer

    Number priority for the order. Higher number indicates higher priority.

  • creationDate datetime

    The date/time this order was created.

  • deadline date

    When the order is due.

  • directionType integer

    1 if the order is a pick order, 2 if it is a put order.

  • handlingUnit string

    DEPRECATED.

  • warehouse string

    Name of the warehouse this order belongs to.

  • errorCode integer

  • errorDescription string

  • zones array

    Array of Zone names this order is a part of.

  • number integer

    Non-unique name for the order line.

Endpoints

List Orders

/api/orders

Arguments

  • priority integer

    Only return orders that have the given priority.

  • limit integer

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

  • orderBy string, array

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

  • countOnly boolean

    If set to true, will only return a count.

  • name string

    Only return orders that have the given name.

  • handlingUnit string

  • directionType integer

    Only return orders that have the given direction type.

  • status string

    Only return order with a certain status.

  • [dynamic_field]

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

Request with curl
curl "http://[Your IP] /api/orders" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "orders": [{ "id": "string", "orderNumber": "string", "status": "string", "priority": "integer", "creationDate": "datetime", "deadline": "date", "directionType": "integer", "handlingUnit": "string", "warehouse": "string", "errorCode": "integer", "errorDescription": "string", "zones": "array", "orderLines": [{ "number": "integer", }] }

Show Order

/api/orders/[id]

Get a specific order from the PPG database and return a JSON response. The order will be pulled either from the MasterOrder table or the HistoryMasterOrder table, depending on whether it's been picked.

Request with curl
curl "http://[Your IP] /api/orders/[id]" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "orders": [{ "id": "string", "orderNumber": "string", "status": "string", "priority": "integer", "creationDate": "datetime", "deadline": "date", "directionType": "integer", "handlingUnit": "string", "warehouse": "string", "errorCode": "integer", "errorDescription": "string", "zones": "array", "orderLines": [{ "number": "integer", }] }

Create Order

/api/orders

Create an order and get a response.

Arguments

  • number string

    The order number.

  • priority integer

    Number priority for the order.

  • directionType integer

    1 if the order is a pick order, 2 if it is a put order.

  • deadline datetime

    When the order is due.

  • [DynamicField] string

    Any of the dynamic fields from PowerPick.

  • orderLines array

    Any amount of order lines related to this order (see Order Line for more information on fields).

Request with curl
curl "http://[Your IP] /api/orders" \ -X post \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "orders": [{ "id": "string", "orderNumber": "string", "status": "string", "priority": "integer", "creationDate": "datetime", "deadline": "date", "directionType": "integer", "handlingUnit": "string", "warehouse": "string", "errorCode": "integer", "errorDescription": "string", "zones": "array", "orderLines": [{ "number": "integer", }] }

Update Order

/orders/[id]

Update an order and get a response. Each key/value is optional. Only keys sent will be updated, but an object is required to be sent.

Arguments

  • handlingUnit string

  • number string

  • [DynamicField] string

Request with curl
curl "http://[Your IP] /orders/[id]" \ -X put \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "orders": [{ "id": "string", "orderNumber": "string", "status": "string", "priority": "integer", "creationDate": "datetime", "deadline": "date", "directionType": "integer", "handlingUnit": "string", "warehouse": "string", "errorCode": "integer", "errorDescription": "string", "zones": "array", "orderLines": [{ "number": "integer", }] }

Delete Order

/api/orders/[id]/delete

Delete a specific order from the PPG database and return a JSON response. This will also delete the order lines associated with the order.

Arguments

Request with curl
curl "http://[Your IP] /api/orders/[id]/delete" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "orders": [{ "id": "string", "orderNumber": "string", "status": "string", "priority": "integer", "creationDate": "datetime", "deadline": "date", "directionType": "integer", "handlingUnit": "string", "warehouse": "string", "errorCode": "integer", "errorDescription": "string", "zones": "array", "orderLines": [{ "number": "integer", }] }