BizKitHub
DocsAPI ReferenceComplaint/bff/complaint/create
postComplaintAdmin BFF

/bff/complaint/create

Creates a new complaint case. Optionally links to an existing order and its items. An initial event is automatically created in the complaint timeline.

ComplaintpostBffComplaintCreate

Parameters

JSON body

Request body

application/json
variantCodestringRequired

Organisation-defined complaint variant code.

Examplesreklamacevracenivymena
orderIdnumberOptional

Internal order ID to link the complaint to an existing order.

Example1024
orderNumberstringOptional

Human-readable order number. Use when order is external or unavailable by ID.

Example25000087
descriptionstringRequired

Customer-provided description and reason for the complaint.

ExampleProduct arrived damaged, visible scratch on the surface.
customerNamestringRequired

Full name of the customer filing the complaint.

ExampleJan Novák
emailstringOptional

Customer e-mail for complaint communication.

Examplejan@example.com
phonestringOptional

Customer phone number.

Example+420 777 123 456
pricenumberOptional

Total claimed amount in the order-defined currency.

Example1500
currencyIdnumberOptional

Currency ID for the claimed amount.

Example1
refundCountrystringOptional

ISO 3166-1 alpha-2 country code for refund bank account.

ExamplesCZSK
refundBankAccountstringOptional

Bank account number for refund transfer.

Example123456789/0100
refundVariableSymbolstringOptional

Variable symbol for refund bank transfer.

Example25000087
branchIdnumberOptional

Branch ID where the product should be sent for inspection.

Example1
serviceIdnumberOptional

External service provider ID handling the complaint.

Example1
resolutionMethodCodestringOptional

Preferred resolution method code defined by organisation.

Examplesrepairexchangerefund
dueDatestringOptionaldate-time

Deadline for complaint resolution.

Example2026-02-15T00:00:00.000Z
itemsobject[]Optional

List of complained items from the original order.

Each array item:
orderItemIdnumberOptional

Link to original order item being complained about.

Example501
labelstringRequired

Item description as displayed in the complaint.

ExampleCheese burger
quantitynumberOptional

Number of items being complained about. Defaults to 1.

Example1
pricenumberOptional

Claimed unit price of the item.

Example250
currencyIdnumberOptional

Currency ID for the item price.

Example1

Response schema

1 status code documented

200Success
successbooleanRequired

Indicates whether the operation completed successfully.

Default: true
idstringRequired

Newly created complaint external ID.

Examplea1b2c3d4

Response example

application/json
{
  "success": true,
  "id": "a1b2c3d4"
}

Request example

POST /bff/complaint/create

post
curl -X POST "https://api.bizkithub.com/bff/complaint/create" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "variantCode": "reklamace",
  "orderId": 1024,
  "orderNumber": "25000087",
  "description": "Product arrived damaged, visible scratch on the surface.",
  "customerName": "Jan Novák",
  "email": "jan@example.com",
  "phone": "+420 777 123 456",
  "price": 1500,
  "currencyId": 1,
  "refundCountry": "CZ",
  "refundBankAccount": "123456789/0100",
  "refundVariableSymbol": "25000087",
  "branchId": 1,
  "serviceId": 1,
  "resolutionMethodCode": "repair",
  "dueDate": "2026-02-15T00:00:00.000Z",
  "items": [
    {
      "orderItemId": 501,
      "label": "Cheese burger",
      "quantity": 1,
      "price": 250,
      "currencyId": 1
    }
  ]
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key