DocsInteractive API Docs/api/v1/shop/complaint/detail
get

/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.

Endpoint Info
Base URLapi.bizkithub.com
AuthBearer Token
Methods1
Authentication Required

This endpoint requires a valid API key passed as a query parameter or Bearer token.

Get your API key

Parameters

2 query parameters

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

idstringrequired

Complaint external ID returned from the create endpoint.

Example Request

JavaScript fetch

const response = await fetch("https://api.bizkithub.com/api/v1/shop/complaint/detail?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&id=a1b2c3d4e5f6g7h8", {
  method: "GET",
  headers: {
    "Content-Type": "application/json"
  }
});

const data = await response.json();
console.log(data);
get

Example Response

200Success
{
  "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"
    }
  ]
}

cURL

Command line example

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

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key