OrderDiscount

OrderDiscount

List order discounts

get

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

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/discounts

List order discounts

Required permissions: SALES_ORDER,RETURN_ORDER

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

orderUidstringRequired

Reference to an Order.

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

Responses

200

Example response

application/json

get/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/discounts

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/discounts HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "orderDiscountUid": "text",
      "discountCode": "text",
      "type": "PERCENTAGE",
      "amount": 1,
      "name": "text",
      "origin": "LOYALTY",
      "validTo": "2026-07-20T06:08:48.279Z",
      "maxUsage": 1,
      "productSkus": [
        "text"
      ],
      "orderItemUids": [
        "text"
      ],
      "externalTransactionId": "text",
      "scope": "WHOLE_ORDER",
      "discountReasonCode": "text",
      "discountReference": "text",
      "createdAt": "2026-07-20T06:08:48.279Z",
      "createdBy": "text",
      "lastModifiedAt": "2026-07-20T06:08:48.279Z",
      "lastModifiedBy": "text",
      "campaignUid": "text"
    }
  ]
}

Add discount to order

post

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

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/discounts

Add discounts to an order.

Required permissions: SALES_ORDER,RETURN_ORDER

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

orderUidstringRequired

Reference to an Order.

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

Body

application/json

discountCodestringOptional

typestring · enumOptionalPossible values:

amountintegerOptional

originstring · enumRequiredPossible values:

namestringOptional

productSkusstring[]Optional

validTostring · date-timeOptional

maxUsageintegerOptional

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

discountReasonCodestringOptional

discountReferencestringOptional

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

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

Responses

201

Example response

application/json

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

discountCodestringRequired

typestring · enumRequiredPossible values:

amountintegerRequired

namestringRequired

originstring · enumRequiredPossible values:

validTostring · date-timeRequired

maxUsageintegerRequired

productSkusstring[]Required

orderItemUidsstring[]Required

externalTransactionIdstringRequired

scopestring · enumRequiredPossible values:

discountReasonCodestringRequired

discountReferencestringRequired

createdAtstring · date-timeRequired

createdBystringRequired

lastModifiedAtstring · date-timeRequired

lastModifiedBystringRequired

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

post/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/discounts

HTTPcURLJavaScriptPython

POST /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/discounts HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 284

{
  "discountCode": "text",
  "type": "PERCENTAGE",
  "amount": 1,
  "origin": "LOYALTY",
  "name": "text",
  "productSkus": [
    "text"
  ],
  "validTo": "2026-07-20T06:08:48.279Z",
  "maxUsage": 1,
  "orderItemUid": "text",
  "discountReasonCode": "text",
  "discountReference": "text",
  "orderDiscountUid": "text",
  "campaignUid": "text"
}

201

Example response

{
  "orderDiscountUid": "text",
  "discountCode": "text",
  "type": "PERCENTAGE",
  "amount": 1,
  "name": "text",
  "origin": "LOYALTY",
  "validTo": "2026-07-20T06:08:48.279Z",
  "maxUsage": 1,
  "productSkus": [
    "text"
  ],
  "orderItemUids": [
    "text"
  ],
  "externalTransactionId": "text",
  "scope": "WHOLE_ORDER",
  "discountReasonCode": "text",
  "discountReference": "text",
  "createdAt": "2026-07-20T06:08:48.279Z",
  "createdBy": "text",
  "lastModifiedAt": "2026-07-20T06:08:48.279Z",
  "lastModifiedBy": "text",
  "campaignUid": "text"
}

Get order discount details

get

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

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/discounts/{orderDiscountUid}

Get order discount details.

Required permissions: SALES_ORDER,RETURN_ORDER

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

orderUidstringRequired

Reference to an Order.

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

orderDiscountUidstringRequired

Reference to an order discount.

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

Responses

200

Example response

application/json

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

discountCodestringRequired

typestring · enumRequiredPossible values:

amountintegerRequired

namestringRequired

originstring · enumRequiredPossible values:

validTostring · date-timeRequired

maxUsageintegerRequired

productSkusstring[]Required

orderItemUidsstring[]Required

externalTransactionIdstringRequired

scopestring · enumRequiredPossible values:

discountReasonCodestringRequired

discountReferencestringRequired

createdAtstring · date-timeRequired

createdBystringRequired

lastModifiedAtstring · date-timeRequired

lastModifiedBystringRequired

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

get/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/discounts/{orderDiscountUid}

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/discounts/{orderDiscountUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "orderDiscountUid": "text",
  "discountCode": "text",
  "type": "PERCENTAGE",
  "amount": 1,
  "name": "text",
  "origin": "LOYALTY",
  "validTo": "2026-07-20T06:08:48.279Z",
  "maxUsage": 1,
  "productSkus": [
    "text"
  ],
  "orderItemUids": [
    "text"
  ],
  "externalTransactionId": "text",
  "scope": "WHOLE_ORDER",
  "discountReasonCode": "text",
  "discountReference": "text",
  "createdAt": "2026-07-20T06:08:48.279Z",
  "createdBy": "text",
  "lastModifiedAt": "2026-07-20T06:08:48.279Z",
  "lastModifiedBy": "text",
  "campaignUid": "text"
}

Update order discount

put

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

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/discounts/{orderDiscountUid}

Update order discount

Required permissions: SALES_ORDER,RETURN_ORDER

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

orderUidstringRequired

Reference to an Order.

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

orderDiscountUidstringRequired

Reference to an order discount.

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

Body

application/json

discountCodestringOptional

typestring · enumOptionalPossible values:

amountintegerOptional

originstring · enumOptionalPossible values:

namestringOptional

productSkusstring[]Optional

validTostring · date-timeOptional

maxUsageintegerOptional

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

discountReasonCodestringOptional

discountReferencestringOptional

Responses

200

Example response

application/json

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

discountCodestringRequired

typestring · enumRequiredPossible values:

amountintegerRequired

namestringRequired

originstring · enumRequiredPossible values:

validTostring · date-timeRequired

maxUsageintegerRequired

productSkusstring[]Required

orderItemUidsstring[]Required

externalTransactionIdstringRequired

scopestring · enumRequiredPossible values:

discountReasonCodestringRequired

discountReferencestringRequired

createdAtstring · date-timeRequired

createdBystringRequired

lastModifiedAtstring · date-timeRequired

lastModifiedBystringRequired

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

put/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/discounts/{orderDiscountUid}

HTTPcURLJavaScriptPython

PUT /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/discounts/{orderDiscountUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 237

{
  "discountCode": "text",
  "type": "PERCENTAGE",
  "amount": 1,
  "origin": "LOYALTY",
  "name": "text",
  "productSkus": [
    "text"
  ],
  "validTo": "2026-07-20T06:08:48.279Z",
  "maxUsage": 1,
  "orderItemUid": "text",
  "discountReasonCode": "text",
  "discountReference": "text"
}

200

Example response

{
  "orderDiscountUid": "text",
  "discountCode": "text",
  "type": "PERCENTAGE",
  "amount": 1,
  "name": "text",
  "origin": "LOYALTY",
  "validTo": "2026-07-20T06:08:48.279Z",
  "maxUsage": 1,
  "productSkus": [
    "text"
  ],
  "orderItemUids": [
    "text"
  ],
  "externalTransactionId": "text",
  "scope": "WHOLE_ORDER",
  "discountReasonCode": "text",
  "discountReference": "text",
  "createdAt": "2026-07-20T06:08:48.279Z",
  "createdBy": "text",
  "lastModifiedAt": "2026-07-20T06:08:48.279Z",
  "lastModifiedBy": "text",
  "campaignUid": "text"
}

Delete order discount

delete

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

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/discounts/{orderDiscountUid}

Delete order discount.

Required permissions: SALES_ORDER,RETURN_ORDER

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

orderUidstringRequired

Reference to an Order.

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

orderDiscountUidstringRequired

Reference to an order discount.

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

Responses

204

No Content

No content

delete/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/discounts/{orderDiscountUid}

HTTPcURLJavaScriptPython

DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/discounts/{orderDiscountUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content

Delete all order discounts with matching discountCode

delete

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

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/discountCode/{discountCode}

Delete all order discounts with matching discountCode

Required permissions: SALES_ORDER,RETURN_ORDER

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

orderUidstringRequired

Reference to an Order.

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

discountCodestringRequired

Reference to a discount code

Responses

204

No Content

No content

delete/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/discountCode/{discountCode}

HTTPcURLJavaScriptPython

DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/discountCode/{discountCode} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content