Private product previewReview the controlled design-partner evaluation path.Explore
DevelopersAPI guides

API guides · Design guidance

Reliable by design.

Operational shipping systems must survive duplicated requests, stale data, timeouts, partial dependency failures, and human review without inventing an outcome.

Not an availability claim. Idempotent operational mutations and webhook delivery are not part of today’s public health-check contract. These patterns describe the required direction for future published integrations.

Start with identity and scope

Authenticate at the server boundary, resolve one authorised workspace, and authorise the exact capability before reading or changing a record. Do not let a browser-provided workspace identifier establish authority. See authentication and workspace scope.

Give every business operation one identity

Create a stable idempotency key for the business action and persist it with the source record. Reuse that key for transport retries. Reusing the same key with different immutable input should produce a conflict that requires investigation.

SituationRequired behaviour
Same key, same inputReturn or reconcile the original outcome without repeating the business effect.
Same key, different inputReject as a conflict; never reinterpret the prior operation.
Timeout after sendMark the outcome unknown and reconcile before another attempt.
Stale record revisionReload canonical state and require a deliberate re-review.

Model errors for operators

A machine-readable code should be stable enough for automation. A human-readable message should explain the safe next action without revealing whether inaccessible records exist. Preserve a request identifier for support and audit.

{
  "code": "STABLE_ERROR_CODE",
  "message": "Safe next action for the operator.",
  "request_id": "request-correlation-id"
}

Prepare for future webhooks

If event delivery is published later, consumers should verify signatures before processing, acknowledge accepted deliveries quickly, store the event identity, and make handlers safe to replay. Delivery order and retry windows must be documented by the future webhook contract rather than assumed.

  • Never infer success from an event timeout.
  • Do not use payload order as the only source of truth.
  • Reconcile gaps against an authorised read contract.
  • Separate event receipt from downstream business completion.

Keep local and provider outcomes separate

A validated correction, approval, or local release record does not prove that a carrier booked a shipment, produced a label, accepted a manifest, or wrote status back to a channel. Read the correction lifecycle and reliability and unknown outcomes before designing those boundaries.