BizKitHub
DocsAPI ReferenceReview/api/v1/shop/review/allowance
getReviewPublic API v1

/api/v1/shop/review/allowance

Each delivered order entitles the customer to one shop review and one review per product in the order. An order counts once it has been delivered (status done) for delayDays days. Cancelled orders never count. pending = orders that will unlock a review later, reviewed = orders already used.

reviewgetApiV1ShopReviewAllowance

Parameters

3 query

Query parameters

· 3
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

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE
identityIdstringRequired

Logged user identity (from your frontend cookies). Learn more

ExampleZ9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg
productSlugstringOptional

Slug of the product. Omit for a review of the shop itself.

Exampleset-start

Response schema

1 status code documented

200Success
canReviewbooleanRequired
remainingnumberRequired

How many reviews the customer can write now.

pendingnumberRequired
reviewednumberRequired
delayDaysnumberRequired
maxTextLengthnumberRequired
suggestedAuthorstringOptional

Name from the customer profile, to prefill the form.

Response example

application/json
{
  "canReview": false,
  "remaining": 0,
  "pending": 0,
  "reviewed": 0,
  "delayDays": 0,
  "maxTextLength": 0,
  "suggestedAuthor": "example_suggestedAuthor"
}

Request example

GET /api/v1/shop/review/allowance

get
curl -X GET "https://api.bizkithub.com/api/v1/shop/review/allowance?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&identityId=Z9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg&productSlug=set-start" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key