Skip to main content
POST
/
api
/
coolblue
/
categories
/coolblue/categories
curl --request POST \
  --url https://api.anysite.io/api/coolblue/categories \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "count": 2,
  "timeout": 300,
  "include_breadcrumbs": false,
  "exclude_orphan": false
}
'
[
  {
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "url": "<string>",
    "sitemap_url": "<string>",
    "@type": "@coolblue_category_entry",
    "parent": {
      "name": "<string>",
      "@type": "@coolblue_category_ref",
      "id": "<string>",
      "alias": "<string>",
      "url": "<string>"
    },
    "breadcrumbs": [
      {
        "name": "<string>",
        "@type": "@coolblue_category_ref",
        "id": "<string>",
        "alias": "<string>",
        "url": "<string>"
      }
    ]
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
count
integer
required

Max number of results

Required range: x >= 1
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
include_breadcrumbs
boolean
default:false

Fetch each category landing page to enrich with breadcrumb parent path and pretty name. Cost and latency scale linearly with count (one landing fetch per category).

​
exclude_orphan
boolean
default:false

Drop legacy/system entries that have no reachable breadcrumb path. Only takes effect together with include_breadcrumbs.

Response

Successful Response

​
id
string
required
​
name
string
required
​
slug
string
required
​
url
string
required
​
sitemap_url
string
required
​
@type
string
default:@coolblue_category_entry
​
parent
CoolblueCategoryRef · object
​
breadcrumbs
CoolblueCategoryRef · object[] | null