Retrieve orders

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Invalidated Orders

Orders which were invalidated will not be returned by this call.

🚧

Note:

This call will return a total of ten orders by default. To retrieve more than ten orders, query the count parameter to return the desired quantity of orders. Yotpo recommends querying 200 orders per request.

🚧

Note:

In the response, total_purchases represents the total number of existing orders while total_orders represents the total number of orders returned per call as defined using the count parameter. By default, total_orders will return 10 orders if the count parameter is excluded.

e.g.
"total_purchases": 1278421,
"total_orders": 10

Path Params
string
required

The store ID

Query Params
string
required

Your Yotpo account access token. See Yotpo Authentication to learn how to generate your utoken.

date

Retrieve all orders created starting from this date. The date format is YYYY-MM-DD.

int32

The page number of the paginated response.

int32
Defaults to 10

Number of orders to return. By default, ten orders are displayed.

boolean

false by default. Includes only valid for emails

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json