Store data and insights
Check orders are available
Whether this Product Metrics environment serves store orders at all.
GET /orders/availability
Scope read · Access Read only · Operation id orders.get_availability
Try it
productmetrics runs after productmetrics login; curl needs PM_TOKEN (see Authentication).
productmetrics orders get-availability --jsonResponse
API response (200):
{
"data": {
"available": true
},
"request_id": "req_01JP1NMYWCCABXND7M1EJ98H24"
}CLI output: productmetrics orders get-availability --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.
Before you call
Call once before orders.list when it is unclear; when available is false, the order operations answer not found.
Errors
A failure answers with its HTTP status and { error: { code, message, details? }, request_id }. Branch on code (stable, lower_snake); show message to the person. The CLI prints the same error with "ok": false.
{
"error": {
"code": "insufficient_scope",
"message": "This operation needs the read scope; connect again and allow it.",
"details": {
"required_scope": "read"
}
},
"request_id": "req_01JZXWG3TJPWZ6C69CH3C7C0YZ"
}| Status | Code | When |
|---|---|---|
| 401 | invalid_token | The token is missing, expired or revoked: sign in again (productmetrics login). The WWW-Authenticate header says why. |
| 403 | insufficient_scope | The token lacks the read scope (details.required_scope): sign in again and allow it. |
| 429 | rate_limited | More than 600 requests a minute for this person: wait the Retry-After seconds (60) and retry. |