Shopify Integration¶

Connect Falara directly to your Shopify store to translate products, collections, and content.

Shopify App

For most use cases, install the Falara Shopify App instead of using the API directly. The app provides a visual interface for managing translations.

Connect Your Store¶

Generate OAuth URL¶

GET /v1/integrations/shopify/connect

Start the Shopify OAuth flow. Redirect the user to the returned URL to authorize Falara for their store.

Authentication: X-API-Key header

Query Parameters

Parameter	Type	Required	Description
`shop`	string	yes	Shopify store domain (e.g., `mystore.myshopify.com`)

cURLPythonJavaScript

curl -X GET "https://app.falara.io/v1/integrations/shopify/connect?shop=mystore.myshopify.com" \
  -H "X-API-Key: YOUR_API_KEY"

import requests

resp = requests.get(
    "https://app.falara.io/v1/integrations/shopify/connect",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"shop": "mystore.myshopify.com"},
)
auth_url = resp.json()["url"]

const resp = await fetch(
  "https://app.falara.io/v1/integrations/shopify/connect?shop=mystore.myshopify.com",
  { headers: { "X-API-Key": "YOUR_API_KEY" } }
);
const { url } = await resp.json();

Response 200 OK

{
  "url": "https://mystore.myshopify.com/admin/oauth/authorize?client_id=...&scope=..."
}

Check Connection Status¶

GET /v1/integrations/shopify/status

Check whether a Shopify store is connected.

Authentication: X-API-Key header

cURLPythonJavaScript

curl -X GET https://app.falara.io/v1/integrations/shopify/status \
  -H "X-API-Key: YOUR_API_KEY"

resp = requests.get(
    "https://app.falara.io/v1/integrations/shopify/status",
    headers={"X-API-Key": "YOUR_API_KEY"},
)
print(resp.json())

const resp = await fetch(
  "https://app.falara.io/v1/integrations/shopify/status",
  { headers: { "X-API-Key": "YOUR_API_KEY" } }
);
const data = await resp.json();

Response 200 OK

{
  "status": "active",
  "shop_domain": "mystore.myshopify.com",
  "shop_name": "My Store",
  "connected_at": "2026-03-15T10:30:00Z"
}

Get Plugin API Key¶

GET /v1/integrations/shopify/pickup-key

Retrieve the API key to use with the Shopify plugin for write-back operations.

Authentication: X-API-Key header

cURLPythonJavaScript

curl -X GET https://app.falara.io/v1/integrations/shopify/pickup-key \
  -H "X-API-Key: YOUR_API_KEY"

resp = requests.get(
    "https://app.falara.io/v1/integrations/shopify/pickup-key",
    headers={"X-API-Key": "YOUR_API_KEY"},
)
plugin_key = resp.json()["api_key"]

const resp = await fetch(
  "https://app.falara.io/v1/integrations/shopify/pickup-key",
  { headers: { "X-API-Key": "YOUR_API_KEY" } }
);
const { api_key } = await resp.json();

Response 200 OK

{
  "api_key": "fal_pk_..."
}

Disconnect Store¶

DELETE /v1/integrations/shopify/disconnect

Disconnect the Shopify store and revoke all access tokens.

Authentication: X-API-Key header

cURLPythonJavaScript

curl -X DELETE https://app.falara.io/v1/integrations/shopify/disconnect \
  -H "X-API-Key: YOUR_API_KEY"

resp = requests.delete(
    "https://app.falara.io/v1/integrations/shopify/disconnect",
    headers={"X-API-Key": "YOUR_API_KEY"},
)

const resp = await fetch(
  "https://app.falara.io/v1/integrations/shopify/disconnect",
  { method: "DELETE", headers: { "X-API-Key": "YOUR_API_KEY" } }
);

Response 200 OK

{
  "status": "disconnected"
}

Errors¶

Status	Reason
`401 Unauthorized`	Missing or invalid API key
`403 Forbidden`	Shopify integration not available on current plan
`404 Not Found`	No Shopify store connected
`400 Bad Request`	Invalid shop domain