Choose a version:

Sale

interface

Requires read_orders 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

Anchor to actionTypeactionType •SaleActionType! non-null: The type of order action that the sale represents.
Anchor to idid •ID! non-null: The unique ID for the sale.
Anchor to lineTypelineType •SaleLineType! non-null: The line type assocated with the sale.
Anchor to quantityquantity •Int: The number of units either ordered or intended to be returned.
Anchor to taxestaxes •[SaleTax!]! non-null: All individual taxes associated with the sale.
Anchor to totalAmounttotalAmount •MoneyBag! non-null: The total sale amount after taxes and discounts.
Anchor to totalDiscountAmountAfterTaxestotalDiscountAmountAfterTaxes •MoneyBag! non-null: The total discounts allocated to the sale after taxes.
Anchor to totalDiscountAmountBeforeTaxestotalDiscountAmountBeforeTaxes •MoneyBag! non-null: The total discounts allocated to the sale before taxes.
Anchor to totalTaxAmounttotalTaxAmount •MoneyBag! non-null: The total amount of taxes for the sale.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

AdditionalFeeSale

•OBJECT

A sale associated with an additional fee charge.

Anchor to actionTypeactionType •SaleActionType! non-null: The type of order action that the sale represents.
Anchor to additionalFeeadditionalFee •SaleAdditionalFee! non-null: The additional fees for the associated sale.
Anchor to idid •ID! non-null: The unique ID for the sale.
Anchor to lineTypelineType •SaleLineType! non-null: The line type assocated with the sale.
Anchor to quantityquantity •Int: The number of units either ordered or intended to be returned.
Anchor to taxestaxes •[SaleTax!]! non-null: All individual taxes associated with the sale.
Anchor to totalAmounttotalAmount •MoneyBag! non-null: The total sale amount after taxes and discounts.
Anchor to totalDiscountAmountAfterTaxestotalDiscountAmountAfterTaxes •MoneyBag! non-null: The total discounts allocated to the sale after taxes.
Anchor to totalDiscountAmountBeforeTaxestotalDiscountAmountBeforeTaxes •MoneyBag! non-null: The total discounts allocated to the sale before taxes.
Anchor to totalTaxAmounttotalTaxAmount •MoneyBag! non-null: The total amount of taxes for the sale.

AdjustmentSale

•OBJECT

A sale associated with an order price adjustment.

Anchor to actionTypeactionType •SaleActionType! non-null: The type of order action that the sale represents.
Anchor to idid •ID! non-null: The unique ID for the sale.
Anchor to lineTypelineType •SaleLineType! non-null: The line type assocated with the sale.
Anchor to quantityquantity •Int: The number of units either ordered or intended to be returned.
Anchor to taxestaxes •[SaleTax!]! non-null: All individual taxes associated with the sale.
Anchor to totalAmounttotalAmount •MoneyBag! non-null: The total sale amount after taxes and discounts.
Anchor to totalDiscountAmountAfterTaxestotalDiscountAmountAfterTaxes •MoneyBag! non-null: The total discounts allocated to the sale after taxes.
Anchor to totalDiscountAmountBeforeTaxestotalDiscountAmountBeforeTaxes •MoneyBag! non-null: The total discounts allocated to the sale before taxes.
Anchor to totalTaxAmounttotalTaxAmount •MoneyBag! non-null: The total amount of taxes for the sale.

DutySale

•OBJECT

A sale associated with a duty charge.

Anchor to actionTypeactionType •SaleActionType! non-null: The type of order action that the sale represents.
Anchor to dutyduty •Duty! non-null: The duty for the associated sale.
Anchor to idid •ID! non-null: The unique ID for the sale.
Anchor to lineTypelineType •SaleLineType! non-null: The line type assocated with the sale.
Anchor to quantityquantity •Int: The number of units either ordered or intended to be returned.
Anchor to taxestaxes •[SaleTax!]! non-null: All individual taxes associated with the sale.
Anchor to totalAmounttotalAmount •MoneyBag! non-null: The total sale amount after taxes and discounts.
Anchor to totalDiscountAmountAfterTaxestotalDiscountAmountAfterTaxes •MoneyBag! non-null: The total discounts allocated to the sale after taxes.
Anchor to totalDiscountAmountBeforeTaxestotalDiscountAmountBeforeTaxes •MoneyBag! non-null: The total discounts allocated to the sale before taxes.
Anchor to totalTaxAmounttotalTaxAmount •MoneyBag! non-null: The total amount of taxes for the sale.

FeeSale

•OBJECT

A sale associated with a fee.

Anchor to actionTypeactionType •SaleActionType! non-null: The type of order action that the sale represents.
Anchor to feefee •Fee: The fee associated with the sale. It can be null if the fee was deleted.
Anchor to idid •ID! non-null: The unique ID for the sale.
Anchor to lineTypelineType •SaleLineType! non-null: The line type assocated with the sale.
Anchor to quantityquantity •Int: The number of units either ordered or intended to be returned.
Anchor to taxestaxes •[SaleTax!]! non-null: All individual taxes associated with the sale.
Anchor to totalAmounttotalAmount •MoneyBag! non-null: The total sale amount after taxes and discounts.
Anchor to totalDiscountAmountAfterTaxestotalDiscountAmountAfterTaxes •MoneyBag! non-null: The total discounts allocated to the sale after taxes.
Anchor to totalDiscountAmountBeforeTaxestotalDiscountAmountBeforeTaxes •MoneyBag! non-null: The total discounts allocated to the sale before taxes.
Anchor to totalTaxAmounttotalTaxAmount •MoneyBag! non-null: The total amount of taxes for the sale.

GiftCardSale

•OBJECT

A sale associated with a gift card.

Anchor to actionTypeactionType •SaleActionType! non-null: The type of order action that the sale represents.
Anchor to idid •ID! non-null: The unique ID for the sale.
Anchor to lineItemlineItem •LineItem! non-null: The line item for the associated sale.
Anchor to lineTypelineType •SaleLineType! non-null: The line type assocated with the sale.
Anchor to quantityquantity •Int: The number of units either ordered or intended to be returned.
Anchor to taxestaxes •[SaleTax!]! non-null: All individual taxes associated with the sale.
Anchor to totalAmounttotalAmount •MoneyBag! non-null: The total sale amount after taxes and discounts.
Anchor to totalDiscountAmountAfterTaxestotalDiscountAmountAfterTaxes •MoneyBag! non-null: The total discounts allocated to the sale after taxes.
Anchor to totalDiscountAmountBeforeTaxestotalDiscountAmountBeforeTaxes •MoneyBag! non-null: The total discounts allocated to the sale before taxes.
Anchor to totalTaxAmounttotalTaxAmount •MoneyBag! non-null: The total amount of taxes for the sale.

ProductSale

•OBJECT

A sale associated with a product.

Anchor to actionTypeactionType •SaleActionType! non-null: The type of order action that the sale represents.
Anchor to idid •ID! non-null: The unique ID for the sale.
Anchor to lineItemlineItem •LineItem! non-null: The line item for the associated sale.
Anchor to lineTypelineType •SaleLineType! non-null: The line type assocated with the sale.
Anchor to quantityquantity •Int: The number of units either ordered or intended to be returned.
Anchor to taxestaxes •[SaleTax!]! non-null: All individual taxes associated with the sale.
Anchor to totalAmounttotalAmount •MoneyBag! non-null: The total sale amount after taxes and discounts.
Anchor to totalDiscountAmountAfterTaxestotalDiscountAmountAfterTaxes •MoneyBag! non-null: The total discounts allocated to the sale after taxes.
Anchor to totalDiscountAmountBeforeTaxestotalDiscountAmountBeforeTaxes •MoneyBag! non-null: The total discounts allocated to the sale before taxes.
Anchor to totalTaxAmounttotalTaxAmount •MoneyBag! non-null: The total amount of taxes for the sale.

ShippingLineSale

•OBJECT

A sale associated with a shipping charge.

Anchor to actionTypeactionType •SaleActionType! non-null: The type of order action that the sale represents.
Anchor to idid •ID! non-null: The unique ID for the sale.
Anchor to lineTypelineType •SaleLineType! non-null: The line type assocated with the sale.
Anchor to quantityquantity •Int: The number of units either ordered or intended to be returned.
Anchor to shippingLineshippingLine •ShippingLine: The shipping line item for the associated sale. shippingLine is not available if the SaleActionType is a return.
Anchor to taxestaxes •[SaleTax!]! non-null: All individual taxes associated with the sale.
Anchor to totalAmounttotalAmount •MoneyBag! non-null: The total sale amount after taxes and discounts.
Anchor to totalDiscountAmountAfterTaxestotalDiscountAmountAfterTaxes •MoneyBag! non-null: The total discounts allocated to the sale after taxes.
Anchor to totalDiscountAmountBeforeTaxestotalDiscountAmountBeforeTaxes •MoneyBag! non-null: The total discounts allocated to the sale before taxes.
Anchor to totalTaxAmounttotalTaxAmount •MoneyBag! non-null: The total amount of taxes for the sale.

TipSale

•OBJECT

A sale associated with a tip.

Anchor to actionTypeactionType •SaleActionType! non-null: The type of order action that the sale represents.
Anchor to idid •ID! non-null: The unique ID for the sale.
Anchor to lineItemlineItem •LineItem! non-null: The line item for the associated sale.
Anchor to lineTypelineType •SaleLineType! non-null: The line type assocated with the sale.
Anchor to quantityquantity •Int: The number of units either ordered or intended to be returned.
Anchor to taxestaxes •[SaleTax!]! non-null: All individual taxes associated with the sale.
Anchor to totalAmounttotalAmount •MoneyBag! non-null: The total sale amount after taxes and discounts.
Anchor to totalDiscountAmountAfterTaxestotalDiscountAmountAfterTaxes •MoneyBag! non-null: The total discounts allocated to the sale after taxes.
Anchor to totalDiscountAmountBeforeTaxestotalDiscountAmountBeforeTaxes •MoneyBag! non-null: The total discounts allocated to the sale before taxes.
Anchor to totalTaxAmounttotalTaxAmount •MoneyBag! non-null: The total amount of taxes for the sale.

UnknownSale

•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.

Anchor to actionTypeactionType •SaleActionType! non-null: The type of order action that the sale represents.
Anchor to idid •ID! non-null: The unique ID for the sale.
Anchor to lineTypelineType •SaleLineType! non-null: The line type assocated with the sale.
Anchor to quantityquantity •Int: The number of units either ordered or intended to be returned.
Anchor to taxestaxes •[SaleTax!]! non-null: All individual taxes associated with the sale.
Anchor to totalAmounttotalAmount •MoneyBag! non-null: The total sale amount after taxes and discounts.
Anchor to totalDiscountAmountAfterTaxestotalDiscountAmountAfterTaxes •MoneyBag! non-null: The total discounts allocated to the sale after taxes.
Anchor to totalDiscountAmountBeforeTaxestotalDiscountAmountBeforeTaxes •MoneyBag! non-null: The total discounts allocated to the sale before taxes.
Anchor to totalTaxAmounttotalTaxAmount •MoneyBag! non-null: The total amount of taxes for the sale.

Was this section helpful?