Orders

Get a list of orders from the PPG database. View the guide on adding filters to List API calls.

Body Parameters

• deadline datetime

  Date by which the order must be completed. Like all date arguments, a [gt], [lt], [lte], for [gte] can be prefixed.

• directionType integer/string

  The type of order. Can use integer or string.

  Possible values:

  1 or "put"
  2 or "pick"
  3 or "return"
  4 or "transport"
  5 or "count"
  7 or "production"

• hasStock integer

  If there is enough stock to fulfill the order.

  Possible values:

  0 = False
  1 = True

• Info1 string

  Information field 1 of the order.

• Info2 string

  Information field 2 of the order.

• Info3 string

  Information field 3 of the order.

• Info4 string

  Information field 4 of the order.

• Info5 string

  Information field 5 of the order.

• modifiedDate datetime

  The date/time this order was last modified. This will either be the creation date if it is still queued, or the processed date. Like all date arguments, a [gt], [lt], [lte], for [gte] can be prefixed.

• name string

  The name of the order.

• priority integer

  Order priority level.

  Possible values:

  1 = Low
  2 = Medium (default)
  3 = High
  4 = Hot (if included)

• stationName string

  Name of the station the order is assigned to.

• status string

  Order status type.

  Possible values:

  "Untouched"
  "Ready for Allocation" (when reverted from "Is Allocated")
  "Is Allocated"
  "In Process" (order is imported but not fully picked/put)
  "processed" (order is fulfilled)

• storageUnits array

  Storage unit(s) where the order is designated to be processed.

• type integer

  Order creation/origin type. Automatically determined.

  Possible values:

  0 = NotSet
  1 = External
  2 = ExtManaged
  3 = Internal
  4 = Manual
  5 = Auto

• warehouseName string

  Name of the warehouse this order belongs in.

• [dynamicField]

  Any dynamic fields that have been set up can be used as a filter. Requires ItemPath's Custom Fields app.

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

  Default value:

  1000
• page integer

  Page numbering is zero-based and uses the value of the "limit" argument. (For example, if limit=20, then page=0 will display the hits from 1 to 20.)

• orderBy string, array

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

Create an order and get a response. An array of at least one Order Line is required. For fields on the Order Lines level, click here. If location details are passed in at both the order and line level, then the line location details will be used.

Body Parameters

• name string LIMIT: 50
  REQUIRED

  The unique order name/number.

  Default value:

  incrementing
• order_lines array
  REQUIRED

  Any amount of order lines related to this order (see Order Lines for more information on fields).
  
  If the order type is Count, "5", then this is not required for order creation. In which case, location content must be passed in the body of the order. ItemPath will then generate individual order lines for each item in the array. See the location argument for examples.

• allocate boolean

  Whether this order should be allocated when imported.

  Possible values:

  true, false

  Default value:

  false
• carriers array

  A list of carriers that this order can be picked or put from. Either an ID or name is required.

  Possible values:

  Example: [{"id": "66AFE69B-695E-469F-9E73-C416A12B727E"}, {"name": "01"}]

• countEmptyLocations boolean

  For count orders only. Determines if locations with that material at a quantity of 0 should be included in the count. Permanent locations must be set up with Power Pick.

  Possible values:

  true, false

  Default value:

  false
• deadline dateTime

  Date by which the order must be completed.

• directionType integer/string

  The type of order. Can use integer or string.

  Possible values:

  1 or "put"
  2 or "pick"
  3 or "return"
  4 or "transport"
  5 or "count"
  7 or "production"

  Default value:

  2 (pick)
• Info1 string LIMIT: 80

  A generic field for custom use.

• Info2 string LIMIT: 80

  A generic field for custom use.

• Info3 string LIMIT: 80

  A generic field for custom use.

• Info4 string LIMIT: 80

  A generic field for custom use.

• Info5 string LIMIT: 80

  A generic field for custom use.

• initialHandlingUnit string LIMIT: 50

  Sets the initial handling unit value (i.e. tote/container/cart number) for all order lines rather than entering manually for each one. The handling unit can be updated during order processing.

• locations array

  A list of locations that this order can be picked or put from. Either an ID or name is required.

  Possible values:

  Example: [{"id": "8B3E44C1-EA03-4F2D-A514-EF5B7AE2BF89"}, {"name": "VLM 1/01/01"}]

• owner string LIMIT: 50

  Used in a transfer order. The owner will be replaced by the given recipient, which will be assigned as the new owner of the material during the put.

• priority integer

  Order priority level.

  Possible values:

  1 = Low
  2 = Medium
  3 = High
  4 = Hot (if included)

  Default value:

  2 (Medium)
• recipient string LIMIT: 50

  Used in a transfer order. The recipient given will be assigned as the new owner of the material during the put.

• shelves array

  A list of shelves that this order can be picked or put from. Either an ID or name is required.

  Possible values:

  Example: [{"id": "7142BF15-38BD-4971-BCB2-D890DDA9CC32"}, {"name": "01/01"}]

• storageUnits array

  A list of storage units that this order can be picked or put from. Either an ID or name is required.

  Possible values:

  Example: [{"id": "3276A9F6-7CE5-4924-A02B-FD8304D7C3A1"},{"id": "18E22E33-11CA-4712-AECF-7A29123C88A5"}, {"name": "VLM 1"}]

• unit string LIMIT: 50

  Used with batches.

• warehouseName string LIMIT: 50

  The name of the Warehouse this order will be associated with. If no warehouse name or id is given, it will use the warehouse associated with the current station.

• warehouseId uuid

  The id of the Warehouse this order will be associated with. Cannot be used with warehouseName.

• zones array

  A list of zones that this order can be picked or put from. Either an ID or name is required.

  Possible values:

  Example: [{"id": "9B937196-FBDC-4462-9D15-E60A7EEB5FA7"}, {"name": "Zone 1"}]

• [dynamicField] string LIMIT: 1999

  Any of the dynamic order fields from Power Pick. Requires ItemPath's Custom Fields app.

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.

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.

Body Parameters

• allocate boolean

  If updated to "true," this will allocate the order. (Updating to false will not deallocate the order. Use the "deallocate" parameter for this.)

• deadline dateTime

  Date by which the order must be completed.

• countEmptyLocations boolean

  For count orders only. Determines if locations with that material at a quantity of 0 should be included in the count. If changed from "true" to "false", order will need to be reallocated.

• deallocate boolean

  If updated to "true," this will deallocate the order. (Updating to false will not allocate the order. Use the "allocate" parameter for this.)

• directionType integer/string

  The type of order. Can use integer or string.

  Possible values:

  1 or "put"
  2 or "pick"
  3 or "return"
  4 or "transport"
  5 or "count"
  7 or "production"

• Info1 string LIMIT: 50

  A generic field for custom use.

• Info2 string LIMIT: 50

  A generic field for custom use.

• Info3 string LIMIT: 50

  A generic field for custom use.

• Info4 string LIMIT: 50

  A generic field for custom use.

• Info5 string LIMIT: 50

  A generic field for custom use.

• initialHandlingUnit string LIMIT: 50

  Sets the initial handling unit value (i.e. tote/container/cart number) for all order lines rather than entering manually for each one. The handling unit can be updated during order processing.

• name string LIMIT: 50

  This updates the unique order name.

• owner string LIMIT: 50

  Used in a transfer order. The owner will be replaced by the given recipient, which will be assigned as the new owner of the material during the put.

• priority integer

  Order priority level.

  Possible values:

  1 = Low
  2 = Medium
  3 = High
  4 = Hot (if included)

• recipient string LIMIT: 50

  Used in a transfer order. The recipient given will be assigned as the new owner of the material during the put.

• unit string LIMIT: 50

  Used with batches.

• [dynamicField] string LIMIT: 1999

  Any of the dynamic order fields from Power Pick. Requires ItemPath's Custom Fields app.

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