RE02 - List reasons by type

RE02 - List reasons by type
⚠️ No Integration Allowed ⚠️

deprecated

Request

Deprecated endpoint

This API is going to be removed in future update. Consider using RE01.

Description

This API returns cancellation, refund, incident, and message reasons.
Reasons are sorted by 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

Path

reason_typestringrequired

Reason type

Enum:"INCIDENT_OPEN""MPS_INCIDENT_OPEN""INCIDENT_CLOSE""MPS_INCIDENT_CLOSE""REFUND""MPS_REFUND""MESSAGING""ORDER_MESSAGING""MPS_ORDER_MESSAGING""MPS_OFFER_MESSAGING"

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

Responses

OK

Bodyapplication/json

reasonsArray of objectsrequired

List of reasons

total_countinteger, (int32)requireddeprecated

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

Response

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