Calculate - Mircate

This API endpoint allows you to calculate promotions based on the cart information of an order. The calculate method calculates and returns the promotions that are applicable to the given order's cart.

The API responds with a list of promotions that are applicable to the given cart.

Data Structure for Customers Using Both Loyalty and Promotions
The data structure for customers using both loyalty and promotions should be formatted as follows:

Note: The values for object arrays such as subOrders, condiments, items, etc., should not contain nested objects. In other words, there should be no second-level objects within these arrays. Data in array format should only consist of primitive types like string[], number[], etc.

{
  // Object arrays (like subOrders, items, condiments, etc.) should be single-level.
  "subOrders": [
    {
      "subOrderId": "1",
      "id": "33047",
      "price": 108,
      // Extra product attributes should be sent directly in the subOrder, without adding another level, such as "attributes".
      "brand": "Ulker",
      "name": "Ulker Napoliten Milk Chocolate",
      "categories": [
          "snacks",
          "chocolate"
      ]
    },
    {
      "subOrderId": "2",
      "id": "43047",
      "price": 110,
      // Extra attributes can be sent directly within the subOrder like this.
      "brand": "Starbucks",
      "name": "Starbucks Cafe Latte",
      "categories": [
          "drinks",
          "coffee"
      ]
    }
  ],
  "condiments": [
    {
      "subOrderId": "2",
      "id": "10002",
      "name": "Caramel",
      "price": 12,
      "type": "condiment"
    }
  ]
}

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Header Params

Body Params application/json

Example

{
    "cart": {
        "items": [
            {
                "merchantId": "string",
                "id": "string",
                "qty": 0,
                "attributes": {
                    "shortName": "string",
                    "longName": "string",
                    "brand": "string",
                    "categories": [
                        {
                            "id": "string",
                            "name": "string"
                        }
                    ],
                    "images": [
                        "string"
                    ],
                    "productLimit": 0,
                    "logisticTags": [],
                    "etiketler": [
                        "string"
                    ]
                },
                "price": 0,
                "totalPrice": 0,
                "itemType": "string"
            }
        ],
        "subOrders": [
            {
                "merchantId": "string",
                "subOrderId": "string",
                "id": "string",
                "price": 0,
                "itemType": "string"
            }
        ],
        "productCount": 0
    },
    "couponId": "string",
    "user": {
        "userId": "string"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Successful response

Body

Example

{
    "cart": {
        "items": [
            {
                "merchantId": "string",
                "id": "string",
                "qty": 0,
                "attributes": {
                    "shortName": "string",
                    "longName": "string",
                    "brand": "string",
                    "categories": [
                        {
                            "id": "string",
                            "name": "string"
                        }
                    ],
                    "images": [
                        "string"
                    ],
                    "productLimit": 0,
                    "logisticTags": [
                        {}
                    ],
                    "etiketler": [
                        "string"
                    ]
                },
                "price": 0,
                "totalPrice": 0,
                "itemType": "string",
                "promotionDiscount": 0,
                "priceAfterPromotion": 0,
                "appliedPromotions": [
                    {
                        "id": "string",
                        "promotionTemplateId": "string",
                        "giftAmount": 0
                    }
                ],
                "totalPromotionDiscount": 0,
                "totalPriceAfterPromotion": 0,
                "totalDisplayPrice": 0
            }
        ],
        "subOrders": [
            {
                "merchantId": "string",
                "subOrderId": "string",
                "id": "string",
                "price": 0,
                "itemType": "string",
                "priceAfterPromotion": 0,
                "displayPrice": 0,
                "promotionDiscount": 0,
                "appliedPromotions": [
                    {
                        "id": "string",
                        "promotionTemplateId": "string",
                        "giftAmount": 0
                    }
                ],
                "usedPoints": 0,
                "usedPointAsMoney": 0,
                "priceAfterPointUsed": 0,
                "usablePoints": 0,
                "usablePointAsMoney": 0,
                "pointMultiplier": 0
            }
        ],
        "productCount": 0,
        "appliedPromotions": [
            {
                "id": "string",
                "promotionTemplateId": "string",
                "giftAmount": 0,
                "tag": "string",
                "promotionType": "string",
                "userMessage": "string"
            }
        ],
        "suggestionPromotions": [
            {
                "id": "string",
                "userMessage": "string",
                "suggestion": "string",
                "additionalData": {}
            }
        ],
        "totalCartPriceAfterPromotion": 0,
        "totalCartPromotionDiscount": 0,
        "userBalance": 0,
        "totalPriceAfterPointUsed": 0,
        "totalUsablePoints": 0,
        "totalUsablePointAsMoney": 0,
        "totalUsedPoints": 0,
        "totalUsedPointAsMoney": 0,
        "totalPriceToPay": 0
    },
    "calculationTime": 0
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found