Compensation

Compensation

List compensations

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/compensations

List compensations

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Query parameters

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

Possible values:

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/compensations

HTTPcURLJavaScriptPython

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

200

Example response

{
  "items": [
    {
      "name": "text",
      "code": "text",
      "compensationUid": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Add new Compensation

post

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/compensations

Add new Compensation

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Body

application/json

namestringRequired

codestringRequired

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

Responses

201

Example response

application/json

post

/tenants/{tenantUid}/compensations

HTTPcURLJavaScriptPython

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"
}

201

Example response

{
  "name": "text",
  "code": "text",
  "compensationUid": "text"
}

Get compensation details

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/compensations/{compensationUid}

Get compensation details

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

compensationUidstringRequired

Reference to a compensation.

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

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/compensations/{compensationUid}

HTTPcURLJavaScriptPython

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

200

Example response

{
  "name": "text",
  "code": "text",
  "compensationUid": "text"
}

Update compensation details

put

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/compensations/{compensationUid}

Update compensation details

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

compensationUidstringRequired

Reference to a compensation.

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

Body

application/json

namestringOptional

codestringOptional

RequireReferringOrderLinesbooleanOptional

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

Responses

200

Example response

application/json

put

/tenants/{tenantUid}/compensations/{compensationUid}

HTTPcURLJavaScriptPython

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
}

200

Example response

{
  "name": "text",
  "code": "text",
  "compensationUid": "text"
}

Delete a compensation

delete

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/compensations/{compensationUid}

Delete a compensation

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

compensationUidstringRequired

Reference to a compensation.

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

Responses

204

No Content

delete

/tenants/{tenantUid}/compensations/{compensationUid}

HTTPcURLJavaScriptPython

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

204

No Content

No content

List Compensation reasons

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/compensations/{compensationUid}/reasons

List Compensation reasons

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

compensationUidstringRequired

Reference to a compensation.

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

Query parameters

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

Possible values:

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/compensations/{compensationUid}/reasons

HTTPcURLJavaScriptPython

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

200

Example response

{
  "items": [
    {
      "reason": "text",
      "code": "text",
      "productUid": "text",
      "limit": 1,
      "requireDocumentation": true,
      "compensationReasonUid": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Add a compensation reason

post

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/compensations/{compensationUid}/reasons

Add a compensation reason

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

compensationUidstringRequired

Reference to a compensation.

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

Body

application/json

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.

reasonstringRequired

codestringRequired

productUidstringRequiredPattern: ^[A-Za-z0-9-_]*

limitintegerRequired

requireDocumentationbooleanRequired

compensationReasonUidstringOptional

Responses

201

Example response

application/json

post

/tenants/{tenantUid}/compensations/{compensationUid}/reasons

HTTPcURLJavaScriptPython

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"
}

201

Example response

{
  "reason": "text",
  "code": "text",
  "productUid": "text",
  "limit": 1,
  "requireDocumentation": true,
  "compensationReasonUid": "text"
}

Get Compensation reason details

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/compensations/{compensationUid}/reasons/{compensationReasonUid}

Get Compensation reason details

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

compensationUidstringRequired

Reference to a compensation.

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

compensationReasonUidstringRequired

Reference to a compensation reason.

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

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/compensations/{compensationUid}/reasons/{compensationReasonUid}

HTTPcURLJavaScriptPython

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

200

Example response

{
  "reason": "text",
  "code": "text",
  "productUid": "text",
  "limit": 1,
  "requireDocumentation": true,
  "compensationReasonUid": "text"
}

Update compensation reason details

put

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/compensations/{compensationUid}/reasons/{compensationReasonUid}

Update compensation reason details

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

compensationUidstringRequired

Reference to a compensation.

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

compensationReasonUidstringRequired

Reference to a compensation reason.

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

Body

application/json

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.

reasonstringOptional

codestringOptional

productUidstringOptionalPattern: ^[A-Za-z0-9-_]*

limitintegerOptional

requireDocumentationbooleanOptional

Responses

201

Example response

application/json

put

/tenants/{tenantUid}/compensations/{compensationUid}/reasons/{compensationReasonUid}

HTTPcURLJavaScriptPython

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
}

201

Example response

{
  "reason": "text",
  "code": "text",
  "productUid": "text",
  "limit": 1,
  "requireDocumentation": true,
  "compensationReasonUid": "text"
}

Delete a Compensation reason

delete

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/compensations/{compensationUid}/reasons/{compensationReasonUid}

Delete a Compensation reason

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

compensationUidstringRequired

Reference to a compensation.

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

compensationReasonUidstringRequired

Reference to a compensation reason.

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

Responses

204

No Content

delete

/tenants/{tenantUid}/compensations/{compensationUid}/reasons/{compensationReasonUid}

HTTPcURLJavaScriptPython

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

204

No Content

No content