Užsakymo kūrimas

Užklausa

POST https://restoranas.kitchenforce.lt/api/orders

Užklausos duomenys

Užklausos parametrai paduodami JSON formatu

{
   "comment" : "Užsakymo komentaras",     
   "takeoutTime" : "19:00",
   "paymentMethod" : "internet",
	"items" : [
		{
			"dishId" : 2, 
			"quantity" : 1, 
			"comment" : "Be sūrio",
			"modifiers" : [
				{
					"modifierId" : 30,
					"quantity" : 1
				},
				{
					"modifierId" : 49,
					"quantity" : 2
				}			
			]
		},
		{
			"dishId" : 17, 
			"quantity" : 2
		},
		{
			"dishId" : 145,
			"quantity" : 1
		},
		{
			"dishId" : 137,
			"quantity" : 0.259
		}
	],
	"customer" : {
		"name" : "Vardenis",
		"surname" : "Pavardenis",
		"phone" : "+37060000000",
		"email" : "darbai@kitchenforce.lt"
	}
}

Užklausos parametrų sąrašas

Parametras Tipas Aprašymas Būtinas
comment string Užsakymo komentaras
takeoutTime string Atsiėmimo laikas. Nenurodžius parametro užsakymas pagaminamas kaip įmanoma greičiau. Pvz: 18:00
paymentMethod string Mokėjimo būdas. Galimos reikšmės: internet, cash_at_checkout, card_at_checkout Taip
items array Užsakomi patiekalai Taip
- dishId integer Patiekalo ID Taip
- quantity double Užsakomas kiekis Taip
- modifiers array Patiekalo modifikatoriai
- - modifierId integer Modifikatoriaus ID Taip
- - quantity double Modifikatoriaus kiekis Taip
customer array Pirkėjo informacija
- name string Pirkėjo vardas Taip
- surname string Pirkėjo pavardė
- phone string Pirkėjo telefonas Taip
- email string Pirkėjo el. paštas

Sėkmingas atsakymas

{
    "id": 129647,
    "number": "220512FH005",
    "comment": "",
    "totalAmount": 22.78,
    "takeoutTime": "2022-05-12 19:00",
    "paid": true,
    "cooked": false,
    "completed": false
}

Parametrų sąrašas

Parametras Tipas Aprašymas
orders array Užsakymai
id integer Užsakymo ID
number string Užsakymo numeris
comment string Užsakymo komentaras
totalAmount double Užsakymo suma
takeoutTime string Pagaminimo / atsiėmimo laikas
paid bool Ar užsakymas apmokėtas
cooked bool Ar užsakymas pagamintas
completed bool Ar užsakymas užbaigtas

Klaidos atsakymas

{
    "errorCode": 8,
    "errorDescription": "Užsakymų priėmimas išjungtas"
}

Klaidos kodai

Žemiau pateikiami tik su užsakymo kūrimu susiję klaidų kodai. Klaidų kodai susiję su API raktu ir jo leidimais aprašyti skyriuje naudojimas.

Kodas Aprašymas
8 Užsakymų priėmimas išjungtas. To priežastis gali būti: deaktyvuotas pardavimo kanalas arba restoranas nedirba
9 Nenurodytas apmokėjimo būdas
10 Nurodytas neteisingas apmokėjimo būdas
11 Nenurodytas užsakomų patiekalų sąrašas
12 Užsakomų patiekalų sąraše yra nenurodytas patiekalo ID
13 Užsakomų patiekalų sąraše yra neegzistuojantis arba išjungtas patiekalas
14 Užsakomų patiekalų sąraše yra nenurodytas patiekalo kiekis
15 Užsakomų patiekalų sąraše yra neteisingai nurodytas patiekalo kiekis
16 Neteisingas patiekalo modifikatorių sąrašas
17 Patiekalo modifikatorių sąraše yra nenurodytas modifikatoriaus ID
18 Patiekalo modifikatorių sąraše yra neegzistuojantis arba išjungtas modifikatorius
19 Patiekalo modifikatorių sąraše yra nenurodytas modifikatoriaus kiekis
20 Patiekalo modifikatorių sąraše yra neteisingai nurodytas modifikatoriaus kiekis
21 Nurodyti neteisingi pirkėjo duomenys
22 Nenurodytas pirkėjo vardas
23 Nenurodytas pirkėjo telefonas
24 Užsakymo negalima pagaminti pasirinktam atsiėmimo laikui
25 Sistemos problema, nepavyko sukurti užsakymo