Add order

POST 
/api/orders

Add order

Request

Header Parameters

X-Company-Slug stringrequired

application/json

Body

customer_id number
notes string
status OrderTypeEnum (string)

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

reservation_id number

items

object[]

Array [

product_id stringrequired

quantity numberrequired

price number

]

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]

items

object[]

Array [

product_id string

quantity number

price number

]

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"
  ],
  "items": [
    {
      "product_id": "string",
      "quantity": 0,
      "price": 0
    }
  ]
}

Loading...