Skip to content

Versions and changes

The current major version is v1 and forms part of the URL. Within one major version, EasyPick only makes backward-compatible additions such as a new optional field, webhook event, or endpoint.

Integrations must ignore unknown JSON fields and must not depend on object field order. A new enum value, removing a field, or changing field semantics requires a new major version.

  • Public responses and webhooks distinguish shipment status from physical compartment compartment_state.
  • The door_available webhook is emitted after every actual compartment release.
  • A new idempotent POST /shipments/{shipment_id}/retry endpoint creates another attempt after safe recovery from fault.
  • Responses and webhooks include attempt_number and retry_of_shipment_id to distinguish attempts.
  • Public /v1 namespace and ep_live_ / ep_test_ Bearer API keys.
  • Atomic compartment reservation with external_order_id idempotency.
  • Audited PIN reveal.
  • Signed webhooks with at-least-once delivery.
  • Isolated sandbox with deterministic shipment transitions.
  • Czech and English OpenAPI documents.