mobilePlatformApplicationCreate - admin-graphql - MUTATION

Version: 2025-01

Description:

Create a mobile platform application.

Access Scopes

`write_mobile_platform_applications` access scope. Please contact Shopify Support to enable this scope for your app.

Arguments

• input: MobilePlatformApplicationCreateInput! - The input to create a mobile platform application.

Returns

• mobilePlatformApplication: MobilePlatformApplication Created mobile platform application.
• userErrors: MobilePlatformApplicationUserError! The list of errors that occurred from executing the mutation.

Examples

• Create a mobile platform application

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation mobilePlatformApplicationCreate($input: MobilePlatformApplicationCreateInput!) { mobilePlatformApplicationCreate(input: $input) { mobilePlatformApplication { ... on AppleApplication { id appId universalLinksEnabled sharedWebCredentialsEnabled appClipsEnabled appClipApplicationId } } userErrors { field message } } }\",\n \"variables\": {\n    \"input\": {\n      \"apple\": {\n        \"appId\": \"com.apple.package\",\n        \"appClipsEnabled\": true,\n        \"appClipApplicationId\": \"clip.app\",\n        \"universalLinksEnabled\": false,\n        \"sharedWebCredentialsEnabled\": false\n      }\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation mobilePlatformApplicationCreate($input: MobilePlatformApplicationCreateInput!) {\n      mobilePlatformApplicationCreate(input: $input) {\n        mobilePlatformApplication {\n          ... on AppleApplication {\n            id\n            appId\n            universalLinksEnabled\n            sharedWebCredentialsEnabled\n            appClipsEnabled\n            appClipApplicationId\n          }\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"apple\": {\n          \"appId\": \"com.apple.package\",\n          \"appClipsEnabled\": true,\n          \"appClipApplicationId\": \"clip.app\",\n          \"universalLinksEnabled\": false,\n          \"sharedWebCredentialsEnabled\": false\n        }\n      }\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation mobilePlatformApplicationCreate($input: MobilePlatformApplicationCreateInput!) {\n    mobilePlatformApplicationCreate(input: $input) {\n      mobilePlatformApplication {\n        ... on AppleApplication {\n          id\n          appId\n          universalLinksEnabled\n          sharedWebCredentialsEnabled\n          appClipsEnabled\n          appClipApplicationId\n        }\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"apple\": {\n      \"appId\": \"com.apple.package\",\n      \"appClipsEnabled\": true,\n      \"appClipApplicationId\": \"clip.app\",\n      \"universalLinksEnabled\": false,\n      \"sharedWebCredentialsEnabled\": false\n    }\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation mobilePlatformApplicationCreate($input: MobilePlatformApplicationCreateInput!) {\n    mobilePlatformApplicationCreate(input: $input) {\n      mobilePlatformApplication {\n        ... on AppleApplication {\n          id\n          appId\n          universalLinksEnabled\n          sharedWebCredentialsEnabled\n          appClipsEnabled\n          appClipApplicationId\n        }\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"input\" => [\n    \"apple\" => [\n      \"appId\" => \"com.apple.package\",\n      \"appClipsEnabled\" => true,\n      \"appClipApplicationId\" => \"clip.app\",\n      \"universalLinksEnabled\" => false,\n      \"sharedWebCredentialsEnabled\" => false,\n    ],\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation mobilePlatformApplicationCreate($input: MobilePlatformApplicationCreateInput!) {\n    mobilePlatformApplicationCreate(input: $input) {\n      mobilePlatformApplication {\n        ... on AppleApplication {\n          id\n          appId\n          universalLinksEnabled\n          sharedWebCredentialsEnabled\n          appClipsEnabled\n          appClipApplicationId\n        }\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"apple\": {\n          \"appId\": \"com.apple.package\",\n          \"appClipsEnabled\": true,\n          \"appClipApplicationId\": \"clip.app\",\n          \"universalLinksEnabled\": false,\n          \"sharedWebCredentialsEnabled\": false\n        }\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation mobilePlatformApplicationCreate($input: MobilePlatformApplicationCreateInput!) {\n  mobilePlatformApplicationCreate(input: $input) {\n    mobilePlatformApplication {\n      ... on AppleApplication {\n        id\n        appId\n        universalLinksEnabled\n        sharedWebCredentialsEnabled\n        appClipsEnabled\n        appClipApplicationId\n      }\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "input": {
      "apple": {
        "appId": "com.apple.package",
        "appClipsEnabled": true,
        "appClipApplicationId": "clip.app",
        "universalLinksEnabled": false,
        "sharedWebCredentialsEnabled": false
      }
    }
  }

  response: {
    "data": {
      "mobilePlatformApplicationCreate": {
        "mobilePlatformApplication": {
          "id": "gid://shopify/MobilePlatformApplication/1066176023",
          "appId": "com.apple.package",
          "universalLinksEnabled": false,
          "sharedWebCredentialsEnabled": false,
          "appClipsEnabled": true,
          "appClipApplicationId": "clip.app"
        },
        "userErrors": []
      }
    }
  }

  Create an Android Mobile Platform Application

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation CreateMobilePlatformApplication($input: MobilePlatformApplicationCreateInput!) { mobilePlatformApplicationCreate(input: $input) { mobilePlatformApplication { ... on AndroidApplication { id applicationId sha256CertFingerprints appLinksEnabled __typename } } userErrors { field message code } } }\",\n \"variables\": {\n    \"input\": {\n      \"android\": {\n        \"applicationId\": \"com.android.package\",\n        \"appLinksEnabled\": true,\n        \"sha256CertFingerprints\": [\n          \"A1:B2:C3:D4\"\n        ]\n      }\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation CreateMobilePlatformApplication($input: MobilePlatformApplicationCreateInput!) {\n      mobilePlatformApplicationCreate(input: $input) {\n        mobilePlatformApplication {\n          ... on AndroidApplication {\n            id\n            applicationId\n            sha256CertFingerprints\n            appLinksEnabled\n            __typename\n          }\n        }\n        userErrors {\n          field\n          message\n          code\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"android\": {\n          \"applicationId\": \"com.android.package\",\n          \"appLinksEnabled\": true,\n          \"sha256CertFingerprints\": [\n            \"A1:B2:C3:D4\"\n          ]\n        }\n      }\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation CreateMobilePlatformApplication($input: MobilePlatformApplicationCreateInput!) {\n    mobilePlatformApplicationCreate(input: $input) {\n      mobilePlatformApplication {\n        ... on AndroidApplication {\n          id\n          applicationId\n          sha256CertFingerprints\n          appLinksEnabled\n          __typename\n        }\n      }\n      userErrors {\n        field\n        message\n        code\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"android\": {\n      \"applicationId\": \"com.android.package\",\n      \"appLinksEnabled\": true,\n      \"sha256CertFingerprints\": [\"A1:B2:C3:D4\"]\n    }\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation CreateMobilePlatformApplication($input: MobilePlatformApplicationCreateInput!) {\n    mobilePlatformApplicationCreate(input: $input) {\n      mobilePlatformApplication {\n        ... on AndroidApplication {\n          id\n          applicationId\n          sha256CertFingerprints\n          appLinksEnabled\n          __typename\n        }\n      }\n      userErrors {\n        field\n        message\n        code\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"input\" => [\n    \"android\" => [\n      \"applicationId\" => \"com.android.package\",\n      \"appLinksEnabled\" => true,\n      \"sha256CertFingerprints\" => [\"A1:B2:C3:D4\"],\n    ],\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation CreateMobilePlatformApplication($input: MobilePlatformApplicationCreateInput!) {\n    mobilePlatformApplicationCreate(input: $input) {\n      mobilePlatformApplication {\n        ... on AndroidApplication {\n          id\n          applicationId\n          sha256CertFingerprints\n          appLinksEnabled\n          __typename\n        }\n      }\n      userErrors {\n        field\n        message\n        code\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"android\": {\n          \"applicationId\": \"com.android.package\",\n          \"appLinksEnabled\": true,\n          \"sha256CertFingerprints\": [\n            \"A1:B2:C3:D4\"\n          ]\n        }\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation CreateMobilePlatformApplication($input: MobilePlatformApplicationCreateInput!) {\n  mobilePlatformApplicationCreate(input: $input) {\n    mobilePlatformApplication {\n      ... on AndroidApplication {\n        id\n        applicationId\n        sha256CertFingerprints\n        appLinksEnabled\n        __typename\n      }\n    }\n    userErrors {\n      field\n      message\n      code\n    }\n  }\n}"
        

  input: {
    "input": {
      "android": {
        "applicationId": "com.android.package",
        "appLinksEnabled": true,
        "sha256CertFingerprints": [
          "A1:B2:C3:D4"
        ]
      }
    }
  }

  response: {
    "data": {
      "mobilePlatformApplicationCreate": {
        "mobilePlatformApplication": {
          "id": "gid://shopify/MobilePlatformApplication/1066176024",
          "applicationId": "com.android.package",
          "sha256CertFingerprints": [
            "A1:B2:C3:D4"
          ],
          "appLinksEnabled": true,
          "__typename": "AndroidApplication"
        },
        "userErrors": []
      }
    }
  }

  Create an Apple Mobile Platform Application

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation CreateMobilePlatformApplication($input: MobilePlatformApplicationCreateInput!) { mobilePlatformApplicationCreate(input: $input) { mobilePlatformApplication { ... on AppleApplication { id appId universalLinksEnabled sharedWebCredentialsEnabled appClipsEnabled appClipApplicationId __typename } } userErrors { field message code } } }\",\n \"variables\": {\n    \"input\": {\n      \"apple\": {\n        \"appId\": \"com.apple.package\",\n        \"appClipsEnabled\": true,\n        \"appClipApplicationId\": \"clip.app\",\n        \"universalLinksEnabled\": false,\n        \"sharedWebCredentialsEnabled\": false\n      }\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation CreateMobilePlatformApplication($input: MobilePlatformApplicationCreateInput!) {\n      mobilePlatformApplicationCreate(input: $input) {\n        mobilePlatformApplication {\n          ... on AppleApplication {\n            id\n            appId\n            universalLinksEnabled\n            sharedWebCredentialsEnabled\n            appClipsEnabled\n            appClipApplicationId\n            __typename\n          }\n        }\n        userErrors {\n          field\n          message\n          code\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"apple\": {\n          \"appId\": \"com.apple.package\",\n          \"appClipsEnabled\": true,\n          \"appClipApplicationId\": \"clip.app\",\n          \"universalLinksEnabled\": false,\n          \"sharedWebCredentialsEnabled\": false\n        }\n      }\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation CreateMobilePlatformApplication($input: MobilePlatformApplicationCreateInput!) {\n    mobilePlatformApplicationCreate(input: $input) {\n      mobilePlatformApplication {\n        ... on AppleApplication {\n          id\n          appId\n          universalLinksEnabled\n          sharedWebCredentialsEnabled\n          appClipsEnabled\n          appClipApplicationId\n          __typename\n        }\n      }\n      userErrors {\n        field\n        message\n        code\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"apple\": {\n      \"appId\": \"com.apple.package\",\n      \"appClipsEnabled\": true,\n      \"appClipApplicationId\": \"clip.app\",\n      \"universalLinksEnabled\": false,\n      \"sharedWebCredentialsEnabled\": false\n    }\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation CreateMobilePlatformApplication($input: MobilePlatformApplicationCreateInput!) {\n    mobilePlatformApplicationCreate(input: $input) {\n      mobilePlatformApplication {\n        ... on AppleApplication {\n          id\n          appId\n          universalLinksEnabled\n          sharedWebCredentialsEnabled\n          appClipsEnabled\n          appClipApplicationId\n          __typename\n        }\n      }\n      userErrors {\n        field\n        message\n        code\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"input\" => [\n    \"apple\" => [\n      \"appId\" => \"com.apple.package\",\n      \"appClipsEnabled\" => true,\n      \"appClipApplicationId\" => \"clip.app\",\n      \"universalLinksEnabled\" => false,\n      \"sharedWebCredentialsEnabled\" => false,\n    ],\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation CreateMobilePlatformApplication($input: MobilePlatformApplicationCreateInput!) {\n    mobilePlatformApplicationCreate(input: $input) {\n      mobilePlatformApplication {\n        ... on AppleApplication {\n          id\n          appId\n          universalLinksEnabled\n          sharedWebCredentialsEnabled\n          appClipsEnabled\n          appClipApplicationId\n          __typename\n        }\n      }\n      userErrors {\n        field\n        message\n        code\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"apple\": {\n          \"appId\": \"com.apple.package\",\n          \"appClipsEnabled\": true,\n          \"appClipApplicationId\": \"clip.app\",\n          \"universalLinksEnabled\": false,\n          \"sharedWebCredentialsEnabled\": false\n        }\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation CreateMobilePlatformApplication($input: MobilePlatformApplicationCreateInput!) {\n  mobilePlatformApplicationCreate(input: $input) {\n    mobilePlatformApplication {\n      ... on AppleApplication {\n        id\n        appId\n        universalLinksEnabled\n        sharedWebCredentialsEnabled\n        appClipsEnabled\n        appClipApplicationId\n        __typename\n      }\n    }\n    userErrors {\n      field\n      message\n      code\n    }\n  }\n}"
        

  input: {
    "input": {
      "apple": {
        "appId": "com.apple.package",
        "appClipsEnabled": true,
        "appClipApplicationId": "clip.app",
        "universalLinksEnabled": false,
        "sharedWebCredentialsEnabled": false
      }
    }
  }

  response: {
    "data": {
      "mobilePlatformApplicationCreate": {
        "mobilePlatformApplication": {
          "id": "gid://shopify/MobilePlatformApplication/1066176022",
          "appId": "com.apple.package",
          "universalLinksEnabled": false,
          "sharedWebCredentialsEnabled": false,
          "appClipsEnabled": true,
          "appClipApplicationId": "clip.app",
          "__typename": "AppleApplication"
        },
        "userErrors": []
      }
    }
  }