{"info":{"_postman_id":"ec86c743-cce3-4107-b153-80f4aa5ccca4","name":"Geovision Dispatch API","description":"

This document contains data regarding the sending of information about the Cargo requested for Distribution (SEND) to the Geovision Dispatch system.

\n

In this document, we have collected the information you will need to use the Geovision Dispatch API. You can go to the services you want to get information from the navigation pane, and see sample requests, responses and request parameters in detail. You can examine the relevant object in the answer that the service has returned to you by clicking the name of the object in the answers section, and you can find detailed explanations about each feature.

\n

You can reach us via info@geovisiongroup.com

\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"4961579","collectionId":"ec86c743-cce3-4107-b153-80f4aa5ccca4","publishedId":"Tz5uzuNw","public":true,"customColor":{"top-bar":"0a194a","right-sidebar":"303030","highlight":"253863"},"publishDate":"2021-05-20T13:43:18.000Z"},"item":[{"name":"Customer","item":[{"name":"{code}","item":[{"name":"Get customer by code","id":"09b4fea2-ee0b-44f1-972d-58e53ff6e66d","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Access_token ","description":"

We send the token type and access_token information in the authorization parameter.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"code\": \"string\"\r\n}"},"url":"{{base}}/api/customer/:code","description":"

Gets a customer data when its code is provided.

\n

Error Codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDefinition
E0004There is no such warehouse.
E0005There is no such customer.
\n
","urlObject":{"path":["api","customer",":code"],"host":["{{base}}"],"query":[],"variable":[{"description":{"content":"

(Required) Customer code

\n","type":"text/plain"},"type":"string","value":"","key":"code"}]}},"response":[{"id":"0c82cb52-75d9-40d7-bb7a-3023b5982828","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw","description":"(Required) Bearer Access_token ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/customer/:code","host":["{{base}}"],"path":["api","customer",":code"],"variable":[{"key":"code"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"string\",\n \"created_at\": \"2021-03-22T15:21:28.805Z\",\n \"lastupdated\": \"2021-03-22T15:21:28.805Z\",\n \"code\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"gsm_number\": \"string\",\n \"email\": \"string\",\n \"channel\": \"string\",\n \"addresses\": [\n {\n \"id\": \"string\",\n \"created_at\": \"2021-03-22T15:21:28.805Z\",\n \"lastupdated\": \"2021-03-22T15:21:28.805Z\",\n \"code\": \"string\",\n \"address_code_ext\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"gsm_number\": \"string\",\n \"email\": \"string\",\n \"address\": \"string\",\n \"country\": \"string\",\n \"state\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"district\": \"string\",\n \"street\": \"string\",\n \"address_line\": \"string\",\n \"post_code\": \"string\",\n \"latitude\": 0,\n \"longitude\": 0\n }\n ],\n \"delivery_days\": \"string\",\n \"delivery_note\": \"string\"\n }\n ]\n}"},{"id":"230c5e63-f081-4ffa-b2cd-bf753af01aa7","name":"Forbidden","originalRequest":{"method":"GET","header":[{"description":"(Required) Bearer: ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/customer/:code","host":["{{base}}"],"path":["api","customer",":code"],"variable":[{"key":"code"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"6764d581-06e2-40d8-bcd7-10a0531ae240","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/customer/:code","host":["{{base}}"],"path":["api","customer",":code"],"variable":[{"key":"code"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"7534dad5-a2d9-4510-937b-53fe468be20a","name":"Not Found","originalRequest":{"method":"GET","header":[{"description":"(Required) Bearer Access_token","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/customer/:code","host":["{{base}}"],"path":["api","customer",":code"],"variable":[{"key":"code"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"09b4fea2-ee0b-44f1-972d-58e53ff6e66d"},{"name":"Delete customer by warehouse code and code.","id":"f2839ac3-db99-4faf-99e8-41908b015809","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Access_token ","description":"

We send the token type and access_token information in the authorization parameter.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"code\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/customer/:warehouse_code/:code","description":"

Delete a customer by code.

\n

Error Codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDefinition
E0004There is no such warehouse.
E0005There is no such customer.
\n
","urlObject":{"path":["api","customer",":warehouse_code",":code"],"host":["{{base}}"],"query":[],"variable":[{"description":{"content":"

(Required) Warehouse code

\n","type":"text/plain"},"type":"any","value":"","key":"warehouse_code"},{"description":{"content":"

(Required) Customer code

\n","type":"text/plain"},"type":"any","value":"","key":"code"}]}},"response":[{"id":"13962f1d-aaf2-4e71-a769-b05bd0b9f2bb","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"(Required) Bearer Access_token","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/customer/:warehouse_code/:code","host":["{{base}}"],"path":["api","customer",":warehouse_code",":code"],"variable":[{"key":"warehouse_code","value":""},{"key":"code"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"480adc41-9e4b-480c-881e-f044be3e47da","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/customer/:warehouse_code/:code","host":["{{base}}"],"path":["api","customer",":warehouse_code",":code"],"variable":[{"key":"warehouse_code","value":""},{"key":"code"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"4ad4cf0d-e84b-4b3a-a6c0-5b150234d6b9","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/customer/:warehouse_code/:code","host":["{{base}}"],"path":["api","customer",":warehouse_code",":code"],"variable":[{"key":"warehouse_code","value":""},{"key":"code"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"827856cd-e684-4dad-8872-4baf7eb3f881","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw","description":"(Required) Bearer Access_token ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/customer/:warehouse_code/:code","host":["{{base}}"],"path":["api","customer",":warehouse_code",":code"],"variable":[{"key":"warehouse_code","value":""},{"key":"code"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"string\",\n \"created_at\": \"2021-03-22T15:21:28.805Z\",\n \"lastupdated\": \"2021-03-22T15:21:28.805Z\",\n \"code\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"gsm_number\": \"string\",\n \"email\": \"string\",\n \"channel\": \"string\",\n \"addresses\": [\n {\n \"id\": \"string\",\n \"created_at\": \"2021-03-22T15:21:28.805Z\",\n \"lastupdated\": \"2021-03-22T15:21:28.805Z\",\n \"code\": \"string\",\n \"address_code_ext\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"gsm_number\": \"string\",\n \"email\": \"string\",\n \"address\": \"string\",\n \"country\": \"string\",\n \"state\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"district\": \"string\",\n \"street\": \"string\",\n \"address_line\": \"string\",\n \"post_code\": \"string\",\n \"latitude\": 0,\n \"longitude\": 0\n }\n ],\n \"delivery_days\": \"string\",\n \"delivery_note\": \"string\"\n }\n ]\n}\n"}],"_postman_id":"f2839ac3-db99-4faf-99e8-41908b015809"}],"id":"c6b0e1b9-1bfe-4f3b-88c2-408dd9af077e","_postman_id":"c6b0e1b9-1bfe-4f3b-88c2-408dd9af077e","description":""},{"name":"Update existing customer","id":"84c993a9-f2e6-4e9a-9cc9-09f0a2725eea","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Access_token ","description":"

We send the token type and access_token information in the authorization parameter.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"code\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"channel\": \"string\",\n \"gsm_number\": \"string\",\n \"email\": \"string\",\n \"addresses\": [\n {\n \"code\": \"string\",\n \"address_code_ext\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"gsm_number\": \"string\",\n \"email\": \"string\",\n \"address\": \"string\",\n \"country\": \"string\",\n \"state\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"district\": \"string\",\n \"street\": \"string\",\n \"address_line\": \"string\",\n \"post_code\": \"string\",\n \"latitude\": 0,\n \"longitude\": 0\n }\n ],\n \"delivery_days\": \"string\",\n \"delivery_note\": \"string\"\n}"},"url":"{{base}}/api/customer","description":"

Update an existing customer.

\n

The field list belonging to the customer is available in Figure 1.

\n

Error Codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDefinition
E0001You must send all Required Fields.
E0002The field (fieldname) must have a maximum length of (maxlength)
E0003The customer code you want to create is already defined.
E0004There is no such warehouse.
\n
","urlObject":{"path":["api","customer"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"05963d58-5ff6-4393-bc11-0d0ad2ca58f7","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw","description":"(Required) Bearer Access_token ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/customer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"string\",\n \"created_at\": \"2021-03-22T15:21:28.805Z\",\n \"lastupdated\": \"2021-03-22T15:21:28.805Z\",\n \"code\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"gsm_number\": \"string\",\n \"email\": \"string\",\n \"channel\": \"string\",\n \"addresses\": [\n {\n \"id\": \"string\",\n \"created_at\": \"2021-03-22T15:21:28.805Z\",\n \"lastupdated\": \"2021-03-22T15:21:28.805Z\",\n \"code\": \"string\",\n \"address_code_ext\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"gsm_number\": \"string\",\n \"email\": \"string\",\n \"address\": \"string\",\n \"country\": \"string\",\n \"state\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"district\": \"string\",\n \"street\": \"string\",\n \"address_line\": \"string\",\n \"post_code\": \"string\",\n \"latitude\": 0,\n \"longitude\": 0\n }\n ],\n \"delivery_days\": \"string\",\n \"delivery_note\": \"string\"\n }\n ]\n}"},{"id":"293d414f-97bb-43f4-a104-bb2e803c5d6d","name":"Forbidden","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/customer"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"43df4179-30bc-4a51-801e-f559ba4c3ab7","name":"Created","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/customer"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"647012c4-744e-437e-9765-d1f7bb493bb8","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/customer"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"9c82f6e7-094e-43bc-96e9-d4fae75bd8c4","name":"Not Found","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/customer"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"84c993a9-f2e6-4e9a-9cc9-09f0a2725eea"},{"name":"Create new customer","id":"1983c1cf-8a66-4073-8b83-91b65bcc22fa","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Access_token ","description":"

We send the token type and access_token information in the authorization parameter.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"code\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"channel\": \"string\",\n \"gsm_number\": \"string\",\n \"email\": \"string\",\n \"addresses\": [\n {\n \"code\": \"string\",\n \"address_code_ext\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"gsm_number\": \"string\",\n \"email\": \"string\",\n \"address\": \"string\",\n \"country\": \"string\",\n \"state\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"district\": \"string\",\n \"street\": \"string\",\n \"address_line\": \"string\",\n \"post_code\": \"string\",\n \"latitude\": 0,\n \"longitude\": 0\n }\n ],\n \"delivery_days\": \"string\",\n \"delivery_note\": \"string\"\n}"},"url":"{{base}}/api/customer","description":"

Create a new customer.

\n

Each address of the customer must have an id. This id must be given uniquely in the address_code field.

\n

The field list belonging to the customer is available in Figure 1.

\n

Error Codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDefinition
E0001You must send all Required Fields.
E0002The field (fieldname) must have a maximum length of (maxlength)
E0003The customer code you want to create is already defined.
E0004There is no such warehouse.
\n
","urlObject":{"path":["api","customer"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"40d2c02e-b54c-4699-8e88-e7ad850fe7d2","name":"Created","originalRequest":{"method":"PUT","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/customer"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"55728f59-c32c-41ff-8808-db6991f8f308","name":"Forbidden","originalRequest":{"method":"PUT","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/customer"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"6304615c-7ab8-4583-b4db-f8ad041d78d8","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/customer"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"946b34cc-8c36-4a72-93a5-30518d393b51","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw","description":"(Required) Bearer Access_token ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/customer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"string\",\n \"created_at\": \"2021-03-22T15:21:28.805Z\",\n \"lastupdated\": \"2021-03-22T15:21:28.805Z\",\n \"code\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"gsm_number\": \"string\",\n \"email\": \"string\",\n \"channel\": \"string\",\n \"addresses\": [\n {\n \"id\": \"string\",\n \"created_at\": \"2021-03-22T15:21:28.805Z\",\n \"lastupdated\": \"2021-03-22T15:21:28.805Z\",\n \"code\": \"string\",\n \"address_code_ext\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"gsm_number\": \"string\",\n \"email\": \"string\",\n \"address\": \"string\",\n \"country\": \"string\",\n \"state\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"district\": \"string\",\n \"street\": \"string\",\n \"address_line\": \"string\",\n \"post_code\": \"string\",\n \"latitude\": 0,\n \"longitude\": 0\n }\n ],\n \"delivery_days\": \"string\",\n \"delivery_note\": \"string\"\n }\n ]\n}"},{"id":"952ea8f5-ed45-4731-988c-d817898696af","name":"Not Found","originalRequest":{"method":"PUT","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/customer"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"1983c1cf-8a66-4073-8b83-91b65bcc22fa"}],"id":"672326b2-9c38-4b46-badd-1fa71ecb1662","description":"

Customer is the person that the cargo will be delivered.

\n

Followings are the fields that will be provided for each customer record:

\n

Field List

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Field NameRequiredData Type and SizeDefinition
code✔String, 0 < length < 32The unique customer code that is used in your database. You may use any unique data that distinguishes one customer from all others, which might be the social security number, phone number, or email address etc. It is important to use a consistent form of data for all customers of your company.
first_name✔String, 0 < length < 50First Name of the Customer.
last_name✔String, 0 < length < 50Last Name of the Customer.
channel✔String, length == 2Channel specifies customer category based on the following Code Table. For example, for a \"grocery\", you shall use \"01\" (00=default 01=grocery 02=market 03=restaurant 04=cafe)
address_code✔String, 0 < length < 32Address code
address_code_ext✔String, 0 < length < 32Address code in Seller.
countryString, 0 < length < 30Country
stateString, 0 < length < 30State
cityString, 0 < length < 30City
countyString, 0 < length < 30County
districtString, 0 < length < 30District
streetString, 0 < length < 30Street
address_lineString, 0 < length < 100Additional information including Street number, apartment number etc.
postal_codeString, 0 < length < 10Postal code of the zone.
latitude✔StringLatitude. For example: 45.891170
longitude✔StringLongitude. For example: 28.721010
gsm_numberStringMobile phone number shall include the following template (country_calling_code)(area_code)XXXXXXX, country_code shall match to the COUNTRY CODE list in the following link: https://countrycode.org/
emailString, 0 < length < 60email address of the customer which satisfies the standard regular expression.
delivery_daysString, length = 7, default: \"1111100\"7 bits, each one denoting availability for delivery in days of weeks (M, T, W, Th, F, Sat, Sun) (1=available, 0=N/A)
delivery_noteString, 0 < length < 250Any additional informal information that the deliverer should know.
\n

Figure 1: Customer Field List

\n","_postman_id":"672326b2-9c38-4b46-badd-1fa71ecb1662"},{"name":"Order","item":[{"name":"{code}","item":[{"name":"Get order by warehouse code and code.","id":"9546e7e9-4a44-4dcd-9d3e-4d95870d29df","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Access_token ","description":"

We send the token type and access_token information in the authorization parameter.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"code\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/order/:warehousecode/:code","description":"

Get orders of a warehouse by providing its code.

\n

Error Codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDefinition
E0004There is no such order.
\n
","urlObject":{"path":["api","order",":warehousecode",":code"],"host":["{{base}}"],"query":[],"variable":[{"id":"a7599e1a-6f81-43b9-a709-42a534dfcf47","type":"any","value":null,"key":"warehousecode"},{"id":"582e2d0f-4a73-4d4e-b835-156155de88f6","type":"any","value":null,"key":"code"}]}},"response":[{"id":"37936801-0edb-4c9e-a327-34878890aea1","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw","description":"(Required) Bearer Access_token","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/order/:warehousecode/:code","host":["{{base}}"],"path":["api","order",":warehousecode",":code"],"variable":[{"key":"warehousecode","value":null},{"key":"code","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"address\": {\n \"address\": \"string\",\n \"address_code_ext\": \"string\",\n \"address_line\": \"string\",\n \"city\": \"string\",\n \"code\": \"string\",\n \"country\": \"string\",\n \"county\": \"string\",\n \"created_at\": \"2021-09-23T09:19:49.318Z\",\n \"district\": \"string\",\n \"email\": \"string\",\n \"first_name\": \"string\",\n \"geocode_score\": 0,\n \"gsm_number\": \"string\",\n \"id\": \"string\",\n \"last_name\": \"string\",\n \"lastupdated\": \"2021-09-23T09:19:49.318Z\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"post_code\": \"string\",\n \"state\": \"string\",\n \"street\": \"string\"\n },\n \"barcode\": \"string\",\n \"cargo_depth\": 0,\n \"cargo_height\": 0,\n \"cargo_weight\": 0,\n \"cargo_width\": 0,\n \"created_at\": \"2021-09-23T09:19:49.318Z\",\n \"customer\": {\n \"addresses\": [\n {\n \"address\": \"string\",\n \"address_code_ext\": \"string\",\n \"address_line\": \"string\",\n \"city\": \"string\",\n \"code\": \"string\",\n \"country\": \"string\",\n \"county\": \"string\",\n \"created_at\": \"2021-09-23T09:19:49.318Z\",\n \"district\": \"string\",\n \"email\": \"string\",\n \"first_name\": \"string\",\n \"geocode_score\": 0,\n \"gsm_number\": \"string\",\n \"id\": \"string\",\n \"last_name\": \"string\",\n \"lastupdated\": \"2021-09-23T09:19:49.318Z\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"post_code\": \"string\",\n \"state\": \"string\",\n \"street\": \"string\"\n }\n ],\n \"channel\": \"string\",\n \"code\": \"string\",\n \"created_at\": \"2021-09-23T09:19:49.318Z\",\n \"delivery_days\": \"string\",\n \"delivery_note\": \"string\",\n \"email\": \"string\",\n \"first_name\": \"string\",\n \"gsm_number\": \"string\",\n \"id\": \"string\",\n \"last_name\": \"string\",\n \"lastupdated\": \"2021-09-23T09:19:49.318Z\"\n },\n \"deci\": 0,\n \"delivery_date\": \"2021-09-23T09:19:49.318Z\",\n \"id\": \"string\",\n \"lastupdated\": \"2021-09-23T09:19:49.318Z\",\n \"order_code\": \"string\",\n \"order_date\": \"2021-09-23T09:19:49.318Z\",\n \"priority\": 0,\n \"products\": [\n {\n \"code\": \"string\",\n \"id\": \"string\",\n \"name\": \"string\",\n \"quantity\": 0,\n \"transfer_type\": \"string\",\n \"unit_quantity\": \"string\"\n }\n ],\n \"sent_to_plan\": true,\n \"special_1\": \"string\",\n \"special_2\": \"string\",\n \"special_3\": \"string\",\n \"taken_by\": \"string\",\n \"warehouse\": {\n \"address\": \"string\",\n \"address_line\": \"string\",\n \"city\": \"string\",\n \"code\": \"string\",\n \"country\": \"string\",\n \"county\": \"string\",\n \"created_at\": \"2021-09-23T09:19:49.318Z\",\n \"district\": \"string\",\n \"id\": \"string\",\n \"lastupdated\": \"2021-09-23T09:19:49.318Z\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"name\": \"string\",\n \"post_code\": \"string\",\n \"special_1\": \"string\",\n \"special_2\": \"string\",\n \"special_3\": \"string\",\n \"state\": \"string\",\n \"street\": \"string\"\n }\n }\n ],\n \"success\": true\n}"},{"id":"db312949-844f-45ea-888f-c2f831c06a4c","name":"Not Found","originalRequest":{"method":"GET","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/order/:code","host":["{{base}}"],"path":["api","order",":code"],"variable":[{"key":"code"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"9951a382-ab9a-447c-a6a3-e834fdbd0481","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"(Required) Bearer Access_token","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/order/:code","host":["{{base}}"],"path":["api","order",":code"],"variable":[{"key":"code"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"93410699-1f0d-4141-9df5-7412fdc949a8","name":"Forbidden","originalRequest":{"method":"GET","header":[{"description":"(Required) Bearer Access_token","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/order/:code","host":["{{base}}"],"path":["api","order",":code"],"variable":[{"key":"code"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9546e7e9-4a44-4dcd-9d3e-4d95870d29df"},{"name":"Delete order by warehouse code and code","id":"f5e849e1-1708-4186-9fef-45b85ee88d5f","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Access_token","description":"

We send the token type and access_token information in the authorization parameter.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"code\": \"string\"\r\n}"},"url":"{{base}}/api/order/:warehousecode/:code","description":"

Delete orders of a warehouse by providing its code.

\n

Error Codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDefinition
E0004There is no such order.
\n
","urlObject":{"path":["api","order",":warehousecode",":code"],"host":["{{base}}"],"query":[],"variable":[{"id":"e504646f-2c97-4efa-8474-1f88f2cd2ca3","type":"any","value":null,"key":"warehousecode"},{"id":"06804159-60cd-427b-a5d2-df31f71816f1","type":"any","value":null,"key":"code"}]}},"response":[{"id":"48f3360a-8f88-4566-8918-44b33f78c47e","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw","description":"(Required) Bearer Access_token","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/order/:warehousecode/:code","host":["{{base}}"],"path":["api","order",":warehousecode",":code"],"variable":[{"key":"warehousecode","value":null},{"key":"code"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\":true,\n \"data\":[\n {\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T15:44:21.170Z\",\n \"lastupdated\":\"2021-03-22T15:44:21.171Z\",\n \"order_code\":\"string\",\n \"customer\":{\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T15:21:28.805Z\",\n \"lastupdated\":\"2021-03-22T15:21:28.805Z\",\n \"code\":\"string\",\n \"first_name\":\"string\",\n \"last_name\":\"string\",\n \"gsm_number\":\"string\",\n \"email\":\"string\",\n \"channel\":\"string\",\n \"addresses\":[\n {\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T15:21:28.805Z\",\n \"lastupdated\":\"2021-03-22T15:21:28.805Z\",\n \"code\":\"string\",\n \"address_code_ext\":\"string\",\n \"first_name\":\"string\",\n \"last_name\":\"string\",\n \"gsm_number\":\"string\",\n \"email\":\"string\",\n \"address\":\"string\",\n \"country\":\"string\",\n \"state\":\"string\",\n \"city\":\"string\",\n \"county\":\"string\",\n \"district\":\"string\",\n \"street\":\"string\",\n \"address_line\":\"string\",\n \"post_code\":\"string\",\n \"latitude\":0,\n \"longitude\":0\n }\n ],\n \"delivery_days\":\"string\",\n \"delivery_note\":\"string\"\n },\n \"warehouse\":{\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T14:53:46.414Z\",\n \"lastupdated\":\"2021-03-22T14:53:46.414Z\",\n \"code\":\"string\",\n \"name\":\"string\",\n \"address\":\"string\",\n \"country\":\"string\",\n \"state\":\"string\",\n \"city\":\"string\",\n \"county\":\"string\",\n \"district\":\"string\",\n \"street\":\"string\",\n \"address_line\":\"string\",\n \"latitude\":0,\n \"longitude\":0,\n \"post_code\":\"string\",\n \"special_1\":\"string\",\n \"special_2\":\"string\",\n \"special_3\":\"string\"\n },\n \"deci\":0,\n \"cargo_width\":0,\n \"cargo_height\":0,\n \"cargo_depth\":0,\n \"cargo_weight\":0,\n \"delivery_date\":\"2021-03-22T15:44:21.171Z\",\n \"order_date\":\"2021-03-22T15:44:21.171Z\",\n \"priority\":0,\n \"barcode\":\"string\",\n \"products\":[\n {\n \"code\":\"string\",\n \"name\":\"string\",\n \"quantity\":0,\n \"transfer_type\":\"string\",\n \"unit_quantity\":\"string\"\n }\n ]\n }\n ]\n}"},{"id":"ab356e6f-a87d-442f-8439-b604fca93cac","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"description":"(Required) Bearer Access_token","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/order/:code","host":["{{base}}"],"path":["api","order",":code"],"variable":[{"key":"code"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"8b953c0f-e63c-44ac-b890-f75e9609117c","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"(Required) Bearer Access_token","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/order/:code","host":["{{base}}"],"path":["api","order",":code"],"variable":[{"key":"code"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"cbff6d52-d5f3-4af9-ac2f-92d3fda667b0","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"(Required) Bearer Access_token","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/order/:code","host":["{{base}}"],"path":["api","order",":code"],"variable":[{"key":"code"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f5e849e1-1708-4186-9fef-45b85ee88d5f"}],"id":"bdf6ac83-7679-4161-a2aa-e51aa35cb038","_postman_id":"bdf6ac83-7679-4161-a2aa-e51aa35cb038","description":""},{"name":"{barcode}","item":[{"name":"Get order status with history by barcode","id":"b3a52a59-2977-45c9-a25a-7d8482d73e3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base}}​/api​/order​/status​/{barcode}","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"43302aae-b671-45bd-9a84-dd2344e2e97d","id":"43302aae-b671-45bd-9a84-dd2344e2e97d","name":"{barcode}","type":"folder"}},"urlObject":{"path":["api​","order​","status​","{barcode}"],"host":["{{base}}​"],"query":[],"variable":[]}},"response":[{"id":"4a391dfe-7f23-4778-9706-9e9bf5c496a2","name":"OK","originalRequest":{"method":"GET","header":[]},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"barcode\": \"string\",\r\n \"created_at\": \"2021-09-23T09:06:37.011Z\",\r\n \"history\": [\r\n {\r\n \"date\": \"2021-09-23T09:06:37.011Z\",\r\n \"status\": \"string\"\r\n }\r\n ],\r\n \"id\": \"string\",\r\n \"lastupdated\": \"2021-09-23T09:06:37.011Z\",\r\n \"order_code\": \"string\",\r\n \"status\": \"string\",\r\n \"url\": \"string\"\r\n }\r\n ],\r\n \"success\": true\r\n}"},{"id":"129f0561-2156-48a1-b7b6-428f0894845d","name":"Forbidden","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/order"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"f799bb3e-465b-408e-8f09-e379f275700e","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/order"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"b1aa83c4-997f-4a6e-b1af-69f87b196dec","name":"Not Found","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/order"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"b3a52a59-2977-45c9-a25a-7d8482d73e3a"},{"name":"Delete order by barcode","id":"6af322a0-d899-4721-8fbd-7601b8d3a316","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{base}}/api/order/{barcode}","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"43302aae-b671-45bd-9a84-dd2344e2e97d","id":"43302aae-b671-45bd-9a84-dd2344e2e97d","name":"{barcode}","type":"folder"}},"urlObject":{"path":["api","order","{barcode}"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"6d302374-b760-4b01-b4a6-f2cdf00aea27","name":"OK","originalRequest":{"method":"GET","header":[]},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"address\": {\r\n \"address\": \"string\",\r\n \"address_code_ext\": \"string\",\r\n \"address_line\": \"string\",\r\n \"city\": \"string\",\r\n \"code\": \"string\",\r\n \"country\": \"string\",\r\n \"county\": \"string\",\r\n \"created_at\": \"2021-09-23T09:17:58.549Z\",\r\n \"district\": \"string\",\r\n \"email\": \"string\",\r\n \"first_name\": \"string\",\r\n \"geocode_score\": 0,\r\n \"gsm_number\": \"string\",\r\n \"id\": \"string\",\r\n \"last_name\": \"string\",\r\n \"lastupdated\": \"2021-09-23T09:17:58.549Z\",\r\n \"latitude\": 0,\r\n \"longitude\": 0,\r\n \"post_code\": \"string\",\r\n \"state\": \"string\",\r\n \"street\": \"string\"\r\n },\r\n \"barcode\": \"string\",\r\n \"cargo_depth\": 0,\r\n \"cargo_height\": 0,\r\n \"cargo_weight\": 0,\r\n \"cargo_width\": 0,\r\n \"created_at\": \"2021-09-23T09:17:58.549Z\",\r\n \"customer\": {\r\n \"addresses\": [\r\n {\r\n \"address\": \"string\",\r\n \"address_code_ext\": \"string\",\r\n \"address_line\": \"string\",\r\n \"city\": \"string\",\r\n \"code\": \"string\",\r\n \"country\": \"string\",\r\n \"county\": \"string\",\r\n \"created_at\": \"2021-09-23T09:17:58.549Z\",\r\n \"district\": \"string\",\r\n \"email\": \"string\",\r\n \"first_name\": \"string\",\r\n \"geocode_score\": 0,\r\n \"gsm_number\": \"string\",\r\n \"id\": \"string\",\r\n \"last_name\": \"string\",\r\n \"lastupdated\": \"2021-09-23T09:17:58.549Z\",\r\n \"latitude\": 0,\r\n \"longitude\": 0,\r\n \"post_code\": \"string\",\r\n \"state\": \"string\",\r\n \"street\": \"string\"\r\n }\r\n ],\r\n \"channel\": \"string\",\r\n \"code\": \"string\",\r\n \"created_at\": \"2021-09-23T09:17:58.549Z\",\r\n \"delivery_days\": \"string\",\r\n \"delivery_note\": \"string\",\r\n \"email\": \"string\",\r\n \"first_name\": \"string\",\r\n \"gsm_number\": \"string\",\r\n \"id\": \"string\",\r\n \"last_name\": \"string\",\r\n \"lastupdated\": \"2021-09-23T09:17:58.549Z\"\r\n },\r\n \"deci\": 0,\r\n \"delivery_date\": \"2021-09-23T09:17:58.549Z\",\r\n \"id\": \"string\",\r\n \"lastupdated\": \"2021-09-23T09:17:58.549Z\",\r\n \"order_code\": \"string\",\r\n \"order_date\": \"2021-09-23T09:17:58.549Z\",\r\n \"priority\": 0,\r\n \"products\": [\r\n {\r\n \"code\": \"string\",\r\n \"id\": \"string\",\r\n \"name\": \"string\",\r\n \"quantity\": 0,\r\n \"transfer_type\": \"string\",\r\n \"unit_quantity\": \"string\"\r\n }\r\n ],\r\n \"sent_to_plan\": true,\r\n \"special_1\": \"string\",\r\n \"special_2\": \"string\",\r\n \"special_3\": \"string\",\r\n \"taken_by\": \"string\",\r\n \"warehouse\": {\r\n \"address\": \"string\",\r\n \"address_line\": \"string\",\r\n \"city\": \"string\",\r\n \"code\": \"string\",\r\n \"country\": \"string\",\r\n \"county\": \"string\",\r\n \"created_at\": \"2021-09-23T09:17:58.549Z\",\r\n \"district\": \"string\",\r\n \"id\": \"string\",\r\n \"lastupdated\": \"2021-09-23T09:17:58.549Z\",\r\n \"latitude\": 0,\r\n \"longitude\": 0,\r\n \"name\": \"string\",\r\n \"post_code\": \"string\",\r\n \"special_1\": \"string\",\r\n \"special_2\": \"string\",\r\n \"special_3\": \"string\",\r\n \"state\": \"string\",\r\n \"street\": \"string\"\r\n }\r\n }\r\n ],\r\n \"success\": true\r\n}"},{"id":"afe15e8c-d8c9-410e-9a64-ef035d713f61","name":"Not Found","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/order"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"067c6645-1dbf-4286-9f63-48b3eedc4104","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/order"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"45177aeb-314a-4158-bfb7-da7b8b768abd","name":"Forbidden","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/order"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"6af322a0-d899-4721-8fbd-7601b8d3a316"}],"id":"43302aae-b671-45bd-9a84-dd2344e2e97d","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"e1fd6912-8e10-49c7-931b-fe392462ee9b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cf69989e-ce2d-4727-8b1a-4c8b84493684","type":"text/javascript","exec":[""]}}],"_postman_id":"43302aae-b671-45bd-9a84-dd2344e2e97d","description":""},{"name":"Update existing orders","id":"c53846ad-9b27-4600-a414-370e34dc7013","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Access_token ","description":"

We send the token type and access_token information in the authorization parameter.

\n","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"warehouse_code\": \"string\",\n \"custmer_code\": \"string\",\n \"order_code\": \"string\",\n \"address_code\": \"string\",\n \"deci\": 0,\n \"cargo_width\": 0,\n \"cargo_height\": 0,\n \"cargo_depth\": 0,\n \"cargo_weight\": 0,\n \"barcode\": \"string\",\n \"delivery_date\": \"2021-03-22T15:44:21.138Z\",\n \"order_date\": \"2021-03-22T15:44:21.138Z\",\n \"priority\": 0,\n \"products\": [\n {\n \"product_code\": \"string\",\n \"quantity\": 0\n }\n ]\n }\n]"},"url":"{{base}}/api/order","description":"

Update an existing order.

\n

The field list belonging to the order is available in Figure 2.

\n

Error Codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDefinition
E0001You must send all Required Fields.
E0002The field (fieldname) must have a maximum length of (maxlength)
E0003The customer code you want to create is already defined.
E0004There is no such warehouse.
E0005There is no such customer.
E0006There is no such product.
E0007There is no such address code.
\n
","urlObject":{"path":["api","order"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"8052cb60-fbb0-4777-8398-36953b900eab","name":"Forbidden","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/order"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"8c37e661-81d3-4f98-ad43-8d463815aa05","name":"Created","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/order"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"e3964879-6b9b-4969-8a30-c2aa1ae3fb1b","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw","description":"(Required) Bearer Access_token","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/order"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\":true,\n \"data\":[\n {\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T15:44:21.170Z\",\n \"lastupdated\":\"2021-03-22T15:44:21.171Z\",\n \"order_code\":\"string\",\n \"customer\":{\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T15:21:28.805Z\",\n \"lastupdated\":\"2021-03-22T15:21:28.805Z\",\n \"code\":\"string\",\n \"first_name\":\"string\",\n \"last_name\":\"string\",\n \"gsm_number\":\"string\",\n \"email\":\"string\",\n \"channel\":\"string\",\n \"addresses\":[\n {\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T15:21:28.805Z\",\n \"lastupdated\":\"2021-03-22T15:21:28.805Z\",\n \"code\":\"string\",\n \"address_code_ext\":\"string\",\n \"first_name\":\"string\",\n \"last_name\":\"string\",\n \"gsm_number\":\"string\",\n \"email\":\"string\",\n \"address\":\"string\",\n \"country\":\"string\",\n \"state\":\"string\",\n \"city\":\"string\",\n \"county\":\"string\",\n \"district\":\"string\",\n \"street\":\"string\",\n \"address_line\":\"string\",\n \"post_code\":\"string\",\n \"latitude\":0,\n \"longitude\":0\n }\n ],\n \"delivery_days\":\"string\",\n \"delivery_note\":\"string\"\n },\n \"warehouse\":{\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T14:53:46.414Z\",\n \"lastupdated\":\"2021-03-22T14:53:46.414Z\",\n \"code\":\"string\",\n \"name\":\"string\",\n \"address\":\"string\",\n \"country\":\"string\",\n \"state\":\"string\",\n \"city\":\"string\",\n \"county\":\"string\",\n \"district\":\"string\",\n \"street\":\"string\",\n \"address_line\":\"string\",\n \"latitude\":0,\n \"longitude\":0,\n \"post_code\":\"string\",\n \"special_1\":\"string\",\n \"special_2\":\"string\",\n \"special_3\":\"string\"\n },\n \"deci\":0,\n \"cargo_width\":0,\n \"cargo_height\":0,\n \"cargo_depth\":0,\n \"cargo_weight\":0,\n \"delivery_date\":\"2021-03-22T15:44:21.171Z\",\n \"order_date\":\"2021-03-22T15:44:21.171Z\",\n \"priority\":0,\n \"barcode\":\"string\",\n \"products\":[\n {\n \"code\":\"string\",\n \"name\":\"string\",\n \"quantity\":0,\n \"transfer_type\":\"string\",\n \"unit_quantity\":\"string\"\n }\n ]\n }\n ]\n}"},{"id":"c48a94d1-b449-4292-a9b2-de28a1e991d3","name":"Not Found","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/order"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"a2223426-cf01-4bbd-9731-4e239e81834b","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/order"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c53846ad-9b27-4600-a414-370e34dc7013"},{"name":"Create new order","id":"8c23f626-84a4-49da-8b41-506a2265fbf8","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Access_token ","description":"

We send the token type and access_token information in the authorization parameter.

\n","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"warehouse_code\": \"string\",\n \"customer_code\": \"string\",\n \"order_code\": \"string\",\n \"address_code\": \"string\",\n \"deci\": 0,\n \"cargo_width\": 0,\n \"cargo_height\": 0,\n \"cargo_depth\": 0,\n \"cargo_weight\": 0,\n \"barcode\": \"string\",\n \"delivery_date\": \"2021-03-22T15:44:21.138Z\",\n \"order_date\": \"2021-03-22T15:44:21.138Z\",\n \"priority\": 0,\n \"products\": [\n {\n \"product_code\": \"string\",\n \"quantity\": 0\n }\n ]\n }\n]"},"url":"{{base}}/api/order","description":"

Create a new order.

\n

The field list belonging to the order is available in Figure 2.

\n

Error Codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDefinition
E0001You must send all Required Fields.
E0002The field (fieldname) must have a maximum length of (maxlength)
E0003The customer code you want to create is already defined.
E0004There is no such warehouse.
E0005There is no such customer.
E0006There is no such product.
E0007There is no such address code.
\n
","urlObject":{"path":["api","order"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"00ca0dff-2019-410b-bc3e-4f61c2e2a2d3","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw","description":"(Required) Bearer Access_token ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/order"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\":true,\n \"data\":[\n {\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T15:44:21.170Z\",\n \"lastupdated\":\"2021-03-22T15:44:21.171Z\",\n \"order_code\":\"string\",\n \"customer\":{\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T15:21:28.805Z\",\n \"lastupdated\":\"2021-03-22T15:21:28.805Z\",\n \"code\":\"string\",\n \"first_name\":\"string\",\n \"last_name\":\"string\",\n \"gsm_number\":\"string\",\n \"email\":\"string\",\n \"channel\":\"string\",\n \"addresses\":[\n {\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T15:21:28.805Z\",\n \"lastupdated\":\"2021-03-22T15:21:28.805Z\",\n \"code\":\"string\",\n \"address_code_ext\":\"string\",\n \"first_name\":\"string\",\n \"last_name\":\"string\",\n \"gsm_number\":\"string\",\n \"email\":\"string\",\n \"address\":\"string\",\n \"country\":\"string\",\n \"state\":\"string\",\n \"city\":\"string\",\n \"county\":\"string\",\n \"district\":\"string\",\n \"street\":\"string\",\n \"address_line\":\"string\",\n \"post_code\":\"string\",\n \"latitude\":0,\n \"longitude\":0\n }\n ],\n \"delivery_days\":\"string\",\n \"delivery_note\":\"string\"\n },\n \"warehouse\":{\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T14:53:46.414Z\",\n \"lastupdated\":\"2021-03-22T14:53:46.414Z\",\n \"code\":\"string\",\n \"name\":\"string\",\n \"address\":\"string\",\n \"country\":\"string\",\n \"state\":\"string\",\n \"city\":\"string\",\n \"county\":\"string\",\n \"district\":\"string\",\n \"street\":\"string\",\n \"address_line\":\"string\",\n \"latitude\":0,\n \"longitude\":0,\n \"post_code\":\"string\",\n \"special_1\":\"string\",\n \"special_2\":\"string\",\n \"special_3\":\"string\"\n },\n \"deci\":0,\n \"cargo_width\":0,\n \"cargo_height\":0,\n \"cargo_depth\":0,\n \"cargo_weight\":0,\n \"delivery_date\":\"2021-03-22T15:44:21.171Z\",\n \"order_date\":\"2021-03-22T15:44:21.171Z\",\n \"priority\":0,\n \"barcode\":\"string\",\n \"products\":[\n {\n \"code\":\"string\",\n \"name\":\"string\",\n \"quantity\":0,\n \"transfer_type\":\"string\",\n \"unit_quantity\":\"string\"\n }\n ]\n }\n ]\n}"},{"id":"5f500ddb-0934-4996-ba05-be234d62915f","name":"Not Found","originalRequest":{"method":"PUT","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/order"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"e86119aa-e78c-401c-bd10-5b418fa568cf","name":"Created","originalRequest":{"method":"PUT","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/ecmascript","type":"text"}],"url":"{{base}}/api/order"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"791ce488-07de-47ee-ab0f-db26eaf78140","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/order"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"263a13f7-58b4-4516-9cc8-52ec91b7ccf4","name":"Forbidden","originalRequest":{"method":"PUT","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/order"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8c23f626-84a4-49da-8b41-506a2265fbf8"},{"name":"Get orders by warehouse_code and date","id":"60c9dba3-0491-421e-bb73-4ef67bd2760a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Access_token","description":"

We send the token type and access_token information in the authorization parameter.

\n","type":"text"}],"url":"{{base}}/api/order/date-between?warehouse_code=&start=&end=","description":"

Get orders of a warehouse on a given date.

\n","urlObject":{"path":["api","order","date-between"],"host":["{{base}}"],"query":[{"description":{"content":"

(Required) Warehouse code

\n","type":"text/plain"},"key":"warehouse_code","value":""},{"description":{"content":"

(Required) Start time (sample: 2021-03-22T15:21:28.805Z)

\n","type":"text/plain"},"key":"start","value":""},{"description":{"content":"

(Required) End time (sample: 2021-03-22T15:21:28.805Z)

\n","type":"text/plain"},"key":"end","value":""}],"variable":[]}},"response":[{"id":"33dddfb1-f888-4a9f-9473-e6190157a5aa","name":"Forbidden","originalRequest":{"method":"GET","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/order/date-between?warehouse_code=&start=1983-08-10T10:44:55.868Z&end=1983-08-10T10:44:55.868Z","host":["{{base}}"],"path":["api","order","date-between"],"query":[{"key":"warehouse_code","value":""},{"key":"start","value":"1983-08-10T10:44:55.868Z"},{"key":"end","value":"1983-08-10T10:44:55.868Z"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"d8b3dd50-9526-4bef-b3db-0e0ce49f4409","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw","description":"(Required) Bearer Access_token ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/order/date-between?warehouse_code=&end=1983-08-10T10:44:55.868Z&start=1983-08-10T10:44:55.868Z","host":["{{base}}"],"path":["api","order","date-between"],"query":[{"key":"warehouse_code","value":""},{"key":"end","value":"1983-08-10T10:44:55.868Z"},{"key":"start","value":"1983-08-10T10:44:55.868Z"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\":true,\n \"data\":[\n {\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T15:44:21.170Z\",\n \"lastupdated\":\"2021-03-22T15:44:21.171Z\",\n \"order_code\":\"string\",\n \"customer\":{\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T15:21:28.805Z\",\n \"lastupdated\":\"2021-03-22T15:21:28.805Z\",\n \"code\":\"string\",\n \"first_name\":\"string\",\n \"last_name\":\"string\",\n \"gsm_number\":\"string\",\n \"email\":\"string\",\n \"channel\":\"string\",\n \"addresses\":[\n {\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T15:21:28.805Z\",\n \"lastupdated\":\"2021-03-22T15:21:28.805Z\",\n \"code\":\"string\",\n \"address_code_ext\":\"string\",\n \"first_name\":\"string\",\n \"last_name\":\"string\",\n \"gsm_number\":\"string\",\n \"email\":\"string\",\n \"address\":\"string\",\n \"country\":\"string\",\n \"state\":\"string\",\n \"city\":\"string\",\n \"county\":\"string\",\n \"district\":\"string\",\n \"street\":\"string\",\n \"address_line\":\"string\",\n \"post_code\":\"string\",\n \"latitude\":0,\n \"longitude\":0\n }\n ],\n \"delivery_days\":\"string\",\n \"delivery_note\":\"string\"\n },\n \"warehouse\":{\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T14:53:46.414Z\",\n \"lastupdated\":\"2021-03-22T14:53:46.414Z\",\n \"code\":\"string\",\n \"name\":\"string\",\n \"address\":\"string\",\n \"country\":\"string\",\n \"state\":\"string\",\n \"city\":\"string\",\n \"county\":\"string\",\n \"district\":\"string\",\n \"street\":\"string\",\n \"address_line\":\"string\",\n \"latitude\":0,\n \"longitude\":0,\n \"post_code\":\"string\",\n \"special_1\":\"string\",\n \"special_2\":\"string\",\n \"special_3\":\"string\"\n },\n \"deci\":0,\n \"cargo_width\":0,\n \"cargo_height\":0,\n \"cargo_depth\":0,\n \"cargo_weight\":0,\n \"delivery_date\":\"2021-03-22T15:44:21.171Z\",\n \"order_date\":\"2021-03-22T15:44:21.171Z\",\n \"priority\":0,\n \"barcode\":\"string\",\n \"products\":[\n {\n \"code\":\"string\",\n \"name\":\"string\",\n \"quantity\":0,\n \"transfer_type\":\"string\",\n \"unit_quantity\":\"string\"\n }\n ]\n }\n ]\n}"},{"id":"045d1e65-51bc-4a8d-97a3-4d5f7d685874","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/order/date-between?warehouse_code=&start=1983-08-10T10:44:55.868Z&end=1983-08-10T10:44:55.868Z","host":["{{base}}"],"path":["api","order","date-between"],"query":[{"key":"warehouse_code","value":""},{"key":"start","value":"1983-08-10T10:44:55.868Z"},{"key":"end","value":"1983-08-10T10:44:55.868Z"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"ea3ecd30-1104-430b-b6f7-353fff079503","name":"Not Found","originalRequest":{"method":"GET","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/order/date-between?warehouse_code=&start=1983-08-10T10:44:55.868Z&end=1983-08-10T10:44:55.868Z","host":["{{base}}"],"path":["api","order","date-between"],"query":[{"key":"warehouse_code","value":""},{"key":"start","value":"1983-08-10T10:44:55.868Z"},{"key":"end","value":"1983-08-10T10:44:55.868Z"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"60c9dba3-0491-421e-bb73-4ef67bd2760a"},{"name":"Create or update orders","id":"87922280-027f-4c61-82c2-a278285a19f7","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Access_token ","description":"

We send the token type and access_token information in the authorization parameter.

\n","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"warehouse_code\": \"string\",\n \"customer_code\": \"string\",\n \"address_code\": \"string\",\n \"address_code_ext\": \"string\",\n \"order_code\": \"string\",\n \"customer_first_name\": \"string\",\n \"customer_last_name\": \"string\",\n \"channel\": \"string\",\n \"customer_gsm_number\": 0,\n \"customer_email\": \"string\",\n \"receiver_first_name\": \"string\",\n \"receiver_last_name\": \"string\",\n \"receiver_gsm_number\": 0,\n \"receiver_email\": \"string\",\n \"address\": \"string\",\n \"country\": \"string\",\n \"state\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"district\": \"string\",\n \"street\": \"string\",\n \"address_line\": \"string\",\n \"post_code\": \"string\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"deci\": 0,\n \"cargo_width\": 0,\n \"cargo_height\": 0,\n \"cargo_depth\": 0,\n \"cargo_weight\": 0,\n \"delivery_date\": \"2021-03-22T14:47:48.972Z\",\n \"order_date\": \"2021-03-22T14:47:48.972Z\",\n \"priority\": 0,\n \"barcode\": \"string\",\n \"products\": [\n {\n \"product_code\": \"string\",\n \"product_name\": \"string\",\n \"quantity\": 1,\n \"quantity_unit\": \"string\",\n \"transfer_type\": \"string\"\n }\n ],\n \"delivery_days\": \"2021-03-22T14:47:48.972Z\",\n \"delivery_note\": \"string\"\n }\n]"},"url":"{{base}}/api/order/general","description":"

It allows to create order information together with customer and product information in one go.

\n

Error Codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDefinition
E0001You must send all required fields.
E0002The field (fieldname) must have a maximum length of (maxlength)
E0004There is no such warehouse.
\n
","urlObject":{"path":["api","order","general"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"c89c8156-acda-4630-8e6c-2c51f20ecc04","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"address\": \"string\",\n \"address_code\": \"string\",\n \"city\": \"string\",\n \"country\": \"string\",\n \"county\": \"string\",\n \"customer_code\": \"string\",\n \"customer_name\": \"string\",\n \"delivery_date\": \"2014-02-11T12:36:19.193Z\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"order_code\": \"string\",\n \"warehouse_code\": \"string\",\n \"address_line\": \"string\",\n \"barcode\": \"string\",\n \"cargo_depth\": 0,\n \"cargo_height\": 0,\n \"cargo_weight\": 0,\n \"cargo_width\": 0,\n \"channel\": \"string\",\n \"deci\": 0,\n \"delivery_days\": \"1984-11-28T08:46:43.042Z\",\n \"delivery_note\": \"string\",\n \"district\": \"string\",\n \"email\": \"string\",\n \"gsm_number\": \"string\",\n \"order_date\": \"1947-10-09T19:49:03.347Z\",\n \"post_code\": \"string\",\n \"priority\": 0,\n \"products\": [\n {\n \"code\": \"string\",\n \"name\": \"string\",\n \"package_type\": \"string\",\n \"quantity\": 1,\n \"transfer_type\": \"string\"\n },\n {\n \"code\": \"string\",\n \"name\": \"string\",\n \"package_type\": \"string\",\n \"quantity\": 1,\n \"transfer_type\": \"string\"\n }\n ],\n \"state\": \"string\",\n \"street\": \"string\"\n },\n {\n \"address\": \"string\",\n \"address_code\": \"string\",\n \"city\": \"string\",\n \"country\": \"string\",\n \"county\": \"string\",\n \"customer_code\": \"string\",\n \"customer_name\": \"string\",\n \"delivery_date\": \"1984-11-28T08:46:43.042Z\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"order_code\": \"string\",\n \"warehouse_code\": \"string\",\n \"address_line\": \"string\",\n \"barcode\": \"string\",\n \"cargo_depth\": 0,\n \"cargo_height\": 0,\n \"cargo_weight\": 0,\n \"cargo_width\": 0,\n \"channel\": \"string\",\n \"deci\": 0,\n \"delivery_days\": \"2021-03-22T15:44:21.138Z\",\n \"delivery_note\": \"string\",\n \"district\": \"string\",\n \"email\": \"string\",\n \"gsm_number\": \"string\",\n \"order_date\": \"1987-03-30T13:44:43.666Z\",\n \"post_code\": \"string\",\n \"priority\": 0,\n \"products\": [\n {\n \"code\": \"string\",\n \"name\": \"string\",\n \"package_type\": \"string\",\n \"quantity\": 1,\n \"transfer_type\": \"string\"\n },\n {\n \"code\": \"string\",\n \"name\": \"string\",\n \"package_type\": \"string\",\n \"quantity\": 1,\n \"transfer_type\": \"string\"\n }\n ],\n \"state\": \"string\",\n \"street\": \"string\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/order/general"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"b9cd21f1-1ef6-4cb7-9b55-f1a8c52f6a52","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw","description":"(Required) Bearer Access_token ","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"address\": \"string\",\n \"address_code\": \"string\",\n \"city\": \"string\",\n \"country\": \"string\",\n \"county\": \"string\",\n \"customer_code\": \"string\",\n \"customer_name\": \"string\",\n \"delivery_date\": \"2014-02-11T12:36:19.193Z\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"order_code\": \"string\",\n \"warehouse_code\": \"string\",\n \"address_line\": \"string\",\n \"barcode\": \"string\",\n \"cargo_depth\": 0,\n \"cargo_height\": 0,\n \"cargo_weight\": 0,\n \"cargo_width\": 0,\n \"channel\": \"string\",\n \"deci\": -27139689.287624553,\n \"delivery_days\": \"1984-11-28T08:46:43.042Z\",\n \"delivery_note\": \"string\",\n \"district\": \"string\",\n \"email\": \"string\",\n \"gsm_number\": \"string\",\n \"order_date\": \"1947-10-09T19:49:03.347Z\",\n \"post_code\": \"string\",\n \"priority\": 0,\n \"products\": [\n {\n \"code\": \"string\",\n \"name\": \"string\",\n \"package_type\": \"string\",\n \"quantity\": 1,\n \"transfer_type\": \"string\"\n },\n {\n \"code\": \"string\",\n \"name\": \"string\",\n \"package_type\": \"string\",\n \"quantity\": 1,\n \"transfer_type\": \"string\"\n }\n ],\n \"state\": \"string\",\n \"street\": \"string\"\n },\n {\n \"address\": \"string\",\n \"address_code\": \"string\",\n \"city\": \"string\",\n \"country\": \"string\",\n \"county\": \"string\",\n \"customer_code\": \"string\",\n \"customer_name\": \"string\",\n \"delivery_date\": \"1984-11-28T08:46:43.042Z\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"order_code\": \"string\",\n \"warehouse_code\": \"string\",\n \"address_line\": \"string\",\n \"barcode\": \"string\",\n \"cargo_depth\": 0,\n \"cargo_height\": 0,\n \"cargo_weight\": 0,\n \"cargo_width\": 0,\n \"channel\": \"string\",\n \"deci\": 0,\n \"delivery_days\": \"2021-03-22T15:44:21.138Z\",\n \"delivery_note\": \"string\",\n \"district\": \"string\",\n \"email\": \"string\",\n \"gsm_number\": \"string\",\n \"order_date\": \"1987-03-30T13:44:43.666Z\",\n \"post_code\": \"string\",\n \"priority\": 0,\n \"products\": [\n {\n \"code\": \"string\",\n \"name\": \"string\",\n \"package_type\": \"string\",\n \"quantity\": 1,\n \"transfer_type\": \"string\"\n },\n {\n \"code\": \"string\",\n \"name\": \"string\",\n \"package_type\": \"string\",\n \"quantity\": 1,\n \"transfer_type\": \"string\"\n }\n ],\n \"state\": \"string\",\n \"street\": \"string\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/order/general"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\":true,\n \"data\":[\n {\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T15:44:21.170Z\",\n \"lastupdated\":\"2021-03-22T15:44:21.171Z\",\n \"order_code\":\"string\",\n \"customer\":{\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T15:21:28.805Z\",\n \"lastupdated\":\"2021-03-22T15:21:28.805Z\",\n \"code\":\"string\",\n \"first_name\":\"string\",\n \"last_name\":\"string\",\n \"gsm_number\":\"string\",\n \"email\":\"string\",\n \"channel\":\"string\",\n \"addresses\":[\n {\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T15:21:28.805Z\",\n \"lastupdated\":\"2021-03-22T15:21:28.805Z\",\n \"code\":\"string\",\n \"address_code_ext\":\"string\",\n \"first_name\":\"string\",\n \"last_name\":\"string\",\n \"gsm_number\":\"string\",\n \"email\":\"string\",\n \"address\":\"string\",\n \"country\":\"string\",\n \"state\":\"string\",\n \"city\":\"string\",\n \"county\":\"string\",\n \"district\":\"string\",\n \"street\":\"string\",\n \"address_line\":\"string\",\n \"post_code\":\"string\",\n \"latitude\":0,\n \"longitude\":0\n }\n ],\n \"delivery_days\":\"string\",\n \"delivery_note\":\"string\"\n },\n \"warehouse\":{\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T14:53:46.414Z\",\n \"lastupdated\":\"2021-03-22T14:53:46.414Z\",\n \"code\":\"string\",\n \"name\":\"string\",\n \"address\":\"string\",\n \"country\":\"string\",\n \"state\":\"string\",\n \"city\":\"string\",\n \"county\":\"string\",\n \"district\":\"string\",\n \"street\":\"string\",\n \"address_line\":\"string\",\n \"latitude\":0,\n \"longitude\":0,\n \"post_code\":\"string\",\n \"special_1\":\"string\",\n \"special_2\":\"string\",\n \"special_3\":\"string\"\n },\n \"deci\":0,\n \"cargo_width\":0,\n \"cargo_height\":0,\n \"cargo_depth\":0,\n \"cargo_weight\":0,\n \"delivery_date\":\"2021-03-22T15:44:21.171Z\",\n \"order_date\":\"2021-03-22T15:44:21.171Z\",\n \"priority\":0,\n \"barcode\":\"string\",\n \"products\":[\n {\n \"code\":\"string\",\n \"name\":\"string\",\n \"quantity\":0,\n \"transfer_type\":\"string\",\n \"unit_quantity\":\"string\"\n }\n ]\n }\n ]\n}"},{"id":"bfcf050f-8aee-45ae-9408-444cb2cf7539","name":"Forbidden","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"address\": \"string\",\n \"address_code\": \"string\",\n \"city\": \"string\",\n \"country\": \"string\",\n \"county\": \"string\",\n \"customer_code\": \"string\",\n \"customer_name\": \"string\",\n \"delivery_date\": \"2014-02-11T12:36:19.193Z\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"order_code\": \"string\",\n \"warehouse_code\": \"string\",\n \"address_line\": \"string\",\n \"barcode\": \"string\",\n \"cargo_depth\": 0,\n \"cargo_height\": 0,\n \"cargo_weight\": 0,\n \"cargo_width\": 0,\n \"channel\": \"string\",\n \"deci\": -27139689.287624553,\n \"delivery_days\": \"1984-11-28T08:46:43.042Z\",\n \"delivery_note\": \"string\",\n \"district\": \"string\",\n \"email\": \"string\",\n \"gsm_number\": \"string\",\n \"order_date\": \"1947-10-09T19:49:03.347Z\",\n \"post_code\": \"string\",\n \"priority\": 0,\n \"products\": [\n {\n \"code\": \"string\",\n \"name\": \"string\",\n \"package_type\": \"string\",\n \"quantity\": 1,\n \"transfer_type\": \"string\"\n },\n {\n \"code\": \"string\",\n \"name\": \"string\",\n \"package_type\": \"string\",\n \"quantity\": 1,\n \"transfer_type\": \"string\"\n }\n ],\n \"state\": \"string\",\n \"street\": \"string\"\n },\n {\n \"address\": \"string\",\n \"address_code\": \"string\",\n \"city\": \"string\",\n \"country\": \"string\",\n \"county\": \"string\",\n \"customer_code\": \"string\",\n \"customer_name\": \"string\",\n \"delivery_date\": \"1984-11-28T08:46:43.042Z\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"order_code\": \"string\",\n \"warehouse_code\": \"string\",\n \"address_line\": \"string\",\n \"barcode\": \"string\",\n \"cargo_depth\": 0,\n \"cargo_height\": 0,\n \"cargo_weight\": 0,\n \"cargo_width\": 0,\n \"channel\": \"string\",\n \"deci\": 0,\n \"delivery_days\": \"2021-03-22T15:44:21.138Z\",\n \"delivery_note\": \"string\",\n \"district\": \"string\",\n \"email\": \"string\",\n \"gsm_number\": \"string\",\n \"order_date\": \"1987-03-30T13:44:43.666Z\",\n \"post_code\": \"string\",\n \"priority\": 0,\n \"products\": [\n {\n \"code\": \"string\",\n \"name\": \"string\",\n \"package_type\": \"string\",\n \"quantity\": 1,\n \"transfer_type\": \"string\"\n },\n {\n \"code\": \"string\",\n \"name\": \"string\",\n \"package_type\": \"string\",\n \"quantity\": 1,\n \"transfer_type\": \"string\"\n }\n ],\n \"state\": \"string\",\n \"street\": \"string\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/order/general"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"b745b85a-0d11-4993-b227-014066dec1a3","name":"Created","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"address\": \"string\",\n \"address_code\": \"string\",\n \"city\": \"string\",\n \"country\": \"string\",\n \"county\": \"string\",\n \"customer_code\": \"string\",\n \"customer_name\": \"string\",\n \"delivery_date\": \"2014-02-11T12:36:19.193Z\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"order_code\": \"string\",\n \"warehouse_code\": \"string\",\n \"address_line\": \"string\",\n \"barcode\": \"string\",\n \"cargo_depth\": 0,\n \"cargo_height\": 0,\n \"cargo_weight\": 0,\n \"cargo_width\": 0,\n \"channel\": \"string\",\n \"deci\": -27139689.287624553,\n \"delivery_days\": \"1984-11-28T08:46:43.042Z\",\n \"delivery_note\": \"string\",\n \"district\": \"string\",\n \"email\": \"string\",\n \"gsm_number\": \"string\",\n \"order_date\": \"1947-10-09T19:49:03.347Z\",\n \"post_code\": \"string\",\n \"priority\": 0,\n \"products\": [\n {\n \"code\": \"string\",\n \"name\": \"string\",\n \"package_type\": \"string\",\n \"quantity\": 1,\n \"transfer_type\": \"string\"\n },\n {\n \"code\": \"string\",\n \"name\": \"string\",\n \"package_type\": \"string\",\n \"quantity\": 1,\n \"transfer_type\": \"string\"\n }\n ],\n \"state\": \"string\",\n \"street\": \"string\"\n },\n {\n \"address\": \"string\",\n \"address_code\": \"string\",\n \"city\": \"string\",\n \"country\": \"string\",\n \"county\": \"string\",\n \"customer_code\": \"string\",\n \"customer_name\": \"string\",\n \"delivery_date\": \"1984-11-28T08:46:43.042Z\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"order_code\": \"string\",\n \"warehouse_code\": \"string\",\n \"address_line\": \"string\",\n \"barcode\": \"string\",\n \"cargo_depth\": 0,\n \"cargo_height\": 0,\n \"cargo_weight\": 0,\n \"cargo_width\": 0,\n \"channel\": \"string\",\n \"deci\": 0,\n \"delivery_days\": \"2021-03-22T15:44:21.138Z\",\n \"delivery_note\": \"string\",\n \"district\": \"string\",\n \"email\": \"string\",\n \"gsm_number\": \"string\",\n \"order_date\": \"1987-03-30T13:44:43.666Z\",\n \"post_code\": \"string\",\n \"priority\": 0,\n \"products\": [\n {\n \"code\": \"string\",\n \"name\": \"string\",\n \"package_type\": \"string\",\n \"quantity\": 1,\n \"transfer_type\": \"string\"\n },\n {\n \"code\": \"string\",\n \"name\": \"string\",\n \"package_type\": \"string\",\n \"quantity\": 1,\n \"transfer_type\": \"string\"\n }\n ],\n \"state\": \"string\",\n \"street\": \"string\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/order/general"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"8a314e45-72ec-4b08-8dab-55e4892a0837","name":"Not Found","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"address\": \"string\",\n \"address_code\": \"string\",\n \"city\": \"string\",\n \"country\": \"string\",\n \"county\": \"string\",\n \"customer_code\": \"string\",\n \"customer_name\": \"string\",\n \"delivery_date\": \"2014-02-11T12:36:19.193Z\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"order_code\": \"string\",\n \"warehouse_code\": \"string\",\n \"address_line\": \"string\",\n \"barcode\": \"string\",\n \"cargo_depth\": 0,\n \"cargo_height\": 0,\n \"cargo_weight\": 0,\n \"cargo_width\": 0,\n \"channel\": \"string\",\n \"deci\": -27139689.287624553,\n \"delivery_days\": \"1984-11-28T08:46:43.042Z\",\n \"delivery_note\": \"string\",\n \"district\": \"string\",\n \"email\": \"string\",\n \"gsm_number\": \"string\",\n \"order_date\": \"1947-10-09T19:49:03.347Z\",\n \"post_code\": \"string\",\n \"priority\": 0,\n \"products\": [\n {\n \"code\": \"string\",\n \"name\": \"string\",\n \"package_type\": \"string\",\n \"quantity\": 1,\n \"transfer_type\": \"string\"\n },\n {\n \"code\": \"string\",\n \"name\": \"string\",\n \"package_type\": \"string\",\n \"quantity\": 1,\n \"transfer_type\": \"string\"\n }\n ],\n \"state\": \"string\",\n \"street\": \"string\"\n },\n {\n \"address\": \"string\",\n \"address_code\": \"string\",\n \"city\": \"string\",\n \"country\": \"string\",\n \"county\": \"string\",\n \"customer_code\": \"string\",\n \"customer_name\": \"string\",\n \"delivery_date\": \"1984-11-28T08:46:43.042Z\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"order_code\": \"string\",\n \"warehouse_code\": \"string\",\n \"address_line\": \"string\",\n \"barcode\": \"string\",\n \"cargo_depth\": 0,\n \"cargo_height\": 0,\n \"cargo_weight\": 0,\n \"cargo_width\": 0,\n \"channel\": \"string\",\n \"deci\": 0,\n \"delivery_days\": \"2021-03-22T15:44:21.138Z\",\n \"delivery_note\": \"string\",\n \"district\": \"string\",\n \"email\": \"string\",\n \"gsm_number\": \"string\",\n \"order_date\": \"1987-03-30T13:44:43.666Z\",\n \"post_code\": \"string\",\n \"priority\": 0,\n \"products\": [\n {\n \"code\": \"string\",\n \"name\": \"string\",\n \"package_type\": \"string\",\n \"quantity\": 1,\n \"transfer_type\": \"string\"\n },\n {\n \"code\": \"string\",\n \"name\": \"string\",\n \"package_type\": \"string\",\n \"quantity\": 1,\n \"transfer_type\": \"string\"\n }\n ],\n \"state\": \"string\",\n \"street\": \"string\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/order/general"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"87922280-027f-4c61-82c2-a278285a19f7"}],"id":"9696202c-25be-4288-9ba3-6be82d469fa4","description":"

Order includes the items to be delivered to the customer (or the outlet)

\n

Followings are the fields that will be provided for each order record:

\n

Field List

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Field NameRequiredData Type and SizeDefinition
warehouse_code✔String, 0 < length < 32Warehouse code to which the order belongs.
customer_code✔String, 0 < length < 32Customer code to which the order will be delivered.
order_code✔String, 0 < length < 32The code of the order that is used in the seller database.
product_code✔String, 0 < length < 32Product code to which the order belongs.
quantity✔IntegerQuantity of the order (shall match Quantity unit of the product in PRODUCT table).
address_code✔String, NOT NULL, 0 < length < 32Address information is given in the customer section.
deciIntegerVolumetric weight of the cargo.
cargo_widthIntegerWidth of the cargo in centimeters.
cargo_heightIntegerHeight of the cargo in centimeters.
cargo_depthIntegerDepth of the cargo in centimeters.
cargo_weightIntegerWeight of the product in grams.
priorityString, length; 0 or 1Priority in delivery (considered when all packages can not be delivered as planned). 0 = Normal 1 = High priority
barcodeString, 0 < length < 100UPC-A barcode consists of 12 numeric digits that are uniquely assigned to each order item. For example; 811204012344.
order_dateDateTimeDatetime of the order. For example: 2021-03-22T15:44:21.138Z
delivery_dateDateTimeRequested delivery date. For example: 2021-03-22T15:44:21.138Z
\n

Figure 2: Order Field List

\n","_postman_id":"9696202c-25be-4288-9ba3-6be82d469fa4"},{"name":"Product","item":[{"name":"{warehouse Code}/{code}","item":[{"name":"Get product by warehouse code and code.","id":"35ddd934-5682-4a8a-9d9f-a9bd7eb59e69","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Access_token ","description":"

We send the token type and access_token information in the authorization parameter.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"warehouse_code\":\"string\",\r\n \"code\": \"string\"\r\n}"},"url":"{{base}}/api/product/:warehouse_code/:code","description":"

Get product by warehouse by code.

\n

Error Codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDefinition
E0004There is no such warehouse.
E0005There is no such product.
\n
","urlObject":{"path":["api","product",":warehouse_code",":code"],"host":["{{base}}"],"query":[],"variable":[{"description":{"content":"

(Required) Warehouse code

\n","type":"text/plain"},"type":"any","value":"","key":"warehouse_code"},{"description":{"content":"

(Required) Product code

\n","type":"text/plain"},"type":"any","value":"","key":"code"}]}},"response":[{"id":"1b01dea5-1980-4fbe-973f-9da8554a6516","name":"Forbidden","originalRequest":{"method":"GET","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/product/:warehouse_code/:code","host":["{{base}}"],"path":["api","product",":warehouse_code",":code"],"variable":[{"key":"warehouse_code","value":""},{"key":"code"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"3d194924-66e1-42a4-838a-6c685c8b2fb0","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw","description":"(Required) Bearer Access_token ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/product/:warehouse_code/:code","host":["{{base}}"],"path":["api","product",":warehouse_code",":code"],"variable":[{"key":"warehouse_code","value":""},{"key":"code","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\":true,\n \"data\":[\n {\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T15:13:06.920Z\",\n \"lastupdated\":\"2021-03-22T15:13:06.920Z\",\n \"code\":\"string\",\n \"name\":\"string\",\n \"warehouse\":{\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T14:53:46.414Z\",\n \"lastupdated\":\"2021-03-22T14:53:46.414Z\",\n \"code\":\"string\",\n \"name\":\"string\",\n \"address\":\"string\",\n \"country\":\"string\",\n \"state\":\"string\",\n \"city\":\"string\",\n \"county\":\"string\",\n \"district\":\"string\",\n \"street\":\"string\",\n \"address_line\":\"string\",\n \"latitude\":0,\n \"longitude\":0,\n \"post_code\":\"string\",\n \"special_1\":\"string\",\n \"special_2\":\"string\",\n \"special_3\":\"string\"\n },\n \"quantity_unit\":\"string\",\n \"quantity\":0,\n \"transfer_type\":\"string\",\n \"deci\":0,\n \"cargo_width\":0,\n \"cargo_height\":0,\n \"cargo_depth\":0,\n \"cargo_weight\":0\n }\n ]\n}"},{"id":"64203eff-ffae-4f75-af4d-bc967209aecd","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/product/:warehouse_code/:code","host":["{{base}}"],"path":["api","product",":warehouse_code",":code"],"variable":[{"key":"warehouse_code","value":""},{"key":"code"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"f4ed8c90-8b1a-4f57-a173-4eee9ef33cff","name":"Not Found","originalRequest":{"method":"GET","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/product/:warehouse_code/:code","host":["{{base}}"],"path":["api","product",":warehouse_code",":code"],"variable":[{"key":"warehouse_code","value":""},{"key":"code"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"35ddd934-5682-4a8a-9d9f-a9bd7eb59e69"},{"name":"Delete product by warehouse code and code.","id":"86ec479b-bd55-47aa-8f53-b5c98ac2f00a","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Access_token","description":"

We send the token type and access_token information in the authorization parameter.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"warehouse_code\":\"string\",\r\n \"code\": \"string\"\r\n}"},"url":"{{base}}/api/product/:warehouse_code/:code","description":"

Delete product by warehouse_code and code.

\n

Error Codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDefinition
E0004There is no such warehouse.
E0005There is no such product.
\n
","urlObject":{"path":["api","product",":warehouse_code",":code"],"host":["{{base}}"],"query":[],"variable":[{"description":{"content":"

(Required) Warehouse code

\n","type":"text/plain"},"type":"any","value":"","key":"warehouse_code"},{"description":{"content":"

(Required) Product code

\n","type":"text/plain"},"type":"string","value":"","key":"code"}]}},"response":[{"id":"61052b2b-cecf-4555-af2a-8040ddefec2a","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"(Required) Bearer Access_token","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/product/:warehouse_code/:code","host":["{{base}}"],"path":["api","product",":warehouse_code",":code"],"variable":[{"key":"warehouse_code","value":""},{"key":"code"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"62976a67-41ce-4cca-8e9b-f892196a6476","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"(Required) Bearer Access_token","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/product/:warehouse_code/:code","host":["{{base}}"],"path":["api","product",":warehouse_code",":code"],"variable":[{"key":"warehouse_code","value":""},{"key":"code"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"6ff7a798-1ee0-4ead-be44-8f1f5da46593","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw","description":"(Required) Bearer Access_token","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/product/:warehouse_code/:code","host":["{{base}}"],"path":["api","product",":warehouse_code",":code"],"variable":[{"key":"warehouse_code","value":""},{"key":"code"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\":true,\n \"data\":[\n {\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T15:13:06.920Z\",\n \"lastupdated\":\"2021-03-22T15:13:06.920Z\",\n \"code\":\"string\",\n \"name\":\"string\",\n \"warehouse\":{\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T14:53:46.414Z\",\n \"lastupdated\":\"2021-03-22T14:53:46.414Z\",\n \"code\":\"string\",\n \"name\":\"string\",\n \"address\":\"string\",\n \"country\":\"string\",\n \"state\":\"string\",\n \"city\":\"string\",\n \"county\":\"string\",\n \"district\":\"string\",\n \"street\":\"string\",\n \"address_line\":\"string\",\n \"latitude\":0,\n \"longitude\":0,\n \"post_code\":\"string\",\n \"special_1\":\"string\",\n \"special_2\":\"string\",\n \"special_3\":\"string\"\n },\n \"quantity_unit\":\"string\",\n \"quantity\":0,\n \"transfer_type\":\"string\",\n \"deci\":0,\n \"cargo_width\":0,\n \"cargo_height\":0,\n \"cargo_depth\":0,\n \"cargo_weight\":0\n }\n ]\n}"},{"id":"cb8071c7-8c6e-4aa9-9b63-ff39b6a624a8","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"description":"(Required) Bearer Access_token","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/product/:warehouse_code/:code","host":["{{base}}"],"path":["api","product",":warehouse_code",":code"],"variable":[{"key":"warehouse_code","value":""},{"key":"code"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"86ec479b-bd55-47aa-8f53-b5c98ac2f00a"}],"id":"7cd30691-a994-4d53-a30c-cdfea68110e7","_postman_id":"7cd30691-a994-4d53-a30c-cdfea68110e7","description":""},{"name":"Update existing product","id":"ae61e836-4dcd-413d-8d77-23da3fc9ae59","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Access_token ","description":"

We send the token type and access_token information in the authorization parameter.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"code\": \"string\",\n \"name\": \"string\",\n \"warehouse_code\": \"string\",\n \"quantity_unit\": \"string\",\n \"transfer_type\": \"string\",\n \"quantity\": 0,\n \"deci\": 0,\n \"cargo_width\": 0,\n \"cargo_height\": 0,\n \"cargo_depth\": 0,\n \"cargo_weight\": 0\n}"},"url":"{{base}}/api/product","description":"

Update an existing product.

\n

Error Codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDefinition
E0001You must send all Required Fields.
E0002The field (fieldname) must have a maximum length of (maxlength)
E0004There is no such warehouse.
E0005There is no such product.
\n

The field list belonging to the product is available in Figure 3.

\n","urlObject":{"path":["api","product"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"083e0e1e-1bf9-4df7-b3f9-e23e525b6d81","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/product"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"3b801ee0-eabf-4215-b7c0-c901363e47a2","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw","description":"(Required) Bearer Access_token","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/product"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\":true,\n \"data\":[\n {\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T15:13:06.920Z\",\n \"lastupdated\":\"2021-03-22T15:13:06.920Z\",\n \"code\":\"string\",\n \"name\":\"string\",\n \"warehouse\":{\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T14:53:46.414Z\",\n \"lastupdated\":\"2021-03-22T14:53:46.414Z\",\n \"code\":\"string\",\n \"name\":\"string\",\n \"address\":\"string\",\n \"country\":\"string\",\n \"state\":\"string\",\n \"city\":\"string\",\n \"county\":\"string\",\n \"district\":\"string\",\n \"street\":\"string\",\n \"address_line\":\"string\",\n \"latitude\":0,\n \"longitude\":0,\n \"post_code\":\"string\",\n \"special_1\":\"string\",\n \"special_2\":\"string\",\n \"special_3\":\"string\"\n },\n \"quantity_unit\":\"string\",\n \"quantity\":0,\n \"transfer_type\":\"string\",\n \"deci\":0,\n \"cargo_width\":0,\n \"cargo_height\":0,\n \"cargo_depth\":0,\n \"cargo_weight\":0\n }\n ]\n}"},{"id":"60de1d0c-a574-4d97-b8b3-2041808590b1","name":"Not Found","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/product"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"7fec018e-42f4-4a73-afc2-67f2574488ed","name":"Created","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/product"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"8e667765-e510-4de0-b377-8d2a2323fe77","name":"Forbidden","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/product"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ae61e836-4dcd-413d-8d77-23da3fc9ae59"},{"name":"Create new product","id":"a2414f7a-4a21-4497-a575-3c2fb7979209","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Access_token","description":"

We send the token type and access_token information in the authorization parameter.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"code\": \"string\",\n \"name\": \"string\",\n \"warehouse_code\": \"string\",\n \"quantity_unit\": \"string\",\n \"transfer_type\": \"string\",\n \"quantity\": 0,\n \"deci\": 0,\n \"cargo_width\": 0,\n \"cargo_height\": 0,\n \"cargo_depth\": 0,\n \"cargo_weight\": 0\n}"},"url":"{{base}}/api/product","description":"

Create a new product.

\n

The field list belonging to the product is available in Figure 3.

\n

Error Codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDefinition
E0001You must send all required fields.
E0002The field (fieldname) must have a maximum length of (maxlength)
E0003The product code you want to create is already defined.
E0004There is no such warehouse.
\n
","urlObject":{"path":["api","product"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"26fe92b9-0106-4e4b-8160-e666452f755b","name":"Not Found","originalRequest":{"method":"PUT","header":[{"description":"(Required) Bearer Access_token","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/product"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"39bbf937-ee1d-440f-9c5c-84bdc56ffa10","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw","description":"(Required) Bearer Access_token","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/product"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\":true,\n \"data\":[\n {\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T15:13:06.920Z\",\n \"lastupdated\":\"2021-03-22T15:13:06.920Z\",\n \"code\":\"string\",\n \"name\":\"string\",\n \"warehouse\":{\n \"id\":\"string\",\n \"created_at\":\"2021-03-22T14:53:46.414Z\",\n \"lastupdated\":\"2021-03-22T14:53:46.414Z\",\n \"code\":\"string\",\n \"name\":\"string\",\n \"address\":\"string\",\n \"country\":\"string\",\n \"state\":\"string\",\n \"city\":\"string\",\n \"county\":\"string\",\n \"district\":\"string\",\n \"street\":\"string\",\n \"address_line\":\"string\",\n \"latitude\":0,\n \"longitude\":0,\n \"post_code\":\"string\",\n \"special_1\":\"string\",\n \"special_2\":\"string\",\n \"special_3\":\"string\"\n },\n \"quantity_unit\":\"string\",\n \"quantity\":0,\n \"transfer_type\":\"string\",\n \"deci\":0,\n \"cargo_width\":0,\n \"cargo_height\":0,\n \"cargo_depth\":0,\n \"cargo_weight\":0\n }\n ]\n}"},{"id":"6f859237-8054-4689-970a-b9c60407dc4e","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"description":"(Required) Bearer Access_token","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/product"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"a6cff1ce-5fd1-4046-a0e6-111420396f4c","name":"Forbidden","originalRequest":{"method":"PUT","header":[{"description":"(Required) Bearer Access_token","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/product"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"c40a0ec9-2aee-4387-af2c-aef58245823a","name":"Created","originalRequest":{"method":"PUT","header":[{"description":"(Required) Bearer Access_token","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/product"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"a2414f7a-4a21-4497-a575-3c2fb7979209"}],"id":"0e2c1274-ef63-414d-ae1a-7bcd8db12f2c","description":"

Followings are the fields that will be provided for each product record:

\n

Field List

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Field NameRequiredData Type and SizeDefinition
code✔String, 0 < length < 32The unique product code that is used in your database.
name✔String, 0 < length < 100Name of product.
warehouse_code✔String, 0 < length < 32Warehouse code to which the product belongs.
quantity_unitString, 0 < length < 30Unit of Quantity used for the product (between 0 and 6). 01 = gr 02 = kg 03 = ml (cc) 04 = lt 05 = package 06 = palet
quantityFloatQuantity of product (shall match Quantity unit of the product in PRODUCT table).
transfer_typeString, 0 < length < 30Information in which part of the vehicle it can transported. 0 = Standard 1 = Frozen 2 = Hot 3 = Cold
deciFloatVolumetric weight of the cargo.
cargo_widthFloatWidth of the cargo in centimeters.
cargo_heightFloatHeight of the cargo in centimeters.
cargo_depthFloatDepth of the cargo in centimeters.
cargo_weightFloatWeight of the product in grams.
\n

Figure 3: Product Field List

\n","_postman_id":"0e2c1274-ef63-414d-ae1a-7bcd8db12f2c"},{"name":"Warehouse","item":[{"name":"{code}","item":[{"name":"Get warehouse by code.","id":"4f1145da-affb-4f55-8951-7772ac54e2d1","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Access_token ","description":"

We send the token type and access_token information in the authorization parameter.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"code\": \"string\"\r\n}"},"url":"{{base}}/api/warehouse/:code","description":"

Get warehouse by code.

\n

Error Codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDefinition
E0004There is no such warehouse.
\n
","urlObject":{"path":["api","warehouse",":code"],"host":["{{base}}"],"query":[],"variable":[{"description":{"content":"

(Required) Warehouse code

\n","type":"text/plain"},"type":"string","value":"","key":"code"}]}},"response":[{"id":"715796ed-4362-4b69-bd6e-d6f4fc9b0920","name":"OK","originalRequest":{"method":"GET","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/warehouse/:code","host":["{{base}}"],"path":["api","warehouse",":code"],"variable":[{"key":"code"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"string\",\n \"created_at\": \"2021-03-22T14:53:46.414Z\",\n \"lastupdated\": \"2021-03-22T14:53:46.414Z\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"address\": \"string\",\n \"country\": \"string\",\n \"state\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"district\": \"string\",\n \"street\": \"string\",\n \"address_line\": \"string\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"post_code\": \"string\",\n \"special_1\": \"string\",\n \"special_2\": \"string\",\n \"special_3\": \"string\"\n }\n ]\n}"},{"id":"b5699236-0fe7-4874-80e3-da71aab57e37","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/warehouse/:code","host":["{{base}}"],"path":["api","warehouse",":code"],"variable":[{"key":"code"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"bf2cdd65-5f69-4d6c-8eff-d636492e1f01","name":"Forbidden","originalRequest":{"method":"GET","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/warehouse/:code","host":["{{base}}"],"path":["api","warehouse",":code"],"variable":[{"key":"code"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"4a09dd5c-477c-4f03-9756-c11eb187f994","name":"Not Found","originalRequest":{"method":"GET","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/warehouse/:code","host":["{{base}}"],"path":["api","warehouse",":code"],"variable":[{"key":"code"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4f1145da-affb-4f55-8951-7772ac54e2d1"},{"name":"Delete warehouse by code.","id":"0f1e82f2-748e-4f05-9756-8cad95b7d5a7","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Access_token ","description":"

We send the token type and access_token information in the authorization parameter.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"code\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/warehouse/:code","description":"

Delete a warehouse by providing its code.

\n

Error Codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDefinition
E0004There is no such warehouse.
\n
","urlObject":{"path":["api","warehouse",":code"],"host":["{{base}}"],"query":[],"variable":[{"description":{"content":"

(Required) Warehouse code

\n","type":"text/plain"},"type":"string","value":"","key":"code"}]}},"response":[{"id":"74b263bf-ef3a-4688-a57e-be2616766837","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/warehouse/:code","host":["{{base}}"],"path":["api","warehouse",":code"],"variable":[{"key":"code"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"7de45c30-3ad6-4f2d-8a5e-aa2f997d6231","name":"OK","originalRequest":{"method":"DELETE","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/warehouse/:code","host":["{{base}}"],"path":["api","warehouse",":code"],"variable":[{"key":"code"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"string\",\n \"created_at\": \"2021-03-22T14:53:46.414Z\",\n \"lastupdated\": \"2021-03-22T14:53:46.414Z\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"address\": \"string\",\n \"country\": \"string\",\n \"state\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"district\": \"string\",\n \"street\": \"string\",\n \"address_line\": \"string\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"post_code\": \"string\",\n \"special_1\": \"string\",\n \"special_2\": \"string\",\n \"special_3\": \"string\"\n }\n ]\n}"},{"id":"96176724-da08-48e7-8b40-a19af0ce0fab","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/warehouse/:code","host":["{{base}}"],"path":["api","warehouse",":code"],"variable":[{"key":"code"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"e918decf-528e-4a69-a7ef-12194a6cd923","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base}}/api/warehouse/:code","host":["{{base}}"],"path":["api","warehouse",":code"],"variable":[{"key":"code"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"0f1e82f2-748e-4f05-9756-8cad95b7d5a7"}],"id":"91acba65-28b4-44af-b5ae-ec5d17e65e91","_postman_id":"91acba65-28b4-44af-b5ae-ec5d17e65e91","description":""},{"name":"Update new warehouse","id":"1b7d264d-436b-46a6-b96c-d5d5af761d88","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Access_token ","description":"

We send the token type and access_token information in the authorization parameter.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"code\": \"string\",\n \"name\": \"string\",\n \"address\": \"string\",\n \"country\": \"string\",\n \"state\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"district\": \"string\",\n \"street\": \"string\",\n \"address_line\": \"string\",\n \"post_code\": \"string\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"special_1\": \"string\",\n \"special_2\": \"string\",\n \"special_3\": \"string\"\n}"},"url":"{{base}}/api/warehouse","description":"

Update a new warehouse.

\n

The field list belonging to the warehouse is available in Figure 4.

\n

Error Codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDefinition
E0001You must send all Required Fields.
E0002The field (fieldname) must have a maximum length of (maxlength)
E0003The warehouse code you want to create is already defined.
E0004There is no such warehouse.
\n
","urlObject":{"path":["api","warehouse"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"32b973a3-f1a4-4df4-90e2-a24723c8df63","name":"OK","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/warehouse"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"string\",\n \"created_at\": \"2021-03-22T14:53:46.414Z\",\n \"lastupdated\": \"2021-03-22T14:53:46.414Z\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"address\": \"string\",\n \"country\": \"string\",\n \"state\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"district\": \"string\",\n \"street\": \"string\",\n \"address_line\": \"string\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"post_code\": \"string\",\n \"special_1\": \"string\",\n \"special_2\": \"string\",\n \"special_3\": \"string\"\n }\n ]\n}"},{"id":"7be6fc2e-73d8-4cac-96c2-c370e5e0fd7d","name":"Created","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/warehouse"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"6fe0648d-c5db-4833-9c2c-bc4467c58ac1","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/warehouse"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"c70f9991-2235-4611-8cbd-3622c4e8b523","name":"Forbidden","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/warehouse"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"8382f1d5-0468-4494-b06c-91d44f13d003","name":"Not Found","originalRequest":{"method":"POST","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/warehouse"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"1b7d264d-436b-46a6-b96c-d5d5af761d88"},{"name":"Create new warehouse","id":"1125e15d-ae8c-43a2-8890-b40373a64028","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Access_token ","description":"

We send the token type and access_token information in the authorization parameter.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"code\": \"string\",\n \"name\": \"string\",\n \"address\": \"string\",\n \"country\": \"string\",\n \"state\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"district\": \"string\",\n \"street\": \"string\",\n \"address_line\": \"string\",\n \"post_code\": \"string\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"special_1\": \"string\",\n \"special_2\": \"string\",\n \"special_3\": \"string\"\n}"},"url":"{{base}}/api/warehouse","description":"

Create a new warehouse.

\n

The field list belonging to the warehouse is available in Figure 4.

\n

Error Codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDefinition
E0001You must send all Required Fields.
E0002The field (fieldname) must have a maximum length of (maxlength)
E0003The warehouse code you want to create is already defined.
\n
","urlObject":{"path":["api","warehouse"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"de216bb9-866a-408b-be4e-ee69a979c581","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/warehouse"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"string\",\n \"created_at\": \"2021-03-22T14:53:46.414Z\",\n \"lastupdated\": \"2021-03-22T14:53:46.414Z\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"address\": \"string\",\n \"country\": \"string\",\n \"state\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"district\": \"string\",\n \"street\": \"string\",\n \"address_line\": \"string\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"post_code\": \"string\",\n \"special_1\": \"string\",\n \"special_2\": \"string\",\n \"special_3\": \"string\"\n }\n ]\n}"},{"id":"4f5c9868-d1fd-4eb5-af02-3371163ac9d9","name":"Created","originalRequest":{"method":"PUT","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"ty","value":"application/json","type":"text"}],"url":"{{base}}/api/warehouse"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"c0b97ce0-f1e1-4138-b37f-3ee9268c3afb","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/warehouse"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"d3adfc76-7546-4ede-97e9-3342d80bba0b","name":"Forbidden","originalRequest":{"method":"PUT","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/warehouse"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"2cf6e183-8e5d-4696-9bb9-8508a284d40c","name":"Not Found","originalRequest":{"method":"PUT","header":[{"description":"(Required) Bearer Access_token ","key":"Authorization","value":"Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJvemd1ciIsImV4cCI6MTYxNzE3NjQ2NSwiaWF0IjoxNjE3MDkwMDY1fQ.YwodlD8UzAaShMoTSsgl-n2q-EwDBUfi13jQrxBsAupKv_HYMS69DHoHl_EPSCEPi0oIS2_gndHNdlNMI8qHAw"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base}}/api/warehouse"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"1125e15d-ae8c-43a2-8890-b40373a64028"}],"id":"592fe461-dbd7-46b4-8723-3d99b7d3c69a","description":"

Warehouse is where products are stored and the starting point of the route.

\n

Followings are the fields that will be provided for each warehouse record:

\n

Field List

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Field NameRequiredData Type and SizeDefinition
code✔String, 0 < length < 32The unique warehouse code that is used in your database.
name✔String, 0 < length < 50Name of the warehouse.
address✔String, 0 < length < 150full address of the warehouse location.
countryString, 0 < length < 30Country where the warehouse is located.
stateString, 0 < length < 30State where the warehouse is located (not necessary for Turkey).
cityString, 0 < length < 30City where the warehouse is located.
countyString, 0 < length < 30County where the warehouse is located.
districtString, 0 < length < 30District where the warehouse is located.
streetString, 0 < length < 30Street where the warehouse is located.
address_lineString, 0 < length < 100Additional information including Street number, apartment number etc.
post_codeString, 0 < length < 10Postal code of the warehouse zone.
latitude✔StringLatitude of the warehouse For example; 45.891170
longitude✔StringLongitude of the warehouse.
\n

Figure 4: Warehouse Field List

\n","_postman_id":"592fe461-dbd7-46b4-8723-3d99b7d3c69a"},{"name":"Authorize","item":[{"name":"Authorize","id":"af601d04-e187-47b7-8398-2e114d857d99","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"username\": \"string\",\r\n \"password\": \"string\"\r\n}"},"url":"{{base}}/authorize","description":"

Get Token using by username and password.

\n

Field List

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Field NameRequiredData Type and SizeDefinition
username✔String, NOT NULL, 0 < length < 50User name.
password✔String, NOT NULL, 6 < length < 10Password.
\n

Error Codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDefinition
W0007Username or password is wrong.
W0002User is not active.
W0008Your password has expired, please change your password.
\n

Figure 5: Authorize Field List

\n","urlObject":{"path":["authorize"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"8b9efcda-cdf1-41ea-82aa-f40de4a22f67","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"password\": \"string\",\n \"userName\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/authorize"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"a77c3d6b-f2dd-4daf-9ac1-2eddb740d05f","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"password\": \"string\",\n \"userName\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/authorize"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"b3a424b9-d680-44eb-98dd-d090ad83f5e9","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"password\": \"string\",\n \"userName\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/authorize"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"e318a8e7-53fc-413b-97b2-95b7c2c2177a","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"password\": \"string\",\n \"userName\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/authorize"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"ec5d91f5-6f3f-4638-9446-436e5decf0f2","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"password\": \"string\",\n \"userName\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/authorize"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"expiration_date\": \"1952-01-12T00:44:39.270Z\",\n \"access_token\": \"13e3bd3ed61043be92881a90369cf3f9\"\n}"},{"id":"fe580974-2c2a-435f-a2ab-c742f69dab78","name":"False Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"username\": \"string\",\r\n \"password\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/authorize"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"No such user or wrong password!\",\n \"code\": \"W0007\"\n}"}],"_postman_id":"af601d04-e187-47b7-8398-2e114d857d99"}],"id":"c13a845a-23a7-42df-9d98-c292301cf8de","description":"

HTTP Status Codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Status CodeMeaningDefinition
200OkRequest Successfully Concluded
201CreatedRegistration is Successful
204No contentRequest is successful, but no result is returned
400Bad RequestIncorrect request, please check the document
401UnauthorizedAuthentication is invalid
403ForbiddenYou are not allowed to make this request
404Not FoundThere is no such service
405Method Not AllowedMethod not accepted
5xxServer ErrorError caused by the server
\n
","_postman_id":"c13a845a-23a7-42df-9d98-c292301cf8de"}],"variable":[{"id":"5bb0e68b-b2e7-4655-8c28-673504ecf592","key":"baseUrl","value":"//api-dev.heybringo.com/","type":"string"}]}