Skip to content
Products
/
/
/
RE01 - List reasons

RE01 - List reasons

Request

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
Read More
Localization

This resource supports locale parameter (see documentation)

Localized output fields will be highlighted with an icon:

Security
Shop-API-Key(Required scopes: ROLE_SHOP_ADMINROLE_PARTNER_ORDER_SETTINGS_READ)
Query
shop_idinteger, (int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

curl -i -X GET \
  'https://your-instance.mirakl.net/api/reasons?shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

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": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}