v1
latestOpenAPI 3.1.02026-07-26620219.6 KBRetrieve Orders
Retrieve a list of all available orders.
get/core/v3/stores/{store_id}/orders
Path parameters
store_idstring required
The store ID (app_key).
Query parameters
access_tokenstring required
Your Yotpo access token. Click here to learn how to generate one
page_infostring
Encoded page info.
limit (100)integer
Defines how many results will be returned per page. Can be any number between 1 and 100.
external_idsstring
Return only entities specified by a comma-separated (without spaces) list of external IDs. The argument must be <a href="https://www.urlencoder.io/learn" target="_blank">URL encoded</a>. Max 100 IDs. Can't come with page_info or limit.
order_date_minstring date
Show orders created on or after this date. Can be used alone or with order_date_max. Format must be ISO 8601.
order_date_maxstring date
Show orders created on or before this date. Can be used alone or with order_date_min. Format must be ISO 8601.
Response
200
Example response
{
"orders": [
{
"yotpo_id": 12345,
"external_id": "sk34m",
"order_name": "#S53",
"order_date": "2021-03-25T13:57:05Z",
"checkout_token": "ll2lk3",
"payment_method": "visa",
"total_price": 500,
"subtotal_price": 400,
"currency": "USD",
"landing_site_url": "www.waverider.com",
"payment_status": "pending",
"cancellation": {
"cancellation_date": "2021-03-28T13:35:57Z"
},
"customer": {
"external_id": "ak123798684365sdfkj",
"email": "tom.smith@hostname.com",
"phone_number": "+5556251199",
"first_name": "Tom",
"last_name": "Smith",
"accepts_sms_marketing": true,
"accepts_email_marketing": true
},
"billing_address": {
"address1": "96 Coffee Street",
"city": "Hudson",
"company": "null",
"zip": "13420",
"province_code": "NY",
"country_code": "US",
"phone_number": "+5556251199"
},
"shipping_address": {
"address1": "96 Coffee Street",
"city": "Hudson",
"company": "null",
"zip": "13420",
"province_code": "NY",
"country_code": "US",
"phone_number": "+5556251199"
},
"custom_properties": {
"key": "value",
"key2": "value2"
},
"fulfillments": [
{
"fulfillment_date": "2021-03-31T11:58:51Z",
"status": "pending",
"shipment_info": {
"shipment_status": "label_printed",
"tracking_company": "UPS",
"tracking_url": "www.ups.com/2222",
"tracking_number": "2222"
},
"fulfilled_items": [
{
"external_product_id": "23234",
"quantity": 5
}
]
}
],
"line_items": [
{
"yotpo_product_id": 12345,
"external_product_id": "23234",
"quantity": 5,
"total_price": 500,
"subtotal_price": 400,
"coupon_code": "hg4m",
"custom_properties": {
"key": "value",
"key2": "value2"
}
}
]
}
]
}