{"info":{"_postman_id":"d6eac86f-d30d-44f3-acff-0a15b361c271","name":"Partner Store API","description":"

Requisition

Web hook endpoint for notification
\n
Public ip: for whitelist
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"10912181","collectionId":"d6eac86f-d30d-44f3-acff-0a15b361c271","publishedId":"2s93CEyHcQ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-02-16T07:38:39.000Z"},"item":[{"name":"Auth","item":[{"name":"Request token","event":[{"listen":"prerequest","script":{"id":"b3688894-065b-4eb3-b5e3-6a8edf9a558f","exec":[""],"type":"text/javascript"}},{"listen":"test","script":{"id":"67ac65f0-e11a-4ffc-a0c1-b91bc1e82b18","exec":["pm.environment.set(\"access_token\", pm.response.json().access_token);"],"type":"text/javascript"}}],"id":"7e0fa544-3234-48f5-99ff-4c4b3a7e0b95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\": \"{{store_username}}\",\n \"password\": \"{{store_password}}\",\n \"type\": \"{{store_type}}\"\n} ","options":{"raw":{"language":"json"}}},"url":"{{url}}/oauth/token","description":"

OAuth Token Request

This endpoint allows you to obtain an access token by providing your username, password, and type.

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

Key	Type	Required	Description
username	string	Yes	The username for authentication
password	string	Yes	The password for authentication
type	string	Yes	The type of the store

Response

access_token (string): The access token to be used for authentication
\n
token_type (string): The type of token
\n
expires_in (integer): The duration for which the token is valid. Expire in 1 hour.
\n

\n","urlObject":{"path":["oauth","token"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"b8a9e376-4f4e-41d0-9e69-56abc9654f03","name":"Request token","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\": \"lucky_burger_city_mall\",\n \"password\": \";VhW|EPIxURt?1y:\",\n \"type\": \"merchant\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.1"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.14"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 16 Feb 2023 03:00:39 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL3N0b3JlLWFwaS50ZXN0L29hdXRoL3Rva2VuIiwiaWF0IjoxNjc2NTE2NDM5LCJleHAiOjE2NzY1MjAwMzksIm5iZiI6MTY3NjUxNjQzOSwianRpIjoiWmI0R040S01heGtMdWtRdiIsInN1YiI6IjI1ODEzMzEyODE2MDQwNCIsInBydiI6IjAwY2UwYzVjY2I3MmY1ZGRlODMyMjRkNmQyZWJmMzI0YzRlNTdlZTIiLCJ1c2VybmFtZSI6Imx1Y2t5X2J1cmdlcl9jaXR5X21hbGwiLCJ0eXBlIjoibWVyY2hhbnQiLCJzY29wZSI6WyJwb3MiXSwid2hpdGVsaXN0IjpbIioubmhhbTI0LmNvbSJdLCJpZCI6MjU4MTMzMTI4MTYwNDA0LCJleHRyYSI6W10sImV4cGlyZXNfYXQiOm51bGx9.1f6xWWjwXgVW-EKfveisWEPAWDz6F2Ep7iD-FIoopzY\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600\n}"}],"_postman_id":"7e0fa544-3234-48f5-99ff-4c4b3a7e0b95"}],"id":"98bca3cd-269a-47c7-9e8d-724e86abadaa","_postman_id":"98bca3cd-269a-47c7-9e8d-724e86abadaa","description":""},{"name":"Profile","item":[{"name":"Available","event":[{"listen":"prerequest","script":{"id":"b3688894-065b-4eb3-b5e3-6a8edf9a558f","exec":[""],"type":"text/javascript"}},{"listen":"test","script":{"id":"67ac65f0-e11a-4ffc-a0c1-b91bc1e82b18","exec":[""],"type":"text/javascript"}}],"id":"6d5fc1a4-1a85-48c5-8915-d6dbb6aecb27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/store/available","description":"

This endpoint allows you to manage the availability of a store.

Example : Set status to false if store is busy and store don't want customers to place new orders;

Request Body

status (boolean) :

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

Parameter	Type	Description
status	boolean	true = availabe, false = not available

Response

message (string) : A message indicating the status of the request.

\n","urlObject":{"path":["api","v1","store","available"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"851181b0-eed9-498a-9bac-1ab5ac20e1b1","name":"Available","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/store/available"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.1"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.14"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 16 Feb 2023 03:39:37 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\"\n}"}],"_postman_id":"6d5fc1a4-1a85-48c5-8915-d6dbb6aecb27"}],"id":"c3494a02-4b85-4ad8-8db7-d046b67b6ffe","_postman_id":"c3494a02-4b85-4ad8-8db7-d046b67b6ffe","description":""},{"name":"Category","item":[{"name":"List","event":[{"listen":"prerequest","script":{"id":"24b1b6a7-5c4a-4355-982e-7cf721f7d3ef","exec":[""],"type":"text/javascript"}}],"id":"6a5fbd28-fa85-4191-9024-04009b25edd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/category/list","description":"\n

This API endpoint makes an HTTP GET request to retrieve a list of categories.

Request

Method: GET
\n
Endpoint: {{url}}/api/v1/category/list
\n

Response

The response for this request is a JSON object with a data array containing category information. Each category object in the array includes the following properties:

ref_id (string): The reference ID of the category.
\n
name_en (string): The name of the category in English.
\n
name_km (string): The name of the category in Khmer.
\n
name_zh (string): The name of the category in Chinese.
\n
desc_en (string): The description of the category in English.
\n
desc_km (string): The description of the category in Khmer.
\n
desc_zh (string): The description of the category in Chinese.
\n
sequence (number): The number ordering of the category.
\n
status (string): The status of the category.
\n
created_at (string): The timestamp of when the category was created.
\n

\n","urlObject":{"path":["api","v1","category","list"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"9728723a-fda0-4565-abb2-8eb5eeb95561","name":"List","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/category/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.1"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.14"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 16 Feb 2023 03:03:50 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"ref_id\": \"6ce25f68-f2f0-4f88-b517-505c452f727b\",\n \"name_en\": \"dota\",\n \"name_km\": \"Frozen\",\n \"name_zh\": \"刀塔\",\n \"desc_en\": \"----\",\n \"desc_km\": \"----\",\n \"desc_zh\": \"----\",\n \"sequence\": 1,\n \"status\": \"Active\",\n \"created_at\": \"2023-02-07 21:42:17\"\n },\n {\n \"ref_id\": \"5f733d02-8f22-4414-8d53-ae2f69e6a701\",\n \"name_en\": \"Fresh\",\n \"name_km\": \"Fresh\",\n \"name_zh\": \"Fresh\",\n \"desc_en\": \"\",\n \"desc_km\": \"\",\n \"desc_zh\": \"\",\n \"sequence\": 1,\n \"status\": \"Active\",\n \"created_at\": \"2023-02-15 10:14:06\"\n },\n {\n \"ref_id\": \"00138df6-6c57-4c39-a3f7-c0ff77ef466f\",\n \"name_en\": \"Wooden\",\n \"name_km\": \"Wooden\",\n \"name_zh\": \"Wooden\",\n \"desc_en\": \"non-volatile\",\n \"desc_km\": \"\",\n \"desc_zh\": \"\",\n \"sequence\": 1,\n \"status\": \"Active\",\n \"created_at\": \"2023-02-15 10:36:26\"\n }\n ]\n}"}],"_postman_id":"6a5fbd28-fa85-4191-9024-04009b25edd7"},{"name":"Create","event":[{"listen":"prerequest","script":{"id":"24b1b6a7-5c4a-4355-982e-7cf721f7d3ef","exec":[""],"type":"text/javascript","packages":{}}}],"id":"c73cd60c-41f3-4689-ace9-1ba16243b0ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ref_id\": \"1234\",\n \"name_en\": \"Soft\",\n \"name_zh\": \"\",\n \"name_kh\": \"\",\n \"desc_en\": \"logistical\",\n \"desc_zh\": \"\",\n \"desc_kh\": \"\",\n \"sequence\": \"1\", \n \"status\":\"active\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/category/create","description":"

Create Category

The Create Category endpoint allows you to add a new category with the specified details.

Request Body

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

Key	Type	Required	Description
ref_id	string	Yes	The reference ID for the category.
name_en	string	Yes	The English name of the category.
name_zh	string	No	The Chinese name of the category.
name_kh	string	No	The Khmer name of the category.
desc_en	string	No	The English description of the category.
desc_zh	string	No	The Chinese description of the category.
desc_kh	string	No	The Khmer description of the category.
sequence	string	Yes	The number ordering of the category.
status	string	Yes	The status of the category (e.g. \"active\").

Response

message (string): A message indicating the status of the request.

\n","urlObject":{"path":["api","v1","category","create"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"4ef93648-9c60-4b28-9423-b41eb8cb8ec2","name":"Create","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ref_id\": \"0993f149-24f3-49d8-a634-b8b66c82f02f\",\n \"name_en\": \"Fresh\",\n \"name_zh\": \"\",\n \"name_kh\": \"\",\n \"desc_en\": \"bandwidth-monitored\",\n \"desc_zh\": \"\",\n \"desc_kh\": \"\",\n \"sequence\": \"1\", \n \"status\":\"active\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/category/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.1"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.14"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 16 Feb 2023 03:03:55 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\"\n}"}],"_postman_id":"c73cd60c-41f3-4689-ace9-1ba16243b0ce"},{"name":"Update","event":[{"listen":"prerequest","script":{"id":"24b1b6a7-5c4a-4355-982e-7cf721f7d3ef","exec":[""],"type":"text/javascript","packages":{}}}],"id":"6ed30432-557c-4e92-8b38-82ca157f0e94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ref_id\": \"1234\",\n \"name_en\": \"frozen\",\n \"name_kh\": \"កក\",\n \"name_zh\": \"冻结的\",\n \"desc_en\": \"----\",\n \"desc_zh\": \"----\",\n \"desc_kh\": \"----\",\n \"sequence\": 12,\n \"status\": \"active\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/category/update","description":"

Update Category

This endpoint allows updating a category with the provided details.

Request Body

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

Key	Type	Required	Description
ref_id	text	Yes	The reference ID of the category.
name_en	text	Yes	The English name of the category.
name_kh	text	No	The Khmer name of the category.
name_zh	text	No	The Chinese name of the category.
desc_en	text	No	The English description of the category.
desc_kh	text	No	The Khmer description of the category.
desc_zh	text	No	The Chinese description of the category.
sequence	text	Yes	The sequence of the category.
status	text	Yes	The status of the category (e.g. active, inactive).

","urlObject":{"path":["api","v1","category","update"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"001924a3-9847-4094-b379-5400f1493b6d","name":"Update","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ref_id\": \"6ce25f68-f2f0-4f88-b517-505c452f727b\",\n \"name_en\": \"frozen\",\n \"name_km\": \"កក\",\n \"name_zh\": \"冻结的\",\n \"desc_en\": \"----\",\n \"desc_zh\": \"----\",\n \"desc_kh\": \"----\",\n \"sequence\": 12,\n \"status\": \"active\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/category/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.1"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.14"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 16 Feb 2023 03:08:49 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\"\n}"}],"_postman_id":"6ed30432-557c-4e92-8b38-82ca157f0e94"},{"name":"Status","event":[{"listen":"prerequest","script":{"id":"24b1b6a7-5c4a-4355-982e-7cf721f7d3ef","exec":[""],"type":"text/javascript"}}],"id":"6e41eb8a-36fa-42eb-ab91-d7dc034fdc33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ref_id\": \"6ce25f68-f2f0-4f88-b517-505c452f727b\",\n \"status\": \"active\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/category/status","description":"

API Request Description

This endpoint allows you to update the status of a category.

Request Body

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

Key	Type	Required	Description
ref_id	string	Yes	The reference ID of the category.
status	string	Yes	The new status to be assigned.

","urlObject":{"path":["api","v1","category","status"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3c44280c-b457-4a40-98d2-ba4e72fd1e83","name":"Status","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ref_id\": \"6ce25f68-f2f0-4f88-b517-505c452f727b\",\n \"status\": \"active\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/category/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.1"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.14"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 16 Feb 2023 03:10:25 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\"\n}"}],"_postman_id":"6e41eb8a-36fa-42eb-ab91-d7dc034fdc33"},{"name":"Delete","event":[{"listen":"prerequest","script":{"id":"24b1b6a7-5c4a-4355-982e-7cf721f7d3ef","exec":[""],"type":"text/javascript","packages":{}}}],"id":"a97a6fdd-ef1d-4437-b07a-01c94e290fbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/category/delete/{{ref_id}}","description":"

Delete Category

This endpoint is used to delete a specific category.

Response

message: A message indicating the result of the delete operation.

\n","urlObject":{"path":["api","v1","category","delete","{{ref_id}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"6b9a7531-6daf-4efa-a4bf-62cd1cba40c1","name":"Delete","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/category/delete/03e78eec-103a-4e52-a5c2-e149f86cb9c5"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.1"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.14"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 16 Feb 2023 03:13:13 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\"\n}"}],"_postman_id":"a97a6fdd-ef1d-4437-b07a-01c94e290fbf"}],"id":"2b0c741a-7428-4878-8b08-e6e22442480b","_postman_id":"2b0c741a-7428-4878-8b08-e6e22442480b","description":""},{"name":"Item","item":[{"name":"List","event":[{"listen":"prerequest","script":{"id":"24b1b6a7-5c4a-4355-982e-7cf721f7d3ef","exec":[""],"type":"text/javascript"}}],"id":"4f7cfc32-2cfa-476a-b8af-cd612e2a2beb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/item/list","description":"

Retrieve Item List

This endpoint makes an HTTP GET request to retrieve a list of items.

Request

Endpoint: {{url}}/api/v1/item/list
\n
Method: GET
\n

Response

The response will contain an array of items, where each item object includes the following properties:

ref_id (string): The reference ID of the item.
\n
name_en (string): The name of the item in English.
\n
desc_en (string): The description of the item in English.
\n
price (number): The price of the item.
\n
status (string): The status of the item.
\n
barcode (string): The barcode of the item.
\n
recommended (boolean): Indicates if the item is recommended to customer.
\n
image (string): The URL of the item's image.
\n
created_at (string): The timestamp of when the item was created.
\n

\n","urlObject":{"path":["api","v1","item","list"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"c87db7ad-f914-4375-b4dc-346c063462a0","name":"List","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/item/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.1"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.14"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 16 Feb 2023 03:14:27 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"ref_id\": \"0a20df49-ecf7-4113-8877-9fc624bfc4e2\",\n \"name_en\": \"Soft\",\n \"desc_en\": \"\",\n \"price\": 11,\n \"status\": \"active\",\n \"barcode\": \"\",\n \"recommended\": false,\n \"image\": \"https://static.go24.app/upload/default/default_image.png\",\n \"created_at\": \"2023-02-08 10:26:07\"\n },\n {\n \"ref_id\": \"9990afdb-7798-4979-9b3c-c891a14971e9\",\n \"name_en\": \"Frozen\",\n \"desc_en\": \"\",\n \"price\": 11,\n \"status\": \"active\",\n \"barcode\": null,\n \"recommended\": false,\n \"image\": \"http://192.168.31.55:9900/testing/upload/MenuItem/0230208103052703121.png\",\n \"created_at\": \"2023-02-08 10:30:52\"\n },\n {\n \"ref_id\": \"19629905-b4bd-48b5-b7e1-fe01c879daa6\",\n \"name_en\": \"Concrete\",\n \"desc_en\": \"\",\n \"price\": 11,\n \"status\": \"active\",\n \"barcode\": \"\",\n \"recommended\": false,\n \"image\": \"http://192.168.31.55:9900/testing/upload/MenuItem/0230210104607703122.png\",\n \"created_at\": \"2023-02-10 10:46:07\"\n },\n {\n \"ref_id\": \"d4d37d91-69ed-4812-9240-243d48767f99\",\n \"name_en\": \"Soft\",\n \"desc_en\": \"\",\n \"price\": 11,\n \"status\": \"active\",\n \"barcode\": null,\n \"recommended\": false,\n \"image\": \"http://192.168.31.55:9900/testing/upload/MenuItem/0230210104901703123.png\",\n \"created_at\": \"2023-02-10 10:49:01\"\n },\n {\n \"ref_id\": \"12bf3565-8fc9-43ae-89ca-f46c7462b852\",\n \"name_en\": \"Fresh\",\n \"desc_en\": \"\",\n \"price\": 11,\n \"status\": \"active\",\n \"barcode\": null,\n \"recommended\": false,\n \"image\": \"http://192.168.31.55:9900/testing/upload/MenuItem/0230216094351703124.png\",\n \"created_at\": \"2023-02-16 09:43:51\"\n }\n ]\n}"}],"_postman_id":"4f7cfc32-2cfa-476a-b8af-cd612e2a2beb"},{"name":"Create","event":[{"listen":"prerequest","script":{"id":"24b1b6a7-5c4a-4355-982e-7cf721f7d3ef","exec":[""],"type":"text/javascript","packages":{}}}],"id":"b5a7a426-1c47-4bb3-8344-91f545cba1ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"ref_id\": \"570\",\n \"ref_cat_id\": \"9cef76c7-cf9b-4f82-b2f1-5326219d9268\",\n \"name_en\": \"Fantastic Frozen Bike\",\n \"name_km\": \"\",\n \"name_zh\": \"\",\n \"desc_en\": \"\",\n \"desc_km\": \"\",\n \"desc_zh\": \"\",\n \"barcode\": \"\",\n \"sku\" : \"\",\n \"status\": \"active\",\n \"enable_stock\" : false,\n \"stock_balance\" : 21,\n \"image\": \"http://placeimg.com/640/480\",\n \"recommended\": false,\n \"option_prices\": [\n {\n \"ref_id\": \"753\",\n \"name\": \"mobile\",\n \"price\": 3.1,\n \"status\": \"active\",\n \"discount_value\": 50,\n \"discount_type\": \"percentage\",\n \"default\": true\n }\n ],\n \"modifier_group\": [\n {\n \"name\": \"Architect\",\n \"type\": \"single\",\n \"required\": false,\n \"modifiers\": [\n {\n \"ref_id\": \"247\",\n \"name\": \"Metal\",\n \"price\": 0.0,\n \"status\": \"active\",\n \"display_order\":1\n },\n {\n \"ref_id\": \"119\",\n \"name\": \"XSS\",\n \"price\": 0.0,\n \"status\": \"active\",\n \"display_order\":1\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/item/create","description":"

Create Item

The Create item endpoint allows you to add a new item with the specified details.

Request Body

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

Key	Type	Required	Description
ref_id	string	Yes	The reference ID of the item.
ref_cat_id	string	Yes	The reference category ID of the item.
name_en	string	Yes	The name of the item in English.
name_km	string	No	The name of the item in Khmer.
name_zh	string	No	The name of the item in Chinese.
desc_en	string	No	The description of the item in English.
desc_km	string	No	The description of the item in Khmer.
desc_zh	string	No	The description of the item in Chinese.
barcode	string	No	The barcode of the item.
sku	string	No	The stock keeping unit of the item.
status	string	Yes	The status of the item (e.g., active).
enable_stock	boolean	No	Indicates if the stock is enabled for the item.
stock_balance	number	No	The stock balance of the item.
image	string	No	The URL of the item's image.
recommended	boolean	No	Indicates if the item is recommended.
option_prices	array	Yes	An array of option prices including reference ID, name, price, status, discount value, discount type, and default status.
modifier_group	array	No	An array of modifier group details including name, type, required status, and an array of modifiers with reference ID, name, price, status, and display order.

Key: option_prices

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

Key	Type	Required	Description
ref_id	string	Yes	The reference ID of the item price.
name	string	Yes	The name of the item price.
price	number	Yes	The amount of the item price.
status	string	Yes	The status of the item price (e.g., active).
discount_value	number	No	The discount amount of the item price.
discount_type	string	No	The discount type of the item price (e.g., percentage, flat).
default	boolean	Yes	Indicates if the item price default selected for customer.

Key: modifier_group

This payload is required only when key modifier_group is present.

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

Key	Type	Required	Description
name	string	Yes	The name of item modifier group
type	string	Yes	The type of item modifier group (e.g., single, multiple)
required	boolean	Yes (when type = single)	Indicates if the item type = single and modifier group is require customer to select.
min	number	Yes (when type = multiple)	Minimum modifier that customer can select..
max	number	Yes (when type = multiple)	Maximum modifier that customer can select.
modifiers.ref_id	string	Yes	The reference ID of the modifier.
modifiers.name	string	Yes	The name of the modifier.
modifiers.price	number	Yes	The price of the modifier.
modifiers.status	string	Yes	The status of the modifier. (e.g., active).
modifiers.display_order	number	Yes	The ordering of the modifier.

","urlObject":{"path":["api","v1","item","create"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"c547f635-93fe-4142-acda-eb53863a6d53","name":"create","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"ref_id\": \"586\",\n \"ref_cat_id\": \"9cef76c7-cf9b-4f82-b2f1-5326219d9268\",\n \"name_en\": \"Ergonomic Metal Chair\",\n \"name_km\": \"\",\n \"name_zh\": \"\",\n \"desc_en\": \"\",\n \"desc_km\": \"\",\n \"desc_zh\": \"\",\n \"barcode\": \"\",\n \"sku\" : \"\",\n \"status\": \"active\",\n \"enable_stock\" : false,\n \"stock_balance\" : 21,\n \"image\": \"http://placeimg.com/640/480\",\n \"recommended\": false,\n \"discount_period\":{\n \"type\":\"day\",\n \"days\":{\n \"monday\":true,\n \"tuesday\":true,\n \"wednesday\":true,\n \"thursday\":true,\n \"friday\":true,\n \"saturday\":true,\n \"sunday\":true \n }\n },\n \"option_prices\": [\n {\n \"ref_id\": \"669\",\n \"name\": \"Avon\",\n \"price\": 3.1,\n \"status\": \"active\",\n \"discount_value\": 50,\n \"discount_type\": \"percentage\",\n \"default\": true\n }\n ],\n \"modifier_group\": [\n {\n \"name\": \"middleware\",\n \"type\": \"single\",\n \"required\": false,\n \"modifiers\": [\n {\n \"ref_id\": \"62\",\n \"name\": \"analyzer\",\n \"price\": 0.0,\n \"status\": \"active\",\n \"display_order\":1\n },\n {\n \"ref_id\": \"362\",\n \"name\": \"card\",\n \"price\": 0.0,\n \"status\": \"active\",\n \"display_order\":1\n }\n ]\n },\n {\n \"name\": \"Austria\",\n \"type\": \"multiple\",\n \"min\": 0,\n \"max\": 1,\n \"modifiers\": [\n {\n \"ref_id\": \"275\",\n \"name\": \"Global\",\n \"price\": 0.0,\n \"status\": \"active\",\n \"display_order\":1\n },\n {\n \"ref_id\": \"785\",\n \"name\": \"Kentucky\",\n \"price\": 0.0,\n \"status\": \"active\",\n \"display_order\":1\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/item/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 03 Dec 2024 06:45:47 GMT"},{"key":"x-amzn-Remapped-date","value":"Tue, 03 Dec 2024 06:45:47 GMT"},{"key":"x-amzn-RequestId","value":"83ceee4c-1db6-4580-8d40-444848039ca3"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-ratelimit-remaining","value":"58"},{"key":"cache-control","value":"no-cache, private"},{"key":"x-ratelimit-limit","value":"60"},{"key":"X-Amzn-Trace-Id","value":"Root=1-674ea91b-6bb174bb2dcc37825cae8b39;Parent=02fe65dd56ff8f2a;Sampled=0;Lineage=1:fd787ec4:0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 3440b79c112e9514e3e6f25a7439db3c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"TLV50-C2"},{"key":"X-Amz-Cf-Id","value":"_F4Hh6tAbmOKoN4fQ9mnviZE8NUfgOXOjkpU_bgArSdrjRwBDb3LmQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\"\n}"}],"_postman_id":"b5a7a426-1c47-4bb3-8344-91f545cba1ae"},{"name":"Bulk Create/update","event":[{"listen":"prerequest","script":{"id":"24b1b6a7-5c4a-4355-982e-7cf721f7d3ef","exec":[""],"type":"text/javascript","packages":{}}}],"id":"dba5e453-e4f6-4924-8df0-c28e9cab0243","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"ref_id\": \"d4c65b1f-2608-41b5-a500-8dd21614d2b8\",\n \"name_en\": \"Metal\",\n \"name_zh\": \"\",\n \"name_kh\": \"\",\n \"desc_en\": \"even-keeled\",\n \"desc_zh\": \"\",\n \"desc_kh\": \"\",\n \"sequence\": \"1\",\n \"status\": \"active\",\n \"items\": [\n {\n \"ref_id\": \"05ff3837-951e-491c-8a56-4a0e7a33dbcf\",\n \"name_en\": \"Concrete\",\n \"name_km\": \"\",\n \"name_zh\": \"\",\n \"desc_en\": \"\",\n \"desc_km\": \"\",\n \"desc_zh\": \"\",\n \"barcode\": \"\",\n \"sku\" : \"\",\n \"enable_stock\" : false,\n \"stock_balance\" : 0,\n \"status\": \"active\",\n \"image\": \"https://random.imagecdn.app/150/150\",\n \"recommended\": false,\n \"option_prices\": [\n {\n \"ref_id\": \"ddc588bc-5924-466a-af66-13a4176d15d2\",\n \"name\": \"small\",\n \"price\": \"11\",\n \"discount_value\": 50,\n \"discount_type\": \"percentage\",\n \"status\": \"active\",\n \"default\": true\n }\n ],\n \"modifier_group\": [\n {\n \"name\": \"ice\",\n \"type\": \"single\",\n \"required\": false,\n \"modifiers\": [\n {\n \"ref_id\": \"8ac67fcd-6b69-4739-8332-ebf417a8401a\",\n \"name\": \"no ice\",\n \"price\": \"0\",\n \"status\": \"active\"\n },\n {\n \"ref_id\": \"ac80bf8b-1fe0-49e5-be8d-b527a8b7c33c\",\n \"name\": \"less ice\",\n \"price\": \"0\",\n \"status\": \"active\"\n }\n ]\n }\n ]\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/item/bulk/update","description":"

Bulk Create/Update Item

This endpoint allows you to create or update multiple items in bulk.
\n
This is a background process, so there will not be an immediate response.
\n
To receive the item status, please check Partner Push Notification on Bulk item notification.
\n

Request Body

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

Key	Type	Required	Description
ref_id	string	Yes	The reference ID for the category.
name_en	string	Yes	Name of the category in English.
name_zh	string	No	Name of the category in Chinese.
name_kh	string	No	Name of the category in Khmer.
desc_en	string	Yes	Description of the category in English.
desc_zh	string	No	Description of the category in Chinese.
desc_kh	string	No	Description of the category in Khmer.
sequence	string	Yes	The number ordering of the category.
status	string	Yes	The status of the category (e.g. \"active\").
items	array	Yes	Array of items. futher detail pleae check on below.

Key: items

Key	Type	Required	Description
ref_id	string	Yes	The reference ID of the item.
name_en	string	Yes	The name of the item in English.
name_km	string	No	The name of the item in Khmer.
name_zh	string	No	The name of the item in Chinese.
desc_en	string	No	The description of the item in English.
desc_km	string	No	The description of the item in Khmer.
desc_zh	string	No	The description of the item in Chinese.
barcode	string	No	The barcode of the item.
sku	string	No	The stock keeping unit of the item.
status	string	Yes	The status of the item (e.g., active).
enable_stock	boolean	No	Indicates if the stock is enabled for the item.
stock_balance	number	No	The stock balance of the item.
image	string	No	The URL of the item's image.
recommended	boolean	No	Indicates if the item is recommended.
option_prices	array	Yes	An array of option prices including reference ID, name, price, status, discount value, discount type, and default status.
modifier_group	array	No	An array of modifier group details including name, type, required status, and an array of modifiers with reference ID, name, price, status, and display order.

Key: option_prices

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

Key	Type	Required	Description
ref_id	string	Yes	The reference ID of the item price.
name	string	Yes	The name of the item price.
price	number	Yes	The amount of the item price.
status	string	Yes	The status of the item price (e.g., active).
discount_value	number	No	The discount amount of the item price.
discount_type	string	No	The discount type of the item price (e.g., percentage, flat).
default	boolean	Yes	Indicates if the item price default selected for customer.

Key: modifier_group

This payload is required only when key modifier_group is present.

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

Key	Type	Required	Description
name	string	Yes	The name of item modifier group
type	string	Yes	The type of item modifier group (e.g., single, multiple)
required	boolean	Yes	Indicates if the item modifier group is require customer to select.
modifiers.ref_id	string	Yes	The reference ID of the modifier.
modifiers.name	string	Yes	The name of the modifier.
modifiers.price	number	Yes	The price of the modifier.
modifiers.status	string	Yes	The status of the modifier. (e.g., active).
modifiers.display_order	number	Yes	The ordering of the modifier.

Response

The response will contain a status code and a message indicating the result of the bulk update operation.

\n","urlObject":{"path":["api","v1","item","bulk","update"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"7ad15880-0263-4f9d-be6d-306a84b6d540","name":"Bulk Create/update success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"ref_id\": \"4dfeb64f-2832-4d85-a557-ccad111649ef\",\n \"name_en\": \"Rubber\",\n \"name_zh\": \"\",\n \"name_kh\": \"\",\n \"desc_en\": \"secondary\",\n \"desc_zh\": \"\",\n \"desc_kh\": \"\",\n \"sequence\": \"1\",\n \"status\": \"active\",\n \"items\": [\n {\n \"ref_id\": \"68f0dffd-2eb3-4ab6-913e-8221de9d5841\",\n \"name_en\": \"Concrete\",\n \"name_km\": \"\",\n \"name_zh\": \"\",\n \"desc_en\": \"\",\n \"desc_km\": \"\",\n \"desc_zh\": \"\",\n \"barcode\": \"\",\n \"sku\" : \"\",\n \"enable_stock\" : false,\n \"stock_balance\" : 0,\n \"status\": \"active\",\n \"image\": \"https://random.imagecdn.app/150/150\",\n \"recommended\": false,\n \"option_prices\": [\n {\n \"ref_id\": \"15385c3a-f48e-42a3-8950-85bef601a00b\",\n \"name\": \"small\",\n \"price\": \"11\",\n \"discount_value\": 50,\n \"discount_type\": \"percentage\",\n \"status\": \"active\",\n \"default\": true\n }\n ],\n \"modifier_group\": [\n {\n \"name\": \"ice\",\n \"type\": \"single\",\n \"required\": false,\n \"modifiers\": [\n {\n \"ref_id\": \"d19bc2ec-22f6-4e21-bc6e-d45d8c901f2e\",\n \"name\": \"no ice\",\n \"price\": \"0\",\n \"status\": \"active\"\n },\n {\n \"ref_id\": \"ac98444d-161b-469e-9c95-462f7345eb22\",\n \"name\": \"less ice\",\n \"price\": \"0\",\n \"status\": \"active\"\n }\n ]\n }\n ]\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/item/bulk/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 03 Dec 2024 11:11:45 GMT"},{"key":"x-amzn-Remapped-date","value":"Tue, 03 Dec 2024 11:11:45 GMT"},{"key":"x-amzn-RequestId","value":"6bf6c6dd-c2c4-40c3-ace6-760ff2acd328"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-ratelimit-remaining","value":"59"},{"key":"cache-control","value":"no-cache, private"},{"key":"x-ratelimit-limit","value":"60"},{"key":"X-Amzn-Trace-Id","value":"Root=1-674ee771-23423d1c13471d643ccc200b;Parent=4528956a2aeff2fe;Sampled=0;Lineage=1:fd787ec4:0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 cc308cac72966d971a24d7b2a41ddf70.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"TLV50-C2"},{"key":"X-Amz-Cf-Id","value":"WkoACZJTZA-hCKnLbWEsL7rscgVPyYJQzBbz8ByS3vXRay2ATENpMA=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\"\n}"},{"id":"225c27c4-e5f0-411b-b10b-c5cc60af7386","name":"Bulk Create/update failed validation","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"ref_id\": \"f59b99a5-4458-4b42-899a-44cf727a6b03\",\n \"name_en\": \"Soft\",\n \"name_zh\": \"\",\n \"name_kh\": \"\",\n \"desc_en\": \"coherent\",\n \"desc_zh\": \"\",\n \"desc_kh\": \"\",\n \"sequence\": \"1\",\n \"status\": \"active\",\n \"items\": [\n {\n \"ref_id\": \"f9a45b52-f3ca-4485-9795-4af115ba059c\",\n \"name_en\": \"\",\n \"name_km\": \"\",\n \"name_zh\": \"\",\n \"desc_en\": \"\",\n \"desc_km\": \"\",\n \"desc_zh\": \"\",\n \"barcode\": \"\",\n \"sku\" : \"\",\n \"enable_stock\" : false,\n \"stock_balance\" : 0,\n \"status\": \"active\",\n \"image\": \"https://random.imagecdn.app/150/150\",\n \"recommended\": false,\n \"option_prices\": [\n {\n \"ref_id\": \"1cfdc326-d943-40a8-a3d4-bf91dede3fd0\",\n \"name\": \"small\",\n \"price\": \"11\",\n \"discount_value\": 50,\n \"discount_type\": \"percentage\",\n \"status\": \"active\",\n \"default\": true\n }\n ],\n \"modifier_group\": [\n {\n \"name\": \"ice\",\n \"type\": \"single\",\n \"required\": false,\n \"modifiers\": [\n {\n \"ref_id\": \"fdb3a2d0-5880-44f1-ada5-c670d9dc1a0c\",\n \"name\": \"no ice\",\n \"price\": \"0\",\n \"status\": \"active\"\n },\n {\n \"ref_id\": \"469fef8e-b2d5-455d-a6db-324eee02f29d\",\n \"name\": \"less ice\",\n \"price\": \"0\",\n \"status\": \"active\"\n }\n ]\n }\n ]\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/item/bulk/update"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"77"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 03 Dec 2024 11:12:31 GMT"},{"key":"x-amzn-Remapped-date","value":"Tue, 03 Dec 2024 11:12:31 GMT"},{"key":"x-amzn-RequestId","value":"0c477352-2783-46ed-9a57-4040025134a5"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-ratelimit-remaining","value":"58"},{"key":"cache-control","value":"no-cache, private"},{"key":"x-ratelimit-limit","value":"60"},{"key":"X-Amzn-Trace-Id","value":"Root=1-674ee79f-04866d60578596064d6b4ef0;Parent=4336bbc2a29baf12;Sampled=0;Lineage=1:fd787ec4:0"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 cc308cac72966d971a24d7b2a41ddf70.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"TLV50-C2"},{"key":"X-Amz-Cf-Id","value":"OTgBfbmNNn63T2kTA23K3cM9KBliySiaRsECvk48fv4Hl12HwO7JUg=="}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": {\n \"0.items.0.name_en\": [\n \"The 0.items.0.name_en field is required.\"\n ]\n }\n}"}],"_postman_id":"dba5e453-e4f6-4924-8df0-c28e9cab0243"},{"name":"Detail","event":[{"listen":"prerequest","script":{"id":"24b1b6a7-5c4a-4355-982e-7cf721f7d3ef","exec":[""],"type":"text/javascript","packages":{}}}],"id":"d6ca2409-61f8-4875-8326-df97e6257209","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/item/detail/3CB3000014","description":"

GET /api/v1/item/detail/{id}

This endpoint retrieves the details of a specific item.

Request

No request body.

Response

The response for this request is a JSON object with the following schema:

{\n  \"data\": {\n    \"ref_id\": \"\",\n    \"name_en\": \"\",\n    \"name_km\": \"\",\n    \"name_zh\": \"\",\n    \"desc_en\": \"\",\n    \"desc_km\": \"\",\n    \"desc_zh\": \"\",\n    \"status\": \"\",\n    \"barcode\": \"\",\n    \"recommended\": true,\n    \"image\": \"\",\n    \"created_at\": \"\",\n    \"category\": {\n      \"ref_id\": \"\",\n      \"name_en\": \"\",\n      \"name_km\": \"\",\n      \"name_zh\": \"\",\n      \"desc_en\": \"\",\n      \"desc_km\": \"\",\n      \"desc_zh\": \"\",\n      \"sequence\": 0,\n      \"status\": \"\",\n      \"created_at\": \"\"\n    },\n    \"option_prices\": [\n      {\n        \"ref_id\": \"\",\n        \"name\": \"\",\n        \"price\": \"\",\n        \"status\": \"\",\n        \"default\": true\n      }\n    ],\n    \"modifier_group\": [\n      {\n        \"name\": \"\",\n        \"type\": \"\",\n        \"required\": true,\n        \"modifiers\": [\n          {\n            \"ref_id\": \"\",\n            \"name\": \"\",\n            \"price\": \"\",\n            \"status\": \"\"\n          }\n        ]\n      }\n    ]\n  }\n}\n\n

\n","urlObject":{"path":["api","v1","item","detail","3CB3000014"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"d8e52342-911a-4a42-bc72-83666d9dc290","name":"Detail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/item/detail/3CB3000014"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 03 Dec 2024 15:05:03 GMT"},{"key":"x-amzn-RequestId","value":"efeb882f-0478-4321-80fb-f226d4cd2928"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-ratelimit-remaining","value":"58"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"x-ratelimit-limit","value":"60"},{"key":"X-Amzn-Trace-Id","value":"Root=1-674f1e1f-6e5b810159016f2716fb78a4;Parent=4d986680bcf3bd73;Sampled=0;Lineage=1:fd787ec4:0"},{"key":"x-amzn-Remapped-date","value":"Tue, 03 Dec 2024 15:05:03 GMT"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 844958a6c6c19e59b7fbdd2ad9cef208.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"TLV50-C2"},{"key":"X-Amz-Cf-Id","value":"Vr9asPIPOTJgjVBoEaNS0NwrnZueoEYhOWx1pA_G7NCJoQ-gAyb0Xw=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"ref_id\": \"3CB3000014\",\n \"name_en\": \"Vanilla Cream Frappuccino (Grande)x Oregano Sausage Roll\",\n \"name_km\": \"Vanilla Cream Frappuccino (Grande)x Oregano Sausage Roll\",\n \"name_zh\": \"Vanilla Cream Frappuccino (Grande)x Oregano Sausage Roll\",\n \"desc_en\": \"\",\n \"desc_km\": \"\",\n \"desc_zh\": \"\",\n \"status\": \"Active\",\n \"barcode\": null,\n \"recommended\": false,\n \"enable_stock\": false,\n \"stock_balance\": null,\n \"image\": \"https://gajo86lcmi.execute-api.ap-southeast-1.amazonaws.com/dev/media/upload/MenuItem/0231228040146711331.png\",\n \"created_at\": \"2023-08-26 04:02:07\",\n \"category\": {\n \"ref_id\": \"00000072\",\n \"name_en\": \"15% OFF Combo Set\",\n \"name_km\": \"15% OFF Combo Set\",\n \"name_zh\": \"15% OFF Combo Set\",\n \"desc_en\": \"15% OFF Combo Set\",\n \"desc_km\": \"\",\n \"desc_zh\": \"\",\n \"sequence\": 6838,\n \"status\": \"Active\",\n \"created_at\": \"2023-04-11 13:51:55\"\n },\n \"option_prices\": [\n {\n \"ref_id\": \"3CB3000014\",\n \"name\": \"Vanilla Cream Frappuccino (Grande)x Oregano Sausage Roll\",\n \"price\": \"6.85\",\n \"status\": \"active\",\n \"default\": true,\n \"discount_value\": \"0.00\",\n \"discount_type\": \"Percentage\"\n }\n ],\n \"modifier_group\": [\n {\n \"name\": \"Choice of Drinks\",\n \"type\": \"single\",\n \"required\": true,\n \"modifiers\": [\n {\n \"ref_id\": \"5613000014\",\n \"name\": \"g: Frap Vanilla Cream\",\n \"price\": \"0\",\n \"status\": \"active\"\n }\n ]\n },\n {\n \"name\": \"Choice of Food\",\n \"type\": \"single\",\n \"required\": true,\n \"modifiers\": [\n {\n \"ref_id\": \"5612003023\",\n \"name\": \"Oregano Sausage Roll\",\n \"price\": \"0\",\n \"status\": \"active\"\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"d6ca2409-61f8-4875-8326-df97e6257209"},{"name":"Update","event":[{"listen":"prerequest","script":{"id":"24b1b6a7-5c4a-4355-982e-7cf721f7d3ef","exec":[""],"type":"text/javascript","packages":{}}}],"id":"a0d141c3-58c4-429d-98e6-c4239321d37e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ref_cat_id\": \"00000072\",\n \"name_en\": \"Fantastic Cotton Towels\",\n \"name_km\": \"\",\n \"name_zh\": \"\",\n \"desc_en\": \"\",\n \"desc_km\": \"\",\n \"desc_zh\": \"\",\n \"barcode\": \"\",\n \"sku\" : \"\",\n \"status\": \"active\",\n \"enable_stock\" : false,\n \"stock_balance\" : 0,\n \"image\": \"http://placeimg.com/640/480\",\n \"recommended\": true,\n \"option_prices\": [\n {\n \"ref_id\": \"822\",\n \"name\": \"empower\",\n \"price\": 3.1,\n \"status\": \"active\",\n \"discount_value\": 50,\n \"discount_type\": \"percentage\",\n \"default\": true\n }\n ],\n \"modifier_group\": [\n {\n \"name\": \"holistic\",\n \"type\": \"single\",\n \"required\": false,\n \"modifiers\": [\n {\n \"ref_id\": \"654\",\n \"name\": \"France\",\n \"price\": 0.0,\n \"status\": \"active\",\n \"display_order\":1\n },\n {\n \"ref_id\": \"156\",\n \"name\": \"strategic\",\n \"price\": 0.0,\n \"status\": \"active\",\n \"display_order\":1\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/item/update/3CB3000014","description":"

Update Item

This endpoint allows the client to update an item with the specified ID.

Request Body

Key	Type	Required	Description
ref_cat_id	text	Yes	Reference category ID
name_en	text	Yes	Name in English
name_km	text	No	Name in Khmer
name_zh	text	No	Name in Chinese
desc_en	text	No	Description in English
desc_km	text	No	Description in Khmer
desc_zh	text	No	Description in Chinese
barcode	text	No	Barcode
sku	text	No	Stock Keeping Unit
status	text	Yes	Status (e.g. active)
enable_stock	text	Yes	Enable stock (true/false)
stock_balance	text	Yes	Stock balance
image	text	Yes	Image URL
recommended	text	Yes	Recommended (true/false)
option_prices	text	Yes	Array of option prices
modifier_group	text	Yes	Array of modifier groups

Response

message: Empty string if successful

\n","urlObject":{"path":["api","v1","item","update","3CB3000014"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"aad806e0-fc30-423e-a63c-dc765857cfef","name":"Update","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ref_cat_id\": \"00000072\",\n \"name_en\": \"Tasty Concrete Table\",\n \"name_km\": \"\",\n \"name_zh\": \"\",\n \"desc_en\": \"\",\n \"desc_km\": \"\",\n \"desc_zh\": \"\",\n \"barcode\": \"\",\n \"sku\" : \"\",\n \"status\": \"active\",\n \"enable_stock\" : false,\n \"stock_balance\" : 0,\n \"image\": \"http://placeimg.com/640/480\",\n \"recommended\": true,\n \"option_prices\": [\n {\n \"ref_id\": \"954\",\n \"name\": \"Arabia\",\n \"price\": 3.1,\n \"status\": \"active\",\n \"discount_value\": 50,\n \"discount_type\": \"percentage\",\n \"default\": true\n }\n ],\n \"modifier_group\": [\n {\n \"name\": \"Licensed\",\n \"type\": \"single\",\n \"required\": false,\n \"modifiers\": [\n {\n \"ref_id\": \"873\",\n \"name\": \"Lanka\",\n \"price\": 0.0,\n \"status\": \"active\",\n \"display_order\":1\n },\n {\n \"ref_id\": \"875\",\n \"name\": \"Account\",\n \"price\": 0.0,\n \"status\": \"active\",\n \"display_order\":1\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/item/update/3CB3000014"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 03 Dec 2024 15:07:22 GMT"},{"key":"x-amzn-Remapped-date","value":"Tue, 03 Dec 2024 15:07:22 GMT"},{"key":"x-amzn-RequestId","value":"4da3eae8-052d-4eee-bfba-ee962509e5a4"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-ratelimit-remaining","value":"57"},{"key":"cache-control","value":"no-cache, private"},{"key":"x-ratelimit-limit","value":"60"},{"key":"X-Amzn-Trace-Id","value":"Root=1-674f1ea9-72eba83679f434be5b19c724;Parent=47cf77b8c0359d5b;Sampled=0;Lineage=1:fd787ec4:0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 bbdef00245eb23edcffbb5c502699edc.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"TLV50-C2"},{"key":"X-Amz-Cf-Id","value":"SVtyYgpS-NmMlURwB50dIcii64T3y6Zksa01jCGj_N1RBhFIz9TiMQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\"\n}"}],"_postman_id":"a0d141c3-58c4-429d-98e6-c4239321d37e"},{"name":"Status","event":[{"listen":"prerequest","script":{"id":"24b1b6a7-5c4a-4355-982e-7cf721f7d3ef","exec":[""],"type":"text/javascript"}}],"id":"aa85c553-b53f-4abe-bfe6-0e9af12cc59d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"active\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/item/status/0a20df49-ecf7-4113-8877-9fc624bfc4e2","description":"

Update item status

This endpoint is used to update the status of a specific item.

Request Body

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

Key	Type	Required	Description
status	text	Yes	The new status value

Response

message (string): A message indicating the status of the request.

\n","urlObject":{"path":["api","v1","item","status","0a20df49-ecf7-4113-8877-9fc624bfc4e2"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"9d394ab8-3eb3-4999-9cba-002f9697e823","name":"Status","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"active\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/item/status/0a20df49-ecf7-4113-8877-9fc624bfc4e2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.1"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.14"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 16 Feb 2023 03:33:04 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\"\n}"}],"_postman_id":"aa85c553-b53f-4abe-bfe6-0e9af12cc59d"},{"name":"Delete","event":[{"listen":"prerequest","script":{"id":"24b1b6a7-5c4a-4355-982e-7cf721f7d3ef","exec":[""],"type":"text/javascript"}}],"id":"b207cd62-8c82-4cb4-b72d-197725210a2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/item/delete/33120cd9-095b-4f82-9e12-a1fe7849b069","description":"

Delete Item

This endpoint is used to delete a specific item.

Response

message: A message indicating the result of the delete operation.

\n","urlObject":{"path":["api","v1","item","delete","33120cd9-095b-4f82-9e12-a1fe7849b069"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"ba03966f-99a9-46c8-9abf-759c1be2958c","name":"Delete","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/item/delete/04ddd646-55fb-461a-a1cb-6a94beebcb12"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.1"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.14"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 16 Feb 2023 03:03:21 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\"\n}"}],"_postman_id":"b207cd62-8c82-4cb4-b72d-197725210a2f"}],"id":"e0af732b-6bb1-4915-a258-721f816e0265","_postman_id":"e0af732b-6bb1-4915-a258-721f816e0265","description":""},{"name":"Order","item":[{"name":"List","event":[{"listen":"prerequest","script":{"id":"24b1b6a7-5c4a-4355-982e-7cf721f7d3ef","exec":[""],"type":"text/javascript"}}],"id":"dfe80f48-d963-466c-b035-d1d39a349e73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/order/list","urlObject":{"path":["api","v1","order","list"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"d7e0fa8b-9175-4193-8cc1-9052bb84da7e","name":"List","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/order/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.1"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.14"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 16 Feb 2023 04:21:00 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"order_no\": \"5341517657\",\n \"count_items\": 1,\n \"total\": 11.7,\n \"status\": \"New\",\n \"order_date\": \"10:51 AM\"\n },\n {\n \"order_no\": \"1908977547\",\n \"count_items\": 1,\n \"total\": 11.7,\n \"status\": \"New\",\n \"order_date\": \"10:51 AM\"\n }\n ],\n \"total\": 2,\n \"total_dispatched\": 0,\n \"total_processing\": 0,\n \"total_new\": 2\n}"}],"_postman_id":"dfe80f48-d963-466c-b035-d1d39a349e73"},{"name":"Earning History","event":[{"listen":"prerequest","script":{"id":"24b1b6a7-5c4a-4355-982e-7cf721f7d3ef","exec":[""],"type":"text/javascript"}}],"id":"664f91bb-a5f9-4b5d-a381-461cc6f4fc6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/order/earning","urlObject":{"path":["api","v1","order","earning"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"083e3699-7810-4fcc-a4a6-12fd4cf9532a","name":"Earning History with filter date","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/api/v1/order/earning?filter[from_to]=15-01-2021,15-01-2021","host":["{{url}}"],"path":["api","v1","order","earning"],"query":[{"key":"filter[from_to]","value":"15-01-2021,15-01-2021"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.1"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.14"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 16 Feb 2023 04:20:50 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"order_no\": \"1951913299\",\n \"order_date\": \"2021-01-15 7:44 PM\",\n \"earned\": 2.592,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"1407672788\",\n \"order_date\": \"2021-01-15 7:44 PM\",\n \"earned\": 3.825,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"7990269517\",\n \"order_date\": \"2021-01-15 7:22 PM\",\n \"earned\": 4.617,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"1858353106\",\n \"order_date\": \"2021-01-15 6:57 PM\",\n \"earned\": 3.609,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"3902650398\",\n \"order_date\": \"2021-01-15 6:41 PM\",\n \"earned\": 9.576,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"2193649006\",\n \"order_date\": \"2021-01-15 6:13 PM\",\n \"earned\": 8.784,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"2656679715\",\n \"order_date\": \"2021-01-15 6:12 PM\",\n \"earned\": 8.442,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"1488350520\",\n \"order_date\": \"2021-01-15 5:57 PM\",\n \"earned\": 3.825,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"3091100689\",\n \"order_date\": \"2021-01-15 5:42 PM\",\n \"earned\": 8.775,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"1366544051\",\n \"order_date\": \"2021-01-15 5:33 PM\",\n \"earned\": 14.742,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"9082045519\",\n \"order_date\": \"2021-01-15 5:20 PM\",\n \"earned\": 22.734,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"1187773384\",\n \"order_date\": \"2021-01-15 5:07 PM\",\n \"earned\": 17.667,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"1721319116\",\n \"order_date\": \"2021-01-15 4:09 PM\",\n \"earned\": 11.025,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"7207053002\",\n \"order_date\": \"2021-01-15 3:53 PM\",\n \"earned\": 4.275,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"1800617718\",\n \"order_date\": \"2021-01-15 2:58 PM\",\n \"earned\": 8.1,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"2181117986\",\n \"order_date\": \"2021-01-15 2:26 PM\",\n \"earned\": 15.867,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"2641475847\",\n \"order_date\": \"2021-01-15 2:09 PM\",\n \"earned\": 6.984,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"2487113866\",\n \"order_date\": \"2021-01-15 1:58 PM\",\n \"earned\": 4.275,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"2762365287\",\n \"order_date\": \"2021-01-15 12:42 PM\",\n \"earned\": 4.275,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"2777383696\",\n \"order_date\": \"2021-01-15 12:38 PM\",\n \"earned\": 40.05,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"1530528986\",\n \"order_date\": \"2021-01-15 12:24 PM\",\n \"earned\": 13.509,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"2666262949\",\n \"order_date\": \"2021-01-15 12:23 PM\",\n \"earned\": 3.834,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"9189931292\",\n \"order_date\": \"2021-01-15 11:15 AM\",\n \"earned\": 4.059,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"5306766983\",\n \"order_date\": \"2021-01-15 10:46 AM\",\n \"earned\": 8.55,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"2869792404\",\n \"order_date\": \"2021-01-15 10:43 AM\",\n \"earned\": 6.417,\n \"status\": \"Delivered\"\n }\n ],\n \"total_order\": 25,\n \"total_earning\": 240.41\n}"},{"id":"15c5de02-7302-42c9-b603-c9173cc4a473","name":"Earning History current month","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/order/earning"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.1"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.14"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 16 Feb 2023 04:21:43 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"57"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"order_no\": \"1819351661\",\n \"order_date\": \"2023-02-15 10:09 AM\",\n \"earned\": 11.7,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"2761345160\",\n \"order_date\": \"2023-02-08 10:50 AM\",\n \"earned\": 43.2,\n \"status\": \"Delivered\"\n },\n {\n \"order_no\": \"1929545037\",\n \"order_date\": \"2023-02-06 3:00 PM\",\n \"earned\": 0.9,\n \"status\": \"Delivered\"\n }\n ],\n \"total_order\": 3,\n \"total_earning\": 55.8\n}"}],"_postman_id":"664f91bb-a5f9-4b5d-a381-461cc6f4fc6b"},{"name":"Detail","event":[{"listen":"prerequest","script":{"id":"24b1b6a7-5c4a-4355-982e-7cf721f7d3ef","exec":[""],"type":"text/javascript","packages":{}}}],"id":"d00d4fdb-a074-4a11-82cb-62057b4c56b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/order/detail/4249428417","urlObject":{"path":["api","v1","order","detail","4249428417"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"611d4fa0-1f6a-4fa2-b245-88498ea4aa6f","name":"Detail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/order/detail/5341517657"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.1"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.14"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 16 Feb 2023 04:23:45 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"order_no\": \"5341517657\",\n \"status\": \"New\",\n \"count_items\": 1,\n \"order_date\": \"2023-02-16 10:51 AM\",\n \"sub_total\": \"13.00\",\n \"packaging_charge\": 0,\n \"commission\": 1.3,\n \"tax\": 0,\n \"service_charge\": 0,\n \"offer_discount\": 0,\n \"offer_delivery_discount\": 0,\n \"total\": 11.7,\n \"is_new_customer\": 0,\n \"need_utensil\": \"yes\",\n \"order_details\": [\n {\n \"order_detail_id\": 4165766,\n \"category_ref_id\": \"e156759d-1c7f-4e80-8888-151f4c9e7e67\",\n \"item_id\": 703123,\n \"ref_id\": \"e156759d-1c7f-4e80-9202-151f4c9e7e67\",\n \"qty\": 1,\n \"unit_price\": 13,\n \"discount\": 0,\n \"total_price\": 13,\n \"food_name\": \"Soft\",\n \"status\": \"Active\",\n \"food_image\": \"http://192.168.31.55:9900/testing/upload/MenuItem/0230210104901703123.png\",\n \"instruction\": null,\n \"barcode\": null,\n \"remark\": null,\n \"price_option\": {\n \"id\": 1095112,\n \"name\": \"small\",\n \"price\": 0,\n \"ref_id\": \"e156759d-1c7f-4e80-9202-151f4c9e7e67\"\n },\n \"modifier_group\": {\n \"ice\": [\n {\n \"id\": 1095116,\n \"name\": \"less ice\",\n \"price\": 0,\n \"ref_id\": \"abe2409b-bf4b-402f-ad44-df7d11a2ee92\"\n }\n ],\n \"toping\": [\n {\n \"id\": 1095118,\n \"name\": \"black bubble\",\n \"price\": 2,\n \"ref_id\": \"67aba1d5-c042-4dc4-90c9-2007c5585e25\"\n }\n ]\n }\n }\n ]\n }\n}"}],"_postman_id":"d00d4fdb-a074-4a11-82cb-62057b4c56b2"},{"name":"Accept","event":[{"listen":"prerequest","script":{"id":"24b1b6a7-5c4a-4355-982e-7cf721f7d3ef","exec":[""],"type":"text/javascript"}}],"id":"31cb4471-00c6-4ead-a27c-e92d4b53e784","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/order/accept/1908977547","description":"

Response error code:

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

code	message
1	This order is already cancelled.
2	This order is already accepted.
3	This order is already declined.
4	This order is already processed.

","urlObject":{"path":["api","v1","order","accept","1908977547"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"d02ce539-1ed2-4593-9f2c-55a83e6e1462","name":"Accept","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/order/accept/1908977547"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.1"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.14"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 16 Feb 2023 04:26:26 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"60"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"code\": 0\n}"}],"_postman_id":"31cb4471-00c6-4ead-a27c-e92d4b53e784"},{"name":"Decline","event":[{"listen":"prerequest","script":{"id":"24b1b6a7-5c4a-4355-982e-7cf721f7d3ef","exec":[""],"type":"text/javascript"}}],"id":"bedffcba-1dc6-483e-9b0e-16733492b5c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reason\":\"item out of stock\",\n \"message\" : \"Item Abc is not avaialbe\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/order/decline/1943163018","description":"

Response error code:

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

Error Code	Error Description
1	This order is already cancelled.
2	This order is already accepted.
3	This order is already declined.
4	This order is already processed.

","urlObject":{"path":["api","v1","order","decline","1943163018"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"273406f6-e4f1-4989-99e7-2f2c08b7e96d","name":"Decline","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reason\":\"item out of stock\",\n \"message\" : \"Item Abc is not avaialbe\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/order/decline/3336844699"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.1"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.1.14"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 16 Feb 2023 04:28:14 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"code\": 0\n}"}],"_postman_id":"bedffcba-1dc6-483e-9b0e-16733492b5c1"}],"id":"fea4e8a2-d218-418c-b3b4-61b5b2a29e03","_postman_id":"fea4e8a2-d218-418c-b3b4-61b5b2a29e03","description":""},{"name":"Partner Push Notification","item":[{"name":"Request Order Notification","id":"24898f95-a7e7-4b41-b4f7-a390dcfabf93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{partner_access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order_no\": \"5341517657\",\n \"status\": \"New\",\n \"message\": \"\",\n \"date\": \"2023-02-16 10:51 AM\"\n}","options":{"raw":{"language":"json"}}},"url":"{{partner_url}}/{{any_path}}/order/status","description":"

Expected status:

New
Processing
Dispatched
Delivered
Canceled
Store Declined

\n","urlObject":{"path":["{{any_path}}","order","status"],"host":["{{partner_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"24898f95-a7e7-4b41-b4f7-a390dcfabf93"},{"name":"Request Bulk Item Notification","id":"fcef6738-067e-48ec-ac7a-98de5cf567e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer {{partner_access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"total_items_count\": 2,\n \"success_items_count\": 1,\n \"errors\": [\n {\n \"ref_id\": \"b89495b2-80eb-48b6-a876-5cf8956fb2d1\",\n \"error\": \"Modifier duplicate ref_id 1234\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{partner_url}}/{{any_path}}/bulk/item/status","urlObject":{"path":["{{any_path}}","bulk","item","status"],"host":["{{partner_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fcef6738-067e-48ec-ac7a-98de5cf567e6"}],"id":"a2ee65bc-7686-40a0-9b73-db9f16fcb892","description":"

Nham24 will uses below partner endpoint to update order status to partner.

How you want to use these status for your internal processes completely depends on your operations team.

\n","_postman_id":"a2ee65bc-7686-40a0-9b73-db9f16fcb892"}]}

Requisition

OAuth Token Request

Request Body Parameters

Response

Request Body

Response

Category List API

Request

Response

Create Category

Request Body

Response

Update Category

Request Body

API Request Description

Request Body

Delete Category

Response

Retrieve Item List

Request

Response

Create Item

Request Body

Key: option_prices

Key: modifier_group

Bulk Create/Update Item

Request Body

Key: items

Key: option_prices

Key: modifier_group

Response

GET /api/v1/item/detail/{id}

Request

Response

Update Item

Request Body

Response

Update item status

Request Body

Response

Delete Item

Response

Response error code:

Response error code: