![\"alt](\"https://mylabaih.com/img/labaih-logo.png\"){kind=logo}
This documentation guide you how to integrate with LaBaih API
\n
Mandatory - use an API Key provided by LaBaih Team
\n"},{"key":"customerOrderNo","value":"123","description":"Mandatory - customer order number
\n","type":"text"},{"key":"noOfPieces","value":"4","description":"Mandatory - number of pieces
\n","type":"text"},{"key":"crates","value":"2","description":"Mandatory - Number of boxes ( packages )
\n","type":"text"},{"key":"weightKgs","value":"5","description":"Mandatory - Weight in KG
\n","type":"text"},{"key":"dimensionsCm","value":"","description":"Optional
\n","type":"text"},{"key":"itemDescription","value":"Test order","description":"Mandatory - shipment description
\n","type":"text"},{"key":"paymentMethod","value":"COD","description":"Mandatory - PREPAID / COD
\n","type":"text"},{"key":"paymentAmount","value":"100","description":"Mandatory - Shipment Total Value
\n","type":"text"},{"key":"consigneeName","type":"text","value":"Abdullah AlQahtani","description":"Mandatory - customer name
\n"},{"key":"consigneeMobile","type":"text","value":"966512345678","description":"Mandatory - customer mobile start with 966
\n"},{"key":"consigneePhone","value":"966512345689","description":"Optional - customer phone
\n","type":"text"},{"key":"consigneeEmail","value":"abdullah@test.com","description":"Optional - customer email
\n","type":"text"},{"key":"consigneeCity","type":"text","value":"Khobar","description":"Optional - customer city
\n"},{"key":"consigneeCommunity","value":"Rakkah","description":"Optional - customer community / district . Example : ( Khobar North )
\n","type":"text"},{"key":"consigneeAddress","type":"text","value":"Saudi Arabia - Eastern Province - Khobar City - Rakkah District","description":"Optional - customer address
\n"},{"key":"consigneeFlatFloor","value":"Second floor","description":"Optional
\n","type":"text"},{"key":"consigneeLatLong","value":"26.365504,50.2056799","description":"Optional - latitdue and longtitdue
\n","type":"text"},{"key":"consigneeSplInstructions","value":"Please Take care - fragel Package","description":"Optional
\n","type":"text"},{"key":"store","value":"LaBaih Store","description":"Mandatory - Store Name
\n","type":"text"},{"key":"shipperName","type":"text","value":"LaBaih Express","description":"Mandatory - shipper name
\n"},{"key":"shipperMobile","type":"text","value":"920000123","description":"Mandatory - shipper mobile to contact
\n"},{"key":"shipperEmail","value":"contact@test.com","description":"Mandatory - shipper email
\n","type":"text"},{"key":"shipperCity","value":"Khobar","description":"Mandatory - Shipper City. Example : ( Khobar)
\n","type":"text"},{"key":"shipperDistrict","value":"AlOlya","description":"Mandatory - Shipper District / Community. Example : ( Khobar North )
\n","type":"text"},{"key":"shipperAddress","value":"Saudi Arabia - Eastern Province - Khobar City - Alolya District","description":"Mandatory - shipper address
\n","type":"text"},{"key":"shipperLatLong","value":"26.294347, 50.175586","description":"Mandatory - shipper pickpoint coordinates ( latitdue and longtitdue )
\n","type":"text"},{"key":"pickuppoint_id","value":"RUH","description":"Optional - To retrive shipper Details from LaBaih by using pickupPointName from pickup points list API
\n","type":"text"},{"key":"national_short_address","value":"","description":"Mandatory if national_full_address does not have a value - National short address must start with four characters and following with 4 numbers example: ABCD1234.
\n","type":"text","uuid":"c9a94529-0f9f-4a59-9dde-f0ba2ebbb166"},{"key":"national_full_address","value":"","description":"Mandatory if national_short_address does not have a value - National full address format should be: short code, building number, street, Additional Number, district, city, postal code
\n","type":"text","uuid":"a67f2b12-c816-4223-9cbe-5ae3f37cf429"}]},"url":"https://dev.mylabaih.com/partners/api/order/create","description":"This API endpoint will let an authorized user to create an order by supplying necessary parameters.
\n","urlObject":{"protocol":"https","path":["partners","api","order","create"],"host":["dev","mylabaih","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"95ac55ad-04e0-492d-a117-397ca8aeb9eb"},{"name":"Get Order Details","id":"7183b6ed-de3d-4c64-a890-1b5c34175767","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"cache-control","value":"no-cache"}],"body":{"mode":"formdata","formdata":[{"key":"api_key","value":"","type":"text"}]},"url":"https://dev.mylabaih.com/partners/api/order/get?api_key=&consignmentNo=","description":"This API endpoint will let an authorized user to get an order details by supplying necessary parameters.
\n","urlObject":{"protocol":"https","path":["partners","api","order","get"],"host":["dev","mylabaih","com"],"query":[{"key":"api_key","value":""},{"key":"consignmentNo","value":""}],"variable":[]}},"response":[],"_postman_id":"7183b6ed-de3d-4c64-a890-1b5c34175767"},{"name":"Query Orders (search)","id":"310266ab-d80e-4f2f-96ea-536e85fc14c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"cache-control","value":"no-cache"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://dev.mylabaih.com/partners/api/order/query?api_key=&from=&to=","description":"This API endpoint will let an authorized user to search orders by supplying necessary parameters.
\n","urlObject":{"protocol":"https","path":["partners","api","order","query"],"host":["dev","mylabaih","com"],"query":[{"description":{"content":"Mandatory - use an API Key provided by LaBaih Team
\n","type":"text/plain"},"key":"api_key","value":""},{"description":{"content":"Mandatory - From Date
\n","type":"text/plain"},"key":"from","value":""},{"description":{"content":"Mandatory - To Date
\n","type":"text/plain"},"key":"to","value":""}],"variable":[]}},"response":[],"_postman_id":"310266ab-d80e-4f2f-96ea-536e85fc14c1"},{"name":"Print Shipment Label","id":"d41bbbce-b22f-463d-8ec8-b38158dbe692","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dev.mylabaih.com/partners/api/order/printlabel?api_key=&consignmentNo=","description":"This API endpoint will let an authorized user to view a shipment label by supplying necessary parameters
\n","urlObject":{"protocol":"https","path":["partners","api","order","printlabel"],"host":["dev","mylabaih","com"],"query":[{"description":{"content":"Mandatory - use an API Key provided by LaBaih Team
\n","type":"text/plain"},"key":"api_key","value":""},{"description":{"content":"Mandatory - shipment number
\n","type":"text/plain"},"key":"consignmentNo","value":""}],"variable":[]}},"response":[],"_postman_id":"d41bbbce-b22f-463d-8ec8-b38158dbe692"},{"name":"Pickup Points Lists","id":"96aa5f62-826c-416c-ba13-3eed92517d91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dev.mylabaih.com/partners/api/order/pickupPoints.php?api_key=","description":"This API endpoint will let an authorized user to view a pickup points by supplying necessary parameters
\n","urlObject":{"protocol":"https","path":["partners","api","order","pickupPoints.php"],"host":["dev","mylabaih","com"],"query":[{"description":{"content":"Mandatory - use an API Key provided by LaBaih Team
\n","type":"text/plain"},"key":"api_key","value":""}],"variable":[]}},"response":[],"_postman_id":"96aa5f62-826c-416c-ba13-3eed92517d91"},{"name":"Add Pickup Point - Soon","id":"907300a3-4519-4afb-9d59-b18ef985c880","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"cache-control","value":"no-cache"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"api_key","type":"text","value":"","description":"Mandatory - use an API Key provided by LaBaih Team
\n"},{"key":"shipperMobile","type":"text","value":"","description":"Shipper Mobile. Example : 05123456789 or 920000000
\n"},{"description":"Shipper Address. Example : ( Al Khobar Al Shamalia, Al Khobar 34429 )
\n","key":"shipperAddress","type":"text","value":""},{"description":"Shipper Coordinates ( Latitude , Longitude ). Example : ( 26.282093, 50.216476 )
\n","key":"shipperLatLong","type":"text","value":""},{"description":"Shipper City. Example : ( Al Khobar )
\n","key":"shipperCity","type":"text","value":""},{"description":"Shipper District / Community. Example : ( Khobar North )
\n","key":"shipperDistrict","type":"text","value":""},{"description":"Pickup Point Name. Example : ( Khobar Warehouse )
\n","key":"pickupPointName","type":"text","value":""}]},"url":"https://dev.mylabaih.com/partners/api/order/addpickuppoint","description":"This API endpoint will let an authorized user to add a pickup point by supplying necessary parameters.
\n","urlObject":{"protocol":"https","path":["partners","api","order","addpickuppoint"],"host":["dev","mylabaih","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"907300a3-4519-4afb-9d59-b18ef985c880"},{"name":"Update Pickup Point - Soon","id":"4f923cd7-6b84-4080-afd2-e18778c3692d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"cache-control","value":"no-cache"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"api_key","type":"text","value":"","description":"Mandatory - use an API Key provided by LaBaih Team
\n"},{"key":"shipperMobile","type":"text","value":"","description":"Shipper Mobile. Example : 05123456789 or 920000000
\n"},{"description":"Shipper Address. Example : ( Al Khobar Al Shamalia, Al Khobar 34429 )
\n","key":"shipperAddress","type":"text","value":""},{"description":"Shipper Coordinates ( Latitude , Longitude ). Example : ( 26.282093, 50.216476 )
\n","key":"shipperLatLong","type":"text","value":""},{"description":"Shipper City. Example : ( Al Khobar )
\n","key":"shipperCity","type":"text","value":""},{"description":"Shipper District / Community. Example : ( Khobar North )
\n","key":"shipperDistrict","type":"text","value":""},{"description":"Pickup Point Name. Example : ( Khobar Warehouse )
\n","key":"pickupPointName","type":"text","value":""}]},"url":"https://dev.mylabaih.com/partners/api/order/updatepickuppoint","description":"This API endpoint will let an authorized user to update a pickup point by supplying necessary parameters.
\n","urlObject":{"protocol":"https","path":["partners","api","order","updatepickuppoint"],"host":["dev","mylabaih","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4f923cd7-6b84-4080-afd2-e18778c3692d"},{"name":"Cancel Order","id":"2bea1f47-83b7-4a98-818e-bbeeaff7561d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"cache-control","value":"no-cache"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"api_key","type":"text","value":"","description":"Mandatory - use an API Key provided by LaBaih Team
\n"},{"key":"consignmentNo","value":"","description":"Mandatory - shipment number
\n","type":"text"}]},"url":"https://dev.mylabaih.com/partners/api/order/cancel","description":"This API endpoint will let an authorized user to send a cancellation request for an order by supplying necessary parameters.
\n","urlObject":{"protocol":"https","path":["partners","api","order","cancel"],"host":["dev","mylabaih","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2bea1f47-83b7-4a98-818e-bbeeaff7561d"},{"name":"Return Order","id":"95708107-207e-4df0-aa86-6aea47f1230f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"cache-control","value":"no-cache"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"api_key","type":"text","value":"","description":"Mandatory - use an API Key provided by LaBaih Team
\n"},{"key":"consignmentNo","value":"","description":"Mandatory - shipment number
\n","type":"text"}]},"url":"https://dev.mylabaih.com/partners/api/order/return","description":"This API endpoint will let an authorized user to send a return request for an order by supplying necessary parameters.
\n","urlObject":{"protocol":"https","path":["partners","api","order","return"],"host":["dev","mylabaih","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"95708107-207e-4df0-aa86-6aea47f1230f"},{"name":"Track Order","id":"ba282a22-e1b0-4531-a654-59782adb3e65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dev.mylabaih.com/partners/api/order/track?api_key=&consignmentNo=","urlObject":{"protocol":"https","path":["partners","api","order","track"],"host":["dev","mylabaih","com"],"query":[{"description":{"content":"Mandatory - use an API Key provided by LaBaih Team
\n","type":"text/plain"},"key":"api_key","value":""},{"description":{"content":"Mandatory - shipment number
\n","type":"text/plain"},"key":"consignmentNo","value":""}],"variable":[]}},"response":[],"_postman_id":"ba282a22-e1b0-4531-a654-59782adb3e65"}],"id":"650898e2-053a-487a-b744-cd0aa7ba9370","_postman_id":"650898e2-053a-487a-b744-cd0aa7ba9370","description":""},{"name":"Reverse Order","item":[{"name":"Create New Reverse Order ","id":"a2c63a5e-cb4e-4db9-876b-95ce6cc83c16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"cache-control","value":"no-cache"}],"body":{"mode":"raw","raw":"\n{\n \"api_key\": \"\",\n \"customerOrderNo\": \"26589\",\n \"crates\": \"1\",\n \"weightKg\": \"3\",\n \"consigneeName\": \"Abdullah\",\n \"consigneeMobile\": \"9665123456789\",\n \"consigneeCity\": \"Riyadh\",\n \"consigneeCommunity\": \"Al Qudos\",\n \"consigneeAddress\": \"Muhammad Ibrahim Ibn Madi, Al Quds, Riyadh 13214\",\n \"consigneeLatLong\": \"24.758450809408306, 46.75252404535755\",\n \"special_instructions\": \"please take care\",\n \"national_short_address\": \"DMAG3000\",\n \"national_full_address\": \"DMAG3000, 3000 Abu Ayoub Al Ansari St, 6666, Al Haram Al Sharif, MADINAH 42311\",\n \"store\": \"LaBaih\",\n \"droppoint_id\": \"KBR01\",\n \"packing_condition\": \"\",\n \"items\": [\n {\n \"item_name\": \"Orange t-shirt\",\n \"item_code\": \"\",\n \"quantity\": 1,\n \"image1\":\"https://encrypted-tbn0.gstatic.com/shopping?q=tbn:ANd9GcTSKsFw2wMLaKfjgSNgcnQBaONlME-VkjF_k37CzrG8fBsQrX3TW_c_UTXYXSP5byRVtkpXg96Bxg&usqp=CAc\",\n \"image2\":\"https://encrypted-tbn1.gstatic.com/shopping?q=tbn:ANd9GcR5eumiNXB2jsUiWsHkHUh1Gcp2wea2P1LBbcvcwN0oIKxycHcy2w-qHSLKaeGOgpkL48l0wZLuUg&usqp=CAc\",\n \"image3\":\"\",\n \"image4\":\"\"\n },\n {\n \"item_name\": \"blue bag\",\n \"item_code\": \"\",\n \"quantity\": 2,\n \"image1\":\"https://encrypted-tbn3.gstatic.com/shopping?q=tbn:ANd9GcQero6tLHJx9d3NpG5NNWutdVJAKyFyMgX2XGsLYR0gpNaNjHJgGsJdghtpQtLrluJFbC1ySiIqa7k&usqp=CAc\",\n \"image2\":\"https://encrypted-tbn2.gstatic.com/shopping?q=tbn:ANd9GcQjbLDebxrOGdLzWXvYu28u-B1L-tbbsCW3q6uid4As2z7l32HHAhaODYcuIWuWg4w2VSkY8rXI6gQ&usqp=CAc\",\n \"image3\":\"\",\n \"image4\":\"\"\n }, \n {\n \"item_name\": \"red t-shirt\",\n \"item_code\": \"741258963\",\n \"quantity\": 3,\n \"image1\":\"https://encrypted-tbn3.gstatic.com/shopping?q=tbn:ANd9GcTbBhaMIQbRNFsBMku1LvPJgGOlMJ9v8ZW1pfGJzROw7h2eDIPcv9OdEbZidas2Q9QG-iozvoUlYI_xZiLwTrQdkQh2r5k79qnAX5d3tQFrs1Hyp4XoJfXY-g&usqp=CAE\",\n \"image2\":\"https://encrypted-tbn3.gstatic.com/shopping?q=tbn:ANd9GcSa42tjFUm7lNNWrPFcjHXsLVcEIt0zz4I45tPV7lLeoG_cBYy_hEWu-TwycwVfgGAiAdYfSR-JljLi-R4oe6Hqs-i7z888PZlvXjt87ppDyQUOYWEECxRp&usqp=CAE\",\n \"image3\":\"\",\n \"image4\":\"\"\n },\n {\n \"item_name\": \"yellow bag\",\n \"item_code\": \"852369741\",\n \"quantity\": 4,\n \"image1\":\"https://encrypted-tbn3.gstatic.com/shopping?q=tbn:ANd9GcQ5LcYE8zeeeTgpZd72DGs2hAFRKJ-mmafyf5ikgQDdMDa2VCiFESAo_Z5qjWtBxVSXKVNbqrBbOe4&usqp=CAc\",\n \"image2\":\"https://encrypted-tbn3.gstatic.com/shopping?q=tbn:ANd9GcS69-4T7QRxYjgUmE-QNdvS0KjEU648BdJP9RRb8c0I5ZkPvxfYKU7ZmsqOgFIo-PMjhhk8cJMbMg&usqp=CAc\",\n \"image3\":\"\",\n \"image4\":\"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dev.mylabaih.com/partners/api/reverse/create-reverse-order","description":"This API endpoint will let an authorized user to create reverse order by supplying necessary parameters.
\n","urlObject":{"protocol":"https","path":["partners","api","reverse","create-reverse-order"],"host":["dev","mylabaih","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a2c63a5e-cb4e-4db9-876b-95ce6cc83c16"},{"name":"Get Reverse Order Details","id":"896a458a-87cc-4434-a281-d91a0dceb434","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"cache-control","value":"no-cache"}],"body":{"mode":"formdata","formdata":[]},"url":"https://dev.mylabaih.com/partners/api/reverse/get-reverse-order?api_key=&consignmentNo=","description":"This API endpoint will let an authorized user to get an order details by supplying necessary parameters.
\n","urlObject":{"protocol":"https","path":["partners","api","reverse","get-reverse-order"],"host":["dev","mylabaih","com"],"query":[{"description":{"content":"API Key
\n","type":"text/plain"},"key":"api_key","value":""},{"description":{"content":"Mandatory - shipment number
\n","type":"text/plain"},"key":"consignmentNo","value":""}],"variable":[]}},"response":[],"_postman_id":"896a458a-87cc-4434-a281-d91a0dceb434"},{"name":"Print Shipment Label","id":"1e703383-d170-4b8f-9f5c-b4dd796f975c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dev.mylabaih.com/partners/api/reverse/printlabel?api_key=&consignmentNo=","description":"This API endpoint will let an authorized user to view a shipment label by supplying necessary parameters
\n","urlObject":{"protocol":"https","path":["partners","api","reverse","printlabel"],"host":["dev","mylabaih","com"],"query":[{"description":{"content":"Mandatory - use an API Key provided by LaBaih Team
\n","type":"text/plain"},"key":"api_key","value":""},{"description":{"content":"Mandatory - shipment number
\n","type":"text/plain"},"key":"consignmentNo","value":""}],"variable":[]}},"response":[],"_postman_id":"1e703383-d170-4b8f-9f5c-b4dd796f975c"}],"id":"294e5fad-2d87-4729-8969-1ceaa54b094a","_postman_id":"294e5fad-2d87-4729-8969-1ceaa54b094a","description":""}]}