get_checkout

com.robotrunk/robotrunk · Verify this server

Reads the current state of a checkout at a store, by checkout_id. Use this when you need the latest merchant status after creation, update or payment at the store. Not for the demo checkout's id (merchant null); read that one with get_order. Outputs: resource, status, next_actions and suggested_tools. A status of requires_escalation, or the message store_checkout_step, means the store needs a step finished on its own checkout page: call complete_checkout; its link opens that page, and the step is finished there before paying, by the person or by you. With click_and_collect_on_store_page, keep this checkout's link to collect: the choice is on that page; send the person there, not to the store's website separately. Error recovery: buyer_identity_contact_method_required means send buyer.email from the person with update_checkout; NOT_A_RAIL_CHECKOUT means the id is not a ucp_ checkout, so call create_checkout with a merchant; continuation_not_found means that reference is unknown, expired (they last up to 24 hours) or from another environment, so call create_checkout again; RUN_AUTH_REQUIRED means checkout_id was not the reference an earlier answer returned, or the 24-hour run behind it has ended, so send it back exactly as given and, if you did, call create_checkout again; CHECKOUT_NOT_FOUND means that checkout cannot be read, so never guess an id; RATE_LIMITED means wait and retry; SERVICE_UNAVAILABLE or a store error (UCP_MERCHANT_BUSY, UCP_MERCHANT_UNAVAILABLE) means retry shortly; any other error, including tool_layer_failure: retry once, then call submit_feedback. Next: update_checkout while the status asks for details, complete_checkout when it is ready_for_complete. Full guide: get_tool_guide or /agent/tools.json#get_checkout Example call: {"checkout_id":"ucp_transcend-dev-lab_abc123"}