Problem
Type: object.
| Name | Type | Description |
|---|---|---|
code required | string | |
detail required | string | |
requestId required | string | |
retryable required | boolean | |
status required | integer | |
title required | string | |
type required | string (uri) | A stable identifier of the problem: https://api.compudime.com/docs/errors#<code>, the same on every deployment. Compare it as a string; it is also the code's entry on the errors page, so following it explains the problem. |
docsUrl | string (uri) | Where this problem code is documented, on the address you call the API on: <API address>/docs/errors#<code>. Present when the deployment knows its address. |
integrationId | string | The integration the API key belongs to. Present once the key has been authenticated: on every problem except a 401 and a 404 or 405 answered before authentication. Quote it with requestId when asking CompuDime for support. |
statusUrl | string (uri) | The public status page (no key needed): check it before retrying a 5xx. A deployment without a status page names its own readiness report, <public base URL>/readyz. Present when the deployment knows either. |
storeId | string | The store the API key belongs to. Present exactly when integrationId is; never on a 401. |
support | string (uri) | Where to ask CompuDime for help, as a mailto: URI: mailto:<support address>. Write there with requestId, and integrationId when the problem has one; never send a key. Present when the deployment has a support address. |
No other fields appear.
Used by
- GET
/healthz - GET
/openapi.json - GET
/readyz - GET
/v1/accounting/journal-entries - GET
/v1/accounting/mapping - GET
/v1/accounting/sales-summaries - GET
/v1/brands - GET
/v1/capabilities - GET
/v1/catalog/snapshots/current - GET
/v1/categories - GET
/v1/customers - GET
/v1/customers/lookup - GET
/v1/customers/{posCustomerId} - GET
/v1/delivery/routes - GET
/v1/inventory/onhand - GET
/v1/invoices - GET
/v1/invoices/external/{externalId} - GET
/v1/invoices/{posInvoiceId} - GET
/v1/me - POST
/v1/orders - GET
/v1/orders/external/{externalOrderId} - GET
/v1/orders/{orderId} - GET
/v1/products - GET
/v1/products/lookup/{code} - GET
/v1/products/{productCode} - GET
/v1/promotions - GET
/v1/promotions/mix-match/{groupId} - GET
/v1/purchase-orders - GET
/v1/purchase-orders/{posPurchaseOrderId} - GET
/v1/reasons - GET
/v1/receiving - GET
/v1/receiving/{posReceivingId} - GET
/v1/sales/daily - GET
/v1/sales/movement - GET
/v1/sales/zreport - GET
/v1/store - GET
/v1/tags - GET
/v1/tenders - GET
/v1/tickets - GET
/v1/tickets/{ticketId} - GET
/v1/usage/current - GET
/v1/webhooks - POST
/v1/webhooks - DELETE
/v1/webhooks/{webhookId} - GET
/v1/webhooks/{webhookId} - GET
/v1/webhooks/{webhookId}/deliveries - POST
/v1/webhooks/{webhookId}/rotate-secret - POST
/v1/webhooks/{webhookId}/test