Skip to main content
POST
List content 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 listing Shopify resource types or resources. The response is a list of remoteResources you can feed back into list (resource types) or download/upload (resources).

credentials
object
required

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

path
object
required

What to list: ROOT (the supported resource types) or RESOURCE_TYPE (the resources of one type, optionally filtered by update time).

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"

targetLocales
string[]

Target locales to report translation coverage for (present / outdated / last updated) on each listed resource. Omit for none.

Example:
{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.

remoteResources
object[]
{key}
any