appRevenueAttributionRecordCreate mutation

Creates a record of the attributed revenue for the app.

Required access

User must have applications permission.

On this page

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

mutation appRevenueAttributionRecordCreate($appRevenueAttributionRecord: AppRevenueAttributionRecordInput!) { appRevenueAttributionRecordCreate(appRevenueAttributionRecord: $appRevenueAttributionRecord) { 
  1. <font style="color:#1F61A0;">appRevenueAttributionRecord</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">cursor</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">code</font>
  11.   <font style="color:#1F61A0;">field</font>
  13.   <font style="color:#1F61A0;">message</font>
  15. <font style="color:#555555;">}</font>
} } { “appRevenueAttributionRecord”: { 
  1. <font style="color:#8B2BB9;">"idempotencyKey"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font><font style="color:#555555;">,</font>
  3. <font style="color:#8B2BB9;">"capturedOn"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font><font style="color:#555555;">,</font>
  5. <font style="color:#8B2BB9;">"amount"</font><font style="color:#555555;">:</font> <font style="color:#555555;">{</font>
  7.   <font style="color:#8B2BB9;">"amount"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font><font style="color:#555555;">,</font>
  9.   <font style="color:#8B2BB9;">"currencyCode"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font>
  11. <font style="color:#555555;">},</font>
  13. <font style="color:#8B2BB9;">"type"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font><font style="color:#555555;">,</font>
  15. <font style="color:#8B2BB9;">"test"</font><font style="color:#555555;">:</font> <font style="color:#D47509;">true</font>
} }

Arguments

Argument Description
appRevenueAttributionRecord
(
[AppRevenueAttributionRecordInput!](https://shopify.dev/docs/admin-api/graphql/reference/billing/apprevenueattributionrecordinput)

) REQUIRED		 The app revenue attribution record to be created.

AppRevenueAttributionRecordInput fields

  • amount ([MoneyInput!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyinput)) REQUIRED
    The financial amount captured in this attribution.
  • capturedOn ([Date!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#date-unstable)) REQUIRED
    The date the financial amount was captured.
  • idempotencyKey ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-unstable)) REQUIRED
    The unique value submitted during creation.
  • test ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-unstable)) REQUIRED
    Indicates whether this is a test submission.
  • type ([AppRevenueAttributionType!](https://shopify.dev/docs/admin-api/graphql/reference/billing/apprevenueattributiontype)) REQUIRED
    The type of revenue attribution.

Return fields

  • appRevenueAttributionRecord ([AppRevenueAttributionRecord](https://shopify.dev/docs/admin-api/graphql/reference/billing/apprevenueattributionrecord))
    The created app revenue attribution record.
  • userErrors ([[AppRevenueAttributionRecordCreateUserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/billing/apprevenueattributionrecordcreateusererror))
    List of errors that occurred executing the mutation.