Square.Connect.Model.V1Order

July 10, 2019 ยท View on GitHub

Description

V1Order

Properties

NameTypeDescriptionNotes
ErrorsList<Error>Any errors that occurred during the request.[optional]
IdstringThe order's unique identifier.[optional]
BuyerEmailstringThe email address of the order's buyer.[optional]
RecipientNamestringThe name of the order's buyer.[optional]
RecipientPhoneNumberstringThe phone number to use for the order's delivery.[optional]
StatestringWhether the tax is an ADDITIVE tax or an INCLUSIVE tax. See V1OrderState for possible values[optional]
ShippingAddressAddressThe address to ship the order to.[optional]
SubtotalMoneyV1MoneyThe amount of all items purchased in the order, before taxes and shipping.[optional]
TotalShippingMoneyV1MoneyThe shipping cost for the order.[optional]
TotalTaxMoneyV1MoneyThe total of all taxes applied to the order.[optional]
TotalPriceMoneyV1MoneyThe total cost of the order.[optional]
TotalDiscountMoneyV1MoneyThe total of all discounts applied to the order.[optional]
CreatedAtstringThe time when the order was created, in ISO 8601 format.[optional]
UpdatedAtstringThe time when the order was last modified, in ISO 8601 format.[optional]
ExpiresAtstringThe time when the order expires if no action is taken, in ISO 8601 format.[optional]
PaymentIdstringThe unique identifier of the payment associated with the order.[optional]
BuyerNotestringA note provided by the buyer when the order was created, if any.[optional]
CompletedNotestringA note provided by the merchant when the order's state was set to COMPLETED, if any[optional]
RefundedNotestringA note provided by the merchant when the order's state was set to REFUNDED, if any.[optional]
CanceledNotestringA note provided by the merchant when the order's state was set to CANCELED, if any.[optional]
TenderV1TenderThe tender used to pay for the order.[optional]
OrderHistoryList<V1OrderHistoryEntry>The history of actions associated with the order.[optional]
PromoCodestringThe promo code provided by the buyer, if any.[optional]
BtcReceiveAddressstringFor Bitcoin transactions, the address that the buyer sent Bitcoin to.[optional]
BtcPriceSatoshidecimal?For Bitcoin transactions, the price of the buyer's order in satoshi (100 million satoshi equals 1 BTC).[optional]

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