Get Order

GET 
/api/orders/:id

Get Order

Request

Path Parameters

id integerrequired

Header Parameters

X-Company-Slug stringrequired

Responses

200

Successful response

application/json

Schema

Schema

id string
customer_id stringnullable
code string
notes stringnullable
status OrderTypeEnum (string)

Possible values: [new, accepted, cancelled, paid, success]

total number
created_at date-time
updated_at date-time
reservation_id stringnullable
marketplace objectnullable
marketplace_id stringnullable
delivery_type stringnullable
transaction_id stringnullable
created_by_id string
nextEvents OrderNextEventEnum (string)[]

Possible values: [accept, cancel, ship, refund, checkout, prepare, deliver, handover]

reservation

object

nullable

id string

code string

customer_id string

created_by_id string

updated_by_id string

notes stringnullable

total float

starting_at date-time

finishing_at date-time

created_at date-time

updated_at date-time

status ReservationStatusEnum (string)

Possible values: [new, accepted, cancelled, no-show, success]

customer

object

id string

name string

surname stringnullable

type ContactTypeEnum (string)nullable

Possible values: [vendor, customer]

email emailnullable

phone phonenullable

gender ContactGenderEnum (string)nullable

Possible values: [male, female, other]

birthdate datenullable

address stringnullable

custom_fields objectnullable

created_at date-time

updated_at date-time

default_photo_id numbernullable

services

object[]

Array [

id string

reservation_id string

employee_id string

service_id string

price float

quantity integer

estimated_time integer

starting_at date-time

finishing_at date-time

is_bound boolean

service

object

id string

name string

slug string

description stringnullable

price float

original_price floatnullable

estimated_time integer

category_id string

created_at date-time

updated_at date-time

employee

object

id string

email string

name stringnullable

surname stringnullable

language stringnullable

phone_number stringnullable

remember_me_token booleannullable

birthday datenullable

created_at date-time

updated_at date-time

timezone stringnullable

meta

object

gender ContactGenderEnum (string)nullable

Possible values: [male, female, other]

]

source_id numbernullable

custom_fields objectnullable

transaction_id stringnullable

customer

object

nullable

id string

name string

surname stringnullable

type ContactTypeEnum (string)nullable

Possible values: [vendor, customer]

email emailnullable

phone phonenullable

gender ContactGenderEnum (string)nullable

Possible values: [male, female, other]

birthdate datenullable

address stringnullable

custom_fields objectnullable

created_at date-time

updated_at date-time

default_photo_id numbernullable

shipping

object

nullable

address_line string

address_line_2 string

city string

country_phone_code stringnullable

country_id number

postal_code string

method stringnullable

tracking_code string

id number

order_id number

status OrderTypeEnum (string)

Possible values: [new, accepted, cancelled, paid, success]

items

object[]

Array [

id number

product_id number

order_id number

price number

quantity numbernullable

total number

product_name string

product

object

id string

quick_sale booleannullable

name string

slug stringnullable

sku string

description string

stock integernullable

shipping_required boolean

price float

original_price floatnullable

brand_id stringnullable

created_at date-time

updated_at date-time

inventory_track booleannullable

inventory_type InventoryType (string)

Possible values: [volume, unit]

inventory_quantity integernullable

]

Example (from schema)

{
  "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"
  ],
  "reservation": {
    "id": "4",
    "code": "A5NZY1",
    "customer_id": "101",
    "created_by_id": "1",
    "updated_by_id": "1",
    "notes": "bla bla",
    "total": 1122,
    "starting_at": "2024-08-01T23:21:53.710+03:00",
    "finishing_at": "2024-08-02T00:21:53.710+03:00",
    "created_at": "2024-08-01T23:21:53.705+03:00",
    "updated_at": "2024-08-01T23:21:53.725+03:00",
    "status": "new",
    "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
    },
    "services": [
      {
        "id": "5",
        "reservation_id": "4",
        "employee_id": "8",
        "service_id": "1",
        "price": 1100,
        "quantity": 1,
        "estimated_time": 30,
        "starting_at": "2024-08-01T23:21:53.710+03:00",
        "finishing_at": "2024-08-01T23:51:53.710+03:00",
        "is_bound": false,
        "service": {
          "id": "1",
          "name": "denem",
          "slug": "denem",
          "description": "afa",
          "price": 2200,
          "original_price": 2100,
          "estimated_time": 15,
          "category_id": "5",
          "created_at": "2024-06-16T23:09:57.899+03:00",
          "updated_at": "2024-06-16T23:09:57.899+03:00"
        },
        "employee": {
          "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"
          }
        }
      }
    ],
    "source_id": 1,
    "custom_fields": {},
    "transaction_id": null
  },
  "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
  },
  "shipping": {
    "address_line": "telsiazsadaasasa",
    "address_line_2": "saa",
    "city": "istanbul",
    "country_phone_code": "233",
    "country_id": 2,
    "postal_code": "34020",
    "method": "air stone",
    "tracking_code": "23SADAd1",
    "id": 0,
    "order_id": 0,
    "status": "new"
  },
  "items": [
    {
      "id": "9",
      "product_id": "1",
      "order_id": "36",
      "price": 2011,
      "quantity": 1,
      "total": 2011,
      "product_name": "productsa 21name",
      "product": {
        "id": "2",
        "quick_sale": false,
        "name": "product2",
        "slug": null,
        "sku": "awdawdaw1adw",
        "description": "adw2d",
        "stock": null,
        "shipping_required": true,
        "price": 11,
        "original_price": 12,
        "brand_id": "25",
        "created_at": "2024-04-08T17:01:13.204+03:00",
        "updated_at": "2024-06-16T23:15:11.113+03:00",
        "inventory_track": true,
        "inventory_type": "volume",
        "inventory_quantity": 2002
      }
    }
  ]
}

Loading...