Introduction
API Reference
- Swag Catalog
- Orders
- People
- Webhooks
- Webhook overview
- GETList webhooks
- POSTCreate webhook
- DELDelete webhook
- PUTUpdate webhook
- POSTTrigger webhook
- Order placed webhook event
- Order confirmed webhook event
- Order fulfilled webhook event
- Collection created webhook event
- Collection updated webhook event
- Collection deleted webhook event
- Product created webhook event
- Product updated webhook event
- Product hidden webhook event
- Product shown webhook event
API Changelog
Webhooks
Order confirmed webhook event
Webhook data sent when the order is confirmed
Webhook data
type OrderConfirmedData {
id: string;
createdAt: string;
orderNumber: string;
externalId?: string;
orderLineItems: {
id: string;
title: string;
price: number;
quantity: number;
// @deprecated, please use image.url
imageUrl: string,
image: { url: string; },
productId: string;
productTitle: string;
variantId: string;
variantTitle: string;
personalizations?: Partial<PersonalizationFields>
sha?: string;
}[]
}
Example Webhook data without personalizations
{
"id": "9a862a01-5e27-4961-ac1c-643de3ac07db",
"createdAt": "2024-01-01 15:45:25.932562",
"orderNumber": "123",
"orderLineItems": [
{
"id": "4251d65d-fab8-46de-908b-204c02ee32f0",
"title": "CamelBak Eddy 25oz Bottle Tritan - Clear / Large",
"price": 54,
"quantity": 1,
// @deprecated, please use image.url
"imageUrl": "https://media.covver.io/image/camelbak-eddy-water-bottle-25oz-fBbJQZ55nAGMKG7ZuhWFAQJUKy55WaGD.jpg",
"image" { "url": "https://media.covver.io/image/camelbak-eddy-water-bottle-25oz-fBbJQZ55nAGMKG7ZuhWFAQJUKy55WaGD.jpg" },
"productId": "bd0fdfce-47e1-4638-a452-1bdc4998cb7c",
"productTitle": "CamelBak Eddy 25oz Bottle Tritan",
"variantId": "b3415cca-24e2-4c88-847b-de78c9e78ae9"
"variantTitle": "Clear / Large",
}
]
}
Note
This is not guaranteed to include all orderLineItems of the order. This webhook depends on our vendors and when they confirm the order.
Assistant
Responses are generated using AI and may contain mistakes.