Basket

Payloads for available basket events.

Basket Submitted

The basket-submitted event is triggered when someone submits a basket. The payload contains the full order snapshot at the time of submission — all line items with their configured products, the submitter's contact details, any custom fields collected during checkout, applied pricing rules, and a link to the generated PDF.

This is the richest source of order data available via webhooks. Use it to feed submitted orders into your ERP, trigger fulfilment workflows, or archive order records in an external system.

tip

The browser-side mimeeq-basket-submitted event only carries the cartId and referenceCode. If you need full order details server-side, this webhook is the way to get them.

Payload example

{
  "id": "CART-40e54c8a-4ce4-4c32-a299-669c6fc301cb",
  "customerId": "CUST-c62ee8d8-ad02-464f-a322-10847d9984b2",
  "status": "SUBMITTED",
  "referenceCode": "OARTWSTS",
  "items": [
    {
      "cartItemId": "ITEM-00067907-b445-40da-b40b-f69e9df0fba3",
      "productId": "PROD-7e042c5b-ead6-4e54-b0bb-827b581df5a0",
      "productName": "Product Name",
      "quantity": 5,
      "variantCode": "PPRFX=Fabric-d10&CastorsandGlides-a4&Colour-a2",
      "shortCode": "GW0NQZ",
      "image": "https://example.com/image.jpg",
      "specification": {
        "Fabric": "ONE-35",
        "Castors and Glides": "Soft Castors",
        "Colour": "Black"
      },
      "sku": "SKU-123456",
      "isModular": false,
      "note": "This is a note",
      "link": "https://example.com/product",
      "price": 100,
      "unitPrice": 20,
      "currency": "USD",
      "templateId": "Basket"
    }
  ],
  "submitter": {
    "fullName": "John Doe",
    "email": "[email protected]",
    "language": "en",
    "phone": "123-456-7890",
    "companyName": "Example Company",
    "address": "123 Example Street",
    "notes": "This is a note"
  },
  "customFields": {
    "customField1": "value1",
    "customField2": "value2"
  },
  "priceModifiers": [
    {
      "name": {
        "en": "Partner discount"
      },
      "description": {
        "en": "Discount above £100"
      },
      "mode": "PERCENTAGE",
      "type": "DISCOUNT",
      "modifierValue": 10,
      "calculatedValue": -50
    },
    {
      "name": {
        "en": "Delivery charge"
      },
      "description": {
        "en": "Delivery charge is 10£"
      },
      "mode": "FIXED",
      "type": "ADDITION",
      "modifierValue": 10,
      "calculatedValue": 10
    }
  ],
  "pdfUrl": "https://cdn.example.com/webhooks/cart/pdf/OARTWSTS_R.pdf",
  "submitterPdfUrl": "https://cdn.example.com/webhooks/cart/pdf/OARTWSTS_S.pdf"
}

Payload fields

Root

Field	Type	Description
id	string	Basket identifier (e.g., "CART-...")
customerId	string	Mimeeq customer (tenant) identifier
status	string	Basket status at time of delivery — "SUBMITTED" for completed orders, "OPEN" if still active
referenceCode	string	Human-readable order reference code (e.g., "OARTWSTS"). Can be used to look up the order in the admin panel
items	CartItem[]	Array of configured products in the basket
submitter	Submitter | undefined	Contact details collected during checkout. Absent if the basket was submitted without a form (e.g., auto-submit)
customFields	object | undefined	Key-value pairs of custom fields collected during checkout
priceModifiers	PriceModifier[]	Pricing rules applied to this basket — discounts and surcharges
pdfUrl	string | null	URL pointing to the generated PDF summary of the submitted basket (translated to the customer default language). null if PDF generation is not enabled or failed
submitterPdfUrl	string | null	URL pointing to the generated PDF summary of the submitted basket (translated to the submitter's language). null if PDF generation is not enabled or failed

CartItem

Field	Type	Description
cartItemId	string	Unique identifier for this line item
productId	string	The Mimeeq product identifier
productName	string	Display name of the product
quantity	number	Number of units ordered
variantCode	string	The full variant code representing the selected configuration
shortCode	string	Short code that can be used to recreate this exact configuration in the configurator
image	string | null	CDN URL of the product image for this configuration. null if no image is available
specification	Record<string, string>	Human-readable map of option block names to selected option labels (e.g., { "Fabric": "ONE-35" })
sku	string	SKU for the configured variant, as defined in the product setup
isModular	boolean	Whether this item is a modular product configuration
note	string | null	Optional note added by the customer for this line item
link	string	URL to the product configurator page
price	number	Total price for this line item (unit price × quantity)
unitPrice	number	Price per single unit
currency	string | null	Currency code (e.g., "USD", "EUR"). null if pricing is not configured
templateId	string | null	The embed template identifier used when this item was added to the basket. null if not available

Submitter

Field	Type	Description
fullName	string	Submitter's full name
email	string	Submitter's email address
language	string	Language code for the submission (e.g., "en")
phone	string | null	Phone number, if provided
companyName	string | null	Company name, if provided
address	string | null	Address, if provided
notes	string | null	Additional notes from the submitter

PriceModifier

Field	Type	Description
name	Record<string, string>	Localised name of the pricing rule (keyed by language code)
description	Record<string, string>	Localised description of the pricing rule
mode	string	How the modifier is calculated — "PERCENTAGE" or "FIXED"
type	string	Whether this is a "DISCOUNT" (reduces total) or "ADDITION" (increases total)
modifierValue	number	The configured rule value (e.g., 10 for a 10% discount or a £10 fixed charge)
calculatedValue	number	The actual amount applied to this basket. Negative for discounts, positive for additions