🚨 Announcement

A new version of the API is available. Please review the changelog for details.

Skip to content

Authentication ​

Kaspi Delivery uses an API key you generate in the partner console. Send it in the x-api-key header on every request.

Headers to include ​

HeaderRequiredDescription
x-api-keyYesYour API key (sandbox or production).
Idempotency-KeyRecommended on POST/DELETEA unique string per request so retries do not create duplicate deliveries.
Content-TypeYes on writesapplication/json

Example ​

bash
curl -X GET https://sandbox.kaspi.kz/delivery/v1/deliveries/dlv_01hfz18tnb7tqw \
  -H "x-api-key: YOUR_API_KEY"

Idempotency keys ​

  • Use a stable identifier such as your order id: Idempotency-Key: order-742.
  • Reusing the same key returns the original response with X-Idempotent-Replay: true.
  • Keys are stored for 24 hours in sandbox and production.

Timeouts and retries ​

  • Client timeout: 10 seconds suggested.
  • Retry on network errors and HTTP 429/5xx with exponential backoff.
  • Do not retry POST/DELETE without an idempotency key.

Error responses ​

StatusWhen it happensHow to fix
401 UnauthorizedMissing/invalid API keyVerify the key and environment.
403 ForbiddenKey is disabledRotate credentials in the console.
409 ConflictDuplicate idempotency key with different payloadReuse the same payload or generate a new key.
429 Too Many RequestsBurst exceededBack off and retry with jitter.

Move on to the Create a delivery guide for a full flow.