asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: added idempotency key documentation (#4039)

Browse Source
This commit is contained in:
Shahed Nasser
2023-05-08 19:21:07 +03:00
committed by GitHub
parent e9ca647a1d
commit a8887cd02f
22 changed files with 290 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/modules/carts-and-checkout/backend/cart-completion-strategy.md
+1 -1
View File
@@ -90,7 +90,7 @@ The cart completion strategy is required to implement a single method: the `comp
The method accepts three parameters:
- `cartId`: the first parameter of the method, which is a string indicating the ID of the cart to complete.
- `idempotencyKey`: the second parameter of the method, which is an instance of the `IdempotencyKey` entity. The idempotency key is retrieved based on the idempotency key passed in the header of the request, and it’s used to determine the current point reached in the checkout flow to avoid inconsistencies on interruptions. You can learn more about the idempotency key [here](../cart.md#idempotency-key).
- `idempotencyKey`: the second parameter of the method, which is an instance of the `IdempotencyKey` entity. The idempotency key is retrieved based on the idempotency key passed in the header of the request, and it’s used to determine the current point reached in the checkout flow to avoid inconsistencies on interruptions. You can learn more about the idempotency key [here](../cart.md#idempotency-key). You can also learn how to use it within your strategy by following [this guide](../../../development/idempotency-key/use-service.md)
- `context`: the third parameter of the method, which is an object that holds a single property `ip`. `ip` is a string indicating the IP of the customer.
The completion strategy is expected to return an object with the following properties: