Choose a version:

Transaction

interface

A Shopify Partner transaction.

Anchor to FieldsFields

Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the transaction was recorded.
Anchor to idid •ID! non-null: The transaction ID.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

AppOneTimeSale

•OBJECT

A transaction corresponding to a one-time app charge.

Anchor to appapp •App! non-null: The app associated with the sale.
Anchor to chargeIdchargeId •ID: The ID of the app charge associated with the transaction. Example value: gid://shopify/AppUsageRecord/1234. This value might be null for transactions that occurred before September 2020.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the transaction was recorded.
Anchor to grossAmountgrossAmount •Money: The total amount that the merchant paid, excluding taxes.
Anchor to idid •ID! non-null: The transaction ID.
Anchor to netAmountnetAmount •Money! non-null: The net amount that is added to or deducted from your payout.
Anchor to shopshop •Shop: The shop associated with the transaction.
Anchor to shopifyFeeshopifyFee •Money: The amount that Shopify retained from the sale.

AppSaleAdjustment

•OBJECT

A transaction corresponding to a refund, downgrade, or adjustment of an app charge.

Anchor to appapp •App! non-null: The app associated with the refund.
Anchor to chargeIdchargeId •ID: The ID of the app charge associated with the transaction. Example value: gid://shopify/AppUsageRecord/1234. This value might be null for transactions that occurred before September 2020.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the transaction was recorded.
Anchor to grossAmountgrossAmount •Money: The total amount that the merchant paid, excluding taxes.
Anchor to idid •ID! non-null: The transaction ID.
Anchor to netAmountnetAmount •Money! non-null: The net amount that is added to or deducted from your payout.
Anchor to shopshop •Shop: The shop associated with the transaction.
Anchor to shopifyFeeshopifyFee •Money: The amount that Shopify retained from the adjustment.

AppSaleCredit

•OBJECT

A transaction corresponding to an app credit.

Anchor to appapp •App! non-null: The app associated with the sale.
Anchor to chargeIdchargeId •ID: The ID of the app charge associated with the transaction. Example value: gid://shopify/AppUsageRecord/1234. This value might be null for transactions that occurred before September 2020.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the transaction was recorded.
Anchor to grossAmountgrossAmount •Money: The total amount that the merchant paid, excluding taxes.
Anchor to idid •ID! non-null: The transaction ID.
Anchor to netAmountnetAmount •Money! non-null: The net amount that is added to or deducted from your payout.
Anchor to shopshop •Shop: The shop associated with the transaction.
Anchor to shopifyFeeshopifyFee •Money: The amount that Shopify retained from the sale.

AppSubscriptionSale

•OBJECT

A transaction corresponding to an app subscription charge.

Anchor to appapp •App! non-null: The app associated with the sale.
Anchor to billingIntervalbillingInterval •AppPricingInterval: The billing frequency for the app.
Anchor to chargeIdchargeId •ID: The ID of the app charge associated with the transaction. Example value: gid://shopify/AppUsageRecord/1234. This value might be null for transactions that occurred before September 2020.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the transaction was recorded.
Anchor to grossAmountgrossAmount •Money: The total amount that the merchant paid, excluding taxes.
Anchor to idid •ID! non-null: The transaction ID.
Anchor to netAmountnetAmount •Money! non-null: The net amount that is added to or deducted from your payout.
Anchor to shopshop •Shop: The shop associated with the transaction.
Anchor to shopifyFeeshopifyFee •Money: The amount that Shopify retained from the sale.

AppUsageSale

•OBJECT

A transaction corresponding to an app usage charge.

Anchor to appapp •App! non-null: The app associated with the sale.
Anchor to chargeIdchargeId •ID: The ID of the app charge associated with the transaction. Example value: gid://shopify/AppUsageRecord/1234. This value might be null for transactions that occurred before September 2020.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the transaction was recorded.
Anchor to grossAmountgrossAmount •Money: The total amount that the merchant paid, excluding taxes.
Anchor to idid •ID! non-null: The transaction ID.
Anchor to netAmountnetAmount •Money! non-null: The net amount that is added to or deducted from your payout.
Anchor to shopshop •Shop: The shop associated with the transaction.
Anchor to shopifyFeeshopifyFee •Money: The amount that Shopify retained from the sale.

LegacyTransaction

•OBJECT

A transaction of a type that is no longer supported.

Anchor to amountamount •Money! non-null: The net amount that is added to or deducted from your payout.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the transaction was recorded.
Anchor to idid •ID! non-null: The transaction ID.
Anchor to shopshop •Shop: The shop associated with the transaction.

ReferralAdjustment

•OBJECT

A transaction corresponding to a shop referral adjustment.

Anchor to amountamount •Money! non-null: The net amount that is added to or deducted from your payout.
Anchor to categorycategory •ReferralCategory! non-null: The referral type.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the transaction was recorded.
Anchor to idid •ID! non-null: The transaction ID.
Anchor to shopshop •Shop: The referred shop.

ReferralTransaction

•OBJECT

A transaction corresponding to a shop referral.

Anchor to amountamount •Money! non-null: The net amount that is added to your payout.
Anchor to categorycategory •ReferralCategory! non-null: The referral type.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the transaction was recorded.
Anchor to idid •ID! non-null: The transaction ID.
Anchor to shopshop •Shop! non-null: The referred shop.

ServiceSale

•OBJECT

A transaction corresponding to a paid invoice for a service.

Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the transaction was recorded.
Anchor to grossAmountgrossAmount •Money: The total amount that the merchant paid, excluding taxes.
Anchor to idid •ID! non-null: The transaction ID.
Anchor to netAmountnetAmount •Money! non-null: The net amount that is added to or deducted from your payout.
Anchor to shopshop •Shop: The shop associated with the transaction.
Anchor to shopifyFeeshopifyFee •Money: The amount that Shopify retained from the sale.

ServiceSaleAdjustment

•OBJECT

A transaction corresponding to a refund, downgrade, or adjustment of a service sale.

Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the transaction was recorded.
Anchor to grossAmountgrossAmount •Money: The total amount that the merchant paid, excluding taxes.
Anchor to idid •ID! non-null: The transaction ID.
Anchor to netAmountnetAmount •Money! non-null: The net amount that is added to or deducted from your payout.
Anchor to shopshop •Shop: The shop associated with the transaction.
Anchor to shopifyFeeshopifyFee •Money: The amount that Shopify retained from the adjustment.

TaxTransaction

•OBJECT

Tax transactions are not computed for pending transactions. Instead, they're rolled up as one transaction per payout. The type of tax and the way it's computed is dependent on the type of transaction.

For sale transactions, such as app subscriptions or theme purchases, Shopify charges the Partner tax on the fee collected for brokering the transaction. The amount is a negative number in this scenario.

For referral transactions, such as a development store transfer, Shopify pays the Partner a commission. The tax represents any taxes on the referral commission that are payable to the Partner. The amount is a positive number in this scenario.

Anchor to amountamount •Money! non-null: The net amount that is added to or deducted from your payout.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the transaction was recorded.
Anchor to idid •ID! non-null: The transaction ID.
Anchor to typetype •TaxTransactionType! non-nullDeprecated

ThemeSale

•OBJECT

A transaction corresponding to a theme purchase.

Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the transaction was recorded.
Anchor to grossAmountgrossAmount •Money: The total amount that the merchant paid, excluding taxes.
Anchor to idid •ID! non-null: The transaction ID.
Anchor to netAmountnetAmount •Money! non-null: The net amount that is added to or deducted from your payout.
Anchor to shopshop •Shop: The shop associated with the transaction.
Anchor to shopifyFeeshopifyFee •Money: The amount that Shopify retained from the sale.
Anchor to themetheme •Theme! non-null: The theme associated with the purchase.

ThemeSaleAdjustment

•OBJECT

A transaction corresponding to a refund, downgrade, or adjustment of a theme sale.

Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the transaction was recorded.
Anchor to grossAmountgrossAmount •Money: The total amount that the merchant paid, excluding taxes.
Anchor to idid •ID! non-null: The transaction ID.
Anchor to netAmountnetAmount •Money! non-null: The net amount that is added to or deducted from your payout.
Anchor to shopshop •Shop: The shop associated with the transaction.
Anchor to shopifyFeeshopifyFee •Money: The amount that Shopify retained from the adjustment.
Anchor to themetheme •Theme! non-null: The theme associated with the refund.

Was this section helpful?