Skip to content

Latest commit

 

History

History
27 lines (18 loc) · 930 Bytes

order-entry.md

File metadata and controls

27 lines (18 loc) · 930 Bytes

Order Entry

A lightweight description of an order that is returned when returned_entries is true on a SearchOrdersRequest.

Structure

OrderEntry

Fields

Name Type Tags Description
orderId string | undefined Optional The ID of the order.
version number | undefined Optional The version number, which is incremented each time an update is committed to the order.
Orders that were not created through the API do not include a version number and
therefore cannot be updated.

Read more about working with versions.
locationId string | undefined Optional The location ID the order belongs to.

Example (as JSON)

{
  "order_id": null,
  "location_id": null
}