Create Review

post

https://platform.nector.io/api/v2/merchant/reviews

Create a review on behalf of the user. Pass order_id or reference_order_id to mark it as a verified purchase review. Attach already hosted images via image_links, or upload files afterwards using Create Upload. Read only api key is sufficient.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

metadetail

object

order_id

string

(This needs to be orders _id value) (If this is passed then the review will be attached against an order and the review will be marked as verified)

reference_order_id

string

(Minimum length is 1) (Maximum length is 128) (This needs to be the order id on your platform, ex. shopify order id) (Alternative to order_id, if this is passed then the review will be attached against the matching order and the review will be marked as verified)

reference_product_source

string

enum

required

(Required) (This needs to be products reference_product_source value) (This can only be one of custom_website,shopify,woocommerce,magento)

Allowed:

reference_product_id

string

required

(Required) (This needs to be products reference_product_id value)

name

string

required

(Required) (Maximum length is 200) (This needs to be the name of the user who is writing the review)

rating

number

required

(Required) (Minimum is 1) (Maximum is 5) (This needs to be rating of the review)

description

string

required

(Required) (This needs to be description of the review)

image_links

array of uris

length ≤ 5

(Maximum 5 items) (Public image URLs to attach to the review, each must be a valid URL) (Alternative to Create Upload when the images are already hosted)

image_links

Headers

x-source

string

enum

required

(Required) (This can only be one of mobile,web) (web for browsers and servers, mobile for native apps)

Allowed:

x-apikey

string

required

(Required) (This needs to be your apikey)

x-workspaceid

string

required

(Required) (This needs to be your workspaceid)

Responses

200200

5XXUnexpected error on our side. Retry with backoff and share meta.request_id with [email protected] if it persists