For the complete documentation index, see llms.txt. This page is also available as Markdown.

Events - Quote

Webhook events related to the creation, update, and deletion of a quote.

Available events

Event type
Event schema

quote.created

{
  "id": "String",
  "businessModel": "String",
  "restriction": "String",
  "customer": {
    "customerId": "String",
    "firstName": "String",
    "lastName": "String"
  },
  "employee": {
    "employeeId": "String",
    "firstName": "String",
    "lastName": "String"
  },
  "cartId": "String",
  "orderId": "String",
  "siteCode": "String",
  "currency": "String",
  "status": {
    "value": "String",
    "comment": "String",
    "quoteReason": {
      "id": "String",
      "code": "String",
      "message": "Map",
      "type": "String"
    }
  },
  "validTo": "String",
  "totalPrice": {
    "currency": "String",
    "netValue": "Number",
    "grossValue": "Number",
    "taxValue": "Number"
  },
  "subTotalPrice": {
    "currency": "String",
    "netValue": "Number",
    "grossValue": "Number",
    "taxValue": "Number"
  },
  "taxAggregate": {
    "lines": [
      {
        "name": "String",
        "amount": "Number",
        "rate": "Number",
        "taxable": "Number"
      }
    ]
  },
  "shippingCost": {
    "value": "Number",
    "methodId": "String",
    "zoneId": "String",
    "methodName": "String",
    "shippingCode": "String"
  },
  "items": [
    {
      "itemId": "String",
      "quantity": {
        "quantity": "Number",
        "unitCode": "String"
      },
      "price": {
        "currency": "String",
        "priceId": "String",
        "unitPrice": "Number",
        "newUnitPrice": "Number",
        "totalNetValue": "Number",
        "discount": "Number",
        "includesTax": "Boolean",
        "tax": {
          "taxClass": "String",
          "taxRate": "String",
          "prices": {
            "grossValue": "Number",
            "netValue": "Number"
          }
        }
      },
      "product": {
        "productId": "String",
        "name": "String",
        "media": "Map",
        "metadata": "Object",
        "mixins": "Map"
      },
      "metadata": "Object",
      "mixins": "Map"
    }
  ],
  "mixins": "Map",
  "metadata": {
    "version": "Integer",
    "createdAt": "String",
    "modifiedAt": "String",
    "mixins": "Map"
  },
  "comment": {
    "employeeComment": "String"
  },
  "customerReference": "String",
  "customerComment": "String",
  "billingAddress": {
    "id": "String",
    "name": "String",
    "addressLine1": "String",
    "addressLine2": "String",
    "city": "String",
    "countryCode": "String",
    "postcode": "String",
    "state": "String"
  },
  "shippingAddress": {
    "id": "String",
    "name": "String",
    "addressLine1": "String",
    "addressLine2": "String",
    "city": "String",
    "countryCode": "String",
    "postcode": "String",
    "state": "String"
  },
  "company": "String"
}

quote.updated

{
  "previousStatus": "String",
  "businessModel": "String",
  "restriction": "String",
  "id": "String",
  "customer": {
    "customerId": "String",
    "firstName": "String",
    "lastName": "String"
  },
  "employee": {
    "employeeId": "String",
    "firstName": "String",
    "lastName": "String"
  },
  "cartId": "String",
  "orderId": "String",
  "siteCode": "String",
  "currency": "String",
  "status": {
    "value": "String",
    "comment": "String",
    "quoteReason": {
      "id": "String",
      "code": "String",
      "message": "Map",
      "type": "String"
    }
  },
  "validTo": "String",
  "totalPrice": {
    "currency": "String",
    "netValue": "Number",
    "grossValue": "Number",
    "taxValue": "Number"
  },
  "subTotalPrice": {
    "currency": "String",
    "netValue": "Number",
    "grossValue": "Number",
    "taxValue": "Number"
  },
  "taxAggregate": {
    "lines": [
      {
        "name": "String",
        "amount": "Number",
        "rate": "Number",
        "taxable": "Number"
      }
    ]
  },
  "shippingCost": {
    "value": "Number",
    "methodId": "String",
    "zoneId": "String",
    "methodName": "String",
    "shippingCode": "String"
  },
  "items": [
    {
      "itemId": "String",
      "quantity": {
        "quantity": "Number",
        "unitCode": "String"
      },
      "price": {
        "currency": "String",
        "priceId": "String",
        "unitPrice": "Number",
        "newUnitPrice": "Number",
        "totalNetValue": "Number",
        "discount": "Number",
        "includesTax": "Boolean",
        "tax": {
          "taxClass": "String",
          "taxRate": "String",
          "prices": {
            "grossValue": "Number",
            "netValue": "Number"
          }
        }
      },
      "product": {
        "productId": "String",
        "name": "String",
        "media": "Map",
        "metadata": "Object",
        "mixins": "Map"
      },
      "metadata": "Object",
      "mixins": "Map"
    }
  ],
  "metadata": {
    "version": "Integer",
    "createdAt": "String",
    "modifiedAt": "String",
    "mixins": "Map"
  },
  "mixins": "Map",
  "comment": {
    "employeeComment": "String"
  },
  "customerReference": "String",
  "customerComment": "String",
  "billingAddress": {
    "id": "String",
    "name": "String",
    "addressLine1": "String",
    "addressLine2": "String",
    "city": "String",
    "countryCode": "String",
    "postcode": "String",
    "state": "String"
  },
  "shippingAddress": {
    "id": "String",
    "name": "String",
    "addressLine1": "String",
    "addressLine2": "String",
    "city": "String",
    "countryCode": "String",
    "postcode": "String",
    "state": "String"
  },
  "company": "String"
}

quote.deleted

{
 "quoteId": "String"
}

Last updated

Was this helpful?