Skip to main content
GET
/
v2
/
order_events
Retrieve order events
curl --request GET \
  --url https://dev.sbx.imprint.co/v2/order_events \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "order_id": "77f60af4-185e-4867-b113-34e3cf7c6acd",
      "type": "CAPTURED",
      "amount": 274999,
      "network_transaction_id": "615e3ba0-6b99-495b-ade4-1f584c40f376",
      "order_event_id": "77f60af4-185e-4867-b113-34e3cf7c6acd",
      "partner_event_id": "7622c07d-eb2b-4345-a9a9-345d61d32bc2",
      "rewards_amount": 2500,
      "currency": "USD",
      "order_lines": [
        {
          "name": "Couch Supreme",
          "product_url": "www.restassured.com/couch-supreme",
          "quantity": 1,
          "rate": 274999,
          "rewards_rate": 2500
        }
      ]
    }
  ],
  "has_more": true,
  "total": 123
}

Authorizations

​
Authorization
string
header
required

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

Query Parameters

​
order_event_id
string

An order event ID. If provided, the response will only have a maximum of one result.

​
order_id
string

Enables searching for events by order ID

​
partner_event_id
string

The identifier of the order event in the partner system. If provided, the response will only have a maximum of one result.

​
network_transaction_id
string

The network's unique identifier for the transaction. Examples include Visa Transaction ID, Mastercard Trace ID, and American Express Network Reference ID

​
limit
integer<int32>
default:10

Limits the number of returned results

Required range: x >= 1
​
starting_after
string

A cursor for use in pagination. An id that defines your place in the list.

Response

200 - application/json

List of order events

​
data
object[]
required

List of order events

​
has_more
boolean
​
total
integer