eDesk API

11 endpoints for eDesk, each at its own method and path, called with your API key. Open an endpoint for its inputs, examples and response.

Base URL: https://cotlet.dev/api/v1/edesk
Connects with: Your own eDesk login (Basic role or higher to reply, as shown in eDesk Help). You sign in in your own browser and keep your own password and 2-step verification.
Integration page: eDesk

Read (8)

Return data and change nothing in the account.

eDesk Endpoints: Read
Endpoint	Description
GET /tickets	Tickets in the Mailbox by section, channel, type, owner or tag, with status, order number and reply count.
GET /tickets/{ticket_id}	One ticket with its messages and internal notes, customer, tags and the order panel with tracking.
GET /orders	Orders from the All Orders page, filtered by search text, status, channel or date, with items and ticket link.
GET /orders/{order_id}	One order with items, status, dates, delivery address, tracking code and carrier.
GET /templates	Reply templates from Settings, Smart Tools, Templates, with text and usage.
GET /users	Teammates of your eDesk account with their role.
GET /tags	Tags and tag groups in your eDesk account.
GET /channels	Channels connected to eDesk: marketplaces, webstores and email.

Change the account. Calls marked Confirm wait for the user to approve them.

eDesk Endpoints: Write
Endpoint	Description
POST /tickets/{ticket_id}/replies Confirm	Send a reply to the customer from the ticket, with the send status you choose.
POST /tickets/{ticket_id}/internal-notes Confirm	Add a note to the ticket that only your teammates see.
PATCH /tickets/{ticket_id} Confirm	Set owner, tags and status, snooze the ticket or mention a teammate.