Order Delegation Webhook
This is a dummy endpoint that demonstrates the webhook payload structure that will be sent to webhook subscribers when an order.created event occurs.
The actual webhooks will be sent asynchronously to the URLs specified in the webhook subscriptions that are subscribed to the order.created event type.
The webhook payload includes:
id: ID of the webhook message
event: The event type (order.created)
timestamp: When the event occurred
subscription_id: ID of the webhook subscription
message: The order data in the same format as the GET /orders/{id} endpoint
Authorizations
Body
idinteger · min: 1RequiredExample:
ID of the webhook message
1
eventstringRequired
Event type of webhook message
timestampstring · date-timeOptional
UTC timestamp when the event was created
subscription_idany ofOptional
ID of the subscription
integer · min: 1OptionalExample:
ID (integer) of this property
1
nullOptional
Responses
200
OK
post
POST /api/v1/webhooks/order-created HTTP/1.1
Host:
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1356
{
"id": 1,
"event": "text",
"timestamp": "2025-07-04T23:31:49.020Z",
"message": {
"order_items": [
{
"return_tracking_key": "text",
"shipment_tracking_key": "text",
"sku": "text",
"id": 1,
"product_variant": 1,
"vat": 19,
"price_without_tax": 1,
"price_with_tax": 1,
"custom_data": {},
"status": "open",
"shopify_fulfillment_item_id": "text"
}
],
"order_number": "text",
"delivery_document_url": "text",
"created_at": "2025-07-04T23:31:49.020Z",
"updated_at": "2025-07-04T23:31:49.020Z",
"customer_key": "text",
"custom_data": {},
"shop": 1,
"carrier_key": "text",
"payment_method": "text",
"billing_street": "text",
"billing_zip_code": "text",
"billing_city": "text",
"billing_country_code": "text",
"billing_recipient_gender": "text",
"billing_recipient_first_name": "text",
"billing_recipient_last_name": "text",
"billing_additional": "text",
"shipping_street": "text",
"shipping_zip_code": "text",
"shipping_city": "text",
"shipping_country_code": "text",
"shipping_additional": "text",
"shipping_collection_point_key": "text",
"shipping_collection_point_type": "text",
"shipping_collection_point_customer_key": "text",
"shipping_collection_point_description": "text",
"shipping_recipient_gender": "text",
"shipping_recipient_first_name": "text",
"shipping_recipient_last_name": "text",
"currency_code": "text",
"cost_without_tax": 1,
"cost_with_tax": 1,
"shopify_order_id": "text",
"status": "open",
"fulfillment_type": "dropshipping"
},
"subscription_id": 1
}
200
OK
No content
Last updated
Was this helpful?