The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.

Anchor to section titled 'undefined'

MobilePlatformApplication

Requires mobile_platform_applications access scope.

Note

Please contact Shopify Support to enable this scope for your app

You can use the MobilePlatformApplication resource to enable shared web credentials for Shopify iOS apps, as well as to create iOS universal link or Android app link verification endpoints for merchant Shopify iOS or Android apps. Shared web credentials let iOS users access a native app after logging into the respective website in Safari without re-entering their username and password. If a user changes their credentials in the app, then those changes are reflected in Safari. You must use a custom domain to integrate shared web credentials with Shopify. With each platform's link system, users can tap a link to a shop's website and get seamlessly redirected to a merchant's installed app without going through a browser or manually selecting an app.

For full configuration instructions on iOS shared web credentials, see the associated domains setup technical documentation.

For full configuration instructions on iOS universal links or Android App Links, see the respective iOS universal link or Android app link technical documentation.

Was this section helpful?
Anchor to section titled 'The MobilePlatformApplication resource'

The MobilePlatformApplication resource

Properties
id
->id
Unique numeric identifier for the mobile platform application.
application_id
->appId
iOS App ID or Android application ID of the application.
platform
->apple
The platform of the application.
sha256_cert_fingerprints
->sha256CertFingerprints
The SHA256 fingerprints of the app’s signing certificate. (Android only)
enabled_universal_or_app_links
->universalLinksEnabled
Whether the application supports iOS universal links and Android App Links. If true, then URLs can be set up to link directly to the application. If false, then URLs can't link directly to the application.
enabled_shared_webcredentials
->sharedWebCredentialsEnabled
Whether the application supports iOS shared web credentials.
enabled_app_clips
->appClipsEnabled
Whether the application supports iOS app clips.
app_clip_application_id
->appClipApplicationId
iOS App ID of the app clip.
Was this section helpful?
{}The MobilePlatformApplication resource
{
  "id": 915396206,
  "application_id": "A1B2C3D4.com.domainname.applicationname",
  "platform": "ios",
  "sha256_cert_fingerprints": [
    "50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42"
  ],
  "enabled_universal_or_app_links": true,
  "enabled_shared_webcredentials": {
    "enabled_shared_webcredential": true
  },
  "enabled_app_clips": {
    "app_clips_enabled": true
  },
  "app_clip_application_id": "A1B2C3D4.com.domainname.applicationname"
}
Anchor to section titled 'POST request, Create a mobile platform application'

post
Create a mobile platform application

mobilePlatformApplicationCreate
Create a mobile platform application
Anchor to section titled 'Parameters of Create a mobile platform application'

Parameters

api_version
string
required
Was this section helpful?
Anchor to section titled 'Examples of Create a mobile platform application'

Examples

Request body
mobileplatformapplication
Mobile_platform_application resource
Was this section helpful?
post
/admin/api/2024-10/mobile_platform_applications.json
Copy
curl -d '{"mobile_platform_application":{"platform":"android","application_id":"com.example","sha256_cert_fingerprints":["14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5"],"enabled_universal_or_app_links":true}}' \
-X POST "https://your-development-store.myshopify.com/admin/api/2024-10/mobile_platform_applications.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"
{}Response
JSON
HTTP/1.1 201 Created
{
  "mobile_platform_application": {
    "id": 1066175996,
    "application_id": "com.example",
    "platform": "android",
    "created_at": "2024-09-23T17:30:49-04:00",
    "updated_at": "2024-09-23T17:30:49-04:00",
    "sha256_cert_fingerprints": [
      "14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5"
    ],
    "enabled_universal_or_app_links": true,
    "enabled_shared_webcredentials": false,
    "enabled_app_clips": false,
    "app_clip_application_id": null
  }
}
Anchor to section titled 'GET request, List all of the mobile platform applications associated with the app'

get
List all of the mobile platform applications associated with the app

mobilePlatformApplications
List the mobile platform applications
Anchor to section titled 'Parameters of List all of the mobile platform applications associated with the app'

Parameters

api_version
string
required
Was this section helpful?
Anchor to section titled 'Examples of List all of the mobile platform applications associated with the app'

Examples

Was this section helpful?
get
/admin/api/2024-10/mobile_platform_applications.json
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/mobile_platform_applications.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}Response
JSON
HTTP/1.1 200 OK
{
  "mobile_platform_applications": [
    {
      "id": 1066175999,
      "application_id": "X1Y2.ca.domain.app",
      "platform": "ios",
      "created_at": "2024-09-23T17:30:52-04:00",
      "updated_at": "2024-09-23T17:30:52-04:00",
      "sha256_cert_fingerprints": [],
      "enabled_universal_or_app_links": true,
      "enabled_shared_webcredentials": true,
      "enabled_app_clips": false,
      "app_clip_application_id": null
    },
    {
      "id": 1066176000,
      "application_id": "com.example",
      "platform": "android",
      "created_at": "2024-09-23T17:30:52-04:00",
      "updated_at": "2024-09-23T17:30:52-04:00",
      "sha256_cert_fingerprints": [
        "14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5"
      ],
      "enabled_universal_or_app_links": true,
      "enabled_shared_webcredentials": false,
      "enabled_app_clips": false,
      "app_clip_application_id": null
    }
  ]
}
Anchor to section titled 'GET request, Get a mobile platform application'

get
Get a mobile platform application

mobilePlatformApplication
Get a mobile platform application
Anchor to section titled 'Parameters of Get a mobile platform application'

Parameters

api_version
string
required
mobile_platform_application_id
string
required
Was this section helpful?
Anchor to section titled 'Examples of Get a mobile platform application'

Examples

Path parameters
mobileplatformapplicationid=1066176002
string
required
Was this section helpful?
get
/admin/api/2024-10/mobile_platform_applications/1066176002.json
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/mobile_platform_applications/1066176002.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}Response
JSON
HTTP/1.1 200 OK
{
  "mobile_platform_application": {
    "id": 1066176002,
    "application_id": "X1Y2.ca.domain.app",
    "platform": "ios",
    "created_at": "2024-09-23T17:30:54-04:00",
    "updated_at": "2024-09-23T17:30:54-04:00",
    "sha256_cert_fingerprints": [],
    "enabled_universal_or_app_links": true,
    "enabled_shared_webcredentials": true,
    "enabled_app_clips": false,
    "app_clip_application_id": null
  }
}
Anchor to section titled 'PUT request, Update a mobile platform application'

put
Update a mobile platform application

mobilePlatformApplicationUpdate
Update a mobile platform application
Anchor to section titled 'Parameters of Update a mobile platform application'

Parameters

api_version
string
required
mobile_platform_application_id
string
required
Was this section helpful?
Anchor to section titled 'Examples of Update a mobile platform application'

Examples

Path parameters
mobileplatformapplicationid=1066176001
string
required
Request body
mobileplatformapplication
Mobile_platform_application resource
Was this section helpful?
put
/admin/api/2024-10/mobile_platform_applications/1066176001.json
Copy
curl -d '{"mobile_platform_application":{"id":1066176001,"application_id":"com.example.news.app","platform":"android","created_at":"2024-09-23T17:30:53-04:00","updated_at":"2024-09-23T17:30:53-04:00","sha256_cert_fingerprints":["14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5"],"enabled_universal_or_app_links":true,"enabled_shared_webcredentials":false,"enabled_app_clips":false,"app_clip_application_id":null}}' \
-X PUT "https://your-development-store.myshopify.com/admin/api/2024-10/mobile_platform_applications/1066176001.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"
{}Response
JSON
HTTP/1.1 200 OK
{
  "mobile_platform_application": {
    "application_id": "com.example.news.app",
    "platform": "android",
    "sha256_cert_fingerprints": [
      "14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5"
    ],
    "enabled_universal_or_app_links": true,
    "enabled_shared_webcredentials": false,
    "id": 1066176001,
    "created_at": "2024-09-23T17:30:53-04:00",
    "updated_at": "2024-09-23T17:30:54-04:00",
    "enabled_app_clips": false,
    "app_clip_application_id": null
  }
}
Anchor to section titled 'DELETE request, Delete a mobile platform application'

del
Delete a mobile platform application

mobilePlatformApplicationDelete
Delete a mobile platform application
Anchor to section titled 'Parameters of Delete a mobile platform application'

Parameters

api_version
string
required
mobile_platform_application_id
string
required
Was this section helpful?
Anchor to section titled 'Examples of Delete a mobile platform application'

Examples

Path parameters
mobileplatformapplicationid=1066175998
string
required
Was this section helpful?
del
/admin/api/2024-10/mobile_platform_applications/1066175998.json
Copy
curl -X DELETE "https://your-development-store.myshopify.com/admin/api/2024-10/mobile_platform_applications/1066175998.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}Response
JSON
HTTP/1.1 200 OK
{}