Get the reason tree

The whole reason tree of the given kinds — nested, ordered, filters pruning the branches. Declared BEFORE GET /reasons/:id: routes match in declaration order, and tree would otherwise be read as an identifier.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
types
array of strings
required

Reason kinds to load (one tab = one kind).

types*
Allowed:
string

Filters by localized content, case and accent insensitive. A matching reason keeps its ancestors, so the branch still reads as a tree.

enabled
array of booleans

Empty = both.

enabled
freeShipping
array of booleans

Free shipping.

freeShipping
assessable
array of booleans

Assessable.

assessable
allowCustomerImage
array of booleans
allowCustomerImage
requireCustomerImage
array of booleans
requireCustomerImage
allowCustomerInfo
array of booleans
allowCustomerInfo
requireCustomerInfo
array of booleans
requireCustomerInfo
isExclusive
array of booleans

Exclusive by products, categories or orders (any of the three).

isExclusive
exclusiveBy
array of strings

Exclusive by ANY of these axes (none = exclusive by none of them).

exclusiveBy
Allowed:
product
array of booleans

Tied to a specific product (true) or not (false).

product
productExchange
array of booleans

Tied to a specific exchange variant (true) or not (false).

productExchange
category
array of booleans

Tied to at least one category (true) or to none (false).

category
order
array of booleans

Tied to at least one order (true) or to none (false).

order
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json