Skip to main content
POST
/
v1
/
ucp
/
orders
/
{id}
/
events
Record fulfillment event
curl --request POST \
  --url https://api.getsly.ai/v1/v1/ucp/orders/{id}/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "shipped",
  "occurred_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "data": {}
}
'
{
  "data": {
    "id": "<string>",
    "type": "shipped",
    "occurred_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "data": {}
  }
}

Authorizations

Authorization
string
header
required

API key (pk_test_* or pk_live_), JWT session, agent token (agent_), Ed25519 session (sess_), or portal token (portal_).

Path Parameters

id
string
required

Body

application/json
type
enum<string>
required
Available options:
shipped,
in_transit,
delivered,
returned,
held,
exception
occurred_at
string<date-time>
required
description
string
data
object

Response

201 - application/json

Event recorded

data
object
required