robotrunk.com

get_order

Reads back a store's order: the status and the totals as the store recorded them, in the store's own currency, and whether the store's own record is behind them (order_source, merchant_read). Use after the person has paid at the store and you want to check the order exists and read it back. Pass order_id or checkout_id. A store checkout_id reads that checkout's state while it has no order: a cancelled or expired checkout answers with its status and the message no_order_placed, saying no order was placed, and one still waiting on the person says no order has been confirmed yet, so call again in a moment; once the person has paid at the store's page, the store reports the order on a read of its checkout: the answer is status completed with the message order_confirmed ("The store confirmed order #1019.") and the store's order number in resource.order.label (resource.label on the order), shown only when the store reports one; resource.order.local_order_id is the order_id to read the order itself with (order_source, merchant_read, and order_from_checkout when the store's own order record was not read for it). Shipping, cancellation and refund after that are not shown. Not for placing or approving an order. Error recovery: identifier_required means pass order_id or checkout_id; not_found means no order can be read with that id, because over /mcp an order is read only with the order_id or checkout_id exactly as an earlier answer returned it, so call submit_feedback if the person did confirm, then start again with search_catalog; run_authority_missing or RUN_AUTH_REQUIRED on an id you were given means the run that owns the order has ended and no retry reaches it, so call submit_feedback; continuation_not_found means that reference is unknown, expired (references last up to 24 hours) or from another environment, so call search_catalog; rate_limited means wait 60 seconds; network_error means call again; any other error, including tool_layer_failure: retry once, then call sub…

Page: /

Input schema

{
  "type": "object",
  "properties": {
    "order_id": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 200,
      "description": "The order id from `/orders/{order_id}` after the person confirms, or null to look it up from `checkout_id`."
    },
    "checkout_id": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 200,
      "description": "The `checkout_id` from `create_checkout`, or null when you already hold `order_id`. At least one of the two must be non-null."
    },
    "shopping_session_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
      "description": "Optional server-issued shopping session correlation ID. It is not purchase authority."
    }
  },
  "required": [
    "order_id",
    "checkout_id"
  ],
  "additionalProperties": false
}