Shipment

Purpose

We use a shipping webhook to send real-time notifications to our clients whenever an order is shipped. The webhook sends a payload with the order information listed below to the client's specified shipment endpoint. By using webhooks, we provide our clients with timely updates without requiring them to constantly check our system for changes. This makes it easier for our clients to stay up-to-date on the status of their orders and to respond quickly to any changes.

JSON

{
    "orderId": "cdf32a04-03b1-486f-b514-17002c255b4f", // Atomix internal ID   
    "orderKey": "a12345", // Your unique order ID
    "orderNumber": "#1001",
    "trackingNumber": "z123838183213932",
    "orderItems": [ // The list of items that were included in the shipment
        {
            "sku": "abc-123",
            "quantity": 1
        },
        {
            "sku": "shirt-1",
            "quantity": 2
        }
    ]
}