Reasons

PreviousPurchase NextReceipt

Was this helpful?

Get reason details

get

Get details for the reason.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

reasonUidstringrequired

Reference to a reason.

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

Responses

application/json

objectoptional

get

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": "2025-04-18T01:24:52.172Z",
  "description": "text",
  "lastModifiedAt": "2025-04-18T01:24:52.172Z",
  "reasonUid": "text",
  "type": "DISCOUNT"
}

Delete a reason

delete

Delete a reason.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

reasonUidstringrequired

Reference to a reason.

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

Responses

delete

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

204

No Content

List reasons

get

List all reasons.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

Query parameters

reasonTypestring · enumoptional

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

Available options:

pageNumberintegeroptional

Reference to a specific page in a result set.

pageSizeintegeroptional

The number of items per page in a result set.

sortBystringoptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumoptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Available options:

Responses

application/json

objectoptional

get

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

200

Reason list response

{
  "items": [
    {
      "code": "text",
      "createdAt": "2025-04-18T01:24:52.172Z",
      "description": "text",
      "lastModifiedAt": "2025-04-18T01:24:52.172Z",
      "reasonUid": "text",
      "type": "DISCOUNT"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create new reason

post

Create new reason

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

Body

codestringrequired

descriptionstringrequired

typestring · enumrequired

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

Available options:

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

Responses

application/json

objectoptional

post

POST /v2/tenants/{tenantUid}/reasons HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "code": "text",
  "description": "text",
  "type": "DISCOUNT",
  "reasonUid": "text"
}

200

Reason response

{
  "code": "text",
  "createdAt": "2025-04-18T01:24:52.172Z",
  "description": "text",
  "lastModifiedAt": "2025-04-18T01:24:52.172Z",
  "reasonUid": "text",
  "type": "DISCOUNT"
}

Update reason details

put

Update details of the reason.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

reasonUidstringrequired

Reference to a reason.

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

Body

codestringoptional

descriptionstringoptional

Responses

application/json

objectoptional

put

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: 36

{
  "code": "text",
  "description": "text"
}

200

Reason response

{
  "code": "text",
  "createdAt": "2025-04-18T01:24:52.172Z",
  "description": "text",
  "lastModifiedAt": "2025-04-18T01:24:52.172Z",
  "reasonUid": "text",
  "type": "DISCOUNT"
}