1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
//! Model struct for Order type
use std::collections::HashMap;
use serde::{Deserialize, Serialize};
use super::{
DateTime, Money, OrderFulfillment, OrderLineItem, OrderLineItemDiscount, OrderLineItemTax,
OrderMoneyAmounts, OrderPricingOptions, OrderReturn, OrderReward, OrderRoundingAdjustment,
OrderServiceCharge, OrderSource, Refund, Tender, enums::OrderState,
};
/// 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.
///
/// All Connect V2 Transactions have all been converted to Orders including all associated
/// itemization data.
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct Order {
/// **Read only** The order's unique ID.
pub id: Option<String>,
/// The ID of the seller location that this order is associated with.
pub location_id: String,
/// A client-specified ID to associate an entity in another system with this order.
pub reference_id: Option<String>,
/// The origination details of the order.
pub source: Option<OrderSource>,
/// The ID of the [Customer] associated with the order.
///
/// **IMPORTANT:** You should specify a `customer_id` if you want the corresponding payment
/// transactions to be explicitly linked to the customer in the Seller Dashboard. If this field
/// is omitted, the `customer_id` assigned to any underlying `Payment` objects is ignored and
/// might result in the creation of new [instant
/// profiles](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles).
pub customer_id: Option<String>,
/// The line items included in the order.
pub line_items: Option<Vec<OrderLineItem>>,
/// The list of all taxes associated with the order.
///
/// Taxes can be scoped to either `ORDER` or `LineItem`. For taxes with `LineItem` scope, an
/// `OrderLineItemAppliedTax` must be added to each line item that the tax applies to. For taxes
/// with `ORDER` scope, the server generates an `OrderLineItemAppliedTax` for every line item.
///
/// On reads, each tax in the list includes the total amount of that tax applied to the order.
///
/// **IMPORTANT:** If `LineItem` scope is set on any taxes in this field, using the deprecated
/// `line_items.taxes` field results in an error. Use `line_items.applied_taxes` instead.
pub taxes: Option<Vec<OrderLineItemTax>>,
/// The list of all discounts associated with the order.
///
/// Discounts can be scoped to either `ORDER` or `LineItem`. For discounts scoped to
/// `LineItem`, an `OrderLineItemAppliedDiscount` must be added to each line item that the
/// discount applies to. For discounts with `ORDER` scope, the server generates an
/// `OrderLineItemAppliedDiscount` for every line item.
///
/// **IMPORTANT:** If `LineItem` scope is set on any discounts in this field, using the
/// deprecated `line_items.discounts` field results in an error. Use
/// `line_items.applied_discounts` instead.
pub discounts: Option<Vec<OrderLineItemDiscount>>,
/// A list of service charges applied to the order.
pub service_charges: Option<Vec<OrderServiceCharge>>,
/// Details about order fulfillment.
///
/// Orders can only be created with at most one fulfillment. However, orders returned by the API
/// might contain multiple fulfillments.
pub fulfillments: Option<Vec<OrderFulfillment>>,
/// **Read only** A collection of items from sale orders being returned in this one. Normally
/// part of an itemized return or exchange. There is exactly one `Return` object per sale
/// `Order` being referenced.
pub returns: Option<Vec<OrderReturn>>,
/// **Read only** A collection of various money amounts.
pub return_amounts: Option<OrderMoneyAmounts>,
/// **Read only** A collection of various money amounts.
pub net_amounts: Option<OrderMoneyAmounts>,
/// **Read only** A rounding adjustment of the money being returned. Commonly used to apply cash
/// rounding when the minimum unit of the account is smaller than the lowest physical
/// denomination of the currency.
pub rounding_adjustment: Option<OrderRoundingAdjustment>,
/// **Read only** The tenders that were used to pay for the order.
pub tenders: Option<Vec<Tender>>,
/// **Read only** The refunds that are part of this order.
pub refunds: Option<Vec<Refund>>,
/// 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 (such as
/// personally identifiable information or card details).
///
/// Keys written by applications must be 60 characters or less and must be in the character set
/// `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are
/// prefixed with a namespace, separated from the key with a ':' character.
///
/// Values have a maximum length of 255 characters.
///
/// An application can 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.
///
/// For more information,
/// see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).
pub metadata: Option<HashMap<String, String>>,
/// **Read only** The timestamp for when the order was created.
pub created_at: Option<DateTime>,
/// **Read only** The timestamp for when the order was last updated.
pub updated_at: Option<DateTime>,
/// **Read only** The timestamp for when the order reached a terminal [state](OrderState).
pub closed_at: Option<DateTime>,
/// The current state of the order.
pub state: Option<OrderState>,
/// The version number, which is incremented each time an update is committed to the order.
/// Orders not created through the API do not include a version number and therefore cannot be
/// updated.
///
/// [Read more about working with
/// versions](https://developer.squareup.com/docs/orders-api/manage-orders#update-orders).
pub version: Option<i32>,
/// **Read only** The total amount of money to collect for the order.
pub total_money: Option<Money>,
/// **Read only** The total amount of tax money to collect for the order.
pub total_tax_money: Option<Money>,
/// **Read only** The total amount of discount money to collect for the order.
pub total_discount_money: Option<Money>,
/// **Read only** The total amount of tip money to collect for the order.
pub total_tip_money: Option<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` only includes inclusive tax amounts,
/// not additive tax amounts.
pub total_service_charge_money: Option<Money>,
/// A short-term identifier for the order (such as a customer first name, table number, or
/// auto-generated order number that resets daily). For orders created in Square Point of Sale,
/// the `ticket_name` is printed on in-person tickets and stubs. It converts to the
/// `kitchen_printing.name` field in the bill cart feature details.
pub ticket_name: Option<String>,
/// 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
/// preconfigured [pricing rules](CatalogPricingRule).
pub pricing_options: Option<OrderPricingOptions>,
/// **Read only** A set-like list of Rewards that have been added to the Order.
pub rewards: Option<Vec<OrderReward>>,
/// **Read only** The net amount of money due on the order.
pub net_amount_due_money: Option<Money>,
}