Object Index
You are viewing an old version of the API
Order
Object Index
Contains all information related to a single order to process with Square, including line items that specify the products to purchase.
Order
objects also
include information about any associated tenders, refunds, and returns.
All Connect V2 Transactions have all been converted to Orders including all associated itemization data.
Properties
Name | Description |
---|---|
id
|
Read only The order's unique ID. |
location_
Required
|
The ID of the seller location that this order is associated with. |
reference_
|
A client-specified ID to associate an entity in another system with this order. |
source
|
The origination details of the order. |
customer_
Beta
|
The ID of the customer associated with the order. IMPORTANT: You should specify a |
line_
|
The line items included in the order. |
taxes
|
The list of all taxes associated with the order. Taxes can be scoped to either On reads, each tax in the list includes the total amount of that tax applied to the order. IMPORTANT: If |
discounts
|
The list of all discounts associated with the order. Discounts can be scoped to either IMPORTANT: If |
service_
|
A list of service charges applied to the order. |
fulfillments
|
Details about order fulfillment. Orders can only be created with at most one fulfillment. However, orders returned by the API might contain multiple fulfillments. |
returns
Beta
|
Read only A collection of items from sale orders being returned in this one. Normally part of an
itemized return or exchange. There is exactly one |
return_
Beta
|
Read only The rollup of the returned money amounts. |
net_
Beta
|
Read only The net money amounts (sale money - return money). |
rounding_
Beta
|
Read only A positive rounding adjustment to the total of the order. This adjustment is commonly used to apply cash rounding when the minimum unit of account is smaller than the lowest physical denomination of the currency. |
tenders
Beta
|
Read only The tenders that were used to pay for the order. |
refunds
Beta
|
Read only The refunds that are part of this order. |
metadata
Beta
|
Application-defined data attached to this order. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (such as personally identifiable information or card details). Keys written by applications must be 60 characters or less and must be in the character set
Values have a maximum length of 255 characters. An application can have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. For more information, see Metadata. |
created_
|
Read only The timestamp for when the order was created, in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 |
updated_
|
Read only The timestamp for when the order was last updated, in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 |
closed_
|
Read only The timestamp for when the order reached a terminal state, in RFC 3339 format (for example "2016-09-04T23:59:33.123Z"). Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 |
state
|
The current state of the order. |
version
Beta
|
The version number, which is incremented each time an update is committed to the order. Orders not created through the API do not include a version number and therefore cannot be updated. |
total_
|
Read only The total amount of money to collect for the order. |
total_
|
Read only The total amount of tax money to collect for the order. |
total_
|
Read only The total amount of discount money to collect for the order. |
total_
|
Read only The total amount of tip money to collect for the order. |
total_
|
Read only The total amount of money collected in service charges for the order. Note: |
ticket_
Beta
|
A short-term identifier for the order (such as a customer first name, table number, or auto-generated order number that resets daily). |
pricing_
|
Pricing options for an order. The options affect how the order's price is calculated. They can be used, for example, to apply automatic price adjustments that are based on preconfigured pricing rules. |
rewards
Beta
|
Read only A set-like list of Rewards that have been added to the Order. |
net_
|
Read only The net amount of money due on the order. |