Skip to main content
POST
cURL

Body

application/json

shopify_partner review scraping parameters

query
string
required

Provide proper Shopify Partner url or provide a partner slug

reviews_to_fetch
number

Number of reviews to fetch (default: all reviews, or within 30-second timeout)

filter_type
integer

Filter type for reviews

sort_type
enum<string>
default:most_helpful

Order in which reviews should be sorted

Available options:
most_recent,
most_helpful
pagination_token
string

The next_page received with the past request, which is required for the pagination

is_text_formatted
boolean

returns the review text with visual formatting preserved

sync_date
string

Fetches reviews posted on a specific date using format: YYYY-MM-DD

Response

Reviews fetched successfully