Hoppa till innehållet

API och integrationer Headless commerce Hjälpartiklar

English

Hjälpartiklar

Knowledge base articles: browse by category, read by slug, search, and look up the articles attached to a specific product.

4 anrop GET Bas-URL https://api.erp.fluit.cloud/ecom

Autentisering, felkoder, rate limits, idempotens och paginering gäller alla anrop och står samlade under Kom igång.

GET /help/articles

List published FAQ / knowledge articles

Returns published knowledge articles grouped by category, with locale-aware translations.

Frågeparametrar

Fält Typ
category string
locale string

Svar

200 EcomArticlesResponse
Fält Typ
categories ArticleCategory[] · nullable
429 Rate limit exceeded. Wait the number of seconds given in Retry-After. The body is problem-shaped application/json, not application/problem+json. This API sends no X-RateLimit-* headers — the quota is discovered here.
  • Retry-After — Seconds to wait before retrying.

Exempel

curl 
curl "https://api.erp.fluit.cloud/ecom/help/articles" \
  -H "X-Tenant-Id: $FLUIT_TENANT_ID" \
  -H "X-Channel: web"
Svar 200 
{
  "categories": [
    {
      "articleCount": 42,
      "articles": [
        {
          "articleType": "string",
          "category": "string",
          "icon": "string",
          "id": "0f8b2c1e-4d3a-4b7e-9f10-2a6c5d8e1b44",
          "slug": "string",
          "summary": "string",
          "title": "string"
        }
      ],
      "category": "string",
      "icon": "string"
    }
  ]
}

Bas-URL https://api.erp.fluit.cloud/ecom. Svarsexemplet är genererat ur schemat: formen stämmer, värdena är påhittade.

GET /help/articles/{slug}

Get a knowledge article by slug

Returns a single published knowledge article with full Markdown content.

Sökvägsparametrar

Fält Typ
slug Krävs string

Frågeparametrar

Fält Typ
locale string

Svar

200 EcomArticleDetailResponse
Fält Typ
articleType string · nullable
category string · nullable
content string · nullable
icon string · nullable
id string(uuid)
slug string · nullable
summary string · nullable
title string · nullable
429 Rate limit exceeded. Wait the number of seconds given in Retry-After. The body is problem-shaped application/json, not application/problem+json. This API sends no X-RateLimit-* headers — the quota is discovered here.
  • Retry-After — Seconds to wait before retrying.

Standardfel: 404 Felhantering

Exempel

curl 
curl "https://api.erp.fluit.cloud/ecom/help/articles/{slug}" \
  -H "X-Tenant-Id: $FLUIT_TENANT_ID" \
  -H "X-Channel: web"
Svar 200 
{
  "articleType": "string",
  "category": "string",
  "content": "string",
  "icon": "string",
  "id": "0f8b2c1e-4d3a-4b7e-9f10-2a6c5d8e1b44",
  "slug": "string",
  "summary": "string",
  "title": "string"
}

Bas-URL https://api.erp.fluit.cloud/ecom. Svarsexemplet är genererat ur schemat: formen stämmer, värdena är påhittade.

GET /help/articles/by-item/{itemId}

Get knowledge articles for a specific item

Returns published knowledge articles linked to the given item ID.

Sökvägsparametrar

Fält Typ
itemId Krävs string(uuid)

Frågeparametrar

Fält Typ
locale string

Svar

200 EcomArticleListItem[]
Fält Typ
articleType string · nullable
category string · nullable
icon string · nullable
id string(uuid)
slug string · nullable
summary string · nullable
title string · nullable
429 Rate limit exceeded. Wait the number of seconds given in Retry-After. The body is problem-shaped application/json, not application/problem+json. This API sends no X-RateLimit-* headers — the quota is discovered here.
  • Retry-After — Seconds to wait before retrying.

Exempel

curl 
curl "https://api.erp.fluit.cloud/ecom/help/articles/by-item/{itemId}" \
  -H "X-Tenant-Id: $FLUIT_TENANT_ID" \
  -H "X-Channel: web"
Svar 200 
[
  {
    "articleType": "string",
    "category": "string",
    "icon": "string",
    "id": "0f8b2c1e-4d3a-4b7e-9f10-2a6c5d8e1b44",
    "slug": "string",
    "summary": "string",
    "title": "string"
  }
]

Bas-URL https://api.erp.fluit.cloud/ecom. Svarsexemplet är genererat ur schemat: formen stämmer, värdena är påhittade.

Scheman

Objekten som gruppens anrop refererar till. Fälttabellerna ovan går ett steg djupt och länkar hit i stället för att upprepa samma schema på varje endpoint.

Article

EcomArticleListItem
Fält Typ
articleType string · nullable
category string · nullable
icon string · nullable
id string(uuid)
slug string · nullable
summary string · nullable
title string · nullable

ArticleCategory

EcomArticleCategory
Fält Typ
articleCount integer
articles Article[] · nullable
category string · nullable
icon string · nullable