Idempotency

Idempotency of GET and DELETE requests

Idempotency is a Web API design principle defined as the ability to apply the same operation multiple times without changing the result beyond the first try. The HopDrive API guarantees the idempotency of GET and DELETE requests, so it’s always safe to retry them.

Idempotent move POST requests

The four move-creation endpoints accept an optional Idempotency-Key header. Use a unique, stable value from your system for each intended request and send the same value when retrying after a timeout or connection failure.

The key is scoped to the authenticated rooftop, so you are free to number your requests however you like without worrying about what another HopDrive customer might send. A successful first request returns replayed: false; a later retry returns the original scenario and move set with replayed: true and does not create another scenario. Existing duplicate_check behavior remains available for business duplicate checks. Replay lookup runs before that check, so a retry does not get refused as a duplicate of the move its own first attempt created.

Keep the request body unchanged for a retry. If the stored use case, requested time, VIN, reference number, customer name, or customer phone differs, the API returns HTTP 409 with code idempotency_key_reused. On a round trip or a concierge-loaner request the second leg's vehicle and reference number are compared too. Some request details are not present in the replay record, so the key itself remains your promise that a retry represents the same operation.