Skip to content

Request a Shopify install link

Request

Request a Shopify install link for the account of the currently authenticated Dash user.

Security
bearerToken
Bodyapplication/jsonrequired
shopifyDomainstringrequired

The Shopify domain to request an install link for

Example:"example.myshopify.com"
curl -i -X POST \
  https://api-v2.dash.app/shopify-installs \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "shopifyDomain": "example.myshopify.com"
  }'

Responses

Success

Bodyapplication/json
resultobjectrequired

A derived view of the current Shopify install state for a Shopify domain.

permittedActionsArray of objectsrequired
Response
{
  "result": {
    "shopifyDomain": "example.myshopify.com",
    "status": "READY_TO_INSTALL",
    "installLink": "https://admin.shopify.com/store/example/oauth/install_custom_app"
  },
  "permittedActions": [
    { … }
  ]
}