Theme

FAQs ​

API endpoints for FAQs management in DEV.

Add FAQ ​

http
POST /v1/lsps/:icode/faqs

Headers ​

  • X-User-Agent (required)
  • X-Auth-Token (required)
  • X-Auth-Device (required)

Request Body ​

typescript
interface Add FAQRequest {
  version: string;
  question: string;
  answer: string;
  tags: string[];
}

Example:

json
{
  "version": "2025.08",
  "question": "What happen if I miss my delivery time?",
  "answer": "The agent will contact you to reschedule another date & time when we could come back with the package. Another option is to choose a pickup-point close to you convenient location, where you can go pick the package yourself.",
  "tags": [
    "delivery"
  ]
}

Retrieve FAQ ​

http
GET /v1/lsps/:icode/faqs/:reference

Headers ​

  • X-User-Agent (required)
  • X-Auth-Token (required)
  • X-Auth-Device (required)

Fetch FAQs ​

http
GET /v1/lsps/:icode/faqs

Headers ​

  • X-User-Agent (required)
  • X-Auth-Token (required)
  • X-Auth-Device (required)

Search FAQ ​

http
GET /v1/lsps/:icode/faqs/search?query=delivery

Headers ​

  • X-User-Agent (required)
  • X-Auth-Token (required)
  • X-Auth-Device (required)

Update FAQ ​

http
PATCH /v1/lsps/:icode/faqs/:reference

Headers ​

  • X-User-Agent (required)
  • X-Auth-Token (required)
  • X-Auth-Device (required)

Request Body ​

typescript
interface Update FAQRequest {
  context: {
    type: string;
    id: string
  };
  source: string;
}

Example:

json
{
  "context": {
    "type": "HUB",
    "id": "{{LSPHubId}}"
  },
  "source": "https://support.dedot.io/lsp/delivery#0023A"
}

Archive/Restore a FAQ ​

http
PATCH /v1/lsps/:icode/faqs/:reference/:operation

Headers ​

  • X-User-Agent (required)
  • X-Auth-Token (required)
  • X-Auth-Device (required)

Lock/Unlock a FAQ ​

http
PATCH /v1/lsps/:icode/faqs/:reference/:ockstate

Headers ​

  • X-User-Agent (required)
  • X-Auth-Token (required)
  • X-Auth-Device (required)

Put FAQ into a given context ​

http
PUT /v1/lsps/:icode/faqs/:reference/context/add

Headers ​

  • X-User-Agent (required)
  • X-Auth-Token (required)
  • X-Auth-Device (required)

Remove FAQ from a given context ​

http
PATCH /v1/lsps/:icode/faqs/:reference/context/remove

Headers ​

  • X-User-Agent (required)
  • X-Auth-Token (required)
  • X-Auth-Device (required)

Delete FAQ ​

http
DELETE /v1/lsps/:icode/faqs/:reference

Headers ​

  • X-User-Agent (required)
  • X-Auth-Token (required)
  • X-Auth-Device (required)

Request Body ​

typescript
interface Delete FAQRequest {
  context: {
    type: string;
    id: string
  };
  source: string;
}

Example:

json
{
  "context": {
    "type": "HUB",
    "id": "{{LSPHubId}}"
  },
  "source": "https://support.dedot.io/lsp/delivery#0023A"
}