Skip to main content
enum

The possible order action types for a sales agreement.

An order with a purchase or charge.

An edit to the order.

A refund on the order.

A return on the order.

An unknown agreement action. Represents new actions that may be added in future versions.


Was this section helpful?

•OBJECT

An agreement associated with an order placement.

•OBJECT

An agreement associated with an edit to the order.

•OBJECT

An agreement between the merchant and customer to refund all or a portion of the order.

•OBJECT

An agreement between the merchant and customer for a return.

•INTERFACE

A contract between a merchant and a customer to do business. Shopify creates a sales agreement whenever an order is placed, edited, or refunded. A sales agreement has one or more sales records, which provide itemized details about the initial agreement or subsequent changes made to the order. For example, when a customer places an order, Shopify creates the order, generates a sales agreement, and records a sale for each line item purchased in the order. A sale record is specific to a type of order line. Order lines can represent different things such as a purchased product, a tip added by a customer, shipping costs collected at checkout, and more.


Was this section helpful?