Skip to main content
POST
Upload translated XLIFF synchronously

Authorizations

Authorization
string
header
required

IDM-issued JWT. Obtain via the IDM authentication flow and pass as: Bearer

Headers

X-ActionId
string
default:""

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.

Body

application/json

Request body for uploading a translated XLIFF of one Shopify resource into one target locale. The connector converts the XLIFF to the raw format and then writes it, as in upload-raw-file.

credentials
object
required

Connection holding the Shopify access token; the store comes from the connection.

path
object
required

The resource the translation is written to (RESOURCE with its Shopify GID); the one the XLIFF was downloaded from.

sourceLocale
string
default:""
required

Source locale of the XLIFF (locale code, e.g. en).

Minimum string length: 1
Example:

"en"

targetLocale
string
default:""
required

Target locale to write into (locale code, e.g. de, fr).

Minimum string length: 1
Example:

"de"

storageId
string
default:""
required

Storage ID of the translated XLIFF file (already in Phrase file storage).

Minimum string length: 1
Example:

"e48eda63928c4155bez9fdbsaadc15f3"

configuration
any
default:""

Shopify-specific settings (currently none); may be omitted.

{key}
any

Response

Success — the XLIFF was parsed and written. The envelope reports success and any per-item errors returned by Shopify.

success
boolean
errors
object[]
{key}
any