Skip to navigation
Cart

Extend the capacity hold on a cart's timed tickets

Capacity held for timed tickets and packages in a cart is only held for a limited time before it expires. Call this while the shopper is still deciding — for example when a countdown in the UI is running low — to extend how long the held slots stay reserved. It is safe to call this even after the hold has already lapsed: a fresh hold is taken automatically, subject to the slots still being available. While more than 20 minutes of the hold remain, the current hold is returned unchanged rather than extended.

Headers

x-entriastringRequired

Identifies which store this request is for. Required on every store-scoped route. It is not authentication and not a secret — it grants no privileges and is safe to send from a browser. You receive the value once your Entria backend has been created and configured. Missing header returns 400; an unknown store returns 404.

Request

This endpoint expects an object.
cartIdstringRequired
Id of the cart whose capacity hold should be extended.

Response

The cart’s timed lines remain reserved: the hold was extended, or returned unchanged while more than 20 minutes of it remain. Read the hold from this body: GET /api/cart is cached and may briefly still report the previous token and an already-elapsed expiry, which is not a lapsed hold.

successboolean

True when the hold is valid: either extended, or returned unchanged because more than 20 minutes of it remain.

reservationTokenstring or nullOptional
The hold token now in force, as this call left it.
reservationExpirationstring or nullOptional

When the extended hold lapses. Read this instead of re-reading the cart.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error