Skip to main content
POST
/
invoices
/
{uniqid}
/
replacements
Issue replacement
curl --request POST \
  --url https://api.shoppex.io/dev/v1/invoices/{uniqid}/replacements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "full": "true",
  "quantity": 2,
  "product_id": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "invoice_id": "<string>",
    "product_id": "<string>",
    "quantity": 123,
    "message": "<string>",
    "created_at": 123
  }
}

Authorizations

Authorization
string
header
required

Use your API key with the Bearer scheme. Get your key from Dashboard → Settings → API Keys. Format: Authorization: Bearer shx_...

Path Parameters

uniqid
string
required

Invoice unique ID

Body

application/json
full
enum<string> | null
Available options:
true,
false
quantity
integer | null
Required range: x >= 1
product_id
string | null
Maximum string length: 50

Response

Default Response

data
object
required