POST
/
price-engine
/
actions
/
evaluate-cart
curl --request POST \
  --url https://api.fabric.inc/v3/price-engine/actions/evaluate-cart \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "customer": {
    "id": "5e2cfb9b45570b000864c4b5",
    "segments": [
      {
        "name": "category",
        "value": [
          "GOLD",
          "YELLOW"
        ]
      },
      {
        "name": "ageGroup",
        "value": [
          "elderly"
        ]
      }
    ]
  },
  "couponCodes": [
    "SUPERCOUPON1"
  ],
  "cartItems": [
    {
      "itemId": 1730902008,
      "position": 1,
      "sku": "16B2GS8LD5FDS",
      "productAttributes": [
        {
          "attributeId": "60c2a358eb2ec30008ae70a1",
          "name": "gift wrapping (small)",
          "description": "Gift wrapping for a small package",
          "mapping": "ITEM",
          "type": "GIFT",
          "value": "true",
          "price": 10,
          "level": "order"
        }
      ],
      "quantity": 15,
      "priceListId": 108674,
      "price": {
        "sale": 1000.15,
        "cost": 900.15,
        "base": 2000.15,
        "unitPriceWithoutDiscounts": 2000.15,
        "lineTotalWithoutDiscounts": 2000.15,
        "lineTotalWithDiscounts": 2000.15,
        "type": "BASE"
      },
      "groups": [
        "61d38e117162b7dba69c3d6d"
      ],
      "attributes": {
        "productFamily": "Laptop computers"
      },
      "shippingDetails": {
        "shippingCost": 150.25,
        "shippingMethodId": "dfsae-2d32113-32lpdd",
        "shippingDiscount": 150.25,
        "shippingMethodName": "Express Delivery"
      },
      "productCollections": [
        "5e2cfb9b45570b000863c4b5"
      ]
    }
  ],
  "locale": "en-US"
}'
{
  "cartItems": [
    {
      "itemId": 1730902008,
      "position": 1,
      "sku": "16B2GS8LD5FDS",
      "productAttributes": [
        {
          "attributeId": "60c2a358eb2ec30008ae70a1",
          "name": "gift wrapping (small)",
          "description": "Gift wrapping for a small package",
          "mapping": "ITEM",
          "type": "GIFT",
          "value": "true",
          "price": 10,
          "level": "order"
        }
      ],
      "quantity": 15,
      "priceListId": 108674,
      "price": {
        "sale": 1000.15,
        "cost": 900.15,
        "base": 2000.15,
        "unitPriceWithoutDiscounts": 2000.15,
        "lineTotalWithoutDiscounts": 2000.15,
        "lineTotalWithDiscounts": 2000.15,
        "type": "BASE"
      },
      "groups": [
        "61d38e117162b7dba69c3d6d"
      ],
      "attributes": {
        "productFamily": "Laptop computers"
      },
      "shippingDetails": {
        "shippingCost": 150.25,
        "shippingMethodId": "dfsae-2d32113-32lpdd",
        "shippingDiscount": 150.25,
        "shippingMethodName": "Express Delivery"
      },
      "discounts": [
        {
          "amount": 100.15,
          "quantity": 1,
          "proratedAmount": 100.15,
          "proratedQuantity": 1,
          "application": 1,
          "promotion": {
            "id": "6197ec46e836ff000952d668",
            "value": 2000.15,
            "groupId": "61a6354d0d70e30009415f16",
            "level": 1,
            "isStackable": true,
            "isAlwaysApplied": true,
            "name": "20% OFF",
            "type": "Coupon",
            "discountType": "AMOUNT_OFF",
            "stackingType": "STACKABLE"
          }
        }
      ],
      "priceAttributes": {
        "floor": 1000.15,
        "cost": 900.15,
        "clearance": 2000.15
      },
      "productCollections": [
        "5e2cfb9b45570b000863c4b5"
      ]
    }
  ],
  "errors": [
    "Parameter doesn't exist"
  ],
  "appliedDiscounts": [
    {
      "promotionId": "6197ec46e836ff000952c665",
      "promotionName": "Buy shoes get socks for free",
      "couponCode": "SUPERCOUPON20",
      "type": "COUPON",
      "amount": 105.15,
      "discountScope": "SKU",
      "discountType": "AMOUNT_OFF",
      "value": 10
    }
  ],
  "suggestedProducts": [
    {
      "promotionId": "6197ec46e836ff000952c665",
      "promotionName": "Buy shoes get socks for free",
      "itemId": 234343,
      "itemIds": [
        1120201,
        1120202
      ],
      "sku": "SHOE1234",
      "skus": [
        "SHOE-1",
        "SHOE-2"
      ],
      "eligiblePriceLists": [
        10000
      ],
      "quantity": 2,
      "promotionQuantity": 10,
      "isFree": true,
      "discountType": "PERCENTAGE_OFF",
      "amount": 105.15
    }
  ],
  "notAppliedCoupons": [
    {
      "couponCode": "SUPERCOUPON",
      "promotionId": "624b5aa2a8fd12000965dfdc",
      "message": "Invalid coupon"
    }
  ],
  "promotionMessages": [
    {
      "title": "Buy 2 get 1 free",
      "message": "Offer valid at participating stores through September 5, 2023.",
      "pages": [
        "PDP"
      ],
      "locales": [
        "en-CA"
      ],
      "type": "DISCOUNT",
      "threshold": 2,
      "promoId": "61df12345678900009b7091c"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-fabric-tenant-id
string
required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

Required string length: 24
​
x-fabric-date
string

The Date and time, in ISO 8601 format, for which the evaluation should be done. The prices and promotions that are active on this date will be considered for evaluation.

Example:

"2022-09-06T14:07:17.000Z"

​
x-fabric-request-id
string

A unique request ID.

Example:

"263e731c-45c8-11ed-b878-0242ac120002"

​
x-fabric-channel-id
string

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

Example:

"12"

Body

application/json

A sample cart evaluation request.

Response

200
application/json

OK

The response of the evaluation request of the cart promotion.