comecerodocs

Shipments

Physical delivery of order items, with carrier and tracking.

Endpoints

post/orders/{order_id}/shipmentsCreate a shipmentget/shipmentsList shipmentsget/shipments/{shipment_id}Get a shipmentpost/shipments/{shipment_id}Update a shipmentdelete/shipments/{shipment_id}Delete a shipmentget/shipments/{shipment_id}/notificationsList a shipment's notifications

Guides that use it

Auto fulfill and capture delay

How fulfillment settings decide when order items are marked fulfilled and when an authorized payment is captured, so you can take the money only after shipping.

Undo a scheduled cancellation POST

Removes a cancellation that was scheduled for the end of the current period, for the subscription and all its items, so it keeps renewing. The `subscription:cancellation_unscheduled` event fires. A subscription that is already cancelled cannot be uncancelled (`422`). No body. Secret, trusted and limited tokens may call it. A limited token may only do this for the customer it is signed in as, and only when your subscription settings allow customers to cancel (otherwise `403`).

Create a shipment POST

Records a parcel sent for the order: the items and quantities in it, and the carrier and tracking number. Each item is marked fulfilled once all of its units have shipped. When that makes the whole order fulfilled, any pending (authorized) payment is captured (money moves) and the `order:fulfilled` event fires. The `shipment:created` event fires and the customer is sent the shipment email. Needs a secret or trusted token. Limited tokens get `403`.