BizKitHub
DocsAPI ReferenceReview/api/v1/shop/review/create
postReviewPublic API v1

/api/v1/shop/review/create

Creates a review of the shop (no productSlug) or of a product for the logged-in customer. The review is tied to their newest delivered order not reviewed yet and is published immediately (the shop can hide it in the admin). Fails with REVIEW_NOT_ALLOWED (403) when no order entitles the customer, REVIEW_INVALID (400) on bad input or spam.

reviewpostApiV1ShopReviewCreate

Parameters

1 query · JSON body

Query parameters

· 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

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE

Request body

application/json
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
ratingstring | integerRequired

Stars, 1–5.

One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer

Stars, 1–5.

Range: 1–5
authorNamestringRequired

Name shown with the review.

Length: 1–128
textstringOptional

Review text (optional).

Length: 0–1000
localestringOptional
Length: 0–8
Examplecs
customerRealIpstringOptional

User IP address used for GEO/IP intelligence.

Accepted formats:

  • IPv4 dot-decimal, e.g. 1.1.1.1 (4 octets, 0–255, no leading zeros).
  • IPv6 as defined by RFC 4291 — full 2001:0db8:0000:0000:0000:0000:0000:0001, zero-compressed 2001:db8::1, IPv4-mapped ::ffff:1.2.3.4, or scoped literals. Both upper- and lower-case hex are accepted.

Server-side canonicalization (ipNormalize in core/src/lib/network/ipNormalize.ts):

  • Valid IPv4 is passed through verbatim.
  • Valid IPv6 is lowercased (RFC 5952 §4.3).
  • IPv4-mapped IPv6 ::ffff:X.X.X.X is unwrapped to plain IPv4 (RFC 4291 §2.5.5.2) so 1.2.3.4 and ::ffff:1.2.3.4 share one brj__geo_ip row.
  • Loopback aliases (::1, 0.0.0.0, localhost, empty string) collapse to 127.0.0.1.
  • Junk values that fail both IPv4 and IPv6 validation are silently rejected and replaced with 127.0.0.1 (loopback).

On the wire: every response returns the canonicalized form — clients can safely rely on lowercase IPv6 and the plain-IPv4 unwrap when de-duping or joining. Server-originated writers (activity log, session log, ban list) resolve the visitor IP via resolveClientIp / resolveClientIpOrNull — always native IPv6 on Vercel Edge (there is no auto-mapping to ::ffff:X.X.X.X).

Enrichment: the system resolves reverse DNS, geolocation, ASN, mobile/proxy/hosting/Tor flags via our VikiTron GEO/IP resolver for both address families. Learn more

Examples1.1.1.12001:4860:4860::8888

Response schema

1 status code documented

200Success
idstringRequired

Public review id.

authorstringRequired

Author name as entered by the customer.

initialsstringRequired

One or two initials for an avatar.

ratingnumberRequired

Stars, 1–5.

textstringOptional
datestringRequired

ISO date of the review.

replystringOptional

Public reply of the shop.

replyDatestringOptional
localestringOptional

Language the review was written in, when known.

productSlugstringOptional

Reviewed product (only with scope=products).

isVerifiedPurchasebooleanRequired

The review is tied to a real order of the author.

Response example

application/json
{
  "id": "example_id",
  "author": "example_author",
  "initials": "example_initials",
  "rating": 0,
  "text": "example_text",
  "date": "example_date",
  "reply": "example_reply",
  "replyDate": "example_replyDate",
  "locale": "example_locale",
  "productSlug": "example_productSlug",
  "isVerifiedPurchase": false
}

Request example

POST /api/v1/shop/review/create

post
curl -X POST "https://api.bizkithub.com/api/v1/shop/review/create?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "identityId": "Z9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg",
  "productSlug": "set-start",
  "authorName": "example_authorName",
  "text": "example_text",
  "locale": "cs",
  "customerRealIp": "1.1.1.1"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key