{"info":{"_postman_id":"53e68179-b775-49f1-86f9-3ac2df365906","name":"Best Arabian Logistic","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"<html><head></head><body></body></html>","owner":"16813331","collectionId":"53e68179-b775-49f1-86f9-3ac2df365906","publishedId":"2sA3dsnuAt","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-07-06T00:00:18.000Z"},"item":[{"name":"CreateNewOrder","event":[{"listen":"test","script":{"id":"efcc9e5f-e0a4-4d36-8b93-7eaade300b05","exec":["// Stores the client reference from the response in an environment or global variable"," "],"type":"text/javascript","packages":{}}}],"id":"27438d7e-55b6-4c5b-a2b2-e4626539883a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"api_key\":\"32abcc1bf4cdea60ce6d09af6515ba9af992d61e8bd6d43df7318819eba347fa\",\n    \"username\":\"test@bestarabian-sa.com\",\n    \"password\":\"123\",\n    \"orders\": [\n    {\n      \"customer_name\": \"John Doe\",\n      \"customer_mobile\": \"1234567890\",\n      \"customer_address\": \"الرياض حي المرسلات شارع منزل رقم 5520\",\n      \"city_name\": \"New York\",\n      \"client_reference\": \"ABC123\",\n      \"content\":\"description\",\n       \"vendor_name\": \"Ahmed Store\",\n      \"vendor_mobile\": \"0534444441\",\n      \"vendor_phone\":  \"0112355555\",\n      \"vendor_address\": \"الرياض فرع الدائري الشمالي .....\",\n      \"items\": [\n        {\n          \"sku_name\": \"Product A\",\n          \"qty\": 2,\n          \"weight\": 0.5,\n          \"price\": 10.99\n        },\n        {\n          \"sku_name\": \"Product B\",\n          \"qty\": 1,\n          \"weight\": 1.2,\n          \"price\": 24.99\n        }\n      ]\n    }\n\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"https://bestarabian-sa.com/api/order/bulk/create","description":"<h3 id=\"create-bulk-order\">Create Bulk Order</h3>\n<p>This endpoint allows you to create multiple orders in bulk. The maximum order limit per request is 100.</p>\n<h4 id=\"request-body\">Request Body</h4>\n<ul>\n<li><p><code>api_key</code> (string, required): Your API key.</p>\n</li>\n<li><p><code>username</code> (string, required): Your username.</p>\n</li>\n<li><p><code>password</code> (string, required): Your password.</p>\n</li>\n<li><p><code>orders</code> (array, required): An array of orders with the following parameters:</p>\n<ul>\n<li><p><code>customer_name</code> (string, required): Name of the customer.</p>\n</li>\n<li><p><code>customer_mobile</code> (string, required): Mobile number of the customer.</p>\n</li>\n<li><p><code>customer_address</code> (string, required): Address of the customer.</p>\n</li>\n<li><p><code>city_name</code> (string, required): Name of the city.</p>\n</li>\n<li><p><code>client_reference</code> (string, required): Reference for the client .</p>\n</li>\n<li><p><code>content</code> (string, required): Content of the order.</p>\n</li>\n<li><p>vendor_name (string, required): vendor or the supplier</p>\n</li>\n<li><p>vendor_mobile : mobile</p>\n</li>\n<li><p>vendor_address: address description</p>\n</li>\n</ul>\n</li>\n</ul>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>- `items` (array, required): An array of items within the order with the following parameters:\n    - `sku_name` (string, required): Name of the SKU.\n    - `qty` (number, required): Quantity of the item.\n    - `weight` (number, required): Weight of the item.\n    - `price` (number, required): Price of the item.\n\n</code></pre><h4 id=\"response\">Response</h4>\n<p>The response is in the form of a JSON schema with the following structure:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"success\": true,\n  \"data\": [\n    {\n      \"client_reference\": \"ABC123\",\n      \"name\": \"BAL0000523230\"\n    }\n  ],\n  \"message\": \"\"\n}\n\n</code></pre>\n<p>This JSON schema represents the response structure:</p>\n<ul>\n<li><p><code>success</code> (boolean): Indicates if the request was successful.</p>\n</li>\n<li><p><code>data</code> (array): An array of objects containing client reference and name.</p>\n<ul>\n<li><p><code>client_reference</code> (string): Reference for the client.</p>\n</li>\n<li><p><code>name</code> (string): BAL reference for the waybill.</p>\n</li>\n</ul>\n</li>\n<li><p><code>message</code> (string): Any additional message related to the response.</p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","order","bulk","create"],"host":["bestarabian-sa","com"],"query":[],"variable":[]}},"response":[{"id":"a03cc4c0-f986-4396-b4d8-abe2869d6977","name":"response exsamble","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"api_key\":\"32abcc1bf4cdea60ce6d09af6515ba9af992d61e8bd6d43df7318819eba347fa\",\n    \"username\":\"test@bestarabian-sa.com\",\n    \"password\":\"123\",\n    \"orders\": [\n    {\n      \"customer_name\": \"John Doe\",\n      \"customer_mobile\": \"1234567890\",\n      \"customer_address\": \"123 Main Street\",\n      \"city_name\": \"New York\",\n      \"client_reference\": \"ABC123\",\n      \"content\":\"description\",\n      \"items\": [\n        {\n          \"sku_name\": \"Product A\",\n          \"qty\": 2,\n          \"weight\": 0.5,\n          \"price\": 10.99\n        },\n        {\n          \"sku_name\": \"Product B\",\n          \"qty\": 1,\n          \"weight\": 1.2,\n          \"price\": 24.99\n        }\n      ]\n    },\n   {\n      \"customer_name\": \"James Anderson\",\n      \"customer_mobile\": \"3334445555\",\n      \"customer_address\": \"765 Pine Avenue\",\n      \"city_name\": \"San Francisco\",\n      \"client_reference\": \"BCD890\",\n            \"content\":\"description\",\n\n      \"items\": [\n        {\n          \"sku_name\": \"Product O\",\n          \"qty\": 2,\n          \"weight\": 0.9,\n          \"price\": 10.99\n        },\n        {\n          \"sku_name\": \"Product P\",\n          \"qty\": 1,\n          \"weight\": 1.6,\n          \"price\": 21.99\n        }\n      ]\n    }\n\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"https://bestarabian-sa.com/api/order/bulk/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.1"},{"key":"Date","value":"Thu, 27 Jun 2024 18:31:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"178"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"session_id=8a24b16887d5b663796d1e63111da72935860a39; Expires=Wed, 25-Sep-2024 18:31:42 GMT; Max-Age=7776000; HttpOnly; Path=/"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n    \"success\": true,\n    \"data\": [\n        {\n            \"client_reference\": \"ABC123\",\n            \"name\": \"BAL2470832\"\n        },\n        {\n            \"client_reference\": \"BCD890\",\n            \"name\": \"BAL2470833\"\n        }\n    ],\n    \"message\": \"orders created successfully \"\n}"}],"_postman_id":"27438d7e-55b6-4c5b-a2b2-e4626539883a"},{"name":"cancelOrder","event":[{"listen":"test","script":{"id":"7fe56651-622c-4a54-96fb-c1a657e6a3dd","exec":[""],"type":"text/javascript","packages":{}}}],"id":"a941dc11-4eaf-4342-aa95-ca06d59a91ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"api_key\":\"32abcc1bf4cdea60ce6d09af6515ba9af992d61e8bd6d43df7318819eba347fa\",\n    \"username\":\"test@bestarabian-sa.com\",\n    \"password\":\"123\",\n    \"waybills\": [\n    \"BAL2470834\"\n\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"https://bestarabian-sa.com/api/order/bulk/cancel","description":"<h3 id=\"cancel-bulk-orders\">Cancel Bulk Orders</h3>\n<p>This endpoint allows you to cancel multiple orders in bulk.</p>\n<h4 id=\"request-body\">Request Body</h4>\n<ul>\n<li><p><code>api_key</code> (string, required): Your API key.</p>\n</li>\n<li><p><code>username</code> (string, required): Your username.</p>\n</li>\n<li><p><code>password</code> (string, required): Your password.</p>\n</li>\n<li><p><code>waybills</code> (array, required): An array of waybill numbers for the orders to be cancelled.</p>\n</li>\n</ul>\n<h4 id=\"response\">Response</h4>\n<ul>\n<li><p><code>success</code> (boolean): Indicates if the request was successful.</p>\n</li>\n<li><p><code>data</code> (array): An array of cancelled waybill numbers.</p>\n</li>\n<li><p><code>message</code> (string): A message indicating the result of the cancellation operation.</p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","order","bulk","cancel"],"host":["bestarabian-sa","com"],"query":[],"variable":[]}},"response":[{"id":"485093bd-d185-4605-b6bd-5c3dae7ce6ce","name":"cancelOrder","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"api_key\":\"32abcc1bf4cdea60ce6d09af6515ba9af992d61e8bd6d43df7318819eba347fa\",\n    \"username\":\"test@bestarabian-sa.com\",\n    \"password\":\"123\",\n    \"waybills\": [\n    \"BAL2470834\"\n\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"https://bestarabian-sa.com/api/order/bulk/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.1"},{"key":"Date","value":"Thu, 27 Jun 2024 20:57:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"72"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"session_id=8a24b16887d5b663796d1e63111da72935860a39; Expires=Wed, 25-Sep-2024 20:57:21 GMT; Max-Age=7776000; HttpOnly; Path=/"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n    \"success\": true,\n    \"data\": [\n        \"BAL2470834\"\n    ],\n    \"message\": \"orders Canceled \"\n}"}],"_postman_id":"a941dc11-4eaf-4342-aa95-ca06d59a91ac"},{"name":"StatusOrder","event":[{"listen":"test","script":{"id":"41ae0ee1-6798-4ffc-8f88-b9a8eece46a3","exec":["// there is 4 states ","// draft === \"For New Created orders\"","// confirmed === \"Delivery in progress\"","// assigned === \"shipped\"","// done === \"Delivered\"","// cancel  === \"canceled =\""],"type":"text/javascript","packages":{}}}],"id":"3621ee7d-e5ef-4171-82df-62cd6734170e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"api_key\":\"32abcc1bf4cdea60ce6d09af6515ba9af992d61e8bd6d43df7318819eba347fa\",\n    \"username\":\"test@bestarabian-sa.com\",\n    \"password\":\"123\",\n    \"waybills\": [\n    \"BAL2470834\"\n\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"https://bestarabian-sa.com/api/order/bulk/status","description":"<p>The endpoint <code>https://bestarabian-sa.com/api/order/bulk/status</code> is a POST request that is used to update the status of multiple orders in bulk.</p>\n<h3 id=\"request-body\">Request Body</h3>\n<ul>\n<li><p>The request body should be in raw format and should include the following parameters:</p>\n<ul>\n<li><p><code>api_key</code> (string): The API key for authentication.</p>\n</li>\n<li><p><code>username</code> (string): The username for authentication.</p>\n</li>\n<li><p><code>password</code> (string): The password for authentication.</p>\n</li>\n<li><p><code>waybills</code> (array of strings): An array of waybill numbers for the orders whose status needs to be updated.</p>\n</li>\n</ul>\n</li>\n</ul>\n<h3 id=\"response\">Response</h3>\n<p>The response to this request will be a JSON object with the following properties:</p>\n<ul>\n<li><p><code>success</code> (boolean): Indicates whether the request was successful or not.</p>\n</li>\n<li><p><code>data</code> (array of objects): Contains the details of the updated orders, with each object having <code>name</code> and <code>state</code> properties.</p>\n<ul>\n<li><p><code>name</code> (string): The name of the order.</p>\n</li>\n<li><p><code>state</code> (string): The updated state of the order.</p>\n</li>\n</ul>\n</li>\n<li><p><code>message</code> (string): A message related to the response.</p>\n</li>\n</ul>\n<p>there is 4 states</p>\n<ul>\n<li><p>draft === \"For New Created orders\"</p>\n</li>\n<li><p>confirmed === \"Delivery in progress\"</p>\n</li>\n<li><p>assigned === \"shipped\"</p>\n</li>\n<li><p>done === \"Delivered\"</p>\n</li>\n<li><p>cancel === \"canceled \"</p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","order","bulk","status"],"host":["bestarabian-sa","com"],"query":[],"variable":[]}},"response":[{"id":"af9a2c46-0563-4810-a9f1-7621da88743a","name":"statusOrder","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"api_key\":\"32abcc1bf4cdea60ce6d09af6515ba9af992d61e8bd6d43df7318819eba347fa\",\n    \"username\":\"test@bestarabian-sa.com\",\n    \"password\":\"123\",\n    \"waybills\": [\n    \"BAL2470834\"\n\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"https://bestarabian-sa.com/api/order/bulk/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.1"},{"key":"Date","value":"Thu, 27 Jun 2024 21:02:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"107"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"session_id=8a24b16887d5b663796d1e63111da72935860a39; Expires=Wed, 25-Sep-2024 21:02:07 GMT; Max-Age=7776000; HttpOnly; Path=/"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n    \"success\": true,\n    \"data\": [\n        {\n            \"name\": \"BAL2470834\",\n            \"state\": \"cancel\"\n        }\n    ],\n    \"message\": \"orders status fetched \"\n}"}],"_postman_id":"3621ee7d-e5ef-4171-82df-62cd6734170e"},{"name":"TraceOrder","event":[{"listen":"test","script":{"id":"41ae0ee1-6798-4ffc-8f88-b9a8eece46a3","exec":[""],"type":"text/javascript","packages":{}}}],"id":"d156f977-f20f-4213-acdb-05eca3f82370","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"api_key\":\"32abcc1bf4cdea60ce6d09af6515ba9af992d61e8bd6d43df7318819eba347fa\",\n    \"username\":\"test@bestarabian-sa.com\",\n    \"password\":\"123\",\n    \"waybills\": [\n    \"BAL2470834\"\n\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"https://bestarabian-sa.com/api/order/bulk/trace","description":"<p>This endpoint allows you to make an HTTP POST request to <a href=\"https://bestarabian-sa.com/api/order/bulk/trace\">https://bestarabian-sa.com/api/order/bulk/trace</a> in order to trace multiple orders in bulk. The request should include an API key, username, password, and a list of waybills to be traced.</p>\n<h3 id=\"request-body\">Request Body</h3>\n<ul>\n<li><p>api_key (string): The API key for authentication.</p>\n</li>\n<li><p>username (string): The username for authentication.</p>\n</li>\n<li><p>password (string): The password for authentication.</p>\n</li>\n<li><p>waybills (array of strings): A list of waybill numbers to be traced.</p>\n</li>\n</ul>\n<h3 id=\"response\">Response</h3>\n<p>The response for this request is expected to be a JSON schema representing the structure of the response data. This schema will define the properties and their types that can be expected in the response from the API endpoint.</p>\n","urlObject":{"protocol":"https","path":["api","order","bulk","trace"],"host":["bestarabian-sa","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d156f977-f20f-4213-acdb-05eca3f82370"}]}