Skip to main content

The REST Admin API is a legacy API as of October 1, 2024. Starting April 1, 2025, all new public apps must be built exclusively with the GraphQL Admin API. For details and migration steps, visit our migration guide.

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

The MobilePlatformApplication resource

Anchor to

Properties


id
->
id

Unique numeric identifier for the mobile platform application.


application_id

iOS App ID or Android application ID of the application.


platform

The platform of the application.


sha256_cert_fingerprints

The SHA256 fingerprints of the app’s signing certificate. (Android only)


enabled_universal_or_app_links

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

Whether the application supports iOS shared web credentials.


enabled_app_clips

Whether the application supports iOS app clips.


app_clip_application_id

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 POST request, Create a mobile platform application
post
Create a mobile platform application

Create a mobile platform application

Anchor to Parameters of Create a mobile platform applicationParameters


api_version
string
required

Was this section helpful?

Anchor to post-mobile-platform-applications-examplesExamples

Create a mobile platform application for Android

Request body
mobile_platform_application
Mobile_platform_application resource
Show mobile_platform_application properties
mobile_platform_application.platform:"android"

The platform of the application.

mobile_platform_application.application_id:"com.example"

iOS App ID or Android application ID of the application.

mobile_platform_application.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"]

The SHA256 fingerprints of the app’s signing certificate. (Android only)

mobile_platform_application.enabled_universal_or_app_links:true

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.

Create mobile platform application for iOS

Request body
mobile_platform_application
Mobile_platform_application resource
Show mobile_platform_application properties
mobile_platform_application.platform:"ios"

The platform of the application.

mobile_platform_application.application_id:"X1Y2.ca.domain.app"

iOS App ID or Android application ID of the application.

mobile_platform_application.enabled_universal_or_app_links:true

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.

mobile_platform_application.enabled_shared_webcredentials:true

Whether the application supports iOS shared web credentials.

Was this section helpful?
post

/admin/api/2025-07/mobile_platform_applications.json

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/2025-07/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": 1066176000,
"application_id": "com.example",
"platform": "android",
"created_at": "2025-07-01T14:45:21-04:00",
"updated_at": "2025-07-01T14:45:21-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 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

List the mobile platform applications


api_version
string
required

Was this section helpful?

List all of the mobile platform applications for the app

Was this section helpful?
get

/admin/api/2025-07/mobile_platform_applications.json

curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/mobile_platform_applications.json" \
-H "X-Shopify-Access-Token: {access_token}"

{}

Response

JSON
HTTP/1.1 200 OK
{
"mobile_platform_applications": [
{
"id": 1066175998,
"application_id": "X1Y2.ca.domain.app",
"platform": "ios",
"created_at": "2025-07-01T14:45:19-04:00",
"updated_at": "2025-07-01T14:45:19-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": 1066175999,
"application_id": "com.example",
"platform": "android",
"created_at": "2025-07-01T14:45:19-04:00",
"updated_at": "2025-07-01T14:45:19-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
}
]
}

Get a mobile platform application


api_version
string
required

mobile_platform_application_id
string
required

Was this section helpful?

Get a mobile platform application

Path parameters
mobile_platform_application_id=1066175997
string
required
Was this section helpful?
get

/admin/api/2025-07/mobile_platform_applications/1066175997.json

curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/mobile_platform_applications/1066175997.json" \
-H "X-Shopify-Access-Token: {access_token}"

{}

Response

JSON
HTTP/1.1 200 OK
{
"mobile_platform_application": {
"id": 1066175997,
"application_id": "X1Y2.ca.domain.app",
"platform": "ios",
"created_at": "2025-07-01T14:45:19-04:00",
"updated_at": "2025-07-01T14:45:19-04:00",
"sha256_cert_fingerprints": [],
"enabled_universal_or_app_links": true,
"enabled_shared_webcredentials": true,
"enabled_app_clips": false,
"app_clip_application_id": null
}
}

Update a mobile platform application


api_version
string
required

mobile_platform_application_id
string
required

Was this section helpful?

Update a Mobile Platform Application for Android

Path parameters
mobile_platform_application_id=1066176001
string
required
Request body
mobile_platform_application
Mobile_platform_application resource
Show mobile_platform_application properties
mobile_platform_application.id:1066176001

Unique numeric identifier for the mobile platform application.

mobile_platform_application.application_id:"com.example.news.app"

iOS App ID or Android application ID of the application.

mobile_platform_application.platform:"android"

The platform of the application.

mobile_platform_application.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"]

The SHA256 fingerprints of the app’s signing certificate. (Android only)

mobile_platform_application.enabled_universal_or_app_links:true

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.

mobile_platform_application.enabled_shared_webcredentials:false

Whether the application supports iOS shared web credentials.

mobile_platform_application.enabled_app_clips:false

Whether the application supports iOS app clips.

mobile_platform_application.app_clip_application_id:null

iOS App ID of the app clip.

Update a Mobile Platform Application for iOS

Path parameters
mobile_platform_application_id=1066176003
string
required
Request body
mobile_platform_application
Mobile_platform_application resource
Show mobile_platform_application properties
mobile_platform_application.id:1066176003

Unique numeric identifier for the mobile platform application.

mobile_platform_application.application_id:"A1B2.ca.domain.app"

iOS App ID or Android application ID of the application.

mobile_platform_application.platform:"ios"

The platform of the application.

mobile_platform_application.sha256_cert_fingerprints:[]

The SHA256 fingerprints of the app’s signing certificate. (Android only)

mobile_platform_application.enabled_universal_or_app_links:true

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.

mobile_platform_application.enabled_shared_webcredentials:true

Whether the application supports iOS shared web credentials.

mobile_platform_application.enabled_app_clips:false

Whether the application supports iOS app clips.

mobile_platform_application.app_clip_application_id:null

iOS App ID of the app clip.

Was this section helpful?
put

/admin/api/2025-07/mobile_platform_applications/1066176001.json

curl -d '{"mobile_platform_application":{"id":1066176001,"application_id":"com.example.news.app","platform":"android","created_at":"2025-07-01T14:45:21-04:00","updated_at":"2025-07-01T14:45:21-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/2025-07/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": "2025-07-01T14:45:21-04:00",
"updated_at": "2025-07-01T14:45:22-04:00",
"enabled_app_clips": false,
"app_clip_application_id": null
}
}

Delete a mobile platform application


api_version
string
required

mobile_platform_application_id
string
required

Was this section helpful?

Delete a mobile platform application

Path parameters
mobile_platform_application_id=1066175996
string
required
Was this section helpful?
del

/admin/api/2025-07/mobile_platform_applications/1066175996.json

curl -X DELETE "https://your-development-store.myshopify.com/admin/api/2025-07/mobile_platform_applications/1066175996.json" \
-H "X-Shopify-Access-Token: {access_token}"

{}

Response

JSON
HTTP/1.1 200 OK
{}