Skip to main content

Create Business Review

API operation: Open the endpoint in Scalar

Use POST /business/{business}/reviews to create a review for an order. The operation documented here is Review.register.

Parameter: {business} is the integer business ID in the route.

The documented schema requires order_id, quality, delivery, service, and package. A signed-in customer can review their own order; permitted staff can act for the customer. When guest UUID access is enabled, a guest can submit the order's matching hash through X-uuid-access-X. Do not expose that hash in documentation or logs.

The order determines user_id and business_id; ensure the order belongs to the business identified in the route. Do not submit a reviewer identity to override the order.

See Business reviews model.

OpenAPI reference​

Operation: POST /business/{business}/reviews

Path parameters

NameTypeRequiredDescription
businessintegerYes—

Header parameters

NameTypeRequiredDescription
X-uuid-access-XstringNo—

Request body fields

NameTypeRequired
commentanyNo
deliveryintegerYes
enabledbooleanNo
order_idintegerYes
packageintegerYes
qualityintegerYes
quality_tagsarray | nullNo
serviceintegerYes

Responses

CodeDescription
200OK (Envelope)
400Bad Request (ErrorResponse)
401Unauthorized
404Not Found
429Too Many Requests (ErrorResponse)
500Internal Server Error (ErrorResponse)
503Service Unavailable (ErrorResponse)
Open this operation in the API reference