DocsAPI ReferenceOrder/bff/order/add-credit
postOrderAdmin BFF

/bff/order/add-credit

Adds a credit-granting line item to the order and recalculates the total price.

OrderpostBffOrderAdd-credit

Parameters

5 body

5 total
Body · 5
orderHashstringRequired

Unique order hash identifier.

labelstringRequired

Item label displayed on invoice.

pricenumberRequired

Unit price including VAT.

creditnumberRequired

Credit amount to grant to the customer.

vatnumberRequired

VAT rate in percent (e.g. 21).

Request

POST /bff/order/add-credit

post
curl -X POST "https://api.bizkithub.com/bff/order/add-credit" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "orderHash": "example_orderHash",
  "label": "example_label",
  "price": 0,
  "credit": 0,
  "vat": 0
}'

Response

JSON payload

{
  "success": true
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key