Claim product serials

Atomically claims and removes the requested number of available serials from a base serial product without variants, then returns the claimed serial values plus the updated remaining stock. Use this endpoint when you want serial values directly and do not want to manually fetch serial IDs first.

POST /dev/v1/products/{id}/serials/claim

Claim product serials

cURL

curl --request POST \
  --url https://api.shoppex.io/dev/v1/products/{id}/serials/claim \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 2
}'

200

{
  "data": {
    "claimed_count": 2,
    "remaining_stock": 7,
    "serials": [
      {
        "id": "serial_1",
        "serial": "ABC-123",
        "variant_id": null,
        "variant_title": null,
        "created_at": "2026-03-16T10:00:00.000Z"
      },
      {
        "id": "serial_2",
        "serial": "XYZ-789",
        "variant_id": null,
        "variant_title": null,
        "created_at": "2026-03-16T10:01:00.000Z"
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Use your Shoppex API key in the Authorization header.

Path Parameters

id · string · required

Body

application/jsonmultipart/form-datatext/plain

amount · number · required

Required range: 1 <= x <= 500

Response

200 - application/json

Successful response

data · object