Choose a version:

SalesAgreement

interface

Requires read_orders access scope or read_marketplace_orders access scope.

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.

Anchor to FieldsFields

Anchor to appapp •App: The application that created the agreement.
Anchor to happenedAthappenedAt •DateTime! non-null: The date and time at which the agreement occured.
Anchor to idid •ID! non-null: The unique ID for the agreement.
Anchor to reasonreason •OrderActionType! non-null: The reason the agremeent was created.
Anchor to salessales •SaleConnection! non-null: The sales associated with the agreement.
Anchor to useruser •StaffMember: The staff member associated with the agreement.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

OrderAgreement

•OBJECT

An agreement associated with an order placement.

Anchor to appapp •App: The application that created the agreement.
Anchor to happenedAthappenedAt •DateTime! non-null: The date and time at which the agreement occured.
Anchor to idid •ID! non-null: The unique ID for the agreement.
Anchor to orderorder •Order! non-null: The order associated with the agreement.
Anchor to reasonreason •OrderActionType! non-null: The reason the agremeent was created.
Anchor to salessales •SaleConnection! non-null: The sales associated with the agreement.
Anchor to useruser •StaffMember: The staff member associated with the agreement.

OrderEditAgreement

•OBJECT

An agreement associated with an edit to the order.

Anchor to appapp •App: The application that created the agreement.
Anchor to happenedAthappenedAt •DateTime! non-null: The date and time at which the agreement occured.
Anchor to idid •ID! non-null: The unique ID for the agreement.
Anchor to reasonreason •OrderActionType! non-null: The reason the agremeent was created.
Anchor to salessales •SaleConnection! non-null: The sales associated with the agreement.
Anchor to useruser •StaffMember: The staff member associated with the agreement.

RefundAgreement

•OBJECT

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

Anchor to appapp •App: The application that created the agreement.
Anchor to happenedAthappenedAt •DateTime! non-null: The date and time at which the agreement occured.
Anchor to idid •ID! non-null: The unique ID for the agreement.
Anchor to reasonreason •OrderActionType! non-null: The reason the agremeent was created.
Anchor to refundrefund •Refund! non-null: The refund associated with the agreement.
Anchor to salessales •SaleConnection! non-null: The sales associated with the agreement.
Anchor to useruser •StaffMember: The staff member associated with the agreement.

ReturnAgreement

•OBJECT

An agreement between the merchant and customer for a return.

Anchor to appapp •App: The application that created the agreement.
Anchor to happenedAthappenedAt •DateTime! non-null: The date and time at which the agreement occured.
Anchor to idid •ID! non-null: The unique ID for the agreement.
Anchor to reasonreason •OrderActionType! non-null: The reason the agremeent was created.
Anchor to returnreturn •Return! non-null: The return associated with the agreement.
Anchor to salessales •SaleConnection! non-null: The sales associated with the agreement.
Anchor to useruser •StaffMember: The staff member associated with the agreement.

Was this section helpful?