List orders

GET

http://localhost:8000/api/v1/orders

GET

/api/v1/orders

curl http://localhost:8000/api/v1/orders \
     -H "Authorization: Bearer <token>"

{
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "string",
        "label": "string",
        "active": true,
        "page": 1
      }
    ],
    "path": "string",
    "per_page": 1,
    "to": 1,
    "total": 1
  },
  "data": [
    {
      "id": 1,
      "total": "string",
      "user": {
        "id": 1,
        "name": "string"
      },
      "customer": {
        "id": 1,
        "name": "string",
        "document_type": "CC",
        "document_number": "string",
        "email": "string",
        "phone": "string",
        "address": "string",
        "is_active": true,
        "created_at": "2024-01-15T09:30:00Z"
      },
      "items": [
        {
          "id": 1,
          "quantity": 1,
          "unit_price": "string",
          "subtotal": "string",
          "product": {
            "id": 1,
            "name": "string",
            "sku": "string"
          }
        }
      ]
    }
  ]
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

customer_idintegerOptional>=1

user_idintegerOptional>=1

order_idintegerOptional>=1

Response

Orders retrieved successfully.

linksobject

metaobject

datalist of objects

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error