Skip to main content

Import Order Shipments

Shipments add useful information for end customers and sales reps about deliveries and track and trace. With shipment data, it is also possible to see which items are yet in backorder.

When to create shipments​

While updating an order status already gives insight into the state of an order, shipments provide more detailed delivery information. Shipments are typically created when an external fulfillment system has shipping details to report back to Propeller.

Create a shipment​

POST /v2/orders/shipments
{
    "orderId": 36,
    "status": "CREATED",
    "items": [
        {
            "orderItemId": 27594,
            "quantity": 4,
            "sku": "Y2200"
        }
    ],
    "trackAndTraces": [
        {
            "code": "trk123.nl",
            "carrierId": 102
        }
    ]
}

The request includes:

  • orderId: the order this shipment belongs to
  • status: the shipment status. Possible values are CREATED, PROCESSING, IN_TRANSIT, OUT_FOR_DELIVERY, DELIVERED, CANCELED, PARTIALLY_DELIVERED, FAILED_DELIVERY and EXCEPTION
  • items: references order items by orderItemId with the quantity being shipped. Items can only reference items that exist on the order. It is not possible to add shipment info for more or different items than there are on the order.
  • trackAndTraces: track and trace codes with a carrier reference

Updating shipment status​

PATCH /v2/orders/shipments/{id}

It can make sense to update the shipment status along the way (for example OUT_FOR_DELIVERY, DELIVERED). You can also make sure the track and trace link is accurate so that opening it always provides the correct and up to date tracking status.

See also​