Get Orders

GET 
/api/orders

Get Orders

Request

Query Parameters

page integer
Example: 3

Header Parameters

X-Company-Slug stringrequired

Responses

200

Successful response

application/json

Schema

Schema

meta

object

total numberrequired

per_page numberrequired

current_page numberrequired

last_page numberrequired

first_page numberrequired

first_page_url stringrequired

last_page_url stringrequired

next_page_url stringnullablerequired

previous_page_url stringnullablerequired
data object[]

Example (from schema)

{
  "meta": {
    "total": 0,
    "per_page": 0,
    "current_page": 0,
    "last_page": 0,
    "first_page": 0,
    "first_page_url": "string",
    "last_page_url": "string",
    "next_page_url": "string",
    "previous_page_url": "string"
  },
  "data": [
    {
      "id": "41",
      "customer_id": null,
      "code": "Q1NZG5",
      "notes": "cğgui",
      "status": "new",
      "total": 2011,
      "created_at": "2024-08-02T16:07:22.867+03:00",
      "updated_at": "2024-08-02T16:09:23.162+03:00",
      "reservation_id": "1",
      "marketplace": {},
      "marketplace_id": 1,
      "delivery_type": null,
      "transaction_id": 1,
      "created_by_id": "1",
      "nextEvents": [
        "accept"
      ],
      "createdBy": {
        "id": "1",
        "email": "[email protected]",
        "name": "Test",
        "surname": "User 1",
        "language": "en",
        "phone_number": "+90123123213",
        "remember_me_token": true,
        "birthday": "1990-01-01",
        "created_at": "2024-02-20T19:18:45.782+03:00",
        "updated_at": "2024-04-11T01:11:24.889+03:00",
        "timezone": "Europe/Istanbul",
        "meta": {
          "gender": "male"
        }
      },
      "customer": {
        "id": "1",
        "name": "Kris",
        "surname": "Williamson",
        "type": "vendor",
        "email": "[email protected]",
        "phone": "5802777946",
        "gender": "male",
        "birthdate": "2011-05-02",
        "address": "İstanbul",
        "custom_fields": {},
        "created_at": "2024-03-03T11:52:04.398+03:00",
        "updated_at": "2024-04-11T01:11:23.878+03:00",
        "default_photo_id": 1
      },
      "items": [
        {
          "id": "9",
          "product_id": "1",
          "order_id": "36",
          "price": 2011,
          "quantity": 1,
          "total": 2011,
          "product_name": "productsa 21name"
        }
      ]
    }
  ]
}

Loading...