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]
btcPriceSatoshiBigDecimalFor Bitcoin transactions, the price of the buyer's order in satoshi (100 million satoshi equals 1 BTC).[optional]