CRM · Sales Channels
Channel Connectors
Shopify, Magento / Adobe Commerce and Amazon: orders come in as sales orders once, stock and tracking go back out. Webhooks are checked against the connector's own secret. A sandbox connector runs sample payloads through the same import.
/api/crm/commerce-connectorsPublished as /api/v1/commerce-connectorsDownload specification (OpenAPI 3.1) Screen: Channel Connectors
Overview
| Package | CRM |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold CRM › Channel Connectors on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | crm.commerce_connectors · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
16 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/commerce-connectorsList channel connectors
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"platform": "shopify",
"sandbox_flavour": "shopify",
"shop_domain": "text",
"base_url": "https://example.com",
"api_version": "text",
"marketplace_id": "text",
"seller_id": "text",
"region": "na",
"client_id": "text",
"token_expires_at": "2026-10-30T09:00:00Z"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/commerce-connectors?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/commerce-connectors/{id}Read one commerce connectors
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"platform": "shopify",
"sandbox_flavour": "shopify",
"shop_domain": "text",
"base_url": "https://example.com",
"api_version": "text",
"marketplace_id": "text",
"seller_id": "text",
"region": "na",
"client_id": "text",
"token_expires_at": "2026-10-30T09:00:00Z"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/commerce-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/commerce-connectorsCreate a commerce connectors
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
platform | text | Yes | Platform Allowed: shopify magento amazon sandbox |
sandbox_flavour | text | No | Sandbox imitates Allowed: shopify magento amazon |
shop_domain | text | No | Shop domain — example.myshopify.com |
base_url | text | No | Store address — https://shop.example.com |
api_version | text | No | API version |
marketplace_id | text | No | Marketplace / location id — Amazon: the marketplace (ATVPDKIKX0DER for the US). Shopify: the location stock is set at. |
seller_id | text | No | Seller id |
region | text | No | Region Allowed: na eu fe |
client_id | text | No | LWA client id |
account_id | uuid | No | Customer account for its orders |
warehouse_id | uuid | No | Warehouse |
location_id | uuid | No | Location id |
currency | text | No | Currency |
sync_inventory | boolean | No | Push stock on a schedule |
poll_orders | boolean | No | Pull orders on a schedule |
confirm_orders | boolean | No | Import orders as confirmed |
stock_buffer | numeric | No | Held back from the channel |
is_active | boolean | No | Active |
Sample body
{
"code": "COD-000001",
"name": "Example",
"platform": "shopify",
"sandbox_flavour": "shopify",
"shop_domain": "text",
"base_url": "https://example.com",
"api_version": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"platform": "shopify",
"sandbox_flavour": "shopify",
"shop_domain": "text",
"base_url": "https://example.com",
"api_version": "text",
"marketplace_id": "text",
"seller_id": "text",
"region": "na",
"client_id": "text",
"token_expires_at": "2026-10-30T09:00:00Z"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/commerce-connectors" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","platform":"shopify","sandbox_flavour":"shopify","shop_domain":"text","base_url":"https://example.com","api_version":"text"}'PUT/api/crm/commerce-connectors/{id}Change a commerce connectors
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
platform | text | Yes | Platform Allowed: shopify magento amazon sandbox |
sandbox_flavour | text | No | Sandbox imitates Allowed: shopify magento amazon |
shop_domain | text | No | Shop domain — example.myshopify.com |
base_url | text | No | Store address — https://shop.example.com |
api_version | text | No | API version |
marketplace_id | text | No | Marketplace / location id — Amazon: the marketplace (ATVPDKIKX0DER for the US). Shopify: the location stock is set at. |
seller_id | text | No | Seller id |
region | text | No | Region Allowed: na eu fe |
client_id | text | No | LWA client id |
account_id | uuid | No | Customer account for its orders |
warehouse_id | uuid | No | Warehouse |
location_id | uuid | No | Location id |
currency | text | No | Currency |
sync_inventory | boolean | No | Push stock on a schedule |
poll_orders | boolean | No | Pull orders on a schedule |
confirm_orders | boolean | No | Import orders as confirmed |
stock_buffer | numeric | No | Held back from the channel |
is_active | boolean | No | Active |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"platform": "shopify",
"sandbox_flavour": "shopify",
"shop_domain": "text",
"base_url": "https://example.com",
"api_version": "text",
"marketplace_id": "text",
"seller_id": "text",
"region": "na",
"client_id": "text",
"token_expires_at": "2026-10-30T09:00:00Z"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/commerce-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/crm/commerce-connectors/{id}Delete a commerce connectors
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/crm/commerce-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"PUT/api/crm/commerce-connectors/{id}/secretsSecrets
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
accessToken, refreshToken, clientSecret, webhookSecretResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/commerce-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/secrets" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"accessToken":"value","refreshToken":"value","clientSecret":"value","webhookSecret":"value"}'GET/api/crm/commerce-connectors/{id}/webhookWebhook
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/commerce-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/webhook" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/commerce-connectors/{id}/activateActivate
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/commerce-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/activate" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/commerce-connectors/{id}/pausePause
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/commerce-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/pause" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/commerce-connectors/{id}/pull-ordersPull orders
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
payloadResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/commerce-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/pull-orders" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"payload":"value"}'POST/api/crm/commerce-connectors/{id}/push-inventoryPush inventory
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/commerce-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/push-inventory" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/commerce-connectors/{id}/import-settlementsImport settlements
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
settlementsResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/commerce-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/import-settlements" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"settlements":"value"}'POST/api/crm/commerce-connectors/{id}/sandbox-webhookSandbox webhook
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
payload, tamper, topic, eventIdResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/commerce-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/sandbox-webhook" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"payload":"value","tamper":"value","topic":"value","eventId":"value"}'POST/api/crm/commerce-connectors/orders/{id}/push-fulfilmentOrders push fulfilment
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
trackingNo, carrierResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/commerce-connectors/orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/push-fulfilment" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"trackingNo":"value","carrier":"value"}'POST/api/crm/commerce-connectors/orders/{id}/retryOrders retry
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/commerce-connectors/orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/retry" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/commerce-connectors/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/commerce-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a commerce connectors, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
code | text | read, write | Code |
name | text | read, write | Name |
platform | text | read, write | Platform Allowed: shopify magento amazon sandbox |
sandbox_flavour | text | read, write | Sandbox imitates Allowed: shopify magento amazon |
shop_domain | text | read, write | Shop domain — example.myshopify.com |
base_url | text | read, write | Store address — https://shop.example.com |
api_version | text | read, write | API version |
marketplace_id | text | read, write | Marketplace / location id — Amazon: the marketplace (ATVPDKIKX0DER for the US). Shopify: the location stock is set at. |
seller_id | text | read, write | Seller id |
region | text | read, write | Region Allowed: na eu fe |
client_id | text | read, write | LWA client id |
token_expires_at | timestamp with time zone | read only | Token expires at |
secrets_set | text | read only | Secrets set |
webhook_key | text | read only | Webhook key |
account_id | uuid | read, write | Customer account for its orders |
warehouse_id | uuid | read, write | Warehouse |
location_id | uuid | read, write | Location id |
currency | text | read, write | Currency |
sync_inventory | boolean | read, write | Push stock on a schedule |
poll_orders | boolean | read, write | Pull orders on a schedule |
confirm_orders | boolean | read, write | Import orders as confirmed |
stock_buffer | numeric | read, write | Held back from the channel |
orders_cursor | text | read only | Orders cursor |
last_order_poll_at | timestamp with time zone | read only | Last order poll at |
last_inventory_sync_at | timestamp with time zone | read only | Last inventory sync at |
status | text | read only | Status |
last_error | text | read only | Last error |
is_active | boolean | read, write | Active |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold CRM › Channel Connectors for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.