• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
Order

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
string

Read only The order's unique ID.

location_id
string

Required

The ID of the merchant location this order is associated with.

Min Length 1
reference_id
string

A client specified identifier to associate an entity in another system with this order.

Max Length 40
source
OrderSource

The origination details of the order.

customer_id
string

Beta

The Customer ID of the customer associated with the order.

Max Length 191
line_items
OrderLineItem [ ]

The line items included in the order.

taxes
OrderLineItemTax [ ]

The list of all taxes associated with the order.

Taxes can be scoped to either ORDER or LINE_ITEM. For taxes with LINE_ITEM scope, an OrderLineItemAppliedTax must be added to each line item that the tax applies to. For taxes with ORDER scope, the server will generate an OrderLineItemAppliedTax for every line item.

On reads, each tax in the list will include the total amount of that tax applied to the order.

IMPORTANT: If LINE_ITEM scope is set on any taxes in this field, usage of the deprecated line_items.taxes field will result in an error. Please use line_items.applied_taxes instead.

discounts
OrderLineItemDiscount [ ]

The list of all discounts associated with the order.

Discounts can be scoped to either ORDER or LINE_ITEM. For discounts scoped to LINE_ITEM, an OrderLineItemAppliedDiscount must be added to each line item that the discount applies to. For discounts with ORDER scope, the server will generate an OrderLineItemAppliedDiscount for every line item.

IMPORTANT: If LINE_ITEM scope is set on any discounts in this field, usage of the deprecated line_items.discounts field will result in an error. Please use line_items.applied_discounts instead.

service_charges
OrderServiceCharge [ ]

A list of service charges applied to the order.

fulfillments
OrderFulfillment [ ]

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
OrderReturn [ ]

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 object per sale Order being referenced.

return_amounts
OrderMoneyAmounts

Beta

Read only Rollup of returned money amounts.

net_amounts
OrderMoneyAmounts

Beta

Read only Net money amounts (sale money - return money).

rounding_adjustment
OrderRoundingAdjustment

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
Tender [ ]

Beta

Read only The Tenders which were used to pay for the Order.

refunds
Refund [ ]

Beta

Read only The Refunds that are part of this Order.

metadata
Map<string, string>

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 [a-zA-Z0-9_-]. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character.

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_at
string

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_at
string

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_at
string

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
string

The current state of the order. OPEN,COMPLETED,CANCELED

version
integer

Beta

Read only 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.

Read more about working with versions.

total_money
Money

Read only The total amount of money to collect for the order.

total_tax_money
Money

Read only The total tax amount of money to collect for the order.

total_discount_money
Money

Read only The total discount amount of money to collect for the order.

total_tip_money
Money

Read only The total tip amount of money to collect for the order.

total_service_charge_money
Money

Read only The total amount of money collected in service charges for the order.

Note: total_service_charge_money is the sum of applied_money fields for each individual service charge. Therefore, total_service_charge_money will only include inclusive tax amounts, not additive tax amounts.

pricing_options
OrderPricingOptions

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
OrderReward [ ]

Beta

Read only A set-like list of rewards that have been added to the order.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?