API Reference
UGC APILoyalty APIApp Developer APIHelp Center

Retrieve orders

get
https://api.yotpo.com/core/v3/stores//orders

Retrieves a list of orders for your Yotpo store.

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

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 /v3/stores/{store_id}/orders
GET /v3/stores/{store_id}/orders?page_info={page_info}
GET /v3/stores/{store_id}/orders?page_info={page_info}&limit={limit}
GET /v3/stores/{store_id}/orders?external_ids=ext1,ext2
GET /v3/stores/{store_id}/orders?order_date_min=2020-08-22T10:34:56.000Z&order_date_max=2020-12-20T15:55:44.000Z
Path Params
string
required

The store ID (app_key).

Query Params
string

Encoded page info.

int32

Defines how many results will be returned per page. Can be any number between 1 and 100.

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.

date

Show orders created on or after this date. Can be used alone or with order_date_max. Format must be ISO 8601.

date

Show orders created on or before this date. Can be used alone or with order_date_min. Format must be ISO 8601.

Responses

Updated 10 days ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json

Updated 10 days ago