specification: API Commons Rate Limits
specificationVersion: '0.1'
schema: https://raw.githubusercontent.com/api-evangelist/interface-research/main/schema/api-commons.yml#/$defs/RateLimits
provider: CargoDocs
providerId: cargodocs
created: '2026-05-04'
# Provenance stamped 2026-08-11: this artifact was written by the API Evangelist
# bulk sweep dated 2026-05-04, not harvested from the provider. See roadmap#35.
method: generated
modified: '2026-05-05'
reconciled: false
tags:
  - Trade Documentation
  - Shipping
  - Supply Chain
  - Rate Limiting
description: CargoDocs does not publish public rate-limit numbers. Limits are configured per enterprise
  contract and are typically dimensioned by document volume rather than raw request rate, since DocEx
  flows are issuer/transfer/surrender events on negotiable instruments.
notes: No public rate-limit documentation found on the CargoDocs/EssDocs ReadMe portal or marketing site.
  Treat as enterprise-contract-defined.
sources:
  - https://www.essdocs.com/
responseCodes:
  throttled: 429
limits:
  - name: Per-customer contract limit
    scope: customer
    metric: varies
    limit: see enterprise agreement
policies:
  - name: Document-event semantics
    description: DocEx APIs operate over negotiable trade documents (eBoL, SWB, eWW). Throttling is more
      likely on document-state transitions than on raw read traffic; coordinate batch issuance windows
      with the EssDocs technical contact.
  - name: Backoff strategy
    description: Implement exponential backoff with jitter on 429 responses; safety-critical signing
      and surrender events should be retried only with idempotency safeguards.
  - name: Authentication scoping
    description: Each customer/partner has scoped credentials; rate caps are enforced per credential.
maintainers:
  - FN: Kin Lane
    email: kin@apievangelist.com