{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"1d1431dd-58cc-496c-81d8-d8dfe27510e9","name":"iiko SOI API","description":"SOI API allows to create delivery/collection orders in iiko from any external system\nPlease refer to the following methods to get more detailed information:\n- Create order\n- Cancel order\n- Get Delivery zones\n\n\n# Order status updates\nOnce order created via SOI API, external system can get oder creation and kitchen status updates.\nFor this endpoint URL should be specified in connection profile.\n\nIf order status updates are not supported by external system, then error code '501 Not Implemented' should be returned as a response for status update request. In this case iiko will stop sending status update requests.\nIf response will contain error codes like 408, 423, 503, 504, iiko will continue to send status update requests.\n## POST request on status update\niiko will send POST request with the following structure for order status update:\n<pre>\n{\n    // CREATE, UPDATE\n    type: string;\n    // Order ID that came from external system\n    orderExternalId: string;\n    // Order readable number\n    readableNumber: string;\n    // Creation status\n    creationStatus: string; // OK or ERROR\n    // Error information or\n    errorInfo: null | {\n        code: string;\n        message: string;\n        description: string;\n    };\n    // Transport injection details\n    transactionDetails: {\n        correlationId: string;\n        organizationId: string;\n    }\n    // Order parameters (if created)\n    iikoOrderDetails: {\n        // order ID in iiko POS\n        iikoOrderId: string;\n        // order number in iiko\n        iikoOrderNumber: string;\n        // Name of the restaurant\n        restaurantName: string;\n        // Type of order\n        orderType: string; // DELIVERY, PICKUP, INSTORE\n        // Status of the order\n        // UNCONFIRMED| WAIT_COOKING | READY_FOR_COOKING | COOKING_STARTED | COOKING_COMPLETED | WAITING | ON_WAY | DELIVERED | CLOSED | CANCELLED\n        orderStatus: string;\n        // Date & time when the order was received by POS ISO-8571\n        receivedAt: string;\n        // Date & time when the order is expected to be delivered or ready for pick up\n        promisedTime: string;\n        // Problem description\n        problem: string | null;\n        // total amount of the order, including delivery fees\n        orderAmount: number;\n    }\n}\n</pre>\n\n### Status update examples\n#### Order created\n<Pre>\n{\n  \"type\": \"CREATE\",\n  \"orderExternalId\": \"20200831-515\",\n  \"readableNumber\": \"515\",\n  \"creationStatus\": \"OK\",\n  \"errorInfo\": null,\n  \"transactionDetails\": {\n    \"correlationId\": \"80607a6a-f05e-465b-99d2-0d7ced9c7f6d\",\n    \"organizationId\": \"622593bc-818a-4c30-9303-44aee69fe06c\"\n  },\n  \"iikoOrderDetails\": {\n    \"iikoOrderId\": \"9cb7a0a4-1e35-4136-9240-14f99bcb8ae5\",\n    \"iikoOrderNumber\": \"51\",\n    \"restaurantName\": \"SIT API\",\n    \"orderType\": \"PICKUP\",\n    \"orderStatus\": \"WAIT_COOKING\",\n    \"receivedAt\": \"2020-08-31T16:23:31+0100\",\n    \"promisedTime\": \"2020-08-31T18:08:31+0100\",\n    \"problem\": null,\n    \"orderAmount\": 11.05\n  }\n}\n</Pre>\n\n#### Order cooked\n<Pre>\n{\n  \"type\": \"UPDATE\",\n  \"orderExternalId\": \"20200831-515\",\n  \"readableNumber\": \"515\",\n  \"creationStatus\": \"OK\",\n  \"errorInfo\": null,\n  \"transactionDetails\": {\n    \"correlationId\": \"6ece42a3-a11e-425c-ba51-a61df069303f\",\n    \"organizationId\": \"622593bc-818a-4c30-9303-44aee69fe06c\"\n  },\n  \"iikoOrderDetails\": {\n    \"iikoOrderId\": \"9cb7a0a4-1e35-4136-9240-14f99bcb8ae5\",\n    \"iikoOrderNumber\": \"51\",\n    \"restaurantName\": \"SIT API\",\n    \"orderType\": \"PICKUP\",\n    \"orderStatus\": \"COOKING_COMPLETED\",\n    \"receivedAt\": \"2020-08-31T16:23:31+0100\",\n    \"promisedTime\": \"2020-08-31T18:08:31+0100\",\n    \"problem\": null,\n    \"orderAmount\": 11.05\n  }\n}\n</Pre>\n\n#### Order closed\n<Pre>\n{\n  \"type\": \"UPDATE\",\n  \"orderExternalId\": \"20200831-515\",\n  \"readableNumber\": \"515\",\n  \"creationStatus\": \"OK\",\n  \"errorInfo\": null,\n  \"transactionDetails\": {\n    \"correlationId\": \"b596212b-3b32-4e72-9126-43f3f13fb494\",\n    \"organizationId\": \"622593bc-818a-4c30-9303-44aee69fe06c\"\n  },\n  \"iikoOrderDetails\": {\n    \"iikoOrderId\": \"9cb7a0a4-1e35-4136-9240-14f99bcb8ae5\",\n    \"iikoOrderNumber\": \"51\",\n    \"restaurantName\": \"SIT API\",\n    \"orderType\": \"PICKUP\",\n    \"orderStatus\": \"CLOSED\",\n    \"receivedAt\": \"2020-08-31T16:23:31+0100\",\n    \"promisedTime\": \"2020-08-31T18:08:31+0100\",\n    \"problem\": null,\n    \"orderAmount\": 11.05\n  }\n}\n</Pre>\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"3103652","team":72798,"collectionId":"1d1431dd-58cc-496c-81d8-d8dfe27510e9","publishedId":"TVCcZW1D","public":true,"publicUrl":"https://documenter-api.postman.tech/view/3103652/TVCcZW1D","privateUrl":"https://go.postman.co/documentation/3103652-1d1431dd-58cc-496c-81d8-d8dfe27510e9","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2020-08-31T16:41:05.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/8e3c3c40997457ccb0f3ce3acf2d62e5c89f0585948af446830df2982400337c","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/TVCcZW1D"}