OrderDiscount

PreviousOrderDelivery NextOrderHandling

Was this helpful?

Get order discount details

get

Get order discount details.

Authorizations

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

application/json

objectoptional

get

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": "2025-04-18T01:27:37.225Z",
  "maxUsage": 1,
  "productSkus": [
    "text"
  ],
  "orderItemUids": [
    "text"
  ],
  "externalTransactionId": "text",
  "scope": "WHOLE_ORDER",
  "discountReasonCode": "text",
  "createdAt": "2025-04-18T01:27:37.225Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-04-18T01:27:37.225Z",
  "lastModifiedBy": "text",
  "campaignUid": "text"
}

Delete order discount

delete

Delete order discount.

Authorizations

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

delete

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

List order discounts

get

List order discounts

Authorizations

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

application/json

objectoptional

get

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": "2025-04-18T01:27:37.225Z",
      "maxUsage": 1,
      "productSkus": [
        "text"
      ],
      "orderItemUids": [
        "text"
      ],
      "externalTransactionId": "text",
      "scope": "WHOLE_ORDER",
      "discountReasonCode": "text",
      "createdAt": "2025-04-18T01:27:37.225Z",
      "createdBy": "text",
      "lastModifiedAt": "2025-04-18T01:27:37.225Z",
      "lastModifiedBy": "text",
      "campaignUid": "text"
    }
  ]
}

Add discount to order

post

Add discounts to an order.

Authorizations

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

discountCodestringoptional

typestring · enumoptionalAvailable options:

amountintegeroptional

originstring · enumrequiredAvailable options:

namestringoptional

productSkusstring[]optional

validTostring · date-timeoptional

maxUsageintegeroptional

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

discountReasonCodestringoptional

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

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

Responses

application/json

objectoptional

post

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

{
  "discountCode": "text",
  "type": "PERCENTAGE",
  "amount": 1,
  "origin": "LOYALTY",
  "name": "text",
  "productSkus": [
    "text"
  ],
  "validTo": "2025-04-18T01:27:37.225Z",
  "maxUsage": 1,
  "orderItemUid": "text",
  "discountReasonCode": "text",
  "orderDiscountUid": "text",
  "campaignUid": "text"
}

201

Example response

{
  "orderDiscountUid": "text",
  "discountCode": "text",
  "type": "PERCENTAGE",
  "amount": 1,
  "name": "text",
  "origin": "LOYALTY",
  "validTo": "2025-04-18T01:27:37.225Z",
  "maxUsage": 1,
  "productSkus": [
    "text"
  ],
  "orderItemUids": [
    "text"
  ],
  "externalTransactionId": "text",
  "scope": "WHOLE_ORDER",
  "discountReasonCode": "text",
  "createdAt": "2025-04-18T01:27:37.225Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-04-18T01:27:37.225Z",
  "lastModifiedBy": "text",
  "campaignUid": "text"
}

Update order discount

put

Update order discount

Authorizations

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

discountCodestringoptional

typestring · enumoptionalAvailable options:

amountintegeroptional

originstring · enumoptionalAvailable options:

namestringoptional

productSkusstring[]optional

validTostring · date-timeoptional

maxUsageintegeroptional

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

discountReasonCodestringoptional

Responses

application/json

objectoptional

put

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

{
  "discountCode": "text",
  "type": "PERCENTAGE",
  "amount": 1,
  "origin": "LOYALTY",
  "name": "text",
  "productSkus": [
    "text"
  ],
  "validTo": "2025-04-18T01:27:37.225Z",
  "maxUsage": 1,
  "orderItemUid": "text",
  "discountReasonCode": "text"
}

200

Example response

{
  "orderDiscountUid": "text",
  "discountCode": "text",
  "type": "PERCENTAGE",
  "amount": 1,
  "name": "text",
  "origin": "LOYALTY",
  "validTo": "2025-04-18T01:27:37.225Z",
  "maxUsage": 1,
  "productSkus": [
    "text"
  ],
  "orderItemUids": [
    "text"
  ],
  "externalTransactionId": "text",
  "scope": "WHOLE_ORDER",
  "discountReasonCode": "text",
  "createdAt": "2025-04-18T01:27:37.225Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-04-18T01:27:37.225Z",
  "lastModifiedBy": "text",
  "campaignUid": "text"
}