CLcloudkitchens
manager_loyalty_endpoints

Compute applicable rewards

Supply both userId and order to get a list of applicable rewards for an order. Supply only userId to get a list of rewards the user can redeem Rate limit: 8 requests per minute.

post/manager/loyalty/v1/{source}/rewards/evaluate

Request

Path parameters

sourcestring required

Loyalty provider source

Example:css-loyalty

Headers

X-Store-Idstring required

The unique identifier of the store in your app. This ID, along with the Application ID, will be used to match the correct store when performing operations. It cannot be longer than 255 characters and must only contain printable ASCII characters. During on-boarding, this ID will be similar to onboarding:905bb725-b141-4a9b-832a-1f254f772c94 (where the UUID is the Internal Store ID). During off-boarding, this field will be filled with the last known Store ID, or with an empty string, in case none is found. In that case, please fall back to the provided internalStoreId (a.k.a. Sku-Sku ID).

Example:partner-store-unique-identifier

Request body

userIdstring required

The id of the user.

Example request

{
  "userId": "someidstring",
  "order": {
    "id": "someidstring",
    "currencyCode": "USD",
    "items": [
      {
        "id": "someidstring",
        "displayName": "Cheese Burger",
        "quantity": 1,
        "price": 19.07
      }
    ],
    "totals": {
      "subTotal": 29.07,
      "tax": 10,
      "discount": 9.07,
      "total": 30
    }
  }
}

Response

Compute applicable rewards response.

Example response

{
  "rewards": [
    {
      "id": "someidstring",
      "type": "SUBTOTAL",
      "cost": 20,
      "costType": "POINT",
      "trigger": {
        "menus": [
          {
            "entityId": "someidstring",
            "entityType": "ITEM",
            "minimumPurchaseQuantity": 1
          }
        ]
      },
      "subtotal": {
        "amount": 20,
        "type": "ABSOLUTE_DISCOUNT"
      },
      "menus": [
        {
          "entityId": "someidstring",
          "amount": 20,
          "type": "ABSOLUTE_DISCOUNT"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.