Request IDs
Every response includes a unique request ID for debugging and support.
Every API response includes a request_id field — a unique identifier for that specific request.
Format
Request IDs follow the pattern req_ followed by a 16-character identifier derived from a UUID:
req_abc123def456ghThe same ID is also returned in the Request-Id response header.
Usage
Request IDs are useful for:
- Debugging — correlate client requests with server-side logs
- Support — include the request ID when reporting issues
- Audit trails — trace a specific request through the system
Where they appear
| Location | Format |
|---|---|
| Response body | "request_id": "req_..." (injected by the response envelope) |
| Response header | Request-Id: req_... |
Response
{
"id": "rst_abc123",
"name": "My Store",
"request_id": "req_abc123def456"
}