Cart Created Notifications

History of changes

Change tag	Change description	Change date
IAP-28135	Cart creation notification created	07.05.2026

You can receive notifications when shopping cart was created.

List of fields

The notification payload will include a 'cart' object containing the following details:

Name	Description	R/O
subject	For cart notifications the subject is cart	R
type	Now we have only one type=created	R
objectId	Cart unique identifier	R
eventDate	Date in ISO 8601 format	R
cart {object}	Cart object	R
cart.id	Cart unique identifier	R
cart.storeId	Store id from the cart	R
cart.creationDate	The date when cart was created	R
cart.products []{object}	List of products in cart	R
cart.products[].publisherRefId	A unique ID for identifying your product in your information system, if defined	O
cart.products[].id	Unique ID for a product in the cart	R
cart.products[].parentId	Product parent ID (Unique ID of parent product in Monetize)	R
cart.products[].businessSegment	Product business segment: b2c, b2b, STRICT b2b or STRICT b2	R
cart.products[].subscriptionTemplate	Subscription template name in Monetize	O
cart.products[].fulfillmentTemplate	Fulfillment template ID in Monetize	O
cart.products[].trial	Boolean indicating if product is trial	R
cart.products[].gift	Boolean indicating if product is gift	R
cart.products[].taxExempt	Boolean indicating if product has tax exemption	R
cart.products[].pricing {object}	Price object	R
cart.products[].pricing.unitPriceExclVAT	Product unit price, excluding sales tax	R
cart.products[].pricing.unitPriceIncVAT	Product unit price, including sales tax	R
cart.products[].pricing.vatAmount	Vat amount	O
cart.products[].pricing.vatRate	Sold product applied sales tax rate	R
cart.products[].pricing.cumulatedDiscountRate	Discount rate applied to product	O
cart.products[].pricing.allDiscountsApplied [{object}]	Array of all applied discounts. Each discount represneted as object	O
cart.products[].pricing.allDiscountsApplied[].discountRate	Discount rate, f.e. 0.2	O
cart.products[].pricing.allDiscountsApplied[].discountId	Identifier of discount in Monetize	R
cart.products[].pricing.allDiscountsApplied[].discountCode	Discount code (if any)	O
cart.products[].pricing.allDiscountsApplied[].discountAmount	Amount of discount	O
cart.products[].discountPlan {object}	Subscription discount plan node will exist in case if discount plan is applied to subscription	O
cart.products[].discountPlan.tag	Subscription discount plan tag	R
cart.products[].discountPlan.discountStep	Subscription discount plan step is used on acquisition	R
cart.products[].discountPlan.ignorePurchaseDiscount	Only in case if this flag was set on acquisition	O
cart.products[].extraTermBonus {object}	Extra term bonus node will exist in case if Extra term bonus is applied to product	O
cart.products[].extraTermBonus.extraTermBonusTag	Extra term bonus tag	R
cart.products[].extraTermBonus.value	Number of extra term bonus units	R
cart.products[].extraTermBonus.unit	Extra term bonus unit: "months" or "days"	R
cart.products[].upsell	Boolean indicating if product was upsold or not	R
cart.products[].quantity	Product quantity	R
cart.products[].name	Product name	R
cart.products[].subscriptionProduct	Boolean indicating if product is sold by subscription model	R
cart.products[].productFamily	Product family name	O
cart.products[].expirationDate	Product license expiration date, if exists	O
cart.locale	Cart locale	R
cart.country	Cart country	R
cart.price {object}	Cart price object	R
cart.price.currency	Cart price currency	R
cart.price.netPrice	Total price of a cart, excluding sales tax	R
cart.price.grossPrice	Total price of a cart, including sales tax	R
cart.customer {object}	Customer object	R
cart.customer.customerId	Customer id associated to the cart	R
cart.customer.customerAccount	Customer realm name associated to the cart	R
cart.customer.serveur	Customer name associated to the cart	R
cart.externalContext	Based64 encoded string of cart parameters	O
cart.decodedExternalContext	Decoded map of cart string parameters if they were provided in the json format	O
cart.source	Cart source: PURCHASE, SUBSCRIPTION, OFFER, MANUAL_RENEWAL, etc	R
cart.scenario	Cart scenario: acquisition, retention, etc	O

If you need to get additional data, which is not available in the event, please refer to the REST API methods to get cart or other entities.

Example

{
  "subject": "cart",
  "type": "created",
  "objectId": "cart-123456",
  "eventDate": "2026-05-27T14:30:00Z",
  "cart": {
    "id": "cart-123456",
    "storeId": "store-001",
    "creationDate": "2026-05-27T14:25:00Z",

    "products": [
      {
        "publisherRefId": "ERP-987654",
        "id": "product-001",
        "parentId": "parent-product-001",
        "businessSegment": "b2c",
        "fulfillmentTemplate": "template-001",
        "trial": false,
        "gift": false,
        "taxExempt": false,

        "pricing": {
          "unitPriceExclVAT": 100.00,
          "unitPriceIncVAT": 120.00,
          "vatAmount": 20.00,
		      "vatRate": 0.20,
          "cumulatedDiscountRate": 0.15,

          "allDiscountsApplied": [
            {
              "discountRate": 0.10,
              "discountId": "discount-001",
              "discountCode": "WELCOME10",
              "discountAmount": 10.00
            }
          ],
        },

        "discountPlan": {
          "tag": "SUMMER2026",
          "discountStep": 1,
          "ignorePurchaseDiscount": false
        },

        "extraTermBonus": {
          "extraTermBonusTag": "BONUS3M",
          "value": 3,
          "unit": "months"
        },

        "upsell": false,
        "quantity": 1,
        "name": "Premium Subscription",
        "subscriptionProduct": true,
        "productFamily": "Subscriptions",
        "expirationDate": "2027-05-27T00:00:00Z"
      }
    ],

    "locale": "en-US",
    "country": "US",

    "price": {
      "currency": "USD",
      "netPrice": 100.00,
      "grossPrice": 120.00
    },

    "customer": {
      "customerId": "customer-001",
      "customerAccount": "acme-corp",
      "serveur": "John Doe"
    },

    "externalContext": "eyJjaGFubmVsIjoid2ViIn0=",

    "decodedExternalContext": {
      "channel": "web"
    },

    "source": "PURCHASE",
    "scenario": "acquisition"
  }
}