Basket

Payloads for available basket events

Basket Submitted

The basket-submitted event is triggered when someone submits a basket.

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"
    }
  ],
  "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
    }
  ]
}