Request IDs

Every /v1 response - success or error - carries an X-Request-Id response header.

Sending your own

You can optionally send X-Request-Id on a request:

X-Request-Id: my-integration-order-sync-42

If it matches ^[A-Za-z0-9_.:-]{1,80}$, it’s preserved and echoed back exactly as sent - useful for correlating a request with your own logs/tracing. If you omit it, or send something that doesn’t match that pattern, the server generates one for you (req_...) and returns that instead.

Where it shows up

• The X-Request-Id response header, on every response.
• Inside error.requestId, on every error body.

Using it to report a problem

If something looks wrong - an unexpected error, a response that doesn’t match this documentation, a suspiciously slow response - capture the X-Request-Id (or error.requestId) and include it when you report the issue. It lets EPOS find the exact request in its logs without you needing to share request/response bodies that might contain data you’d rather not paste into a support channel.

curl -i "https://dev-api.theprioryshop.co.uk/v1/catalog/products" \
  -H "Authorization: Bearer epos_dev_sk_example_not_real" \
  | grep -i x-request-id