RE01 - List reasons

Description

This API returns cancellation, refund, incident, and message reasons.
Reasons are sorted by type then sort index (set in the back-office)

Call Frequency

Recommended usage: Each time a page must display a list of reasons

Maximum usage: Each time a page must display a list of reasons

Localization

This resource supports locale parameter (see documentation)

Localized output fields will be highlighted with an icon:

Security

Operator-Bearer-Token or OAuth-2

curl -i -X GET \
  https://your-instance.mirakl.net/api/reasons \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

OK

Bodyapplication/json

reasonsArray of objectsrequired

List of reasons detailed

total_countinteger, (int32)requireddeprecated

Total count of elements returned by the query (no pagination)

Response

{
  "reasons": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}