Orders
List Orders
Orders
List Orders
GET
/
v1
/
orders
curl --request GET \
--url https://api.production.orderprotection.com/v1/orders \
--header 'Authorization: Bearer <token>'
{
"pageInfo": {
"startCursor": "",
"endCursor": "",
"hasNextPage": false,
"hasPreviousPage": false
},
"pageCursors": {
"around": [
{
"cursor": "YXJyYXljb25uZWN0aW9uOjA=",
"page": 1,
"isCurrent": true
}
]
},
"totalCount": 5,
"edges": [
{
"node": {
"id": "asdasdfasdfasdfasdf",
"fulfillments": [
{
"id": "12345",
"sourceOrderId": "12345",
"fulfillmentStatus": "shipped",
"trackingCompany": "ups",
"trackingNumber": "12345",
"sourceItemIds": [
{
"id": "12345",
"quantity": 1
}
]
}
],
"sourceOrderId": "12345",
"originalSourceOrderId": "12345",
"originalOrderId": "12345",
"sourceOrderNumber": "#12345",
"sourceCreatedAt": "2000-05-15T21:00:00.000Z",
"sourceUpdatedAt": "2025-03-13T21:20:08.238Z",
"sourceCancelledAt": "2025-03-13T21:20:08.239Z",
"policyCancelledAt": "2025-03-13T21:20:08.239Z",
"platformId": "api",
"premiumPaid": "2025-03-13T21:20:08.239Z",
"premiumCost": "2025-03-13T21:20:08.239Z",
"currency": "USD",
"orderItems": [
{
"id": "clv5u1ix00002pheol047kwrv",
"orderId": "clv5u1ix00000pheoqpxke986",
"productName": "Handcrafted Wooden Table",
"productUrl": "https://bogus-clarity.name/",
"productImage": "https://picsum.photos/seed/orderprotection1/200/300",
"itemDescription": null,
"sku": "978-0-10-081434-9",
"selectedOptions": [],
"quantity": 20,
"price": 31.5,
"discount": 0,
"tax": 0,
"sourceItemId": "387179",
"sourceProductId": "477353",
"sourceVariantId": "17742",
"addressId": null,
"createdAt": "2024-04-18T22:48:08.964Z",
"updatedAt": "2024-04-18T22:48:08.964Z",
"refundedQuantity": 0
},
{
"id": "clv5u1ix00003pheom3edzt29",
"orderId": "clv5u1ix00000pheoqpxke986",
"productName": "Crazy T-Shirt",
"selectedOptions": [],
"productUrl": "https://test.site/",
"productImage": "https://picsum.photos/seed/orderprotection2/200/300",
"itemDescription": null,
"sku": "5555",
"quantity": 3,
"price": 32.2,
"discount": 0,
"tax": 0,
"sourceItemId": "387180",
"sourceProductId": "477353",
"sourceVariantId": "17742",
"addressId": null,
"createdAt": "2024-04-18T22:48:08.964Z",
"updatedAt": "2024-04-18T22:48:08.964Z",
"refundedQuantity": 0
}
],
"total": 12.55,
"discountTotal": 2.55,
"shippingCost": 7.55,
"shippingCostTax": 1.44,
"tax": 1.44,
"subtotal": 1200,
"customerEmail": "customer@email.com",
"customerName": "John Doe",
"customerPhone": "(801) 555-5555",
"exchangeRate": 1,
"storeId": "test",
"policyId": "asdadsasdad",
"eligibleForOta": false,
"createdAt": "2025-03-13T21:20:08.239Z",
"activities": [
{
"message": "Order created",
"orderId": "asdasd"
}
],
"updatedAt": "2025-03-13T21:20:08.239Z",
"deletedAt": "2025-03-13T21:20:08.239Z"
}
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Number of records
Record cursor
Number of pages on page cursors
Response
200
application/json
Example:
{
"startCursor": "",
"endCursor": "",
"hasNextPage": false,
"hasPreviousPage": false
}
Example:
{
"around": [
{
"cursor": "YXJyYXljb25uZWN0aW9uOjA=",
"page": 1,
"isCurrent": true
}
]
}
Example:
5
curl --request GET \
--url https://api.production.orderprotection.com/v1/orders \
--header 'Authorization: Bearer <token>'
{
"pageInfo": {
"startCursor": "",
"endCursor": "",
"hasNextPage": false,
"hasPreviousPage": false
},
"pageCursors": {
"around": [
{
"cursor": "YXJyYXljb25uZWN0aW9uOjA=",
"page": 1,
"isCurrent": true
}
]
},
"totalCount": 5,
"edges": [
{
"node": {
"id": "asdasdfasdfasdfasdf",
"fulfillments": [
{
"id": "12345",
"sourceOrderId": "12345",
"fulfillmentStatus": "shipped",
"trackingCompany": "ups",
"trackingNumber": "12345",
"sourceItemIds": [
{
"id": "12345",
"quantity": 1
}
]
}
],
"sourceOrderId": "12345",
"originalSourceOrderId": "12345",
"originalOrderId": "12345",
"sourceOrderNumber": "#12345",
"sourceCreatedAt": "2000-05-15T21:00:00.000Z",
"sourceUpdatedAt": "2025-03-13T21:20:08.238Z",
"sourceCancelledAt": "2025-03-13T21:20:08.239Z",
"policyCancelledAt": "2025-03-13T21:20:08.239Z",
"platformId": "api",
"premiumPaid": "2025-03-13T21:20:08.239Z",
"premiumCost": "2025-03-13T21:20:08.239Z",
"currency": "USD",
"orderItems": [
{
"id": "clv5u1ix00002pheol047kwrv",
"orderId": "clv5u1ix00000pheoqpxke986",
"productName": "Handcrafted Wooden Table",
"productUrl": "https://bogus-clarity.name/",
"productImage": "https://picsum.photos/seed/orderprotection1/200/300",
"itemDescription": null,
"sku": "978-0-10-081434-9",
"selectedOptions": [],
"quantity": 20,
"price": 31.5,
"discount": 0,
"tax": 0,
"sourceItemId": "387179",
"sourceProductId": "477353",
"sourceVariantId": "17742",
"addressId": null,
"createdAt": "2024-04-18T22:48:08.964Z",
"updatedAt": "2024-04-18T22:48:08.964Z",
"refundedQuantity": 0
},
{
"id": "clv5u1ix00003pheom3edzt29",
"orderId": "clv5u1ix00000pheoqpxke986",
"productName": "Crazy T-Shirt",
"selectedOptions": [],
"productUrl": "https://test.site/",
"productImage": "https://picsum.photos/seed/orderprotection2/200/300",
"itemDescription": null,
"sku": "5555",
"quantity": 3,
"price": 32.2,
"discount": 0,
"tax": 0,
"sourceItemId": "387180",
"sourceProductId": "477353",
"sourceVariantId": "17742",
"addressId": null,
"createdAt": "2024-04-18T22:48:08.964Z",
"updatedAt": "2024-04-18T22:48:08.964Z",
"refundedQuantity": 0
}
],
"total": 12.55,
"discountTotal": 2.55,
"shippingCost": 7.55,
"shippingCostTax": 1.44,
"tax": 1.44,
"subtotal": 1200,
"customerEmail": "customer@email.com",
"customerName": "John Doe",
"customerPhone": "(801) 555-5555",
"exchangeRate": 1,
"storeId": "test",
"policyId": "asdadsasdad",
"eligibleForOta": false,
"createdAt": "2025-03-13T21:20:08.239Z",
"activities": [
{
"message": "Order created",
"orderId": "asdasd"
}
],
"updatedAt": "2025-03-13T21:20:08.239Z",
"deletedAt": "2025-03-13T21:20:08.239Z"
}
}
]
}