squareconnect.models.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.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The order's unique ID. This field is read-only. | [optional] |
| location_id | str | The ID of the merchant location this order is associated with. | |
| reference_id | str | A client specified identifier to associate an entity in another system with this order. | [optional] |
| source | OrderSource | The origination details of the order. | [optional] |
| customer_id | str | The Customer ID of the customer associated with the order. | [optional] |
| line_items | list[OrderLineItem] | The line items included in the order. | [optional] |
| taxes | list[OrderLineItemTax] | A list of taxes applied to this order. On read or retrieve, this list includes both order-level and item-level taxes. When creating an Order, set your order-level taxes in this list. | [optional] |
| discounts | list[OrderLineItemDiscount] | A list of discounts applied to this order. On read or retrieve, this list includes both order-level and item-level discounts. When creating an Order, set your order-level discounts in this list. | [optional] |
| service_charges | list[OrderServiceCharge] | A list of service charges applied to the order. | [optional] |
| fulfillments | list[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. | [optional] |
| returns | list[OrderReturn] | 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. This field is read-only. | [optional] |
| return_amounts | OrderMoneyAmounts | Rollup of returned money amounts. This field is read-only. | [optional] |
| net_amounts | OrderMoneyAmounts | Net money amounts (sale money - return money). This field is read-only. | [optional] |
| rounding_adjustment | OrderRoundingAdjustment | 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. This field is read-only. | [optional] |
| tenders | list[Tender] | The Tenders which were used to pay for the Order. This field is read-only. | [optional] |
| refunds | list[Refund] | The Refunds that are part of this Order. This field is read-only. | [optional] |
| created_at | str | Timestamp for when the order was created. In RFC 3339 format, e.g., "2016-09-04T23:59:33.123Z". This field is read-only. | [optional] |
| updated_at | str | Timestamp for when the order was last updated. In RFC 3339 format, e.g., "2016-09-04T23:59:33.123Z". This field is read-only. | [optional] |
| closed_at | str | Timestamp for when the order was closed. In RFC 3339 format, e.g., "2016-09-04T23:59:33.123Z". This field is read-only. | [optional] |
| state | str | The current state of the order. `OPEN`,`COMPLETED`,`CANCELED` See OrderState for possible values | [optional] |
| total_money | Money | The total amount of money to collect for the order. This field is read-only. | [optional] |
| total_tax_money | Money | The total tax amount of money to collect for the order. This field is read-only. | [optional] |
| total_discount_money | Money | The total discount amount of money to collect for the order. This field is read-only. | [optional] |
| total_service_charge_money | Money | 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. This field is read-only. | [optional] |