List the category tree
GET/v1/categories
scope catalog.read
The whole tree in one response — an ERP caches it. id is the Romanian master id and never changes between languages; tid is the row in the language you asked for. Only leaves accept listings. Each category carries its commission — the rate Biklo charges a company seller here, inherited down the tree — so you can set margins before listing rather than inferring the fee from a completed order. max_amount: null means UNCAPPED.
Query parameters#
| Name | Example | |
|---|---|---|
lang | ro | Language code from GET /v1/languages |
parent_id | — | Only the children of this category |
Response#
| Field | Type | Description |
|---|---|---|
language | string | Which language these names came back in. |
count | integer | How many categories are in data. The tree comes back whole, not paged. |
data | array | Every category, flat. Rebuild the tree from parent_id. |
data[]. | integer | The MASTER id, and the one to send back as category_id. It is the same whatever language you asked for, so this is the one to store. |
data[]. | integer | The id of this row in the requested language. Useful only for matching a name you already hold; never send it. |
data[]. | integer | The parent category, for rebuilding the tree. |
data[]. | string | Display name in the requested language. |
data[]. | string | URL segment for this category. |
data[]. | integer | How deep in the tree, top level being 0. |
data[]. | boolean | Whether it has no children. List against a LEAF: a parent category will take the product, but buyers filter on leaves. |
data[]. | object | What this category implies about delivery. |
data[]. | boolean | false means products here cannot go by courier at all, whatever you put in shipping.ship_with_us. |
data[]. | number | The weight assumed when a listing declares none. Send a real one — this is a fallback, not a quote. |
Example
{
"language": "ro",
"count": 210,
"data": [
{
"id": 4291,
"tid": 4291,
"parent_id": 5,
"name": "Hardtail",
"slug": "hardtail",
"depth": 2,
"is_leaf": true,
"shipping": {
"can_be_shipped": true,
"default_weight_kg": 14
}
}
]
}