For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create new reason

Create new reason

Required permissions: REASON

post
/tenants/{tenantUid}/reasons
Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
codestringRequired
descriptionstringRequired
typestring · enumRequired
ENUMDescription
DISCOUNTReason for discounts
RETURNReason for returns
RMAReason for return to supplier
Possible values:
requiresReferencebooleanOptional

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

reasonUidstringOptionalPattern: ^[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
ENUMDescription
DISCOUNTReason for discounts
RETURNReason for returns
RMAReason for return to supplier
Possible values:
post/tenants/{tenantUid}/reasons
POST /v2/tenants/{tenantUid}/reasons HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "code": "text",
  "description": "text",
  "type": "DISCOUNT",
  "requiresReference": true,
  "reasonUid": "text"
}
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"
}

Last updated

Was this helpful?