Orders

Prepare an address share (step 1 of 2)

Resolves who would receive the seller's address in this conversation and returns a single-use confirmation token. DISCLOSES NOTHING: no message is written and the buyer cannot tell this was called. Show the seller the returned recipient name and email and get their explicit yes before calling the confirm endpoint. The address and recipient are frozen here, so nothing sent at step 2 can change either. Only a buyer who verified their email by reserving can receive an address; an enquiry-only conversation returns 403 BUYER_NOT_VERIFIED.

post/api/conversations/{id}/address/prepare

Request

  • Base URL: https://clearlist.me
  • URL: https://clearlist.me/api/conversations/{id}/address/prepare
  • 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)

Request body

addressstring

Only when the account has no street address on file, or the seller wants a different one for this pickup. Used for this share only and never saved to the account.

Response

Recipient resolved and a confirmation token minted. Nothing disclosed.

successboolean

Changes

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