- 
- 
+ 
- 
+ 
+
+ 
+ Getting Started
+Overview
+If you want your restaurant registered in the Adisyo Cafe Restaurant application, you can log in to the + order with the corresponding endpoint and several configurations. You can enter your first order + immediately with a few simple steps mentioned below;
+1- The list of products contained in the relevant restaurant's Adisyo application with x-api-key and + x-api-secret information ’https://ext.adisyo.com/api/external/GetExternalProducts’ + withdraw from the address. A request must be sent using the GET method.
+2- Adding the ‘x-api-key’ and + ‘x-api-secret’ information received from the Adisyo application to the corresponding http + request header.
+3- Creating the order object (JSON).
+4- With x-api-key and x-api-secret information received from the order object and Adisyo authorities + ’https://ext.adisyo.com/api/external/SaveExternalOrder’ + a request can be sent to the address. The POST + method should be used. +
+ +Retrieving Api Key and Secret Key Information
+The x-api-key and x-api-secret information shared by the adisio authorities for each restaurant to be + integrated are provided. This information must be located in the header field of the Http request to be + sent and must be in the specified format, otherwise the operation will not occur. please contact adisyo + for x-api-key and x-api-secret information.
+ +View the Product List
+The product list in the relevant restaurant's adisyo application is provided with x-api-key and + x-api-secret information ’https://ext.adisyo.com/api/external/GetExternalProducts’ + withdraw from the address. A request must be sent using the GET method.
+ +++Example Request
+
curl https://ext.adisyo.com/api/external/GetExternalProducts
+++Example Response
+
{
+ "productName": "Hamburger"
+ "productCode": null,
+ "features": [
+ {
+ "featureName": "Ekstra Peynir",
+ "featureId": 968348,
+ "featureCode": null,
+ "productId": 2267678,
+ "additionalPrice": 3.00",
+ "featureHeaderName": "Hamburger İçerik",
+ },
+ {
+ "featureName": "Ekstra Köfte",
+ "featureId": 968351,
+ "featureCode": null,
+ "productId": 2267678,
+ "additionalPrice": 6.00",
+ "featureHeaderName": "Hamburger İçerik",
+ },
+ {
+ "featureName": "Mantar",
+ "featureId": 968359,
+ "featureCode": null,
+ "productId": 2267678,
+ "additionalPrice": 3.00",
+ "featureHeaderName": "Hamburger İçerik",
+ },
+ ],
+ "productUnits": [
+ {
+ "unitName": "Tam",
+ "price": 12.00,
+ "productUnitId": 2408389,
+ },
+ ],
+ "menus": [
+ {
+ "menuName": "Büyük Boy Menü( 1lt İçecek)",
+ "subProducts": [
+ {
+ "productName": "Su",
+ "productCode": null,
+ "productUnitId": 2408366
+ },
+ {
+ "productName": "Ayran",
+ "productCode": null,
+ "productUnitId": 2408367
+ },
+ {
+ "productName": "Coca Cola",
+ "productCode": null,
+ "productUnitId": 2408368
+ }, {
+ "productName": "Soda",
+ "productCode": null,
+ "productUnitId": 2408369
+ }, {
+ "productName": "Ice Tea",
+ "productCode": null,
+ "productUnitId": 2408370
+ },
+ ]
+ }
+ ],
+ "excludedFeatures": [
+ {
+ "featureName": "Tiramisu",
+ "featureId": 2408376,
+ "featureCode": null,
+ "productId": 2267678
+ }
+ {
+ "featureName": "Türk Kahvesi",
+ "featureId": 2408362,
+ "featureCode": null,
+ "productId": 2267678
+ }
+ ]
+}
+
+
+Endpoint
+GET /api/external/GetExternalProducts
+Required Parameters
+-
+
-
x-api-key- The API key for your account
+ -
x-api-secret- The API Secret key for your account
+
+
Creating an Order Object
+ +++An Example Order Object
+
+
+{
+ "CustomerName": "Christian",
+ "CustomerSurname": "Luyindama",
+ "CustomerId": "44545",
+ "CustomerPhone": "5554443444",
+ "CustomerPhone2": "5554443441",
+ "Address": "adres bilgisi...",
+ "AddressDescription": "adres tarif",
+ "Region": "Ataşehir",
+ "City": "İstanbul",
+ "PaymentMethodId": "3",
+ "PaymentNote": "temassız çalışmıyorr",
+ "Discount": "20",
+ "OrderNote": "ıslak mendil getirin",
+ "WebOrderId": "746364",
+ "OrderTotal": "20.00",
+ "OrderDetails":
+ [
+ {
+ "Quantity": 4,
+ "ProductUnitId": 43455,
+ "OrderDetailNote": "çıtır olsun",
+ "Features":
+ [
+ {
+ "Name": "Soğansız",
+ "FeatureId": "322343"
+ } ,{...},{...}
+ ],
+ "IsMenu": "true/false",
+ "MenuId": "1",
+ "ParentId": "1"
+ }
+ ]
+}
+
+ The order object must be in JSON format. The order contains basic information, the products included in + the order, and some information about these products. Each parameter is described separately below;
+ +-
+
-
CustomerName- The name of the user who placed the order
+ -
CustomerSurname- Last name of the user who placed the order
+ -
CustomerId- The ID of the user registered in your own system, if not, leave it blank +
+ -
CustomerPhone- The phone number of the user who placed the order
+ -
CustomerPhone2- The second phone number of the user who placed the order
+ -
Address- The address of the user who placed the order
+ -
AddressDescription- Address description of the user who placed the order
+ -
Region- District-by-district information of the ordering user
+ -
City- City information of the ordering user
+ -
PaymentMethodId- Pay type information, pay types list are below
+ -
PaymentNote- Pay note
+ -
Discount- The total amount of discounts on the order
+ -
OrderNote- Order note
+ -
WebOrderId- The order ID in your own system
+ -
OrderTotal- The Total Amount Of The Order
+ -
ParentId- ID of the main product
+
Determining the Pay Method
+ +This is how the order object is made ready. The options that may appear in the Pay type field should + again be filled in with one of the values used in the adisio system. The pay type list is as follows; +
+ ++
-
+
-
Cash: 1
+ -
Credit Card: 2
+ -
Multinet: 3
+ -
SmartTicket: 4
+ -
Setcard: 5
+ -
Sodexo: 6
+ -
Other: 7
+ -
Basit Otel: 22
+ -
BizimHesap: 24
+ -
Metropol: 26
+ -
Açık Hesap: 27
+ -
HMS Otel: 28
+ -
YS Online: 29
+ -
Glovo: 30
+ -
Cüzdan: 31
+ -
Getir: 33
+ -
Sedna: 34
+ -
Sodexo Online: 41
+ -
Paye: 52
+ -
Web Online: 53
+ -
Chippin: 63
+ -
Zomato: 65
+ -
Maximum Mobile: 88
+ -
Paycell: 89
+ -
Trendyol: 90
+ -
Sodexo Pass Mobil: 91
+ -
FastPay: 92
+ -
Fuudy: 93
+ -
Sodexo Cep Pos: 97
+ -
CIO Kart: 98
+
Sending the Prepared Request
+++Example Request
+
curl -X POST https://ext.adisyo.com/api/external/SaveExternalOrder
+ ++Example Success Response
+
+
+{
+ "orderId": 66297940,
+ "orderTotal": 20.00,
+ "discount": -4.00,
+ "insertedDate": "2022-06-12T19:33:12.033",
+ "errorMessage": null,
+ "status": 1
+}
+
+ ++Example Fail Response
+
+
+{
+ "orderId": 0,
+ "orderTotal": 0.0,
+ "discount": 0.0,
+ "insertedDate": "0001-01-01T00:00:00",
+ "errorMessage": "Sipariş kaydedilirken bir hata oluştu, lütfen tekrar deneyin veya Adisyo destek ile iletişime
+ geçiniz.",
+ "status": 0
+}
+
+ In the header field of the http request, the x-api-key and x-api-secret information of the relevant + restaurant are entered, and the order object is prepared in the same way as in the example, and the + final stage is reached. From here on, all that needs to be done is to send the prepared request to the + endpoint address specified by the post method. +
+Endpoint
+GET /api/external/SaveExternalOrder
+Required Parameters
+-
+
-
x-api-key- The API key for your account
+ -
x-api-secret- The API Secret key for your account
+
Response Types
+-
+
-
Success (1)- If the transaction was successful, the order has been transferred to the + file system. As a Response, the general information about the order, the ‘Status’ information + (returned as 1 in successful transactions) and + the date/time information when the order was saved in the Adisyo system are returned.
+ -
Fail (0)- I f there is an error during the registration of the order, the transaction + is considered unsuccessful and no registration will fall into the file system. As a response, the + ‘Status’ information (returns 0 for failed + transactions), the description of the process that caused the error, returns ‘ErrorMessage’.
+
View Open Orders
+ +++Example Request
+
curl https://ext.adisyo.com/api/external/HemenYoldaOrders
+ ++Example Response
+
+{
+ "orders": [
+ {
+ "id": 66473932,
+ "waiterName": "hemenyolda",
+ "deliveryUserName": null,
+ "externalAppName": "Adisyo",
+ "restaurantName": null,
+ "orderTotal": 6,
+ "paymentMethodName": "SetCard",
+ "paymentMethodId": 5,
+ "deliveryTime": null,
+ "discountAmount": 0.00,
+ "currency": "TRY",
+ "orderNote": null,
+ "externalAppId": null,
+ "statusId": 1,
+ "status": "Sipariş Alındı",
+ "orderCancelReason": null,
+ "tableName": null,
+ "orderNumber": 100,
+ "taxAmount": 0.44,
+ "insertDate": "2022-06-14T10:19:30.317",
+ "updateDate": "2022-06-14T10:19:30.317",
+ "customerId": 1767682,
+ "customerLatitude": null,
+ "customerLongitude": null,
+ "confirmationCode": null,
+ "integrationRestaurantName": null,
+ "addressId": 1766443,
+ "customer": {
+ "customerName": "Baver Bölüm",
+ "customerSurname": null,
+ "customerEmail": null,
+ "customerId": "1767682",
+ "customerPhone": "5453454545",
+ "customerPhone2": null,
+ "address": "asd",
+ "addressDescription": null,
+ "region": null,
+ "addressHeader": null,
+ "city": null,
+ "company": null,
+ "phoneCode": null,
+ "addressId": 0,
+ "isDefault": null,
+ },
+ "products": [
+ {
+ "id": 213829215,
+ "orderId": 66473932,
+ "quantity": 1.00,
+ "unitPrice": 6.00,
+ "productName": "Türk Kahvesi",
+ "productNote": 66473932,
+ "isMenu": false,
+ "parentId": null,
+ "cost": 0.0,
+ "totalAmount": 6.00,
+ "groupName": null,
+ "groupId": 0,
+ "discountAmount": 0.00,
+ "insertDate": "2022-06-14T10:19:30.333",
+ "description": null,
+ "cancelReason": null,
+ "excludedComposites": null,
+ "excludedItems": [],
+ "features": [
+ {
+ "featureName": "Brownie",
+ "AdditionalPrice": 4.00,
+ "featureId": 2408384,
+ "OrderDetailId": 53455
+ },
+ {
+ "featureName": "Tiramisu",
+ "AdditionalPrice": 4.00,
+ "featureId": 2408376,
+ "OrderDetailId": 53455
+ }
+ ],
+ }
+ ],
+ "payments": []
+ }
+ ],
+ "result": 1,
+ "errorMessage": null,
+ "totalOrderCount": 1,
+ "pageCount": 1
+}The product list in the relevant restaurant's adisyo application is provided with x-api-key and + x-api-secret information ’https://ext.adisyo.com/api/external/HemenYoldaOrders’ + withdraw from the address. A request must be sent using the GET method.
+ + +Endpoint
+GET /api/external/HemenYoldaOrders
+Required Parameters
+-
+
-
x-api-key- The API key for your account
+ -
x-api-secret- The API Secret key for your account
+
Optional Parameters
+-
+
-
pageIndex- When the number of orders is higher than 50, the data is paged. Data can + be accessed with Index. By default, it fetches the first page. To access other pages, you must fill + in this field.
+ -
minimumOrderId- Returns orders with an order number greater than the minimumOrderId + variable.
+ -
updatedOrdersAfter- It can be used to access updated orders. The update date fetches + orders that are after the date sent from this parameter. (Eg. yyyy-mm-dd hh:mm:ss - 2022-06-13 + 15:15:19)
+
Response Types
+-
+
-
Success (1)- As a Response, the general information about the order, the ‘Result’ + information (returns 1 for successful + transactions) and the current number of orders and the number of pages registered in the Adisyo + system are returned.
+ -
Fail (0)- If the parameters are not sent in accordance with the format, the ‘Result’ + information is returned as a response (returns + 0 for failed operations) and the ‘ErrorMessage’ that caused the error is returned.
+
+ 
- 
- 
+
+
- 
- 
+
+ 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
