Finish a Shopify install

POST/v1/api/store/{team_slug}/setting/external_integration/shopify/finalize-install

v1InternalOperation ID v1_public_external_integration_shopify_finalize_install

Internal

Built for YoPrint's own apps, not for integrations. It is listed so the reference is complete; don't build on it, and use the other operations in this section.

Built for YoPrint's web app. After a store owner installs YoPrint from the Shopify admin and picks this team, it turns the pending install (install_token) into the team's Shopify integration. Returns the integration.

Permission

Needs the Manage Settings permission. The team owner always has it.

Side effects

• Connects the Shopify store to the team.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Request body

application/json, required.

• install_tokenstringrequired

  The pending install's token, from the install flow.

Response

200Successful response.

• dataobjectrequired
  Child fields (17)

  • deprecatedbooleanrequired

    A retired integration: it can only be deleted.

  • has_logsbooleanrequired

    Whether it keeps a log of sync errors: true for QuickBooks Online only.

  • idstringrequired
  • labelstringrequired
  • statusstringrequired

    For example ENABLED, ACTION_REQUIRED, REAUTH (sign in to the provider again), UNINITIALIZED (set up but not configured yet) or DISABLED.

  • subtypestringrequired

    Which integration, for example sanmar_v1. The same value goes in the create path.

  • trashedbooleanrequired
  • typestringrequired

    The kind: supplier, sms (Twilio), shipment_v1 (GoShippo), data_sync (QuickBooks Online, Shopify), payment_gateway (Square), shipment (retired FedEx and UPS).

    • One of: "supplier", "sms", "shipment_v1", "data_sync", "payment_gateway", "shipment"
  • dataobject | array | null
  • integration_check_keystring

    A fixed key for the kind of integration, such as sanmar or shopify.

  • last_syncstring (date-time) | null
  • last_token_refreshstring (date-time) | null
  • optionobject | array | null

    The integration's settings, which differ by type.

  • shopify_admin_app_urlstring | null

    Shopify only.

  • shopify_admin_settings_apps_urlstring | null

    Shopify only: the store's apps settings page, where the app is uninstalled.

  • shopify_admin_urlstring | null

    Shopify only: the YoPrint app in the store's Shopify admin. Same as shopify_admin_app_url.

  • shopify_compliance_deletionobject | null

    Shopify only: where a store data deletion requested by Shopify stands, or null.

• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

  When

  Your role lacks Manage Settings. The body is {"message": "Insufficient Permission"}, without the error envelope.

  Fix

  Use the key of a member whose role has Manage Settings, or the owner's.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

• 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  install_token is missing (validation_failed).

  Fix

  Send the token from the install flow.

  When

  The install can't be finished: error.code pending_install_not_found, pending_install_expired or pending_install_not_ready.

  Fix

  Start the install again from the Shopify admin.

  When

  plan_limitation (Shopify is not in your plan), shopify_store_limit_reached, shopify_store_deletion_in_progress, or shopify_store_already_connected_other_team.

  Fix

  Read error.message; upgrade the plan, wait, or disconnect the store from the other team first.

Notes

• AI apps (MCP connections) can't call this operation: they get 403 agent_operation_not_available. Use a personal API key.

Related

• POSTCheck a Shopify install signature/v1/api/store/{team_slug}/setting/external_integration/shopify/verify-signature
• GETList integrations/v1/api/store/{team_slug}/setting/external_integration

Example request

curl

curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/setting/external_integration/shopify/finalize-install' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "install_token": "YOUR_INSTALL_TOKEN"  }'

Example response 200

Response

{
  "data": {
    "data": {
      "currencyCode": "USD",
      "domain": "example.myshopify.com",
      "gid": "gid://shopify/Shop/1001",
      "id": "gid://shopify/Shop/1001",
      "myshopifyDomain": "example.myshopify.com",
      "name": "Northwind Apparel",
      "shop_domain": "example.myshopify.com",
      "shop_url": "example.myshopify.com",
      "url": "https://example.myshopify.com"
    },
    "deprecated": false,
    "has_logs": false,
    "id": "aDFOUrmqetFJaN",
    "integration_check_key": "shopify",
    "label": "Shopify",
    "last_sync": null,
    "last_token_refresh": "2026-11-03T09:00:00+00:00",
    "option": [],
    "shopify_admin_app_url": "https://example.com/shopify-admin/apps/yoprint",
    "shopify_admin_settings_apps_url": "https://example.com/shopify-admin/settings/apps",
    "shopify_admin_url": "https://example.com/shopify-admin/apps/yoprint",
    "shopify_compliance_deletion": null,
    "status": "UNINITIALIZED",
    "subtype": "shopify_v1",
    "trashed": false,
    "type": "data_sync"
  },
  "status": 200,
  "success": true
}