Issue invoice replacement

Issues replacement serials for a completed serial-based invoice. By default, replacements cannot exceed the original purchased quantity. Set override_remaining_quantity to true for a manual support override when a previous replacement also failed.

POST /dev/v1/invoices/{uniqid}/replacements

Issue invoice replacement

cURL

curl --request POST \
  --url https://api.shoppex.io/dev/v1/invoices/{uniqid}/replacements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "full": "false",
  "quantity": 1,
  "product_id": "prod_2"
}
'

200

{
  "data": {
    "id": "replacement_1",
    "invoice_id": "33333333-3333-4333-8333-333333333333",
    "product_id": "prod_2",
    "quantity": 1,
    "message": "Replacement issued.",
    "created_at": 1712059800
  }
}

Authorizations

Authorization · string · header · required

Use your Shoppex API key in the Authorization header.

Path Parameters

uniqid · string · required

Body

application/jsonmultipart/form-datatext/plain

full · Option 1 · enum<string> Option 2 · enum<string>

Available options: true

quantity · number | null

product_id · string | null

Maximum string length: 50

reason · string | null

Maximum string length: 500

override_remaining_quantity · boolean

Response

200 - application/json

Successful response

data · object