Skip to content
Dixa API/Commerce Events/
Submit commerce event

Submit commerce event

Request

Submit a commerce event for a user (e.g. order lifecycle events for conversation routing, sales attribution, and analytics).

Security
ApiKeyAuth
Bodyapplication/jsonrequired

The commerce event to submit

eventIdstringrequired

Unique identifier for the event; used for idempotency

eventTimestampstring, (date-time)required

When the event occurred in the source system, not when Dixa received it

userByContactPoints (object) or ById (object)(UserReference)required
One of:

Identifies the user associated with the event.

authorByContactPoints (object) or ById (object)(UserReference)
One of:

Identifies the author of the action that triggered the event (e.g. a staff member who initiated a refund).

originstring

Sales channel or platform origin (e.g. web, mobile, pos).

metadataobject(Map_String)

Optional platform-specific key-value pairs for data that does not fit the typed payload.

payloadDeliveryAttemptFailed (object) or OrderCanceled (object) or OrderCreated (object) or OrderDelivered (object) or OrderDrafted (object) or OrderFulfilled (object) or RefundCreated (object) or ReturnReceived (object) or ReturnRequested (object)(CommerceEventPayload)required
One of:

Typed event payload. The _type field determines the event variant.

POST
/beta/commerce-events
curl -i -X POST \
  https://dev.dixa.io/beta/commerce-events \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "eventId": "evt_001",
    "eventTimestamp": "2026-05-08T14:32:11Z",
    "user": {
      "userId": "04a4db4f-cd01-41e2-88cf-32c4b6079f33",
      "_type": "ById"
    },
    "payload": {
      "orderId": "ORD-9981",
      "total": {
        "amount": 8950,
        "currency": "EUR"
      },
      "lineItems": [
        {
          "label": "Leather Derby Shoes",
          "reference": "SHOE-42-BLK",
          "quantity": 1,
          "amount": {
            "amount": 8950,
            "currency": "EUR"
          }
        }
      ],
      "_type": "OrderCreated"
    }
  }'

Responses

Event accepted

Response
No content