Skip to main content
POST
Download 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-ResponseType
enum<string>
default:ID

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.

Available options:
ID,
OBJECT
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 downloading the translatable content of a Shopify resource. Authenticates via the credentials connection reference.

credentials
object
required

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

path
object
required

The resource to download (RESOURCE with its Shopify GID).

configuration
any
default:""

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

sourceLocale
string
default:""

Source locale to read (locale code, e.g. en). Omit to use the shop's primary language.

Example:

"en"

{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