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:
\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.
\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.
\niiko will send POST request with the following structure for order status update:
\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\n\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\n\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\n\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\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Order status updates","slug":"order-status-updates"}],"owner":"3103652","collectionId":"1d1431dd-58cc-496c-81d8-d8dfe27510e9","publishedId":"TVCcZW1D","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-08-31T16:41:05.000Z"},"item":[{"name":"Create Order","event":[{"listen":"test","script":{"id":"57e44bc4-ebbf-43dd-ba1c-e089cda6f1a9","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"ae526030-82e1-40f4-86e3-d60a0187e724","exec":["var delivery_time = postman.getEnvironmentVariable(\"delivery_time\");","if (delivery_time === undefined) {"," delivery_time = 50;"," postman.setEnvironmentVariable(\"delivery_time\", delivery_time);","}","","var moment = require('moment');","var ISO_8601_OFFSET = 'YYYY-MM-DDTHH:mm:ss';","var momentdate = moment().utc().add(delivery_time, 'minutes').format(ISO_8601_OFFSET);","","pm.environment.set(\"restaurant_acknowledged_at\", moment().utc().format(ISO_8601_OFFSET)+'Z');","pm.environment.set(\"pickup_at\", momentdate+'Z');","","pm.environment.set(\"today\", moment().utc().format('YYYYMMDD'));","","var num = postman.getEnvironmentVariable(\"order_number\");","if (num === undefined) {"," num = 0;","}","num++;","postman.setEnvironmentVariable(\"order_number\", num);"],"type":"text/javascript"}}],"id":"60abab01-f0e4-4131-bd1e-8550f9b0f2c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"event\": \"newOrder\",\n \"locationId\": \"{{location}}\",\n \"order\": {\n \"textOrderContent\": \"Some text order description, if needed\",\n \"id\": \"{{today}}-{{order_number}}\",\n \"displayId\": \"{{order_number}}\",\n \"totalPrice\": 12.00,\n \"items\": [\n {\n \"posItemId\": \"10015500-10015250-10015320-10015320-10015480-R\",\n \"unitPrice\": 12.00,\n \"quantity\": 1,\n \"notes\": \"\",\n \"modifiers\": []\n }\n ],\n \"notes\": \"\",\n \"fulfillmentType\": \"PICKUP\",\n \"offerDiscount\": 0,\n \"deliveryFee\": 0,\n \"payment\": \"WEB\",\n \"customer\": {\n \"name\": \"SOI Test-1\",\n \"phone\": \"+441110001101\"\n },\n \"asap\": false,\n \"dueBy\": \"{{pickup_at}}\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/api/integrations/delivery-injector/webhook/{{SOI_token}}","description":"Order creation request details.
\n| Field name | \nField description | \nMandatory (Yes/No) | \n
| event | \nEvent type.\n Values: \"newOrder\", \"cancelOrder\" | \nYes | \n
| locationId | \nRestautant id (store code in iiko) | \nYes | \n
| order | \nOrder details, nested object | \nYes | \n
Properties of order created.
\n| Field name | \nField description | \nMandatory (Yes/No) | \n
| textOrderContent | \nSome text order description, if needed | \nNo | \n
| id | \nOrder Id in external system | \nYes | \n
| displayId | \nOrder Id to be displayed to the user and in order comments in iiko | \nYes | \n
| totalPrice | \nTotal order amount including discounts and additional fees.\n totalPrice = sum(items amount) - discount amount + delivery fee amount\n Numeric, '.' - fractional part separator | \nYe | \n
| items | \nOrder items, nested array of objects | \nYes | \n
| notes | \nOrder notes | \nNo | \n
| fulfillmentType | \nOrder type.\n Values: \"DELIVERY\", \"PICKUP\" | \nYes | \n
| offerDiscount | \nDiscount amount. Numeric, '.' - fractional part separator | \nNo | \n
| deliveryFee | \nDelivery fee. Numeric, '.' - fractional part separator | \nNo | \n
| payment | \nPayment details.\n Values: \"WEB\" - paid online, \"COD\" - to be paid by cash to the driver upon delivery | \nYes | \n
| customer | \nGuest details. Nested object.\n If null, default guest settings from conection profile used. | \nNo | \n
| address | \nGuest address. Nested object. \n Ignored if fulfillmentType = \"PICKUP\". | \nYes if fulfillmentType = \"DELIVERY\" | \n
| asap | \nUse iiko delivery/collection settings when calculating order readiness time.\n Values: true/false | \nYes | \n
| dueBy | \nOrder readiness time in ISO 8601 format. https://en.wikipedia.org/wiki/ISO_8601.\n Ignored if asap = \"true\"\n | \nNo | \n
Items included into order.\nArray of objects.
\n| Field name | \nField description | \nMandatory (Yes/No) | \n
| posItemId | \nItem identifier in iiko. Can be compound structure.\n Format template: --- | \nYes | \n
| unitPrice | \nPrice per item unit without discounts and modifiers price. Numeric, '.' - fractional part separator | \nYes | \n
| quantity | \nItem quantity. Integer. | \nYes | \n
| notes | \nItem comments | \nNo | \n
| modifiers | \nItem modifiers, nested array of objects. | \nNo | \n
Order items modifiers.
\n| Field name | \nField description | \nMandatory (Yes/No) | \n
| posItemId | \nModifier SKU in iiko | \nYes | \n
| unitPrice | \nPrice per modifier without discounts. Numeric, '.' - fractional part separator | \nYes | \n
| quantity | \nItem quantity. Integer. | \nYes | \n
Guest address. Nested object. \nIgnored if fulfillmentType = \"PICKUP\"\nMandatory if fulfillmentType = \"DELIVERY\"
\n2 address formats used to support different addres systems: with and without detailed structure.\nFields 'line1' and 'line2' are used to work with unstructured address (UK, UAE addresses)\nFields 'house', 'index' etc. are used to work with structured addresses (Russia) and only considered if empty string specified in 'line1' field. If 'line1' contains some non empty string, then only values in 'line1' and 'line2' ae used, values in other fields are ignored.
\n| Field name | \nField description | \nMandatory (Yes/No) | \n
| line1 | \nAddress details related to geocoding, e.g. postcode, city, ctreet, house. String | \nYes | \n
| line2 | \nAddress detaild not related to geocoding, e.g. flat number, floor. String. | \nNo | \n
| house | \nHouse number | \nYes if 'line1' is empty | \n
| index | \nPostcode | \nNo | \n
| bilding | \nHouse number | \nNo | \n
| flat | \nFlat number | \nNo | \n
| doorphone | \nDoorphone umber | \nNo | \n
| entrance | \nEntrance number | \nNo | \n
| floor | \nFloor number | \nNo | \n
| zone | \nAddress zone. Nested object. | \nYes if not set in connection profile. | \n
| notes | \nAddress comments | \nNo | \n
| location | \nAddress geo position. Nested object. | \nNo | \n
Below described address fields not related to address format style
\nZones list cab be retrieved via Get Delivery Zones API call ({{server}}/api/integrations/delivery-injector/locality/{{SOI_token}})
\n| Field name | \nField description | \nMandatory (Yes/No) | \n
| zoneId | \nZone | \nYes | \n
| zoneName | \nZone name (used for visibility and triubleshooting) | \nNo | \n
| cityName | \nName of the city to which zone belongs | \nNo | \n
| classifierId | \nZone classifier Id | \nNo | \n
Address geo location
\n| Field name | \nField description | \nMandatory (Yes/No) | \n
| latitude | \nLocation latitude. Numeric, '.' - fractional part separator | \nYes, if object is present | \n
| longitude | \nLocation longitude. Numeric, '.' - fractional part separator | \nYes, if object is present | \n
If null, default customer settings from conection profile used
\n| Field name | \nField description | \nMandatory (Yes/No) | \n
| name | \nGuest name | \nYes | \n
| phone | \nGuest phone. If null, default customer settings from conection profile used. | \nNo | \n
| birthDate | \nBirthday in ISO 8601 format. https://en.wikipedia.org/wiki/ISO_8601 | \nNo | \n
| Guest e-mail | \nNo | \n|
| shouldReceivePromoActionsInfo | \nAgreement to receive marketing notifications. \n Values: true/false | \nNo | \n
| gender | \nGuest gender. \n Values: \"NOT_SPECIFIED\", \"MALE\", \"FEMALE\" | \nNo | \n
Get Delivery Zones
\n","urlObject":{"path":["api","integrations","delivery-injector","locality","{{SOI_token}}"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"9f24ac5b-a19a-4901-be80-e9b8615ffbed","name":"Get Delivery Zones","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"{{server}}/api/integrations/delivery-injector/locality/{{SOI_token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"nginx/1.15.10"},{"key":"date","value":"Mon, 31 Aug 2020 15:01:54 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1049"},{"key":"cache-control","value":"no-cache, private"},{"key":"pid","value":"7242e889-e67f-424b-af6d-fa00b66641cd"},{"key":"strict-transport-security","value":"max-age=0; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"zoneId\": \"f8aaf1ec-8f46-907f-9357-e4c27bab5f78\",\n \"zoneName\": \"----------\",\n \"cityName\": \"-\",\n \"classifierId\": \"----------\"\n },\n {\n \"zoneId\": \"b52d1ffa-2394-4abc-a298-4a7886d6125c\",\n \"zoneName\": \"Liverpool\",\n \"cityName\": \"-\",\n \"classifierId\": \"Liverpool\"\n },\n {\n \"zoneId\": \"f2444948-bf93-4064-88de-e8b9c480a91c\",\n \"zoneName\": \"London\",\n \"cityName\": \"-\",\n \"classifierId\": \"London\"\n },\n {\n \"zoneId\": \"ba536317-19f5-40d1-abb4-ef3f9e5ef3d5\",\n \"zoneName\": \"London\",\n \"cityName\": \"-\",\n \"classifierId\": \"London\"\n },\n {\n \"zoneId\": \"6eb83556-7d64-4d89-9cd0-d79cc563804a\",\n \"zoneName\": \"Newcastle\",\n \"cityName\": \"-\",\n \"classifierId\": \"Newcastle\"\n },\n {\n \"zoneId\": \"e7a52a47-23f7-1e7f-0173-5bb25b1520ed\",\n \"zoneName\": \"North Aberford\",\n \"cityName\": \"Tadcaster\",\n \"classifierId\": \"North Aberford\"\n },\n {\n \"zoneId\": \"e7a52a47-23f7-1e7f-0173-5bb25b1520e8\",\n \"zoneName\": \"Tadcaster\",\n \"cityName\": \"Tadcaster\",\n \"classifierId\": \"Tadcaster\"\n },\n {\n \"zoneId\": \"e7a52a47-23f7-1e7f-0173-5bb25b1520de\",\n \"zoneName\": \"York\",\n \"cityName\": \"Tadcaster\",\n \"classifierId\": \"York\"\n },\n {\n \"zoneId\": \"d85bda35-b7cf-bbe1-0173-aee6792cd716\",\n \"zoneName\": \"London\",\n \"cityName\": \"London\",\n \"classifierId\": \"London\"\n }\n]"}],"_postman_id":"a100fcb3-7d04-4714-b36f-868e57c2b605"},{"name":"Cancel order","event":[{"listen":"prerequest","script":{"id":"7c1a4245-662d-48cf-ad26-dc38590af971","exec":["var moment = require('moment');\r","var ISO_8601_OFFSET = 'YYYY-MM-DDTHH:mm:ss';\r","\r","pm.environment.set(\"cancelled_at\", moment().utc().format(ISO_8601_OFFSET)+'Z');\r","\r","var cancel_order = postman.getEnvironmentVariable(\"order_number\");\r","if (cancel_order === undefined) {\r"," cancel_order = 1;\r","}\r","postman.setEnvironmentVariable(\"cancel_order\", cancel_order);"],"type":"text/javascript"}}],"id":"aa22cb8b-2f50-4dac-b681-db6aed81536d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"event\": \"cancelOrder\", \r\n \"locationId\": \"{{location}}\" \r\n \"order\": {\r\n \"id\": \"{{today}}-{{cancel_order}}\", \r\n \"displayId\": \"{{cancel_order}}\", \r\n \"reason\": \"Changed mind\", \r\n \"occurredAt\": \"{{cancelled_at}}\" \r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/api/integrations/delivery-injector/webhook/{{SOI_token}}","description":"| Field name | \nDescription | \nMandatory (Yes/No) | \n
| event | \nOrder action, \"cancelOrder\" | \nYes | \n
| locationId | \nrestautant id (store code in iiko) | \nYes | \n
| order | \nOrder details to cancel section | \nYes | \n
| id | \nExternal id of order to cancel | \nYes | \n
| displayId | \ndisplay id of order to cancel | \nYes | \n
| occurredAt | \nCancellation time | \nYes | \n