Choose a version:

Node

interface

An object with an ID to support global identification.

Anchor to FieldsFields

Anchor to idid •ID! non-null: A globally unique identifier.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

App

•OBJECT

A Shopify app.

Anchor to apiKeyapiKey •String! non-null: A unique application API identifier.
Anchor to eventsevents •AppEventConnection! non-null: A list of app events.
Anchor to idid •ID! non-null: The ID of the app. Example value: gid://partners/App/1234.
Anchor to namename •String! non-null: The name of the app.

AppCredit

•OBJECT

A credit issued to a merchant for an app. Merchants are entitled to app credits under certain circumstances, such as when a paid app subscription is downgraded partway through its billing cycle.

Anchor to amountamount •Money! non-null: The amount that can be used towards future app purchases in Shopify.
Anchor to idid •ID! non-null: A globally unique identifier.
Anchor to namename •String! non-null: The description of the app credit.
Anchor to testtest •Boolean! non-null: Whether the app credit was a test transaction.

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.

AppPurchaseOneTime

•OBJECT

A one-time app charge for services and features purchased once by a store. For example, a one-time migration of a merchant's data from one platform to another.

Anchor to amountamount •Money! non-null: The amount of the app charge.
Anchor to idid •ID! non-null: A globally unique identifier.
Anchor to namename •String! non-null: The name of the app charge.
Anchor to testtest •Boolean! non-null: Whether the app purchase was a test transaction.

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.

AppSubscription

•OBJECT

A recurring charge for use of an app, such as a monthly subscription charge.

Anchor to amountamount •Money! non-null: The amount of the app charge.
Anchor to billingOnbillingOn •DateTime: The date when the merchant will next be billed.
Anchor to idid •ID! non-null: A globally unique identifier.
Anchor to namename •String! non-null: The name of the app charge.
Anchor to testtest •Boolean! non-null: Whether the app purchase was a test transaction.

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.

AppUsageRecord

•OBJECT

An app charge. This charge varies based on how much the merchant uses the app or a service that the app integrates with.

Anchor to amountamount •Money! non-null: The amount of the app charge.
Anchor to idid •ID! non-null: A globally unique identifier.
Anchor to namename •String! non-null: The name of the app charge.
Anchor to testtest •Boolean! non-null: Whether the app purchase was a test transaction.

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.

Conversation

•OBJECT

A conversation with a merchant through the Experts Marketplace.

Anchor to createdAtcreatedAt •DateTime! non-null: The date and time the conversation was started.
Anchor to dashboardUrldashboardUrl •Url! non-null: The URL to access this conversation in the Partner Dashboard.
Anchor to hasUnreadMessageshasUnreadMessages •Boolean! non-null: Whether the conversation has unread messages.
Anchor to idid •ID! non-null: A globally unique identifier.
Anchor to lastEventAtlastEventAt •DateTime! non-null: The date and time of the most recent conversation event. Example events: a message being sent, or a proposal being accepted.
Anchor to merchantUsermerchantUser •MerchantUser! non-null: The merchant account involved in the conversation.
Anchor to messagesmessages •MessageConnection! non-null: The messages exchanged within the conversation.
Anchor to statusstatus •ConversationStatus! non-null: The status of the Experts Marketplace conversation.

Job

•OBJECT

An Experts Marketplace job.

Anchor to confirmedCompletedconfirmedCompleted •Boolean! non-null: Whether the merchant has marked the job as complete.
Anchor to conversationconversation •Conversation: The conversation containing messages exchanged with the merchant.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time the job was submitted to your organization.
Anchor to dashboardUrldashboardUrl •Url! non-null: A URL to access this job in the Partner Dashboard.
Anchor to idid •ID! non-null: A globally unique identifier.
Anchor to lastEventAtlastEventAt •DateTime! non-null: The date and time of the most recent job event.
Anchor to requirementsrequirements •[JobRequirement!]! non-null: The job requirements that the merchant provided.
Anchor to servicesservices •[Service!]! non-null: The services requested for this job.
Anchor to shopshop •Shop! non-null: The shop that submitted the job.
Anchor to statusstatus •JobStatus! non-null: The status of the job.

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.

MerchantUser

•OBJECT

A merchant account. This might be a shop owner, a staff member, or a user that isn't associated with a shop. A single merchant account can be associated with many shops.

Anchor to avatarUrlavatarUrl •Url: A URL referencing the avatar associated with the actor.
Anchor to idid •ID! non-null: A globally unique identifier for the actor. Example value: gid://partners/Shop/1234.
Anchor to namename •String! non-null: The user's full name.
Anchor to timezonetimezone •String! non-null: The user's time zone.

Message

•OBJECT

A message exchanged within a conversation.

Anchor to bodybody •String: The message body.
Anchor to fileUrlsfileUrls •[Url!]! non-null: A collection of URLs pointing to files attached to the message.
Anchor to idid •ID! non-null: A globally unique identifier.
Anchor to sentAtsentAt •DateTime! non-null: The date and time the message was sent.
Anchor to sentBysentBy •MessageSender! non-null: The organization or user that sent the message.
Anchor to sentViasentVia •MessageSentVia! non-null: The platform that was used to send the message.

Organization

•OBJECT

A Partner organization.

Anchor to avatarUrlavatarUrl •Url: A URL referencing the avatar associated with the actor.
Anchor to idid •ID! non-null: A globally unique identifier for the actor. Example value: gid://partners/Shop/1234.
Anchor to namename •String! non-null: The name of the actor. This might be a Partner organization or shop name.

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.

Shop

•OBJECT

A Shopify shop.

Anchor to avatarUrlavatarUrl •Url: A URL referencing the avatar associated with the actor.
Anchor to idid •ID! non-null: A globally unique identifier for the actor. Example value: gid://partners/Shop/1234.
Anchor to myshopifyDomainmyshopifyDomain •Url! non-null: The shop's .myshopify.com domain name.
Anchor to namename •String! non-null: The name of the actor. This might be a Partner organization or shop name.

ShopifyEmployee

•OBJECT

A Shopify employee.

Anchor to avatarUrlavatarUrl •Url: A URL referencing the avatar associated with the actor.
Anchor to idid •ID! non-null: A globally unique identifier for the actor. Example value: gid://partners/Shop/1234.
Anchor to namename •String! non-null: The Shopify employee's full name.

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

TeamMember

•OBJECT

An owner or staff member of the Partner Organization.

Anchor to avatarUrlavatarUrl •Url: A URL referencing the avatar associated with the actor.
Anchor to idid •ID! non-null: A globally unique identifier for the actor. Example value: gid://partners/Shop/1234.
Anchor to namename •String! non-null: The team member's full name.

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?