Sale Action Type
An order action type associated with a sale.
Anchor to Valid valuesValid values
- Anchor to ORDERORDER
A purchase or charge.
- Anchor to RETURNRETURN
A removal or return.
- Anchor to UNKNOWNUNKNOWN
An unidentified order action. Represents new actions that may be added in future versions.
- Anchor to UPDATEUPDATE
A change to the price, taxes, or discounts for a previous purchase.
Anchor to FieldsFields
- •OBJECT
A sale that includes an additional fee charge.
- •OBJECT
A sale event that results in an adjustment to the order price.
- •OBJECT
A sale that includes a duty charge.
- •OBJECT
A sale associated with a fee.
- •OBJECT
A sale associated with a gift card.
- •OBJECT
A sale associated with a product.
- •INTERFACE
A record of an individual sale associated with a sales agreement. Every monetary value in an order's sales data is represented in the smallest unit of the currency. 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.
- •OBJECT
A sale associated with a shipping charge.
- •OBJECT
A sale that is associated with a tip.
- •OBJECT
This 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.