Get reason details

Get details for the reason.

get

/tenants/{tenantUid}/reasons/{reasonUid}

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

reasonUidstringRequired

Reference to a reason.

Pattern: ^[A-Za-z0-9-_]+

Responses

200

Reason response

application/json

codestringRequired

createdAtstring · date-timeOptional

descriptionstringRequired

lastModifiedAtstring · date-timeOptional

reasonUidstringRequiredPattern: ^[A-Za-z0-9-_]+

requiresReferencebooleanRequired

Requires that a reference is filled when using this reason (discountReference, returnReference, or reference)

typestring · enumRequired

ENUM	Description
DISCOUNT	Reason for discounts
RETURN	Reason for returns
RMA	Reason for return to supplier

Possible values:

get/tenants/{tenantUid}/reasons/{reasonUid}

GET /v2/tenants/{tenantUid}/reasons/{reasonUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Reason response

{
  "code": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "description": "text",
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "reasonUid": "text",
  "requiresReference": true,
  "type": "DISCOUNT"
}