DocsAPI ReferenceComplaint/api/v1/shop/complaint/set-status
postComplaintPublic API v1

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

complaintpostApiV1ShopComplaintSet-status

Parameters

1 query · 2 body

3 total
Query · 1
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

Body · 2
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.

Request

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

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

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