Confirm the shipment
The optional Shipping Assistant call after a purchase: POST /shipment/{shipment_id}/confirm, which tells your TMS a reserved shipment was actually bought.
Once the purchase completes, Kustom tells your TMS the reservation is real. The call is optional:
nothing the customer sees depends on it, and the purchase is already done when it arrives. Build
it if you want reservations confirmed in your system. It uses the shipment_id you returned from
POST /shipment, so it’s never called
for a reservation without one.
Confirm the reservation
Section titled “Confirm the reservation”POST /shipment/{shipment_id}/confirmAuthorization: Bearer <token>Kustom sends this once, when the purchase completes. There’s no body. Answer 200 or 201;
anything you send back is ignored.
| You answer | What happens |
|---|---|
200 or 201 | Done |
404 | Accepted. This is the answer if you don’t implement the endpoint |
401 | Kustom fetches a new token and tries once more |
| Anything else, or no answer | Logged at Kustom. The purchase is unaffected, and the call isn’t retried |
If you don’t implement this endpoint, answer 404. Not implementing it means every
reservation from POST /shipment is held and none is confirmed as a purchase on your system.
You’d have to learn which ones turned into purchases from the merchant, who books against your
shipment_id (tms_reference on their order).
Kustom doesn’t send it for a checkout that fell back to the merchant’s own options, or for a digital-only order.
The API reference also lists GET /shipment/{shipment_id}, to read a shipment back. Kustom
doesn’t call it, so you don’t need to build it.
Related
Section titled “Related”- Reserve and update the shipment — where
shipment_idcomes from - Build a TMS integration — the whole flow
POST /shipment/{shipment_id}/confirmin the API reference
This page is also available as Markdown — append .md to its URL — and is indexed in llms.txt.