> ## Documentation Index > Fetch the complete documentation index at: https://developers.phrase.com/llms.txt > Use this file to discover all available pages before exploring further. # Download content as XLIFF synchronously > Download the translatable content of one Shopify resource as XLIFF 2.0, ready for translation. `path` must be a `RESOURCE` path. Omit `sourceLocale` to read the shop's primary language. HTML fields (e.g. `body_html`) keep their markup as protected inline codes; plain text fields (title, handle, SEO fields) are plain units. Fields of other types (JSON, lists, links, ...) are left out of the XLIFF and keep their source value in Shopify. Pair with `upload-xliff-file` once translated. ## OpenAPI ````yaml /openapi/phrase-connectors.json post /shopify/v1/sync/download-xliff-file openapi: 3.1.0 info: title: Connectors API description: > The Connectors API (Bifrost) is the public gateway between Phrase clients and the individual content connectors (Google Drive, Contentful, Tridion, Knak, Shopify, Optimizely, ...). Every endpoint follows the same request/response contract — this page documents the shared pieces. Per-connector pages below show the connector-specific request bodies. --- ## Gateway prefix When calling Bifrost through the public Phrase gateway, **prefix every path with `/connectors`**: ``` https:///connectors//v1/ ``` Internal callers (service-to-service inside the Phrase cluster) call Bifrost directly and omit the `/connectors` prefix. The OpenAPI paths below show the *internal* form. --- ## Authentication All endpoints require an IDM-issued JWT in the `Authorization` header: ``` Authorization: Bearer ``` Bifrost decodes the token, resolves the caller's TMS account via IDM Discovery, and exchanges the JWT for a short-lived TMS access token transparently. Callers do not handle TMS tokens directly. --- ## Connector identity & credentials Every request body carries a **`connectorUuid`** that references a connector instance configured in TMS. Bifrost loads the connector's stored credentials and uses them to talk to the underlying system — callers never handle connector credentials directly. New connectors are created in TMS — e.g. for Google Drive: `https:///tms/connectors/create?connectorType=GOOGLE_DRIVE2`. --- ## Synchronous vs asynchronous variants Most operations expose two variants: | Path prefix | Behavior | |---|---| | `/sync/...` | Blocks until the operation completes. Best for small payloads / interactive flows. | | `/async/...` | Returns immediately with `{ requestId, webHookUrl }`. Bifrost POSTs the result to `X-Webhook` when ready, or you can poll. Use for large payloads and long-running work. | For async endpoints, the `X-Webhook` header is **required** — Bifrost will POST the result there once the connector finishes processing. --- ## Common headers | Header | Direction | Purpose | |---|---|---| | `Authorization` | request | `Bearer ` — required on every endpoint. | | `X-ActionId` | request + response | Correlation id propagated through Phrase logs. Generated by Bifrost when omitted; always returned on the response. | | `X-Webhook` | request | Required on `/async/...` endpoints. URL that receives the result. | | `X-ResponseType` | request | `ID` (default) — JSON with `storageId`. `OBJECT` — raw binary stream (`application/octet-stream`). Use `ID` for files > 1 MB. | | `X-Upload-Mode` | request | `STORAGE` (default) — upload bytes already in file storage. `STREAM` — initialize a streaming upload session; the response carries `uploadUrl` + `X-Stream-Token` for the phase-2 PUT. Currently supported by Google Drive only. | | `X-Stream-Token` | request | Required on phase-2 streaming upload PUTs. Value returned by phase-1. | --- ## Raw vs XLIFF operations Most connectors expose two content shapes: - **Raw** (`download-raw-file`, `upload-raw-file`) — the connector's native content, unmodified. Use when you want the original asset. - **XLIFF** (`download-xliff-file`, `upload-xliff-file`) — the same content converted to/from XLIFF 2.0 ready for translation. The connector applies its segmentation and serialization rules. `convert-to-xliff` / `convert-to-raw` are the standalone conversion variants that operate on already-stored files referenced by `storageId`. --- ## Error model Errors come back in two envelopes depending on the endpoint: - **Operations that report partial success** (upload, convert) return `200 OK` with: ```json { "success": false, "errors": [{ "code": "404", "message": "Content was not found." }] } ``` - **Hard failures** return a 4xx/5xx with an `ErrorResponse` body. HTTP status maps to the Bifrost error taxonomy: | Status | Error type | Typical cause | |---|---|---| | 401, 403 | `auth_error` | Missing/invalid JWT, IDM identity unresolved, connector credential rejected upstream. | | 429 | `rate_limited` | Caller or upstream rate limit hit. | | 400 | `processing_error` | Bad request body, validation failure, unsupported configuration. | | 4xx (other) | `processing_error` | Connector returned a client error. | | 5xx | `upstream_error` | Connector or downstream Phrase service failed. | | timeout | `timeout` | Upstream did not respond in time. | | deserialization | `deserialization` | Connector returned a malformed response. | | other | `unknown` | Unclassified. | `X-ActionId` is returned on every error response — quote it when reporting issues. --- ## Streaming uploads (two-phase) For connectors that support `X-Upload-Mode: STREAM` (currently Google Drive): 1. **Phase 1** — `POST //v1/sync/upload-raw-file` with `X-Upload-Mode: STREAM` and a body that includes `name`, `size`, and a `FOLDER` path. The response is: ```json { "uploadUrl": "//v1/sync/upload-raw-file/stream/", "streamToken": "", "expiresAt": "2026-01-29T13:48:01Z", "maxBytes": 240113628 } ``` `uploadUrl` is relative — prepend the gateway host (and `/connectors` prefix when calling through the public gateway). 2. **Phase 2** — `PUT ` with the raw bytes, `X-Stream-Token: `, and a `Content-Type` matching the file. `Content-Length` must equal the declared `size`. Streams expire at `expiresAt`. Large transfers may need increased client-side timeouts. version: '1.0' servers: - url: https://eu.phrase.com/connectors description: The API server for EU data center. - url: https://us.phrase.com/connectors description: The API server for US data center. security: - bearerAuth: [] tags: - name: Files description: Upload and download files via Phrase file storage. - name: GitHub description: GitHub connector. Supports raw download/upload and batch uploads. - name: Braze description: Braze multilingual content connector. - name: Contentful description: >- Contentful headless CMS connector. Supports raw and XLIFF download/upload, listing entries, and standalone XLIFF conversion. Requires a `connectorUuid` and a `configuration` block on every request. - name: Google Drive description: >- Google Drive connector. Supports raw download/upload (JSON `storageId` or streamed binary via `X-ResponseType: OBJECT`) plus the two-phase streaming upload (`X-Upload-Mode: STREAM` → `X-Stream-Token`). - name: Connectors description: >- Cross-connector discovery and metadata: list available connector types, retrieve schemas, and inspect supported operations. - name: Tridion Docs description: SDL Tridion CMS connector. - name: GitHub description: Perform operations using the GitHub connector. - name: Optimizely description: Optimizely CMS / experimentation connector. - name: Knak description: >- Knak connector. Supports listing translation requests plus raw download/upload. - name: Document360 description: >- Document360 knowledge-base connector. Lists projects, workspaces, categories and articles; downloads and uploads one article in one language; converts articles to and from XLIFF. Requests carry a connection reference (`connectionUid` + `organizationUid`), never an API key or URL. - name: Shopify description: >- Shopify connector. Supports listing resource types and resources (with per-target-locale translation coverage), raw download/upload, and XLIFF download/upload/conversion (one resource per XLIFF). Requests reference a connection (`connectionUid` + `organizationUid`); the store comes from it. externalDocs: description: Tutorial-style integration guides (Phrase Confluence, INT space) url: https://phrase.atlassian.net/wiki/spaces/INT paths: /shopify/v1/sync/download-xliff-file: post: tags: - Shopify summary: Download content as XLIFF synchronously description: > Download the translatable content of one Shopify resource as XLIFF 2.0, ready for translation. `path` must be a `RESOURCE` path. Omit `sourceLocale` to read the shop's primary language. HTML fields (e.g. `body_html`) keep their markup as protected inline codes; plain text fields (title, handle, SEO fields) are plain units. Fields of other types (JSON, lists, links, ...) are left out of the XLIFF and keep their source value in Shopify. Pair with `upload-xliff-file` once translated. operationId: shopifyDownloadXliffContentSync parameters: - name: X-ActionId in: header description: > A logging ID of the request. It is propagated through Phrase systems, making it easier to connect logs from various services. If no ActionId is sent with a request, one will be generated by Bifrost and returned with the response. required: false schema: type: string default: '' example: e48eda63928c4155bez9fdbsaadc15f3 - name: X-ResponseType in: header description: > Specify if the response should contain the processed object itself in an application/octet-stream body, or a application/json body with an ID that can be then used to retrieve the object using a /load-content endpoint. Note that for larger files (> 1 MB), it is advised to use the ID option which is also default. required: false schema: type: string default: ID enum: - ID - OBJECT requestBody: content: application/json: schema: $ref: '#/components/schemas/ShopifyDownloadXliffFileApiBody' additionalProperties: default: '' default: '' examples: Download as XLIFF: description: Download as XLIFF value: credentials: connectionUid: 7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11 organizationUid: 3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10 path: pathType: RESOURCE id: gid://shopify/Product/1234567890 sourceLocale: en required: true responses: '200': description: OK — XLIFF binary stream (returned when `X-ResponseType=OBJECT`). headers: Content-Disposition: description: '`attachment; filename="export.xliff"`.' style: simple schema: type: array contains: default: '' items: default: '' unevaluatedItems: default: '' X-ActionId: description: > A logging ID of the request. It is propagated through Phrase systems, making it easier to connect logs from various services. If no ActionId is sent with a request, one will be generated by Bifrost and returned with the response. style: simple schema: type: array contains: default: '' items: default: '' unevaluatedItems: default: '' Content-Type: description: '`application/xliff+xml`.' style: simple schema: type: array contains: default: '' items: default: '' unevaluatedItems: default: '' content: application/xliff+xml: schema: type: string format: binary additionalProperties: default: '' default: '' default: description: > Bad request or upstream failure. Returns an `ErrorResponse` body. See the API overview's "Error model" section for the HTTP status → error-type mapping. The `X-ActionId` header is set on every error response — quote it when reporting issues. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' additionalProperties: default: '' default: '' components: schemas: ShopifyDownloadXliffFileApiBody: type: object description: >- Request body for downloading the translatable content of one Shopify resource as XLIFF 2.0. The connector downloads the raw content and converts it in a second step. properties: credentials: $ref: '#/components/schemas/ShopifyCredentialsDto' default: '' description: >- Connection holding the Shopify access token; the store comes from the connection. configuration: $ref: '#/components/schemas/ShopifyConfigurationDto' default: '' description: Shopify-specific settings (currently none); may be omitted. path: $ref: '#/components/schemas/ResourcePathDto' default: '' description: The resource to download (`RESOURCE` with its Shopify GID). sourceLocale: type: string default: '' description: >- Source locale to read; also the XLIFF source locale (locale code, e.g. `en`). Omit to use the shop's primary language. example: en required: - credentials - path ErrorResponse: type: object properties: problemDetail: $ref: '#/components/schemas/ProblemDetail' ShopifyCredentialsDto: type: object description: > Reference to the connection holding the Shopify access token. Neither the token nor the store identity travels through Bifrost: connector2 resolves both from the connection (the store host is taken from the connection the token was issued for, so the caller does not supply - and cannot mismatch - it). properties: connectionUid: type: string default: '' description: >- UID of the connection to resolve the Shopify access token and store host from. example: 7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11 minLength: 1 organizationUid: type: string default: '' description: > UID of the organization that owns the connection. Must match the organization of the authenticated caller, otherwise the request is rejected with 403. example: 3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10 minLength: 1 required: - connectionUid - organizationUid ShopifyConfigurationDto: description: Shopify configuration. Currently has no fields; may be omitted. ResourcePathDto: description: A single Shopify resource, addressed by its GID. properties: pathType: type: string default: '' enum: - RESOURCE example: RESOURCE id: type: string default: '' description: Shopify GID of the resource. example: gid://shopify/Product/1234567890 minLength: 1 required: - id - pathType ProblemDetail: type: object properties: type: type: string format: uri title: type: string status: type: integer format: int32 detail: type: string instance: type: string format: uri properties: type: object additionalProperties: {} errorType: type: string description: Bifrost error taxonomy — see the "Error model" section above. enum: - auth_error - upstream_error - processing_error - deserialization - timeout - rate_limited - unknown securitySchemes: bearerAuth: type: http description: >- IDM-issued JWT. Obtain via the IDM authentication flow and pass as: Bearer scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.