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 on 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 merchant location this order is associated with. |
reference_
|
A client specified identifier to associate an entity in another system with this order. |
source
|
The origination details of the order. |
customer_
Beta
|
The Customer ID of the customer associated with the order. |
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 will include 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 on order fulfillment. Orders can only be created with at most one fulfillment. However, orders returned by the API may contain multiple fulfillments. |
returns
Beta
|
Read only Collection of items from sale Orders being returned in this one. Normally part of an
Itemized Return or Exchange. There will be exactly one |
return_
Beta
|
Read only Rollup of returned money amounts. |
net_
Beta
|
Read only Net money amounts (sale money - return money). |
rounding_
Beta
|
Read only A positive or negative rounding adjustment to the total of the order, commonly used to apply Cash Rounding when the minimum unit of account is smaller than the lowest physical denomination of currency. |
tenders
Beta
|
Read only The Tenders which 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 (personally identifiable information, card details, etc.). Keys written by applications must be 60 characters or less and must be in the character set
Values have a max length of 255 characters. An application may 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. See Metadata for more information. |
created_
|
Read only Timestamp for when the order was created. In RFC 3339 format, e.g., "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 Timestamp for when the order was last updated. In RFC 3339 format, e.g., "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 Timestamp for when the order reached a terminal state. In RFC 3339 format, e.g., "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
|
Version number which is incremented each time an update is committed to the order. Orders that were not created through the API will not include a version and thus cannot be updated. |
total_
|
Read only The total amount of money to collect for the order. |
total_
|
Read only The total tax amount of money to collect for the order. |
total_
|
Read only The total discount amount of money to collect for the order. |
total_
|
Read only The total tip amount of money to collect for the order. |
total_
|
Read only The total amount of money collected in service charges for the order. Note: |
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 pre-configured pricing rules. |
rewards
Beta
|
Read only A set-like list of rewards that have been added to the order. |