What is X-ShopBack-Idempotent Id?

To help prevent duplicate requests and ensure smoother transactions between your system and our platform, we are introducing the X-ShopBack-Idempotent-Id parameter. This enhancement is designed to improve reliability by ensuring that each request is processed only once, even if it is sent multiple times due to network retries or other unexpected issues.

What is X-ShopBack-Idempotent-Id?

The X-ShopBack-Idempotent-Id is a unique identifier that you include in the header of each API request. This identifier allows our system to recognize duplicate requests and prevent them from being processed more than once.

By using this parameter, you can safely retry the same API request without risking duplicate processing (for example, double-charging or double-refunding).

Implementation Guidelines

Add the X-ShopBack-Idempotent-Id parameter to the header of your API requests.

✅ Use the same idempotent ID when:

Retrying the exact same request (same payload, same purpose).
The previous request timed out, returned an error, or no response was received, and you’re re-sending it.

❌ Use a different idempotent ID when:

Performing a new or different request (for example, a new order, new refund, or changed amount).

Important: Please ensure that the Idempotency ID you send is in UUID v4 format. For example,faa5e09a-8cf3-43f7-8309-d94deb426e66

Reference Documentation

For Bespoke API: Create Order API
For POS API: Create Dynamic QR Order API Reference