Skip to content
Livstick Developers

Three hook points in a purchase flow

Wherever your order lives — a custom cart, a headless storefront, an internal order management tool — the same three moments recur. Each one maps to a small, well-defined call.

  • Order confirmation — create the container, using the order number as crid, and offer recording to the buyer or the recipient.
  • Preparation or shipment — generate the QR code or the card if the journey is physical, or record carrier tracking if it is not.
  • Delivery or unboxing — trigger delivery of the recorded message.

Use your order number as crid

The decisive choice in this integration is made once, at the first call: let the order number be the crid.

Hook points and calls

The same three moments, matched to the Client API v3 operation behind each one.

Checkout hook points
Moment Call What it does
Order confirmation POST /containers Creates the container with crid set to the order number; returns editKey once, for offering recording.
Preparation or shipment (physical) GET /containers/{crid}/qrcode or GET /containers/{crid}/card Generates the QR code (PNG) or the printable card (PDF) to include with the shipment.
Preparation or shipment (not physical) PATCH /containers/{crid} Records shipmentCarrier and shipmentCode against the container.
Delivery or unboxing POST /containers/{crid}/notify Triggers delivery to the recipient.

What to plan for on your side

Two decisions belong to your integration, not to Livstick.

  • Capture and store editKey the moment the container is created — it is returned only at that point, and there is no endpoint to retrieve it afterwards. Without it, you cannot grant write access to that container from a browser later.
  • Decide where the buyer or recipient records: at order confirmation, from a link you send, or later at unboxing through a QR code or card. This shapes which hook points you actually implement.

Pick your variant

The exact shape of these hook points — what triggers recording, what the recipient sees, how delivery is timed — depends on the journey you are building. These scenarios detail the variants: