Skip to main content
POST
/
store-data
/
{storeUrl}
/
shopify
/
rest
Read a Shopify REST resource
curl --request POST \
  --url https://app.bily.ai/api/customer/v1/store-data/{storeUrl}/shopify/rest \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "path": "<string>"
}
'
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({path: '<string>'})
};

fetch('https://app.bily.ai/api/customer/v1/store-data/{storeUrl}/shopify/rest', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
import requests

url = "https://app.bily.ai/api/customer/v1/store-data/{storeUrl}/shopify/rest"

payload = { "path": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
{
  "ok": true,
  "storeUrl": "<string>",
  "apiVersion": "<string>",
  "requestId": "<string>",
  "response": "<unknown>",
  "callLimit": "<string>",
  "retryAfter": "<string>",
  "link": "<string>"
}
{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}
{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}
{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}
{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}
{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}
{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}
{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}

Authorizations

x-api-key
string
header
required

A server-side Bily API key created under Settings > MCP > Access key fallback. Select the intended store before creating it.

Headers

x-bily-organization-id
string

An organization ID returned by GET /context or GET /organizations. Required for GET /stores and optional for store-scoped paths.

Example:

"org_01J8W7T9G3E6ZQ4M2K5N8P1R0S"

Path Parameters

storeUrl
string
required

The exact store URL returned by GET /context or GET /stores.

Example:

"store.example.com"

Body

application/json
path
string
required

A relative resource path without a query string, such as orders or orders/123.

Maximum string length: 500
query
object
apiVersion
string
Pattern: ^(?:\d{4}-\d{2}|unstable)$

Response

Request completed successfully.

ok
boolean
required
storeUrl
string
required
apiVersion
string
required
requestId
string | null
required
response
any
required

The commerce REST response payload.

callLimit
string | null
retryAfter
string | null