Skip to content

Inbox

The store inbox holds every conversation a shopper has with your store: the chat on your site, where your store’s assistant answers first, and email. A reply to an order email lands in that order’s conversation. Anything the assistant can’t answer, and anyone who asks for a person, waits for your team under Needs you.

  1. Shopper writesin the chat or by email
  2. Needs youthe assistant hands over
  3. You replyby email or in the chat
  4. Waitingfor the shopper's answer
Terminal window
curl -sS "https://api.tuppence.ai/v1/store_threads?status=needs_you" \
-H "Authorization: Bearer $TUPPENCE_SECRET_KEY"

GET /v1/store_threads/{id} returns one conversation with its messages.

Terminal window
curl -sS https://api.tuppence.ai/v1/store_threads/sthr_…/messages \
-H "Authorization: Bearer $TUPPENCE_SECRET_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-d text="It's on its way and should arrive on Thursday."

The reply goes by email when the shopper left an address, from your store’s sender (your own domain once it is verified), and in the chat otherwise. The conversation then waits for the shopper.

POST /v1/store_threads/{id} with status: closed, or status: open to let your store’s assistant answer again.

statusMeans
openYour store’s assistant is answering
needs_youWaiting for your team. needs_you_reason says why
waiting_customerYou answered; waiting for the shopper
closedDone. A new message opens it again

Store emails go from Tuppence in your name until your own domain is verified. In Store settings › Email, add mail. on your domain (a subdomain, so your own email is untouched) and put its three records at your DNS host. Tuppence checks them every 10 minutes for 72 hours and names any record that is missing or wrong. A new domain sends up to 500 emails a day in its first week, doubling each week.

RouteDoes
GET /v1/merchant_sending_domainsYour sending domain, with each record and what the last check found
POST /v1/merchant_sending_domainsAdds one (domain, or the suggestion when left out)
POST /v1/merchant_sending_domains/{id}/checkChecks the records now
EventWhen
store_thread.message_receivedA shopper wrote
store_thread.needs_youA conversation went to your team
merchant_sending_domain.verifiedYour store’s emails now go from your own domain
ToolScopeDoes
list_store_threads, get_store_threadcustomers:readConversations and their messages
reply_to_store_threadcustomers:writeAnswers a shopper. A person approves every answer
update_store_threadcustomers:writeCloses a conversation or gives it back to the assistant
get_store_email_sendersites:readWhere your store’s emails come from. Adding a domain is yours, in the dashboard

Docs assistant

Open as a page
Loading the assistant…