BizKitHub
DocsAPI ReferenceComplaint/api/v1/shop/complaint/detail
getComplaintPublic API v1

/api/v1/shop/complaint/detail

Returns full complaint detail including items, events timeline, refund information, and satisfaction feedback.

Use this endpoint to check the current status and history of a complaint. The events array contains the full timeline of status changes and messages.

complaintgetApiV1ShopComplaintDetail

Parameters

2 query

Query parameters

· 2
apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE
idstringRequired

Complaint external ID returned from the create endpoint.

Examplea1b2c3d4e5f6g7h8

Response schema

1 status code documented

200Success
object | object
One of 2:
Variant 1
exist"true"Required

Indicator of whether the complaint exists.

idstringRequired

Complaint external ID.

Examplea1b2c3d4e5f6g7h8
orderNumberstringOptional

Linked order number.

Example25000087
variantobjectRequired
idnumberRequired

Variant ID.

codestringRequired

Variant code.

Examplereklamace
labelstringRequired

Variant display label.

ExampleReklamace
statusstringRequired

Current complaint status.

Examplesnewopenwaitresolverejectclosed
isResolvedbooleanRequired

Indicator of whether the complaint has been resolved.

Examplefalse
descriptionstringRequired

Complaint description provided by the customer.

customerNamestringRequired

Customer full name.

ExampleJan Novák
emailstringOptional

Customer e-mail.

phonestringOptional

Customer phone number.

refundobjectOptional
countrystringOptional

Refund country code.

bankAccountstringOptional

Refund bank account.

variableSymbolstringOptional

Refund variable symbol.

satisfactionobjectOptional
scorenumberRequired

Satisfaction score 1–10.

Example8
messagestringOptional

Customer feedback message.

insertedDateDate | string | string | numberRequired

Date and time the complaint was created.

One of 4:
Variant 1
Date

Date and time the complaint was created.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
updatedDateDate | string | string | numberRequired

Date and time the complaint was last updated.

One of 4:
Variant 1
Date

Date and time the complaint was last updated.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
dueDateDate | string | string | numberOptional

Deadline for complaint resolution.

One of 4:
Variant 1
Date

Deadline for complaint resolution.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
resolvedDateDate | string | string | numberOptional

Date and time the complaint was resolved.

One of 4:
Variant 1
Date

Date and time the complaint was resolved.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
itemsobject[]Required
Each array item:
idnumberRequired

Complaint item ID.

labelstringRequired

Item description.

quantitynumberRequired

Item quantity.

pricenumberOptional

Claimed item price.

eventsobject[]Required

Complaint timeline — status changes, internal notes, and customer-facing messages.

Each array item:
idnumberRequired

Event ID.

statusstringOptional

Status at the time of this event.

shareWithCustomerbooleanRequired

Indicator of whether this event is visible to the customer.

subjectstringOptional

Event subject.

messagestringOptional

Event message body.

insertedDateDate | string | string | numberRequired

Date and time the event was created.

One of 4:
Variant 1
Date

Date and time the event was created.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
Variant 2
exist"false"Required

Complaint does not exist or does not belong to this organisation.

Response example

application/json
{
  "exist": true,
  "id": "a1b2c3d4e5f6g7h8",
  "orderNumber": "25000087",
  "variant": {
    "id": 0,
    "code": "reklamace",
    "label": "Reklamace"
  },
  "status": "new",
  "isResolved": false,
  "description": "example_description",
  "customerName": "Jan Novák",
  "email": "example_email",
  "phone": "example_phone",
  "refund": {
    "country": "example_country",
    "bankAccount": "example_bankAccount",
    "variableSymbol": "example_variableSymbol"
  },
  "satisfaction": {
    "score": 8,
    "message": "example_message"
  },
  "items": [
    {
      "id": 0,
      "label": "example_label",
      "quantity": 0,
      "price": 0
    }
  ],
  "events": [
    {
      "id": 0,
      "status": "example_status",
      "shareWithCustomer": false,
      "subject": "example_subject",
      "message": "example_message"
    }
  ]
}

Request example

GET /api/v1/shop/complaint/detail

get
curl -X GET "https://api.bizkithub.com/api/v1/shop/complaint/detail?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&id=a1b2c3d4e5f6g7h8" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key