Welcome to the Senpex API documentation. You can use the Senpex API to provide same-day delivery to your customers by one click.
\nThrough the Senpex API, your application will be able to create and manage orders as well as retrieve the details and status updates on those select orders. The Senpex API is organized around REST and has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes.
\neSignature request now available in /create_quick_order
Now users have to send local time for orders instead of UTC. For that purpose parameter in /get_price request \"schedule_date\" was changed to \"schedule_date_local\"
Performance improvements.
\nThe update is related to a huge improvement of multi-vendor/warehouse support and a new pricing model for long-distance multi-stop deliveries.
\nSince now a new request /create_dropp_off_route is available. It lets us to group orders by time windows and optimize routes even more efficient as we did.
A new pricing model for long-distance deliveries applicable for intercity and interstate multi-drop-off deliveries where first drop-off point is far than 20 miles from the pick-up.
\nmore about request /create_dropp_off_route
Includes multi-vendor/warehouse support. Designed for web portals that aggregate many different pick-up points.
\nIncludes the Webhook. Through the Webhook an external application will receive order status changes notifications.
\nAlso includes powerful add-on that opens new possibilities. Using this add-on external applications are able to load to Senpex Platform a number of addresses which should be served lately. Classical Senpex API works by model \"one delivery - one order\", but add-on works as \"multiple deliveries in one order\". A number of requests and separate Webhook which are used for uninterrupted data exchange make delivery process transparent and convenient.
\nTo use the Senpex API, the Client has to register on web.senpex.com. After successful registration, the client has to request for approval from the Senpex support team by making a call 650-514-6350 Once a client gets approved, he will receive an email with the link to API dashboard.
\nThe API requires credit card details which must be entered at API Dashboard. Notice, it is by default that Senpex will immediately provide the end user a price that will be expected to be paid for, however, the pricing is not determined by Senpex, rather the vendor is given the freedom to choose their own pricing structure. Thereby, the customer will use client secret keys that will be provided by Senpex, but the end user will have the ability to re-generate the secret keys for safety
\nIf you are ready to integrate with our API, please send an email to contact@senpex.com and include your Client Account - if you don't have one, you can register here https://web.senpex.com Once we receive your email, a member of our API Support Team will contact you to get started.
\nOnce your account is approved, you will be provided with a client_id and secret_id. Additionally, you will need to add your own Google Maps API Key to the dashboard.
\nTest Environment API Dashboard - https://api.dashboard.senpex.com/api_login/
\nProduction Environment API Dashboard - https://adminpanel.senpex.com/api_login
\nTo create your own Google Maps API Key, visit: https://developers.google.com Create a new account or register with an existing one. After you’re logged in, go to the Products/Cloud and click “Go to console”. Then go to “APIs & Services”/Dashboard/Credentials and click “Create Credentials”/API key. After you created your API key you need to activate the Geocoding API, Directions API, Distance matrix API, Geolocation API, Places API, Time Zone API.
\nOnce you get a Google API key, verify it here. After verification, paste it in Senpex API Dashboard.
\nNote! Please, keep these keys secured and do not embed them in any client-side code.
\nEvery integration starts with the Test Environment. Credentials and all required information for both environments will be provided by Senpex Support Team.
\nBaselink for Test Environment https://api.sandbox.senpex.com/senpex/api/rest/v4
Baselink for Production https://api.production.senpex.com/senpex/api/rest/v4
-
\nImages Test server: https://imagesfiles.version4.senpex.com/image_list/
Images Prod server https://imagesfiles.production.senpex.com/image_list/
Senpex platform provides five different types of transportation vehicle for delivering orders depending on the size of the order. As a default transport type, set up 'Car'
\nAs a default package size set up 'Small'
\nAPI provides different statuses for the Order that is placed.
\nRoute status for any order will be “0” if the order is not yet taken by the courier.
\nA courier can be cancelled anytime. This list shows the available reason for cancellation.
\nEach REST API request results is giving error information:
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"API Overview","slug":"api-overview"},{"content":"Preliminary Notes","slug":"preliminary-notes"},{"content":"Requirements","slug":"requirements"},{"content":"What to start with?","slug":"what-to-start-with"},{"content":"Environments","slug":"environments"},{"content":"Dictionary Definitions","slug":"dictionary-definitions"},{"content":"Errors","slug":"errors"}],"owner":"9662282","collectionId":"66bbc188-f8e6-4357-ad4c-13f58586616e","publishedId":"TW73Fkyi","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-06-12T21:06:54.000Z"},"item":[{"name":"v4","item":[{"name":"General Requests","item":[{"name":"/get_price - URGENT","event":[{"listen":"test","script":{"id":"6b338440-18e1-4bf8-a35c-b068ff9e10a4","exec":["var jsonData = pm.response.json();\r","\r","pm.environment.set(\"api_token\", jsonData.details[0].api_token); \r","\r","\r",""],"type":"text/javascript","packages":{}}}],"id":"41417095-b9ca-4793-98cb-8f19b2d3be0c","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"key":"Country","value":"{{country_can}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"order_name\": \"Delivery Order\",\r\n \"taken_asap\": 1,\r\n \"transport_id\": 1,\r\n \"item_value\": 200,\r\n \"pack_size_id\": 1,\r\n \"promo_code\": \"If Available\",\r\n \"pack_from_text\": \"511 Central Ave, Mountain View, 94043, CA\",\r\n \"client_id\": \"{{client_id}}\",\r\n \"secret_id\": \"{{secret_id}}\",\r\n \"timeZoneIdentifier\": \"US/Arizona\",\r\n \"use_optimization\": 1,\r\n \"routes\": [\r\n {\r\n \"route_to_text\": \"1101 W El Camino Real, Mountain View, CA 94040, USA\",\r\n \"rec_name\": \"Jack\",\r\n \"rec_phone\": \"1002003000\"\r\n },\r\n {\r\n \"route_to_text\": \"1101 W El Camino Real, Mountain View, CA 94040, USA\",\r\n \"rec_name\": \"Jack\",\r\n \"rec_phone\": \"1002003000\"\r\n },\r\n {\r\n \"route_to_text\": \"1101 W El Camino Real, Mountain View, CA 94040, USA\",\r\n \"rec_name\": \"Jack\",\r\n \"rec_phone\": \"1002003000\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baselink_v4_canada}}/get_price","description":"This service allows you to obtain a delivery price estimate by providing the following parameters. Also it generates a token used in /create_quick_order request, that is valid for 60 minutes.
\nThis service allows you to obtain a delivery price estimate depending on the size of your package, type of transport you chose and the drop-off address. If taken_asap and schedule_date parameters are provided in request, it returns scheduled delivery price, otherwise it returns urgent delivery price.
A full list of the parameters and their descriptions is shown below.
Allows to get price by providing required parameters and the list of drop off addressess
\n","urlObject":{"protocol":"https","path":["senpex","api","rest","v4","get_price"],"host":["api","sandbox","senpex","com"],"query":[],"variable":[]}},"response":[{"id":"21193f18-2f13-400e-8b4d-7a992f15d309","name":"/get_price - SCHEDULED","originalRequest":{"method":"POST","header":[{"key":"","value":"","type":"text","disabled":true},{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"order_name\": \"Test Delivery Order\",\r\n \"taken_asap\": 0,\r\n \"schedule_date\": \"01/01/2099 12:50\",\r\n \"transport_id\": 1,\r\n \"item_value\": 200,\r\n \"pack_size_id\": 1,\r\n \"promo_code\": \"If available\",\r\n \"pack_from_text\": \"350 Oakmead Pkwy, Sunnyvale, CA 94085, USA\",\r\n \"client_id\": \"{{client_id}}\",\r\n \"secret_id\": \"{{secret_id}}\",\r\n \"routes\": [\r\n {\r\n \"route_to_text\": \"1101 W El Camino Real, Mountain View, CA 94040, USA\",\r\n \"rec_name\": \"Jack\",\r\n \"rec_phone\": \"1002003000\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sandbox.senpex.com/senpex/api/rest/v4/get_price"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sat, 06 Feb 2021 01:47:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"0\",\n \"inserted_id\": -1,\n \"is_user_registered\": false,\n \"diff_in_minutes\": 40972982.43,\n \"details\": [\n {\n \"api_token\": \"2932295cfb89b98299408b9c9ee888c1\",\n \"order_price\": 19.34,\n \"original_order_price\": \"19.34\",\n \"order_discount\": null,\n \"promo_code_info\": null,\n \"distance_miles\": 6.85,\n \"distance_time_seconds\": 858,\n \"schedule_date\": \"2099-01-01 12:50:00\",\n \"item_value\": \"200\",\n \"pack_size_id\": \"1\",\n \"transport_id\": \"1\",\n \"pack_from_lat\": 37.3786872,\n \"pack_from_lng\": -121.987255,\n \"pack_from_text\": \"350 Oakmead Pkwy, Sunnyvale, CA 94085, USA\",\n \"order_name\": \"Test Delivery Order\",\n \"order_desc\": \"\",\n \"routes\": \"[{\\\"route_to_text\\\":\\\"1101 W El Camino Real, Mountain View, CA 94040, USA\\\",\\\"rec_name\\\":\\\"Jack\\\",\\\"rec_phone\\\":\\\"1002003000\\\",\\\"route_to_lat\\\":37.3872,\\\"route_to_lng\\\":-122.087406,\\\"route_distance\\\":6.85,\\\"route_distance_time\\\":858}]\",\n \"token_hash\": \"95de0754803e58fbd3c3bae2b95b7a3b\",\n \"routes_json\": [\n {\n \"route_to_text\": \"1101 W El Camino Real, Mountain View, CA 94040, USA\",\n \"rec_name\": \"Jack\",\n \"rec_phone\": \"1002003000\",\n \"route_to_lat\": 37.3872,\n \"route_to_lng\": -122.087406,\n \"route_distance\": 6.85,\n \"route_distance_time\": 858\n }\n ],\n \"expire_mins\": 60\n }\n ]\n}"}],"_postman_id":"9ffaef1e-c196-48f3-a6a0-b86ed8e56965"},{"name":"/create_quick_order","id":"8f307de9-1012-4e07-b0c2-ddd9d8cfa1f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Country","value":"{{country_can}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"api_token\": \"{{api_token}}\",\r\n \"email\": \"cheosteria+c@gmail.com\",\r\n \"client_id\": \"{{client_id}}\",\r\n \"secret_id\": \"{{secret_id}}\",\r\n \"tip_amount\": 100,\r\n \"ask_sign\": 1,\r\n \"routes\": [\r\n {\r\n \"rec_name\": \"Bruce Lee\",\r\n \"rec_phone\": \"1002003000\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baselink_v4_canada}}/create_quick_order","description":"This service allows to create a new single order.\nTo create a quick order, first send a POST/get_price request. This will return \"api_token\" in the response. Then, make a POST to the create_quick_order endpoint with api_token and the following parameters.
\nNote: api_token expires in 60 minutes after creating and it can be used for creating one order only.
\nAny data that was sent through \"/get_price\" can be updated through this request.
This request returns list of all previously created orders.
\nAllows to get the details about specific, previously created order by providing order_id
\nIf \"include_images\", \"include_history\" and \"include_routes\" are not provided in the request, the response will not have \"order_images\", \"history\" and \"routes\"
\n","urlObject":{"protocol":"https","path":["senpex","api","rest","v4","get_order_details"],"host":["api","sandbox","senpex","com"],"query":[],"variable":[]}},"response":[{"id":"b9407663-f62d-48fc-af59-cbe703f854ec","name":"/get_order_details","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \r\n \"client_id\":\"{{client_id}}\",\r\n \"secret_id\":\"{{secret_id}}\",\r\n \"order_id\":{{last_order_id}},\r\n \"include_images\":\"0\",\r\n \"include_history\":\"0\",\r\n \"include_routes\":\"0\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sandbox.senpex.com/senpex/api/rest/v2/get_order_details"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Tue, 09 Feb 2021 04:19:54 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"0\",\n \"data\": [\n {\n \"id\": \"39083\",\n \"order_name\": \"Test Delivery Order\",\n \"pack_size_id\": \"1\",\n \"pack_transport_id\": \"1\",\n \"pack_from_lat\": \"37.4200867000000000000000\",\n \"pack_from_lng\": \"-122.0823509000000000000000\",\n \"pack_from_text\": \"1585 Charleston Rd, Mountain View, CA 94043, USA\",\n \"taken_asap\": \"1\",\n \"schedule_date\": null,\n \"distance_miles\": \"6.35\",\n \"distance_time_seconds\": \"897.00\",\n \"pack_map_img\": \"f232e6f72305fc5b186d723728e846a8.png\",\n \"pack_price\": \"27.50\",\n \"rest_api_vers\": \"1\",\n \"route_count\": \"1\",\n \"last_pack_to_lat\": \"37.4299830000000000000000\",\n \"last_pack_to_lng\": \"-122.1640234000000000000000\",\n \"last_pack_to_text\": \"341 Galvez St, Stanford, CA 94305, USA\",\n \"conn_client_name\": \"Web site\",\n \"pack_status\": \"40\",\n \"order_status_text\": \"Item is delivered\",\n \"courier_name\": \"Alex\",\n \"courier_surname\": \"Ginglow\",\n \"courier_cell\": \"6507777777\",\n \"courier_self_img\": \"image_list2/02F9F3F8-AC6A-4325-B54E-E25FBA1596FE2021020200430.png\",\n \"sender_name\": \"Hanna\",\n \"sender_surname\": \"Smith\",\n \"sender_cell\": \"6507883883\",\n \"sender_email\": \"hanna.smith@gmail.com\",\n \"sender_user_id\": \"5527\",\n \"status_sender\": \"Item is delivered\",\n \"item_value\": \"250.00\",\n \"pack_mailing_status\": \"1\",\n \"snpx_emails\": \"1\",\n \"snpx_nots\": \"1\",\n \"snpx_sms\": \"0\",\n \"snpx_instant_not\": \"1\",\n \"instant_not_url\": \"https://api.github.com/users/hadley/orgs\",\n \"company_metadata\": null,\n \"pack_bidders\": [\n {\n \"pack_id\": \"39083\",\n \"bidder_id\": \"5384\",\n \"bid_date\": \"2021-02-09 01:57:53\",\n \"accept_status\": \"10\",\n \"accepted_date\": \"2021-02-09 01:57:53\",\n \"bid_text\": \"\",\n \"reason_type\": null,\n \"reason_id\": null,\n \"reason_text\": null,\n \"courier_name\": \"Alex\",\n \"courier_surname\": \"Ginglow\",\n \"courier_cell\": \"6507777777\",\n \"courier_email\": \"cheosteria+truck@gmail.com\",\n \"accept_status_text\": \"Accepted\",\n \"reason_template_text\": null\n }\n ],\n \"courier_self_img_thumb\": \"image_list2/02F9F3F8-AC6A-4325-B54E-E25FBA1596FE2021020200430.png.thumb.png\"\n }\n ]\n}"}],"_postman_id":"13a05156-8cd3-41eb-99b8-c43a1d11784c"},{"name":"/get_courier_place","id":"11622f0a-c28a-4442-8a7a-a8dcfd9ae0db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"order_id\": \"{{last_order_id}}\",\r\n \"client_id\": \"{{client_id}}\",\r\n \"secret_id\": \"{{secret_id}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sandbox.senpex.com/senpex/api/rest/v4/get_courier_place","description":"Gets the details of the courier service and the real time location of the courier agent for a particular order.
\nFrom the moment of order creation and until the delivery is done, clients receive the real-time notifications about the delivery status of their orders. Currently our system supports four options for sending notifications:
\nEmail - messages delivered to the client’s email box;
Push - a quick pop-up messages received from the client’s app;
Sms - text messages delivered to the client’s cell phone;
Delivery Tracking Status - delivery tracking notifications that can be accessed from the user’s personal account dashboard.
By default each user receives email and push notifications, but our API allows you to modify notification preferences.
Allows to cancel order by order_id
\n","urlObject":{"protocol":"https","path":["api","rest","v3","cancel_order"],"host":["api","sandbox","senpex","com"],"query":[],"variable":[]}},"response":[{"id":"64940cd8-5973-4ff0-9b2d-bbda527e003b","name":"/cancel_order","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \r\n \"order_id\":\"39287\",\r\n \"client_id\":\"{{client_id}}\",\r\n \"secret_id\":\"{{secret_id}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sandbox.senpex.com/senpex/api/rest/v2/cancel_order"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sun, 21 Feb 2021 10:42:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"0\",\n \"inserted_id\": -1,\n \"details\": {\n \"refund_amount\": 20.5\n }\n}"}],"_postman_id":"e901c96a-17b1-43dd-9f00-5f236b9d29c7"}],"id":"5c72bc4d-6ddc-434f-8ad4-f0230b1903f1","description":"General Request represent classical API and contain requests used to create orders and retrieve different data.
\nSenpex API support two types of orders:
\nThe only difference of these requests is the value of the parameter \"taken_asap\".\nTo create an urgent order \"taken_asap\" should have \"1\". In this case the date and time of the order will be considered as a current time.
But if you need to create a scheduled order, lets say for tomorrow, \"taken_asap\" parameter, should have \"0\" and \"schedule_date\" must be added. You will find this in example below.
Example of the webhook notification sent by Senpex Platform
\n","urlObject":{"path":["Clients_Webhook_URL "],"query":[],"variable":[]}},"response":[],"_postman_id":"5eeab21d-c88d-4325-b0e1-d376b6c3ea02"}],"id":"f9582f28-3df5-43a9-aed7-0c9e017a8153","description":"Webhooks notify applications when specific events occur on a Senpex Platform. This commonly related to the order delivery statuses:
\nTo start receive notification using webhook, provide our support team with webhook URL.
\npack_status possible values:
route_status possible values:
Parameters:
\n","event":[{"listen":"prerequest","script":{"id":"9e3d7161-4687-43a8-b61d-3f13bd2b1140","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"df5043b6-09ec-4dd3-89ed-ec44e45d496f","type":"text/javascript","exec":[""]}}],"_postman_id":"f9582f28-3df5-43a9-aed7-0c9e017a8153"},{"name":"Add-on [Bulk Order]","item":[{"name":"/create_droppoff_point","id":"4de2cc29-8fd0-41a8-8d7e-2d49bcdabdbc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"access_key\": \"Test Delivery \", \n \"client_id\": \"{{client_id}}\", \n \"secret_id\": \"{{secret_id}}\", \n \"rec_name\": \"Jack London\", \n \"rec_phone\": \"1002003000\", \n \"rec_desc\": \" Description that will be visible to driver\", \n \"rec_address\": \"490 Lincoln St, Santa Clara, CA 95050\", \n \"rec_email\": \"test@test.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sandbox.senpex.com/senpex/api/rest/v4/create_dropp_off_point","description":"By this request external application sends to Senpex system information about the address that supposed to be served. By default this unit have the status \"Ready for delivery\". Once the status changed Senpex system will send to external application notification via Webhook.
It is a modified and improved endpoint helping to pass through it additional information about the destination point. Unlike the /create_dropp_off_point it contains 3 additional parameters:
\"pickup_address\"\"pickup_time\"\"pickup_address_text\"This gives our platform a possibility to retrieve more accurate data and conduct more flexible and efficient route optimization and planning, taking into consideration different pick-up points and various time windows.
\nThe rest of requests in Add-on set work fine with it e.g. /get_dropoff
Request helps to retrieve the date and time of all events of the order by \"id\" or \"access_key\".
Request is used to get the information about the exact sender/recipient.\nEach fulfillment could be accessed by its \"id\" or “access_key”.
\n","urlObject":{"protocol":"https","path":["senpex","api","rest","v4","get_dropoff"],"host":["api","sandbox","senpex","com"],"query":[],"variable":[]}},"response":[{"id":"1cb1ab44-75b0-44f2-b702-d6932f279a04","name":"/get_dropoff","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"id\":\"290\",\n\"client_id\": \"{{client_id}}\", \n\"secret_id\": \"{{secret_id}}\" \n}","options":{"raw":{"language":"json"}}},"url":"https://api.sandbox.senpex.com/senpex/api/rest/v2/get_dropoff"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 10 Feb 2021 21:07:43 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"0\",\n \"data\": [\n {\n \"id\": \"290\",\n \"rec_address\": \"3555 Monroe St, Santa Clara, CA 95051\",\n \"rec_name\": \"Jack Jones\",\n \"rec_phone\": \"6507883883\",\n \"rec_desc\": \"Delivery notes. Please leave the kit near my door.\",\n \"rec_email\": null,\n \"metadata\": null,\n \"status_id\": \"1500\",\n \"company_id\": \"50020\",\n \"order_id\": \"37987\",\n \"route_id\": \"90472\",\n \"return_order_id\": \"37844\",\n \"return_route_id\": \"90151\",\n \"inserted_date\": \"2020-08-25 23:05:36\",\n \"access_key\": \"707\",\n \"attempt_count\": \"0\",\n \"rec_address_google_maps\": \"3555 Monroe St, Santa Clara, CA 95051\"\n }\n ]\n}"}],"_postman_id":"0ddffcca-5ead-4e5d-b3c0-12b1b22bb893"},{"name":"/get_dropoffs","id":"a640da77-e63a-4560-adf1-1ccfb1229b13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"client_id\": \"{{client_id}}\", \n\"secret_id\": \"{{secret_id}}\" \n}","options":{"raw":{"language":"json"}}},"url":"https://api.sandbox.senpex.com/senpex/api/rest/v4/get_dropoffs","description":"Request is used to get the information about all deliveries.
\n","urlObject":{"protocol":"https","path":["senpex","api","rest","v4","get_dropoffs"],"host":["api","sandbox","senpex","com"],"query":[],"variable":[]}},"response":[{"id":"545c7770-3379-4b70-9af5-0a6bf49ab12d","name":"/get_dropoffs","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"client_id\": \"{{client_id}}\", \n\"secret_id\": \"{{secret_id}}\" \n}","options":{"raw":{"language":"json"}}},"url":"https://api.sandbox.senpex.com/senpex/api/rest/v2/get_dropoffs"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 10 Feb 2021 21:11:50 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"0\",\n \"data\": [\n {\n \"id\": \"1137\",\n \"rec_address\": \"490 Lincoln St, Santa Clara, CA 95050\",\n \"rec_name\": \"Jack London\",\n \"rec_phone\": \"1002003000\",\n \"rec_desc\": \"Description that will be visible to driver\",\n \"rec_email\": \"test@test.com\",\n \"metadata\": null,\n \"status_id\": \"1000\",\n \"company_id\": \"50020\",\n \"order_id\": null,\n \"route_id\": null,\n \"return_order_id\": null,\n \"return_route_id\": null,\n \"inserted_date\": \"2021-02-10 02:23:55\",\n \"access_key\": \"Test Delivery 1\",\n \"attempt_count\": \"0\",\n \"rec_address_google_maps\": null\n },\n {\n \"id\": \"1136\",\n \"rec_address\": \"490 Lincoln St, Santa Clara, CA 95050\",\n \"rec_name\": \"Jack London\",\n \"rec_phone\": \"6506080559\",\n \"rec_desc\": \"Description that will be visible to driver\",\n \"rec_email\": \"test@test.com\",\n \"metadata\": null,\n \"status_id\": \"1000\",\n \"company_id\": \"50020\",\n \"order_id\": null,\n \"route_id\": null,\n \"return_order_id\": null,\n \"return_route_id\": null,\n \"inserted_date\": \"2021-02-10 02:22:49\",\n \"access_key\": \"1er23\",\n \"attempt_count\": \"0\",\n \"rec_address_google_maps\": null\n },\n {\n \"id\": \"1135\",\n \"rec_address\": \"490 Lincoln St, Santa Clara, CA 95050\",\n \"rec_name\": \"Jack London\",\n \"rec_phone\": \"6506080559\",\n \"rec_desc\": \"Description that will be visible to driver\",\n \"rec_email\": \"test@test.com\",\n \"metadata\": null,\n \"status_id\": \"1000\",\n \"company_id\": \"50020\",\n \"order_id\": null,\n \"route_id\": null,\n \"return_order_id\": null,\n \"return_route_id\": null,\n \"inserted_date\": \"2021-02-10 02:21:38\",\n \"access_key\": \"123er\",\n \"attempt_count\": \"0\",\n \"rec_address_google_maps\": null\n }"}],"_postman_id":"a640da77-e63a-4560-adf1-1ccfb1229b13"},{"name":"/track_dropoff","id":"7c158e98-0f7d-4d9c-bf49-174e4158b306","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"id\":\"290\",\n\"client_id\": \"{{client_id}}\", \n\"secret_id\": \"{{secret_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sandbox.senpex.com/senpex/api/rest/v4/track_dropoff","description":"Request is used to get tracking information about each kit once it was taken by delivery specialist.\nEach kit could be accessed by it’s \"id\" or “access_key”.
\n","urlObject":{"protocol":"https","path":["senpex","api","rest","v4","track_dropoff"],"host":["api","sandbox","senpex","com"],"query":[],"variable":[]}},"response":[{"id":"37a3e8cd-2e55-4f51-a7fb-32ee37392a3a","name":"/track_dropoff","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"id\":\"290\",\n\"client_id\": \"{{client_id}}\", \n\"secret_id\": \"{{secret_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sandbox.senpex.com/senpex/api/rest/v2/track_dropoff"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 10 Feb 2021 21:14:53 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"0\",\n \"data\": [\n {\n \"id\": \"290\",\n \"rec_address\": \"3555 Monroe St, Santa Clara, CA 95051\",\n \"rec_name\": \"Jack Jones\",\n \"rec_phone\": \"6507883883\",\n \"status_id\": \"1500\",\n \"last_lat\": null,\n \"last_lng\": null,\n \"last_location_date\": null,\n \"route_status\": \"30\",\n \"route_status2\": \"0\",\n \"pack_status\": \"30\",\n \"pack_status2\": \"100\",\n \"qr_code_data\": null,\n \"tracking_code\": \"rha564\",\n \"courier_name\": null,\n \"courier_surname\": null,\n \"courier_cell\": null,\n \"courier_self_img\": null,\n \"courier_name_return\": null,\n \"courier_surname_return\": null,\n \"courier_cell_return\": null,\n \"courier_self_img_return\": null,\n \"route_to_lat\": \"37.3675741000000000000000\",\n \"route_to_lng\": \"-121.9938407000000000000000\",\n \"status_text\": \"Your parcel has been picked up\"\n }\n ]\n}"}],"_postman_id":"7c158e98-0f7d-4d9c-bf49-174e4158b306"}],"id":"be5a7a80-d81e-4b8a-850c-3d72de259f45","description":"It is a special add-on was designed to cover needs of companies which receive a huge number of requests for delivery during a period of time. No matter either it's a pick-up or drop-off request. By this API module Senpex platform able to accumulate multiple destination points and organize them in orders with high efficiency thanks to route optimization algorithm.
\n","event":[{"listen":"prerequest","script":{"id":"bc3dc93a-3251-4823-b89d-4e11015a104f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"37003bbf-e1b5-4002-9338-0e3efc3fc53b","type":"text/javascript","exec":[""]}}],"_postman_id":"be5a7a80-d81e-4b8a-850c-3d72de259f45"},{"name":"Add-on Webhook","item":[{"name":"webhook","id":"ef196584-45fb-47d3-b33c-5aac19891e35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"route\": {\n \"images\": [\n {\n \"img_link\": \"image_list2/DB297F55-E947-43BE-9376-39377DB3CAF42023033104260.png\"\n },\n {\n \"img_link\": \"image_list2/EADC684D-8D01-4BDD-9909-ABC6E66F85C62023033104260.png\"\n },\n {\n \"img_link\": \"image_list2/733C9C18-32ED-4042-B799-5A361545DBA02023033104260.png\"\n }\n ]\n },\n \"return\": {\n \"images\": [\n {\n \"img_link\": null\n }\n ]\n },\n \"order_id\": \"180627\",\n \"secret_id\": \"1D1B7979-AC8A-415A-AB71-CFCE5D051BF02023031206020\",\n \"access_key\": \"134805\",\n \"drop_off_id\": \"7680\",\n \"request_type\": \"test\",\n \"drop_off_event_id\": \"1700\"\n}","options":{"raw":{"language":"json"}}},"url":"/Clients_Webhook_URL ","description":"Example of the webhook notification sent by Senpex Platform
\n","urlObject":{"path":["Clients_Webhook_URL "],"query":[],"variable":[]}},"response":[],"_postman_id":"ef196584-45fb-47d3-b33c-5aac19891e35"}],"id":"53a18269-8700-4d9b-8532-89668c8b8ca9","description":"Webhooks notify applications when specific events occur on a Senpex Platform. This commonly related to the order delivery statuses:
\nTo start receive notification using webhook, provide our support team with webhook URL.
\n","_postman_id":"53a18269-8700-4d9b-8532-89668c8b8ca9"}],"id":"7d8c9e1e-4f19-4195-8b82-226f59133913","event":[{"listen":"prerequest","script":{"id":"88c53139-487f-4ccd-a226-0b57fc109dea","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"52bd6c42-93b6-48b5-8b6b-6388e616a7f3","type":"text/javascript","exec":[""]}}],"_postman_id":"7d8c9e1e-4f19-4195-8b82-226f59133913","description":""}],"event":[{"listen":"prerequest","script":{"id":"02352a2e-b942-430e-9a30-f585caa1073a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b83575db-cc91-45be-b1c4-dfec617c0a89","type":"text/javascript","exec":[""]}}]}