v1

latestOpenAPI 3.1.02026-07-23307478.5 KB
Webhook Messages

Order Items Shipped Webhook

This is a dummy endpoint that demonstrates the webhook payload structure that will be sent to webhook subscribers when an order_items.shipped event occurs.

The actual webhooks will be sent asynchronously to the URLs specified in the webhook subscriptions that are subscribed to the order_items.shipped event type.

The webhook payload includes:

  • id: ID of the webhook message
  • event: The event type (order_items.shipped)
  • timestamp: When the event occurred
  • subscription_id: ID of the webhook subscription
  • message: The shipment data in the same format as the GET /shipments/{id} endpoint
post/api/v1/webhooks/order-items-shipped

Request body

idinteger required

ID of the webhook message

event'order_items.shipped' required

Event type of webhook message

timestampstring date-time

UTC timestamp when the event was created

subscription_idinteger nullable

ID (integer) of this property

Response

OK