Sales
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 happenedAthappened•Date
At Time! non-null The date and time when the agreement occurred.
- •ID!non-null
The unique ID for the agreement.
- Anchor to reasonreason•Order
Action Type! non-null The reason the agreement was created.
- Anchor to salessales•Sale
Connection! non-null The sales associated with the agreement.
Anchor to Types implemented inTypes implemented in
- •OBJECT
An agreement associated with an order placement.
- Anchor to happenedAthappened•Date
At Time! non-null The date and time when the agreement occurred.
- •ID!non-null
The unique ID for the agreement.
- Anchor to orderorder•Order!non-null
The order associated with the agreement.
- Anchor to reasonreason•Order
Action Type! non-null The reason the agreement was created.
- Anchor to salessales•Sale
Connection! non-null The sales associated with the agreement.
- •OBJECT
An agreement related to an edit of the order.
- Anchor to happenedAthappened•Date
At Time! non-null The date and time when the agreement occurred.
- •ID!non-null
The unique ID for the agreement.
- Anchor to reasonreason•Order
Action Type! non-null The reason the agreement was created.
- Anchor to salessales•Sale
Connection! non-null The sales associated with the agreement.
- •OBJECT
An agreement for refunding all or a portion of the order between the merchant and the customer.
- Anchor to happenedAthappened•Date
At Time! non-null The date and time when the agreement occurred.
- •ID!non-null
The unique ID for the agreement.
- Anchor to reasonreason•Order
Action Type! non-null The reason the agreement was created.
- Anchor to refundrefund•Refund!non-null
The refund that's associated with the agreement.
- Anchor to salessales•Sale
Connection! non-null The sales associated with the agreement.
- •OBJECT
An agreement between the merchant and customer for a return.
- Anchor to happenedAthappened•Date
At Time! non-null The date and time when the agreement occurred.
- •ID!non-null
The unique ID for the agreement.
- Anchor to reasonreason•Order
Action Type! non-null The reason the agreement was created.
- Anchor to returnreturn•Return!non-null
The return associated with the agreement.
- Anchor to salessales•Sale
Connection! non-null The sales associated with the agreement.