Skip to main content
POST
/
reviews
Create review
curl --request POST \
  --url https://store.salesive.com/api/v1/reviews \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-shop-id: <api-key>' \
  --data '
{
  "productId": "<string>",
  "rating": 3,
  "comment": "<string>",
  "orderId": "<string>"
}
'

​
Request

POST /reviews
Authorization: Bearer {{token}}
x-shop-id: {{shopId}}
Content-Type: application/json

{
  "productId": "68e5bb463a1fc56a8ac150bf",
  "orderId": "690ff00acf4de460fd1f6114",
  "rating": 5,
  "comment": "Excellent product! Very satisfied with the quality."
}

​
Headers

HeaderTypeDescription
AuthorizationstringProvide the customer token as Bearer <jwt>.
x-shop-idstringIdentify the shop.
Content-TypestringAlways set to application/json.

​
Body parameters

FieldTypeRequiredDescription
productIdstringYesProduct identifier to review.
orderIdstringYesOrder ID containing the product.
ratingintegerYesRating from 1 to 5.
commentstringYesReview text.

​
Successful response

{
    "status": 201,
    "success": true,
    "message": "Review created successfully",
    "data": {
        "_id": "678bd902e37452d19efcb4eb",
        "product": "68e5bb463a1fc56a8ac150bf",
        "order": "690ff00acf4de460fd1f6114",
        "user": {
            "_id": "68f976e92bb0b821425fdda6",
            "name": "John Doe"
        },
        "rating": 5,
        "comment": "Excellent product! Very satisfied with the quality.",
        "createdAt": "2025-01-18T12:40:00.000Z"
    }
}

​
Error response

{
    "status": 400,
    "success": false,
    "message": "You can only review products from completed orders",
    "data": {}
}

Authorizations

​
Authorization
string
header
required

JWT issued by the Salesive Store API for authenticated shoppers.

​
x-shop-id
string
header
required

Optional storefront identifier sent as a header to scope responses to a specific shop. Try It requests remember this value once provided.

Headers

​
x-shop-id
string

Optional identifier that scopes responses to a specific storefront when the referer cannot be inferred.

Body

application/json
​
productId
string
required
​
rating
integer
required
Required range: 1 <= x <= 5
​
comment
string
required
​
orderId
string

Response

201

Review created