Support Tickets

Category: Admin Base URL: /admin/support Authentication: Required Routes: 12 routes documented

Overview

This section documents 12 API routes for support tickets.

⚠️ These endpoints operate on your live store. POST/PUT/DELETE operations here — including sync, push, resync, and cache operations — modify or delete production data, and some trigger downstream effects such as warehouse orders or customer emails. DELETE operations are generally irreversible. Verify IDs and parameters carefully before calling them from scripts.

Quick Reference

Method	Endpoint	Description
GET	`/admin/support/agents`	GET /admin/support/agents List all synced support agents
GET	`/admin/support/customer-links`	GET /admin/support/customer-links List customer links with o...
GET	`/admin/support/knowledge`	GET /admin/support/knowledge List knowledge base articles wi...
POST	`/admin/support/knowledge`	POST /admin/support/knowledge Create a new knowledge base ar...
GET	`/admin/support/knowledge/:id`	GET /admin/support/knowledge/:id Get a single knowledge base...
POST	`/admin/support/knowledge/:id`	POST /admin/support/knowledge/:id Update a knowledge base ar...
DELETE	`/admin/support/knowledge/:id`	DELETE /admin/support/knowledge/:id Delete a knowledge base ...
GET	`/admin/support/platforms`	GET /admin/support/platforms List all configured support pla...
POST	`/admin/support/platforms`	POST /admin/support/platforms Create a new platform configur...
POST	`/admin/support/platforms/:id`	POST /admin/support/platforms/:id Update a platform configur...
POST	`/admin/support/platforms/:id/sync-agents`	POST /admin/support/platforms/:id/sync-agents Sync agents fr...
POST	`/admin/support/sync`	POST /admin/support/sync Trigger a manual sync of tickets fr...
GET	`/admin/support/tickets`	GET /admin/support/tickets List all support tickets with opt...
POST	`/admin/support/tickets`	POST /admin/support/tickets Create a new support ticket (man...
GET	`/admin/support/tickets/:id`	GET /admin/support/tickets/:id Get a single support ticket b...
POST	`/admin/support/tickets/:id`	POST /admin/support/tickets/:id Update a support ticket
DELETE	`/admin/support/tickets/:id`	DELETE /admin/support/tickets/:id Delete a support ticket
POST	`/admin/support/tickets/:id/ai-suggestions`	POST /admin/support/tickets/:id/ai-suggestions Generate AI s...
GET	`/admin/support/tickets/:id/ai-suggestions`	POST /admin/support/tickets/:id/ai-suggestions/response Gene...
GET	`/admin/support/tickets/:id/messages`	GET /admin/support/tickets/:id/messages Get all messages for...
POST	`/admin/support/tickets/:id/messages`	POST /admin/support/tickets/:id/messages Create a new messag...

GET Admin Support Agents

Endpoint: GET /admin/support/agents Authentication: Admin (Required)

Description

GET /admin/support/agents List all synced support agents

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/admin/support/agents' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Support Customer-links

Endpoint: GET /admin/support/customer-links Authentication: Admin (Required)

Description

GET /admin/support/customer-links List customer links with optional filters

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/admin/support/customer-links' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Support Knowledge

Endpoint: GET /admin/support/knowledge Authentication: Admin (Required)

Description

GET /admin/support/knowledge List knowledge base articles with optional filters

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/admin/support/knowledge' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Support Knowledge

Endpoint: POST /admin/support/knowledge Authentication: Admin (Required)

Description

POST /admin/support/knowledge Create a new knowledge base article

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X POST 'https://your-store.omnicart.cc/admin/support/knowledge' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Support Knowledge :id

Endpoint: GET /admin/support/knowledge/:id Authentication: Admin (Required)

Description

GET /admin/support/knowledge/:id Get a single knowledge base article

URL Parameters

Parameter	Type	Required	Description
`id`	string	Yes	Id identifier

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/admin/support/knowledge/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Support Knowledge :id

Endpoint: POST /admin/support/knowledge/:id Authentication: Admin (Required)

Description

POST /admin/support/knowledge/:id Update a knowledge base article

URL Parameters

Parameter	Type	Required	Description
`id`	string	Yes	Id identifier

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X POST 'https://your-store.omnicart.cc/admin/support/knowledge/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

DELETE Admin Support Knowledge :id

Endpoint: DELETE /admin/support/knowledge/:id Authentication: Admin (Required)

Description

DELETE /admin/support/knowledge/:id Delete a knowledge base article

URL Parameters

Parameter	Type	Required	Description
`id`	string	Yes	Id identifier

Response

Success:

// Response structure (to be documented)

Example Request

curl -X DELETE 'https://your-store.omnicart.cc/admin/support/knowledge/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Support Platforms

Endpoint: GET /admin/support/platforms Authentication: Admin (Required)

Description

GET /admin/support/platforms List all configured support platforms

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/admin/support/platforms' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Support Platforms

Endpoint: POST /admin/support/platforms Authentication: Admin (Required)

Description

POST /admin/support/platforms Create a new platform configuration

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X POST 'https://your-store.omnicart.cc/admin/support/platforms' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Support Platforms :id

Endpoint: POST /admin/support/platforms/:id Authentication: Admin (Required)

Description

POST /admin/support/platforms/:id Update a platform configuration (e.g., toggle is_active or sync_enabled)

URL Parameters

Parameter	Type	Required	Description
`id`	string	Yes	Id identifier

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X POST 'https://your-store.omnicart.cc/admin/support/platforms/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Support Platforms :id Sync-agents

Endpoint: POST /admin/support/platforms/:id/sync-agents Authentication: Admin (Required)

Description

POST /admin/support/platforms/:id/sync-agents Sync agents from the platform to the local database

URL Parameters

Parameter	Type	Required	Description
`id`	string	Yes	Id identifier

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X POST 'https://your-store.omnicart.cc/admin/support/platforms/:id/sync-agents' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Support Sync

Endpoint: POST /admin/support/sync Authentication: Admin (Required)

Description

POST /admin/support/sync Trigger a manual sync of tickets from any platform (Intercom, Freshdesk, Gorgias)

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X POST 'https://your-store.omnicart.cc/admin/support/sync' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Support Tickets

Endpoint: GET /admin/support/tickets Authentication: Admin (Required)

Description

GET /admin/support/tickets List all support tickets with optional filtering

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/admin/support/tickets' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Support Tickets

Endpoint: POST /admin/support/tickets Authentication: Admin (Required)

Description

POST /admin/support/tickets Create a new support ticket (manual creation)

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X POST 'https://your-store.omnicart.cc/admin/support/tickets' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Support Tickets :id

Endpoint: GET /admin/support/tickets/:id Authentication: Admin (Required)

Description

GET /admin/support/tickets/:id Get a single support ticket by ID

URL Parameters

Parameter	Type	Required	Description
`id`	string	Yes	Id identifier

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/admin/support/tickets/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Support Tickets :id

Endpoint: POST /admin/support/tickets/:id Authentication: Admin (Required)

Description

POST /admin/support/tickets/:id Update a support ticket

URL Parameters

Parameter	Type	Required	Description
`id`	string	Yes	Id identifier

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X POST 'https://your-store.omnicart.cc/admin/support/tickets/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

DELETE Admin Support Tickets :id

Endpoint: DELETE /admin/support/tickets/:id Authentication: Admin (Required)

Description

DELETE /admin/support/tickets/:id Delete a support ticket

URL Parameters

Parameter	Type	Required	Description
`id`	string	Yes	Id identifier

Response

Success:

// Response structure (to be documented)

Example Request

curl -X DELETE 'https://your-store.omnicart.cc/admin/support/tickets/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Support Tickets :id Ai-suggestions

Endpoint: POST /admin/support/tickets/:id/ai-suggestions Authentication: Admin (Required)

Description

POST /admin/support/tickets/:id/ai-suggestions Generate AI suggestions for a support ticket

URL Parameters

Parameter	Type	Required	Description
`id`	string	Yes	Id identifier

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X POST 'https://your-store.omnicart.cc/admin/support/tickets/:id/ai-suggestions' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Support Tickets :id Ai-suggestions

Endpoint: GET /admin/support/tickets/:id/ai-suggestions Authentication: Admin (Required)

Description

POST /admin/support/tickets/:id/ai-suggestions/response Generate a suggested response for the agent

URL Parameters

Parameter	Type	Required	Description
`id`	string	Yes	Id identifier

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/admin/support/tickets/:id/ai-suggestions' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Support Tickets :id Messages

Endpoint: GET /admin/support/tickets/:id/messages Authentication: Admin (Required)

Description

GET /admin/support/tickets/:id/messages Get all messages for a ticket

URL Parameters

Parameter	Type	Required	Description
`id`	string	Yes	Id identifier

Response

Success:

// Response structure (to be documented)

Example Request

curl -X GET 'https://your-store.omnicart.cc/admin/support/tickets/:id/messages' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Support Tickets :id Messages

Endpoint: POST /admin/support/tickets/:id/messages Authentication: Admin (Required)

Description

POST /admin/support/tickets/:id/messages Create a new message (reply) for a ticket

URL Parameters

Parameter	Type	Required	Description
`id`	string	Yes	Id identifier

Request Body

// Request body structure (to be documented)

Response

Success:

// Response structure (to be documented)

Example Request

curl -X POST 'https://your-store.omnicart.cc/admin/support/tickets/:id/messages' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'