Hoppa till innehållet

API and integrations Headless commerce Help articles

Svenska

Help articles

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

4 calls GET Base URL https://api.erp.fluit.cloud/ecom

Authentication, error codes, rate limits, idempotency and pagination apply to every call and are documented once under Getting started.

GET /help/articles

List published FAQ / knowledge articles

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

Query parameters

Field Type
category string
locale string

Responses

200 EcomArticlesResponse
Field Type
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.

Examples

curl 
curl "https://api.erp.fluit.cloud/ecom/help/articles" \
  -H "X-Tenant-Id: $FLUIT_TENANT_ID" \
  -H "X-Channel: web"
Response 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"
    }
  ]
}

Base URL https://api.erp.fluit.cloud/ecom. The response example is generated from the schema: the shape is right, the values are made up.

GET /help/articles/{slug}

Get a knowledge article by slug

Returns a single published knowledge article with full Markdown content.

Path parameters

Field Type
slug Required string

Query parameters

Field Type
locale string

Responses

200 EcomArticleDetailResponse
Field Type
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.

Standard errors: 404 Errors

Examples

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

Base URL https://api.erp.fluit.cloud/ecom. The response example is generated from the schema: the shape is right, the values are made up.

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

Get knowledge articles for a specific item

Returns published knowledge articles linked to the given item ID.

Path parameters

Field Type
itemId Required string(uuid)

Query parameters

Field Type
locale string

Responses

200 EcomArticleListItem[]
Field Type
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.

Examples

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

Base URL https://api.erp.fluit.cloud/ecom. The response example is generated from the schema: the shape is right, the values are made up.

Schemas

The objects this group's calls refer to. The field tables above go one level deep and link here rather than repeating the same schema on every endpoint.

Article

EcomArticleListItem
Field Type
articleType string · nullable
category string · nullable
icon string · nullable
id string(uuid)
slug string · nullable
summary string · nullable
title string · nullable

ArticleCategory

EcomArticleCategory
Field Type
articleCount integer
articles Article[] · nullable
category string · nullable
icon string · nullable