SquareConnect::V1Order

March 13, 2019 ยท View on GitHub

Description

V1Order

Properties

NameTypeDescriptionNotes
errorsArray<Error>Any errors that occurred during the request.[optional]
idStringThe order's unique identifier.[optional]
buyer_emailStringThe email address of the order's buyer.[optional]
recipient_nameStringThe name of the order's buyer.[optional]
recipient_phone_numberStringThe 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]
shipping_addressAddressThe address to ship the order to.[optional]
subtotal_moneyV1MoneyThe amount of all items purchased in the order, before taxes and shipping.[optional]
total_shipping_moneyV1MoneyThe shipping cost for the order.[optional]
total_tax_moneyV1MoneyThe total of all taxes applied to the order.[optional]
total_price_moneyV1MoneyThe total cost of the order.[optional]
total_discount_moneyV1MoneyThe total of all discounts applied to the order.[optional]
created_atStringThe time when the order was created, in ISO 8601 format.[optional]
updated_atStringThe time when the order was last modified, in ISO 8601 format.[optional]
expires_atStringThe time when the order expires if no action is taken, in ISO 8601 format.[optional]
payment_idStringThe unique identifier of the payment associated with the order.[optional]
buyer_noteStringA note provided by the buyer when the order was created, if any.[optional]
completed_noteStringA note provided by the merchant when the order's state was set to COMPLETED, if any[optional]
refunded_noteStringA note provided by the merchant when the order's state was set to REFUNDED, if any.[optional]
canceled_noteStringA 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]
order_historyArray<V1OrderHistoryEntry>The history of actions associated with the order.[optional]
promo_codeStringThe promo code provided by the buyer, if any.[optional]
btc_receive_addressStringFor Bitcoin transactions, the address that the buyer sent Bitcoin to.[optional]
btc_price_satoshiFloatFor Bitcoin transactions, the price of the buyer's order in satoshi (100 million satoshi equals 1 BTC).[optional]