Sale
Requires access scope.
An individual sale record associated with a sales agreement. Every money value in an order's sales data is represented in the currency's smallest unit. When amounts are divided across multiple line items, such as taxes or order discounts, the amounts might not divide evenly across all of the line items on the order. To address this, the remaining currency units that couldn't be divided evenly are allocated one at a time, starting with the first line item, until they are all accounted for. In aggregate, the values sum up correctly. In isolation, one line item might have a different tax or discount amount than another line item of the same price, before taxes and discounts. This is because the amount could not be divided evenly across the items. The allocation of currency units across line items is immutable. After they are allocated, currency units are never reallocated or redistributed among the line items.
Anchor to FieldsFields
- actionType (SaleActionType!)
- id (ID!)
- lineType (SaleLineType!)
- quantity (Int)
- taxes ([SaleTax!]!)
- totalAmount (MoneyBag!)
- totalDiscountAmountAfterTaxes (MoneyBag!)
- totalDiscountAmountBeforeTaxes (MoneyBag!)
- totalTaxAmount (MoneyBag!)
- Anchor to actionTypeaction•Sale
Type Action Type! non-null The type of order action that the sale represents.
Show enum values
- •ID!non-null
The unique ID for the sale.
- Anchor to lineTypeline•Sale
Type Line Type! non-null The line type assocated with the sale.
Show enum values
- Anchor to quantityquantity•Int
The number of units either ordered or intended to be returned.
- Anchor to taxestaxes•[Sale
Tax!]! non-null All individual taxes associated with the sale.
Show fields
- Anchor to totalAmounttotal•Money
Amount Bag! non-null The total sale amount after taxes and discounts.
Show fields
- Anchor to totalDiscountAmountAfterTaxestotal•Money
Discount Amount After Taxes Bag! non-null The total discounts allocated to the sale after taxes.
Show fields
- Anchor to totalDiscountAmountBeforeTaxestotal•Money
Discount Amount Before Taxes Bag! non-null The total discounts allocated to the sale before taxes.
Show fields
- Anchor to totalTaxAmounttotal•Money
Tax Amount Bag! non-null The total amount of taxes for the sale.
Show fields
Anchor to Types implemented inTypes implemented in
- AdditionalFeeSale (AdditionalFeeSale)
- AdjustmentSale (AdjustmentSale)
- DutySale (DutySale)
- FeeSale (FeeSale)
- GiftCardSale (GiftCardSale)
- ProductSale (ProductSale)
- ShippingLineSale (ShippingLineSale)
- TipSale (TipSale)
- UnknownSale (UnknownSale)
- •OBJECT
A sale associated with an additional fee charge.
Show fields
- •OBJECT
A sale associated with an order price adjustment.
Show fields
- •OBJECT
A sale associated with a duty charge.
Show fields
- •OBJECT
A sale associated with a fee.
Show fields
- •OBJECT
A sale associated with a gift card.
Show fields
- •OBJECT
A sale associated with a product.
Show fields
- •OBJECT
A sale associated with a shipping charge.
Show fields
- •OBJECT
A sale associated with a tip.
Show fields
- •OBJECT
This is represents new sale types that have been added in future API versions. You may update to a more recent API version to receive additional details about this sale.
Show fields