Users can connect to our Onetracker web API to access information available for this API collection. Our API currently includes the following functionalities.
\nPREPROD:
\nBASE_URL= \"{URL will be provide with access and secret keys}\"
\nclient_id = \"{access_key}\"
\nclient_secret = \"{client secret}\"
\nPROD:
\nBASE_URL= \"https://ext-api.onetraker.com/api/v1\"
\nclient_id = \"{access_key}\"
\nclient_secret = \"{client secret}\"
\nHTTP Status Codes
\nERROR code related to credentials:
\nGenerate base64 encoded value of string:
\nA merchant is a business who uses services of the career. The API connects at merchant level. So, a specific combination of APIs keys will connect to a specific merchant with necessary privileges.
\nA branch is a physical business location of a merchant. A merchant may have one or more branches. e.g. businesses like MFC, BigBazar, RelMart have 100s of branches across the country. It is optional for an external client (API user) to provide branch information during the placement of orders. Though we recommend it for future reporting of orders according to branches when required.
\nService is an important entity for the career. A career may have multiple services defined , depending on type of career. E.g. Get it Fast focuses on LAST_MILE services. When placing an order it is important to place it against a specific service for the career to identify and render the service accordingly.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting Started","slug":"getting-started"},{"content":"Header","slug":"header"},{"content":"Key Business Concepts","slug":"key-business-concepts"}],"owner":"21384855","collectionId":"7420f16e-1d05-4ac3-abd5-577fbf3d0b23","publishedId":"2sAXxLBZer","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-10-04T12:02:50.000Z"},"item":[{"name":"Branches for merchant","id":"b9fc0e43-6595-4cfc-8844-46ba65775292","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{BASE_URL}/otoms/merchant/branch/","description":"API to get list of branches belongs to particular merchant
\nHeaders:
\nauthorization: \"Bearer Base64encodedValueOf(client_id:client_secret)\"
content-type : “application/json”
Response Attributes:
\n","urlObject":{"path":["otoms","merchant","branch",""],"host":["{BASE_URL}"],"query":[],"variable":[]}},"response":[{"id":"d0a82230-b06c-4364-afc4-7d95087565e1","name":"Response","originalRequest":{"method":"GET","header":[],"url":"{BASE_URL}/otoms/merchant/branch/"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"genericResponse\": {\n \"apiStatusCode\": 200,\n \"apiSuccessStatus\": \"True\",\n \"apiStatusMessage\": \"Get branch success\"\n },\n \"no_of_counts\": 1,\n \"branches\": [\n {\n \"id\": \"63045cfc35a3f8439777ca75\",\n \"name\": \"Brandon Park\",\n \"address\": {\n \"google_formated_address\": \"1169 Pascoe Vale Rd, Broadmeadows VIC 3047, Australia\",\n \"business_name\": null,\n \"address1\": \"1169 Pascoe Vale Rd, Broadmeadows VIC 3047, Australia\",\n \"address2\": \"Pascoe Vale Road\",\n \"city\": \"Broadmeadows\",\n \"zip\": \"3047\",\n \"province\": \"Victoria\",\n \"province_code\": \"VIC\",\n \"country\": \"Australia\",\n \"country_code\": \"AU\",\n \"gps_latitude\": -37.6797773,\n \"gps_longitude\": 144.9194622,\n \"street_address\": null,\n \"area_name\": null,\n \"locality\": null,\n \"unit_floor\": null,\n \"landmark\": null,\n \"google_place_id\": null,\n \"contact\": {\n }\n },\n \"created_epoch\": 1661230332,\n \"updated_epoch\": 1661230332,\n \"created_datetime\": \"2022-08-23T04:52:12.812000\",\n \"updated_datetime\": \"2022-08-23T04:52:12.812000”\n }\n ]\n}"}],"_postman_id":"b9fc0e43-6595-4cfc-8844-46ba65775292"},{"name":"Service","id":"b1337400-1fee-47a4-9483-07fdcf0b5913","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{BASE_URL}/otoms/service/","description":"API to get services for a merchant.
\nHeaders:
\nauthorization: \"Bearer Base64encodedValueOf(client_id:client_secret)\"
content-type : “application/json”
Response Attributes:
\n","urlObject":{"path":["otoms","service",""],"host":["{BASE_URL}"],"query":[],"variable":[]}},"response":[{"id":"244ef06f-beda-41fd-8043-331d97e2ed9b","name":"Response","originalRequest":{"method":"GET","header":[],"url":"{BASE_URL}/otoms/service/"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"genericResponse\": {\n \"apiStatusCode\": 200,\n \"apiSuccessStatus\": \"True\",\n \"apiStatusMessage\": \"Get service success\"\n },\n \"services\": [\n {\n \"id\": \"5fdba33b464511602669f654\",\n \"name\": \"LAST_MILE\",\n \"service_type\": \"DELIVERY\",\n \"description\": \"Door to door last mile delivery service\",\n \"price\": {\n \"currency\": \"AUD\"\n },\n \"attribute\": [\n {\n \"category\": \"distance\",\n \"unit\": \"km\",\n \"min_value\": 0,\n \"max_value\": 1000\n },\n {\n \"category\": \"volume\",\n \"unit\": \"meter3\",\n \"min_value\": 0,\n \"max_value\": 2\n },\n {\n \"category\": \"length\",\n \"unit\": \"meter\",\n \"min_value\": 0,\n \"max_value\": 2\n },\n {\n \"category\": \"height\",\n \"unit\": \"meter\",\n \"min_value\": 0,\n \"max_value\": 2\n },\n {\n \"category\": \"width\",\n \"unit\": \"meter\",\n \"min_value\": 0,\n \"max_value\": 2\n },\n {\n \"category\": \"weight\",\n \"unit\": \"kg\",\n \"min_value\": 0,\n \"max_value\": 1000\n }\n ]\n }\n ]\n}"}],"_postman_id":"b1337400-1fee-47a4-9483-07fdcf0b5913"},{"name":"Slots for Service","id":"0af19679-56f7-4d83-a0ca-d7ce41391120","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"Slots are defined for specific services to be rendered on pre-defined schedules. When the service type is of DELIVERY it is recommended to provide intended slot information while placing the order.
\nGet slot for service API provide slots based on
\nNote:
\n{The slot for service API will be available in upcoming release 22nd Sept 2022. Currently order API automatically assign next available slot for delivery internally}
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"0af19679-56f7-4d83-a0ca-d7ce41391120"},{"name":"Price quotation","id":"dc63a887-75c3-46b1-8d33-7c76d426bc74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"Sample Request body for LAST MILE order :\n\n{\n \"service_id\": \"5fdba33b464511602669f654\",\n \"from_branch_id\": \"5fdba33b464511602669f654\",\n \"to_branch_id\": \"5fdba33b464511602669f654\",\n \"order_type\": \"DELIVERY\",\n \"parcel_value\": 1,\n \"validations\": {\n \"time_offset\": true\n },\n \"items\": [\n {\n \"name\": \"Carton 1\",\n \"type\": \"CARTON\",\n \"description\": \"\",\n \"products\": [\n {\n \"product_id\": 1234,\n \"name\": \"Learn to Tie My Shoelaces Toy\",\n \"quantity\": 2\n },\n {\n \"product_id\": 1222,\n \"name\": \"Trick Sticks\",\n \"quantity\": 1\n }\n ],\n \"quantity\": 1,\n \"attributes\": [\n {\n \"category\": \"distance\",\n \"unit\": \"KM\",\n \"value\": 13.765\n },\n {\n \"category\": \"weight\",\n \"unit\": \"KG\",\n \"value\": 3\n },\n {\n \"category\": \"volume\",\n \"name\": \"volume\",\n \"value\": 1\n }\n ]\n }\n ],\n \"from_address\": {\n \"google_formated_address\": \"Cnr Springvale, Ferntree Gully Rd, Wheelers Hill VIC 3170, Australia\",\n \"business_name\": null,\n \"address1\": \"Cnr Springvale, Ferntree Gully Rd, Wheelers Hill VIC 3170, Australia\",\n \"address2\": \"Wheelers Hill\",\n \"city\": \"Wheelers Hill\",\n \"zip\": \"3170\",\n \"province\": \"Victoria\",\n \"province_code\": \"VIC\",\n \"country\": \"Australia\",\n \"country_code\": \"AU\",\n \"gps_latitude\": -37.9059245,\n \"gps_longitude\": 145.1623669,\n \"street_address\": null,\n \"area_name\": null,\n \"locality\": null,\n \"unit_floor\": null,\n \"landmark\": null,\n \"google_place_id\": null,\n \"contact\": {\n \"is_primary\": false,\n \"name\": \"Brandon Park,VIC\",\n \"mobile_number\": \"+61777777777\",\n \"email\": \"sby@fast.com.au\"\n }\n },\n \"to_address\": {\n \"google_formated_address\": \"15/11 Dominion Ave, Glen Waverley VIC 3150, Australia\",\n \"business_name\": null,\n \"address1\": \"15/11 Dominion Ave, Glen Waverley VIC 3150, Australia\",\n \"address2\": \"Glen Waverley\",\n \"city\": \"Glen Waverley\",\n \"zip\": \"3150\",\n \"province\": \"Victoria\",\n \"province_code\": \"VIC\",\n \"country\": \"Australia\",\n \"country_code\": \"AU\",\n \"gps_latitude\": -37.8905312,\n \"gps_longitude\": 145.1857472,\n \"street_address\": null,\n \"area_name\": null,\n \"locality\": null,\n \"unit_floor\": null,\n \"landmark\": null,\n \"google_place_id\": null,\n \"contact\": {\n \"is_primary\": false,\n \"name\": \"MFC\",\n \"mobile_number\": \"+61888888888\",\n \"email\": \"palas@fast.com.au\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{BASE_URL}/otoms/price/price_quotation","description":"This API is used for two purposes
\nNote:
\n-> Price calculation is only applicable for non POSTPAID merchants. Price calculation mainly depends on the services.
\n-> For LAST MILE service, while calculating price, API clients do not need to mention from_branch_id and to_branch_id, instead the user needs to provide from_address and to_address as mandatory fields.
\nHeaders:
\nauthorization: \"Bearer Base64encodedValueOf(client_id:client_secret)\"
content-type : “application/json”
M - Mandatory Field
\nO - Optional Field – value can be empty but parameter must exist
\nRequest Attributes :
\nImportant Attributes common for Option mentioned above :
\nResponse Attributes:
\nPrice attributes are relevant for non-postpaid merchants.
\nFor POSTPAID merchants (GiF’s customers), these values should be ignored.
\n","urlObject":{"path":["otoms","price","price_quotation"],"host":["{BASE_URL}"],"query":[],"variable":[]}},"response":[{"id":"4a108754-85b9-4359-a8cd-bc0d867daa0a","name":"Response","originalRequest":{"method":"POST","header":[],"url":"{BASE_URL}/otoms/price/price_quotation"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"genericResponse\": {\n \"apiStatusCode\": 200,\n \"apiSuccessStatus\": \"True\",\n \"apiStatusMessage\": \"Get price quotation success\"\n },\n \"quotation\": {\n \"id\": \"5fdba33b4645116026ssf654\",\n \"service_id\": \"5fdba33b464511602669f654\",\n \"price\": {\n \"price\": 128,\n \"currency\": \"AUD\",\n \"tax\": null,\n \"item_prices\": [\n {\n \"item\": {\n \"name\": \"Document\",\n \"variant_id\": \"\",\n \"quantity\": 1,\n \"description\": \"\",\n \"type\": \"CARTON\",\n \"products\": [\n {\n \"product_id\": 1234,\n \"name\": \"Learn to Tie My Shoelaces Toy\",\n \"quantity\": 2\n },\n {\n \"product_id\": 1222,\n \"name\": \"Trick Sticks\",\n \"quantity\": 1\n }\n ],\n \"attributes\": [\n {\n \"category\": \"distance\",\n \"unit\": \"KM\",\n \"value\": 7.8709\n },\n {\n \"category\": \"weight\",\n \"unit\": \"KG\",\n \"value\": 3\n },\n {\n \"category\": \"volume\",\n \"unit\": \"meter3\",\n \"value\": 1\n }\n ]\n },\n \"price\": 128,\n \"currency\": \"AUD\",\n \"tax\": null\n }\n ]\n },\n \"from_branch_id\": \"5fdba33b464511602669f6wqq\",\n \"from_address\": {\n \"google_formated_address\": \"Cnr Springvale, Ferntree Gully Rd, Wheelers Hill VIC 3170, Australia\",\n \"business_name\": null,\n \"address1\": \"Cnr Springvale, Ferntree Gully Rd, Wheelers Hill VIC 3170, Australia\",\n \"address2\": \"Wheelers Hill\",\n \"city\": \"Wheelers Hill\",\n \"zip\": \"3170\",\n \"province\": \"Victoria\",\n \"province_code\": \"VIC\",\n \"country\": \"Australia\",\n \"country_code\": \"AU\",\n \"gps_latitude\": -37.9059245,\n \"gps_longitude\": 145.1623669,\n \"street_address\": null,\n \"area_name\": null,\n \"locality\": null,\n \"unit_floor\": null,\n \"landmark\": null,\n \"google_place_id\": null,\n \"contact\": {\n \"is_primary\": false,\n \"name\": \"Brandon Park,VIC\",\n \"mobile_number\": \"+61777777777\",\n \"email\": \"sby@fast.com.au\"\n }\n },\n \"to_branch_id\": \"etete-6ba33b464511602669f654\",\n \"to_address\": {\n \"google_formated_address\": \"15/11 Dominion Ave, Glen Waverley VIC 3150, Australia\",\n \"business_name\": null,\n \"address1\": \"15/11 Dominion Ave, Glen Waverley VIC 3150, Australia\",\n \"address2\": \"Glen Waverley\",\n \"city\": \"Glen Waverley\",\n \"zip\": \"3150\",\n \"province\": \"Victoria\",\n \"province_code\": \"VIC\",\n \"country\": \"Australia\",\n \"country_code\": \"AU\",\n \"gps_latitude\": -37.8905312,\n \"gps_longitude\": 145.1857472,\n \"street_address\": null,\n \"area_name\": null,\n \"locality\": null,\n \"unit_floor\": null,\n \"landmark\": null,\n \"google_place_id\": null,\n \"contact\": {\n \"is_primary\": false,\n \"name\": \"MFC\",\n \"mobile_number\": \"+61888888888\",\n \"email\": \"palas@fast.com.au\"\n }\n },\n \"items\": [\n {\n \"name\": \"Carton 1\",\n \"type\": \"CARTON\",\n \"products\": [\n {\n \"product_id\": 1234,\n \"name\": \"Learn to Tie My Shoelaces Toy\",\n \"quantity\": 2\n },\n {\n \"product_id\": 1222,\n \"name\": \"Trick Sticks\",\n \"quantity\": 1\n }\n ],\n \"quantity\": 1,\n \"attributes\": [\n {\n \"category\": \"distance\",\n \"unit\": \"KM\",\n \"name\": \"3+ km\",\n \"value\": 13.765,\n \"attribute_type\": \"RANGE\",\n \"components\": [],\n \"additional_info\": null\n },\n {\n \"category\": \"weight\",\n \"unit\": \"KG\",\n \"name\": \"3+ kg\",\n \"value\": 3,\n \"attribute_type\": \"RANGE\",\n \"components\": [],\n \"additional_info\": null\n },\n {\n \"category\": \"volume\",\n \"unit\": \"meter3\",\n \"name\": \"volume\",\n \"value\": 1,\n \"attribute_type\": \"NUMBER\",\n \"components\": [],\n \"additional_info\": null\n }\n ]\n }\n ],\n \"payment\": {},\n \"schedule\": {\n \"scheduled_date\": \"2020-09-03\",\n \"cut_off_time\": \"2020-09-03 12:00:PM GMT+11\",\n \"expected_start_of_delivery\": \"2020-09-03 12:00:PM GMT+11\",\n \"expected_end_of_delivery\": \"2020-09-03 08:00:PM GMT+11\",\n \"expected_start_of_delivery_epoch\": 1725364800,\n \"expected_end_of_delivery_epoch\": 1725393600\n }\n }\n}{\n \"genericResponse\": {\n \"apiStatusCode\": 200,\n \"apiSuccessStatus\": \"True\",\n \"apiStatusMessage\": \"Get price quotation success\"\n },\n \"quotation\": {\n \"id\": \"5fdba33b4645116026ssf654\",\n \"service_id\": \"5fdba33b464511602669f654\",\n \"price\": {\n \"price\": 128,\n \"currency\": \"AUD\",\n \"tax\": null,\n \"item_prices\": [\n {\n \"item\": {\n \"name\": \"Document\",\n \"variant_id\": \"\",\n \"quantity\": 1,\n \"description\": \"\",\n \"type\": \"CARTON\",\n \"products\": [\n {\n \"product_id\": 1234,\n \"name\": \"Learn to Tie My Shoelaces Toy\",\n \"quantity\": 2\n },\n {\n \"product_id\": 1222,\n \"name\": \"Trick Sticks\",\n \"quantity\": 1\n }\n ],\n \"attributes\": [\n {\n \"category\": \"distance\",\n \"unit\": \"KM\",\n \"value\": 7.8709\n },\n {\n \"category\": \"weight\",\n \"unit\": \"KG\",\n \"value\": 3\n },\n {\n \"category\": \"volume\",\n \"unit\": \"meter3\",\n \"value\": 1\n }\n ]\n },\n \"price\": 128,\n \"currency\": \"AUD\",\n \"tax\": null\n }\n ]\n },\n \"from_branch_id\": \"5fdba33b464511602669f6wqq\",\n \"from_address\": {\n \"google_formated_address\": \"Cnr Springvale, Ferntree Gully Rd, Wheelers Hill VIC 3170, Australia\",\n \"business_name\": null,\n \"address1\": \"Cnr Springvale, Ferntree Gully Rd, Wheelers Hill VIC 3170, Australia\",\n \"address2\": \"Wheelers Hill\",\n \"city\": \"Wheelers Hill\",\n \"zip\": \"3170\",\n \"province\": \"Victoria\",\n \"province_code\": \"VIC\",\n \"country\": \"Australia\",\n \"country_code\": \"AU\",\n \"gps_latitude\": -37.9059245,\n \"gps_longitude\": 145.1623669,\n \"street_address\": null,\n \"area_name\": null,\n \"locality\": null,\n \"unit_floor\": null,\n \"landmark\": null,\n \"google_place_id\": null,\n \"contact\": {\n \"is_primary\": false,\n \"name\": \"Brandon Park,VIC\",\n \"mobile_number\": \"+61777777777\",\n \"email\": \"sby@fast.com.au\"\n }\n },\n \"to_branch_id\": \"etete-6ba33b464511602669f654\",\n \"to_address\": {\n \"google_formated_address\": \"15/11 Dominion Ave, Glen Waverley VIC 3150, Australia\",\n \"business_name\": null,\n \"address1\": \"15/11 Dominion Ave, Glen Waverley VIC 3150, Australia\",\n \"address2\": \"Glen Waverley\",\n \"city\": \"Glen Waverley\",\n \"zip\": \"3150\",\n \"province\": \"Victoria\",\n \"province_code\": \"VIC\",\n \"country\": \"Australia\",\n \"country_code\": \"AU\",\n \"gps_latitude\": -37.8905312,\n \"gps_longitude\": 145.1857472,\n \"street_address\": null,\n \"area_name\": null,\n \"locality\": null,\n \"unit_floor\": null,\n \"landmark\": null,\n \"google_place_id\": null,\n \"contact\": {\n \"is_primary\": false,\n \"name\": \"MFC\",\n \"mobile_number\": \"+61888888888\",\n \"email\": \"palas@fast.com.au\"\n }\n },\n \"items\": [\n {\n \"name\": \"Carton 1\",\n \"type\": \"CARTON\",\n \"products\": [\n {\n \"product_id\": 1234,\n \"name\": \"Learn to Tie My Shoelaces Toy\",\n \"quantity\": 2\n },\n {\n \"product_id\": 1222,\n \"name\": \"Trick Sticks\",\n \"quantity\": 1\n }\n ],\n \"quantity\": 1,\n \"attributes\": [\n {\n \"category\": \"distance\",\n \"unit\": \"KM\",\n \"name\": \"3+ km\",\n \"value\": 13.765,\n \"attribute_type\": \"RANGE\",\n \"components\": [],\n \"additional_info\": null\n },\n {\n \"category\": \"weight\",\n \"unit\": \"KG\",\n \"name\": \"3+ kg\",\n \"value\": 3,\n \"attribute_type\": \"RANGE\",\n \"components\": [],\n \"additional_info\": null\n },\n {\n \"category\": \"volume\",\n \"unit\": \"meter3\",\n \"name\": \"volume\",\n \"value\": 1,\n \"attribute_type\": \"NUMBER\",\n \"components\": [],\n \"additional_info\": null\n }\n ]\n }\n ],\n \"payment\": {},\n \"schedule\": {\n \"scheduled_date\": \"2020-09-03\",\n \"cut_off_time\": \"2020-09-03 12:00:PM GMT+11\",\n \"expected_start_of_delivery\": \"2020-09-03 12:00:PM GMT+11\",\n \"expected_end_of_delivery\": \"2020-09-03 08:00:PM GMT+11\",\n \"expected_start_of_delivery_epoch\": 1725364800,\n \"expected_end_of_delivery_epoch\": 1725393600\n }\n }\n}"}],"_postman_id":"dc63a887-75c3-46b1-8d33-7c76d426bc74"},{"name":"Create order","id":"b1d58e9c-f635-40e8-8435-d7fc654083ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"Sample request body for LAST MILE order:\n\n{\n \"order_number\": \"238523756TEST\",\n \"service_id\": \"5fdba33b464511602669f654\",\n \"source_order_type\": \"HOME DELIVERY\",\n \"name\": \"Alex\",\n \"mobile_number\": \"+6100000000\",\n \"email\": \"test@gmail.com\",\n \"branch_id\": null,\n \"waybill_no\": null,\n \"from_branch_id\": null,\n \"to_branch_id\": null,\n \"quotation_id\": null,\n \"air_waybill_no\": null,\n \"tags\": {\n \"internal_order_id\": \"487487478\"\n },\n \"delivery\": {\n \"items\": [\n {\n \"name\": \"Carton 1\",\n \"type\": \"CARTON\",\n \"products\": [\n {\n \"product_id\": 1234,\n \"name\": \"Learn to Tie My Shoelaces Toy\",\n \"quantity\": 2\n },\n {\n \"product_id\": 1222,\n \"name\": \"Trick Sticks\",\n \"quantity\": 1\n }\n ],\n \"quantity\": 1,\n \"details\": {\n \"tracking_barcode\": [\n \"98765r6tyu8765\"\n ]\n },\n \"attributes\": [\n {\n \"category\": \"distance\",\n \"unit\": \"KM\",\n \"value\": 13.765\n },\n {\n \"category\": \"weight\",\n \"unit\": \"KG\",\n \"value\": 3\n },\n {\n \"category\": \"volume\",\n \"unit\": \"m3\",\n \"value\": 1\n }\n ]\n }\n ],\n \"from_branch_id\": \"212323\",\n \"from_address\": {\n \"google_formated_address\": \"Cnr Springvale, Ferntree Gully Rd, Wheelers Hill VIC 3170, Australia\",\n \"business_name\": null,\n \"address1\": \"Cnr Springvale, Ferntree Gully Rd, Wheelers Hill VIC 3170, Australia\",\n \"address2\": \"Wheelers Hill\",\n \"city\": \"Wheelers Hill\",\n \"zip\": \"3170\",\n \"province\": \"Victoria\",\n \"province_code\": \"VIC\",\n \"country\": \"Australia\",\n \"country_code\": \"AU\",\n \"gps_latitude\": -37.9059245,\n \"gps_longitude\": 145.1623669,\n \"street_address\": null,\n \"area_name\": null,\n \"locality\": null,\n \"unit_floor\": null,\n \"landmark\": null,\n \"google_place_id\": null,\n \"contact\": {\n \"is_primary\": false,\n \"name\": \"MFC Brandon Park\",\n \"mobile_number\": \"+6100000000\",\n \"email\": \"test@gmail.com\"\n }\n },\n \"to_branch_id\": \"212323\",\n \"to_address\": {\n \"google_formated_address\": \"Cnr Springvale, Ferntree Gully Rd, Wheelers Hill VIC 3170, Australia\",\n \"business_name\": null,\n \"address1\": \"Cnr Springvale, Ferntree Gully Rd, Wheelers Hill VIC 3170, Australia\",\n \"address2\": \"Wheelers Hill\",\n \"city\": \"Wheelers Hill\",\n \"zip\": \"3170\",\n \"province\": \"Victoria\",\n \"province_code\": \"VIC\",\n \"country\": \"Australia\",\n \"country_code\": \"AU\",\n \"gps_latitude\": -37.9059245,\n \"gps_longitude\": 145.1623669,\n \"street_address\": null,\n \"area_name\": null,\n \"locality\": null,\n \"unit_floor\": null,\n \"landmark\": null,\n \"google_place_id\": null,\n \"contact\": {\n \"is_primary\": false,\n \"name\": \"MFC Brandon Park\",\n \"mobile_number\": \"+6100000000\",\n \"email\": \"test@gmail.com\"\n },\n \"instruction\": {\n \"note\": \"test\",\n \"additional\": {\n \"id_verification\": true\n }\n },\n \"payment\": {\n \"payment_type\": \"COD\",\n \"delivery_charge\": 128.0,\n \"delivery_charge_tax\": 0,\n \"product_charge\": 0,\n \"product_charge_tax\": 0,\n \"total_amount\": 0,\n \"currency\": \"AUD\",\n \"payment_service\": null,\n \"cod_payment\": {\n \"collection_point\": \"PICKUP\"\n }\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{BASE_URL}/otoms/order/","description":"Api used to place a new delivery short distance order or long distance order.
\nNote:
\n1 .
-> Price calculation mainly depends on the services(i.e LAST MILE, COURIER)
-> For LAST MILE service, while price calculation users do not need to mention source_hub_id and destination_hub_id instead of that user needs to provide from_address and to_address as mandatory fields.
\n-> While passing the payment details, the user needs to make sure that if he wants to collect his/her product_charge while delivering the order then only pass that value,otherwise just pass product_charge as 0.
\nHeaders:
\nauthorization: \"Bearer Base64encodedValueOf(client_id:client_secret)\"
content-type : “application/json”
M - Mandatory Field
\nO - Optional Field – value can be empty but parameter must exist
\nRequest Attributes :
\nImportant Attributes common for Option mentioned above :
\nResponse Attributes:
\n","urlObject":{"path":["otoms","order",""],"host":["{BASE_URL}"],"query":[],"variable":[]}},"response":[{"id":"c8649433-bb25-43df-bc29-66174662dde0","name":"Response","originalRequest":{"method":"POST","header":[],"url":"{BASE_URL}/otoms/order/"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"genericResponse\": {\n \"apiStatusCode\": 200,\n \"apiSuccessStatus\": \"True\",\n \"apiStatusMessage\": \"Order creation success\"\n },\n \"order\": {\n \"id\": \"609d05ece079a55b099dbf37\",\n \"name\": \"some name\",\n \"service_id\": \"\",\n \"email\": \"example@gmail.com\",\n \"mobile_number\": \"+9196583773734\",\n \"customer_id\": \"602ccc20dbab12de26e0ceb7\",\n \"organization_id\": null,\n \"branch_id\": null,\n \"order_type\": \"DELIVERY\",\n \"status\": \"PLACED\",\n \"created_epoch\": 1620903404,\n \"created_datetime\": \"2021-05-13T10:56:44.623000\",\n \"delivery\": {\n \"from_address\": {\n \"google_formated_address\": \"Cnr Springvale, Ferntree Gully Rd, Wheelers Hill VIC 3170, Australia\",\n \"business_name\": null,\n \"address1\": \"Cnr Springvale, Ferntree Gully Rd, Wheelers Hill VIC 3170, Australia\",\n \"address2\": \"Wheelers Hill\",\n \"city\": \"Wheelers Hill\",\n \"zip\": \"3170\",\n \"province\": \"Victoria\",\n \"province_code\": \"VIC\",\n \"country\": \"Australia\",\n \"country_code\": \"AU\",\n \"gps_latitude\": -37.9059245,\n \"gps_longitude\": 145.1623669,\n \"street_address\": null,\n \"area_name\": null,\n \"locality\": null,\n \"unit_floor\": null,\n \"landmark\": null,\n \"google_place_id\": null,\n \"contact\": {\n \"is_primary\": false,\n \"name\": \"MFC Brandon Park\",\n \"mobile_number\": \"+61429008306\",\n \"email\": \"ankit@fastestcarrier.com.au\"\n }\n },\n \"to_address\": {\n \"google_formated_address\": \"Cnr Springvale, Ferntree Gully Rd, Wheelers Hill VIC 3170, Australia\",\n \"business_name\": null,\n \"address1\": \"Cnr Springvale, Ferntree Gully Rd, Wheelers Hill VIC 3170, Australia\",\n \"address2\": \"Wheelers Hill\",\n \"city\": \"Wheelers Hill\",\n \"zip\": \"3170\",\n \"province\": \"Victoria\",\n \"province_code\": \"VIC\",\n \"country\": \"Australia\",\n \"country_code\": \"AU\",\n \"gps_latitude\": -37.9059245,\n \"gps_longitude\": 145.1623669,\n \"street_address\": null,\n \"area_name\": null,\n \"locality\": null,\n \"unit_floor\": null,\n \"landmark\": null,\n \"google_place_id\": null,\n \"contact\": {\n \"is_primary\": false,\n \"name\": \"MFC Brandon Park\",\n \"mobile_number\": \"+61429008306\",\n \"email\": \"palas@fastestcarrier.com.au\"\n }\n },\n \"instruction\": {\n \"note\": \"Order\",\n \"need_box\": false,\n \"send_sms\": true,\n \"additional\": null\n }\n },\n \"price\": {\n \"price\": 0,\n \"currency\": \"AUD\",\n \"tax\": null,\n \"item_prices\": [\n {\n \"item\": {\n \"name\": \"Document\",\n \"variant_id\": \"\",\n \"quantity\": 1,\n \"description\": \"\",\n \"type\": \"CARTON\",\n \"products\": [\n {\n \"product_id\": 1234,\n \"name\": \"Learn to Tie My Shoelaces Toy\",\n \"quantity\": 2\n },\n {\n \"product_id\": 1222,\n \"name\": \"Trick Sticks\",\n \"quantity\": 1\n }\n ],\n \"attributes\": [\n {\n \"category\": \"distance\",\n \"unit\": \"KM\",\n \"name\": \"3+ km\",\n \"value\": 7.8709,\n \"attribute_type\": \"RANGE\",\n \"components\": [],\n \"additional_info\": null\n },\n {\n \"category\": \"weight\",\n \"unit\": \"KG\",\n \"name\": \"3+ kg\",\n \"value\": 3,\n \"attribute_type\": \"RANGE\",\n \"components\": [],\n \"additional_info\": null\n },\n {\n \"category\": \"volume\",\n \"unit\": \"meter3\",\n \"name\": \"volume\",\n \"value\": 1,\n \"attribute_type\": \"NUMBER\",\n \"components\": [],\n \"additional_info\": null\n }\n ]\n },\n \"price\": 0,\n \"currency\": \"AUD\",\n \"tax\": null\n }\n ]\n },\n \"payment\": {\n \"payment_type\": \"COD\",\n \"status\": \"PENDING\",\n \"delivery_charge\": 0,\n \"delivery_charge_tax\": 0,\n \"product_charge\": 0,\n \"product_charge_tax\": 0,\n \"currency\": \"AUD\",\n \"payment_service\": \"PREPAID\",\n \"cod_payment\": {\n \"collection_point\": \"PICKUP\",\n \"amount\": 0\n }\n },\n \"schedule\": {\n \"scheduled_date\": \"2020-09-03\",\n \"cut_off_time\": \"2020-09-03 12:00:PM GMT+11\",\n \"expected_start_of_delivery\": \"2020-09-03 12:00:PM GMT+11\",\n \"expected_end_of_delivery\": \"2020-09-03 08:00:PM GMT+11\",\n \"expected_start_of_delivery_epoch\": 1725364800,\n \"expected_end_of_delivery_epoch\": 1725393600\n }\n }\n}"}],"_postman_id":"b1d58e9c-f635-40e8-8435-d7fc654083ed"},{"name":"Update order","id":"13d9832b-5625-4ca3-9594-9e91cffeb784","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"PLACED\",\n \"order_id\":\"61d3f81e32485085abc3cdb6\",\n \"from_address\": {\n \"google_formated_address\": \"Cnr Springvale, Ferntree Gully Rd, Wheelers Hill VIC 3170, Australia\",\n \"business_name\": null,\n \"address1\": \"Cnr Springvale, Ferntree Gully Rd, Wheelers Hill VIC 3170, Australia\",\n \"address2\": \"Wheelers Hill\",\n \"city\": \"Wheelers Hill\",\n \"zip\": \"3170\",\n \"province\": \"Victoria\",\n \"province_code\": \"VIC\",\n \"country\": \"Australia\",\n \"country_code\": \"AU\",\n \"gps_latitude\": -37.9059245,\n \"gps_longitude\": 145.1623669,\n \"street_address\": null,\n \"area_name\": null,\n \"locality\": null,\n \"unit_floor\": null,\n \"landmark\": null,\n \"google_place_id\": null,\n \"contact\": {\n \"is_primary\": false,\n \"name\": \"MFC Brandon Park\",\n \"mobile_number\": \"+61429008306\",\n \"email\": \"saby@fastestcarrier.com.au\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{BASE_URL}/otoms/order/update/","description":"API used to update the order by changing the status of the order.
\nAn order can be canceled using status as CANCELED. Orders can only be canceled before it is ASSIGNED for delivery. A CANCELED order cannot be changed back to PLACED.
\nOrder update API will provide options to change from and to addresses before the order is ASSIGNED.
\nHeaders:
\nauthorization: \"Bearer Base64encodedValueOf(client_id:client_secret)\"
content-type : “application/json”
Request Attributes :
\nImportant Attributes common for Option mentioned above :
\nResponse Attributes:
\nHTTP status codes:
\n","urlObject":{"path":["otoms","order","update",""],"host":["{BASE_URL}"],"query":[],"variable":[]}},"response":[{"id":"162c253d-833c-4039-b195-8a375f471762","name":"Response","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"PLACED\",\n \"order_id\":\"61d3f81e32485085abc3cdb6\",\n \"from_address\": {\n \"google_formated_address\": \"Cnr Springvale, Ferntree Gully Rd, Wheelers Hill VIC 3170, Australia\",\n \"business_name\": null,\n \"address1\": \"Cnr Springvale, Ferntree Gully Rd, Wheelers Hill VIC 3170, Australia\",\n \"address2\": \"Wheelers Hill\",\n \"city\": \"Wheelers Hill\",\n \"zip\": \"3170\",\n \"province\": \"Victoria\",\n \"province_code\": \"VIC\",\n \"country\": \"Australia\",\n \"country_code\": \"AU\",\n \"gps_latitude\": -37.9059245,\n \"gps_longitude\": 145.1623669,\n \"street_address\": null,\n \"area_name\": null,\n \"locality\": null,\n \"unit_floor\": null,\n \"landmark\": null,\n \"google_place_id\": null,\n \"contact\": {\n \"is_primary\": false,\n \"name\": \"MFC Brandon Park\",\n \"mobile_number\": \"+61429008306\",\n \"email\": \"saby@fastestcarrier.com.au\"\n }\n }\n}"},"url":"{BASE_URL}/otoms/order/update/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"genericResponse\": {\n \"apiStatusCode\": 200,\n \"apiSuccessStatus\": \"True\",\n \"apiStatusMessage\": \"Update order success\"\n },\n \"order_details\": {\n \"id\": \"61f387d90367af3e1e3b4272\",\n \"name\": \"Decathlon\",\n \"service_id\": \"5fe340785c2c707b75a530b5\",\n \"email\": \"delivery.australia+1516@decathlon.com\",\n \"mobile_number\": \"82553647\",\n \"customer_id\": null,\n \"merchant_id\": \"616cf997686e0b287adc1114\",\n \"branch_id\": \"616d0af5686e0b287adc1116\",\n \"order_type\": \"DELIVERY\",\n \"service_type\": \"SAME_DAY\",\n \"pickup_type\": \"AGENT_PICKUP\",\n \"delivery_type\": \"AGENT_DROPOFF\",\n \"status\": \"PLACED\",\n \"created_epoch\": 1643349977,\n \"created_datetime\": null,\n \"chat_user_id\": null,\n \"delivery\": {\n \"from_address\": {\n \"google_formated_address\": \"Cnr Springvale, Ferntree Gully Rd, Wheelers Hill VIC 3170, Australia\",\n \"business_name\": null,\n \"address1\": \"Cnr Springvale, Ferntree Gully Rd, Wheelers Hill VIC 3170, Australia\",\n \"address2\": \"Wheelers Hill\",\n \"city\": \"Wheelers Hill\",\n \"zip\": \"3170\",\n \"province\": \"Victoria\",\n \"province_code\": \"VIC\",\n \"country\": \"Australia\",\n \"country_code\": \"AU\",\n \"gps_latitude\": -37.9059245,\n \"gps_longitude\": 145.1623669,\n \"street_address\": null,\n \"area_name\": null,\n \"locality\": null,\n \"unit_floor\": null,\n \"landmark\": null,\n \"google_place_id\": null,\n \"contact\": {\n \"is_primary\": false,\n \"name\": \"MFC Brandon Park\",\n \"mobile_number\": \"+61429008306\",\n \"email\": \"saby@fastestcarrier.com.au\"\n }\n },\n \"to_address\": {\n \"google_formated_address\": \"Cnr Springvale, Ferntree Gully Rd, Wheelers Hill VIC 3170, Australia\",\n \"business_name\": null,\n \"address1\": \"Cnr Springvale, Ferntree Gully Rd, Wheelers Hill VIC 3170, Australia\",\n \"address2\": \"Wheelers Hill\",\n \"city\": \"Wheelers Hill\",\n \"zip\": \"3170\",\n \"province\": \"Victoria\",\n \"province_code\": \"VIC\",\n \"country\": \"Australia\",\n \"country_code\": \"AU\",\n \"gps_latitude\": -37.9059245,\n \"gps_longitude\": 145.1623669,\n \"street_address\": null,\n \"area_name\": null,\n \"locality\": null,\n \"unit_floor\": null,\n \"landmark\": null,\n \"google_place_id\": null,\n \"contact\": {\n \"is_primary\": false,\n \"name\": \"MFC Brandon Park\",\n \"mobile_number\": \"+61429008306\",\n \"email\": \"saby@fastestcarrier.com.au\"\n }\n },\n \"instruction\": {\n \"note\": \"Order\",\n \"need_box\": false,\n \"send_sms\": true,\n \"additional\": null\n },\n \"tracking\": {}\n },\n \"price\": null,\n \"payment\": {\n \"payment_type\": \"COD\",\n \"status\": \"PENDING\",\n \"delivery_charge\": 0,\n \"delivery_charge_tax\": 0,\n \"product_charge\": 595.0,\n \"product_charge_tax\": 0,\n \"currency\": \"AUD\",\n \"payment_service\": \"POSTPAID\",\n \"cod_payment\": {\n \"collection_point\": \"PICKUP\",\n \"amount\": 0\n }\n }\n }\n}\n"}],"_postman_id":"13d9832b-5625-4ca3-9594-9e91cffeb784"},{"name":"Order status","id":"2b7d9433-5c71-4fad-bc7e-0a4a71197670","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"Sample Request :\n\nOrder_id:str -> path parameter","options":{"raw":{"language":"json"}}},"url":"{BASE_URL}/otoms/order/{order_id}","description":"Using this api user can get the status of the order
\nHeaders:
\nauthorization: \"Bearer Base64encodedValueOf(client_id:client_secret)\"
content-type : “application/json”
Response Attributes:
For POSTPAID merchant price attributes should be ignored
API used to get the order tracking details
\nHeaders:
\nauthorization: \"Bearer Base64encodedValueOf(client_id:client_secret)\"
content-type : “application/json”
Response Attributes
\n","urlObject":{"path":["otoms","order","{order_id}","tracking"],"host":["{BASE_URL}"],"query":[],"variable":[]}},"response":[{"id":"155846ca-e738-49e0-8e50-c9efb74c64e6","name":"Get order tracking details","originalRequest":{"method":"GET","header":[],"url":"{BASE_URL}/otoms/order/{order_id}/tracking"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"19902f1f-815b-4c9b-a0c4-73c7c61b0bcc"},{"name":"Webhook","id":"99c6954a-46c3-4ead-855d-0c59533f2f72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"We send webhook notification as a HTTP POST request with a well defined JSON payload on the provided endpoint URL.
\nWebhook events are treated to be successful if the endpoint URL responds with 200 OK Response within 10 seconds.
\nIn case of failure, there will be a total of 10 attempts every hour to process a webhook notification.
\nIf all attempts fail, processing of webhook notifications will be paused for the account.
\nHow To Create WebHook Endpoint API
\nWebhook endpoint API can be written in any server side coding language.
\nServer API should accept application/json content-type and should respond back within 10 seconds with 200 OK. Any other http response status would mark the notification as a failure.
\nWebHook Entity
\nA webhook event is always triggered for an entity. When the event occurs, relevant information of the entity is shared in the webhook notification.
\nEvents:
\nCurrently we support events for change of order status or change of status of the steps.
\nThe events supported are
\nSERVICE :
\nLAST MILE
\nEXAMPLE WEBHOOK:
\n{\n \"event_id\": \"31a4f0e13d304318a9303541622cb33f\",\n \"created_epoch\": 1662706125.481716,\n \"created_datetime\": \"2022-09-09 06:48:45.481716\",\n \"event_name\": \"placed\",\n \"order\": {\n \"id\": \"631ae1cc16e4cee21b284015\",\n \"name\": \" test\",\n \"service\": \"LAST MILE\",\n \"service_id\": \"61ee668a04f218adbed93826\",\n \"email\": null,\n \"mobile_number\": \"+917737362081\",\n \"customer_id\": null,\n \"merchant_id\": \"62872a35a2a2f84e0fd6ae1a\",\n \"branch_id\": \"DELIVERY\",\n \"service_type\": \"SAME_DAY\",\n \"pickup_type\": \"HUB_PICKUP\",\n \"delivery_type\": \"HOME_DEIVERY/HUB_DELIVERY\",\n \"status\": \"PLACED\",\n \"reason_type\": null,\n \"reason\": null,\n \"created_datetime\": \"2022-09-09T06:48:44.679000\",\n \"chat_user_id\": null,\n \"delivery\": {\n \"from_address\": {\n \"google_formated_address\": \"124-134 Millers Rd, Altona North VIC 3025, Australia\",\n \"business_name\": \"MFC atlona 2\",\n \"address1\": \"124/134 Millers Road,Altona North,Victoria,Australia\",\n \"address2\": null,\n \"city\": \"Altona North\",\n \"zip\": \"3025\",\n \"province\": \"Millers Road\",\n \"province_code\": \"Millers Rd\",\n \"country\": \"3025\",\n \"country_code\": \"3025\",\n \"gps_latitude\": -37.8278645,\n \"gps_longitude\": 144.848057,\n \"street_address\": null,\n \"area_name\": null,\n \"locality\": null,\n \"unit_floor\": \"\",\n \"landmark\": null,\n \"google_place_id\": \"ChIJCw54UeBg1moR_EUCyq3T3oY\",\n \"contact\": {\n \"is_primary\": false,\n \"name\": \"MFC atlona 2\",\n \"mobile_number\": \"+616846846464\",\n \"email\": \"vinay@onetraker.com\"\n }\n },\n \"to_address\": {\n \"google_formated_address\": \"124-134 Millers Rd, Altona North VIC 3025, Australia\",\n \"business_name\": null,\n \"address1\": \"124/134 Millers Road,Altona North,Victoria,Australia\",\n \"address2\": null,\n \"city\": \"Altona North\",\n \"zip\": \"3025\",\n \"province\": \"Millers Road\",\n \"province_code\": \"Millers Rd\",\n \"country\": \"3025\",\n \"country_code\": \"3025\",\n \"gps_latitude\": -37.8278645,\n \"gps_longitude\": 144.848057,\n \"street_address\": null,\n \"area_name\": null,\n \"locality\": null,\n \"unit_floor\": \"\",\n \"landmark\": null,\n \"google_place_id\": \"ChIJCw54UeBg1moR_EUCyq3T3oY\",\n \"contact\": {\n \"is_primary\": false,\n \"name\": \"test\",\n \"mobile_number\": \"+917737362081\",\n \"email\": \"\"\n }\n },\n \"instruction\": {\n \"note\": \" \",\n \"need_box\": false,\n \"send_sms\": false,\n \"additional\": null\n },\n \"tracking\": {\n \"tracking_code\": \"7b738aa336174b6bbe18b7e138692a01\",\n \"tracking_link\": \"https://onetraker.tech/#/custom/track-consignment/meta?token=7b738aa336174b6bbe18b7e138692a01\",\n \"driver\": {},\n \"do_history\": {}\n }\n },\n \"price\": {\n \"price\": 5,\n \"currency\": \"AUD\",\n \"tax\": null,\n \"item_prices\": [\n {\n \"item\": {\n \"name\": \"prod1\",\n \"type\": null,\n \"variant_id\": \"\",\n \"quantity\": 1,\n \"category\": \"\",\n \"category2\": \"\",\n \"category3\": \"\",\n \"description\": \"\",\n \"products\": null,\n \"attributes\": [\n {\n \"category\": \"distance\",\n \"unit\": \"KM\",\n \"name\": \"0-10km\",\n \"value\": 0,\n \"attribute_type\": \"RANGE\",\n \"components\": [],\n \"additional_info\": null\n }\n ]\n },\n \"price\": 5,\n \"currency\": \"AUD\",\n \"tax\": null\n }\n ]\n },\n \"payment\": {\n \"payment_type\": \"ONLINE\",\n \"status\": \"PAID\",\n \"delivery_charge\": 5,\n \"delivery_charge_tax\": 0,\n \"product_charge\": 11,\n \"product_charge_tax\": 0,\n \"currency\": \"AUD\",\n \"payment_service\": \"POSTPAID\"\n }\n }\n}\n\n-Do work with the API team for any queries regarding webhook events.
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"99c6954a-46c3-4ead-855d-0c59533f2f72"},{"name":"Tags","id":"47218b25-dee9-4d66-ac80-6c5a1670a8fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{BASE_URL}/otoms/merchant/tags/","description":"Using this API user can get the all Tags
\nHeaders:
\nauthorization: \"Bearer Base64encodedValueOf(client_id:client_secret)\"
content-type : \"application/json\"
Using this api user can get invoice
\nHeaders:
\nauthorization: \"Bearer Base64encodedValueOf(client_id:client_secret)\"
content-type : \"application/json\"