MobilePlatformApplication

Version 2019-04

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. 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.

What you can do with MobilePlatformApplication

The Shopify API lets you do the following with the MobilePlatformApplication resource. More detailed versions of these general actions may be available:

MobilePlatformApplication properties

id
"id": 915396206

Unique numeric identifier for the mobile platform application.

application_id
"application_id": "A1B2C3D4.com.domainname.applicationname"

iOS App ID or Android application ID of the application.

platform
"platform": "ios"

The platform of the application.

sha256_cert_fingerprints
"sha256_cert_fingerprints": [
  "50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42"
]

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

enabled_shared_webcredentials
"enabled_shared_webcredential": true

Whether the application supports iOS shared web credentials.

Endpoints

GET /admin/api/2019-04/mobile_platform_applications.json
List the mobile platform applications

List all of the mobile platform applications for the app

GET /admin/api/2019-04/mobile_platform_applications.json
View Response
HTTP/1.1 200 OK
{
  "mobile_platform_applications": [
    {
      "id": 1066176012,
      "application_id": "X1Y2.ca.domain.app",
      "platform": "ios",
      "created_at": "2019-10-16T16:00:39-04:00",
      "updated_at": "2019-10-16T16:00:39-04:00",
      "sha256_cert_fingerprints": [],
      "enabled_universal_or_app_links": true,
      "enabled_shared_webcredentials": true
    },
    {
      "id": 1066176013,
      "application_id": "com.example",
      "platform": "android",
      "created_at": "2019-10-16T16:00:39-04:00",
      "updated_at": "2019-10-16T16:00:39-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
    }
  ]
}
POST /admin/api/2019-04/mobile_platform_applications.json
Create a mobile platform application

Create mobile platform application for iOS

POST /admin/api/2019-04/mobile_platform_applications.json
{
  "mobile_platform_application": {
    "platform": "ios",
    "application_id": "X1Y2.ca.domain.app",
    "enabled_universal_or_app_links": true,
    "enabled_shared_webcredentials": true
  }
}
View Response
HTTP/1.1 201 Created
{
  "mobile_platform_application": {
    "id": 1066176014,
    "application_id": "X1Y2.ca.domain.app",
    "platform": "ios",
    "created_at": "2019-10-16T16:00:40-04:00",
    "updated_at": "2019-10-16T16:00:40-04:00",
    "sha256_cert_fingerprints": [],
    "enabled_universal_or_app_links": true,
    "enabled_shared_webcredentials": true
  }
}

Create a mobile platform application for Android

POST /admin/api/2019-04/mobile_platform_applications.json
{
  "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
  }
}
View Response
HTTP/1.1 201 Created
{
  "mobile_platform_application": {
    "id": 1066176015,
    "application_id": "com.example",
    "platform": "android",
    "created_at": "2019-10-16T16:00:40-04:00",
    "updated_at": "2019-10-16T16:00:40-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
  }
}
GET /admin/api/2019-04/mobile_platform_applications/#{mobile_platform_application_id}.json
Get a mobile platform application

Get a mobile platform application

GET /admin/api/2019-04/mobile_platform_applications/#{mobile_platform_application_id}.json
View Response
HTTP/1.1 200 OK
{
  "mobile_platform_application": {
    "id": 1066176016,
    "application_id": "X1Y2.ca.domain.app",
    "platform": "ios",
    "created_at": "2019-10-16T16:00:40-04:00",
    "updated_at": "2019-10-16T16:00:40-04:00",
    "sha256_cert_fingerprints": [],
    "enabled_universal_or_app_links": true,
    "enabled_shared_webcredentials": true
  }
}
PUT /admin/api/2019-04/mobile_platform_applications/#{mobile_platform_application_id}.json
Update a mobile platform application

Update a Mobile Platform Application for iOS

PUT /admin/api/2019-04/mobile_platform_applications/#{mobile_platform_application_id}.json
{
  "mobile_platform_application": {
    "id": 1066176017,
    "application_id": "A1B2.ca.domain.app",
    "platform": "ios",
    "created_at": "2019-10-16T16:00:41-04:00",
    "updated_at": "2019-10-16T16:00:41-04:00",
    "sha256_cert_fingerprints": [],
    "enabled_universal_or_app_links": true,
    "enabled_shared_webcredentials": true
  }
}
View Response
HTTP/1.1 200 OK
{
  "mobile_platform_application": {
    "id": 1066176017,
    "application_id": "A1B2.ca.domain.app",
    "platform": "ios",
    "created_at": "2019-10-16T16:00:41-04:00",
    "updated_at": "2019-10-16T16:00:42-04:00",
    "sha256_cert_fingerprints": [],
    "enabled_universal_or_app_links": true,
    "enabled_shared_webcredentials": true
  }
}

Update a Mobile Platform Application for Android

PUT /admin/api/2019-04/mobile_platform_applications/#{mobile_platform_application_id}.json
{
  "mobile_platform_application": {
    "id": 1066176018,
    "application_id": "com.example.news.app",
    "platform": "android",
    "created_at": "2019-10-16T16:00:42-04:00",
    "updated_at": "2019-10-16T16:00:42-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
  }
}
View Response
HTTP/1.1 200 OK
{
  "mobile_platform_application": {
    "id": 1066176018,
    "application_id": "com.example.news.app",
    "platform": "android",
    "created_at": "2019-10-16T16:00:42-04:00",
    "updated_at": "2019-10-16T16:00:43-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
  }
}
DELETE /admin/api/2019-04/mobile_platform_applications/#{mobile_platform_application_id}.json
Delete a mobile platform application

Delete a mobile platform application

DELETE /admin/api/2019-04/mobile_platform_applications/#{mobile_platform_application_id}.json
View Response
HTTP/1.1 200 OK
{
}
Version 2019-07

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. 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.

What you can do with MobilePlatformApplication

The Shopify API lets you do the following with the MobilePlatformApplication resource. More detailed versions of these general actions may be available:

MobilePlatformApplication properties

id
"id": 915396206

Unique numeric identifier for the mobile platform application.

application_id
"application_id": "A1B2C3D4.com.domainname.applicationname"

iOS App ID or Android application ID of the application.

platform
"platform": "ios"

The platform of the application.

sha256_cert_fingerprints
"sha256_cert_fingerprints": [
  "50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42"
]

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

enabled_shared_webcredentials
"enabled_shared_webcredential": true

Whether the application supports iOS shared web credentials.

Endpoints

GET /admin/api/2019-07/mobile_platform_applications.json
List the mobile platform applications

List all of the mobile platform applications for the app

GET /admin/api/2019-07/mobile_platform_applications.json
View Response
HTTP/1.1 200 OK
{
  "mobile_platform_applications": [
    {
      "id": 1066176012,
      "application_id": "X1Y2.ca.domain.app",
      "platform": "ios",
      "created_at": "2019-10-16T16:00:39-04:00",
      "updated_at": "2019-10-16T16:00:39-04:00",
      "sha256_cert_fingerprints": [],
      "enabled_universal_or_app_links": true,
      "enabled_shared_webcredentials": true
    },
    {
      "id": 1066176013,
      "application_id": "com.example",
      "platform": "android",
      "created_at": "2019-10-16T16:00:39-04:00",
      "updated_at": "2019-10-16T16:00:39-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
    }
  ]
}
POST /admin/api/2019-07/mobile_platform_applications.json
Create a mobile platform application

Create mobile platform application for iOS

POST /admin/api/2019-07/mobile_platform_applications.json
{
  "mobile_platform_application": {
    "platform": "ios",
    "application_id": "X1Y2.ca.domain.app",
    "enabled_universal_or_app_links": true,
    "enabled_shared_webcredentials": true
  }
}
View Response
HTTP/1.1 201 Created
{
  "mobile_platform_application": {
    "id": 1066176014,
    "application_id": "X1Y2.ca.domain.app",
    "platform": "ios",
    "created_at": "2019-10-16T16:00:40-04:00",
    "updated_at": "2019-10-16T16:00:40-04:00",
    "sha256_cert_fingerprints": [],
    "enabled_universal_or_app_links": true,
    "enabled_shared_webcredentials": true
  }
}

Create a mobile platform application for Android

POST /admin/api/2019-07/mobile_platform_applications.json
{
  "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
  }
}
View Response
HTTP/1.1 201 Created
{
  "mobile_platform_application": {
    "id": 1066176015,
    "application_id": "com.example",
    "platform": "android",
    "created_at": "2019-10-16T16:00:40-04:00",
    "updated_at": "2019-10-16T16:00:40-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
  }
}
GET /admin/api/2019-07/mobile_platform_applications/#{mobile_platform_application_id}.json
Get a mobile platform application

Get a mobile platform application

GET /admin/api/2019-07/mobile_platform_applications/#{mobile_platform_application_id}.json
View Response
HTTP/1.1 200 OK
{
  "mobile_platform_application": {
    "id": 1066176016,
    "application_id": "X1Y2.ca.domain.app",
    "platform": "ios",
    "created_at": "2019-10-16T16:00:40-04:00",
    "updated_at": "2019-10-16T16:00:40-04:00",
    "sha256_cert_fingerprints": [],
    "enabled_universal_or_app_links": true,
    "enabled_shared_webcredentials": true
  }
}
PUT /admin/api/2019-07/mobile_platform_applications/#{mobile_platform_application_id}.json
Update a mobile platform application

Update a Mobile Platform Application for iOS

PUT /admin/api/2019-07/mobile_platform_applications/#{mobile_platform_application_id}.json
{
  "mobile_platform_application": {
    "id": 1066176017,
    "application_id": "A1B2.ca.domain.app",
    "platform": "ios",
    "created_at": "2019-10-16T16:00:41-04:00",
    "updated_at": "2019-10-16T16:00:41-04:00",
    "sha256_cert_fingerprints": [],
    "enabled_universal_or_app_links": true,
    "enabled_shared_webcredentials": true
  }
}
View Response
HTTP/1.1 200 OK
{
  "mobile_platform_application": {
    "id": 1066176017,
    "application_id": "A1B2.ca.domain.app",
    "platform": "ios",
    "created_at": "2019-10-16T16:00:41-04:00",
    "updated_at": "2019-10-16T16:00:42-04:00",
    "sha256_cert_fingerprints": [],
    "enabled_universal_or_app_links": true,
    "enabled_shared_webcredentials": true
  }
}

Update a Mobile Platform Application for Android

PUT /admin/api/2019-07/mobile_platform_applications/#{mobile_platform_application_id}.json
{
  "mobile_platform_application": {
    "id": 1066176018,
    "application_id": "com.example.news.app",
    "platform": "android",
    "created_at": "2019-10-16T16:00:42-04:00",
    "updated_at": "2019-10-16T16:00:42-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
  }
}
View Response
HTTP/1.1 200 OK
{
  "mobile_platform_application": {
    "id": 1066176018,
    "application_id": "com.example.news.app",
    "platform": "android",
    "created_at": "2019-10-16T16:00:42-04:00",
    "updated_at": "2019-10-16T16:00:43-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
  }
}
DELETE /admin/api/2019-07/mobile_platform_applications/#{mobile_platform_application_id}.json
Delete a mobile platform application

Delete a mobile platform application

DELETE /admin/api/2019-07/mobile_platform_applications/#{mobile_platform_application_id}.json
View Response
HTTP/1.1 200 OK
{
}
Version 2019-10 (Latest)

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. 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.

What you can do with MobilePlatformApplication

The Shopify API lets you do the following with the MobilePlatformApplication resource. More detailed versions of these general actions may be available:

MobilePlatformApplication properties

id
"id": 915396206

Unique numeric identifier for the mobile platform application.

application_id
"application_id": "A1B2C3D4.com.domainname.applicationname"

iOS App ID or Android application ID of the application.

platform
"platform": "ios"

The platform of the application.

sha256_cert_fingerprints
"sha256_cert_fingerprints": [
  "50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42"
]

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

enabled_shared_webcredentials
"enabled_shared_webcredential": true

Whether the application supports iOS shared web credentials.

Endpoints

GET /admin/api/2019-10/mobile_platform_applications.json
List the mobile platform applications

List all of the mobile platform applications for the app

GET /admin/api/2019-10/mobile_platform_applications.json
View Response
HTTP/1.1 200 OK
{
  "mobile_platform_applications": [
    {
      "id": 1066176012,
      "application_id": "X1Y2.ca.domain.app",
      "platform": "ios",
      "created_at": "2019-10-16T16:00:39-04:00",
      "updated_at": "2019-10-16T16:00:39-04:00",
      "sha256_cert_fingerprints": [],
      "enabled_universal_or_app_links": true,
      "enabled_shared_webcredentials": true
    },
    {
      "id": 1066176013,
      "application_id": "com.example",
      "platform": "android",
      "created_at": "2019-10-16T16:00:39-04:00",
      "updated_at": "2019-10-16T16:00:39-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
    }
  ]
}
POST /admin/api/2019-10/mobile_platform_applications.json
Create a mobile platform application

Create mobile platform application for iOS

POST /admin/api/2019-10/mobile_platform_applications.json
{
  "mobile_platform_application": {
    "platform": "ios",
    "application_id": "X1Y2.ca.domain.app",
    "enabled_universal_or_app_links": true,
    "enabled_shared_webcredentials": true
  }
}
View Response
HTTP/1.1 201 Created
{
  "mobile_platform_application": {
    "id": 1066176014,
    "application_id": "X1Y2.ca.domain.app",
    "platform": "ios",
    "created_at": "2019-10-16T16:00:40-04:00",
    "updated_at": "2019-10-16T16:00:40-04:00",
    "sha256_cert_fingerprints": [],
    "enabled_universal_or_app_links": true,
    "enabled_shared_webcredentials": true
  }
}

Create a mobile platform application for Android

POST /admin/api/2019-10/mobile_platform_applications.json
{
  "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
  }
}
View Response
HTTP/1.1 201 Created
{
  "mobile_platform_application": {
    "id": 1066176015,
    "application_id": "com.example",
    "platform": "android",
    "created_at": "2019-10-16T16:00:40-04:00",
    "updated_at": "2019-10-16T16:00:40-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
  }
}
GET /admin/api/2019-10/mobile_platform_applications/#{mobile_platform_application_id}.json
Get a mobile platform application

Get a mobile platform application

GET /admin/api/2019-10/mobile_platform_applications/#{mobile_platform_application_id}.json
View Response
HTTP/1.1 200 OK
{
  "mobile_platform_application": {
    "id": 1066176016,
    "application_id": "X1Y2.ca.domain.app",
    "platform": "ios",
    "created_at": "2019-10-16T16:00:40-04:00",
    "updated_at": "2019-10-16T16:00:40-04:00",
    "sha256_cert_fingerprints": [],
    "enabled_universal_or_app_links": true,
    "enabled_shared_webcredentials": true
  }
}
PUT /admin/api/2019-10/mobile_platform_applications/#{mobile_platform_application_id}.json
Update a mobile platform application

Update a Mobile Platform Application for iOS

PUT /admin/api/2019-10/mobile_platform_applications/#{mobile_platform_application_id}.json
{
  "mobile_platform_application": {
    "id": 1066176017,
    "application_id": "A1B2.ca.domain.app",
    "platform": "ios",
    "created_at": "2019-10-16T16:00:41-04:00",
    "updated_at": "2019-10-16T16:00:41-04:00",
    "sha256_cert_fingerprints": [],
    "enabled_universal_or_app_links": true,
    "enabled_shared_webcredentials": true
  }
}
View Response
HTTP/1.1 200 OK
{
  "mobile_platform_application": {
    "id": 1066176017,
    "application_id": "A1B2.ca.domain.app",
    "platform": "ios",
    "created_at": "2019-10-16T16:00:41-04:00",
    "updated_at": "2019-10-16T16:00:42-04:00",
    "sha256_cert_fingerprints": [],
    "enabled_universal_or_app_links": true,
    "enabled_shared_webcredentials": true
  }
}

Update a Mobile Platform Application for Android

PUT /admin/api/2019-10/mobile_platform_applications/#{mobile_platform_application_id}.json
{
  "mobile_platform_application": {
    "id": 1066176018,
    "application_id": "com.example.news.app",
    "platform": "android",
    "created_at": "2019-10-16T16:00:42-04:00",
    "updated_at": "2019-10-16T16:00:42-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
  }
}
View Response
HTTP/1.1 200 OK
{
  "mobile_platform_application": {
    "id": 1066176018,
    "application_id": "com.example.news.app",
    "platform": "android",
    "created_at": "2019-10-16T16:00:42-04:00",
    "updated_at": "2019-10-16T16:00:43-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
  }
}
DELETE /admin/api/2019-10/mobile_platform_applications/#{mobile_platform_application_id}.json
Delete a mobile platform application

Delete a mobile platform application

DELETE /admin/api/2019-10/mobile_platform_applications/#{mobile_platform_application_id}.json
View Response
HTTP/1.1 200 OK
{
}
Version 2020-01 (Release candidate)

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. 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.

What you can do with MobilePlatformApplication

The Shopify API lets you do the following with the MobilePlatformApplication resource. More detailed versions of these general actions may be available:

MobilePlatformApplication properties

id
"id": 915396206

Unique numeric identifier for the mobile platform application.

application_id
"application_id": "A1B2C3D4.com.domainname.applicationname"

iOS App ID or Android application ID of the application.

platform
"platform": "ios"

The platform of the application.

sha256_cert_fingerprints
"sha256_cert_fingerprints": [
  "50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42"
]

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

enabled_shared_webcredentials
"enabled_shared_webcredential": true

Whether the application supports iOS shared web credentials.

Endpoints

GET /admin/api/2020-01/mobile_platform_applications.json
List the mobile platform applications

List all of the mobile platform applications for the app

GET /admin/api/2020-01/mobile_platform_applications.json
View Response
HTTP/1.1 200 OK
{
  "mobile_platform_applications": [
    {
      "id": 1066176012,
      "application_id": "X1Y2.ca.domain.app",
      "platform": "ios",
      "created_at": "2019-10-16T16:00:39-04:00",
      "updated_at": "2019-10-16T16:00:39-04:00",
      "sha256_cert_fingerprints": [],
      "enabled_universal_or_app_links": true,
      "enabled_shared_webcredentials": true
    },
    {
      "id": 1066176013,
      "application_id": "com.example",
      "platform": "android",
      "created_at": "2019-10-16T16:00:39-04:00",
      "updated_at": "2019-10-16T16:00:39-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
    }
  ]
}
POST /admin/api/2020-01/mobile_platform_applications.json
Create a mobile platform application

Create mobile platform application for iOS

POST /admin/api/2020-01/mobile_platform_applications.json
{
  "mobile_platform_application": {
    "platform": "ios",
    "application_id": "X1Y2.ca.domain.app",
    "enabled_universal_or_app_links": true,
    "enabled_shared_webcredentials": true
  }
}
View Response
HTTP/1.1 201 Created
{
  "mobile_platform_application": {
    "id": 1066176014,
    "application_id": "X1Y2.ca.domain.app",
    "platform": "ios",
    "created_at": "2019-10-16T16:00:40-04:00",
    "updated_at": "2019-10-16T16:00:40-04:00",
    "sha256_cert_fingerprints": [],
    "enabled_universal_or_app_links": true,
    "enabled_shared_webcredentials": true
  }
}

Create a mobile platform application for Android

POST /admin/api/2020-01/mobile_platform_applications.json
{
  "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
  }
}
View Response
HTTP/1.1 201 Created
{
  "mobile_platform_application": {
    "id": 1066176015,
    "application_id": "com.example",
    "platform": "android",
    "created_at": "2019-10-16T16:00:40-04:00",
    "updated_at": "2019-10-16T16:00:40-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
  }
}
GET /admin/api/2020-01/mobile_platform_applications/#{mobile_platform_application_id}.json
Get a mobile platform application

Get a mobile platform application

GET /admin/api/2020-01/mobile_platform_applications/#{mobile_platform_application_id}.json
View Response
HTTP/1.1 200 OK
{
  "mobile_platform_application": {
    "id": 1066176016,
    "application_id": "X1Y2.ca.domain.app",
    "platform": "ios",
    "created_at": "2019-10-16T16:00:40-04:00",
    "updated_at": "2019-10-16T16:00:40-04:00",
    "sha256_cert_fingerprints": [],
    "enabled_universal_or_app_links": true,
    "enabled_shared_webcredentials": true
  }
}
PUT /admin/api/2020-01/mobile_platform_applications/#{mobile_platform_application_id}.json
Update a mobile platform application

Update a Mobile Platform Application for iOS

PUT /admin/api/2020-01/mobile_platform_applications/#{mobile_platform_application_id}.json
{
  "mobile_platform_application": {
    "id": 1066176017,
    "application_id": "A1B2.ca.domain.app",
    "platform": "ios",
    "created_at": "2019-10-16T16:00:41-04:00",
    "updated_at": "2019-10-16T16:00:41-04:00",
    "sha256_cert_fingerprints": [],
    "enabled_universal_or_app_links": true,
    "enabled_shared_webcredentials": true
  }
}
View Response
HTTP/1.1 200 OK
{
  "mobile_platform_application": {
    "id": 1066176017,
    "application_id": "A1B2.ca.domain.app",
    "platform": "ios",
    "created_at": "2019-10-16T16:00:41-04:00",
    "updated_at": "2019-10-16T16:00:42-04:00",
    "sha256_cert_fingerprints": [],
    "enabled_universal_or_app_links": true,
    "enabled_shared_webcredentials": true
  }
}

Update a Mobile Platform Application for Android

PUT /admin/api/2020-01/mobile_platform_applications/#{mobile_platform_application_id}.json
{
  "mobile_platform_application": {
    "id": 1066176018,
    "application_id": "com.example.news.app",
    "platform": "android",
    "created_at": "2019-10-16T16:00:42-04:00",
    "updated_at": "2019-10-16T16:00:42-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
  }
}
View Response
HTTP/1.1 200 OK
{
  "mobile_platform_application": {
    "id": 1066176018,
    "application_id": "com.example.news.app",
    "platform": "android",
    "created_at": "2019-10-16T16:00:42-04:00",
    "updated_at": "2019-10-16T16:00:43-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
  }
}
DELETE /admin/api/2020-01/mobile_platform_applications/#{mobile_platform_application_id}.json
Delete a mobile platform application

Delete a mobile platform application

DELETE /admin/api/2020-01/mobile_platform_applications/#{mobile_platform_application_id}.json
View Response
HTTP/1.1 200 OK
{
}

Sign up for a Partner account to get started.

Sign up