Claim Order

POST

/store/orders/batch/customer/token

Store API/OrdersOrders

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

order_ids

array[string]

required

The ID of the orders to claim

Example

{
  "order_ids": [
    "string"
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/store/orders/batch/customer/token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "order_ids": [
        "string"
    ]
}'

Responses

🟢200OK

application/json

Body

object {0}

Example

{}

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

Modified at 2025-04-11 01:45:37

Get Gift Card by Code

Verify Order Claim