order-entry.md

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	Getter	Setter
orderId	?string	Optional	The ID of the order.	getOrderId(): ?string	setOrderId(?string orderId): void
version	?int	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.	getVersion(): ?int	setVersion(?int version): void
locationId	?string	Optional	The location ID the order belongs to.	getLocationId(): ?string	setLocationId(?string locationId): void

Example (as JSON)

{
  "order_id": "order_id0",
  "version": 72,
  "location_id": "location_id0"
}