Checkout intents
Webhooks are sent when a checkout intent transitions between states. See the Checkout Intent Lifecycle for the full state machine.| Event | Description | State Transition |
|---|---|---|
checkout_intent.offer_retrieved | An offer is ready with pricing and availability details. | retrieving_offer → awaiting_confirmation |
checkout_intent.offer_failed | Offer retrieval failed (e.g., unsupported merchant, product unavailable). | retrieving_offer → failed |
checkout_intent.completed | The order was successfully placed and confirmed. | placing_order → completed |
checkout_intent.order_failed | Order placement failed after confirmation (e.g., out of stock, payment declined). | placing_order → failed |
Shipments
Shipment events are sent for completed orders (i.e. checkout intents in thecompleted state), and are fired whenever the corresponding shipment’s state changes.
| Event | Description | Occurs |
|---|---|---|
shipment.created | A shipment was created for an order. | When the merchant adds shipping info to a completed order for the first time. |
shipment.updated | A shipment was updated for an order. | Whenever a shipment is updated, e.g. when a tracking number becomes available or the parcel is on board a delivery vehicle. |