Compensation
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+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 |
Example response
GET /v2/tenants/{tenantUid}/compensations HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"name": "text",
"code": "text",
"compensationUid": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+Example response
^[A-Za-z0-9-_]+POST /v2/tenants/{tenantUid}/compensations HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 54
{
"name": "text",
"code": "text",
"compensationUid": "text"
}Example response
{
"name": "text",
"code": "text",
"compensationUid": "text"
}Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a compensation.
^[A-Za-z0-9-_]+Example response
^[A-Za-z0-9-_]+GET /v2/tenants/{tenantUid}/compensations/{compensationUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"name": "text",
"code": "text",
"compensationUid": "text"
}Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a compensation.
^[A-Za-z0-9-_]+When an order is marked with a compensation with this field set to true, the order must have order lines referring to a settled sale
Example response
^[A-Za-z0-9-_]+PUT /v2/tenants/{tenantUid}/compensations/{compensationUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 63
{
"name": "text",
"code": "text",
"RequireReferringOrderLines": true
}Example response
{
"name": "text",
"code": "text",
"compensationUid": "text"
}Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a compensation.
^[A-Za-z0-9-_]+No Content
No content
DELETE /v2/tenants/{tenantUid}/compensations/{compensationUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a compensation.
^[A-Za-z0-9-_]+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 |
Example response
GET /v2/tenants/{tenantUid}/compensations/{compensationUid}/reasons HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"reason": "text",
"code": "text",
"productUid": "text",
"limit": 1,
"requireDocumentation": true,
"compensationReasonUid": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a compensation.
^[A-Za-z0-9-_]+productUid refers to the product that is added to an order when this compensation reason is added to the order. limit is the amount of total compensations on an order. Returns a warning if limit is exceeded.
^[A-Za-z0-9-_]*Example response
productUid refers to the product that is added to an order when this compensation reason is added to the order. limit is the amount of total compensations on an order. Returns a warning if limit is exceeded.
^[A-Za-z0-9-_]*POST /v2/tenants/{tenantUid}/compensations/{compensationUid}/reasons HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 120
{
"reason": "text",
"code": "text",
"productUid": "text",
"limit": 1,
"requireDocumentation": true,
"compensationReasonUid": "text"
}Example response
{
"reason": "text",
"code": "text",
"productUid": "text",
"limit": 1,
"requireDocumentation": true,
"compensationReasonUid": "text"
}Get Compensation reason details
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a compensation.
^[A-Za-z0-9-_]+Reference to a compensation reason.
^[A-Za-z0-9-_]+Example response
productUid refers to the product that is added to an order when this compensation reason is added to the order. limit is the amount of total compensations on an order. Returns a warning if limit is exceeded.
^[A-Za-z0-9-_]*GET /v2/tenants/{tenantUid}/compensations/{compensationUid}/reasons/{compensationReasonUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"reason": "text",
"code": "text",
"productUid": "text",
"limit": 1,
"requireDocumentation": true,
"compensationReasonUid": "text"
}Update compensation reason details
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a compensation.
^[A-Za-z0-9-_]+Reference to a compensation reason.
^[A-Za-z0-9-_]+productUid refers to the product that is added to an order when this compensation reason is added to the order. limit is the amount of total compensations on an order. Returns a warning if limit is exceeded.
^[A-Za-z0-9-_]*Example response
productUid refers to the product that is added to an order when this compensation reason is added to the order. limit is the amount of total compensations on an order. Returns a warning if limit is exceeded.
^[A-Za-z0-9-_]*PUT /v2/tenants/{tenantUid}/compensations/{compensationUid}/reasons/{compensationReasonUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 89
{
"reason": "text",
"code": "text",
"productUid": "text",
"limit": 1,
"requireDocumentation": true
}Example response
{
"reason": "text",
"code": "text",
"productUid": "text",
"limit": 1,
"requireDocumentation": true,
"compensationReasonUid": "text"
}Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a compensation.
^[A-Za-z0-9-_]+Reference to a compensation reason.
^[A-Za-z0-9-_]+No Content
No content
DELETE /v2/tenants/{tenantUid}/compensations/{compensationUid}/reasons/{compensationReasonUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
Last updated