BizKitHub
DocsInteractive API Docs/api/v1/shop/complaint/set-status
post

/api/v1/shop/complaint/set-status

Changes the complaint status.

Each status transition is recorded in the complaint event timeline. Terminal statuses (resolve, reject, closed) mark the complaint as resolved.

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

1 query, 2 body 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

complaintIdstringrequired

Complaint external ID to update.

statusstringrequired

New complaint status.

Available statuses:

  • new — Complaint has been filed, not yet reviewed
  • open — Complaint is being processed by staff
  • wait — Waiting for customer response or external input
  • resolve — Complaint has been resolved in favour of the customer
  • reject — Complaint has been rejected
  • closed — Complaint is closed (final state)

Setting status to resolve or closed automatically marks the complaint as resolved and sets the resolvedDate.

Example Request

JavaScript fetch

const response = await fetch("https://api.bizkithub.com/api/v1/shop/complaint/set-status?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "complaintId": "a1b2c3d4e5f6g7h8",
    "status": "new"
  })
});

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

Example Response

200Success
{
  "success": true
}

cURL

Command line example

curl -X POST "https://api.bizkithub.com/api/v1/shop/complaint/set-status?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -d '{
  "complaintId": "a1b2c3d4e5f6g7h8",
  "status": "new"
}'

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key
Back to API DocumentationAPI Reference