This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

Claim Order

Production Env

http://127.0.0.1:3658/m1/543334-505232-default

POST

/store/orders/batch/customer/token

Allow the logged-in customer to claim ownership of one or more orders. This generates a token that can be used later on to verify the claim using the Verify Order Claim API Route. This also emits the event order-update-token.created. So, if you have a notification provider installed that handles this event and sends the customer a notification, such as an email, the customer should receive instructions on how to finalize their claim ownership.

Request

Body Params application/json

Examples

Responses

🟢200OK

application/json

Body

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl -X POST '{backend_url}/store/batch/customer/token' \
-H 'Content-Type: application/json' \
--data-raw '{
    "order_ids": ["id"],
}'

Response Example

200 - Example 1

{}

Modified at 2024-05-20 07:45:58

Get Gift Card by Code

Verify Order Claim