v1

latestOpenAPI 3.1.02026-07-14460151.1 KB

Retrieve a list of orders

Retrieve a list of orders.

get/v2/orders

Query parameters

limitstring

Return up to this many results per page. (≤ 50 default 15)

pagestring

Return the data of the specified page

Response

200

Example response

{
  "data": [
    {
      "id": 1,
      "first_name": "firstname",
      "last_name": "lastname",
      "phone_number": "0000000000",
      "email": "email@company.com",
      "address1": "line 1",
      "address2": "line 2",
      "city": "city",
      "state": "state",
      "zip_code": "000000",
      "country": "country",
      "status": "status",
      "created_at": "2022-06-16T14:09:00+00:00",
      "products": [
        {
          "id": 1,
          "status": "status",
          "product_id": 5,
          "name": "Product name",
          "items": [
            {
              "product_id": 5,
              "quantity": 100
            }
          ]
        }
      ]
    }
  ],
  "pagination": {
    "path": "https://api.corporatemerch.com/v1/orders",
    "total": 1,
    "limit": 15,
    "current_page": 1,
    "last_page": 1
  }
}