Skip to content

Latest commit

 

History

History
37 lines (34 loc) · 6.42 KB

Order.md

File metadata and controls

37 lines (34 loc) · 6.42 KB
Raw

Order

Properties

Name Type Description Notes
Id string The order's unique ID. [optional] [default to null]
LocationId string The ID of the merchant location this order is associated with. [default to null]
ReferenceId string A client specified identifier to associate an entity in another system with this order. [optional] [default to null]
Source *OrderSource [optional] [default to null]
CustomerId string The `Customer` ID of the customer associated with the order. [optional] [default to null]
LineItems []OrderLineItem The line items included in the order. [optional] [default to null]
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. [optional] [default to null]
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. [optional] [default to null]
ServiceCharges []OrderServiceCharge A list of service charges applied to the order. [optional] [default to null]
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. [optional] [default to null]
Returns []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. [optional] [default to null]
ReturnAmounts *OrderMoneyAmounts [optional] [default to null]
NetAmounts *OrderMoneyAmounts [optional] [default to null]
RoundingAdjustment *OrderRoundingAdjustment [optional] [default to null]
Tenders []Tender The Tenders which were used to pay for the Order. [optional] [default to null]
Refunds []Refund The Refunds that are part of this Order. [optional] [default to null]
Metadata map[string]string 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. [optional] [default to null]
CreatedAt string Timestamp for when the order was created. In RFC 3339 format, e.g., "2016-09-04T23:59:33.123Z". [optional] [default to null]
UpdatedAt string Timestamp for when the order was last updated. In RFC 3339 format, e.g., "2016-09-04T23:59:33.123Z". [optional] [default to null]
ClosedAt string Timestamp for when the order reached a terminal state. In RFC 3339 format, e.g., "2016-09-04T23:59:33.123Z". [optional] [default to null]
State string The current state of the order. `OPEN`,`COMPLETED`,`CANCELED` See OrderState for possible values [optional] [default to null]
Version int32 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. [optional] [default to null]
TotalMoney *Money [optional] [default to null]
TotalTaxMoney *Money [optional] [default to null]
TotalDiscountMoney *Money [optional] [default to null]
TotalTipMoney *Money [optional] [default to null]
TotalServiceChargeMoney *Money [optional] [default to null]
PricingOptions *OrderPricingOptions [optional] [default to null]
Rewards []OrderReward A set-like list of rewards that have been added to the order. [optional] [default to null]

[Back to Model list] [Back to API list] [Back to README]