Skip to main content
GET
Node.js

Authorizations

Authorization
string
header
required

A secret API key, made under Developers in the dashboard: Authorization: Bearer shoply_sk_...

Path Parameters

storeId
string
required

The store's ID. A key reaches the store it was made in: GET /key answers which.

Query Parameters

page
integer
default:1

Which page of the list. The first is 1.

perPage
integer
default:20

How many a page holds.

rating
integer

Only reviews of this many stars: 1 to 5.

type
enum<string>

Only reviews a buyer wrote, or only the ones given by themselves.

Available options:
buyer,
automatic

A buyer's email, an order's ID, or words from a review.

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object[]
pages
integer
total
integer
meta
object