V1Order
March 13, 2019 ยท View on GitHub
squareconnect.models.v1_order
Description
V1Order
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| errors | list[Error] | Any errors that occurred during the request. | [optional] |
| id | str | The order's unique identifier. | [optional] |
| buyer_email | str | The email address of the order's buyer. | [optional] |
| recipient_name | str | The name of the order's buyer. | [optional] |
| recipient_phone_number | str | The phone number to use for the order's delivery. | [optional] |
| state | str | Whether the tax is an ADDITIVE tax or an INCLUSIVE tax. See V1OrderState for possible values | [optional] |
| shipping_address | Address | The address to ship the order to. | [optional] |
| subtotal_money | V1Money | The amount of all items purchased in the order, before taxes and shipping. | [optional] |
| total_shipping_money | V1Money | The shipping cost for the order. | [optional] |
| total_tax_money | V1Money | The total of all taxes applied to the order. | [optional] |
| total_price_money | V1Money | The total cost of the order. | [optional] |
| total_discount_money | V1Money | The total of all discounts applied to the order. | [optional] |
| created_at | str | The time when the order was created, in ISO 8601 format. | [optional] |
| updated_at | str | The time when the order was last modified, in ISO 8601 format. | [optional] |
| expires_at | str | The time when the order expires if no action is taken, in ISO 8601 format. | [optional] |
| payment_id | str | The unique identifier of the payment associated with the order. | [optional] |
| buyer_note | str | A note provided by the buyer when the order was created, if any. | [optional] |
| completed_note | str | A note provided by the merchant when the order's state was set to COMPLETED, if any | [optional] |
| refunded_note | str | A note provided by the merchant when the order's state was set to REFUNDED, if any. | [optional] |
| canceled_note | str | A note provided by the merchant when the order's state was set to CANCELED, if any. | [optional] |
| tender | V1Tender | The tender used to pay for the order. | [optional] |
| order_history | list[V1OrderHistoryEntry] | The history of actions associated with the order. | [optional] |
| promo_code | str | The promo code provided by the buyer, if any. | [optional] |
| btc_receive_address | str | For Bitcoin transactions, the address that the buyer sent Bitcoin to. | [optional] |
| btc_price_satoshi | float | For Bitcoin transactions, the price of the buyer's order in satoshi (100 million satoshi equals 1 BTC). | [optional] |