{
 "openapi": "3.1.0",
 "info": {
  "title": "Channel Connectors (CRM)",
  "version": "20261030b",
  "description": "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."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "commerce-connectors": {
    "type": "object",
    "required": [
     "code",
     "name",
     "platform"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org unit id",
      "readOnly": true
     },
     "code": {
      "type": "string",
      "description": "Code"
     },
     "name": {
      "type": "string",
      "description": "Name"
     },
     "platform": {
      "type": "string",
      "description": "Platform",
      "enum": [
       "shopify",
       "magento",
       "amazon",
       "sandbox"
      ]
     },
     "sandbox_flavour": {
      "type": "string",
      "description": "Sandbox imitates",
      "enum": [
       "shopify",
       "magento",
       "amazon"
      ]
     },
     "shop_domain": {
      "type": "string",
      "description": "Shop domain"
     },
     "base_url": {
      "type": "string",
      "description": "Store address"
     },
     "api_version": {
      "type": "string",
      "description": "API version"
     },
     "marketplace_id": {
      "type": "string",
      "description": "Marketplace / location id"
     },
     "seller_id": {
      "type": "string",
      "description": "Seller id"
     },
     "region": {
      "type": "string",
      "description": "Region",
      "enum": [
       "na",
       "eu",
       "fe"
      ]
     },
     "client_id": {
      "type": "string",
      "description": "LWA client id"
     },
     "token_expires_at": {
      "type": "string",
      "format": "date-time",
      "description": "Token expires at",
      "readOnly": true
     },
     "secrets_set": {
      "type": "string",
      "description": "Secrets set",
      "readOnly": true
     },
     "webhook_key": {
      "type": "string",
      "description": "Webhook key",
      "readOnly": true
     },
     "account_id": {
      "type": "string",
      "format": "uuid",
      "description": "Customer account for its orders"
     },
     "warehouse_id": {
      "type": "string",
      "format": "uuid",
      "description": "Warehouse"
     },
     "location_id": {
      "type": "string",
      "format": "uuid",
      "description": "Location id"
     },
     "currency": {
      "type": "string",
      "description": "Currency"
     },
     "sync_inventory": {
      "type": "boolean",
      "description": "Push stock on a schedule"
     },
     "poll_orders": {
      "type": "boolean",
      "description": "Pull orders on a schedule"
     },
     "confirm_orders": {
      "type": "boolean",
      "description": "Import orders as confirmed"
     },
     "stock_buffer": {
      "type": "string",
      "format": "decimal",
      "description": "Held back from the channel"
     },
     "orders_cursor": {
      "type": "string",
      "description": "Orders cursor",
      "readOnly": true
     },
     "last_order_poll_at": {
      "type": "string",
      "format": "date-time",
      "description": "Last order poll at",
      "readOnly": true
     },
     "last_inventory_sync_at": {
      "type": "string",
      "format": "date-time",
      "description": "Last inventory sync at",
      "readOnly": true
     },
     "status": {
      "type": "string",
      "description": "Status",
      "readOnly": true
     },
     "last_error": {
      "type": "string",
      "description": "Last error",
      "readOnly": true
     },
     "is_active": {
      "type": "boolean",
      "description": "Active"
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "readOnly": true
     },
     "created_by": {
      "type": "string",
      "format": "uuid",
      "description": "Created by",
      "readOnly": true
     },
     "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Updated at",
      "readOnly": true
     },
     "updated_by": {
      "type": "string",
      "format": "uuid",
      "description": "Updated by",
      "readOnly": true
     },
     "xf_text_1": {
      "type": "string",
      "description": "Xf text 1",
      "readOnly": true
     },
     "xf_text_2": {
      "type": "string",
      "description": "Xf text 2",
      "readOnly": true
     },
     "xf_text_3": {
      "type": "string",
      "description": "Xf text 3",
      "readOnly": true
     },
     "xf_text_4": {
      "type": "string",
      "description": "Xf text 4",
      "readOnly": true
     },
     "xf_text_5": {
      "type": "string",
      "description": "Xf text 5",
      "readOnly": true
     },
     "xf_num_1": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 1",
      "readOnly": true
     },
     "xf_num_2": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 2",
      "readOnly": true
     },
     "xf_num_3": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 3",
      "readOnly": true
     },
     "xf_date_1": {
      "type": "string",
      "format": "date",
      "description": "Xf date 1",
      "readOnly": true
     },
     "xf_date_2": {
      "type": "string",
      "format": "date",
      "description": "Xf date 2",
      "readOnly": true
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/crm/commerce-connectors": {
   "get": {
    "summary": "list commerce-connectors",
    "operationId": "list_commerce_connectors_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create commerce-connectors",
    "operationId": "create_commerce_connectors_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/crm/commerce-connectors/{id}": {
   "get": {
    "summary": "get commerce-connectors",
    "operationId": "get_commerce_connectors_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change commerce-connectors",
    "operationId": "change_commerce_connectors_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete commerce-connectors",
    "operationId": "delete_commerce_connectors_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/crm/commerce-connectors/{id}/secrets": {
   "put": {
    "summary": "Secrets",
    "operationId": "action_commerce_connectors_0_6",
    "description": "Body keys: accessToken, refreshToken, clientSecret, webhookSecret",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/crm/commerce-connectors/{id}/webhook": {
   "get": {
    "summary": "Webhook",
    "operationId": "action_commerce_connectors_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/crm/commerce-connectors/{id}/activate": {
   "post": {
    "summary": "Activate",
    "operationId": "action_commerce_connectors_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/crm/commerce-connectors/{id}/pause": {
   "post": {
    "summary": "Pause",
    "operationId": "action_commerce_connectors_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/crm/commerce-connectors/{id}/pull-orders": {
   "post": {
    "summary": "Pull orders",
    "operationId": "action_commerce_connectors_0_6",
    "description": "Body keys: payload",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/crm/commerce-connectors/{id}/push-inventory": {
   "post": {
    "summary": "Push inventory",
    "operationId": "action_commerce_connectors_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/crm/commerce-connectors/{id}/import-settlements": {
   "post": {
    "summary": "Import settlements",
    "operationId": "action_commerce_connectors_0_6",
    "description": "Body keys: settlements",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/crm/commerce-connectors/{id}/sandbox-webhook": {
   "post": {
    "summary": "Sandbox webhook",
    "operationId": "action_commerce_connectors_0_6",
    "description": "Body keys: payload, tamper, topic, eventId",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/crm/commerce-connectors/orders/{id}/push-fulfilment": {
   "post": {
    "summary": "Orders push fulfilment",
    "operationId": "action_commerce_connectors_0_7",
    "description": "Body keys: trackingNo, carrier",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/crm/commerce-connectors/orders/{id}/retry": {
   "post": {
    "summary": "Orders retry",
    "operationId": "action_commerce_connectors_0_7",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/crm/commerce-connectors/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_commerce_connectors_0_6",
    "description": "Body keys: overrides, preview, withLines",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}