Skip to content

Get the order timeline

GET
/stores/{storeRef}/orders/{id}/timeline
curl --request GET \
--url https://apibase.ecomweb.app/api/v1/stores/example/orders/1/timeline \
--header 'x-api-key: <x-api-key>'

Returns the order’s history as one list, newest first: status changes, tracking updates and shipment events, interleaved with internal staff comments. Each entry has a kind of event or comment. At most 500 events and 500 comments are read, and truncated is true when older entries were left out.

Required scopes: read:orders

id
required
integer

The order ID.

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
entries
required

Events and comments merged, newest first. Tell them apart with kind.

Array
One of: discriminator: kind
object
kind
required

Always event.

string
Allowed values: event
event_type
required

What happened.

string
Allowed values: placed order_status_changed fulfillment_status_changed shipping_status_changed payment_status_changed tracking_number_updated shipment_booked shipment_cancelled shipment_failed
arguments
required

Details of the event, such as the old and new status. Its keys depend on event_type.

object
key
additional properties
any
id
required

Event ID.

string
reason
required

The reason given for the change, or null.

string
nullable
actor
required

Who caused the event.

object
type
required

Kind of actor.

string
Allowed values: staff customer api_key gateway system carrier
id
required

Actor ID: a staff user ID or an API key ID. Null for the system and some gateways.

string
nullable
name
required

Display name, or null when it cannot be resolved.

string
nullable
email
required

Staff members only: their email. Null for every other actor.

string
nullable
created_at
required

When the event happened, as an ISO 8601 timestamp.

string
truncated
required

True when the order has more history than one response carries, so the oldest entries are missing.

boolean

Example

{
"entries": [
{
"kind": "event",
"event_type": "placed",
"actor": {
"type": "staff"
}
}
]
}

The request is malformed or failed validation.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The resource does not exist in this store.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}