Skip to content
v0.3

read.internal.orders_admin

The operator’s order work queue: the derived axes, the exception flags, tab counts, search by order number and tracking code (plus buyer e-mail/name for a caller holding pii.read — without it the answer says so in pii_search_excluded rather than looking like no match), and store/period filters. Paginated (limit+offset). Internal face only (PII).

  • Surface: GET /v1/read/internal/orders_admin · MCP tool read.internal.orders_admin
  • Auth:Internal read (operator) — a tenant credential is REQUIRED; requires ANY ONE of order.read, order.write. The tenant is resolved from the CALLER’s identity, never from store. Personal fields come back MASKED for an actor without pii.read (the shape is unchanged).
{
"properties": {
"created_from": {
"type": "string"
},
"created_to": {
"type": "string"
},
"limit": {
"default": 25,
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"offset": {
"default": 0,
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
"payment_status": {
"enum": [
"not_paid",
"partially_authorized",
"partially_paid",
"paid",
"partially_refunded",
"refunded"
],
"type": "string"
},
"q": {
"minLength": 1,
"type": "string"
},
"sort": {
"enum": [
"number_asc",
"number_desc",
"newest",
"oldest",
"items_desc",
"items_asc"
],
"type": "string"
},
"store": {
"minLength": 1,
"type": "string"
},
"tab": {
"default": "all",
"enum": [
"all",
"attention",
"to_prepare",
"preparing",
"shipped",
"completed",
"cancelled"
],
"type": "string"
}
},
"type": "object"
}

Open (unknown) — this capability does not declare an output schema.

validation_failed (400) · not_found (404) · unauthorized (401) · forbidden (403)