RetailHardHat Developer docs

REST API documentation

Errors & rate limits

Build integrations that handle failures safely and recover predictably.

HTTP status codes

StatusMeaningRecommended action
400Invalid request or validation failureCheck field names, types, required values and pagination.
401Missing, invalid, expired or revoked keyVerify the credential or rotate it through private settings.
403Operation or source IP is not permittedReview key permissions and configured access restrictions.
404The requested record or endpoint was not foundCheck identifiers, paths and organization ownership.
429A request budget has been exceededWait and retry with bounded exponential backoff.
500Unexpected server errorRetry safe reads with backoff; contact support if it persists.

Validation errors

{
  "data": null,
  "meta": null,
  "errors": [
    {
      "field": "name",
      "message": "Required",
      "code": "invalid_type"
    }
  ]
}

Rate limiting

API keys have configured request budgets; additional service protections can also limit traffic. Do not hardcode an unlimited request rate. Respect rate-limit or retry headers when present and use bounded exponential backoff with jitter on 429 responses.

Retry writes carefully

Do not assume every write supports idempotency keys. If a request times out, check the resulting record before retrying a create or another non-idempotent operation.