Platitun · API · The deal · Complain about a buyer

Complain about a buyer

POST /api/v1/complaints

Key scope: orders · changes data, the Idempotency-Key header is required

A topic is required and comes from the classifier: a “just bad” complaint cannot be judged, while an accumulation of similar violations is counted automatically.

Request fields

FieldTypeWhat it is
topic requiredstringA topic from the classifier.
text requiredstringWhat happened.
orderIdstringThe order, if the complaint is about one. It determines whom the complaint is against.
reviewIdstringThe review, if the complaint is about a review.

Response fields

FieldTypeWhat it is
okbooleanThe complaint is accepted.

Refusal reasons

A rule refusal arrives as {"error":"rejected","refusal":{"kind":"…"}} with status 409. Refusals common to all endpoints are in the rules section.

CodeWhat happened and what to do
need_topicA topic from the classifier is required: a “just bad” complaint cannot be judged.
too_shortThe text is too short. A one-word answer helps neither the buyer nor the review.
not_foundThe record does not exist or is not yours. The ownership condition is in the database query itself, so someone else’s record looks like a missing one.

Nearby in this section