Order Item Status Update Webhooks

Order Items Shipped Webhook

post

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

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

HTTPcURLJavaScriptPython

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

{
  "id": 1,
  "event": "text",
  "timestamp": "2025-08-23T05:56:52.435Z",
  "message": {
    "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": {}
      }
    ],
    "carrier_key": "text",
    "return_tracking_key": "text",
    "tracking_key": "text"
  },
  "subscription_id": 1
}

200

OK

No content

Order Items Cancelled Webhook

post

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

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

The webhook payload includes:

• id: ID of the webhook message

• event: The event type (order_items.cancelled)

• 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

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

HTTPcURLJavaScriptPython

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

{
  "id": 1,
  "event": "text",
  "timestamp": "2025-08-23T05:56:52.435Z",
  "message": {
    "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": {}
      }
    ],
    "carrier_key": "text",
    "return_tracking_key": "text",
    "tracking_key": "text"
  },
  "subscription_id": 1
}

200

OK

No content

Order Items Returned Webhook

post

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

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

The webhook payload includes:

• id: ID of the webhook message

• event: The event type (order_items.returned)

• 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

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

HTTPcURLJavaScriptPython

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

{
  "id": 1,
  "event": "text",
  "timestamp": "2025-08-23T05:56:52.435Z",
  "message": {
    "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": {}
      }
    ],
    "carrier_key": "text",
    "return_tracking_key": "text",
    "tracking_key": "text"
  },
  "subscription_id": 1
}

200

OK

No content