Skip to content
YoPrintDevelopers

Restore a removed Shopify store

Open .md

PATCH/v1/api/store/{team_slug}/setting/external_integration/{id}/restore

v1Operation ID v1_public_external_integration_restore

Brings back a removed Shopify store connection and turns it on again. Only Shopify can be restored; every other type answers 422 invalid_public_action. The {id} is the integration's id from the list. Find removed ones with "Search integrations" and trashed_only. Returns the restored integration.

Permission

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

Path parameters

  • team_slugstringrequired

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

    • Example your-team
  • idstringrequired

    The removed Shopify integration, from "Search integrations" with trashed_only. Its hash id from an earlier answer; there is no unique key for it.

    • Example aDFOUrmqetFJaN

Request body

This operation takes no request body.

Response

200Successful response.

  • dataobjectrequired

    As "Get an integration" returns it. No stored credential is in it: supplier passwords, Twilio's Account SID and auth token, the GoShippo sign-in and AS Colour's API key are never returned.

    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.

    When
    No integration of your team, removed or not, has this id. error.code is null; error.message names the record type.
    Fix
    Use an id from "Search integrations".

  • 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
    The integration is not Shopify: error.code invalid_public_action.
    Fix
    Connect it again instead.
    When
    The Shopify store isn't removed: error.code restore_fail.
    Fix
    Nothing to restore.
    When
    The integration is not in your plan (plan_limitation).
    Fix
    Upgrade the plan, or use another integration.
    When
    The integration is retired (integration_deprecated).
    Fix
    Delete it and connect an alternative.

Notes

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

AI agents: read /llms.txt; add .md to any page URL for its Markdown. Guides and concepts in one file: /llms-full.txt.

Download the OpenAPI specSupport: support@yoprint.comyoprint.com