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

APIKeyAuth

X-API-KeystringRequired

Body

application/json

idany ofOptional

integerOptional

or

nullOptional

eventconst: order_items.shippedRequired

Event type of webhook message

timestampstring · date-timeOptional

subscription_idany ofOptional

ID of the subscription

integer · min: 1Optional

ID (integer) of this property

Example: 1

or

nullOptional

Responses

200

OK

No content

post

/api/v1/webhooks/order-items-shipped

HTTPcURLJavaScriptPython

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

{
  "id": 1,
  "event": "text",
  "timestamp": "2026-02-03T09:48:30.760Z",
  "message": {
    "items": [
      1
    ],
    "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

APIKeyAuth

X-API-KeystringRequired

Body

application/json

idany ofOptional

integerOptional

or

nullOptional

eventconst: order_items.cancelledRequired

Event type of webhook message

timestampstring · date-timeOptional

subscription_idany ofOptional

ID of the subscription

integer · min: 1Optional

ID (integer) of this property

Example: 1

or

nullOptional

Responses

200

OK

No content

post

/api/v1/webhooks/order-items-cancelled

HTTPcURLJavaScriptPython

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

{
  "id": 1,
  "event": "text",
  "timestamp": "2026-02-03T09:48:30.760Z",
  "message": {
    "items": [
      1
    ],
    "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

APIKeyAuth

X-API-KeystringRequired

Body

application/json

idany ofOptional

integerOptional

or

nullOptional

eventconst: order_items.returnedRequired

Event type of webhook message

timestampstring · date-timeOptional

subscription_idany ofOptional

ID of the subscription

integer · min: 1Optional

ID (integer) of this property

Example: 1

or

nullOptional

Responses

200

OK

No content

post

/api/v1/webhooks/order-items-returned

HTTPcURLJavaScriptPython

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

{
  "id": 1,
  "event": "text",
  "timestamp": "2026-02-03T09:48:30.760Z",
  "message": {
    "items": [
      1
    ],
    "carrier_key": "text",
    "return_tracking_key": "text",
    "tracking_key": "text"
  },
  "subscription_id": 1
}

200

OK

No content