Skip to main content
POST
/
v1
/
order
/
{id}
/
events
Add custom event to order
curl --request POST \
  --url https://api.sandbox.usenash.com/v1/order/{id}/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "timestamp": null,
  "payload": {}
}
'
{
  "event": {
    "id": "<string>",
    "eventName": "<string>",
    "orderId": "<string>",
    "eventCreatedAt": "<string>",
    "payload": {}
  }
}

​
Limits

  • Rate limits: Max 3 requests/second
  • Size limit: Request body must not exceed 1kb

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Unique reference number for the order: either order.id (starts with "ord_") or order.externalId

Example:

"ord_1234567890"

Body

application/json

Expected payload for the add event endpoint.

​
name
string
required
​
timestamp
string

The event time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'.

​
payload
Payload · object

Response

OK

​
event
EventOutputPayload · object
required