Square · Schema
Square 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 about any associated tenders, refunds, and returns.
BookingsCatalogCheckoutCustomersDisputesEcommerceFinancial TechnologyGift CardsInventoryInvoicingLaborLocationsLoyaltyMerchantsOrdersPaymentsPoint of SaleRefundsRetailSubscriptionsTeamTerminalWebhooks
Properties
| Name | Type | Description |
|---|---|---|
| id | string | The order's unique ID. |
| location_id | string | The ID of the seller location that this order is associated with. |
| reference_id | string | A client-specified ID to associate an entity in another system with this order. |
| source | object | The origination details of the order. |
| customer_id | string | The ID of the customer associated with the order. |
| line_items | array | The line items included in the order. |
| taxes | array | The list of all taxes associated with the order. |
| discounts | array | The list of all discounts associated with the order. |
| service_charges | array | A list of service charges applied to the order. |
| fulfillments | array | Details about order fulfillment. |
| returns | array | A collection of items from sale orders being returned in this one. |
| return_amounts | object | The rollup of the returned money amounts. |
| net_amounts | object | The net money amounts (sale money - return money). |
| rounding_adjustment | object | A positive rounding adjustment to the total of the order. |
| tenders | array | The tenders that were used to pay for the order. |
| refunds | array | The refunds that are part of this order. |
| metadata | object | Application-defined data attached to this order. Metadata fields are intended to store descriptive references or associations with an entity in another system. |
| created_at | string | The timestamp for when the order was created, in RFC 3339 format. |
| updated_at | string | The timestamp for when the order was last updated, in RFC 3339 format. |
| closed_at | string | The timestamp for when the order reached a terminal state, in RFC 3339 format. |
| state | string | The current state of the order. |
| version | integer | The version number, incremented each time an update is committed to the order. |
| total_money | object | The total amount of money to collect for the order. |
| total_tax_money | object | The total amount of tax money to collect for the order. |
| total_discount_money | object | The total amount of discount money to collect for the order. |
| total_tip_money | object | The total amount of tip money to collect for the order. |
| total_service_charge_money | object | The total amount of service charge money to collect for the order. |
| ticket_name | string | A short-term identifier for the order used on receipts, the Seller Dashboard, and the Point of Sale device. |
| pricing_options | object | Pricing options for an order. |