YOyotpo

Retrieve Orders per Account

Changed on

Retrieves the orders Yotpo holds for the store, newest first by order_date. For full order data with line items and fulfillments, use Retrieve Orders.

get/v2/{account_id}/orders

Request

  • Base URL
    https://developers.yotpo.com
  • URL
    https://developers.yotpo.com/v2/{account_id}/orders
  • Auth
    API key in header X-Yotpo-Token

Path parameters

account_idstring required

Your account's API app key

Query parameters

pageinteger

Page number, starting at 1.

countinteger

Number of orders per page. A page can hold fewer orders than count.

Response

200

Example response

{
  "status": {
    "code": 200,
    "message": "OK"
  },
  "pagination": {
    "page": 1,
    "count": 2,
    "total": 295
  },
  "orders": {
    "purchases": [
      {
        "id": 123,
        "user_email": "john@example.com",
        "user_name": "john doe",
        "order_id": "1",
        "product_url": "http://yourstore.com/products/oc2101/index.php?route=product/product&product_id=40",
        "order_date": "2016-12-08T12:34:25.000Z",
        "product_description": "this is a description of your product",
        "created_at": "2017-01-15T12:14:48.000Z"
      }
    ]
  }
}

Changes