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

​
Limits

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

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.

Response

OK

The response is of type object.