Class Manager
GET /v1/orders

List Orders

Query parameters

  • page number

    Current page

  • pageSize number

    Number of items per page

  • selectAll boolean

    Determines if all items are selected

  • where object

    App\Shop\Orders\Http\OpenApi\Schemas\Orders Filters: 0, 1, 2, 3, 4

    Hide where attributes Show where attributes object
  • sort object

    App\Shop\Orders\Http\OpenApi\Schemas\Orders Sorting by orderDisp, createdAt

    Hide sort attributes Show sort attributes object
    • orderDisp string

      Values are asc or desc.

    • createdAt string

      Values are asc or desc.

Responses

  • 200 application/json

    Paginated response

    Hide response attributes Show response attributes object
    • data array[object] Required
      Hide data attributes Show data attributes object
      • id string Required
      • familyId string Required
      • orderId string Required
      • createdAt string(date-time) Required
      • orderDisp string Required
      • status string Required

        Current status of the order

        Values are order-placed, awaiting-supplier, awaiting-collection, dispatched, delivered, cancelled, refunded, or completed.

      • familyName string Required
      • grossPrice integer Required
      • netPrice integer Required
      • discountAmount integer Required
      • taxAmount integer | null Required
      • totalTendered integer Required
      • totalDue integer Required
      • paid string Required

        Values are no, part-paid, or yes.

      • totalWithCredit integer Required

        Gross price minus total credits applied

      • totalRemaining integer Required

        Amount remaining to be paid (totalWithCredit - totalTendered)

      • itemCount integer Required

        Number of items in the order

      • nextPaymentDue object | null Required
        Hide nextPaymentDue attributes Show nextPaymentDue attributes object | null
        • amount integer Required
        • paymentDate string(date) Required
        • status array[string] Required

          Values are upcoming, due, overdue, failed, paid, or cancelled.

        • paymentNumber string Required
      • nextPaymentDueDate string(date) | null Required
      • nextPaymentDueStatus array[string] | null Required

        Values are upcoming, due, overdue, failed, paid, or cancelled.

    • pagination object Required

      Pagination schema

      Hide pagination attributes Show pagination attributes object
      • total integer Required

        Total number of items

      • count integer Required

        Number of items on this page

      • perPage integer

        Number of items per page

      • currentPage integer

        Current page number

      • totalPages integer

        Total number of pages
  • 403 application/json

    Not authorized

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
GET /v1/orders 
curl \
 --request GET 'https://localhost/v1/orders'
Response examples (200) 
{
  "data": [
    {
      "id": "_ord_01jsxy8epr403x5sk4dm5ba5cf",
      "familyId": "fml_01jrw5h5ezr2vvwv34zfw2pm9y",
      "orderId": "ord_01jsxy8epr403x5sk4dm5ba5cf",
      "createdAt": "2025-04-28T10:14:37Z",
      "orderDisp": "14809",
      "status": "order-placed",
      "familyName": "Considine",
      "grossPrice": 3327,
      "netPrice": 3327,
      "discountAmount": 0,
      "taxAmount": 0,
      "totalTendered": 3327,
      "totalDue": 0,
      "paid": "no",
      "totalWithCredit": 3327,
      "totalRemaining": 0,
      "itemCount": 2,
      "nextPaymentDue": {
        "amount": 1000,
        "paymentDate": "2025-04-28",
        "status": [
          "upcoming"
        ],
        "paymentNumber": "3/10"
      },
      "nextPaymentDueDate": "2025-04-28",
      "nextPaymentDueStatus": [
        "upcoming"
      ]
    }
  ],
  "pagination": {
    "total": 15,
    "count": 10,
    "perPage": 10,
    "currentPage": 1,
    "totalPages": 2
  }
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}