# GraphQL Partner API The Partner API provides access to data in the Partners Dashboard. Data includes transactions that impact your earnings, app events, and for participating partners, Experts Marketplace opportunities. With this information, you can effectively scale your business by automating front and back-office operations, freeing up time to focus on solutions for Shopify merchants. ## Authentication There are two pieces of information that you must include to successfully authenticate requests to a Partner API endpoint: <ul><li> Your organization ID. You can find this in the URL of the Partners Dashboard when you're logged in. For example: <code>https://partners.shopify.com/organization-id/api/2021-04/graphql.json</code> <li>A Partner API client access token. The API client access token must belong to the organization that you're querying. You can create a new API client for your organization through the Partner Dashboard. For example: <code>X-Shopify-Access-Token: <partner-access-token></code> </li></ul> There are two pieces of information that you must include to successfully authenticate requests to a Partner API endpoint: <ul><li> Your organization ID. You can find this in the URL of the Partners Dashboard when you're logged in. For example: <code>https://partners.shopify.com/organization-id/api/2021-04/graphql.json</code> <li>A Partner API client access token. The API client access token must belong to the organization that you're querying. You can create a new API client for your organization through the Partner Dashboard. For example: <code>X-Shopify-Access-Token: <partner-access-token></code> </li></ul> ### Code samples | Language | Code Sample | |----------|------------| | curl | ```bash curl -X POST \<br> https://partners.shopify.com/{organization_id}/api/2021-07/graphql.json \<br> -H 'Content-Type: application/json' \<br> -H 'X-Shopify-Access-Token: {partner_access_token}' \<br> -d '{<br> "query": "{your_query}"<br> }'``` | ## Endpoints and queries Use GraphiQL explorer through your Partners Dashboard to query the Partner API. The GraphiQL explorer uses your [Partner API client](#create-a-partner-api-client) to retrieve the requested information from your Partner account. From your Partners Dashboard, navigate to Settings > Partner API clients. Next to the Partner API client that you want to explore, click View GraphiQL explorer. You can also use the GraphiQL explorer to work with the schema and build queries. Queries begin with one of the objects listed under QueryRoot. The QueryRoot is the schema’s entry-point for queries. Queries are equivalent to making a GET request in REST. Use GraphiQL explorer through your Partners Dashboard to query the Partner API. The GraphiQL explorer uses your [Partner API client](#create-a-partner-api-client) to retrieve the requested information from your Partner account. From your Partners Dashboard, navigate to Settings > Partner API clients. Next to the Partner API client that you want to explore, click View GraphiQL explorer. You can also use the GraphiQL explorer to work with the schema and build queries. Queries begin with one of the objects listed under QueryRoot. The QueryRoot is the schema’s entry-point for queries. Queries are equivalent to making a GET request in REST. https://partners.shopify.com/{org_id}/api/{API_VERSION}/graphql.json You can use cURL or an HTTP client such as Postman or Insomnia to query the Partner API. This example is a basic request using cURL. Replace <code>{organization-id}</code> with the ID for the organization you are querying, and replace <code>{partner-access-token}</code> with your client access token. This request retrieves the last 20 active Experts Marketplace conversations with unread messages. The Partner API is versioned. To keep your app stable, make sure you specify a supported version in the URL. ### Create a Partner API client You must be an organization owner to create and manage your API client through the Partners Dashboard. Each API client has access only to the data belonging to the organization in which it is created. You need to create an API client for each organization that you want to access using the API. From the Partners Dashboard, navigate to Settings > Partner API clients, and then click Manage Partner API clients. The following permissions can be granted for each API client: <ul><li>View financials: This permission is required to access Transaction resources. These resources represent all of the transactions that impact your Partner earnings. <li>Manage apps: This permission is required to access App resources, including all app-related events such as installs, uninstalls, and charges. This resource represents all of the public and private apps managed by your organization. <li>Manage themes: This permission is required to access the Theme resource. This resource represents all of the Shopify themes managed by your organization. <li>Manage jobs: This permission is required to access Conversation and Job resources. These resources represent Experts Marketplace conversations and jobs owned by your organization.</ul> ### Secure your data by rotating your access token Your access token secures your organization's data. It should be kept secret at all times. If you need to replace your access token, you can generate a secondary token from your Partners Dashboard, Navigate to Settings > Partner API clients, and then click Manage Partner API clients. <hr> ### Usage limitations - Transaction information is for analytics purposes only. This information shouldn't be used for accounting or financial reporting. - All apps and services connecting to the Partner API are subject to Shopify’s API Terms of Service. Only organization owners can create and manage Partner API clients. ### Code samples | Language | Code Sample | |----------|------------| | curl | ```bash # Get the ID and user name of your 20 most recent unread messages<br>curl -X POST "https://partners.shopify.com/{org_id}/api/2021-07/graphql.json" \<br> -H "Content-Type: application/json" \<br> -H "X-Shopify-Access-Token: {partner-access-token}" \<br> -d '{<br> "query": "{<br> conversations(<br> first: 20,<br> unreadOnly: true,<br> statuses: [ACTIVE]<br> ) {<br> edges {<br> node {<br> id<br> merchantUser {<br> name<br> }<br> }<br> }<br> }<br> }"<br> }'``` | ## Rate limits The Partner API has a rate limit of four requests per second per Partner API client. After the limit is exceeded, all requests are throttled and return an `{"errors": [{"message": "Too many requests"}]}` error. The Partner API has a rate limit of four requests per second per Partner API client. After the limit is exceeded, all requests are throttled and return an `{"errors": [{"message": "Too many requests"}]}` error. ### Request ```bash HTTP/1.1 429 Too Many Requests ``` ### Response | Language | Code Sample | |----------|------------| | json | ```json HTTP/1.1 429 Too Many Requests<br> {<br> "errors": [{<br> "message": "Too many requests",<br> "extensions": {<br> "code": "429"<br> }<br> }]<br> }``` | ## Status and error codes All API queries return HTTP status codes that contain more information about the response. All API queries return HTTP status codes that contain more information about the response.The GraphQL Partner API can return a 200 OK response code in cases that would typically produce 4xx errors in REST. 200 response codes can return different formats including both strings and objects.> NOTE: Didn’t find the status code you’re looking for? View the complete list of [API status response and error codes](/api/usage/response-codes). ### Sample 200 error responses | Language | Code Sample | |----------|------------| | Throttled | ```json {<br> "errors": [<br> {<br> "message": "Too many requests",<br> "extensions": {<br> "code": "429"<br> }<br> }<br> ]<br>}``` | | Internal | ```json5 {<br> "errors": [<br> {<br> "message": "Internal error. Looks like something went wrong on our end.<br> Request ID: 1b355a21-7117-44c5-8d8b-8948082f40a8 (include this in support requests).",<br> "extensions": {<br> "code": "500"<br> }<br> }<br> ]<br>}``` | ### Sample error codes | Language | Code Sample | |----------|------------| | 400 | ```400 {<br> "errors": [{<br> "message": "Maximum query length is 50000 characters",<br> "extensions": {<br> "code": "400"<br> }<br> }]<br>}``` | | 401 | ```401 {<br> "errors": [{<br> "message": "Invalid access token",<br> "extensions": {<br> "code": "401"<br> }<br> }]<br>}``` | | 404 | ```404 {<br> "errors": [{<br> "message": "Invalid API version",<br> "extensions": {<br> "code": "404"<br> }<br> }]<br>}``` | | 429 | ```429 HTTP/1.1 429 Too many requests<br>{<br> "errors": [{<br> "message": "Too many requests",<br> "extensions": {<br> "code": "429"<br> }<br> }]<br>}``` | The response for the errors object contains additional detail to help you debug your operation. The response for mutations contains additional detail to help debug your query. To access this, you must request `userErrors`. #### Properties ##### 400 <span>Bad Request:</span> The server will not process the request. ##### 401 <span>Unauthorized:</span> A call was made with an invalid API client (for example, using tokens that don't exist) or against an invalid Organization (for example, one that is disabled). ##### 404 <span>Not found: </span> The resource isn’t available. This occurs when querying for something that has been deleted. ##### 429 <span>Too Many Requests:</span> The client has exceeded the [rate limit](#rate-limits). ##### 500 <span>Internal Server Error:</span> An internal error occurred in Shopify. Check out the [Shopify status page](https://www.shopifystatus.com) for more information. [{"title"=>"400", "description"=>"<span>Bad Request:</span> The server will not process the request."}, {"title"=>"401", "description"=>"<span>Unauthorized:</span> A call was made with an invalid API client (for example, using tokens that don't exist) or against an invalid Organization (for example, one that is disabled)."}, {"title"=>"404", "description"=>"<span>Not found: </span> The resource isn’t available. This occurs when querying for something that has been deleted."}, {"title"=>"429", "description"=>"<span>Too Many Requests:</span> The client has exceeded the [rate limit](#rate-limits)."}, {"title"=>"500", "description"=>"<span>Internal Server Error:</span> An internal error occurred in Shopify. Check out the [Shopify status page](https://www.shopifystatus.com) for more information."}] #### 400 Bad Request The server will not process the request. #### 401 Unauthorized A call was made with an invalid API client (for example, using tokens that don't exist) or against an invalid Organization (for example, one that's been disabled). #### 404 Not Found The resource isn’t available. This is often caused by querying for something that’s been deleted. #### 429 Too Many Requests Too many requests were sent in a given time period. [{"content"=>"#### 400 Bad Request\n\nThe server will not process the request."}, {"content"=>"#### 401 Unauthorized\n\nA call was made with an invalid API client (for example, using tokens that don't exist) or against an invalid Organization (for example, one that's been disabled)."}, {"content"=>"#### 404 Not Found\n\nThe resource isn’t available. This is often caused by querying for something that’s been deleted."}, {"content"=>"#### 429 Too Many Requests\n\nToo many requests were sent in a given time period."}] ## Translations To receive translated error messages when using the Partner API, you need to specify a locale in the Accept-Language HTTP request header when sending queries. This example shows a header that enables error messages to be returned in Spanish when using the Partner API. If the locale is missing or unsupported, then the API returns error messages in English. ### Sample request header for locale | Language | Code Sample | |----------|------------| | json | ```json Accept-Language: es``` | ## **2024-04** API Reference - [Actor](https://shopify.dev/docs/api/partner/2024-04/interfaces/Actor.txt) - A Partner organization or shop. - [ApiVersion](https://shopify.dev/docs/api/partner/2024-04/objects/ApiVersion.txt) - A version of the API. - [App](https://shopify.dev/docs/api/partner/2024-04/objects/App.txt) - A Shopify [app](/concepts/apps). - [AppCharge](https://shopify.dev/docs/api/partner/2024-04/interfaces/AppCharge.txt) - A [charge](/docs/admin-api/rest/reference/billing/applicationcharge) created through an app. - [AppCredit](https://shopify.dev/docs/api/partner/2024-04/objects/AppCredit.txt) - A [credit](/docs/admin-api/rest/reference/billing/applicationcredit) 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. - [AppCreditCreatePayload](https://shopify.dev/docs/api/partner/2024-04/payloads/AppCreditCreatePayload.txt) - The result of an appCreditCreate mutation. - [AppCreditEvent](https://shopify.dev/docs/api/partner/2024-04/interfaces/AppCreditEvent.txt) - An event involving an app credit. - [AppEvent](https://shopify.dev/docs/api/partner/2024-04/interfaces/AppEvent.txt) - An event related to a Shopify app. - [AppEventConnection](https://shopify.dev/docs/api/partner/2024-04/connections/AppEventConnection.txt) - The connection type for AppEvent. - [AppEventTypes](https://shopify.dev/docs/api/partner/2024-04/enums/AppEventTypes.txt) - The type of app event. - [AppOneTimeSale](https://shopify.dev/docs/api/partner/2024-04/objects/AppOneTimeSale.txt) - A transaction corresponding to a one-time app charge. - [AppPricingInterval](https://shopify.dev/docs/api/partner/2024-04/enums/AppPricingInterval.txt) - The billing frequency for the app. - [AppPurchaseOneTime](https://shopify.dev/docs/api/partner/2024-04/objects/AppPurchaseOneTime.txt) - 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. - [AppPurchaseOneTimeEvent](https://shopify.dev/docs/api/partner/2024-04/interfaces/AppPurchaseOneTimeEvent.txt) - An app event for a one-time app charge. - [AppSaleAdjustment](https://shopify.dev/docs/api/partner/2024-04/objects/AppSaleAdjustment.txt) - A transaction corresponding to a refund, downgrade, or adjustment of an app charge. - [AppSaleCredit](https://shopify.dev/docs/api/partner/2024-04/objects/AppSaleCredit.txt) - A transaction corresponding to an [app credit](/docs/admin-api/rest/reference/billing/applicationcredit). - [AppSubscription](https://shopify.dev/docs/api/partner/2024-04/objects/AppSubscription.txt) - A recurring charge for use of an app, such as a monthly subscription charge. - [AppSubscriptionEvent](https://shopify.dev/docs/api/partner/2024-04/interfaces/AppSubscriptionEvent.txt) - An event related to an [app subscription charge](/docs/admin-api/rest/reference/billing/recurringapplicationcharge). - [AppSubscriptionSale](https://shopify.dev/docs/api/partner/2024-04/objects/AppSubscriptionSale.txt) - A transaction corresponding to an app subscription charge. - [AppUsageRecord](https://shopify.dev/docs/api/partner/2024-04/objects/AppUsageRecord.txt) - An app charge. This charge varies based on how much the merchant uses the app or a service that the app integrates with. - [AppUsageRecordEvent](https://shopify.dev/docs/api/partner/2024-04/interfaces/AppUsageRecordEvent.txt) - An app event for an app usage charge. - [AppUsageSale](https://shopify.dev/docs/api/partner/2024-04/objects/AppUsageSale.txt) - A transaction corresponding to an app usage charge. - [Boolean](https://shopify.dev/docs/api/partner/2024-04/scalars/Boolean.txt) - Represents `true` or `false` values. - [Conversation](https://shopify.dev/docs/api/partner/2024-04/objects/Conversation.txt) - A conversation with a merchant through the Experts Marketplace. - [ConversationConnection](https://shopify.dev/docs/api/partner/2024-04/connections/ConversationConnection.txt) - The connection type for Conversation. - [ConversationStatus](https://shopify.dev/docs/api/partner/2024-04/enums/ConversationStatus.txt) - The status of the Experts Marketplace conversation. - [CreditApplied](https://shopify.dev/docs/api/partner/2024-04/objects/CreditApplied.txt) - An event that marks that an app credit was applied. - [CreditFailed](https://shopify.dev/docs/api/partner/2024-04/objects/CreditFailed.txt) - An event that marks that an app credit failed to apply. - [CreditPending](https://shopify.dev/docs/api/partner/2024-04/objects/CreditPending.txt) - An event that marks that an app credit is pending. - [Currency](https://shopify.dev/docs/api/partner/2024-04/enums/Currency.txt) - Supported monetary currencies from ISO 4217. - [DateTime](https://shopify.dev/docs/api/partner/2024-04/scalars/DateTime.txt) - An [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) encoded UTC date time string. Example value: `"2019-07-03T20:47:55.123456Z"`. - [Decimal](https://shopify.dev/docs/api/partner/2024-04/scalars/Decimal.txt) - A signed decimal number, which supports arbitrary precision and is serialized as a string. - [ID](https://shopify.dev/docs/api/partner/2024-04/scalars/ID.txt) - Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) input value will be accepted as an ID. - [Int](https://shopify.dev/docs/api/partner/2024-04/scalars/Int.txt) - Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. - [Job](https://shopify.dev/docs/api/partner/2024-04/objects/Job.txt) - An [Experts Marketplace job](https://help.shopify.com/partners/selling-services). - [JobConnection](https://shopify.dev/docs/api/partner/2024-04/connections/JobConnection.txt) - The connection type for Job. - [JobRequirement](https://shopify.dev/docs/api/partner/2024-04/objects/JobRequirement.txt) - Details that the merchant provided about their job requirements. Details are returned as sets of questions and responses. - [JobStatus](https://shopify.dev/docs/api/partner/2024-04/enums/JobStatus.txt) - The status of the [Experts Marketplace job](https://help.shopify.com/partners/selling-services). - [LegacyTransaction](https://shopify.dev/docs/api/partner/2024-04/objects/LegacyTransaction.txt) - A transaction of a type that is no longer supported. - [MerchantUser](https://shopify.dev/docs/api/partner/2024-04/objects/MerchantUser.txt) - 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. - [Message](https://shopify.dev/docs/api/partner/2024-04/objects/Message.txt) - A message exchanged within a conversation. - [MessageConnection](https://shopify.dev/docs/api/partner/2024-04/connections/MessageConnection.txt) - The connection type for Message. - [MessageSender](https://shopify.dev/docs/api/partner/2024-04/unions/MessageSender.txt) - A union of all of the types that can send messages within a conversation. - [MessageSentVia](https://shopify.dev/docs/api/partner/2024-04/enums/MessageSentVia.txt) - The platform that was used to send the message. - [Money](https://shopify.dev/docs/api/partner/2024-04/objects/Money.txt) - A monetary value with currency. - [MoneyInput](https://shopify.dev/docs/api/partner/2024-04/input-objects/MoneyInput.txt) - A monetary value with currency. - [appCreditCreate](https://shopify.dev/docs/api/partner/2024-04/mutations/appCreditCreate.txt) - Allows an app to create a credit for a shop that can be used towards future app purchases. This mutation is only available to Partner API clients that have been granted the `View financials` permission. - [OneTimeChargeAccepted](https://shopify.dev/docs/api/partner/2024-04/objects/OneTimeChargeAccepted.txt) - An event that marks that a one-time app charge was accepted by the merchant. - [OneTimeChargeActivated](https://shopify.dev/docs/api/partner/2024-04/objects/OneTimeChargeActivated.txt) - An event that marks that a one-time app charge was activated. - [OneTimeChargeDeclined](https://shopify.dev/docs/api/partner/2024-04/objects/OneTimeChargeDeclined.txt) - An event that marks that a one-time app charge was declined by the merchant. - [OneTimeChargeExpired](https://shopify.dev/docs/api/partner/2024-04/objects/OneTimeChargeExpired.txt) - An event that marks that a one-time app charge expired before the merchant could accept it. - [Organization](https://shopify.dev/docs/api/partner/2024-04/objects/Organization.txt) - A Partner organization. - [PageInfo](https://shopify.dev/docs/api/partner/2024-04/objects/PageInfo.txt) - Information about pagination in a connection. - [QueryRoot](https://shopify.dev/docs/api/partner/2024-04/objects/QueryRoot.txt) - The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. - [app](https://shopify.dev/docs/api/partner/2024-04/queries/app.txt) - A Shopify [app](/concepts/apps). - [conversation](https://shopify.dev/docs/api/partner/2024-04/queries/conversation.txt) - A conversation with a merchant through the Experts Marketplace. - [conversations](https://shopify.dev/docs/api/partner/2024-04/queries/conversations.txt) - A list of the Partner organization's conversations. - [job](https://shopify.dev/docs/api/partner/2024-04/queries/job.txt) - An [Experts Marketplace job](https://help.shopify.com/partners/selling-services). - [jobs](https://shopify.dev/docs/api/partner/2024-04/queries/jobs.txt) - A list of the Partner organization's [Experts Marketplace jobs](https://help.shopify.com/partners/selling-services). - [publicApiVersions](https://shopify.dev/docs/api/partner/2024-04/queries/publicApiVersions.txt) - The list of public Partner API versions, including supported, release candidate and unstable versions. - [transaction](https://shopify.dev/docs/api/partner/2024-04/queries/transaction.txt) - A Shopify Partner transaction. - [transactions](https://shopify.dev/docs/api/partner/2024-04/queries/transactions.txt) - A list of the Partner organization's [transactions](https://help.shopify.com/partners/getting-started/getting-paid). - [ReferralAdjustment](https://shopify.dev/docs/api/partner/2024-04/objects/ReferralAdjustment.txt) - A transaction corresponding to a shop referral adjustment. - [ReferralCategory](https://shopify.dev/docs/api/partner/2024-04/enums/ReferralCategory.txt) - The referral type. - [ReferralTransaction](https://shopify.dev/docs/api/partner/2024-04/objects/ReferralTransaction.txt) - A transaction corresponding to a shop referral. - [RelationshipDeactivated](https://shopify.dev/docs/api/partner/2024-04/objects/RelationshipDeactivated.txt) - An event that marks that an app was deactivated. - [RelationshipInstalled](https://shopify.dev/docs/api/partner/2024-04/objects/RelationshipInstalled.txt) - An event that marks that an app was installed. - [RelationshipReactivated](https://shopify.dev/docs/api/partner/2024-04/objects/RelationshipReactivated.txt) - An event that marks that an app was reactivated. - [RelationshipUninstalled](https://shopify.dev/docs/api/partner/2024-04/objects/RelationshipUninstalled.txt) - An event that marks that an app was uninstalled. - [Service](https://shopify.dev/docs/api/partner/2024-04/objects/Service.txt) - A service in the Experts Marketplace. - [ServiceSale](https://shopify.dev/docs/api/partner/2024-04/objects/ServiceSale.txt) - A transaction corresponding to a paid invoice for a service. - [ServiceSaleAdjustment](https://shopify.dev/docs/api/partner/2024-04/objects/ServiceSaleAdjustment.txt) - A transaction corresponding to a refund, downgrade, or adjustment of a service sale. - [Shop](https://shopify.dev/docs/api/partner/2024-04/objects/Shop.txt) - A Shopify shop. - [ShopifyEmployee](https://shopify.dev/docs/api/partner/2024-04/objects/ShopifyEmployee.txt) - A Shopify employee. - [String](https://shopify.dev/docs/api/partner/2024-04/scalars/String.txt) - Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. - [SubscriptionApproachingCappedAmount](https://shopify.dev/docs/api/partner/2024-04/objects/SubscriptionApproachingCappedAmount.txt) - An event that marks that a subscription is approaching its capped amount. - [SubscriptionCappedAmountUpdated](https://shopify.dev/docs/api/partner/2024-04/objects/SubscriptionCappedAmountUpdated.txt) - An event that marks that a subscription had its capped amount updated. - [SubscriptionChargeAccepted](https://shopify.dev/docs/api/partner/2024-04/objects/SubscriptionChargeAccepted.txt) - An event that marks that a recurring app charge was accepted. - [SubscriptionChargeActivated](https://shopify.dev/docs/api/partner/2024-04/objects/SubscriptionChargeActivated.txt) - An event that marks that a recurring app charge was activated. - [SubscriptionChargeCanceled](https://shopify.dev/docs/api/partner/2024-04/objects/SubscriptionChargeCanceled.txt) - An event that marks that a recurring app charge was cancelled. - [SubscriptionChargeDeclined](https://shopify.dev/docs/api/partner/2024-04/objects/SubscriptionChargeDeclined.txt) - An event that marks that a recurring app charge was declined. - [SubscriptionChargeExpired](https://shopify.dev/docs/api/partner/2024-04/objects/SubscriptionChargeExpired.txt) - An event that marks that a recurring app charge has expired. - [SubscriptionChargeFrozen](https://shopify.dev/docs/api/partner/2024-04/objects/SubscriptionChargeFrozen.txt) - An event that marks that a recurring app charge has been suspended. For example, if a merchant stops paying their bills, or closes their store, then Shopify suspends the recurring app charge. - [SubscriptionChargeUnfrozen](https://shopify.dev/docs/api/partner/2024-04/objects/SubscriptionChargeUnfrozen.txt) - An event that marks that a recurring app charge was unfrozen. - [TaxTransaction](https://shopify.dev/docs/api/partner/2024-04/objects/TaxTransaction.txt) - 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. - [TaxTransactionType](https://shopify.dev/docs/api/partner/2024-04/enums/TaxTransactionType.txt) - The tax model applied to the transaction, based on the transaction type. - [TeamMember](https://shopify.dev/docs/api/partner/2024-04/objects/TeamMember.txt) - An owner or staff member of the Partner Organization. - [Theme](https://shopify.dev/docs/api/partner/2024-04/objects/Theme.txt) - A Shopify [theme](/concepts/themes). - [ThemeSale](https://shopify.dev/docs/api/partner/2024-04/objects/ThemeSale.txt) - A transaction corresponding to a theme purchase. - [ThemeSaleAdjustment](https://shopify.dev/docs/api/partner/2024-04/objects/ThemeSaleAdjustment.txt) - A transaction corresponding to a refund, downgrade, or adjustment of a theme sale. - [Transaction](https://shopify.dev/docs/api/partner/2024-04/interfaces/Transaction.txt) - A Shopify Partner transaction. - [TransactionConnection](https://shopify.dev/docs/api/partner/2024-04/connections/TransactionConnection.txt) - The connection type for Transaction. - [TransactionType](https://shopify.dev/docs/api/partner/2024-04/enums/TransactionType.txt) - The type of transaction. - [Url](https://shopify.dev/docs/api/partner/2024-04/scalars/Url.txt) - A valid URL, transported as a string. - [UsageChargeApplied](https://shopify.dev/docs/api/partner/2024-04/objects/UsageChargeApplied.txt) - An event that marks that an app usage charge was applied. - [UserError](https://shopify.dev/docs/api/partner/2024-04/objects/UserError.txt) - Represents an error in a mutation. - [__Directive](https://shopify.dev/docs/api/partner/2024-04/objects/__Directive.txt) - A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor. - [__DirectiveLocation](https://shopify.dev/docs/api/partner/2024-04/enums/__DirectiveLocation.txt) - A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies. - [__EnumValue](https://shopify.dev/docs/api/partner/2024-04/objects/__EnumValue.txt) - One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string. - [__Field](https://shopify.dev/docs/api/partner/2024-04/objects/__Field.txt) - Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type. - [__InputValue](https://shopify.dev/docs/api/partner/2024-04/objects/__InputValue.txt) - Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value. - [__Schema](https://shopify.dev/docs/api/partner/2024-04/objects/__Schema.txt) - A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations. - [__Type](https://shopify.dev/docs/api/partner/2024-04/objects/__Type.txt) - The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types. - [__TypeKind](https://shopify.dev/docs/api/partner/2024-04/enums/__TypeKind.txt) - An enum describing what kind of type a given `__Type` is. ## **internal** API Reference - [Actor](https://shopify.dev/docs/api/partner/internal/interfaces/Actor.txt) - A Partner organization or shop. - [ApiVersion](https://shopify.dev/docs/api/partner/internal/objects/ApiVersion.txt) - A version of the API. - [App](https://shopify.dev/docs/api/partner/internal/objects/App.txt) - A Shopify [app](/concepts/apps). - [AppCharge](https://shopify.dev/docs/api/partner/internal/interfaces/AppCharge.txt) - A [charge](/docs/admin-api/rest/reference/billing/applicationcharge) created through an app. - [AppCredit](https://shopify.dev/docs/api/partner/internal/objects/AppCredit.txt) - A [credit](/docs/admin-api/rest/reference/billing/applicationcredit) 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. - [AppCreditCreatePayload](https://shopify.dev/docs/api/partner/internal/payloads/AppCreditCreatePayload.txt) - The result of an appCreditCreate mutation. - [AppCreditEvent](https://shopify.dev/docs/api/partner/internal/interfaces/AppCreditEvent.txt) - An event involving an app credit. - [AppEvent](https://shopify.dev/docs/api/partner/internal/interfaces/AppEvent.txt) - An event related to a Shopify app. - [AppEventConnection](https://shopify.dev/docs/api/partner/internal/connections/AppEventConnection.txt) - The connection type for AppEvent. - [AppEventTypes](https://shopify.dev/docs/api/partner/internal/enums/AppEventTypes.txt) - The type of app event. - [AppOneTimeSale](https://shopify.dev/docs/api/partner/internal/objects/AppOneTimeSale.txt) - A transaction corresponding to a one-time app charge. - [AppPricingInterval](https://shopify.dev/docs/api/partner/internal/enums/AppPricingInterval.txt) - The billing frequency for the app. - [AppPurchaseOneTime](https://shopify.dev/docs/api/partner/internal/objects/AppPurchaseOneTime.txt) - 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. - [AppPurchaseOneTimeEvent](https://shopify.dev/docs/api/partner/internal/interfaces/AppPurchaseOneTimeEvent.txt) - An app event for a one-time app charge. - [AppSaleAdjustment](https://shopify.dev/docs/api/partner/internal/objects/AppSaleAdjustment.txt) - A transaction corresponding to a refund, downgrade, or adjustment of an app charge. - [AppSaleCredit](https://shopify.dev/docs/api/partner/internal/objects/AppSaleCredit.txt) - A transaction corresponding to an [app credit](/docs/admin-api/rest/reference/billing/applicationcredit). - [AppSubscription](https://shopify.dev/docs/api/partner/internal/objects/AppSubscription.txt) - A recurring charge for use of an app, such as a monthly subscription charge. - [AppSubscriptionEvent](https://shopify.dev/docs/api/partner/internal/interfaces/AppSubscriptionEvent.txt) - An event related to an [app subscription charge](/docs/admin-api/rest/reference/billing/recurringapplicationcharge). - [AppSubscriptionSale](https://shopify.dev/docs/api/partner/internal/objects/AppSubscriptionSale.txt) - A transaction corresponding to an app subscription charge. - [AppUsageRecord](https://shopify.dev/docs/api/partner/internal/objects/AppUsageRecord.txt) - An app charge. This charge varies based on how much the merchant uses the app or a service that the app integrates with. - [AppUsageRecordEvent](https://shopify.dev/docs/api/partner/internal/interfaces/AppUsageRecordEvent.txt) - An app event for an app usage charge. - [AppUsageSale](https://shopify.dev/docs/api/partner/internal/objects/AppUsageSale.txt) - A transaction corresponding to an app usage charge. - [Boolean](https://shopify.dev/docs/api/partner/internal/scalars/Boolean.txt) - Represents `true` or `false` values. - [Conversation](https://shopify.dev/docs/api/partner/internal/objects/Conversation.txt) - A conversation with a merchant through the Experts Marketplace. - [ConversationConnection](https://shopify.dev/docs/api/partner/internal/connections/ConversationConnection.txt) - The connection type for Conversation. - [ConversationStatus](https://shopify.dev/docs/api/partner/internal/enums/ConversationStatus.txt) - The status of the Experts Marketplace conversation. - [CreditApplied](https://shopify.dev/docs/api/partner/internal/objects/CreditApplied.txt) - An event that marks that an app credit was applied. - [CreditFailed](https://shopify.dev/docs/api/partner/internal/objects/CreditFailed.txt) - An event that marks that an app credit failed to apply. - [CreditPending](https://shopify.dev/docs/api/partner/internal/objects/CreditPending.txt) - An event that marks that an app credit is pending. - [Currency](https://shopify.dev/docs/api/partner/internal/enums/Currency.txt) - Supported monetary currencies from ISO 4217. - [DateTime](https://shopify.dev/docs/api/partner/internal/scalars/DateTime.txt) - An [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) encoded UTC date time string. Example value: `"2019-07-03T20:47:55.123456Z"`. - [Decimal](https://shopify.dev/docs/api/partner/internal/scalars/Decimal.txt) - A signed decimal number, which supports arbitrary precision and is serialized as a string. - [Eventsink](https://shopify.dev/docs/api/partner/internal/objects/Eventsink.txt) - A sink for submitting customer events. - [EventsinkCreateInput](https://shopify.dev/docs/api/partner/internal/input-objects/EventsinkCreateInput.txt) - Input for creating a new eventsink. - [EventsinkCreatePayload](https://shopify.dev/docs/api/partner/internal/payloads/EventsinkCreatePayload.txt) - The result of an Eventsink creation. - [EventsinkDeletePayload](https://shopify.dev/docs/api/partner/internal/payloads/EventsinkDeletePayload.txt) - The result of an Eventsink delete. - [EventsinkQueue](https://shopify.dev/docs/api/partner/internal/objects/EventsinkQueue.txt) - An eventsink queue. - [EventsinkTopic](https://shopify.dev/docs/api/partner/internal/enums/EventsinkTopic.txt) - The topic name of an Eventsink. - [ID](https://shopify.dev/docs/api/partner/internal/scalars/ID.txt) - Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) input value will be accepted as an ID. - [Int](https://shopify.dev/docs/api/partner/internal/scalars/Int.txt) - Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. - [Job](https://shopify.dev/docs/api/partner/internal/objects/Job.txt) - An [Experts Marketplace job](https://help.shopify.com/partners/selling-services). - [JobConnection](https://shopify.dev/docs/api/partner/internal/connections/JobConnection.txt) - The connection type for Job. - [JobRequirement](https://shopify.dev/docs/api/partner/internal/objects/JobRequirement.txt) - Details that the merchant provided about their job requirements. Details are returned as sets of questions and responses. - [JobStatus](https://shopify.dev/docs/api/partner/internal/enums/JobStatus.txt) - The status of the [Experts Marketplace job](https://help.shopify.com/partners/selling-services). - [LegacyTransaction](https://shopify.dev/docs/api/partner/internal/objects/LegacyTransaction.txt) - A transaction of a type that is no longer supported. - [MerchantUser](https://shopify.dev/docs/api/partner/internal/objects/MerchantUser.txt) - 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. - [Message](https://shopify.dev/docs/api/partner/internal/objects/Message.txt) - A message exchanged within a conversation. - [MessageConnection](https://shopify.dev/docs/api/partner/internal/connections/MessageConnection.txt) - The connection type for Message. - [MessageSender](https://shopify.dev/docs/api/partner/internal/unions/MessageSender.txt) - A union of all of the types that can send messages within a conversation. - [MessageSentVia](https://shopify.dev/docs/api/partner/internal/enums/MessageSentVia.txt) - The platform that was used to send the message. - [Money](https://shopify.dev/docs/api/partner/internal/objects/Money.txt) - A monetary value with currency. - [MoneyInput](https://shopify.dev/docs/api/partner/internal/input-objects/MoneyInput.txt) - A monetary value with currency. - [appCreditCreate](https://shopify.dev/docs/api/partner/internal/mutations/appCreditCreate.txt) - Allows an app to create a credit for a shop that can be used towards future app purchases. This mutation is only available to Partner API clients that have been granted the `View financials` permission. - [eventsinkCreate](https://shopify.dev/docs/api/partner/internal/mutations/eventsinkCreate.txt) - Creates a new Eventsink. - [eventsinkDelete](https://shopify.dev/docs/api/partner/internal/mutations/eventsinkDelete.txt) - Deletes an Eventsink. - [OneTimeChargeAccepted](https://shopify.dev/docs/api/partner/internal/objects/OneTimeChargeAccepted.txt) - An event that marks that a one-time app charge was accepted by the merchant. - [OneTimeChargeActivated](https://shopify.dev/docs/api/partner/internal/objects/OneTimeChargeActivated.txt) - An event that marks that a one-time app charge was activated. - [OneTimeChargeDeclined](https://shopify.dev/docs/api/partner/internal/objects/OneTimeChargeDeclined.txt) - An event that marks that a one-time app charge was declined by the merchant. - [OneTimeChargeExpired](https://shopify.dev/docs/api/partner/internal/objects/OneTimeChargeExpired.txt) - An event that marks that a one-time app charge expired before the merchant could accept it. - [Organization](https://shopify.dev/docs/api/partner/internal/objects/Organization.txt) - A Partner organization. - [PageInfo](https://shopify.dev/docs/api/partner/internal/objects/PageInfo.txt) - Information about pagination in a connection. - [QueryRoot](https://shopify.dev/docs/api/partner/internal/objects/QueryRoot.txt) - The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. - [app](https://shopify.dev/docs/api/partner/internal/queries/app.txt) - A Shopify [app](/concepts/apps). - [conversation](https://shopify.dev/docs/api/partner/internal/queries/conversation.txt) - A conversation with a merchant through the Experts Marketplace. - [conversations](https://shopify.dev/docs/api/partner/internal/queries/conversations.txt) - A list of the Partner organization's conversations. - [eventsinks](https://shopify.dev/docs/api/partner/internal/queries/eventsinks.txt) - A list of Eventsinks configured for the specified App ID. - [job](https://shopify.dev/docs/api/partner/internal/queries/job.txt) - An [Experts Marketplace job](https://help.shopify.com/partners/selling-services). - [jobs](https://shopify.dev/docs/api/partner/internal/queries/jobs.txt) - A list of the Partner organization's [Experts Marketplace jobs](https://help.shopify.com/partners/selling-services). - [publicApiVersions](https://shopify.dev/docs/api/partner/internal/queries/publicApiVersions.txt) - The list of public Partner API versions, including supported, release candidate and unstable versions. - [transaction](https://shopify.dev/docs/api/partner/internal/queries/transaction.txt) - A Shopify Partner transaction. - [transactions](https://shopify.dev/docs/api/partner/internal/queries/transactions.txt) - A list of the Partner organization's [transactions](https://help.shopify.com/partners/getting-started/getting-paid). - [ReferralAdjustment](https://shopify.dev/docs/api/partner/internal/objects/ReferralAdjustment.txt) - A transaction corresponding to a shop referral adjustment. - [ReferralCategory](https://shopify.dev/docs/api/partner/internal/enums/ReferralCategory.txt) - The referral type. - [ReferralTransaction](https://shopify.dev/docs/api/partner/internal/objects/ReferralTransaction.txt) - A transaction corresponding to a shop referral. - [RelationshipDeactivated](https://shopify.dev/docs/api/partner/internal/objects/RelationshipDeactivated.txt) - An event that marks that an app was deactivated. - [RelationshipInstalled](https://shopify.dev/docs/api/partner/internal/objects/RelationshipInstalled.txt) - An event that marks that an app was installed. - [RelationshipReactivated](https://shopify.dev/docs/api/partner/internal/objects/RelationshipReactivated.txt) - An event that marks that an app was reactivated. - [RelationshipUninstalled](https://shopify.dev/docs/api/partner/internal/objects/RelationshipUninstalled.txt) - An event that marks that an app was uninstalled. - [Service](https://shopify.dev/docs/api/partner/internal/objects/Service.txt) - A service in the Experts Marketplace. - [ServiceSale](https://shopify.dev/docs/api/partner/internal/objects/ServiceSale.txt) - A transaction corresponding to a paid invoice for a service. - [ServiceSaleAdjustment](https://shopify.dev/docs/api/partner/internal/objects/ServiceSaleAdjustment.txt) - A transaction corresponding to a refund, downgrade, or adjustment of a service sale. - [Shop](https://shopify.dev/docs/api/partner/internal/objects/Shop.txt) - A Shopify shop. - [ShopifyEmployee](https://shopify.dev/docs/api/partner/internal/objects/ShopifyEmployee.txt) - A Shopify employee. - [String](https://shopify.dev/docs/api/partner/internal/scalars/String.txt) - Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. - [SubscriptionApproachingCappedAmount](https://shopify.dev/docs/api/partner/internal/objects/SubscriptionApproachingCappedAmount.txt) - An event that marks that a subscription is approaching its capped amount. - [SubscriptionCappedAmountUpdated](https://shopify.dev/docs/api/partner/internal/objects/SubscriptionCappedAmountUpdated.txt) - An event that marks that a subscription had its capped amount updated. - [SubscriptionChargeAccepted](https://shopify.dev/docs/api/partner/internal/objects/SubscriptionChargeAccepted.txt) - An event that marks that a recurring app charge was accepted. - [SubscriptionChargeActivated](https://shopify.dev/docs/api/partner/internal/objects/SubscriptionChargeActivated.txt) - An event that marks that a recurring app charge was activated. - [SubscriptionChargeCanceled](https://shopify.dev/docs/api/partner/internal/objects/SubscriptionChargeCanceled.txt) - An event that marks that a recurring app charge was cancelled. - [SubscriptionChargeDeclined](https://shopify.dev/docs/api/partner/internal/objects/SubscriptionChargeDeclined.txt) - An event that marks that a recurring app charge was declined. - [SubscriptionChargeExpired](https://shopify.dev/docs/api/partner/internal/objects/SubscriptionChargeExpired.txt) - An event that marks that a recurring app charge has expired. - [SubscriptionChargeFrozen](https://shopify.dev/docs/api/partner/internal/objects/SubscriptionChargeFrozen.txt) - An event that marks that a recurring app charge has been suspended. For example, if a merchant stops paying their bills, or closes their store, then Shopify suspends the recurring app charge. - [SubscriptionChargeUnfrozen](https://shopify.dev/docs/api/partner/internal/objects/SubscriptionChargeUnfrozen.txt) - An event that marks that a recurring app charge was unfrozen. - [TaxTransaction](https://shopify.dev/docs/api/partner/internal/objects/TaxTransaction.txt) - 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. - [TaxTransactionType](https://shopify.dev/docs/api/partner/internal/enums/TaxTransactionType.txt) - The tax model applied to the transaction, based on the transaction type. - [TeamMember](https://shopify.dev/docs/api/partner/internal/objects/TeamMember.txt) - An owner or staff member of the Partner Organization. - [Theme](https://shopify.dev/docs/api/partner/internal/objects/Theme.txt) - A Shopify [theme](/concepts/themes). - [ThemeSale](https://shopify.dev/docs/api/partner/internal/objects/ThemeSale.txt) - A transaction corresponding to a theme purchase. - [ThemeSaleAdjustment](https://shopify.dev/docs/api/partner/internal/objects/ThemeSaleAdjustment.txt) - A transaction corresponding to a refund, downgrade, or adjustment of a theme sale. - [Transaction](https://shopify.dev/docs/api/partner/internal/interfaces/Transaction.txt) - A Shopify Partner transaction. - [TransactionConnection](https://shopify.dev/docs/api/partner/internal/connections/TransactionConnection.txt) - The connection type for Transaction. - [TransactionType](https://shopify.dev/docs/api/partner/internal/enums/TransactionType.txt) - The type of transaction. - [Url](https://shopify.dev/docs/api/partner/internal/scalars/Url.txt) - A valid URL, transported as a string. - [UsageChargeApplied](https://shopify.dev/docs/api/partner/internal/objects/UsageChargeApplied.txt) - An event that marks that an app usage charge was applied. - [UserError](https://shopify.dev/docs/api/partner/internal/objects/UserError.txt) - Represents an error in a mutation. - [__Directive](https://shopify.dev/docs/api/partner/internal/objects/__Directive.txt) - A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor. - [__DirectiveLocation](https://shopify.dev/docs/api/partner/internal/enums/__DirectiveLocation.txt) - A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies. - [__EnumValue](https://shopify.dev/docs/api/partner/internal/objects/__EnumValue.txt) - One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string. - [__Field](https://shopify.dev/docs/api/partner/internal/objects/__Field.txt) - Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type. - [__InputValue](https://shopify.dev/docs/api/partner/internal/objects/__InputValue.txt) - Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value. - [__Schema](https://shopify.dev/docs/api/partner/internal/objects/__Schema.txt) - A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations. - [__Type](https://shopify.dev/docs/api/partner/internal/objects/__Type.txt) - The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types. - [__TypeKind](https://shopify.dev/docs/api/partner/internal/enums/__TypeKind.txt) - An enum describing what kind of type a given `__Type` is. ## **2024-10** API Reference - [Actor](https://shopify.dev/docs/api/partner/2024-10/interfaces/Actor.txt) - A Partner organization or shop. - [ApiVersion](https://shopify.dev/docs/api/partner/2024-10/objects/ApiVersion.txt) - A version of the API. - [App](https://shopify.dev/docs/api/partner/2024-10/objects/App.txt) - A Shopify [app](/concepts/apps). - [AppCharge](https://shopify.dev/docs/api/partner/2024-10/interfaces/AppCharge.txt) - A [charge](/docs/admin-api/rest/reference/billing/applicationcharge) created through an app. - [AppCredit](https://shopify.dev/docs/api/partner/2024-10/objects/AppCredit.txt) - A [credit](/docs/admin-api/rest/reference/billing/applicationcredit) 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. - [AppCreditCreatePayload](https://shopify.dev/docs/api/partner/2024-10/payloads/AppCreditCreatePayload.txt) - The result of an appCreditCreate mutation. - [AppCreditEvent](https://shopify.dev/docs/api/partner/2024-10/interfaces/AppCreditEvent.txt) - An event involving an app credit. - [AppEvent](https://shopify.dev/docs/api/partner/2024-10/interfaces/AppEvent.txt) - An event related to a Shopify app. - [AppEventConnection](https://shopify.dev/docs/api/partner/2024-10/connections/AppEventConnection.txt) - The connection type for AppEvent. - [AppEventTypes](https://shopify.dev/docs/api/partner/2024-10/enums/AppEventTypes.txt) - The type of app event. - [AppOneTimeSale](https://shopify.dev/docs/api/partner/2024-10/objects/AppOneTimeSale.txt) - A transaction corresponding to a one-time app charge. - [AppPricingInterval](https://shopify.dev/docs/api/partner/2024-10/enums/AppPricingInterval.txt) - The billing frequency for the app. - [AppPurchaseOneTime](https://shopify.dev/docs/api/partner/2024-10/objects/AppPurchaseOneTime.txt) - 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. - [AppPurchaseOneTimeEvent](https://shopify.dev/docs/api/partner/2024-10/interfaces/AppPurchaseOneTimeEvent.txt) - An app event for a one-time app charge. - [AppSaleAdjustment](https://shopify.dev/docs/api/partner/2024-10/objects/AppSaleAdjustment.txt) - A transaction corresponding to a refund, downgrade, or adjustment of an app charge. - [AppSaleCredit](https://shopify.dev/docs/api/partner/2024-10/objects/AppSaleCredit.txt) - A transaction corresponding to an [app credit](/docs/admin-api/rest/reference/billing/applicationcredit). - [AppSubscription](https://shopify.dev/docs/api/partner/2024-10/objects/AppSubscription.txt) - A recurring charge for use of an app, such as a monthly subscription charge. - [AppSubscriptionEvent](https://shopify.dev/docs/api/partner/2024-10/interfaces/AppSubscriptionEvent.txt) - An event related to an [app subscription charge](/docs/admin-api/rest/reference/billing/recurringapplicationcharge). - [AppSubscriptionSale](https://shopify.dev/docs/api/partner/2024-10/objects/AppSubscriptionSale.txt) - A transaction corresponding to an app subscription charge. - [AppUsageRecord](https://shopify.dev/docs/api/partner/2024-10/objects/AppUsageRecord.txt) - An app charge. This charge varies based on how much the merchant uses the app or a service that the app integrates with. - [AppUsageRecordEvent](https://shopify.dev/docs/api/partner/2024-10/interfaces/AppUsageRecordEvent.txt) - An app event for an app usage charge. - [AppUsageSale](https://shopify.dev/docs/api/partner/2024-10/objects/AppUsageSale.txt) - A transaction corresponding to an app usage charge. - [Boolean](https://shopify.dev/docs/api/partner/2024-10/scalars/Boolean.txt) - Represents `true` or `false` values. - [Conversation](https://shopify.dev/docs/api/partner/2024-10/objects/Conversation.txt) - A conversation with a merchant through the Experts Marketplace. - [ConversationConnection](https://shopify.dev/docs/api/partner/2024-10/connections/ConversationConnection.txt) - The connection type for Conversation. - [ConversationStatus](https://shopify.dev/docs/api/partner/2024-10/enums/ConversationStatus.txt) - The status of the Experts Marketplace conversation. - [CreditApplied](https://shopify.dev/docs/api/partner/2024-10/objects/CreditApplied.txt) - An event that marks that an app credit was applied. - [CreditFailed](https://shopify.dev/docs/api/partner/2024-10/objects/CreditFailed.txt) - An event that marks that an app credit failed to apply. - [CreditPending](https://shopify.dev/docs/api/partner/2024-10/objects/CreditPending.txt) - An event that marks that an app credit is pending. - [Currency](https://shopify.dev/docs/api/partner/2024-10/enums/Currency.txt) - Supported monetary currencies from ISO 4217. - [DateTime](https://shopify.dev/docs/api/partner/2024-10/scalars/DateTime.txt) - An [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) encoded UTC date time string. Example value: `"2019-07-03T20:47:55.123456Z"`. - [Decimal](https://shopify.dev/docs/api/partner/2024-10/scalars/Decimal.txt) - A signed decimal number, which supports arbitrary precision and is serialized as a string. - [ID](https://shopify.dev/docs/api/partner/2024-10/scalars/ID.txt) - Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) input value will be accepted as an ID. - [Int](https://shopify.dev/docs/api/partner/2024-10/scalars/Int.txt) - Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. - [Job](https://shopify.dev/docs/api/partner/2024-10/objects/Job.txt) - An [Experts Marketplace job](https://help.shopify.com/partners/selling-services). - [JobConnection](https://shopify.dev/docs/api/partner/2024-10/connections/JobConnection.txt) - The connection type for Job. - [JobRequirement](https://shopify.dev/docs/api/partner/2024-10/objects/JobRequirement.txt) - Details that the merchant provided about their job requirements. Details are returned as sets of questions and responses. - [JobStatus](https://shopify.dev/docs/api/partner/2024-10/enums/JobStatus.txt) - The status of the [Experts Marketplace job](https://help.shopify.com/partners/selling-services). - [LegacyTransaction](https://shopify.dev/docs/api/partner/2024-10/objects/LegacyTransaction.txt) - A transaction of a type that is no longer supported. - [MerchantUser](https://shopify.dev/docs/api/partner/2024-10/objects/MerchantUser.txt) - 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. - [Message](https://shopify.dev/docs/api/partner/2024-10/objects/Message.txt) - A message exchanged within a conversation. - [MessageConnection](https://shopify.dev/docs/api/partner/2024-10/connections/MessageConnection.txt) - The connection type for Message. - [MessageSender](https://shopify.dev/docs/api/partner/2024-10/unions/MessageSender.txt) - A union of all of the types that can send messages within a conversation. - [MessageSentVia](https://shopify.dev/docs/api/partner/2024-10/enums/MessageSentVia.txt) - The platform that was used to send the message. - [Money](https://shopify.dev/docs/api/partner/2024-10/objects/Money.txt) - A monetary value with currency. - [MoneyInput](https://shopify.dev/docs/api/partner/2024-10/input-objects/MoneyInput.txt) - A monetary value with currency. - [appCreditCreate](https://shopify.dev/docs/api/partner/2024-10/mutations/appCreditCreate.txt) - Allows an app to create a credit for a shop that can be used towards future app purchases. This mutation is only available to Partner API clients that have been granted the `View financials` permission. - [OneTimeChargeAccepted](https://shopify.dev/docs/api/partner/2024-10/objects/OneTimeChargeAccepted.txt) - An event that marks that a one-time app charge was accepted by the merchant. - [OneTimeChargeActivated](https://shopify.dev/docs/api/partner/2024-10/objects/OneTimeChargeActivated.txt) - An event that marks that a one-time app charge was activated. - [OneTimeChargeDeclined](https://shopify.dev/docs/api/partner/2024-10/objects/OneTimeChargeDeclined.txt) - An event that marks that a one-time app charge was declined by the merchant. - [OneTimeChargeExpired](https://shopify.dev/docs/api/partner/2024-10/objects/OneTimeChargeExpired.txt) - An event that marks that a one-time app charge expired before the merchant could accept it. - [Organization](https://shopify.dev/docs/api/partner/2024-10/objects/Organization.txt) - A Partner organization. - [PageInfo](https://shopify.dev/docs/api/partner/2024-10/objects/PageInfo.txt) - Information about pagination in a connection. - [QueryRoot](https://shopify.dev/docs/api/partner/2024-10/objects/QueryRoot.txt) - The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. - [app](https://shopify.dev/docs/api/partner/2024-10/queries/app.txt) - A Shopify [app](/concepts/apps). - [conversation](https://shopify.dev/docs/api/partner/2024-10/queries/conversation.txt) - A conversation with a merchant through the Experts Marketplace. - [conversations](https://shopify.dev/docs/api/partner/2024-10/queries/conversations.txt) - A list of the Partner organization's conversations. - [job](https://shopify.dev/docs/api/partner/2024-10/queries/job.txt) - An [Experts Marketplace job](https://help.shopify.com/partners/selling-services). - [jobs](https://shopify.dev/docs/api/partner/2024-10/queries/jobs.txt) - A list of the Partner organization's [Experts Marketplace jobs](https://help.shopify.com/partners/selling-services). - [publicApiVersions](https://shopify.dev/docs/api/partner/2024-10/queries/publicApiVersions.txt) - The list of public Partner API versions, including supported, release candidate and unstable versions. - [transaction](https://shopify.dev/docs/api/partner/2024-10/queries/transaction.txt) - A Shopify Partner transaction. - [transactions](https://shopify.dev/docs/api/partner/2024-10/queries/transactions.txt) - A list of the Partner organization's [transactions](https://help.shopify.com/partners/getting-started/getting-paid). - [ReferralAdjustment](https://shopify.dev/docs/api/partner/2024-10/objects/ReferralAdjustment.txt) - A transaction corresponding to a shop referral adjustment. - [ReferralCategory](https://shopify.dev/docs/api/partner/2024-10/enums/ReferralCategory.txt) - The referral type. - [ReferralTransaction](https://shopify.dev/docs/api/partner/2024-10/objects/ReferralTransaction.txt) - A transaction corresponding to a shop referral. - [RelationshipDeactivated](https://shopify.dev/docs/api/partner/2024-10/objects/RelationshipDeactivated.txt) - An event that marks that an app was deactivated. - [RelationshipInstalled](https://shopify.dev/docs/api/partner/2024-10/objects/RelationshipInstalled.txt) - An event that marks that an app was installed. - [RelationshipReactivated](https://shopify.dev/docs/api/partner/2024-10/objects/RelationshipReactivated.txt) - An event that marks that an app was reactivated. - [RelationshipUninstalled](https://shopify.dev/docs/api/partner/2024-10/objects/RelationshipUninstalled.txt) - An event that marks that an app was uninstalled. - [Service](https://shopify.dev/docs/api/partner/2024-10/objects/Service.txt) - A service in the Experts Marketplace. - [ServiceSale](https://shopify.dev/docs/api/partner/2024-10/objects/ServiceSale.txt) - A transaction corresponding to a paid invoice for a service. - [ServiceSaleAdjustment](https://shopify.dev/docs/api/partner/2024-10/objects/ServiceSaleAdjustment.txt) - A transaction corresponding to a refund, downgrade, or adjustment of a service sale. - [Shop](https://shopify.dev/docs/api/partner/2024-10/objects/Shop.txt) - A Shopify shop. - [ShopifyEmployee](https://shopify.dev/docs/api/partner/2024-10/objects/ShopifyEmployee.txt) - A Shopify employee. - [String](https://shopify.dev/docs/api/partner/2024-10/scalars/String.txt) - Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. - [SubscriptionApproachingCappedAmount](https://shopify.dev/docs/api/partner/2024-10/objects/SubscriptionApproachingCappedAmount.txt) - An event that marks that a subscription is approaching its capped amount. - [SubscriptionCappedAmountUpdated](https://shopify.dev/docs/api/partner/2024-10/objects/SubscriptionCappedAmountUpdated.txt) - An event that marks that a subscription had its capped amount updated. - [SubscriptionChargeAccepted](https://shopify.dev/docs/api/partner/2024-10/objects/SubscriptionChargeAccepted.txt) - An event that marks that a recurring app charge was accepted. - [SubscriptionChargeActivated](https://shopify.dev/docs/api/partner/2024-10/objects/SubscriptionChargeActivated.txt) - An event that marks that a recurring app charge was activated. - [SubscriptionChargeCanceled](https://shopify.dev/docs/api/partner/2024-10/objects/SubscriptionChargeCanceled.txt) - An event that marks that a recurring app charge was cancelled. - [SubscriptionChargeDeclined](https://shopify.dev/docs/api/partner/2024-10/objects/SubscriptionChargeDeclined.txt) - An event that marks that a recurring app charge was declined. - [SubscriptionChargeExpired](https://shopify.dev/docs/api/partner/2024-10/objects/SubscriptionChargeExpired.txt) - An event that marks that a recurring app charge has expired. - [SubscriptionChargeFrozen](https://shopify.dev/docs/api/partner/2024-10/objects/SubscriptionChargeFrozen.txt) - An event that marks that a recurring app charge has been suspended. For example, if a merchant stops paying their bills, or closes their store, then Shopify suspends the recurring app charge. - [SubscriptionChargeUnfrozen](https://shopify.dev/docs/api/partner/2024-10/objects/SubscriptionChargeUnfrozen.txt) - An event that marks that a recurring app charge was unfrozen. - [TaxTransaction](https://shopify.dev/docs/api/partner/2024-10/objects/TaxTransaction.txt) - 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. - [TaxTransactionType](https://shopify.dev/docs/api/partner/2024-10/enums/TaxTransactionType.txt) - The tax model applied to the transaction, based on the transaction type. - [TeamMember](https://shopify.dev/docs/api/partner/2024-10/objects/TeamMember.txt) - An owner or staff member of the Partner Organization. - [Theme](https://shopify.dev/docs/api/partner/2024-10/objects/Theme.txt) - A Shopify [theme](/concepts/themes). - [ThemeSale](https://shopify.dev/docs/api/partner/2024-10/objects/ThemeSale.txt) - A transaction corresponding to a theme purchase. - [ThemeSaleAdjustment](https://shopify.dev/docs/api/partner/2024-10/objects/ThemeSaleAdjustment.txt) - A transaction corresponding to a refund, downgrade, or adjustment of a theme sale. - [Transaction](https://shopify.dev/docs/api/partner/2024-10/interfaces/Transaction.txt) - A Shopify Partner transaction. - [TransactionConnection](https://shopify.dev/docs/api/partner/2024-10/connections/TransactionConnection.txt) - The connection type for Transaction. - [TransactionType](https://shopify.dev/docs/api/partner/2024-10/enums/TransactionType.txt) - The type of transaction. - [Url](https://shopify.dev/docs/api/partner/2024-10/scalars/Url.txt) - A valid URL, transported as a string. - [UsageChargeApplied](https://shopify.dev/docs/api/partner/2024-10/objects/UsageChargeApplied.txt) - An event that marks that an app usage charge was applied. - [UserError](https://shopify.dev/docs/api/partner/2024-10/objects/UserError.txt) - Represents an error in a mutation. - [__Directive](https://shopify.dev/docs/api/partner/2024-10/objects/__Directive.txt) - A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor. - [__DirectiveLocation](https://shopify.dev/docs/api/partner/2024-10/enums/__DirectiveLocation.txt) - A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies. - [__EnumValue](https://shopify.dev/docs/api/partner/2024-10/objects/__EnumValue.txt) - One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string. - [__Field](https://shopify.dev/docs/api/partner/2024-10/objects/__Field.txt) - Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type. - [__InputValue](https://shopify.dev/docs/api/partner/2024-10/objects/__InputValue.txt) - Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value. - [__Schema](https://shopify.dev/docs/api/partner/2024-10/objects/__Schema.txt) - A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations. - [__Type](https://shopify.dev/docs/api/partner/2024-10/objects/__Type.txt) - The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types. - [__TypeKind](https://shopify.dev/docs/api/partner/2024-10/enums/__TypeKind.txt) - An enum describing what kind of type a given `__Type` is. ## **2025-01** API Reference - [Actor](https://shopify.dev/docs/api/partner/2025-01/interfaces/Actor.txt) - A Partner organization or shop. - [ApiVersion](https://shopify.dev/docs/api/partner/2025-01/objects/ApiVersion.txt) - A version of the API. - [App](https://shopify.dev/docs/api/partner/2025-01/objects/App.txt) - A Shopify [app](/concepts/apps). - [AppCharge](https://shopify.dev/docs/api/partner/2025-01/interfaces/AppCharge.txt) - A [charge](/docs/admin-api/rest/reference/billing/applicationcharge) created through an app. - [AppCredit](https://shopify.dev/docs/api/partner/2025-01/objects/AppCredit.txt) - A [credit](/docs/admin-api/rest/reference/billing/applicationcredit) 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. - [AppCreditCreatePayload](https://shopify.dev/docs/api/partner/2025-01/payloads/AppCreditCreatePayload.txt) - The result of an appCreditCreate mutation. - [AppCreditEvent](https://shopify.dev/docs/api/partner/2025-01/interfaces/AppCreditEvent.txt) - An event involving an app credit. - [AppEvent](https://shopify.dev/docs/api/partner/2025-01/interfaces/AppEvent.txt) - An event related to a Shopify app. - [AppEventConnection](https://shopify.dev/docs/api/partner/2025-01/connections/AppEventConnection.txt) - The connection type for AppEvent. - [AppEventTypes](https://shopify.dev/docs/api/partner/2025-01/enums/AppEventTypes.txt) - The type of app event. - [AppOneTimeSale](https://shopify.dev/docs/api/partner/2025-01/objects/AppOneTimeSale.txt) - A transaction corresponding to a one-time app charge. - [AppPricingInterval](https://shopify.dev/docs/api/partner/2025-01/enums/AppPricingInterval.txt) - The billing frequency for the app. - [AppPurchaseOneTime](https://shopify.dev/docs/api/partner/2025-01/objects/AppPurchaseOneTime.txt) - 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. - [AppPurchaseOneTimeEvent](https://shopify.dev/docs/api/partner/2025-01/interfaces/AppPurchaseOneTimeEvent.txt) - An app event for a one-time app charge. - [AppSaleAdjustment](https://shopify.dev/docs/api/partner/2025-01/objects/AppSaleAdjustment.txt) - A transaction corresponding to a refund, downgrade, or adjustment of an app charge. - [AppSaleCredit](https://shopify.dev/docs/api/partner/2025-01/objects/AppSaleCredit.txt) - A transaction corresponding to an [app credit](/docs/admin-api/rest/reference/billing/applicationcredit). - [AppSubscription](https://shopify.dev/docs/api/partner/2025-01/objects/AppSubscription.txt) - A recurring charge for use of an app, such as a monthly subscription charge. - [AppSubscriptionEvent](https://shopify.dev/docs/api/partner/2025-01/interfaces/AppSubscriptionEvent.txt) - An event related to an [app subscription charge](/docs/admin-api/rest/reference/billing/recurringapplicationcharge). - [AppSubscriptionSale](https://shopify.dev/docs/api/partner/2025-01/objects/AppSubscriptionSale.txt) - A transaction corresponding to an app subscription charge. - [AppUsageRecord](https://shopify.dev/docs/api/partner/2025-01/objects/AppUsageRecord.txt) - An app charge. This charge varies based on how much the merchant uses the app or a service that the app integrates with. - [AppUsageRecordEvent](https://shopify.dev/docs/api/partner/2025-01/interfaces/AppUsageRecordEvent.txt) - An app event for an app usage charge. - [AppUsageSale](https://shopify.dev/docs/api/partner/2025-01/objects/AppUsageSale.txt) - A transaction corresponding to an app usage charge. - [Boolean](https://shopify.dev/docs/api/partner/2025-01/scalars/Boolean.txt) - Represents `true` or `false` values. - [Conversation](https://shopify.dev/docs/api/partner/2025-01/objects/Conversation.txt) - A conversation with a merchant through the Experts Marketplace. - [ConversationConnection](https://shopify.dev/docs/api/partner/2025-01/connections/ConversationConnection.txt) - The connection type for Conversation. - [ConversationStatus](https://shopify.dev/docs/api/partner/2025-01/enums/ConversationStatus.txt) - The status of the Experts Marketplace conversation. - [CreditApplied](https://shopify.dev/docs/api/partner/2025-01/objects/CreditApplied.txt) - An event that marks that an app credit was applied. - [CreditFailed](https://shopify.dev/docs/api/partner/2025-01/objects/CreditFailed.txt) - An event that marks that an app credit failed to apply. - [CreditPending](https://shopify.dev/docs/api/partner/2025-01/objects/CreditPending.txt) - An event that marks that an app credit is pending. - [Currency](https://shopify.dev/docs/api/partner/2025-01/enums/Currency.txt) - Supported monetary currencies from ISO 4217. - [DateTime](https://shopify.dev/docs/api/partner/2025-01/scalars/DateTime.txt) - An [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) encoded UTC date time string. Example value: `"2019-07-03T20:47:55.123456Z"`. - [Decimal](https://shopify.dev/docs/api/partner/2025-01/scalars/Decimal.txt) - A signed decimal number, which supports arbitrary precision and is serialized as a string. - [ID](https://shopify.dev/docs/api/partner/2025-01/scalars/ID.txt) - Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) input value will be accepted as an ID. - [Int](https://shopify.dev/docs/api/partner/2025-01/scalars/Int.txt) - Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. - [Job](https://shopify.dev/docs/api/partner/2025-01/objects/Job.txt) - An [Experts Marketplace job](https://help.shopify.com/partners/selling-services). - [JobConnection](https://shopify.dev/docs/api/partner/2025-01/connections/JobConnection.txt) - The connection type for Job. - [JobRequirement](https://shopify.dev/docs/api/partner/2025-01/objects/JobRequirement.txt) - Details that the merchant provided about their job requirements. Details are returned as sets of questions and responses. - [JobStatus](https://shopify.dev/docs/api/partner/2025-01/enums/JobStatus.txt) - The status of the [Experts Marketplace job](https://help.shopify.com/partners/selling-services). - [LegacyTransaction](https://shopify.dev/docs/api/partner/2025-01/objects/LegacyTransaction.txt) - A transaction of a type that is no longer supported. - [MerchantUser](https://shopify.dev/docs/api/partner/2025-01/objects/MerchantUser.txt) - 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. - [Message](https://shopify.dev/docs/api/partner/2025-01/objects/Message.txt) - A message exchanged within a conversation. - [MessageConnection](https://shopify.dev/docs/api/partner/2025-01/connections/MessageConnection.txt) - The connection type for Message. - [MessageSender](https://shopify.dev/docs/api/partner/2025-01/unions/MessageSender.txt) - A union of all of the types that can send messages within a conversation. - [MessageSentVia](https://shopify.dev/docs/api/partner/2025-01/enums/MessageSentVia.txt) - The platform that was used to send the message. - [Money](https://shopify.dev/docs/api/partner/2025-01/objects/Money.txt) - A monetary value with currency. - [MoneyInput](https://shopify.dev/docs/api/partner/2025-01/input-objects/MoneyInput.txt) - A monetary value with currency. - [appCreditCreate](https://shopify.dev/docs/api/partner/2025-01/mutations/appCreditCreate.txt) - Allows an app to create a credit for a shop that can be used towards future app purchases. This mutation is only available to Partner API clients that have been granted the `View financials` permission. - [OneTimeChargeAccepted](https://shopify.dev/docs/api/partner/2025-01/objects/OneTimeChargeAccepted.txt) - An event that marks that a one-time app charge was accepted by the merchant. - [OneTimeChargeActivated](https://shopify.dev/docs/api/partner/2025-01/objects/OneTimeChargeActivated.txt) - An event that marks that a one-time app charge was activated. - [OneTimeChargeDeclined](https://shopify.dev/docs/api/partner/2025-01/objects/OneTimeChargeDeclined.txt) - An event that marks that a one-time app charge was declined by the merchant. - [OneTimeChargeExpired](https://shopify.dev/docs/api/partner/2025-01/objects/OneTimeChargeExpired.txt) - An event that marks that a one-time app charge expired before the merchant could accept it. - [Organization](https://shopify.dev/docs/api/partner/2025-01/objects/Organization.txt) - A Partner organization. - [PageInfo](https://shopify.dev/docs/api/partner/2025-01/objects/PageInfo.txt) - Information about pagination in a connection. - [QueryRoot](https://shopify.dev/docs/api/partner/2025-01/objects/QueryRoot.txt) - The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. - [app](https://shopify.dev/docs/api/partner/2025-01/queries/app.txt) - A Shopify [app](/concepts/apps). - [conversation](https://shopify.dev/docs/api/partner/2025-01/queries/conversation.txt) - A conversation with a merchant through the Experts Marketplace. - [conversations](https://shopify.dev/docs/api/partner/2025-01/queries/conversations.txt) - A list of the Partner organization's conversations. - [job](https://shopify.dev/docs/api/partner/2025-01/queries/job.txt) - An [Experts Marketplace job](https://help.shopify.com/partners/selling-services). - [jobs](https://shopify.dev/docs/api/partner/2025-01/queries/jobs.txt) - A list of the Partner organization's [Experts Marketplace jobs](https://help.shopify.com/partners/selling-services). - [publicApiVersions](https://shopify.dev/docs/api/partner/2025-01/queries/publicApiVersions.txt) - The list of public Partner API versions, including supported, release candidate and unstable versions. - [transaction](https://shopify.dev/docs/api/partner/2025-01/queries/transaction.txt) - A Shopify Partner transaction. - [transactions](https://shopify.dev/docs/api/partner/2025-01/queries/transactions.txt) - A list of the Partner organization's [transactions](https://help.shopify.com/partners/getting-started/getting-paid). - [ReferralAdjustment](https://shopify.dev/docs/api/partner/2025-01/objects/ReferralAdjustment.txt) - A transaction corresponding to a shop referral adjustment. - [ReferralCategory](https://shopify.dev/docs/api/partner/2025-01/enums/ReferralCategory.txt) - The referral type. - [ReferralTransaction](https://shopify.dev/docs/api/partner/2025-01/objects/ReferralTransaction.txt) - A transaction corresponding to a shop referral. - [RelationshipDeactivated](https://shopify.dev/docs/api/partner/2025-01/objects/RelationshipDeactivated.txt) - An event that marks that an app was deactivated. - [RelationshipInstalled](https://shopify.dev/docs/api/partner/2025-01/objects/RelationshipInstalled.txt) - An event that marks that an app was installed. - [RelationshipReactivated](https://shopify.dev/docs/api/partner/2025-01/objects/RelationshipReactivated.txt) - An event that marks that an app was reactivated. - [RelationshipUninstalled](https://shopify.dev/docs/api/partner/2025-01/objects/RelationshipUninstalled.txt) - An event that marks that an app was uninstalled. - [Service](https://shopify.dev/docs/api/partner/2025-01/objects/Service.txt) - A service in the Experts Marketplace. - [ServiceSale](https://shopify.dev/docs/api/partner/2025-01/objects/ServiceSale.txt) - A transaction corresponding to a paid invoice for a service. - [ServiceSaleAdjustment](https://shopify.dev/docs/api/partner/2025-01/objects/ServiceSaleAdjustment.txt) - A transaction corresponding to a refund, downgrade, or adjustment of a service sale. - [Shop](https://shopify.dev/docs/api/partner/2025-01/objects/Shop.txt) - A Shopify shop. - [ShopifyEmployee](https://shopify.dev/docs/api/partner/2025-01/objects/ShopifyEmployee.txt) - A Shopify employee. - [String](https://shopify.dev/docs/api/partner/2025-01/scalars/String.txt) - Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. - [SubscriptionApproachingCappedAmount](https://shopify.dev/docs/api/partner/2025-01/objects/SubscriptionApproachingCappedAmount.txt) - An event that marks that a subscription is approaching its capped amount. - [SubscriptionCappedAmountUpdated](https://shopify.dev/docs/api/partner/2025-01/objects/SubscriptionCappedAmountUpdated.txt) - An event that marks that a subscription had its capped amount updated. - [SubscriptionChargeAccepted](https://shopify.dev/docs/api/partner/2025-01/objects/SubscriptionChargeAccepted.txt) - An event that marks that a recurring app charge was accepted. - [SubscriptionChargeActivated](https://shopify.dev/docs/api/partner/2025-01/objects/SubscriptionChargeActivated.txt) - An event that marks that a recurring app charge was activated. - [SubscriptionChargeCanceled](https://shopify.dev/docs/api/partner/2025-01/objects/SubscriptionChargeCanceled.txt) - An event that marks that a recurring app charge was cancelled. - [SubscriptionChargeDeclined](https://shopify.dev/docs/api/partner/2025-01/objects/SubscriptionChargeDeclined.txt) - An event that marks that a recurring app charge was declined. - [SubscriptionChargeExpired](https://shopify.dev/docs/api/partner/2025-01/objects/SubscriptionChargeExpired.txt) - An event that marks that a recurring app charge has expired. - [SubscriptionChargeFrozen](https://shopify.dev/docs/api/partner/2025-01/objects/SubscriptionChargeFrozen.txt) - An event that marks that a recurring app charge has been suspended. For example, if a merchant stops paying their bills, or closes their store, then Shopify suspends the recurring app charge. - [SubscriptionChargeUnfrozen](https://shopify.dev/docs/api/partner/2025-01/objects/SubscriptionChargeUnfrozen.txt) - An event that marks that a recurring app charge was unfrozen. - [TaxTransaction](https://shopify.dev/docs/api/partner/2025-01/objects/TaxTransaction.txt) - 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. - [TaxTransactionType](https://shopify.dev/docs/api/partner/2025-01/enums/TaxTransactionType.txt) - The tax model applied to the transaction, based on the transaction type. - [TeamMember](https://shopify.dev/docs/api/partner/2025-01/objects/TeamMember.txt) - An owner or staff member of the Partner Organization. - [Theme](https://shopify.dev/docs/api/partner/2025-01/objects/Theme.txt) - A Shopify [theme](/concepts/themes). - [ThemeSale](https://shopify.dev/docs/api/partner/2025-01/objects/ThemeSale.txt) - A transaction corresponding to a theme purchase. - [ThemeSaleAdjustment](https://shopify.dev/docs/api/partner/2025-01/objects/ThemeSaleAdjustment.txt) - A transaction corresponding to a refund, downgrade, or adjustment of a theme sale. - [Transaction](https://shopify.dev/docs/api/partner/2025-01/interfaces/Transaction.txt) - A Shopify Partner transaction. - [TransactionConnection](https://shopify.dev/docs/api/partner/2025-01/connections/TransactionConnection.txt) - The connection type for Transaction. - [TransactionType](https://shopify.dev/docs/api/partner/2025-01/enums/TransactionType.txt) - The type of transaction. - [Url](https://shopify.dev/docs/api/partner/2025-01/scalars/Url.txt) - A valid URL, transported as a string. - [UsageChargeApplied](https://shopify.dev/docs/api/partner/2025-01/objects/UsageChargeApplied.txt) - An event that marks that an app usage charge was applied. - [UserError](https://shopify.dev/docs/api/partner/2025-01/objects/UserError.txt) - Represents an error in a mutation. - [__Directive](https://shopify.dev/docs/api/partner/2025-01/objects/__Directive.txt) - A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor. - [__DirectiveLocation](https://shopify.dev/docs/api/partner/2025-01/enums/__DirectiveLocation.txt) - A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies. - [__EnumValue](https://shopify.dev/docs/api/partner/2025-01/objects/__EnumValue.txt) - One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string. - [__Field](https://shopify.dev/docs/api/partner/2025-01/objects/__Field.txt) - Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type. - [__InputValue](https://shopify.dev/docs/api/partner/2025-01/objects/__InputValue.txt) - Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value. - [__Schema](https://shopify.dev/docs/api/partner/2025-01/objects/__Schema.txt) - A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations. - [__Type](https://shopify.dev/docs/api/partner/2025-01/objects/__Type.txt) - The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types. - [__TypeKind](https://shopify.dev/docs/api/partner/2025-01/enums/__TypeKind.txt) - An enum describing what kind of type a given `__Type` is. ## **2025-04** API Reference - [Actor](https://shopify.dev/docs/api/partner/2025-04/interfaces/Actor.txt) - A Partner organization or shop. - [ApiVersion](https://shopify.dev/docs/api/partner/2025-04/objects/ApiVersion.txt) - A version of the API. - [App](https://shopify.dev/docs/api/partner/2025-04/objects/App.txt) - A Shopify [app](/concepts/apps). - [AppCharge](https://shopify.dev/docs/api/partner/2025-04/interfaces/AppCharge.txt) - A [charge](/docs/admin-api/rest/reference/billing/applicationcharge) created through an app. - [AppCredit](https://shopify.dev/docs/api/partner/2025-04/objects/AppCredit.txt) - A [credit](/docs/admin-api/rest/reference/billing/applicationcredit) 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. - [AppCreditCreatePayload](https://shopify.dev/docs/api/partner/2025-04/payloads/AppCreditCreatePayload.txt) - The result of an appCreditCreate mutation. - [AppCreditEvent](https://shopify.dev/docs/api/partner/2025-04/interfaces/AppCreditEvent.txt) - An event involving an app credit. - [AppEvent](https://shopify.dev/docs/api/partner/2025-04/interfaces/AppEvent.txt) - An event related to a Shopify app. - [AppEventConnection](https://shopify.dev/docs/api/partner/2025-04/connections/AppEventConnection.txt) - The connection type for AppEvent. - [AppEventTypes](https://shopify.dev/docs/api/partner/2025-04/enums/AppEventTypes.txt) - The type of app event. - [AppOneTimeSale](https://shopify.dev/docs/api/partner/2025-04/objects/AppOneTimeSale.txt) - A transaction corresponding to a one-time app charge. - [AppPricingInterval](https://shopify.dev/docs/api/partner/2025-04/enums/AppPricingInterval.txt) - The billing frequency for the app. - [AppPurchaseOneTime](https://shopify.dev/docs/api/partner/2025-04/objects/AppPurchaseOneTime.txt) - 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. - [AppPurchaseOneTimeEvent](https://shopify.dev/docs/api/partner/2025-04/interfaces/AppPurchaseOneTimeEvent.txt) - An app event for a one-time app charge. - [AppSaleAdjustment](https://shopify.dev/docs/api/partner/2025-04/objects/AppSaleAdjustment.txt) - A transaction corresponding to a refund, downgrade, or adjustment of an app charge. - [AppSaleCredit](https://shopify.dev/docs/api/partner/2025-04/objects/AppSaleCredit.txt) - A transaction corresponding to an [app credit](/docs/admin-api/rest/reference/billing/applicationcredit). - [AppSubscription](https://shopify.dev/docs/api/partner/2025-04/objects/AppSubscription.txt) - A recurring charge for use of an app, such as a monthly subscription charge. - [AppSubscriptionEvent](https://shopify.dev/docs/api/partner/2025-04/interfaces/AppSubscriptionEvent.txt) - An event related to an [app subscription charge](/docs/admin-api/rest/reference/billing/recurringapplicationcharge). - [AppSubscriptionSale](https://shopify.dev/docs/api/partner/2025-04/objects/AppSubscriptionSale.txt) - A transaction corresponding to an app subscription charge. - [AppUsageRecord](https://shopify.dev/docs/api/partner/2025-04/objects/AppUsageRecord.txt) - An app charge. This charge varies based on how much the merchant uses the app or a service that the app integrates with. - [AppUsageRecordEvent](https://shopify.dev/docs/api/partner/2025-04/interfaces/AppUsageRecordEvent.txt) - An app event for an app usage charge. - [AppUsageSale](https://shopify.dev/docs/api/partner/2025-04/objects/AppUsageSale.txt) - A transaction corresponding to an app usage charge. - [Boolean](https://shopify.dev/docs/api/partner/2025-04/scalars/Boolean.txt) - Represents `true` or `false` values. - [Conversation](https://shopify.dev/docs/api/partner/2025-04/objects/Conversation.txt) - A conversation with a merchant through the Experts Marketplace. - [ConversationConnection](https://shopify.dev/docs/api/partner/2025-04/connections/ConversationConnection.txt) - The connection type for Conversation. - [ConversationStatus](https://shopify.dev/docs/api/partner/2025-04/enums/ConversationStatus.txt) - The status of the Experts Marketplace conversation. - [CreditApplied](https://shopify.dev/docs/api/partner/2025-04/objects/CreditApplied.txt) - An event that marks that an app credit was applied. - [CreditFailed](https://shopify.dev/docs/api/partner/2025-04/objects/CreditFailed.txt) - An event that marks that an app credit failed to apply. - [CreditPending](https://shopify.dev/docs/api/partner/2025-04/objects/CreditPending.txt) - An event that marks that an app credit is pending. - [Currency](https://shopify.dev/docs/api/partner/2025-04/enums/Currency.txt) - Supported monetary currencies from ISO 4217. - [DateTime](https://shopify.dev/docs/api/partner/2025-04/scalars/DateTime.txt) - An [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) encoded UTC date time string. Example value: `"2019-07-03T20:47:55.123456Z"`. - [Decimal](https://shopify.dev/docs/api/partner/2025-04/scalars/Decimal.txt) - A signed decimal number, which supports arbitrary precision and is serialized as a string. - [ID](https://shopify.dev/docs/api/partner/2025-04/scalars/ID.txt) - Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) input value will be accepted as an ID. - [Int](https://shopify.dev/docs/api/partner/2025-04/scalars/Int.txt) - Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. - [Job](https://shopify.dev/docs/api/partner/2025-04/objects/Job.txt) - An [Experts Marketplace job](https://help.shopify.com/partners/selling-services). - [JobConnection](https://shopify.dev/docs/api/partner/2025-04/connections/JobConnection.txt) - The connection type for Job. - [JobRequirement](https://shopify.dev/docs/api/partner/2025-04/objects/JobRequirement.txt) - Details that the merchant provided about their job requirements. Details are returned as sets of questions and responses. - [JobStatus](https://shopify.dev/docs/api/partner/2025-04/enums/JobStatus.txt) - The status of the [Experts Marketplace job](https://help.shopify.com/partners/selling-services). - [LegacyTransaction](https://shopify.dev/docs/api/partner/2025-04/objects/LegacyTransaction.txt) - A transaction of a type that is no longer supported. - [MerchantUser](https://shopify.dev/docs/api/partner/2025-04/objects/MerchantUser.txt) - 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. - [Message](https://shopify.dev/docs/api/partner/2025-04/objects/Message.txt) - A message exchanged within a conversation. - [MessageConnection](https://shopify.dev/docs/api/partner/2025-04/connections/MessageConnection.txt) - The connection type for Message. - [MessageSender](https://shopify.dev/docs/api/partner/2025-04/unions/MessageSender.txt) - A union of all of the types that can send messages within a conversation. - [MessageSentVia](https://shopify.dev/docs/api/partner/2025-04/enums/MessageSentVia.txt) - The platform that was used to send the message. - [Money](https://shopify.dev/docs/api/partner/2025-04/objects/Money.txt) - A monetary value with currency. - [MoneyInput](https://shopify.dev/docs/api/partner/2025-04/input-objects/MoneyInput.txt) - A monetary value with currency. - [appCreditCreate](https://shopify.dev/docs/api/partner/2025-04/mutations/appCreditCreate.txt) - Allows an app to create a credit for a shop that can be used towards future app purchases. This mutation is only available to Partner API clients that have been granted the `View financials` permission. - [OneTimeChargeAccepted](https://shopify.dev/docs/api/partner/2025-04/objects/OneTimeChargeAccepted.txt) - An event that marks that a one-time app charge was accepted by the merchant. - [OneTimeChargeActivated](https://shopify.dev/docs/api/partner/2025-04/objects/OneTimeChargeActivated.txt) - An event that marks that a one-time app charge was activated. - [OneTimeChargeDeclined](https://shopify.dev/docs/api/partner/2025-04/objects/OneTimeChargeDeclined.txt) - An event that marks that a one-time app charge was declined by the merchant. - [OneTimeChargeExpired](https://shopify.dev/docs/api/partner/2025-04/objects/OneTimeChargeExpired.txt) - An event that marks that a one-time app charge expired before the merchant could accept it. - [Organization](https://shopify.dev/docs/api/partner/2025-04/objects/Organization.txt) - A Partner organization. - [PageInfo](https://shopify.dev/docs/api/partner/2025-04/objects/PageInfo.txt) - Information about pagination in a connection. - [QueryRoot](https://shopify.dev/docs/api/partner/2025-04/objects/QueryRoot.txt) - The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. - [app](https://shopify.dev/docs/api/partner/2025-04/queries/app.txt) - A Shopify [app](/concepts/apps). - [conversation](https://shopify.dev/docs/api/partner/2025-04/queries/conversation.txt) - A conversation with a merchant through the Experts Marketplace. - [conversations](https://shopify.dev/docs/api/partner/2025-04/queries/conversations.txt) - A list of the Partner organization's conversations. - [job](https://shopify.dev/docs/api/partner/2025-04/queries/job.txt) - An [Experts Marketplace job](https://help.shopify.com/partners/selling-services). - [jobs](https://shopify.dev/docs/api/partner/2025-04/queries/jobs.txt) - A list of the Partner organization's [Experts Marketplace jobs](https://help.shopify.com/partners/selling-services). - [publicApiVersions](https://shopify.dev/docs/api/partner/2025-04/queries/publicApiVersions.txt) - The list of public Partner API versions, including supported, release candidate and unstable versions. - [transaction](https://shopify.dev/docs/api/partner/2025-04/queries/transaction.txt) - A Shopify Partner transaction. - [transactions](https://shopify.dev/docs/api/partner/2025-04/queries/transactions.txt) - A list of the Partner organization's [transactions](https://help.shopify.com/partners/getting-started/getting-paid). - [ReferralAdjustment](https://shopify.dev/docs/api/partner/2025-04/objects/ReferralAdjustment.txt) - A transaction corresponding to a shop referral adjustment. - [ReferralCategory](https://shopify.dev/docs/api/partner/2025-04/enums/ReferralCategory.txt) - The referral type. - [ReferralTransaction](https://shopify.dev/docs/api/partner/2025-04/objects/ReferralTransaction.txt) - A transaction corresponding to a shop referral. - [RelationshipDeactivated](https://shopify.dev/docs/api/partner/2025-04/objects/RelationshipDeactivated.txt) - An event that marks that an app was deactivated. - [RelationshipInstalled](https://shopify.dev/docs/api/partner/2025-04/objects/RelationshipInstalled.txt) - An event that marks that an app was installed. - [RelationshipReactivated](https://shopify.dev/docs/api/partner/2025-04/objects/RelationshipReactivated.txt) - An event that marks that an app was reactivated. - [RelationshipUninstalled](https://shopify.dev/docs/api/partner/2025-04/objects/RelationshipUninstalled.txt) - An event that marks that an app was uninstalled. - [Service](https://shopify.dev/docs/api/partner/2025-04/objects/Service.txt) - A service in the Experts Marketplace. - [ServiceSale](https://shopify.dev/docs/api/partner/2025-04/objects/ServiceSale.txt) - A transaction corresponding to a paid invoice for a service. - [ServiceSaleAdjustment](https://shopify.dev/docs/api/partner/2025-04/objects/ServiceSaleAdjustment.txt) - A transaction corresponding to a refund, downgrade, or adjustment of a service sale. - [Shop](https://shopify.dev/docs/api/partner/2025-04/objects/Shop.txt) - A Shopify shop. - [ShopifyEmployee](https://shopify.dev/docs/api/partner/2025-04/objects/ShopifyEmployee.txt) - A Shopify employee. - [String](https://shopify.dev/docs/api/partner/2025-04/scalars/String.txt) - Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. - [SubscriptionApproachingCappedAmount](https://shopify.dev/docs/api/partner/2025-04/objects/SubscriptionApproachingCappedAmount.txt) - An event that marks that a subscription is approaching its capped amount. - [SubscriptionCappedAmountUpdated](https://shopify.dev/docs/api/partner/2025-04/objects/SubscriptionCappedAmountUpdated.txt) - An event that marks that a subscription had its capped amount updated. - [SubscriptionChargeAccepted](https://shopify.dev/docs/api/partner/2025-04/objects/SubscriptionChargeAccepted.txt) - An event that marks that a recurring app charge was accepted. - [SubscriptionChargeActivated](https://shopify.dev/docs/api/partner/2025-04/objects/SubscriptionChargeActivated.txt) - An event that marks that a recurring app charge was activated. - [SubscriptionChargeCanceled](https://shopify.dev/docs/api/partner/2025-04/objects/SubscriptionChargeCanceled.txt) - An event that marks that a recurring app charge was cancelled. - [SubscriptionChargeDeclined](https://shopify.dev/docs/api/partner/2025-04/objects/SubscriptionChargeDeclined.txt) - An event that marks that a recurring app charge was declined. - [SubscriptionChargeExpired](https://shopify.dev/docs/api/partner/2025-04/objects/SubscriptionChargeExpired.txt) - An event that marks that a recurring app charge has expired. - [SubscriptionChargeFrozen](https://shopify.dev/docs/api/partner/2025-04/objects/SubscriptionChargeFrozen.txt) - An event that marks that a recurring app charge has been suspended. For example, if a merchant stops paying their bills, or closes their store, then Shopify suspends the recurring app charge. - [SubscriptionChargeUnfrozen](https://shopify.dev/docs/api/partner/2025-04/objects/SubscriptionChargeUnfrozen.txt) - An event that marks that a recurring app charge was unfrozen. - [TaxTransaction](https://shopify.dev/docs/api/partner/2025-04/objects/TaxTransaction.txt) - 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. - [TaxTransactionType](https://shopify.dev/docs/api/partner/2025-04/enums/TaxTransactionType.txt) - The tax model applied to the transaction, based on the transaction type. - [TeamMember](https://shopify.dev/docs/api/partner/2025-04/objects/TeamMember.txt) - An owner or staff member of the Partner Organization. - [Theme](https://shopify.dev/docs/api/partner/2025-04/objects/Theme.txt) - A Shopify [theme](/concepts/themes). - [ThemeSale](https://shopify.dev/docs/api/partner/2025-04/objects/ThemeSale.txt) - A transaction corresponding to a theme purchase. - [ThemeSaleAdjustment](https://shopify.dev/docs/api/partner/2025-04/objects/ThemeSaleAdjustment.txt) - A transaction corresponding to a refund, downgrade, or adjustment of a theme sale. - [Transaction](https://shopify.dev/docs/api/partner/2025-04/interfaces/Transaction.txt) - A Shopify Partner transaction. - [TransactionConnection](https://shopify.dev/docs/api/partner/2025-04/connections/TransactionConnection.txt) - The connection type for Transaction. - [TransactionType](https://shopify.dev/docs/api/partner/2025-04/enums/TransactionType.txt) - The type of transaction. - [Url](https://shopify.dev/docs/api/partner/2025-04/scalars/Url.txt) - A valid URL, transported as a string. - [UsageChargeApplied](https://shopify.dev/docs/api/partner/2025-04/objects/UsageChargeApplied.txt) - An event that marks that an app usage charge was applied. - [UserError](https://shopify.dev/docs/api/partner/2025-04/objects/UserError.txt) - Represents an error in a mutation. - [__Directive](https://shopify.dev/docs/api/partner/2025-04/objects/__Directive.txt) - A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor. - [__DirectiveLocation](https://shopify.dev/docs/api/partner/2025-04/enums/__DirectiveLocation.txt) - A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies. - [__EnumValue](https://shopify.dev/docs/api/partner/2025-04/objects/__EnumValue.txt) - One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string. - [__Field](https://shopify.dev/docs/api/partner/2025-04/objects/__Field.txt) - Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type. - [__InputValue](https://shopify.dev/docs/api/partner/2025-04/objects/__InputValue.txt) - Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value. - [__Schema](https://shopify.dev/docs/api/partner/2025-04/objects/__Schema.txt) - A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations. - [__Type](https://shopify.dev/docs/api/partner/2025-04/objects/__Type.txt) - The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types. - [__TypeKind](https://shopify.dev/docs/api/partner/2025-04/enums/__TypeKind.txt) - An enum describing what kind of type a given `__Type` is. ## **2024-07** API Reference - [Actor](https://shopify.dev/docs/api/partner/2024-07/interfaces/Actor.txt) - A Partner organization or shop. - [ApiVersion](https://shopify.dev/docs/api/partner/2024-07/objects/ApiVersion.txt) - A version of the API. - [App](https://shopify.dev/docs/api/partner/2024-07/objects/App.txt) - A Shopify [app](/concepts/apps). - [AppCharge](https://shopify.dev/docs/api/partner/2024-07/interfaces/AppCharge.txt) - A [charge](/docs/admin-api/rest/reference/billing/applicationcharge) created through an app. - [AppCredit](https://shopify.dev/docs/api/partner/2024-07/objects/AppCredit.txt) - A [credit](/docs/admin-api/rest/reference/billing/applicationcredit) 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. - [AppCreditCreatePayload](https://shopify.dev/docs/api/partner/2024-07/payloads/AppCreditCreatePayload.txt) - The result of an appCreditCreate mutation. - [AppCreditEvent](https://shopify.dev/docs/api/partner/2024-07/interfaces/AppCreditEvent.txt) - An event involving an app credit. - [AppEvent](https://shopify.dev/docs/api/partner/2024-07/interfaces/AppEvent.txt) - An event related to a Shopify app. - [AppEventConnection](https://shopify.dev/docs/api/partner/2024-07/connections/AppEventConnection.txt) - The connection type for AppEvent. - [AppEventTypes](https://shopify.dev/docs/api/partner/2024-07/enums/AppEventTypes.txt) - The type of app event. - [AppOneTimeSale](https://shopify.dev/docs/api/partner/2024-07/objects/AppOneTimeSale.txt) - A transaction corresponding to a one-time app charge. - [AppPricingInterval](https://shopify.dev/docs/api/partner/2024-07/enums/AppPricingInterval.txt) - The billing frequency for the app. - [AppPurchaseOneTime](https://shopify.dev/docs/api/partner/2024-07/objects/AppPurchaseOneTime.txt) - 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. - [AppPurchaseOneTimeEvent](https://shopify.dev/docs/api/partner/2024-07/interfaces/AppPurchaseOneTimeEvent.txt) - An app event for a one-time app charge. - [AppSaleAdjustment](https://shopify.dev/docs/api/partner/2024-07/objects/AppSaleAdjustment.txt) - A transaction corresponding to a refund, downgrade, or adjustment of an app charge. - [AppSaleCredit](https://shopify.dev/docs/api/partner/2024-07/objects/AppSaleCredit.txt) - A transaction corresponding to an [app credit](/docs/admin-api/rest/reference/billing/applicationcredit). - [AppSubscription](https://shopify.dev/docs/api/partner/2024-07/objects/AppSubscription.txt) - A recurring charge for use of an app, such as a monthly subscription charge. - [AppSubscriptionEvent](https://shopify.dev/docs/api/partner/2024-07/interfaces/AppSubscriptionEvent.txt) - An event related to an [app subscription charge](/docs/admin-api/rest/reference/billing/recurringapplicationcharge). - [AppSubscriptionSale](https://shopify.dev/docs/api/partner/2024-07/objects/AppSubscriptionSale.txt) - A transaction corresponding to an app subscription charge. - [AppUsageRecord](https://shopify.dev/docs/api/partner/2024-07/objects/AppUsageRecord.txt) - An app charge. This charge varies based on how much the merchant uses the app or a service that the app integrates with. - [AppUsageRecordEvent](https://shopify.dev/docs/api/partner/2024-07/interfaces/AppUsageRecordEvent.txt) - An app event for an app usage charge. - [AppUsageSale](https://shopify.dev/docs/api/partner/2024-07/objects/AppUsageSale.txt) - A transaction corresponding to an app usage charge. - [Boolean](https://shopify.dev/docs/api/partner/2024-07/scalars/Boolean.txt) - Represents `true` or `false` values. - [Conversation](https://shopify.dev/docs/api/partner/2024-07/objects/Conversation.txt) - A conversation with a merchant through the Experts Marketplace. - [ConversationConnection](https://shopify.dev/docs/api/partner/2024-07/connections/ConversationConnection.txt) - The connection type for Conversation. - [ConversationStatus](https://shopify.dev/docs/api/partner/2024-07/enums/ConversationStatus.txt) - The status of the Experts Marketplace conversation. - [CreditApplied](https://shopify.dev/docs/api/partner/2024-07/objects/CreditApplied.txt) - An event that marks that an app credit was applied. - [CreditFailed](https://shopify.dev/docs/api/partner/2024-07/objects/CreditFailed.txt) - An event that marks that an app credit failed to apply. - [CreditPending](https://shopify.dev/docs/api/partner/2024-07/objects/CreditPending.txt) - An event that marks that an app credit is pending. - [Currency](https://shopify.dev/docs/api/partner/2024-07/enums/Currency.txt) - Supported monetary currencies from ISO 4217. - [DateTime](https://shopify.dev/docs/api/partner/2024-07/scalars/DateTime.txt) - An [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) encoded UTC date time string. Example value: `"2019-07-03T20:47:55.123456Z"`. - [Decimal](https://shopify.dev/docs/api/partner/2024-07/scalars/Decimal.txt) - A signed decimal number, which supports arbitrary precision and is serialized as a string. - [ID](https://shopify.dev/docs/api/partner/2024-07/scalars/ID.txt) - Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) input value will be accepted as an ID. - [Int](https://shopify.dev/docs/api/partner/2024-07/scalars/Int.txt) - Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. - [Job](https://shopify.dev/docs/api/partner/2024-07/objects/Job.txt) - An [Experts Marketplace job](https://help.shopify.com/partners/selling-services). - [JobConnection](https://shopify.dev/docs/api/partner/2024-07/connections/JobConnection.txt) - The connection type for Job. - [JobRequirement](https://shopify.dev/docs/api/partner/2024-07/objects/JobRequirement.txt) - Details that the merchant provided about their job requirements. Details are returned as sets of questions and responses. - [JobStatus](https://shopify.dev/docs/api/partner/2024-07/enums/JobStatus.txt) - The status of the [Experts Marketplace job](https://help.shopify.com/partners/selling-services). - [LegacyTransaction](https://shopify.dev/docs/api/partner/2024-07/objects/LegacyTransaction.txt) - A transaction of a type that is no longer supported. - [MerchantUser](https://shopify.dev/docs/api/partner/2024-07/objects/MerchantUser.txt) - 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. - [Message](https://shopify.dev/docs/api/partner/2024-07/objects/Message.txt) - A message exchanged within a conversation. - [MessageConnection](https://shopify.dev/docs/api/partner/2024-07/connections/MessageConnection.txt) - The connection type for Message. - [MessageSender](https://shopify.dev/docs/api/partner/2024-07/unions/MessageSender.txt) - A union of all of the types that can send messages within a conversation. - [MessageSentVia](https://shopify.dev/docs/api/partner/2024-07/enums/MessageSentVia.txt) - The platform that was used to send the message. - [Money](https://shopify.dev/docs/api/partner/2024-07/objects/Money.txt) - A monetary value with currency. - [MoneyInput](https://shopify.dev/docs/api/partner/2024-07/input-objects/MoneyInput.txt) - A monetary value with currency. - [appCreditCreate](https://shopify.dev/docs/api/partner/2024-07/mutations/appCreditCreate.txt) - Allows an app to create a credit for a shop that can be used towards future app purchases. This mutation is only available to Partner API clients that have been granted the `View financials` permission. - [OneTimeChargeAccepted](https://shopify.dev/docs/api/partner/2024-07/objects/OneTimeChargeAccepted.txt) - An event that marks that a one-time app charge was accepted by the merchant. - [OneTimeChargeActivated](https://shopify.dev/docs/api/partner/2024-07/objects/OneTimeChargeActivated.txt) - An event that marks that a one-time app charge was activated. - [OneTimeChargeDeclined](https://shopify.dev/docs/api/partner/2024-07/objects/OneTimeChargeDeclined.txt) - An event that marks that a one-time app charge was declined by the merchant. - [OneTimeChargeExpired](https://shopify.dev/docs/api/partner/2024-07/objects/OneTimeChargeExpired.txt) - An event that marks that a one-time app charge expired before the merchant could accept it. - [Organization](https://shopify.dev/docs/api/partner/2024-07/objects/Organization.txt) - A Partner organization. - [PageInfo](https://shopify.dev/docs/api/partner/2024-07/objects/PageInfo.txt) - Information about pagination in a connection. - [QueryRoot](https://shopify.dev/docs/api/partner/2024-07/objects/QueryRoot.txt) - The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. - [app](https://shopify.dev/docs/api/partner/2024-07/queries/app.txt) - A Shopify [app](/concepts/apps). - [conversation](https://shopify.dev/docs/api/partner/2024-07/queries/conversation.txt) - A conversation with a merchant through the Experts Marketplace. - [conversations](https://shopify.dev/docs/api/partner/2024-07/queries/conversations.txt) - A list of the Partner organization's conversations. - [job](https://shopify.dev/docs/api/partner/2024-07/queries/job.txt) - An [Experts Marketplace job](https://help.shopify.com/partners/selling-services). - [jobs](https://shopify.dev/docs/api/partner/2024-07/queries/jobs.txt) - A list of the Partner organization's [Experts Marketplace jobs](https://help.shopify.com/partners/selling-services). - [publicApiVersions](https://shopify.dev/docs/api/partner/2024-07/queries/publicApiVersions.txt) - The list of public Partner API versions, including supported, release candidate and unstable versions. - [transaction](https://shopify.dev/docs/api/partner/2024-07/queries/transaction.txt) - A Shopify Partner transaction. - [transactions](https://shopify.dev/docs/api/partner/2024-07/queries/transactions.txt) - A list of the Partner organization's [transactions](https://help.shopify.com/partners/getting-started/getting-paid). - [ReferralAdjustment](https://shopify.dev/docs/api/partner/2024-07/objects/ReferralAdjustment.txt) - A transaction corresponding to a shop referral adjustment. - [ReferralCategory](https://shopify.dev/docs/api/partner/2024-07/enums/ReferralCategory.txt) - The referral type. - [ReferralTransaction](https://shopify.dev/docs/api/partner/2024-07/objects/ReferralTransaction.txt) - A transaction corresponding to a shop referral. - [RelationshipDeactivated](https://shopify.dev/docs/api/partner/2024-07/objects/RelationshipDeactivated.txt) - An event that marks that an app was deactivated. - [RelationshipInstalled](https://shopify.dev/docs/api/partner/2024-07/objects/RelationshipInstalled.txt) - An event that marks that an app was installed. - [RelationshipReactivated](https://shopify.dev/docs/api/partner/2024-07/objects/RelationshipReactivated.txt) - An event that marks that an app was reactivated. - [RelationshipUninstalled](https://shopify.dev/docs/api/partner/2024-07/objects/RelationshipUninstalled.txt) - An event that marks that an app was uninstalled. - [Service](https://shopify.dev/docs/api/partner/2024-07/objects/Service.txt) - A service in the Experts Marketplace. - [ServiceSale](https://shopify.dev/docs/api/partner/2024-07/objects/ServiceSale.txt) - A transaction corresponding to a paid invoice for a service. - [ServiceSaleAdjustment](https://shopify.dev/docs/api/partner/2024-07/objects/ServiceSaleAdjustment.txt) - A transaction corresponding to a refund, downgrade, or adjustment of a service sale. - [Shop](https://shopify.dev/docs/api/partner/2024-07/objects/Shop.txt) - A Shopify shop. - [ShopifyEmployee](https://shopify.dev/docs/api/partner/2024-07/objects/ShopifyEmployee.txt) - A Shopify employee. - [String](https://shopify.dev/docs/api/partner/2024-07/scalars/String.txt) - Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. - [SubscriptionApproachingCappedAmount](https://shopify.dev/docs/api/partner/2024-07/objects/SubscriptionApproachingCappedAmount.txt) - An event that marks that a subscription is approaching its capped amount. - [SubscriptionCappedAmountUpdated](https://shopify.dev/docs/api/partner/2024-07/objects/SubscriptionCappedAmountUpdated.txt) - An event that marks that a subscription had its capped amount updated. - [SubscriptionChargeAccepted](https://shopify.dev/docs/api/partner/2024-07/objects/SubscriptionChargeAccepted.txt) - An event that marks that a recurring app charge was accepted. - [SubscriptionChargeActivated](https://shopify.dev/docs/api/partner/2024-07/objects/SubscriptionChargeActivated.txt) - An event that marks that a recurring app charge was activated. - [SubscriptionChargeCanceled](https://shopify.dev/docs/api/partner/2024-07/objects/SubscriptionChargeCanceled.txt) - An event that marks that a recurring app charge was cancelled. - [SubscriptionChargeDeclined](https://shopify.dev/docs/api/partner/2024-07/objects/SubscriptionChargeDeclined.txt) - An event that marks that a recurring app charge was declined. - [SubscriptionChargeExpired](https://shopify.dev/docs/api/partner/2024-07/objects/SubscriptionChargeExpired.txt) - An event that marks that a recurring app charge has expired. - [SubscriptionChargeFrozen](https://shopify.dev/docs/api/partner/2024-07/objects/SubscriptionChargeFrozen.txt) - An event that marks that a recurring app charge has been suspended. For example, if a merchant stops paying their bills, or closes their store, then Shopify suspends the recurring app charge. - [SubscriptionChargeUnfrozen](https://shopify.dev/docs/api/partner/2024-07/objects/SubscriptionChargeUnfrozen.txt) - An event that marks that a recurring app charge was unfrozen. - [TaxTransaction](https://shopify.dev/docs/api/partner/2024-07/objects/TaxTransaction.txt) - 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. - [TaxTransactionType](https://shopify.dev/docs/api/partner/2024-07/enums/TaxTransactionType.txt) - The tax model applied to the transaction, based on the transaction type. - [TeamMember](https://shopify.dev/docs/api/partner/2024-07/objects/TeamMember.txt) - An owner or staff member of the Partner Organization. - [Theme](https://shopify.dev/docs/api/partner/2024-07/objects/Theme.txt) - A Shopify [theme](/concepts/themes). - [ThemeSale](https://shopify.dev/docs/api/partner/2024-07/objects/ThemeSale.txt) - A transaction corresponding to a theme purchase. - [ThemeSaleAdjustment](https://shopify.dev/docs/api/partner/2024-07/objects/ThemeSaleAdjustment.txt) - A transaction corresponding to a refund, downgrade, or adjustment of a theme sale. - [Transaction](https://shopify.dev/docs/api/partner/2024-07/interfaces/Transaction.txt) - A Shopify Partner transaction. - [TransactionConnection](https://shopify.dev/docs/api/partner/2024-07/connections/TransactionConnection.txt) - The connection type for Transaction. - [TransactionType](https://shopify.dev/docs/api/partner/2024-07/enums/TransactionType.txt) - The type of transaction. - [Url](https://shopify.dev/docs/api/partner/2024-07/scalars/Url.txt) - A valid URL, transported as a string. - [UsageChargeApplied](https://shopify.dev/docs/api/partner/2024-07/objects/UsageChargeApplied.txt) - An event that marks that an app usage charge was applied. - [UserError](https://shopify.dev/docs/api/partner/2024-07/objects/UserError.txt) - Represents an error in a mutation. - [__Directive](https://shopify.dev/docs/api/partner/2024-07/objects/__Directive.txt) - A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor. - [__DirectiveLocation](https://shopify.dev/docs/api/partner/2024-07/enums/__DirectiveLocation.txt) - A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies. - [__EnumValue](https://shopify.dev/docs/api/partner/2024-07/objects/__EnumValue.txt) - One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string. - [__Field](https://shopify.dev/docs/api/partner/2024-07/objects/__Field.txt) - Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type. - [__InputValue](https://shopify.dev/docs/api/partner/2024-07/objects/__InputValue.txt) - Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value. - [__Schema](https://shopify.dev/docs/api/partner/2024-07/objects/__Schema.txt) - A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations. - [__Type](https://shopify.dev/docs/api/partner/2024-07/objects/__Type.txt) - The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types. - [__TypeKind](https://shopify.dev/docs/api/partner/2024-07/enums/__TypeKind.txt) - An enum describing what kind of type a given `__Type` is. ## **unstable** API Reference - [Actor](https://shopify.dev/docs/api/partner/unstable/interfaces/Actor.txt) - A Partner organization or shop. - [ApiVersion](https://shopify.dev/docs/api/partner/unstable/objects/ApiVersion.txt) - A version of the API. - [App](https://shopify.dev/docs/api/partner/unstable/objects/App.txt) - A Shopify [app](/concepts/apps). - [AppCharge](https://shopify.dev/docs/api/partner/unstable/interfaces/AppCharge.txt) - A [charge](/docs/admin-api/rest/reference/billing/applicationcharge) created through an app. - [AppCredit](https://shopify.dev/docs/api/partner/unstable/objects/AppCredit.txt) - A [credit](/docs/admin-api/rest/reference/billing/applicationcredit) 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. - [AppCreditCreatePayload](https://shopify.dev/docs/api/partner/unstable/payloads/AppCreditCreatePayload.txt) - The result of an appCreditCreate mutation. - [AppCreditEvent](https://shopify.dev/docs/api/partner/unstable/interfaces/AppCreditEvent.txt) - An event involving an app credit. - [AppEvent](https://shopify.dev/docs/api/partner/unstable/interfaces/AppEvent.txt) - An event related to a Shopify app. - [AppEventConnection](https://shopify.dev/docs/api/partner/unstable/connections/AppEventConnection.txt) - The connection type for AppEvent. - [AppEventTypes](https://shopify.dev/docs/api/partner/unstable/enums/AppEventTypes.txt) - The type of app event. - [AppOneTimeSale](https://shopify.dev/docs/api/partner/unstable/objects/AppOneTimeSale.txt) - A transaction corresponding to a one-time app charge. - [AppPricingInterval](https://shopify.dev/docs/api/partner/unstable/enums/AppPricingInterval.txt) - The billing frequency for the app. - [AppPurchaseOneTime](https://shopify.dev/docs/api/partner/unstable/objects/AppPurchaseOneTime.txt) - 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. - [AppPurchaseOneTimeEvent](https://shopify.dev/docs/api/partner/unstable/interfaces/AppPurchaseOneTimeEvent.txt) - An app event for a one-time app charge. - [AppSaleAdjustment](https://shopify.dev/docs/api/partner/unstable/objects/AppSaleAdjustment.txt) - A transaction corresponding to a refund, downgrade, or adjustment of an app charge. - [AppSaleCredit](https://shopify.dev/docs/api/partner/unstable/objects/AppSaleCredit.txt) - A transaction corresponding to an [app credit](/docs/admin-api/rest/reference/billing/applicationcredit). - [AppSubscription](https://shopify.dev/docs/api/partner/unstable/objects/AppSubscription.txt) - A recurring charge for use of an app, such as a monthly subscription charge. - [AppSubscriptionEvent](https://shopify.dev/docs/api/partner/unstable/interfaces/AppSubscriptionEvent.txt) - An event related to an [app subscription charge](/docs/admin-api/rest/reference/billing/recurringapplicationcharge). - [AppSubscriptionSale](https://shopify.dev/docs/api/partner/unstable/objects/AppSubscriptionSale.txt) - A transaction corresponding to an app subscription charge. - [AppUsageRecord](https://shopify.dev/docs/api/partner/unstable/objects/AppUsageRecord.txt) - An app charge. This charge varies based on how much the merchant uses the app or a service that the app integrates with. - [AppUsageRecordEvent](https://shopify.dev/docs/api/partner/unstable/interfaces/AppUsageRecordEvent.txt) - An app event for an app usage charge. - [AppUsageSale](https://shopify.dev/docs/api/partner/unstable/objects/AppUsageSale.txt) - A transaction corresponding to an app usage charge. - [Boolean](https://shopify.dev/docs/api/partner/unstable/scalars/Boolean.txt) - Represents `true` or `false` values. - [Conversation](https://shopify.dev/docs/api/partner/unstable/objects/Conversation.txt) - A conversation with a merchant through the Experts Marketplace. - [ConversationConnection](https://shopify.dev/docs/api/partner/unstable/connections/ConversationConnection.txt) - The connection type for Conversation. - [ConversationStatus](https://shopify.dev/docs/api/partner/unstable/enums/ConversationStatus.txt) - The status of the Experts Marketplace conversation. - [CreditApplied](https://shopify.dev/docs/api/partner/unstable/objects/CreditApplied.txt) - An event that marks that an app credit was applied. - [CreditFailed](https://shopify.dev/docs/api/partner/unstable/objects/CreditFailed.txt) - An event that marks that an app credit failed to apply. - [CreditPending](https://shopify.dev/docs/api/partner/unstable/objects/CreditPending.txt) - An event that marks that an app credit is pending. - [Currency](https://shopify.dev/docs/api/partner/unstable/enums/Currency.txt) - Supported monetary currencies from ISO 4217. - [DateTime](https://shopify.dev/docs/api/partner/unstable/scalars/DateTime.txt) - An [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) encoded UTC date time string. Example value: `"2019-07-03T20:47:55.123456Z"`. - [Decimal](https://shopify.dev/docs/api/partner/unstable/scalars/Decimal.txt) - A signed decimal number, which supports arbitrary precision and is serialized as a string. - [Eventsink](https://shopify.dev/docs/api/partner/unstable/objects/Eventsink.txt) - A sink for submitting customer events. - [EventsinkCreateInput](https://shopify.dev/docs/api/partner/unstable/input-objects/EventsinkCreateInput.txt) - Input for creating a new eventsink. - [EventsinkCreatePayload](https://shopify.dev/docs/api/partner/unstable/payloads/EventsinkCreatePayload.txt) - The result of an Eventsink creation. - [EventsinkDeletePayload](https://shopify.dev/docs/api/partner/unstable/payloads/EventsinkDeletePayload.txt) - The result of an Eventsink delete. - [EventsinkQueue](https://shopify.dev/docs/api/partner/unstable/objects/EventsinkQueue.txt) - An eventsink queue. - [EventsinkTopic](https://shopify.dev/docs/api/partner/unstable/enums/EventsinkTopic.txt) - The topic name of an Eventsink. - [ID](https://shopify.dev/docs/api/partner/unstable/scalars/ID.txt) - Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) input value will be accepted as an ID. - [Int](https://shopify.dev/docs/api/partner/unstable/scalars/Int.txt) - Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. - [Job](https://shopify.dev/docs/api/partner/unstable/objects/Job.txt) - An [Experts Marketplace job](https://help.shopify.com/partners/selling-services). - [JobConnection](https://shopify.dev/docs/api/partner/unstable/connections/JobConnection.txt) - The connection type for Job. - [JobRequirement](https://shopify.dev/docs/api/partner/unstable/objects/JobRequirement.txt) - Details that the merchant provided about their job requirements. Details are returned as sets of questions and responses. - [JobStatus](https://shopify.dev/docs/api/partner/unstable/enums/JobStatus.txt) - The status of the [Experts Marketplace job](https://help.shopify.com/partners/selling-services). - [LegacyTransaction](https://shopify.dev/docs/api/partner/unstable/objects/LegacyTransaction.txt) - A transaction of a type that is no longer supported. - [MerchantUser](https://shopify.dev/docs/api/partner/unstable/objects/MerchantUser.txt) - 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. - [Message](https://shopify.dev/docs/api/partner/unstable/objects/Message.txt) - A message exchanged within a conversation. - [MessageConnection](https://shopify.dev/docs/api/partner/unstable/connections/MessageConnection.txt) - The connection type for Message. - [MessageSender](https://shopify.dev/docs/api/partner/unstable/unions/MessageSender.txt) - A union of all of the types that can send messages within a conversation. - [MessageSentVia](https://shopify.dev/docs/api/partner/unstable/enums/MessageSentVia.txt) - The platform that was used to send the message. - [Money](https://shopify.dev/docs/api/partner/unstable/objects/Money.txt) - A monetary value with currency. - [MoneyInput](https://shopify.dev/docs/api/partner/unstable/input-objects/MoneyInput.txt) - A monetary value with currency. - [appCreditCreate](https://shopify.dev/docs/api/partner/unstable/mutations/appCreditCreate.txt) - Allows an app to create a credit for a shop that can be used towards future app purchases. This mutation is only available to Partner API clients that have been granted the `View financials` permission. - [eventsinkCreate](https://shopify.dev/docs/api/partner/unstable/mutations/eventsinkCreate.txt) - Creates a new Eventsink. - [eventsinkDelete](https://shopify.dev/docs/api/partner/unstable/mutations/eventsinkDelete.txt) - Deletes an Eventsink. - [OneTimeChargeAccepted](https://shopify.dev/docs/api/partner/unstable/objects/OneTimeChargeAccepted.txt) - An event that marks that a one-time app charge was accepted by the merchant. - [OneTimeChargeActivated](https://shopify.dev/docs/api/partner/unstable/objects/OneTimeChargeActivated.txt) - An event that marks that a one-time app charge was activated. - [OneTimeChargeDeclined](https://shopify.dev/docs/api/partner/unstable/objects/OneTimeChargeDeclined.txt) - An event that marks that a one-time app charge was declined by the merchant. - [OneTimeChargeExpired](https://shopify.dev/docs/api/partner/unstable/objects/OneTimeChargeExpired.txt) - An event that marks that a one-time app charge expired before the merchant could accept it. - [Organization](https://shopify.dev/docs/api/partner/unstable/objects/Organization.txt) - A Partner organization. - [PageInfo](https://shopify.dev/docs/api/partner/unstable/objects/PageInfo.txt) - Information about pagination in a connection. - [QueryRoot](https://shopify.dev/docs/api/partner/unstable/objects/QueryRoot.txt) - The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. - [app](https://shopify.dev/docs/api/partner/unstable/queries/app.txt) - A Shopify [app](/concepts/apps). - [conversation](https://shopify.dev/docs/api/partner/unstable/queries/conversation.txt) - A conversation with a merchant through the Experts Marketplace. - [conversations](https://shopify.dev/docs/api/partner/unstable/queries/conversations.txt) - A list of the Partner organization's conversations. - [eventsinks](https://shopify.dev/docs/api/partner/unstable/queries/eventsinks.txt) - A list of Eventsinks configured for the specified App ID. - [job](https://shopify.dev/docs/api/partner/unstable/queries/job.txt) - An [Experts Marketplace job](https://help.shopify.com/partners/selling-services). - [jobs](https://shopify.dev/docs/api/partner/unstable/queries/jobs.txt) - A list of the Partner organization's [Experts Marketplace jobs](https://help.shopify.com/partners/selling-services). - [publicApiVersions](https://shopify.dev/docs/api/partner/unstable/queries/publicApiVersions.txt) - The list of public Partner API versions, including supported, release candidate and unstable versions. - [transaction](https://shopify.dev/docs/api/partner/unstable/queries/transaction.txt) - A Shopify Partner transaction. - [transactions](https://shopify.dev/docs/api/partner/unstable/queries/transactions.txt) - A list of the Partner organization's [transactions](https://help.shopify.com/partners/getting-started/getting-paid). - [ReferralAdjustment](https://shopify.dev/docs/api/partner/unstable/objects/ReferralAdjustment.txt) - A transaction corresponding to a shop referral adjustment. - [ReferralCategory](https://shopify.dev/docs/api/partner/unstable/enums/ReferralCategory.txt) - The referral type. - [ReferralTransaction](https://shopify.dev/docs/api/partner/unstable/objects/ReferralTransaction.txt) - A transaction corresponding to a shop referral. - [RelationshipDeactivated](https://shopify.dev/docs/api/partner/unstable/objects/RelationshipDeactivated.txt) - An event that marks that an app was deactivated. - [RelationshipInstalled](https://shopify.dev/docs/api/partner/unstable/objects/RelationshipInstalled.txt) - An event that marks that an app was installed. - [RelationshipReactivated](https://shopify.dev/docs/api/partner/unstable/objects/RelationshipReactivated.txt) - An event that marks that an app was reactivated. - [RelationshipUninstalled](https://shopify.dev/docs/api/partner/unstable/objects/RelationshipUninstalled.txt) - An event that marks that an app was uninstalled. - [Service](https://shopify.dev/docs/api/partner/unstable/objects/Service.txt) - A service in the Experts Marketplace. - [ServiceSale](https://shopify.dev/docs/api/partner/unstable/objects/ServiceSale.txt) - A transaction corresponding to a paid invoice for a service. - [ServiceSaleAdjustment](https://shopify.dev/docs/api/partner/unstable/objects/ServiceSaleAdjustment.txt) - A transaction corresponding to a refund, downgrade, or adjustment of a service sale. - [Shop](https://shopify.dev/docs/api/partner/unstable/objects/Shop.txt) - A Shopify shop. - [ShopifyEmployee](https://shopify.dev/docs/api/partner/unstable/objects/ShopifyEmployee.txt) - A Shopify employee. - [String](https://shopify.dev/docs/api/partner/unstable/scalars/String.txt) - Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. - [SubscriptionApproachingCappedAmount](https://shopify.dev/docs/api/partner/unstable/objects/SubscriptionApproachingCappedAmount.txt) - An event that marks that a subscription is approaching its capped amount. - [SubscriptionCappedAmountUpdated](https://shopify.dev/docs/api/partner/unstable/objects/SubscriptionCappedAmountUpdated.txt) - An event that marks that a subscription had its capped amount updated. - [SubscriptionChargeAccepted](https://shopify.dev/docs/api/partner/unstable/objects/SubscriptionChargeAccepted.txt) - An event that marks that a recurring app charge was accepted. - [SubscriptionChargeActivated](https://shopify.dev/docs/api/partner/unstable/objects/SubscriptionChargeActivated.txt) - An event that marks that a recurring app charge was activated. - [SubscriptionChargeCanceled](https://shopify.dev/docs/api/partner/unstable/objects/SubscriptionChargeCanceled.txt) - An event that marks that a recurring app charge was cancelled. - [SubscriptionChargeDeclined](https://shopify.dev/docs/api/partner/unstable/objects/SubscriptionChargeDeclined.txt) - An event that marks that a recurring app charge was declined. - [SubscriptionChargeExpired](https://shopify.dev/docs/api/partner/unstable/objects/SubscriptionChargeExpired.txt) - An event that marks that a recurring app charge has expired. - [SubscriptionChargeFrozen](https://shopify.dev/docs/api/partner/unstable/objects/SubscriptionChargeFrozen.txt) - An event that marks that a recurring app charge has been suspended. For example, if a merchant stops paying their bills, or closes their store, then Shopify suspends the recurring app charge. - [SubscriptionChargeUnfrozen](https://shopify.dev/docs/api/partner/unstable/objects/SubscriptionChargeUnfrozen.txt) - An event that marks that a recurring app charge was unfrozen. - [TaxTransaction](https://shopify.dev/docs/api/partner/unstable/objects/TaxTransaction.txt) - 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. - [TaxTransactionType](https://shopify.dev/docs/api/partner/unstable/enums/TaxTransactionType.txt) - The tax model applied to the transaction, based on the transaction type. - [TeamMember](https://shopify.dev/docs/api/partner/unstable/objects/TeamMember.txt) - An owner or staff member of the Partner Organization. - [Theme](https://shopify.dev/docs/api/partner/unstable/objects/Theme.txt) - A Shopify [theme](/concepts/themes). - [ThemeSale](https://shopify.dev/docs/api/partner/unstable/objects/ThemeSale.txt) - A transaction corresponding to a theme purchase. - [ThemeSaleAdjustment](https://shopify.dev/docs/api/partner/unstable/objects/ThemeSaleAdjustment.txt) - A transaction corresponding to a refund, downgrade, or adjustment of a theme sale. - [Transaction](https://shopify.dev/docs/api/partner/unstable/interfaces/Transaction.txt) - A Shopify Partner transaction. - [TransactionConnection](https://shopify.dev/docs/api/partner/unstable/connections/TransactionConnection.txt) - The connection type for Transaction. - [TransactionType](https://shopify.dev/docs/api/partner/unstable/enums/TransactionType.txt) - The type of transaction. - [Url](https://shopify.dev/docs/api/partner/unstable/scalars/Url.txt) - A valid URL, transported as a string. - [UsageChargeApplied](https://shopify.dev/docs/api/partner/unstable/objects/UsageChargeApplied.txt) - An event that marks that an app usage charge was applied. - [UserError](https://shopify.dev/docs/api/partner/unstable/objects/UserError.txt) - Represents an error in a mutation. - [__Directive](https://shopify.dev/docs/api/partner/unstable/objects/__Directive.txt) - A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor. - [__DirectiveLocation](https://shopify.dev/docs/api/partner/unstable/enums/__DirectiveLocation.txt) - A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies. - [__EnumValue](https://shopify.dev/docs/api/partner/unstable/objects/__EnumValue.txt) - One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string. - [__Field](https://shopify.dev/docs/api/partner/unstable/objects/__Field.txt) - Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type. - [__InputValue](https://shopify.dev/docs/api/partner/unstable/objects/__InputValue.txt) - Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value. - [__Schema](https://shopify.dev/docs/api/partner/unstable/objects/__Schema.txt) - A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations. - [__Type](https://shopify.dev/docs/api/partner/unstable/objects/__Type.txt) - The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types. - [__TypeKind](https://shopify.dev/docs/api/partner/unstable/enums/__TypeKind.txt) - An enum describing what kind of type a given `__Type` is.