Skip to main content
The OrderCreate event fires the moment a new order is submitted through a HoopAI store or funnel. The payload includes the full order details — contact, line items, pricing breakdown, tax summary, and the originating source — making it straightforward to trigger fulfillment workflows, notify warehouse systems, or record revenue in external platforms.

​
Payload

FieldTypeDescription
typestringAlways "OrderCreate"
locationIdstringSub-account ID where the order was placed
_idstringUnique identifier for the order
altIdstringSub-account (location) ID — matches locationId
altTypestringResource type for altId — always "location"
statusstringOrder payment status (e.g., pending, completed)
fulfillmentStatusstringShipping/fulfillment status (e.g., unfulfilled, fulfilled)
contactIdstringID of the contact who placed the order
contactSnapshotobjectPoint-in-time snapshot of the contact (id, locationId, firstName, lastName, email, phone, dnd, dateAdded)
currencystringISO 4217 currency code (e.g., USD)
amountnumberTotal order amount including tax and shipping
liveModebooleantrue when the event originates from a live sub-account; false in test mode
itemsarrayLine items in the order, each containing name, quantity, and price details
amountSummaryobjectBreakdown of the order total (subtotal, discount, tax, shipping)
amountSummary.subtotalnumberPre-tax, pre-discount order subtotal
amountSummary.discountnumberTotal discount applied to the order
amountSummary.taxnumberTotal tax amount
amountSummary.shippingnumberShipping charges
taxSummaryarrayPer-tax-rule breakdown (id, name, calculation method, rate, amount)
sourceobjectOrigin of the order (type, subType, id, name — e.g., a website store)
createdAtstringISO 8601 timestamp when the order was created
updatedAtstringISO 8601 timestamp of the most recent update

​
Example payload

{
  "type": "OrderCreate",
  "locationId": "Z4Bxl8J4SaPEPLq9IQ8g",
  "_id": "660ed43bfdf9fc05a0de7a40",
  "altId": "Z4Bxl8J4SaPEPLq9IQ8g",
  "altType": "location",
  "status": "pending",
  "fulfillmentStatus": "unfulfilled",
  "contactId": "ff2JstbQJfRuofXzeT0M",
  "currency": "USD",
  "amount": 150.1,
  "liveMode": false,
  "amountSummary": {
    "subtotal": 138,
    "discount": 0,
    "tax": 12.1,
    "shipping": 0
  },
  "taxSummary": [
    {
      "_id": "63770f5cecf298787c752075",
      "name": "10%",
      "calculation": "exclusive",
      "rate": 10,
      "amount": 12.1
    }
  ],
  "source": {
    "type": "website",
    "subType": "store",
    "id": "nohc1pPZJlpZTpxJfLCp",
    "name": "Ecom Store"
  },
  "createdAt": "2024-04-04T16:24:27.036Z",
  "updatedAt": "2024-04-04T16:24:31.297Z",
  "contactSnapshot": {
    "id": "ff2JstbQJfRuofXzeT0M",
    "locationId": "Z4Bxl8J4SaPEPLq9IQ8g",
    "firstName": "Maxwell",
    "lastName": "Schmidt",
    "email": "limof@mailinator.com",
    "phone": "+2389372075506",
    "dnd": false,
    "dateAdded": "2024-04-04T16:24:21.375Z"
  },
  "items": [
    {
      "name": "Men's classic tee - XL / Charcoal",
      "qty": 1,
      "price": {
        "_id": "660ed20095e1dcd37bb0d392",
        "name": "XL / Charcoal",
        "type": "one_time",
        "currency": "USD",
        "amount": 17
      }
    }
  ]
}
Last modified on March 4, 2026