Skip to main content
POST
Upload raw content asynchronously

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.

X-Webhook
string
default:""
required

Required on /async/... endpoints. Bifrost POSTs the operation result to this URL once the connector finishes processing. Omitting this header on an async endpoint returns 400.

Body

application/json

Request body for uploading a translation to a Shopify resource. The file must already be in Phrase file storage — reference it by storageId.

credentials
object
required

Connection holding the Shopify access token, plus the store slug.

path
object
required

The resource the translation is uploaded to (RESOURCE with its Shopify GID).

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 raw file (already uploaded to Phrase file storage) to push to Shopify.

Minimum string length: 1
Example:

"e48eda63928c4155bez9fdbsaadc15f3"

configuration
any
default:""

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

{key}
any

Response

Successful operation. If X-ResponseType is set to 'ID' or no value is sent in the header, the file is saved and can be retrieved by sending a GET request to this endpoint. If X-ResponseType is set to 'OBJECT', the file is returned as a stream.

webhookUrl
string
default:""

Webhook URL you supplied in the request

requestId
string
default:""

Request ID you can use to retrieve the result

{key}
any