Order Status Update Webhooks

Order Shipped Webhook

post

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

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

The webhook payload includes:

  • id: ID of the webhook message

  • event: The event type (order.shipped)

  • 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: 1Required

ID of the webhook message

Example: 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: 1Optional

ID (integer) of this property

Example: 1
or
nullOptional
Responses
200

OK

post
POST /api/v1/webhooks/order-shipped HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1273

{
  "id": 1,
  "event": "text",
  "timestamp": "2025-08-22T18:12:19.519Z",
  "message": {
    "order_items": [
      {
        "return_tracking_key": "text",
        "shipment_tracking_key": "text",
        "sku": "text",
        "status": "open",
        "id": 1,
        "vat": 19,
        "price_without_tax": 1,
        "price_with_tax": 1,
        "custom_data": {}
      }
    ],
    "order_number": "text",
    "delivery_document_url": "text",
    "status": "open",
    "customer_key": "text",
    "carrier_key": "text",
    "shop": 1,
    "created_at": "2025-08-22T18:12:19.519Z",
    "updated_at": "2025-08-22T18:12:19.519Z",
    "fulfillment_type": "dropshipping",
    "custom_data": {},
    "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
  },
  "subscription_id": 1
}
200

OK

No content

Order Cancelled Webhook

post

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

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

The webhook payload includes:

  • id: ID of the webhook message

  • event: The event type (order.cancelled)

  • 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: 1Required

ID of the webhook message

Example: 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: 1Optional

ID (integer) of this property

Example: 1
or
nullOptional
Responses
200

OK

post
POST /api/v1/webhooks/order-cancelled HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1273

{
  "id": 1,
  "event": "text",
  "timestamp": "2025-08-22T18:12:19.519Z",
  "message": {
    "order_items": [
      {
        "return_tracking_key": "text",
        "shipment_tracking_key": "text",
        "sku": "text",
        "status": "open",
        "id": 1,
        "vat": 19,
        "price_without_tax": 1,
        "price_with_tax": 1,
        "custom_data": {}
      }
    ],
    "order_number": "text",
    "delivery_document_url": "text",
    "status": "open",
    "customer_key": "text",
    "carrier_key": "text",
    "shop": 1,
    "created_at": "2025-08-22T18:12:19.519Z",
    "updated_at": "2025-08-22T18:12:19.519Z",
    "fulfillment_type": "dropshipping",
    "custom_data": {},
    "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
  },
  "subscription_id": 1
}
200

OK

No content

Order Returned Webhook

post

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

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

The webhook payload includes:

  • id: ID of the webhook message

  • event: The event type (order.returned)

  • 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: 1Required

ID of the webhook message

Example: 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: 1Optional

ID (integer) of this property

Example: 1
or
nullOptional
Responses
200

OK

post
POST /api/v1/webhooks/order-returned HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1273

{
  "id": 1,
  "event": "text",
  "timestamp": "2025-08-22T18:12:19.519Z",
  "message": {
    "order_items": [
      {
        "return_tracking_key": "text",
        "shipment_tracking_key": "text",
        "sku": "text",
        "status": "open",
        "id": 1,
        "vat": 19,
        "price_without_tax": 1,
        "price_with_tax": 1,
        "custom_data": {}
      }
    ],
    "order_number": "text",
    "delivery_document_url": "text",
    "status": "open",
    "customer_key": "text",
    "carrier_key": "text",
    "shop": 1,
    "created_at": "2025-08-22T18:12:19.519Z",
    "updated_at": "2025-08-22T18:12:19.519Z",
    "fulfillment_type": "dropshipping",
    "custom_data": {},
    "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
  },
  "subscription_id": 1
}
200

OK

No content
PreviousOrder Delegation WebhookNextOrder Item Status Update Webhooks

Last updated

Was this helpful?