List
curl --request GET \
--url https://{defaultHost}/v1/events \
--header 'Authorization: Bearer <token>'import requests
url = "https://{defaultHost}/v1/events"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{defaultHost}/v1/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{defaultHost}/v1/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{defaultHost}/v1/events"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{defaultHost}/v1/events")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{defaultHost}/v1/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "list",
"pagination": {
"count": 6,
"limit": 20,
"page": 1,
"url": "/v1/events"
},
"data": [
{
"id": "0a3c5fda-39b6-4d4d-929f-67dd65131f86",
"object": "event",
"data": {
"object": {
"id": "4e57a421-3d0b-460c-91f2-9444cbfb161e",
"object": "purchase",
"live_mode": true,
"quantity": 1,
"revoked": false,
"revoked_at": null,
"revoke_at": null,
"customer": "d971bb61-a2d0-43ba-9674-5b717e1d89d5",
"initial_order": "303f42ff-a940-497d-804f-aae19c0dd842",
"license": null,
"price": "aef0516b-3563-4f74-97e4-e2db5de3c2d1",
"product": "1f9e35f8-dbb2-4c6e-bd2b-be5375a767fb",
"subscription": null,
"variant": null,
"review": null,
"created_at": 1787228379,
"updated_at": 1787228379
}
},
"type": "purchase.created",
"account": "c17565f0-ee55-4393-b446-193023a6c625",
"created_at": 1787228379
},
{
"id": "8cae2847-56b3-4865-9cc4-2e0ad351c8ab",
"object": "event",
"data": {
"object": {
"id": "303f42ff-a940-497d-804f-aae19c0dd842",
"object": "order",
"fulfillment_status": "unfulfilled",
"live_mode": true,
"number": "0001",
"order_type": "checkout",
"return_status": "not_returned",
"shipment_status": "unshippable",
"portal_url": "http://app.example.com/portal_redirect/orders/303f42ff-a940-497d-804f-aae19c0dd842",
"statement_url": "http://app.example.com/statements/orders/303f42ff-a940-497d-804f-aae19c0dd842",
"status": "paid",
"checkout": "05c1ecda-a1e6-4883-80d1-5a35d98be174",
"created_at": 1787228379,
"updated_at": 1787228379
}
},
"type": "order.paid",
"account": "c17565f0-ee55-4393-b446-193023a6c625",
"created_at": 1787228379
},
{
"id": "27c3e373-8e72-42d3-85f1-f28af5e27c0a",
"object": "event",
"data": {
"object": {
"id": "5f681174-1ee0-4f89-a712-31a6a18a5172",
"object": "purchase",
"live_mode": true,
"quantity": 1,
"revoked": false,
"revoked_at": null,
"revoke_at": null,
"customer": "d971bb61-a2d0-43ba-9674-5b717e1d89d5",
"initial_order": "303f42ff-a940-497d-804f-aae19c0dd842",
"license": null,
"price": "aef0516b-3563-4f74-97e4-e2db5de3c2d1",
"product": "1f9e35f8-dbb2-4c6e-bd2b-be5375a767fb",
"subscription": null,
"variant": null,
"review": null,
"created_at": 1787228379,
"updated_at": 1787228379
}
},
"type": "purchase.created",
"account": "c17565f0-ee55-4393-b446-193023a6c625",
"created_at": 1787228379
},
{
"id": "368fa86e-5b0d-437b-89f1-758533bf03ad",
"object": "event",
"data": {
"object": {
"id": "303f42ff-a940-497d-804f-aae19c0dd842",
"object": "order",
"fulfillment_status": "unfulfilled",
"live_mode": true,
"number": "0001",
"order_type": "checkout",
"return_status": "not_returned",
"shipment_status": "unshippable",
"portal_url": "http://app.example.com/portal_redirect/orders/303f42ff-a940-497d-804f-aae19c0dd842",
"statement_url": "http://app.example.com/statements/orders/303f42ff-a940-497d-804f-aae19c0dd842",
"status": "paid",
"checkout": "05c1ecda-a1e6-4883-80d1-5a35d98be174",
"created_at": 1787228379,
"updated_at": 1787228379
}
},
"type": "order.made_processing",
"account": "c17565f0-ee55-4393-b446-193023a6c625",
"created_at": 1787228379
},
{
"id": "8ad98d55-d177-49f8-bd2c-ed3b54cf2bbb",
"object": "event",
"data": {
"object": {
"id": "303f42ff-a940-497d-804f-aae19c0dd842",
"object": "order",
"fulfillment_status": "unfulfilled",
"live_mode": true,
"number": "0001",
"order_type": "checkout",
"return_status": "not_returned",
"shipment_status": "unshippable",
"portal_url": "http://app.example.com/portal_redirect/orders/303f42ff-a940-497d-804f-aae19c0dd842",
"statement_url": "http://app.example.com/statements/orders/303f42ff-a940-497d-804f-aae19c0dd842",
"status": "paid",
"checkout": "05c1ecda-a1e6-4883-80d1-5a35d98be174",
"created_at": 1787228379,
"updated_at": 1787228379
}
},
"type": "order.created",
"account": "c17565f0-ee55-4393-b446-193023a6c625",
"created_at": 1787228379
},
{
"id": "059192ae-de76-4981-889e-1ed3c651d284",
"object": "event",
"data": {
"object": {
"id": "1f9e35f8-dbb2-4c6e-bd2b-be5375a767fb",
"object": "product",
"allow_out_of_stock_purchases": false,
"archived": false,
"archived_at": null,
"auto_fulfill_enabled": false,
"available_stock": -1,
"average_stars": "0.0",
"bundle": false,
"description": null,
"dimensions": null,
"held_stock": 1,
"featured": false,
"licensing_enabled": false,
"license_activation_limit": null,
"metadata": {},
"purchase_limit": null,
"metrics": {
"currency": "usd",
"max_price_amount": null,
"min_price_amount": null,
"prices_count": 0
},
"name": "Test Product",
"recurring": false,
"reviews_breakdown": {},
"reviews_enabled": true,
"shipping_enabled": false,
"sku": null,
"slug": "test-product",
"solicit_reviews": true,
"status": "draft",
"stock": 0,
"stock_enabled": false,
"tax_enabled": false,
"tax_category": "tangible",
"weight": 0,
"weight_unit": "lb",
"commission_structure": null,
"featured_product_media": null,
"product_group": null,
"current_release_download": null,
"shipping_profile": null,
"cataloged_at": 1787228378,
"discarded_at": null,
"created_at": 1787228378,
"updated_at": 1787228379
}
},
"type": "product.stock_adjusted",
"account": "c17565f0-ee55-4393-b446-193023a6c625",
"created_at": 1787228379
}
]
}Events
List
Returns a list of your events.
GET
/
v1
/
events
List
curl --request GET \
--url https://{defaultHost}/v1/events \
--header 'Authorization: Bearer <token>'import requests
url = "https://{defaultHost}/v1/events"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{defaultHost}/v1/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{defaultHost}/v1/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{defaultHost}/v1/events"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{defaultHost}/v1/events")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{defaultHost}/v1/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "list",
"pagination": {
"count": 6,
"limit": 20,
"page": 1,
"url": "/v1/events"
},
"data": [
{
"id": "0a3c5fda-39b6-4d4d-929f-67dd65131f86",
"object": "event",
"data": {
"object": {
"id": "4e57a421-3d0b-460c-91f2-9444cbfb161e",
"object": "purchase",
"live_mode": true,
"quantity": 1,
"revoked": false,
"revoked_at": null,
"revoke_at": null,
"customer": "d971bb61-a2d0-43ba-9674-5b717e1d89d5",
"initial_order": "303f42ff-a940-497d-804f-aae19c0dd842",
"license": null,
"price": "aef0516b-3563-4f74-97e4-e2db5de3c2d1",
"product": "1f9e35f8-dbb2-4c6e-bd2b-be5375a767fb",
"subscription": null,
"variant": null,
"review": null,
"created_at": 1787228379,
"updated_at": 1787228379
}
},
"type": "purchase.created",
"account": "c17565f0-ee55-4393-b446-193023a6c625",
"created_at": 1787228379
},
{
"id": "8cae2847-56b3-4865-9cc4-2e0ad351c8ab",
"object": "event",
"data": {
"object": {
"id": "303f42ff-a940-497d-804f-aae19c0dd842",
"object": "order",
"fulfillment_status": "unfulfilled",
"live_mode": true,
"number": "0001",
"order_type": "checkout",
"return_status": "not_returned",
"shipment_status": "unshippable",
"portal_url": "http://app.example.com/portal_redirect/orders/303f42ff-a940-497d-804f-aae19c0dd842",
"statement_url": "http://app.example.com/statements/orders/303f42ff-a940-497d-804f-aae19c0dd842",
"status": "paid",
"checkout": "05c1ecda-a1e6-4883-80d1-5a35d98be174",
"created_at": 1787228379,
"updated_at": 1787228379
}
},
"type": "order.paid",
"account": "c17565f0-ee55-4393-b446-193023a6c625",
"created_at": 1787228379
},
{
"id": "27c3e373-8e72-42d3-85f1-f28af5e27c0a",
"object": "event",
"data": {
"object": {
"id": "5f681174-1ee0-4f89-a712-31a6a18a5172",
"object": "purchase",
"live_mode": true,
"quantity": 1,
"revoked": false,
"revoked_at": null,
"revoke_at": null,
"customer": "d971bb61-a2d0-43ba-9674-5b717e1d89d5",
"initial_order": "303f42ff-a940-497d-804f-aae19c0dd842",
"license": null,
"price": "aef0516b-3563-4f74-97e4-e2db5de3c2d1",
"product": "1f9e35f8-dbb2-4c6e-bd2b-be5375a767fb",
"subscription": null,
"variant": null,
"review": null,
"created_at": 1787228379,
"updated_at": 1787228379
}
},
"type": "purchase.created",
"account": "c17565f0-ee55-4393-b446-193023a6c625",
"created_at": 1787228379
},
{
"id": "368fa86e-5b0d-437b-89f1-758533bf03ad",
"object": "event",
"data": {
"object": {
"id": "303f42ff-a940-497d-804f-aae19c0dd842",
"object": "order",
"fulfillment_status": "unfulfilled",
"live_mode": true,
"number": "0001",
"order_type": "checkout",
"return_status": "not_returned",
"shipment_status": "unshippable",
"portal_url": "http://app.example.com/portal_redirect/orders/303f42ff-a940-497d-804f-aae19c0dd842",
"statement_url": "http://app.example.com/statements/orders/303f42ff-a940-497d-804f-aae19c0dd842",
"status": "paid",
"checkout": "05c1ecda-a1e6-4883-80d1-5a35d98be174",
"created_at": 1787228379,
"updated_at": 1787228379
}
},
"type": "order.made_processing",
"account": "c17565f0-ee55-4393-b446-193023a6c625",
"created_at": 1787228379
},
{
"id": "8ad98d55-d177-49f8-bd2c-ed3b54cf2bbb",
"object": "event",
"data": {
"object": {
"id": "303f42ff-a940-497d-804f-aae19c0dd842",
"object": "order",
"fulfillment_status": "unfulfilled",
"live_mode": true,
"number": "0001",
"order_type": "checkout",
"return_status": "not_returned",
"shipment_status": "unshippable",
"portal_url": "http://app.example.com/portal_redirect/orders/303f42ff-a940-497d-804f-aae19c0dd842",
"statement_url": "http://app.example.com/statements/orders/303f42ff-a940-497d-804f-aae19c0dd842",
"status": "paid",
"checkout": "05c1ecda-a1e6-4883-80d1-5a35d98be174",
"created_at": 1787228379,
"updated_at": 1787228379
}
},
"type": "order.created",
"account": "c17565f0-ee55-4393-b446-193023a6c625",
"created_at": 1787228379
},
{
"id": "059192ae-de76-4981-889e-1ed3c651d284",
"object": "event",
"data": {
"object": {
"id": "1f9e35f8-dbb2-4c6e-bd2b-be5375a767fb",
"object": "product",
"allow_out_of_stock_purchases": false,
"archived": false,
"archived_at": null,
"auto_fulfill_enabled": false,
"available_stock": -1,
"average_stars": "0.0",
"bundle": false,
"description": null,
"dimensions": null,
"held_stock": 1,
"featured": false,
"licensing_enabled": false,
"license_activation_limit": null,
"metadata": {},
"purchase_limit": null,
"metrics": {
"currency": "usd",
"max_price_amount": null,
"min_price_amount": null,
"prices_count": 0
},
"name": "Test Product",
"recurring": false,
"reviews_breakdown": {},
"reviews_enabled": true,
"shipping_enabled": false,
"sku": null,
"slug": "test-product",
"solicit_reviews": true,
"status": "draft",
"stock": 0,
"stock_enabled": false,
"tax_enabled": false,
"tax_category": "tangible",
"weight": 0,
"weight_unit": "lb",
"commission_structure": null,
"featured_product_media": null,
"product_group": null,
"current_release_download": null,
"shipping_profile": null,
"cataloged_at": 1787228378,
"discarded_at": null,
"created_at": 1787228378,
"updated_at": 1787228379
}
},
"type": "product.stock_adjusted",
"account": "c17565f0-ee55-4393-b446-193023a6c625",
"created_at": 1787228379
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
A limit on the number of items to be returned, between 1 and 100.
The page of items you want returned.
Only return objects that belong to the given records.
Only return events with the given type.
Was this page helpful?
⌘I