Retrieve orders

get

https://api.yotpo.com/core/v3/stores/{store_id}/orders

Retrieves a list of orders for your Yotpo store.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

👍
How to use this endpoint

Required parameters are listed below. For the full list of properties, see About orders.

For example requests, see below.

For example responses, click the relevant status code on the right.

Example requests

GET /core/v3/stores/{store_id}/orders

GET /core/v3/stores/{store_id}/orders?page_info={page_info}

GET /core/v3/stores/{store_id}/orders?page_info={page_info}&limit={limit}

GET /core/v3/stores/{store_id}/orders?external_ids=ext1,ext2

GET /core/v3/stores/{store_id}/orders?order_date_min=2020-08-22T10:34:56.000Z&order_date_max=2020-12-20T15:55:44.000Z

📘
order_date_min and order_date_max need a full ISO 8601 date and time, such as 2024-01-01T00:00:00Z. A date on its own (2024-01-01) returns a 400 error.

Path Params

store_id

string

required

The store ID (app_key).

Query Params

page_info

string

Encoded page info.

limit

int32

1 to 100

Defaults to 100

The number of results per page, from 1 to 100. Defaults to 100.

external_ids

string

Return only entities specified by a comma-separated (without spaces) list of external IDs. The argument must be URL encoded. Max 100 IDs. Can't come with page_info or limit.

order_date_min

date-time

Show orders created on or after this date and time, in ISO 8601 date-time format (for example 2024-01-01T00:00:00Z). A date without a time is rejected. Can be used alone or with order_date_max.

order_date_max

date-time

Show orders created on or before this date and time, in ISO 8601 date-time format (for example 2024-01-01T00:00:00Z). A date without a time is rejected. Can be used alone or with order_date_min.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

How to use this endpoint

Example requests

order_date_min and order_date_max need a full ISO 8601 date and time, such as 2024-01-01T00:00:00Z. A date on its own (2024-01-01) returns a 400 error.

200200

400400

401Unauthorized. The access token in X-Yotpo-Token is invalid or expired. Generate a new one with Generate access token. The body is plain text.

403Forbidden. The request has no X-Yotpo-Token header.

`order_date_min` and `order_date_max` need a full ISO 8601 date and time, such as `2024-01-01T00:00:00Z`. A date on its own (`2024-01-01`) returns a 400 error.