{
"event": "order.confirmed",
"event_id": "<string>",
"delivery_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"is_test": true,
"payload": {
"event": "order.confirmed",
"event_id": "<string>",
"store_id": "<string>",
"properties": {
"applied_promotions": [
{
"promotion_id": "<string>",
"savings": 123,
"product_id": "<string>",
"variant_id": "<string>",
"product_name": "<string>",
"variant_name": "<string>",
"applied_sequence": 123,
"scope": "<string>"
}
],
"applied_coupons": [
{
"coupon_id": "<string>",
"savings": 123,
"product_id": "<string>",
"variant_id": "<string>",
"product_name": "<string>",
"variant_name": "<string>"
}
],
"order_number": "<string>",
"order_date": "2023-11-07T05:31:56Z",
"payment_success_date": "<string>",
"customer_note": "<string>",
"is_promotion_applied": true,
"promotion_discount_amount": 123,
"promotion_discount_percent": 123,
"is_coupon_applied": true,
"coupon_code": "<string>",
"coupon_discount_amount": 123,
"coupon_discount_percent": 123,
"promotion_savings": 1,
"coupon_savings": 1,
"other_savings": 1,
"total_savings": 1,
"on_subscription": true,
"subtotal": 123,
"item_total_tax": 123,
"subtotal_including_tax": 123,
"shipping_estimated_cost": 1,
"shipping_discount_amount": 1,
"shipping_amount": 123,
"shipping_tax_rate": 1,
"shipping_tax_amount": 1,
"shipping_amount_including_tax": 1,
"fulfillment_preference": {
"fulfillment_type": "collect-in-store",
"pickup_location_id": "<string>"
},
"estimated_delivery_days": 123,
"handling_charge_excluding_tax": 1,
"handling_charge_tax_amount": 1,
"handling_charge_including_tax": 1,
"total_tax": 123,
"grand_total": 123,
"loyalty_points_earned": 1,
"loyalty_points_redeemed": 1,
"credit_balance_used": 123,
"to_be_paid": 123,
"order_items_count": 123,
"order_items": [
{
"product_id": "<string>",
"product_name": "<string>",
"product_image_url": "<string>",
"sku": "<string>",
"product_slug": "<string>",
"variant_slug": "<string>",
"variant_id": "<string>",
"variant_name": "<string>",
"backorder": true,
"on_promotion": true,
"on_subscription": true,
"subscription_plan": "<string>",
"subscription_interval": 123,
"subscription_frequency": "<string>",
"quantity": 1,
"free_quantity": 1,
"is_free_item": true,
"price_including_tax": true,
"selling_price": 1,
"listing_price": 1,
"selling_price_excluding_tax": 1,
"promotion_discount_amount": 1,
"coupon_discount_amount": 1,
"tax_type": "GST",
"tax_rate": 1,
"tax_amount": 1,
"handling_charge_excluding_tax": 1,
"handling_charge_tax_rate": 1,
"handling_charge_including_tax": 1,
"associated_options": {
"background_color": {
"name": "Background Color",
"value": {
"name": "Blue",
"hexcode": "#0000FF"
},
"type": "color"
},
"size": {
"name": "Size",
"value": "Large",
"type": "single-select"
}
},
"attributes": [
{
"id": "<string>",
"name": "<string>",
"key": "<string>",
"type": "color",
"value": [
{
"name": "<string>",
"hexcode": "<string>"
}
]
}
],
"seller_id": "<string>",
"seller_detail": {
"id": "<string>",
"trade_name": "<string>",
"legal_name": "<string>",
"business_type": "<string>",
"tax_identification_number": "<string>"
}
}
],
"billing_address": {
"first_name": "<string>",
"last_name": "<string>",
"country_code": "<string>",
"phone": "<string>",
"email": "<string>",
"address_line1": "<string>",
"address_line2": "<string>",
"landmark": "<string>",
"pincode": "<string>",
"city": "<string>",
"state": "<string>",
"country": "India",
"tax_identification_number": "<string>",
"business_name": "<string>",
"is_default_billing": true,
"is_default_shipping": true,
"nickname": null
},
"shipping_address": {
"first_name": "<string>",
"last_name": "<string>",
"country_code": "<string>",
"phone": "<string>",
"email": "<string>",
"address_line1": "<string>",
"address_line2": "<string>",
"landmark": "<string>",
"pincode": "<string>",
"city": "<string>",
"state": "<string>",
"country": "India",
"tax_identification_number": "<string>",
"business_name": "<string>",
"is_default_billing": true,
"is_default_shipping": true,
"nickname": null
},
"currency": {
"name": "<string>",
"code": "<string>",
"symbol": "<string>"
},
"metadata": {},
"is_cancellation_allowed": true,
"cancellation_refund_details": {
"loyalty_point": 123,
"refundable_amount": 123,
"cancellation_charges": 123,
"cancellation_charges_reason": "<string>"
},
"feedback": "<string>",
"payments": [
{
"request_number": "<string>",
"amount": 123,
"payment_date": "2023-11-07T05:31:56Z",
"payment_reference_number": "<string>",
"payment_method": "<string>",
"icon_url": "<string>",
"card_number": "<string>"
}
],
"shipments": [
{
"reference_number": "<string>",
"total_weight": 123,
"total_boxes": 123,
"shipment_items_count": 123,
"shipment_items": [
{
"product_id": "<string>",
"product_name": "<string>",
"product_image_url": "<string>",
"variant_id": "<string>",
"variant_name": "<string>",
"sku": "<string>",
"quantity": 123,
"free_quantity": 123,
"is_free_item": true
}
],
"shipping_amount": 123,
"shipping_tax_amount": 123,
"shipping_amount_including_tax": 123,
"courier_company_name": "<string>",
"shipping_label_url": "<string>",
"awb_no": "<string>",
"tracking_url": "<string>",
"eta_delivery": "<string>",
"shipped_date": "2023-11-07T05:31:56Z",
"delivered_date": "2023-11-07T05:31:56Z",
"is_return_allowed": false,
"cancellation_reason": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"seller_id": "<string>",
"seller_detail": {
"id": "<string>",
"trade_name": "<string>",
"legal_name": "<string>",
"business_type": "<string>",
"tax_identification_number": "<string>"
}
}
]
},
"store_type": "<string>",
"user_id": "<string>",
"customer_id": "<string>",
"admin_user_id": "<string>",
"tenant_id": "<string>",
"seller_id": "<string>",
"timestamp": "<string>",
"is_test": true
}
}{
"message": "<string>",
"success": true,
"code": "<string>",
"errors": {}
}{
"message": "Not authorized for given operation on the Resource.",
"success": false,
"code": "unauthorized"
}Order confirmed
Fires when payment succeeds on an auto-approved store, when an admin accepts an awaiting_approval order, or when a bank-transfer/credit-line order settles.
{
"event": "order.confirmed",
"event_id": "<string>",
"delivery_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"is_test": true,
"payload": {
"event": "order.confirmed",
"event_id": "<string>",
"store_id": "<string>",
"properties": {
"applied_promotions": [
{
"promotion_id": "<string>",
"savings": 123,
"product_id": "<string>",
"variant_id": "<string>",
"product_name": "<string>",
"variant_name": "<string>",
"applied_sequence": 123,
"scope": "<string>"
}
],
"applied_coupons": [
{
"coupon_id": "<string>",
"savings": 123,
"product_id": "<string>",
"variant_id": "<string>",
"product_name": "<string>",
"variant_name": "<string>"
}
],
"order_number": "<string>",
"order_date": "2023-11-07T05:31:56Z",
"payment_success_date": "<string>",
"customer_note": "<string>",
"is_promotion_applied": true,
"promotion_discount_amount": 123,
"promotion_discount_percent": 123,
"is_coupon_applied": true,
"coupon_code": "<string>",
"coupon_discount_amount": 123,
"coupon_discount_percent": 123,
"promotion_savings": 1,
"coupon_savings": 1,
"other_savings": 1,
"total_savings": 1,
"on_subscription": true,
"subtotal": 123,
"item_total_tax": 123,
"subtotal_including_tax": 123,
"shipping_estimated_cost": 1,
"shipping_discount_amount": 1,
"shipping_amount": 123,
"shipping_tax_rate": 1,
"shipping_tax_amount": 1,
"shipping_amount_including_tax": 1,
"fulfillment_preference": {
"fulfillment_type": "collect-in-store",
"pickup_location_id": "<string>"
},
"estimated_delivery_days": 123,
"handling_charge_excluding_tax": 1,
"handling_charge_tax_amount": 1,
"handling_charge_including_tax": 1,
"total_tax": 123,
"grand_total": 123,
"loyalty_points_earned": 1,
"loyalty_points_redeemed": 1,
"credit_balance_used": 123,
"to_be_paid": 123,
"order_items_count": 123,
"order_items": [
{
"product_id": "<string>",
"product_name": "<string>",
"product_image_url": "<string>",
"sku": "<string>",
"product_slug": "<string>",
"variant_slug": "<string>",
"variant_id": "<string>",
"variant_name": "<string>",
"backorder": true,
"on_promotion": true,
"on_subscription": true,
"subscription_plan": "<string>",
"subscription_interval": 123,
"subscription_frequency": "<string>",
"quantity": 1,
"free_quantity": 1,
"is_free_item": true,
"price_including_tax": true,
"selling_price": 1,
"listing_price": 1,
"selling_price_excluding_tax": 1,
"promotion_discount_amount": 1,
"coupon_discount_amount": 1,
"tax_type": "GST",
"tax_rate": 1,
"tax_amount": 1,
"handling_charge_excluding_tax": 1,
"handling_charge_tax_rate": 1,
"handling_charge_including_tax": 1,
"associated_options": {
"background_color": {
"name": "Background Color",
"value": {
"name": "Blue",
"hexcode": "#0000FF"
},
"type": "color"
},
"size": {
"name": "Size",
"value": "Large",
"type": "single-select"
}
},
"attributes": [
{
"id": "<string>",
"name": "<string>",
"key": "<string>",
"type": "color",
"value": [
{
"name": "<string>",
"hexcode": "<string>"
}
]
}
],
"seller_id": "<string>",
"seller_detail": {
"id": "<string>",
"trade_name": "<string>",
"legal_name": "<string>",
"business_type": "<string>",
"tax_identification_number": "<string>"
}
}
],
"billing_address": {
"first_name": "<string>",
"last_name": "<string>",
"country_code": "<string>",
"phone": "<string>",
"email": "<string>",
"address_line1": "<string>",
"address_line2": "<string>",
"landmark": "<string>",
"pincode": "<string>",
"city": "<string>",
"state": "<string>",
"country": "India",
"tax_identification_number": "<string>",
"business_name": "<string>",
"is_default_billing": true,
"is_default_shipping": true,
"nickname": null
},
"shipping_address": {
"first_name": "<string>",
"last_name": "<string>",
"country_code": "<string>",
"phone": "<string>",
"email": "<string>",
"address_line1": "<string>",
"address_line2": "<string>",
"landmark": "<string>",
"pincode": "<string>",
"city": "<string>",
"state": "<string>",
"country": "India",
"tax_identification_number": "<string>",
"business_name": "<string>",
"is_default_billing": true,
"is_default_shipping": true,
"nickname": null
},
"currency": {
"name": "<string>",
"code": "<string>",
"symbol": "<string>"
},
"metadata": {},
"is_cancellation_allowed": true,
"cancellation_refund_details": {
"loyalty_point": 123,
"refundable_amount": 123,
"cancellation_charges": 123,
"cancellation_charges_reason": "<string>"
},
"feedback": "<string>",
"payments": [
{
"request_number": "<string>",
"amount": 123,
"payment_date": "2023-11-07T05:31:56Z",
"payment_reference_number": "<string>",
"payment_method": "<string>",
"icon_url": "<string>",
"card_number": "<string>"
}
],
"shipments": [
{
"reference_number": "<string>",
"total_weight": 123,
"total_boxes": 123,
"shipment_items_count": 123,
"shipment_items": [
{
"product_id": "<string>",
"product_name": "<string>",
"product_image_url": "<string>",
"variant_id": "<string>",
"variant_name": "<string>",
"sku": "<string>",
"quantity": 123,
"free_quantity": 123,
"is_free_item": true
}
],
"shipping_amount": 123,
"shipping_tax_amount": 123,
"shipping_amount_including_tax": 123,
"courier_company_name": "<string>",
"shipping_label_url": "<string>",
"awb_no": "<string>",
"tracking_url": "<string>",
"eta_delivery": "<string>",
"shipped_date": "2023-11-07T05:31:56Z",
"delivered_date": "2023-11-07T05:31:56Z",
"is_return_allowed": false,
"cancellation_reason": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"seller_id": "<string>",
"seller_detail": {
"id": "<string>",
"trade_name": "<string>",
"legal_name": "<string>",
"business_type": "<string>",
"tax_identification_number": "<string>"
}
}
]
},
"store_type": "<string>",
"user_id": "<string>",
"customer_id": "<string>",
"admin_user_id": "<string>",
"tenant_id": "<string>",
"seller_id": "<string>",
"timestamp": "<string>",
"is_test": true
}
}{
"message": "<string>",
"success": true,
"code": "<string>",
"errors": {}
}{
"message": "Not authorized for given operation on the Resource.",
"success": false,
"code": "unauthorized"
}Headers
Event name; equals the body event.
sha256= followed by the hex HMAC-SHA256 of the raw request body, keyed with the webhook secret. Verify with a constant-time comparison before processing.
^sha256=[0-9a-f]{64}$Equals the body event_id. Stable across retries — use as the idempotency key.
Equals the body delivery_id. Unique per delivery attempt.
Body
Body of every webhook request. The HMAC-SHA256 signature in X-CE-Signature is computed over the raw request body with the webhook secret. Use event_id as the idempotency key: retries of the same event reuse it while delivery_id changes per attempt.
Event name, e.g. order.created. Also sent as the X-CE-Event header.
order.confirmed ULID shared by every delivery attempt of the same event. Also sent as X-CE-Event-ID.
ULID unique to this delivery attempt. Also sent as X-CE-Delivery-ID.
Time this delivery attempt was made.
true when sent from the admin Send test webhook action.
The inner event record. properties carries the event-specific model documented on each webhook; every other key is common to all events.
Show child attributes
Show child attributes
Was this page helpful?