Skip to content
YoPrintDevelopers

Download a Shopify customer data export

Open .md

GET/v1/api/store/{team_slug}/setting/compliance/shopify-data-request/{id}/download

v1InternalOperation ID v1_public_compliance_shopify_data_request_download

Built for YoPrint's web app: it downloads the file YoPrint prepared for a Shopify customer data request, a ZIP of what YoPrint holds about that customer. The {id} identifies the data request.

Through this API it always answers 403. The download is for the team owner, and it looks for the owner's web sign-in, which an API key doesn't carry. So even the owner's key gets 403 "Only the team owner can access this compliance export." Download the file as the owner in the YoPrint web app.

Permission

Meant for the team owner only, but no API key passes the owner check (see the description). It is a GET, so the Manage Settings check on its route doesn't apply.

Path parameters

  • team_slugstringrequired

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

    • Example your-team
  • idstringrequired

    The Shopify data request. Its hash id from an earlier answer; there is no unique key for it.

    • Example PwbV3hrunm1NZ8

Request body

This operation takes no request body.

Response

200Binary download response.

The answer is a file (application/octet-stream), not JSON. The example saves it with curl -o.

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
    Every call with an API key whose data request belongs to your team. The body is {"message": "Only the team owner can access this compliance export."}, without the error envelope.
    Fix
    Download it as the owner in the YoPrint web app.
    When
    The data request belongs to another team. The body is {"message": "You do not have permission to access this compliance export."}, without the error envelope.
    Fix
    Use your own team's data request.

  • 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 data request has this id. error.code is null.
    Fix
    Use the data request's id.

Notes

  • AI apps (MCP connections) can't call it either: they get 403 agent_operation_not_available.

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