Orders

Close out a pickup: sold or no-show (step 2 of 2 for an API key)

The seller's "did this pickup happen?" action. sold marks the reservation's items sold, completes it and emails the buyer. noshow cancels the reservation, returns the items to sale, frees any booked slot and advances the queue. Cannot be undone. An API key or OAuth token must send confirmation_token from POST /api/reservations/{id}/pickup-confirm/prepare, and the action is taken from that token. A partial close-out answers 500 with retryable: true and leaves the reservation active; re-run it with the same token. A reservation that is no longer active answers 200 with outcome: already_processed and changes nothing.

post/api/reservations/{id}/pickup-confirm

Request

  • Base URL: https://clearlist.me
  • URL: https://clearlist.me/api/reservations/{id}/pickup-confirm
  • Auth: one of:
    • API key in header X-ClearList-API-Key
    • OAuth 2 (authorization code, authorization URL https://clearlist.me/oauth/authorize, token URL https://clearlist.me/api/oauth/token, scopes: write)

Headers

Idempotency-Keystring

Unique client-generated key (1-255 chars from A-Za-z0-9_-:.; a UUID works well), scoped to the seller and the operation. The first successful (2xx) response is stored for 24h; retrying the identical request with the same key replays it instead of re-executing, so network-failure retries never create duplicates. A duplicate that arrives while the first is still running gets 409 idempotency_conflict. The same key with a different body (byte for byte) or a different kind of credential gets 422 idempotency_key_reuse and leaves the original record in place: send a new key. An error the operation itself returns is never stored and releases the key.

Request body

action'sold' | 'noshow'

Required for the seller's own session or email link. For an API key the action comes from confirmation_token; it may be echoed here and must then match (409 CONFIRMATION_MISMATCH otherwise).

confirmation_tokenstring

Required for an API key or OAuth token. From the prepare step. Reusable for 10 minutes while the reservation is still active, so a partial close-out can be re-run.

tokenstring

The token from the seller's pickup-check email. Not used by agents.

Response

Close-out applied, or outcome: already_processed when the reservation was no longer active.

successboolean required
errorstring required

Human-readable error message.

codestring

Machine-readable error code, e.g. route_not_found, invalid_token, rate_limited.

messagestring

Detailed message.

hintstring

Resolution guidance for agents.

retryableboolean

Present on refusals that are worth retrying unchanged. Currently only a wrong-conversation address confirmation, where the token is untouched and only the id was wrong. Absent means terminal.

Changes

No recorded changes to this operation across all 1 revision of this API.