TRANXACT.AI Help

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.

Type REST16 operationsBase path /api/crm/commerce-connectorsPublished as /api/v1/commerce-connectors

Download specification (OpenAPI 3.1) Screen: Channel Connectors

Overview

PackageCRM
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablecrm.commerce_connectors · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
platformtextYesPlatform
Allowed: shopify magento amazon sandbox
sandbox_flavourtextNoSandbox imitates
Allowed: shopify magento amazon
shop_domaintextNoShop domain — example.myshopify.com
base_urltextNoStore address — https://shop.example.com
api_versiontextNoAPI version
marketplace_idtextNoMarketplace / location id — Amazon: the marketplace (ATVPDKIKX0DER for the US). Shopify: the location stock is set at.
seller_idtextNoSeller id
regiontextNoRegion
Allowed: na eu fe
client_idtextNoLWA client id
account_iduuidNoCustomer account for its orders
warehouse_iduuidNoWarehouse
location_iduuidNoLocation id
currencytextNoCurrency
sync_inventorybooleanNoPush stock on a schedule
poll_ordersbooleanNoPull orders on a schedule
confirm_ordersbooleanNoImport orders as confirmed
stock_buffernumericNoHeld back from the channel
is_activebooleanNoActive

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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
platformtextYesPlatform
Allowed: shopify magento amazon sandbox
sandbox_flavourtextNoSandbox imitates
Allowed: shopify magento amazon
shop_domaintextNoShop domain — example.myshopify.com
base_urltextNoStore address — https://shop.example.com
api_versiontextNoAPI version
marketplace_idtextNoMarketplace / location id — Amazon: the marketplace (ATVPDKIKX0DER for the US). Shopify: the location stock is set at.
seller_idtextNoSeller id
regiontextNoRegion
Allowed: na eu fe
client_idtextNoLWA client id
account_iduuidNoCustomer account for its orders
warehouse_iduuidNoWarehouse
location_iduuidNoLocation id
currencytextNoCurrency
sync_inventorybooleanNoPush stock on a schedule
poll_ordersbooleanNoPull orders on a schedule
confirm_ordersbooleanNoImport orders as confirmed
stock_buffernumericNoHeld back from the channel
is_activebooleanNoActive

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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, webhookSecret

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 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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

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/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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

settlements

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/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

NameTypeDescription
idstring (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, eventId

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/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

NameTypeDescription
idstring (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, carrier

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/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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
codetextread, writeCode
nametextread, writeName
platformtextread, writePlatform
Allowed: shopify magento amazon sandbox
sandbox_flavourtextread, writeSandbox imitates
Allowed: shopify magento amazon
shop_domaintextread, writeShop domain — example.myshopify.com
base_urltextread, writeStore address — https://shop.example.com
api_versiontextread, writeAPI version
marketplace_idtextread, writeMarketplace / location id — Amazon: the marketplace (ATVPDKIKX0DER for the US). Shopify: the location stock is set at.
seller_idtextread, writeSeller id
regiontextread, writeRegion
Allowed: na eu fe
client_idtextread, writeLWA client id
token_expires_attimestamp with time zoneread onlyToken expires at
secrets_settextread onlySecrets set
webhook_keytextread onlyWebhook key
account_iduuidread, writeCustomer account for its orders
warehouse_iduuidread, writeWarehouse
location_iduuidread, writeLocation id
currencytextread, writeCurrency
sync_inventorybooleanread, writePush stock on a schedule
poll_ordersbooleanread, writePull orders on a schedule
confirm_ordersbooleanread, writeImport orders as confirmed
stock_buffernumericread, writeHeld back from the channel
orders_cursortextread onlyOrders cursor
last_order_poll_attimestamp with time zoneread onlyLast order poll at
last_inventory_sync_attimestamp with time zoneread onlyLast inventory sync at
statustextread onlyStatus
last_errortextread onlyLast error
is_activebooleanread, writeActive
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold CRM › Channel Connectors for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.