Reasons
Reasons
List all reasons.
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+| ENUM | Description |
|---|---|
| DISCOUNT | Reason for discounts |
| RETURN | Reason for returns |
| RMA | Reason for return to supplier |
Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Reason list response
GET /v2/tenants/{tenantUid}/reasons HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Reason list response
{
"items": [
{
"code": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"description": "text",
"lastModifiedAt": "2026-01-01T00:00:00.000Z",
"reasonUid": "text",
"requiresReference": true,
"type": "DISCOUNT"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Create new reason
Required permissions: REASON
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+| ENUM | Description |
|---|---|
| DISCOUNT | Reason for discounts |
| RETURN | Reason for returns |
| RMA | Reason for return to supplier |
Requires that a discountReference is filled when using this reason
^[A-Za-z0-9-_]+Reason response
^[A-Za-z0-9-_]+Requires that a discountReference is filled when using this reason
| ENUM | Description |
|---|---|
| DISCOUNT | Reason for discounts |
| RETURN | Reason for returns |
| RMA | Reason for return to supplier |
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"
}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"
}Get details for the reason.
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a reason.
^[A-Za-z0-9-_]+Reason response
^[A-Za-z0-9-_]+Requires that a discountReference is filled when using this reason
| ENUM | Description |
|---|---|
| DISCOUNT | Reason for discounts |
| RETURN | Reason for returns |
| RMA | Reason for return to supplier |
GET /v2/tenants/{tenantUid}/reasons/{reasonUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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"
}Update details of the reason.
Required permissions: REASON
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a reason.
^[A-Za-z0-9-_]+Requires that a discountReference is filled when using this reason
Reason response
^[A-Za-z0-9-_]+Requires that a discountReference is filled when using this reason
| ENUM | Description |
|---|---|
| DISCOUNT | Reason for discounts |
| RETURN | Reason for returns |
| RMA | Reason for return to supplier |
PUT /v2/tenants/{tenantUid}/reasons/{reasonUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61
{
"code": "text",
"description": "text",
"requiresReference": true
}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"
}Delete a reason.
Required permissions: REASON
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a reason.
^[A-Za-z0-9-_]+No Content
No content
DELETE /v2/tenants/{tenantUid}/reasons/{reasonUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
Last updated