{"info":{"_postman_id":"7430aa88-6e2d-4973-aa85-0bfb00313a2a","name":"Merchant open APIs","description":"

Activation and Authentication

Store Activation Details

Following are the steps to activate the integration for a new Store:

Koinz will share the merchant_key of the store with the POS Partner.
The developer should call the activation endpoint providing the merchant_key, the endpoint will respond with the access_key for this store, which will be used in authentication.

Authentication Details

Json Web Token is used as the authentication token.
To acquire a token you will call the /api/v1/login endpoint providing the merchant_key and access_key (provided to you after activation).
To make authorized requests, the token should be sent in the Authorization header following the Bearer authentication scheme.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Activation and Authentication","slug":"activation-and-authentication"}],"owner":"7869877","collectionId":"7430aa88-6e2d-4973-aa85-0bfb00313a2a","publishedId":"Uze6Qhfn","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-08-02T14:31:33.000Z"},"item":[{"name":"Activation and Authentication","item":[{"name":"Activate Merchant","id":"d48462c3-aed7-4568-907a-b2cd7c0a67df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"merchant_key\": \"1ddac089-cf0c-4fc6-a784-139776b971fe-97941f45-732f-4d03-8f4c-b39bc18dd17b\",\n \"pos_id\": \"3f664cf6-a379-4rcf-9e20-ceeab7b651d9\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/activate","description":"

Description

The endpoint is used for activating the integration for a store

Request body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
pos_id	string	The id used by the POS client to identify the merchant
merchant_key	string	The merchant key manually provided to you by Koinz.

","urlObject":{"path":["api","v1","activate"],"query":[],"variable":[]}},"response":[{"id":"f5b4ca79-2f26-4f25-9951-9d4d3868d123","name":"200 Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"merchant_key\": \"e3866512-44c4-42f2-81d3-a125434e75c6-e3866512-44c4-42f2-81d3-a125434e75c6\",\n \"pos_id\": \"d9e7f441-d20a-49b8-85e3-c86a0133fb90\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/activate"},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"access_key\": \"123456\"\n}"},{"id":"62261cce-19bd-4e43-8cce-b9c962a5f95a","name":"400 Validation Failure","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"pos_id\": \"d9e7f441-d20a-49b8-85e3-c86a0133fb90\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/activate"},"code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"VALIDATION-ERROR\",\n \"message\": {\n \"merchant_key\": [\n \"merchant_key is required\"\n ]\n }\n}"},{"id":"3b577ed7-270a-4843-9e1b-0b105843b7e2","name":"403 General Failure","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"merchant_key\": \"e3866512-44c4-42f2-81d3-a125434e75c6-e3866512-44c4-42f2-81d3-a125434e75c6\",\n \"pos_id\": \"d9e7f441-d20a-49b8-85e3-c86a0133fb90\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/activate"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"ACTIVATION_01\",\n \"message\": \"Merchant Key is invalid\"\n}"},{"id":"d44e760d-f3b1-4c9d-8042-4c8db354be40","name":"500 Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"merchant_key\": \"e3866512-44c4-42f2-81d3-a125434e75c6-e3866512-44c4-42f2-81d3-a125434e75c6\",\n \"pos_id\": \"d9e7f441-d20a-49b8-85e3-c86a0133fb90\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/activate"},"code":500,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SERVER-FAILURE\",\n \"message\": \"Something wrong happened\"\n}"}],"_postman_id":"d48462c3-aed7-4568-907a-b2cd7c0a67df"},{"name":"Login","id":"2fbb1e16-fa56-4074-8cf4-204fa25b62e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"merchant_key\": \"1ddac089-cf0c-4fc6-a784-139776b971fe-97941f45-732f-4d03-8f4c-b39bc18dd17b\",\n \"access_key\": \"AsHxOwLDhRBWdPVu\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/login","description":"

Description

Request Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
merchant_key	string	The merchant key manually provided to you by Koinz.
access_key	string	The access key that was provided to you after activating the merchant.

","urlObject":{"path":["api","v1","login"],"query":[],"variable":[]}},"response":[{"id":"c283a064-e839-4daa-a299-bee712465c80","name":"200 Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"merchant_key\": \"1ddac089-cf0c-4fc6-a724-139776b971fe-97941f15-732f-4d03-8f4c-b39bc18dd17b\",\n \"access_key\": \"123456\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/login"},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdG9yZV9pZCI6IjExMS0zMzMzLTU1NTUtNjY2NiIsImludGVncmF0aW9uX2lkIjoiOWJiYmM0NjYtMThmZS00ZTU0LTg0ODctNjBiYjI0ZDZiZTdlIiwicG9zX3R5cGUiOiIiLCJpYXQiOjE2NTkwMzUzMzl9.AaGo1FXjP9HiFYzEwEzFfcColMPrL7VMGC1z1pOSHJg\",\n \"type\": \"bearer\"\n}"},{"id":"33580cf8-77dc-47d7-b847-1aababf0e786","name":"401 Authorization Failure","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"merchant_key\": \"e3866512-44c4-42f2-81d3-a125434e75c6-e3866512-44c4-42f2-81d3-a125434e75c6\",\n \"access_key\": \"kRF69CSg4WVqLYnX\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/login"},"code":401,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"AUTH_01\",\n \"message\": \"Wrong credentials\"\n}"},{"id":"8361aa85-90c4-4bfb-bb6d-4bbc4e459019","name":"400 Validation Failure","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"access_key\": \"kRF69CSg4WVqLYnX\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/login"},"code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"VALIDATION-ERROR\",\n \"message\": {\n \"merchant_key\": [\n \"merchant_key is required\"\n ]\n }\n}"},{"id":"80ed0112-857d-4413-a2f7-71c01ad3bd6f","name":"403 General Failure","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"merchant_key\": \"e3866512-44c4-42f2-81d3-a125434e75c6-e3866512-44c4-42f2-81d3-a125434e75c6\",\n \"access_key\": \"kRF69CSg4WVqLYnX\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/login"},"code":403,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"AUTH_03\",\n \"message\": \"The integration for this store is not activated\"\n}"},{"id":"fecef872-5bc4-430a-bd1c-be77db2a743b","name":"500 Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"merchant_key\": \"e3866512-44c4-42f2-81d3-a125434e75c6-e3866512-44c4-42f2-81d3-a125434e75c6\",\n \"access_key\": \"kRF69CSg4WVqLYnX\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/login"},"code":500,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SERVER-FAILURE\",\n \"message\": \"Something wrong happened\"\n}"}],"_postman_id":"2fbb1e16-fa56-4074-8cf4-204fa25b62e2"},{"name":"Deactivate Merchant","id":"efb69674-81a6-4596-9c2b-84662443090f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/api/v1/deactivate","description":"

Description:

This endpoint is used for deactivating the integration for a store

\n","urlObject":{"path":["api","v1","deactivate"],"query":[],"variable":[]}},"response":[{"id":"016d5bb1-3ead-4e7a-b65c-4048343cd087","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/api/v1/deactivate"},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""},{"id":"73e42878-1e34-4cbb-b51e-e2c9ab136318","name":"401 Authorization Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/api/v1/deactivate"},"code":401,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"AUTHENTICATION-ERROR\",\n \"message\": \"Authorization Token not found in Authorization header\"\n}"},{"id":"a2431ed8-0006-4bbf-8317-34390344987f","name":"403 General Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/api/v1/deactivate"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"ACTIVATION_05\",\n \"message\": \"Something went wrong while deactivating the integrarion\"\n}"},{"id":"eec2fc6c-63e9-43b4-9fc6-7148551a9a2f","name":"500 Server Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/api/v1/deactivate"},"code":500,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SERVER-FAILURE\",\n \"message\": \"Something wrong happened\"\n}"}],"_postman_id":"efb69674-81a6-4596-9c2b-84662443090f"}],"id":"eff4df0a-6980-49f1-bf93-1081746f4d99","_postman_id":"eff4df0a-6980-49f1-bf93-1081746f4d99","description":""},{"name":"Store management","item":[{"name":"Get Store","id":"f4587ab0-b699-4484-9d54-b555a77e8900","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/api/v1/store","description":"

This endpoint is used for retrieving the store details.

Response body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	type	Description
koinz_id	string (UUID)	A unique identifying string for the store provided by Koinz.
name	string	Store name.
localized_name	string	Localized store name if the business uses localization.
status	string (enum)	Store status in Koinz system Allowed values: inactive: Store is currently not activated running: Store is currently running and ready to receive orders. in progress: store is currently in setup mode closed: Store is currently closed
merchant_key	string	Merchant key used to activate store and generate its token for API authorization.
created_at	number (8 bytes)	The time when the store has been created. Specified as a Unix timestamp in milliseconds since Jan 1, 1970.
updated_at	number (8 bytes)	The time when the store has been updated. Specified as a Unix timestamp in milliseconds since Jan 1, 1970.
bio	string	store description which will be displayed to the customer.
pickup_prep_min	integer	store minimum pickup preparation time in minutes
pickup_prep_max	integer	store maximum pickup preparation time in minutes
minimum_order_value	integer	Store allowed minimum value for order.
payment_methods	array	Store available payment methods Allowed Values: cash: pay cash. online: pay online.

","urlObject":{"path":["api","v1","store"],"query":[],"variable":[]}},"response":[{"id":"18bda79b-a2f0-42de-ace1-552efcfe41d3","name":"200 Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"url":"/api/v1/store"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"koinz_id\": \"d9f5d9ee-0e8d-4d9d-b476-123430r04c21\",\n \"name\": \"store_name\",\n \"localized_name\": \"اسم المطعم\",\n \"status\": \"running\",\n \"merchant_key\": \"8212b88d-6164-4cd5-b573-b53beca8f2cc-38cc8b79-bb9c-4abe-9688-4867786bb53b\",\n \"created_at\": 1488279307808,\n \"updated_at\": 1659268564603,\n \"bio\": \"Come and enjoy our Smoothies, Chocolate fudge, Delicious blueberry cheese cake and more...\",\n \"pickup_prep_min\": 10,\n \"pickup_prep_max\": 30,\n \"minimum_order_value\": 30,\n \"payment_methods\": [\n \"cash\",\n \"online\"\n ]\n}"},{"id":"4a904e39-df05-4777-8884-c1fd5fc9aa92","name":"401 Authorization Failure","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"url":"/api/v1/store"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"AUTHENTICATION-ERROR\",\n \"message\": \"Authorization Token not found in Authorization header\"\n}"},{"id":"2c417a6f-b062-4d10-a9ae-c84c2bb586e6","name":"403 General Failure","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"url":"/api/v1/store"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"STORE_01\",\n \"message\": \"Something went wrong, while fetching store data.\"\n}"},{"id":"5d9d758e-6de3-4d4e-b4b4-872706b419cf","name":"500 Server Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"url":"/api/v1/store"},"code":500,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SERVER-FAILURE\",\n \"message\": \"Something wrong happened\"\n}"}],"_postman_id":"f4587ab0-b699-4484-9d54-b555a77e8900"},{"name":"Get Store Branches","id":"ad4a54d1-18bd-409c-abac-18cf10216e35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"url":"/api/v1/store/branches","description":"

This endpoint allows a developer to get store branches details.

Response body parameters

This endpoint returns an array of store_branch objects.

store_branch Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type	description
koinz_id	string (UUID)	A unique identifying string for the branch provided by Koinz.
pos_id	string	A unique identifying string for the branch, provided by the pos.
name	string	branch name.
localized_name	string	Localized branch name if the business uses localization.
address	string (100 chars)	branch address which will be displayed to the customer.
detailed_address	string (1000 chars)	branch address details which will be displayed to the customer.
localized_detailed_address	string	Localized branch address details if the business uses localization.
pickup_prep_min	integer	pickup preparation minimum time in minutes
pickup_prep_max	integer	pickup preparation maximum time in minutes
pickup_status	string (enum)	The desired status of the branch. Allowed values: enabled: Branch can accept pickup orders. disabled: Branch can't accept pickup orders and doesn't show in the customer app. paused_by_working_hours: Branch can't accept pickup orders and show as busy in the customer app. paused_by_cashier: Branch can't accept pickup orders and show as busy in the customer app.
delivery_status	string (enum)	The desired status of the branch. Allowed values: enabled: Branch can accept delivery orders. disabled: Branch can't accept delivery orders and doesn't show in the customer app. paused_by_working_hours: Branch can't accept delivery orders and show as busy in the customer app. paused_by_cashier: Branch can't accept delivery orders and show as busy in the customer app.
longitude	double	Branch location longitude.
latitude	double	Branch location latitude.
phone_numbers	array	Branch phone numbers array which will be displayed to the customer.
created_at	number (8 bytes)	The time when the branch has been created. Specified as a Unix timestamp in milliseconds since Jan 1, 1970.
updated_at	number (8 bytes)	The time when the branch has been updated. Specified as a Unix timestamp in milliseconds since Jan 1, 1970.

","urlObject":{"path":["api","v1","store","branches"],"query":[],"variable":[]}},"response":[{"id":"9a1badc1-29d0-410e-b721-a6891f438c64","name":"200 Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"/api/v1/store/branches"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"koinz_id\": \"75d7d627-afa7-4298-9ee9-0a781e1b2011\",\n \"pos_id\": null,\n \"name\": \"Zahraa Al Maadi\",\n \"localized_name\": \"Zahraa Al Maadi\",\n \"address\": \"Coffee Corner, Zahraa Al Maadi, ، قسم، El Basatin, Egypt\",\n \"detailed_address\": \"Building No. 19, Section 13 - Zahraa Maadi behind McDonald\\\\\\\\\\\\\\\\'s\",\n \"localized_detailed_address\": \"Building No. 19, Section 13 - Zahraa Maadi behind McDonald\\\\\\\\\\\\\\\\'s\",\n \"pickup_prep_min\": null,\n \"pickup_prep_max\": null,\n \"pickup_status\": \"disabled\",\n \"delivery_status\": \"disabled\",\n \"longitude\": 31.3031879,\n \"latitude\": 29.9619782,\n \"phone_numbers\": [\n \"01009666767\"\n ],\n \"created_at\": 1582042237298,\n \"updated_at\": 1637138660609\n },\n {\n \"koinz_id\": \"a5dd9ac2-ca9e-455e-bd4c-699ea67e9d6a\",\n \"pos_id\": null,\n \"name\": \"Zamalek\",\n \"localized_name\": \"Zamalek\",\n \"address\": \"Coffee Corner, Hassan Assem, Mohammed Mazhar, Zamalek, Egypt\",\n \"detailed_address\": \"Hassan Assem, Mohammed Mazhar, Zamalek, Egypt\",\n \"localized_detailed_address\": \"Hassan Assem, Mohammed Mazhar, Zamalek, Egypt\",\n \"pickup_prep_min\": 5,\n \"pickup_prep_max\": 8,\n \"pickup_status\": \"enabled\",\n \"delivery_status\": \"disabled\",\n \"longitude\": 31.2223873,\n \"latitude\": 30.0615083,\n \"phone_numbers\": [\n \"01096638966\"\n ],\n \"created_at\": 1581513655079,\n \"updated_at\": 1659394800710\n },\n {\n \"koinz_id\": \"0217fc0e-4070-4112-bcd7-cd4a3cf5a444\",\n \"pos_id\": null,\n \"name\": \"Maadi - Degla\",\n \"localized_name\": \"Maadi - Degla\",\n \"address\": \"Coffee Corner, Street 233, Maadi as Sarayat Al Gharbeyah, القاهرة, Egypt\",\n \"detailed_address\": \"21 Road 233, Degla Maadi\",\n \"localized_detailed_address\": \"21 Road 233, Degla Maadi\",\n \"pickup_prep_min\": 2,\n \"pickup_prep_max\": 7,\n \"pickup_status\": \"enabled\",\n \"delivery_status\": \"disabled\",\n \"longitude\": 31.2785448,\n \"latitude\": 29.9614706,\n \"phone_numbers\": [\n \"01069669666\"\n ],\n \"created_at\": 1582042381963,\n \"updated_at\": 1659394800759\n }\n]"},{"id":"2faa0bb1-3fe4-43be-a493-7f0423b9cceb","name":"401 Authorization Failure","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"url":"/api/v1/store/branches"},"code":401,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"AUTHENTICATION-ERROR\",\n \"message\": \"Authorization Token not found in Authorization header\"\n}"},{"id":"badb78ed-55c6-4afa-ad65-c955e21c115b","name":"403 General Failure","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"url":"/api/v1/store/branches"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"STORE_02\",\n \"message\": \"Something went wrong, while fetching store branches data.\"\n}"},{"id":"86b4dc2a-f06c-4fdc-ac5d-41805c440e1b","name":"500 Server Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"url":"/api/v1/store/branches"},"code":500,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SERVER-FAILURE\",\n \"message\": \"Something wrong happened\"\n}"}],"_postman_id":"ad4a54d1-18bd-409c-abac-18cf10216e35"},{"name":"Update Store","id":"7713fe0b-6e58-41e2-9d94-27409a8f75a1","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"url":"/api/v1/store","description":"

This endpoint allows a developer to update store details.

Request Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type	description
name	string	store name
localized_name	string	Localized store name if the business uses localization.
pickup_prep_min	integer	Store minimum pickup preparation value in minutes
pickup_prep_max	integer	Store maximum pickup preparation value in minutes
minimum_order_value	integer	Store allowed minimum value for order.
status	string	Store status in Koinz system Allowed values: inactive: Store is currently not activated running: Store is currently running and ready to receive orders. in progress: store is currently in setup mode closed: Store is currently closed
bio	string	store description which will be displayed to the customer.

Update branch delivery and pickup status.

Request Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
pickup_status	string (enum)	The desired status of the branch. Allowed values: enabled: Branch can accept pickup orders. disabled: Branch can't accept pickup orders and doesn't show in the customer app. paused_by_working_hours: Branch can't accept pickup orders and show as busy in the customer app. paused_by_cashier: Branch can't accept pickup orders and show as busy in the customer app.
pickup_paused_until [optional]	double	required in pickup_status == paused_by_cashier The timestamp(in milliseconds) until which a branch will not be accepting pickup orders.
delivery_status	string (enum)	The desired status of the branch. Allowed values: enabled: Branch can accept delivery orders. disabled: Branch can't accept delivery orders and doesn't show in the customer app. paused_by_working_hours: Branch can't accept delivery orders and show as busy in the customer app. paused_by_cashier: Branch can't accept delivery orders and show as busy in the customer app.
delivery_paused_until [optional]	double	required in delivery_status == paused_by_cashier The timestamp (in milliseconds) until which a branch will not be accepting delivery orders.

","urlObject":{"path":["api","v1","branch","{pos_branch_id}","status"],"query":[],"variable":[]}},"response":[{"id":"4eb0b65e-d5b1-4447-9fe1-eccc53ba8f3a","name":"200 Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"pos_branch_id\":\"1234\",\n \"pickup_status\":\"paused_for_working_hours\",\n \"pickup_paused_until\":1642372140000, // required if pickup_status = 'paused_by_cashier'\n \"delivery_status\":\"enabled\",\n \"delivery_paused_until\":1642372140000 // required if delivery_status = 'paused_by_cashier' \n}","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:8000/api/v1/branch/update-status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Date","value":"Thu, 28 Jul 2022 10:44:36 GMT"},{"key":"Date","value":"Thu, 28 Jul 2022 10:44:36 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.0.21"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\" : \"Branch updated successfully.\"\n}"},{"id":"32e1a509-09d8-4f0c-ac82-5a20b21b2768","name":"400 Validation failure","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"pos_branch_id\":\"1234\",\n \"pickup_status\":\"paused_for_working_hours\",\n \"pickup_paused_until\":1642372140000,\n \"delivery_status\":\"enabled\",\n \"delivery_paused_until\":1642372140000 \n}","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:8000/api/v1/branch/update-status"},"code":400,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Date","value":"Thu, 28 Jul 2022 10:44:36 GMT"},{"key":"Date","value":"Thu, 28 Jul 2022 10:44:36 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.0.21"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"pos_branch_id\": [\n \"The pos branch id field is required.\"\n ],\n \"delivery_status\": [\n \"The delivery status field is required.\"\n ]\n }\n}"},{"id":"13be49d0-6fa0-4b23-920f-7eee15e97ee2","name":"General failure","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"pos_branch_id\":\"123\",\n \"pickup_status\":\"paused_for_working_hours\",\n \"pickup_paused_until\":1642372140000,\n \"delivery_status\":\"enabled\",\n \"delivery_paused_until\":1642372140000 \n}","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:8000/api/v1/branch/update-status"},"code":403,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Date","value":"Thu, 28 Jul 2022 11:20:37 GMT"},{"key":"Date","value":"Thu, 28 Jul 2022 11:20:37 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.0.21"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"BRANCH_UPDATE_03\",\n \"message\": \"Error in branch data\"\n}"}],"_postman_id":"5a15ce78-910f-4f8d-a20b-5c295e79e2fd"},{"name":"Branch Sync","id":"b7f740b7-e5e9-46c7-9c52-24ab01595e92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\n [\n {\n \"pos_id\":\"93d35771-af25-4cfc-bab5-84974f1ae549\",\n \"name\":\"branch_name\",\n \"localized_name\":\"الفرع اسم\",\n \"phone_numbers\":[\"010xxxxxxxx\"],\n \"address\":\"branch address\",\n \"localized_address\":\"الفرع عنوان\",\n \"map_location\":\"branch map location text for ex:Saudi Arabia - Chinese Friendship Garden, Turki Ibn Abdullah Al Saud, Riyadh Saudi Arabia\",\n \"lat\": 24.7076316,\n \"lng\": 46.702679\n }\n ]\n","options":{"raw":{"language":"json"}}},"url":"/api/v1/branches/sync","description":"

Description:

This endpoint is used to (update/delete) store branches.

Request body parameters

This endpoint request accepts an array of branches with the following structure:

Branch object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
pos_id	string	A unique identifying string for the branch, provided by the pos.
name	string	name of the modifiers group
localized_name	string	Localized modifier group name if business uses localization.
is_deleted	integer	Determines if the branch is deleted or not.
phone_numbers	array	branch phone_numbers
address	string	branch address text
localized_address	string	branch localized address text
map_location[optional]	string	branch location name in google maps
lat [optional]	double	map location latitude
lng [optional]	double	map location longitude

","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"1dc39708-9c24-4cf0-88b3-a4ff2f89248c","id":"1dc39708-9c24-4cf0-88b3-a4ff2f89248c","name":"Store management","type":"folder"}},"urlObject":{"path":["api","v1","branches","sync"],"query":[],"variable":[]}},"response":[{"id":"f049ca47-8c11-47c1-b28b-849251bebc1e","name":"200 success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"\n [\n {\n \"pos_id\":\"93d35771-af25-4cfc-bab5-84974f1ae549\",\n \"name\":\"branch_name\",\n \"localized_name\":\"الفرع اسم\",\n \"phone_numbers\":[\"010xxxxxxxx\"],\n \"address\":\"branch address\",\n \"localized_address\":\"الفرع عنوان\",\n \"map_location\":\"branch map location text for ex:Saudi Arabia - Chinese Friendship Garden, Turki Ibn Abdullah Al Saud, Riyadh Saudi Arabia\",\n \"lat\": 24.7076316,\n \"lng\": 46.702679\n }\n ]\n","options":{"raw":{"language":"json"}}},"url":"/api/v1/branches/sync"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"failed_items\": [\n \n ]\n}"},{"id":"5a53fcea-0086-4727-bf70-c5f1747c2ec8","name":"200 Success with failed entities","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"\n [\n {\n \"pos_id\":\"93d35771-af25-4cfc-bab5-84974f1ae549\",\n \"name\":\"branch_name\",\n \"localized_name\":\"الفرع اسم\",\n \"phone_numbers\":[\"010xxxxxxxx\"],\n \"address\":\"branch address\",\n \"localized_address\":\"الفرع عنوان\",\n \"map_location\":\"branch map location text for ex:Saudi Arabia - Chinese Friendship Garden, Turki Ibn Abdullah Al Saud, Riyadh Saudi Arabia\",\n \"lat\": 24.7076316,\n \"lng\": 46.702679\n }\n ]\n","options":{"raw":{"language":"json"}}},"url":"/api/v1/branches/sync"},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"failed_items\": [\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27444\",\n \"code\": \"ITEM_01\",\n \"message\": \"Related category doesn't exists\"\n }\n ]\n}"},{"id":"91257b8d-44a7-4f70-8ecb-634113887e0d","name":"400 Validation Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"\n [\n {\n \"pos_id\":\"93d35771-af25-4cfc-bab5-84974f1ae549\",\n \"name\":\"branch_name\",\n \"localized_name\":\"الفرع اسم\",\n \"phone_numbers\":[\"010xxxxxxxx\"],\n \"address\":\"branch address\",\n \"localized_address\":\"الفرع عنوان\",\n \"map_location\":\"branch map location text for ex:Saudi Arabia - Chinese Friendship Garden, Turki Ibn Abdullah Al Saud, Riyadh Saudi Arabia\",\n \"lat\": 24.7076316,\n \"lng\": 46.702679\n }\n ]\n","options":{"raw":{"language":"json"}}},"url":"/api/v1/branches/sync"},"code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"VALIDATION-ERROR\",\n \"message\": {\n \"name\": [\n \"name is required\"\n ]\n }\n}"},{"id":"0389f0ff-a721-4f5d-ab95-44d4c21f0c45","name":"401 Authorization Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"\n [\n {\n \"pos_id\":\"93d35771-af25-4cfc-bab5-84974f1ae549\",\n \"name\":\"branch_name\",\n \"localized_name\":\"الفرع اسم\",\n \"phone_numbers\":[\"010xxxxxxxx\"],\n \"address\":\"branch address\",\n \"localized_address\":\"الفرع عنوان\",\n \"map_location\":\"branch map location text for ex:Saudi Arabia - Chinese Friendship Garden, Turki Ibn Abdullah Al Saud, Riyadh Saudi Arabia\",\n \"lat\": 24.7076316,\n \"lng\": 46.702679\n }\n ]\n","options":{"raw":{"language":"json"}}},"url":"/api/v1/branches/sync"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"AUTHENTICATION-ERROR\",\n \"message\": \"Authorization Token not found in Authorization header\"\n}"},{"id":"ca4c3332-e21b-47bc-b649-6ae8d585c6c6","name":"403 General Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"\n [\n {\n \"pos_id\":\"93d35771-af25-4cfc-bab5-84974f1ae549\",\n \"name\":\"branch_name\",\n \"localized_name\":\"الفرع اسم\",\n \"phone_numbers\":[\"010xxxxxxxx\"],\n \"address\":\"branch address\",\n \"localized_address\":\"الفرع عنوان\",\n \"map_location\":\"branch map location text for ex:Saudi Arabia - Chinese Friendship Garden, Turki Ibn Abdullah Al Saud, Riyadh Saudi Arabia\",\n \"lat\": 24.7076316,\n \"lng\": 46.702679\n }\n ]\n","options":{"raw":{"language":"json"}}},"url":"/api/v1/branches/sync"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"ITEM_01\",\n \"message\": \"Something went wrong while syncing items\"\n}"},{"id":"fa34a9b6-cabb-4c1f-a60f-15fcb90c5540","name":"500 Server Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"\n [\n {\n \"pos_id\":\"93d35771-af25-4cfc-bab5-84974f1ae549\",\n \"name\":\"branch_name\",\n \"localized_name\":\"الفرع اسم\",\n \"phone_numbers\":[\"010xxxxxxxx\"],\n \"address\":\"branch address\",\n \"localized_address\":\"الفرع عنوان\",\n \"map_location\":\"branch map location text for ex:Saudi Arabia - Chinese Friendship Garden, Turki Ibn Abdullah Al Saud, Riyadh Saudi Arabia\",\n \"lat\": 24.7076316,\n \"lng\": 46.702679\n }\n ]\n","options":{"raw":{"language":"json"}}},"url":"/api/v1/branches/sync"},"code":500,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SERVER-FAILURE\",\n \"message\": \"Something wrong happened\"\n}"}],"_postman_id":"b7f740b7-e5e9-46c7-9c52-24ab01595e92"}],"id":"1dc39708-9c24-4cf0-88b3-a4ff2f89248c","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"0c13bba6-fc2f-4b1c-b997-334372cc3605","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"07441188-944e-40f1-a930-b9347c0b5e8d","type":"text/javascript","exec":[""]}}],"_postman_id":"1dc39708-9c24-4cf0-88b3-a4ff2f89248c","description":""},{"name":"Menu management","item":[{"name":"Get Menu","id":"18d9cdd3-8a4d-46c5-8c8a-905a2365c8a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"url":"/api/v1/branch/{branch_id}/menu","description":"

This endpoint allows a developer to pull a branch menu. this response may be very large.

Response body parameters

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
koinz_id	string (UUID)	A unique identifying string for the menu provided by Koinz.
pos_id	string	A unique identifying string for the menu, provided by the pos.
tax	float	Specifies the taxes applicable to any items or modifiers in the menu.
name	string	Menu name.
created_at	number (8 bytes)	The time when the menu has been created. Specified as a Unix timestamp in milliseconds since Jan 1, 1970.
updated_at	number (8 bytes)	The time when the menu has been updated. Specified as a Unix timestamp in milliseconds since Jan 1, 1970.
categories	array	Array of menu categories.

Category object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
koinz_id	string (UUID)	A unique identifying string for the category, provided by Koinz.
pos_id	double	A unique identifying string for the category, provided by the restaurant.
name	string	Category name.
localized_name	string	Localized category name if the business uses localization.
created_at	number (8 bytes)	The time when the category has been created. Specified as a Unix timestamp in milliseconds since Jan 1, 1970.
updated_at	number (8 bytes)	The time when the category has been updated. Specified as a Unix timestamp in milliseconds since Jan 1, 1970.
order	integer	The order of the category which will be displayed to the customer.
is_bundle	boolean	Determines if category is bundled category or not.
is_deleted	boolean	Determines if the category is deleted or not.
availability	string (enum)	Determines category availability in this branch. Allowed values: [\"available\", \"unavailable\", \"sold_out\"].
items	array	Array of menu items in the category.

Item object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
koinz_id	string (UUID)	A unique identifying string for the item, provided by Koinz.
pos_id	string	A unique identifying string for the item, provided by the store.
name	string	Item name.
localized_name	string	Localized item name if the business uses localization.
description	string	Item description.
localized_description	string	Localized item description if the business uses localization.
created_at	number (8 bytes)	The time when the item has been created. Specified as a Unix timestamp in milliseconds since Jan 1, 1970.
updated_at	number (8 bytes)	The time when the item has been updated. Specified as a Unix timestamp in milliseconds since Jan 1, 1970.
order	integer	The order of the item which will be displayed to the customer.
image	string (url)	Item image url.
compressed_image	string (url)	Item image url.
tax	float	Specifies the taxes applicable to this item and its modifiers.
is_deleted	boolean	Determines if the item is deleted or not.
price	float	item price in this branch.
availability	string (enum)	Determines item availability in this branch. Allowed values: [\"available\", \"unavailable\", \"sold_out\"].
modifiers_groups	array	Array of menu modifiers_groups.

Modifier group object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
koinz_id	string (UUID)	A unique identifying string for the modifier group, provided by Koinz.
pos_id	string	A unique identifying string for the modifier group, provided by the restaurant.
name	string	Modifier group name.
localized_name	string	Localized modifier group name if the business uses localization.
created_at	number (8 bytes)	The time when the modifier group has been created. Specified as a Unix timestamp in milliseconds since Jan 1, 1970.
updated_at	number (8 bytes)	The time when the modifier group has been updated. Specified as a Unix timestamp in milliseconds since Jan 1, 1970.
order	integer	The order of the item which will be displayed to the customer.
is_deleted	boolean	Determines if the item is deleted or not.
min_options_number	integer	Minimum quantity of modifiers allowed to be ordered in this modifier group.
max_options_number	integer	Maximum quantity of modifiers allowed to be ordered in this modifier group.
availability	string (enum)	Determines modifier group availability in this branch. Allowed values: [\"available\", \"unavailable\", \"sold_out\"].
modifiers_options	array	Array of menu modifiers_options.

Modifiers object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
koinz_id	string (UUID)	A unique identifying string for the modifier option, provided by Koinz.
pos_id	string	A unique identifying string for the modifier option, provided by the restaurant.
name	string	Modifier option name.
localized_name	string	Localized modifier option name if the business uses localization.
created_at	number (8 bytes)	The time when the modifier option has been created. Specified as a Unix timestamp in milliseconds since Jan 1, 1970.
updated_at	number (8 bytes)	The time when the modifier option has been updated. Specified as a Unix timestamp in milliseconds since Jan 1, 1970.
order	integer	The order of the modifier option which will be displayed to the customer.
tax	float	Specifies the taxes applicable to this modifier option.
is_deleted	boolean	Determines if the modifier option is deleted or not.
price	float	Modifier option price in this branch.
availability	string (enum)	Determines modifier option availability in this branch. Allowed values: [\"available\", \"unavailable\", \"sold_out\"].

","urlObject":{"path":["api","v1","branch","{branch_id}","menu"],"query":[],"variable":[]}},"response":[{"id":"1ce77912-d57f-4ba9-971d-7f39e5c281b7","name":"200 success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"/api/v1/branch/{branch_id}/menu?Authorization=Bearer {access_token}","path":["api","v1","branch","{branch_id}","menu"],"query":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}]}},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"koinz_id\": \"koinz_uuid\",\n \"pos_id\": \"your_system_id\",\n \"tax\": 0.14,\n \"name\": \"Main Menu\",\n \"created_at\": 1582203300307, // test comments\n \"updated_at\": 1582203300307,\n \"categories\": [\n {\n \"koinz_id\": \"koinz_uuid\",\n \"pos_id\": \"your_system_id\",\n \"name\": \"meals\",\n \"localized_name\": \"وجبات\",\n \"created_at\": 1655617191383,\n \"updated_at\": 1655617236793,\n \"order\": 1,\n \"is_bundle\": 0,\n \"is_deleted\": 0,\n \"availability\":\"available / unavailable / sold_out\",\n \"items\": [\n {\n \"koinz_id\": \"koinz_uuid\",\n \"pos_id\": \"your_system_id\",\n \"name\": \"Iftar meal\",\n \"localized_name\": \"وجبه الإفطار\",\n \"description\": \"en_description\",\n \"localized_description\": \"وصف عربي\",\n \"created_at\": 1647364435000,\n \"updated_at\": 1658235616186,\n \"image\": \"image_url\",\n \"compressed_image\": \"image_url\",\n \"tax\": 0.14,\n \"is_deleted\": 0,\n \"price\": 1.01,\n \"order\": 1,\n \"availability\":\"available / unavailable / sold_out\",\n \"modifiers_groups\": [\n {\n \"koinz_id\": \"koinz_uuid\",\n \"pos_id\": \"your_system_id\",\n \"name\": \"Grilled dishes\",\n \"localized_name\": \"أطباق المشاوي\",\n \"created_at\": 1645454363000,\n \"updated_at\": 1649068165000,\n \"order\": 1,\n \"is_deleted\": 0,\n \"min_options_number\": 1,\n \"max_options_number\": 1,\n \"availability\":\"available / unavailable / sold_out\",\n \"modifiers_options\": [\n {\n \"koinz_id\": \"koinz_uuid\",\n \"pos_id\": \"your_system_id\",\n \"name\": \"item\",\n \"localized_name\": \"صنف 1\",\n \"created_at\": 1647363953000,\n \"updated_at\": 1658235620601,\n \"order\": 11,\n \"is_deleted\": 0,\n \"tax\": 0.14,\n \"price\": 39,\n \"availability\":\"available / unavailable / sold_out\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n}"},{"id":"31d66596-cfee-407d-b81f-c2ed2b9de011","name":"400 Validation Failure","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"url":{"raw":"/api/v1/branch/{branch_id}/menu?Authorization=Bearer {access_token}","path":["api","v1","branch","{branch_id}","menu"],"query":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}]}},"code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"VALIDATION-ERROR\",\n \"message\": {\n \"name\": [\n \"name is required\"\n ]\n }\n}"},{"id":"036922e5-dd5d-4ce5-9b4f-f2f49bcbd881","name":"401 Authorization Failure","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"url":{"raw":"/api/v1/branch/{branch_id}/menu?Authorization=Bearer {access_token}","path":["api","v1","branch","{branch_id}","menu"],"query":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"AUTHENTICATION-ERROR\",\n \"message\": \"Authorization Token not found in Authorization header\"\n}"},{"id":"a48b7df0-524c-4699-b4a1-1f60ef9be8dc","name":"403 General Failure","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"url":{"raw":"/api/v1/branch/{branch_id}/menu?Authorization=Bearer {access_token}","path":["api","v1","branch","{branch_id}","menu"],"query":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"MENU_01\",\n \"message\": \"Something went wrong while syncing menu\"\n}"},{"id":"981fea86-01c0-4856-92da-75dcdd12c3f0","name":"500 Server Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"url":{"raw":"/api/v1/branch/{branch_id}/menu?Authorization=Bearer {access_token}","path":["api","v1","branch","{branch_id}","menu"],"query":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}]}},"code":500,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SERVER-FAILURE\",\n \"message\": \"Something wrong happened\"\n}"}],"_postman_id":"18d9cdd3-8a4d-46c5-8c8a-905a2365c8a6"},{"name":"Sync Categories","id":"4146ff25-7c2b-49ca-8a9b-746d41eb75f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27444\",\n \"name\": \"test_cat_11\",\n \"localized_name\": \"sandwiches\",\n \"is_deleted\": 0,\n \"order\": 1\n },\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27555\",\n \"name\": \"test_cat_22\",\n \"localized_name\": \"plates\",\n \"is_deleted\": 0,\n \"order\": 2\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/categories/sync","description":"

Description:

This endpoint is used to (create/update/delete) the menu Categories.

Note that name and localized_name are updated only once, if you would like to update them again please contact us through our support email, or update them through Koinz Merchant Dashboard provided to the store manager.

Request body parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
pos_id	double	A unique identifying string for the category, provided by the restaurant.
name	string	Category name.
localized_name	string	Localized category name if the business uses localization.
is_deleted	boolean	Use 1 if you want to delete this Category
order	integer	The order of the category which will be displayed to the customer.

","urlObject":{"path":["api","v1","categories","sync"],"query":[],"variable":[]}},"response":[{"id":"316dfe30-173f-412d-939f-2e117e0b8e1f","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27444\",\n \"name\": \"sandwiches\",\n \"localized_name\": \"sandwiches\",\n \"is_deleted\": 0,\n \"order\": 1\n },\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27555\",\n \"name\": \"plates\",\n \"localized_name\": \"plates\",\n \"is_deleted\": 0,\n \"order\": 1\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/categories/sync"},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"failed\": []\n}"},{"id":"68af4a6d-eb91-471d-a64a-ee0ac88fd093","name":"200 Success with failed entities","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27444\",\n \"name\": \"sandwiches\",\n \"localized_name\": \"sandwiches\",\n \"is_deleted\": 0,\n \"order\": 1\n },\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27555\",\n \"name\": \"plates\",\n \"localized_name\": \"plates\",\n \"is_deleted\": 0,\n \"order\": 1\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/categories/sync"},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"failed\": [\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27444\",\n \"message\": \"Failed to sync this category\",\n \"code\": \"CATEGORY-02\"\n }\n ]\n}"},{"id":"3fdb98f8-7594-42a6-bb57-fb9920fd94f1","name":"400 Validation Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27444\",\n \"localized_name\": \"sandwiches\",\n \"is_deleted\": 0,\n \"order\": 1\n },\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27555\",\n \"name\": \"plates\",\n \"localized_name\": \"plates\",\n \"is_deleted\": 0,\n \"order\": 1\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/categories/sync"},"code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"VALIDATION-ERROR\",\n \"message\": {\n \"name\": [\n \"name is required\"\n ]\n }\n}"},{"id":"1a93784c-dc48-4259-be52-dc5cb09c4cfa","name":"401 Authorization Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27444\",\n \"name\": \"sandwiches\",\n \"localized_name\": \"sandwiches\",\n \"is_deleted\": 0,\n \"order\": 1\n },\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27555\",\n \"name\": \"plates\",\n \"localized_name\": \"plates\",\n \"is_deleted\": 0,\n \"order\": 1\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/categories/sync"},"code":401,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"AUTHENTICATION-ERROR\",\n \"message\": \"Authorization Token not found in Authorization header\"\n}"},{"id":"ba857f2a-ab35-4faa-b8fd-746250551df4","name":"403 General Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27444\",\n \"name\": \"sandwiches\",\n \"localized_name\": \"sandwiches\",\n \"is_deleted\": 0,\n \"order\": 1\n },\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27555\",\n \"name\": \"plates\",\n \"localized_name\": \"plates\",\n \"is_deleted\": 0,\n \"order\": 1\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/categories/sync"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"CATEGORIES_01\",\n \"message\": \"Something went wrong while syncing categories\"\n}"},{"id":"1d1561ba-37ed-4faa-98e2-2241194abac0","name":"500 Server Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27444\",\n \"name\": \"sandwiches\",\n \"localized_name\": \"sandwiches\",\n \"is_deleted\": 0,\n \"order\": 1\n },\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27555\",\n \"name\": \"plates\",\n \"localized_name\": \"plates\",\n \"is_deleted\": 0,\n \"order\": 1\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/categories/sync"},"code":500,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SERVER-FAILURE\",\n \"message\": \"Something wrong happened\"\n}"}],"_postman_id":"4146ff25-7c2b-49ca-8a9b-746d41eb75f3"},{"name":"Sync Items","id":"2aa0ed1f-7c05-4945-bacc-52f68bf76afe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27444\",\n \"name\": \"size\",\n \"localized_name\": \"size\",\n \"is_deleted\": 0,\n \"category_pos_id\": 0,\n \"order\": 1,\n \"branches_configs\": [\n {\n \"branch_pos_id\": \"sasgb-lgdfsl-gafag\",\n \"availability\": \"available\"\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/items/sync","description":"

Developer can use this end point to add/update/delete items in Koinz system.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
pos_id	double	A unique identifying string for the item, provided by the restaurant.
category_pos_id	double	A unique identifying string for the related category, provided by the restaurant.
name	string	Item name.
localized_name	string	Localized item name if the business uses localization.
description	string	Item description.
localized_description	string	Localized item description if the business uses localization.
order	integer	The order of the item which will be displayed to the customer.
image	string (url)	Item image url.
tax	float	Specifies the taxes applicable to this item and its modifiers.
is_deleted	boolean	Determines if the item is deleted or not.
price	float	Default item price in all branches(Developer can change the peice in custom branch by sendeing it in the \"branches_configs.price\").
branches_configs [optional]	array	List of Custom Branches configs. By default item availaible in all branches except branches with custom configs.
branches_configs.branch_pos_id	string	A unique identifying string for the branch, provided by the restaurant.
branches_configs.availability	string (enum)	Determines item availability in this branch. Allowed values: [\"available\", \"unavailable\", \"sold_out\"].
branches_configs.price	float	Custom item price in this branch.

","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"06615353-b632-4728-8153-dfe6c664e33a","id":"06615353-b632-4728-8153-dfe6c664e33a","name":"Menu management","type":"folder"}},"urlObject":{"path":["api","v1","items","sync"],"query":[],"variable":[]}},"response":[{"id":"a1a476e3-b16f-4093-945e-472d17fdf8ee","name":"200 success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"e0b9aeab-6865-46ec-81ad-b89a6f052ec6\",\n \"category_pos_id\": \"ccf981be-7d1b-46e6-9296-192113d3c193\",\n \"name\": \"Orange Juice\",\n \"localized_name\": \"برتقال عصير\",\n \"description\": \"Fresh orange juice\",\n \"localized_description\": \"منعش عصير برتقال\",\n \"order\": 1,\n \"image\": \"image_url\",\n \"tax\": 0.14,\n \"is_deleted\": 0,\n \"price\": 7,\n \"branches_configs\": [\n {\n \"branch_pos_id\": \"e27ac84b-e0e7-474c-8ba1-0cd1366d9ba3\",\n \"availability\": \"available\",\n \"price\": 5\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/items/sync"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"failed_items\": [\n \n ]\n}"},{"id":"624d0f81-d64a-439b-a252-cd4cbaab5d7c","name":"200 Success with failed entities","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"e0b9aeab-6865-46ec-81ad-b89a6f052ec6\",\n \"category_pos_id\": \"ccf981be-7d1b-46e6-9296-192113d3c193\",\n \"name\": \"Orange Juice\",\n \"localized_name\": \"برتقال عصير\",\n \"description\": \"Fresh orange juice\",\n \"localized_description\": \"منعش عصير برتقال\",\n \"order\": 1,\n \"image\": \"image_url\",\n \"tax\": 0.14,\n \"is_deleted\": 0,\n \"price\": 7,\n \"branches_configs\": [\n {\n \"branch_pos_id\": \"e27ac84b-e0e7-474c-8ba1-0cd1366d9ba3\",\n \"availability\": \"available\",\n \"price\": 5\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/items/sync"},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"failed_items\": [\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27444\",\n \"code\": \"ITEM_01\",\n \"message\": \"Related category doesn't exists\"\n }\n ]\n}"},{"id":"c6842add-8230-4009-95ba-b436a8715836","name":"400 Validation Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"e0b9aeab-6865-46ec-81ad-b89a6f052ec6\",\n \"category_pos_id\": \"ccf981be-7d1b-46e6-9296-192113d3c193\",\n \"name\": \"Orange Juice\",\n \"localized_name\": \"برتقال عصير\",\n \"description\": \"Fresh orange juice\",\n \"localized_description\": \"منعش عصير برتقال\",\n \"order\": 1,\n \"image\": \"image_url\",\n \"tax\": 0.14,\n \"is_deleted\": 0,\n \"price\": 7,\n \"branches_configs\": [\n {\n \"branch_pos_id\": \"e27ac84b-e0e7-474c-8ba1-0cd1366d9ba3\",\n \"availability\": \"available\",\n \"price\": 5\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/items/sync"},"code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"VALIDATION-ERROR\",\n \"message\": {\n \"name\": [\n \"name is required\"\n ]\n }\n}"},{"id":"15a76e19-0ea8-4b7e-b1bf-b5bb8955a7d5","name":"401 Authorization Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"e0b9aeab-6865-46ec-81ad-b89a6f052ec6\",\n \"category_pos_id\": \"ccf981be-7d1b-46e6-9296-192113d3c193\",\n \"name\": \"Orange Juice\",\n \"localized_name\": \"برتقال عصير\",\n \"description\": \"Fresh orange juice\",\n \"localized_description\": \"منعش عصير برتقال\",\n \"order\": 1,\n \"image\": \"image_url\",\n \"tax\": 0.14,\n \"is_deleted\": 0,\n \"price\": 7,\n \"branches_configs\": [\n {\n \"branch_pos_id\": \"e27ac84b-e0e7-474c-8ba1-0cd1366d9ba3\",\n \"availability\": \"available\",\n \"price\": 5\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/items/sync"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"AUTHENTICATION-ERROR\",\n \"message\": \"Authorization Token not found in Authorization header\"\n}"},{"id":"3f8b77ef-cfd8-474d-ba47-f8321b210dd8","name":"403 General Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"e0b9aeab-6865-46ec-81ad-b89a6f052ec6\",\n \"category_pos_id\": \"ccf981be-7d1b-46e6-9296-192113d3c193\",\n \"name\": \"Orange Juice\",\n \"localized_name\": \"برتقال عصير\",\n \"description\": \"Fresh orange juice\",\n \"localized_description\": \"منعش عصير برتقال\",\n \"order\": 1,\n \"image\": \"image_url\",\n \"tax\": 0.14,\n \"is_deleted\": 0,\n \"price\": 7,\n \"branches_configs\": [\n {\n \"branch_pos_id\": \"e27ac84b-e0e7-474c-8ba1-0cd1366d9ba3\",\n \"availability\": \"available\",\n \"price\": 5\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/items/sync"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"ITEM_01\",\n \"message\": \"Something went wrong while syncing items\"\n}"},{"id":"fd0b479f-b6f5-47db-8d8c-d77b04a41780","name":"500 Server Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"e0b9aeab-6865-46ec-81ad-b89a6f052ec6\",\n \"category_pos_id\": \"ccf981be-7d1b-46e6-9296-192113d3c193\",\n \"name\": \"Orange Juice\",\n \"localized_name\": \"برتقال عصير\",\n \"description\": \"Fresh orange juice\",\n \"localized_description\": \"منعش عصير برتقال\",\n \"order\": 1,\n \"image\": \"image_url\",\n \"tax\": 0.14,\n \"is_deleted\": 0,\n \"price\": 7,\n \"branches_configs\": [\n {\n \"branch_pos_id\": \"e27ac84b-e0e7-474c-8ba1-0cd1366d9ba3\",\n \"availability\": \"available\",\n \"price\": 5\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/items/sync"},"code":500,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SERVER-FAILURE\",\n \"message\": \"Something wrong happened\"\n}"}],"_postman_id":"2aa0ed1f-7c05-4945-bacc-52f68bf76afe"},{"name":"Sync Modifiers Group","id":"c9725d22-11ee-4c56-b969-8cd19e9a9e83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"/api/v1/modifiers-group/sync","description":"

This endpoint allows a developer to add/update/delete the modifiers groups in Koinz system.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
pos_id	string	A unique identifying string for the menu, provided by the pos.
name	string	Modifiers group name.
localized_name	string	Localized modifier group name if business uses localization.
order	integer	the order of the modifiers group which will be displayed to customer.
is_deleted	integer	determines if modifiers group is deleted or not.
items_configs	array	List of items configrations attached to the modifier group.

items_configs object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
item_pos_id	string	A unique identifying string for the item, provided by Koinz.
min_options_number	integer	Minimum quantity of modifiers options allowed to be ordered in this modifier group.
max_options_number	integer	Maximum quantity of modifiers options allowed to be ordered in this modifier group.

","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"06615353-b632-4728-8153-dfe6c664e33a","id":"06615353-b632-4728-8153-dfe6c664e33a","name":"Menu management","type":"folder"}},"urlObject":{"path":["api","v1","modifiers-group","sync"],"query":[],"variable":[]}},"response":[{"id":"3ed37383-80e0-4cfc-9a36-285dca27d633","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"9d67d087-584a-48c5-92bd-96316c1aed2f\",\n \"name\": \"size\",\n \"localized_name\": \"الحجم\",\n \"is_deleted\": 0,\n \"items_configs\": [\n {\n \"item_pos_id\": \"9d67d087-584a-48c5-92bd-96316c1aed2f\",\n \"min_options_number\": 1,\n \"max_options_number\": 1\n }\n ],\n \"order\": 1\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/modifiers-group/sync"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"failed\": []\n}"},{"id":"0d6b4240-50d5-480d-9f86-824236db7208","name":"200 Success with failed entities","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"9d67d087-584a-48c5-92bd-96316c1aed2f\",\n \"name\": \"size\",\n \"localized_name\": \"الحجم\",\n \"is_deleted\": 0,\n \"items_configs\": [\n {\n \"item_pos_id\": \"9d67d087-584a-48c5-92bd-96316c1aed2f\",\n \"min_options_number\": 1,\n \"max_options_number\": 1\n }\n ],\n \"order\": 1\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/modifiers-group/sync"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"failed\": [\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27444\",\n \"code\": \"MG-01\",\n \"message\": \"Item related to Modifiers Group not found please item first\"\n }\n ]\n}"},{"id":"0983845b-e979-44b3-b4e2-2220b6244449","name":"400 Validation Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27444\",\n \"name\": \"size\",\n \"localized_name\": \"size\",\n \"is_deleted\": 0,\n \"items_configs\": [\n {\n \"item_pos_id\": \"9f28a1ed-1ed9-4c3f\",\n \"min_options_number\": 1,\n \"max_options_number\": 1\n }\n ],\n \"order\": 1\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/modifiers-group/sync"},"code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"VALIDATION-ERROR\",\n \"message\": {\n \"name\": [\n \"name is required\"\n ]\n }\n}"},{"id":"1bab6d88-ab52-4831-99da-00d29681bf4b","name":"401 Authorization Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27444\",\n \"name\": \"size\",\n \"localized_name\": \"size\",\n \"is_deleted\": 0,\n \"items_configs\": [\n {\n \"item_pos_id\": \"9f28a1ed-1ed9-4c3f\",\n \"min_options_number\": 1,\n \"max_options_number\": 1\n }\n ],\n \"order\": 1\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/modifiers-group/sync"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"AUTHENTICATION-ERROR\",\n \"message\": \"Authorization Token not found in Authorization header\"\n}"},{"id":"88f8ebb5-ee96-48a6-b989-1e83bad152b3","name":"403 General Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27444\",\n \"name\": \"size\",\n \"localized_name\": \"size\",\n \"is_deleted\": 0,\n \"items_configs\": [\n {\n \"item_pos_id\": \"9f28a1ed-1ed9-4c3f\",\n \"min_options_number\": 1,\n \"max_options_number\": 1\n }\n ],\n \"order\": 1\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/modifiers-group/sync"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"CATEGORIES_01\",\n \"message\": \"Something went wrong while syncing categories\"\n}"},{"id":"cd4e7601-30b5-4bab-94f1-a62208cc8bbc","name":"500 Server Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27444\",\n \"name\": \"size\",\n \"localized_name\": \"size\",\n \"is_deleted\": 0,\n \"items_configs\": [\n {\n \"item_pos_id\": \"9f28a1ed-1ed9-4c3f\",\n \"min_options_number\": 1,\n \"max_options_number\": 1\n }\n ],\n \"order\": 1\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/modifiers-group/sync"},"code":500,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SERVER-FAILURE\",\n \"message\": \"Something wrong happened\"\n}"}],"_postman_id":"c9725d22-11ee-4c56-b969-8cd19e9a9e83"},{"name":"Sync Modifiers options","id":"b359c71b-ebd5-42f7-b6e3-d2c8887c0abb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"/api/v1/modifiers/sync","description":"

This endpoint allows a developer to add/update/delete the modifiers options in Koinz system.

Response body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
pos_id	string	A unique identifying string for the modifier option, provided by the store.
modifiers_group_pos_id	string	A unique identifying string for the related modifier group, provided by the store.
name	string	Modifier option name.
localized_name	string	Localized modifier option name if the business uses localization.
order	integer	The order of the modifier which will be displayed to the customer.
tax	float	Specifies the taxes applicable to this modifier.
is_deleted	boolean	Determines if the modifier is deleted or not.
price	float	Default modifier price in all branches(Developer can change the price in specific branch by sendeing it in the \"branches_configs.price\").
branches_configs [optional]	array	List of Custom Branches configs. By default modifier option availaible in all branches except branches with custom configs.

Branches configs object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
branch_pos_id	string	A unique identifying string for the branch, provided by the restaurant.
availability	string (enum)	Determines modifier availability in this branch. Allowed values: [\"available\", \"unavailable\", \"sold_out\"].
price	float	Custom modifier price in this branch.

","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"06615353-b632-4728-8153-dfe6c664e33a","id":"06615353-b632-4728-8153-dfe6c664e33a","name":"Menu management","type":"folder"}},"urlObject":{"path":["api","v1","modifiers","sync"],"query":[],"variable":[]}},"response":[{"id":"0850d964-865a-48c4-a329-14ccba4152c4","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"2554f813-e656-44d3-bd76-dbd57a9f86d3\",\n \"name\": \"small\",\n \"localized_name\": \"صغير\",\n \"is_deleted\": 0,\n \"modifier_group_pos_id\": \"d505dc5f-f10e-4ad2-a07f-6830d4333575\",\n \"order\": 1,\n \"excluded_items\": [\n \"a3e936f4-ba34-47b8-b568-31437979b592\"\n ],\n \"branches_configs\": [\n {\n \"branch_pos_id\": \"6bc9fd7a-51a8-4e48-b627-fb3b74913bc7\",\n \"availability\": \"available\"\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/modifiers/sync"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"failed\": []\n}"},{"id":"3497c3cc-4f30-4bee-99c5-1b8df2c8441b","name":"200 Success with failed entities","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"2554f813-e656-44d3-bd76-dbd57a9f86d3\",\n \"name\": \"small\",\n \"localized_name\": \"صغير\",\n \"is_deleted\": 0,\n \"modifier_group_pos_id\": \"d505dc5f-f10e-4ad2-a07f-6830d4333575\",\n \"order\": 1,\n \"excluded_items\": [\n \"a3e936f4-ba34-47b8-b568-31437979b592\"\n ],\n \"branches_configs\": [\n {\n \"branch_pos_id\": \"6bc9fd7a-51a8-4e48-b627-fb3b74913bc7\",\n \"availability\": \"available\"\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/modifiers/sync"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"failed\": [\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27444\",\n \"code\": \"MG-01\",\n \"message\": \"Item related to Modifiers Group not found please item first\"\n }\n ]\n}"},{"id":"1c9f507f-2c28-45d9-ad6e-70417a173e02","name":"400 Validation Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"2554f813-e656-44d3-bd76-dbd57a9f86d3\",\n \"name\": \"small\",\n \"localized_name\": \"صغير\",\n \"is_deleted\": 0,\n \"modifier_group_pos_id\": \"d505dc5f-f10e-4ad2-a07f-6830d4333575\",\n \"order\": 1,\n \"excluded_items\": [\n \"a3e936f4-ba34-47b8-b568-31437979b592\"\n ],\n \"branches_configs\": [\n {\n \"branch_pos_id\": \"6bc9fd7a-51a8-4e48-b627-fb3b74913bc7\",\n \"availability\": \"available\"\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/modifiers/sync"},"code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"VALIDATION-ERROR\",\n \"message\": {\n \"name\": [\n \"name is required\"\n ]\n }\n}"},{"id":"b6ef27b5-56fb-4a6d-8f65-d88d696bcb4a","name":"401 Authorization Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"2554f813-e656-44d3-bd76-dbd57a9f86d3\",\n \"name\": \"small\",\n \"localized_name\": \"صغير\",\n \"is_deleted\": 0,\n \"modifier_group_pos_id\": \"d505dc5f-f10e-4ad2-a07f-6830d4333575\",\n \"order\": 1,\n \"excluded_items\": [\n \"a3e936f4-ba34-47b8-b568-31437979b592\"\n ],\n \"branches_configs\": [\n {\n \"branch_pos_id\": \"6bc9fd7a-51a8-4e48-b627-fb3b74913bc7\",\n \"availability\": \"available\"\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/modifiers/sync"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"AUTHENTICATION-ERROR\",\n \"message\": \"Authorization Token not found in Authorization header\"\n}"},{"id":"351b5d9b-cfe8-4533-8f0c-6a12e1187a18","name":"403 General Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"2554f813-e656-44d3-bd76-dbd57a9f86d3\",\n \"name\": \"small\",\n \"localized_name\": \"صغير\",\n \"is_deleted\": 0,\n \"modifier_group_pos_id\": \"d505dc5f-f10e-4ad2-a07f-6830d4333575\",\n \"order\": 1,\n \"excluded_items\": [\n \"a3e936f4-ba34-47b8-b568-31437979b592\"\n ],\n \"branches_configs\": [\n {\n \"branch_pos_id\": \"6bc9fd7a-51a8-4e48-b627-fb3b74913bc7\",\n \"availability\": \"available\"\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/modifiers/sync"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"MODIFIERS_01\",\n \"message\": \"Something went wrong while syncing categories\"\n}"},{"id":"577e7402-cfbe-4c57-a48b-dd52743e45be","name":"500 Server Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"2554f813-e656-44d3-bd76-dbd57a9f86d3\",\n \"name\": \"small\",\n \"localized_name\": \"صغير\",\n \"is_deleted\": 0,\n \"modifier_group_pos_id\": \"d505dc5f-f10e-4ad2-a07f-6830d4333575\",\n \"order\": 1,\n \"excluded_items\": [\n \"a3e936f4-ba34-47b8-b568-31437979b592\"\n ],\n \"branches_configs\": [\n {\n \"branch_pos_id\": \"6bc9fd7a-51a8-4e48-b627-fb3b74913bc7\",\n \"availability\": \"available\"\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/modifiers/sync"},"code":500,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SERVER-FAILURE\",\n \"message\": \"Something wrong happened\"\n}"}],"_postman_id":"b359c71b-ebd5-42f7-b6e3-d2c8887c0abb"}],"id":"06615353-b632-4728-8153-dfe6c664e33a","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"d23ba377-64a0-4510-88d8-df2f21d09f4f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"69750084-6a68-492f-b360-75b1a85759ae","type":"text/javascript","exec":[""]}}],"_postman_id":"06615353-b632-4728-8153-dfe6c664e33a","description":""},{"name":"Order Management","item":[{"name":"Webhooks","item":[{"name":"Dispatch Order","id":"20c19ab2-63e9-4644-8fb4-dae2dd7e5e5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https:///order/dispatch","description":"

Description

This Webhook is used to notify the pos about a new dispatched order on Koinz. You will use the provided koinz_id to get the order details using the /api/v1/order/{koinz_id} endpoint.

Request body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	type	Description
koinz_id	string	koinz order id

","urlObject":{"protocol":"https","path":["order","dispatch"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"6465d0e4-517d-49e7-a9bf-e56280e6fe3a","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"koinz_id\": \"ea9a4cd9-824d-4fff-b905-10c5b17281dc\"\n}","options":{"raw":{"language":"json"}}},"url":"https:///order/dispatch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""},{"id":"06967b8a-7801-472c-92db-ce495df127de","name":"400 Validation Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"koinz_id\": \"ea9a4cd9-824d-4fff-b905-10c5b17281dc\"\n}","options":{"raw":{"language":"json"}}},"url":"https:///order/dispatch"},"code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""},{"id":"d2de62cb-4841-4669-9f2c-6e61e81cd625","name":"401 Authorization Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"koinz_id\": \"ea9a4cd9-824d-4fff-b905-10c5b17281dc\"\n}","options":{"raw":{"language":"json"}}},"url":"https:///order/dispatch"},"code":401,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"20c19ab2-63e9-4644-8fb4-dae2dd7e5e5d"},{"name":"Update Order Status","id":"cac69bba-a105-492f-9531-c5abc22e62d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"cancelled\"\n}","options":{"raw":{"language":"json"}}},"url":"https:///order/{koinz_order_id}/status","description":"

Description

This Webhook is used to notify the pos about status updates for dispatched order from koinz .

Currently only called if an order is cancelled from Koinz side.

Request body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
status	string	The status of the order Value: \"cancelled\"

","urlObject":{"protocol":"https","path":["order","{koinz_order_id}","status"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"88bdd6e7-be1b-4207-80b6-b5feef39b6ff","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"cancelled\"\n}","options":{"raw":{"language":"json"}}},"url":"https:///order/{koinz_order_id}/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""},{"id":"10656a06-8efe-4a7e-b44a-c63c1ff3f1ef","name":"400 Validation Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"koinz_id\": \"ea9a4cd9-824d-4fff-b905-10c5b17281dc\"\n}","options":{"raw":{"language":"json"}}},"url":"https:///order/{koinz_order_id}/status"},"code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""},{"id":"8849334d-c02e-411d-935c-f573053f5cb6","name":"401 Authorization Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"koinz_id\": \"ea9a4cd9-824d-4fff-b905-10c5b17281dc\"\n}","options":{"raw":{"language":"json"}}},"url":"https:///order/{koinz_order_id}/status"},"code":401,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"cac69bba-a105-492f-9531-c5abc22e62d2"}],"id":"5314c917-4c5d-4394-b02d-56357fc4423b","description":"

Webhooks are endpoints that are going to be implemented by the POS side. Koinz will call these endpoints to notify the POS about some events like a new dispatched order, or an order status update.

Authentication

To be documented ..

Response

The expected responses to your webhook are [200, 400, 401]. Any other response will lead to retrying the request.
Your system should not use any other response code than the ones listed here.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status Code	Description
200	Successfully Acknowledged
400	Validation Error
401	Authentication Error

Retry Attempts

We have implemented an exponential back-off algorithm with a back-off multiplier of 30 seconds which will make up to 7 attempts. This means we will attempt to request your webhook up to 7 times across roughly 1 hour.

\n","_postman_id":"5314c917-4c5d-4394-b02d-56357fc4423b"},{"name":"Get Order details","id":"a8e1caf0-e11b-420d-8d68-da396df582a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"url":"/api/v1/order/{koinz_order_id}","description":"

This endpoint retrieves all details for order on Koinz.

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
order_id	string (UUID)	Unique identifying string for order on Koinz.

Response body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
koinz_id	string (UUID)	A unique identifying string for the order provided by Koinz.
koinz_order_code	integer (6 digits)	A unique identifying number for the order in the store, provided by koinz.
order_type	string (enum)	The dining type of the order. Possible values: pickup: Refers to orders that will be recieved by customer in the branch. delivery: Refers to orders that will be delivered to the customer.
created_at	number (8 bytes)	The time when the order has been created. Specified as a Unix timestamp in milliseconds since Jan 1, 1970.
updated_at	number (8 bytes)	The time when the order has been updated. Specified as a Unix timestamp in milliseconds since Jan 1, 1970.
sub_total	float	The total cost of each item in the order excluded discounts and fees.
discount_value	float	Discount value on the order cost that has a promo code.
total_invoice	float	The total cost of the entire order, including taxes, discount and fees.
payment_method	string (enum)	Order payment method possible values: (\"cash\", \"online\").
status	string (enum)	Order payment method possible values: (\"sent\", \"accepted\", \"rejected\", \"out_for_delivery\", \"delivered\", \"ready_for_pickup\", \"got_picked_up\", \"canceled_by_customer\")
estimated_ready_time	number (8 bytes)	The time we expect the order to be ready. Specified as a Unix timestamp in milliseconds since Jan 1, 1970.
estimated_delivery_time	number (8 bytes)
delivery_fees	float	Order delivery fees.
delivered_by	string (enum)	The order delivery way. possible values: (\"in_house_delivery\", \"courier_delivery\")
courier	object [optional]	Courier info
customer	object	Order customer data.
branch	object	Order Branch data.
comment	string	order note
order_items	array	Order items data.

Order item object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
koinz_id	string (UUID)	A unique identifying string for the item, provided by Koinz.
pos_id	string	A unique identifying string for the item, provided by the store.
name	string	Item name.
localized_name	string	Localized item name if the business uses localization.
quantity	integer	Item quantity in the order.
is_gift	boolean	Identifying if this item is a gift redeemed by koinz loyalty system or not.
created_at	number (8 bytes)	The time when the item has been created. Specified as a Unix timestamp in milliseconds since Jan 1, 1970.
updated_at	number (8 bytes)	The time when the item has been updated. Specified as a Unix timestamp in milliseconds since Jan 1, 1970.
tax	float	Specifies the taxes applied to this item and its modifiers.
price	float	item price in this branch.
modifiers_options	array	Array of order item modifiers_options.

Modifiers object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
koinz_id	string (UUID)	A unique identifying string for the modifier option, provided by Koinz.
pos_id	string	A unique identifying string for the modifier option, provided by the restaurant.
name	string	Modifier option name.
localized_name	string	Localized modifier option name if the business uses localization.
created_at	number (8 bytes)	The time when the modifier option has been created. Specified as a Unix timestamp in milliseconds since Jan 1, 1970.
updated_at	number (8 bytes)	The time when the modifier option has been updated. Specified as a Unix timestamp in milliseconds since Jan 1, 1970.
tax	float	Specifies the taxes applicable to this modifier option.
price	float	Modifier option price in this branch.

","urlObject":{"path":["api","v1","order","{koinz_order_id}"],"query":[],"variable":[]}},"response":[{"id":"bb81127c-53d7-4d51-b901-618f6b855c22","name":"200 success delivery order","originalRequest":{"method":"GET","header":[],"url":"/api/v1/order/{koinz_order_id}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"koinz_order_id\": \"koinz_uuid\",\n \"order_type\": \"delivery\",\n \"order_code\": \"356671\",\n \"created_at\": 1655648799985,\n \"updated_at\": 1658235616186,\n \"sub_total\": 60.5,\n \"discount_value\":10.0,\n \"commnet\":\"add more \",\n \"total_invoice\": 50.5,\n \"payment_method\": \"cash\",\n \"status\": \"sent\",\n \"estimated_ready_time\": 1655649861000,\n \"estimated_delivery_time\": 1655657901000,\n \"delivery_fees\": 3.5,\n \"delivered_by\": \"Call Nola\",\n \"courier\": {\n \"name\":\"test\",\n \"phone_number\":\"+201012345678\"\n },\n \"customer\" : {\n \"id\": \"koinz_uuid\",\n \"phone_number\":\"01000649695\",\n \"country_code\":\"+2\"\n },\n \"branch\": {\n \"koinz_id\": \"koinz_uuid\",\n \"pos_id\": \"75d7d627-afa7-4298-9ee9-0a781e1b2011\",\n \"name\": \"Zahraa Al Maadi\",\n \"localized_name\": \"Zahraa Al Maadi\"\n },\n \"order_items\": [\n {\n \"koinz_id\": \"koinz_uuid\",\n \"pos_id\": \"1c04tc74-735d-45\",\n \"created_at\": 1647364435000,\n \"updated_at\": 1658235616186,\n \"quantity\": 6,\n \"is_gift\": 0,\n \"name\": \"Cake \",\n \"localized_name\": \"كيك\",\n \"commnet\":\"add more \",\n \"tax\": 0.14,\n \"price\": 10.6,\n \"modifiers_options\": [\n {\n \"koinz_id\": \"koinz_uuid\",\n \"pos_id\": \"your_system_id\",\n \"created_at\": 1647363953000,\n \"updated_at\": 1658235620601,\n \"name\": \"small size\",\n \"localized_name\": \"حجم صغير\",\n \"tax\": 0.14,\n \"price\": 1\n }\n ]\n },\n {\n \"koinz_id\": \"koinz_uuid\",\n \"pos_id\": \"1c04tc74-735d-45\",\n \"created_at\": 1647364435000,\n \"updated_at\": 1658235616186,\n \"quantity\": 6,\n \"is_gift\": 1,\n \"en_name\": \"Gift name\",\n \"ar_name\": \"هدية\",\n \"tax\": 0.14,\n \"price\": 10.6,\n \"modifiers_options\": [\n {\n \"koinz_id\": \"koinz_uuid\",\n \"pos_id\": \"your_system_id\",\n \"created_at\": 1647363953000,\n \"updated_at\": 1658235620601,\n \"name\": \"big size\",\n \"localized_name\": \"حجم كبير\",\n \"tax\": 0.14,\n \"price\": 2\n }\n ]\n }\n ]\n}"},{"id":"9795d6a2-e020-40f8-bd0b-b99a8c3fa0e5","name":"200 success pickup order","originalRequest":{"method":"GET","header":[],"url":"/api/v1/order/{koinz_order_id}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"koinz_order_id\": \"koinz_uuid\",\n \"order_type\": \"pickup\",\n \"order_code\": \"357781\",\n \"created_at\": 1655648799985,\n \"updated_at\": 1658235616186,\n \"sub_total\": 60.5,\n \"discount_value\":10.0,\n \"total_invoice\": 50.5,\n \"payment_method\": \"cash\",\n \"status\": \"sent\",\n \"estimated_ready_time\": 1655649861000,\n \"estimated_customer_arrival_time\": 1655657901000,\n \"customer\" : {\n \"id\": \"koinz_uuid\",\n \"phone_number\":\"+201000649695\",\n \"name\": \"test_name\",\n \"email\": \"test@koinz.app\"\n },\n \"branch\": {\n \"koinz_id\": \"koinz_uuid\",\n \"pos_id\": \"75d7d627-afa\",\n \"name\": \"Zahraa Al Maadi\",\n \"localized_name\": \"Zahraa Al Maadi\"\n },\n \"order_items\": [\n {\n \"koinz_id\": \"koinz_uuid\",\n \"pos_id\": \"1c04tc74-735d-45\",\n \"created_at\": 1647364435000,\n \"updated_at\": 1658235616186,\n \"quantity\": 6,\n \"is_gift\": 0,\n \"name\": \"Cake \",\n \"localized_name\": \"كيك\",\n \"total_price\": 10.6,\n \"modifiers_options\": [\n {\n \"koinz_id\": \"koinz_uuid\",\n \"pos_id\": \"your_system_id\",\n \"created_at\": 1647363953000,\n \"updated_at\": 1658235620601,\n \"name\": \"small size\",\n \"localized_name\": \"حجم صغير\",\n \"tax\": 0.14,\n \"price\": 1\n }\n ]\n },\n {\n \"koinz_id\": \"koinz_uuid\",\n \"pos_id\": \"1c04tc74-735d-45\",\n \"created_at\": 1647364435000,\n \"updated_at\": 1658235616186,\n \"quantity\": 6,\n \"is_gift\": 1,\n \"en_name\": \"Gift name\",\n \"ar_name\": \"هدية\",\n \"tax\": 0.14,\n \"price\": 10.6,\n \"modifiers_options\": [\n {\n \"koinz_id\": \"koinz_uuid\",\n \"pos_id\": \"your_system_id\",\n \"created_at\": 1647363953000,\n \"updated_at\": 1658235620601,\n \"name\": \"big size\",\n \"localized_name\": \"حجم كبير\",\n \"tax\": 0.14,\n \"price\": 2\n }\n ]\n }\n ]\n}"}],"_postman_id":"a8e1caf0-e11b-420d-8d68-da396df582a6"},{"name":"Update Order Status","id":"fe223c90-95fa-4418-9d0d-70ecefd42e77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"{{url}}/api/v1/order/{koinz_order_id}/status","description":"

This endpoint is used to update the order status

Response body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	type	Description
status	string (enum)	Order status in Koinz system Allowed values: rejected: Order is rejected before acceptance. accepted: Order is accepted. cancelled: Order is cancelled and customer will be penalized depending on the reason. ready_for_pickup : Order is ready to be picked up. got_picked_up: Order is picked up successfully. out_for_delivery: Order is being delivered. delivered : Order has been delivered.
reason [optional]	string (enum)	Order cancelled reasons in Koinz system Allowed values: store_issue: Order is cancelled because of store related issue customer_issue: Order is cancelled because of customer related issue
cashier_id	string (enum)	Pos Cahsier Id that updated the order
cashier_name	string (enum)	Pos Cahsier name that updated the order

","urlObject":{"path":["api","v1","order","{koinz_order_id}","status"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"45425047-c0a5-4b71-863e-29411343a4d8","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"out_for_delivery\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/order/koinz_order_id/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""},{"id":"c051e139-1a80-4cdf-8e62-01b82f57a614","name":"400 Validation Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27444\",\n \"name\": \"size\",\n \"localized_name\": \"size\",\n \"is_deleted\": 0,\n \"items_configs\": [\n {\n \"item_pos_id\": \"9f28a1ed-1ed9-4c3f\",\n \"min_options_number\": 1,\n \"max_options_number\": 1\n }\n ],\n \"order\": 1\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/order/koinz_order_id/status"},"code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"VALIDATION-ERROR\",\n \"message\": {\n \"name\": [\n \"name is required\"\n ]\n }\n}"},{"id":"a3d160f5-6541-45a3-acb6-ceb0e41df6cd","name":"401 Authorization Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27444\",\n \"name\": \"size\",\n \"localized_name\": \"size\",\n \"is_deleted\": 0,\n \"items_configs\": [\n {\n \"item_pos_id\": \"9f28a1ed-1ed9-4c3f\",\n \"min_options_number\": 1,\n \"max_options_number\": 1\n }\n ],\n \"order\": 1\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/order/koinz_order_id/status"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"AUTHENTICATION-ERROR\",\n \"message\": \"Authorization Token not found in Authorization header\"\n}"},{"id":"2c3a81b7-3290-4303-aa26-6e1546f5ae09","name":"403 General Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27444\",\n \"name\": \"size\",\n \"localized_name\": \"size\",\n \"is_deleted\": 0,\n \"items_configs\": [\n {\n \"item_pos_id\": \"9f28a1ed-1ed9-4c3f\",\n \"min_options_number\": 1,\n \"max_options_number\": 1\n }\n ],\n \"order\": 1\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/order/koinz_order_id/status"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"CATEGORIES_01\",\n \"message\": \"Something went wrong while syncing categories\"\n}"},{"id":"02aa8df0-0da1-4f72-bb03-9318510b4b7b","name":"500 Server Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {access_token}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"pos_id\": \"14f795c3-f808-4031-b2a6-d0e27444\",\n \"name\": \"size\",\n \"localized_name\": \"size\",\n \"is_deleted\": 0,\n \"items_configs\": [\n {\n \"item_pos_id\": \"9f28a1ed-1ed9-4c3f\",\n \"min_options_number\": 1,\n \"max_options_number\": 1\n }\n ],\n \"order\": 1\n }\n]","options":{"raw":{"language":"json"}}},"url":"/api/v1/modifiers-group/sync"},"code":500,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SERVER-FAILURE\",\n \"message\": \"Something wrong happened\"\n}"}],"_postman_id":"fe223c90-95fa-4418-9d0d-70ecefd42e77"}],"id":"b96fa32b-851b-45c9-8b6f-63007f0f1757","_postman_id":"b96fa32b-851b-45c9-8b6f-63007f0f1757","description":""}],"event":[{"listen":"prerequest","script":{"id":"716b23e0-27e3-4d00-86f1-3ab8547896e8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1281d2e0-5a33-4484-aa71-153a7346ca4e","type":"text/javascript","exec":[""]}}]}

Activation and Authentication

Store Activation Details

Authentication Details

Description

Request body parameters

Description

Request Body Parameters

Description:

Response body parameters

Response body parameters

store_branch Object

Request Body Parameters

Request Body Parameters

Description:

Request body parameters

Branch object

Response body parameters

Menu object

Category object

Item object

Modifier group object

Modifiers object

Description:

Request body parameters:

items_configs object

Response body parameters

Branches configs object

Description

Request body parameters

Description

Request body parameters

Authentication

Response

Retry Attempts

Path Parameters

Response body parameters

Order item object

Modifiers object

Response body parameters