Using this InTargos API documentation guide, developers/users can integrate our platform into their applications. The API is designed to allow application developers to use and manage following:
\nWarehouse Management
\nAdd Warehouse
\nUpdate Warehouse
\nGet Warehouse Details
\nOrder Management
\nCreate Forward Order
\nCreate Reverse Order
\nCreate MPS/B2B Order
\nGenerate Shipping Labels
\nCancel Order
\nOrder Tracking
\nTracking History
\nLatest Status
\nNDR Management
\nRe-Attempt
\nRe-Schedule
\nMark RTO
\nUpdate Details
\nUtility APIs
\nRate Calculator
\nPincode Serviceability Check
\nCarriers Availability
\nForward Operations – Orders that are originating at client's warehouse or seller's side and are to be delivered to end customer.
\nReverse Operations – Return orders that are originating at customer side and are to be delivered or returned to client's warehouse or seller.
\nEndpoint URL – https://staging.intargos.com/api
\nToken/API Key – VNL3N8FGEWK67O4HPL5IUXBSRM2VPU
\nEndpoint URL – https://app.intargos.com/api
\nToken/API Key – Can be obtained from – Profile > My Details > API Token Key
\nAWB – Also known as waybill number or airwaybill number is unique tracking number which is obtained when any order is successfully placed within InTargos system.
\nOrder Id – Unique Order Id is given to every order within InTargos System for references.
\nAuthentication – Each call for InTargos API request requires an Authentication Token called as signature, to process your API request in our system. There will be different Staging and Production API key/signature.
\nInTargos API uses HTTP status codes to indicate the status of your requests. This includes successful, unsuccessful and error responses. All responses are in JSON by default.
\n200 - OK: Everything went as planned.
\n400 - Bad Request: You did something wrong. Often a missing argument or parameter.
\n401 - Unauthorized: Authentication was incorrect.
\n404 - Not Found
\n405 - Method not allowed
\n500 - Internal Server Error: We had a problem processing the request.
\n503 - Service Unavailable: Try again later.
\nIt makes use of standard HTTP verbs like GET, POST
\nThe API uses standard HTTP error responses to describe errors.
\nAuthentication is specified with HTTP Token Authentication.
\nPOST data should be encoded as standard application/JSON
\nCreation of pickup locations is essential for initiating pickups. Users have the capability to add multiple pickup locations through this API. Each address is assigned with unique address id, (can be found in InTargos Dashboard under \"Manage Warehouse\"). This unique address ID is utilized during the order creation.
\nThis usually comes under advance integration, and hence before creating an order, the client warehouse needs to be created in our system.
\nIntegration of this API is completely optional, as the same can be created using InTargos Dashboard. But if the business use case demands dynamic pickup locations addition, then this API is good to integrate with.
\nThe pickup address will be also be registered as return address, by default.
\nThis update API facilitates the modification of existing warehouse details within InTargos system. All details can be altered, with the exception of the warehouse title, which is unique & serves as identifier for InTargos system.
\nIntegration of this API is also optional, as the same can be updated using InTargos Dashboard.
\nThe pickup address will be also be registered as return address, by default.
\nThis GET API enables you to fetch and view details of existing warehouse within InTargos system based on address title.
\nThis API collection provides endpoints for the management of your warehouses or pickup addresses. These APIs facilitate tasks such as creating new warehouses or pickup locations and modifying existing ones.
\n","_postman_id":"44b1f40b-30ca-421f-8719-8d37073d21fd"},{"name":"Order Management","item":[{"name":"Create Forward Order","id":"b4c9505f-2a4f-449b-94ae-13b74c511b4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"signature","value":"ENVIRONMENT'S TOKEN KEY","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"consignee_name\": \"Mr. Somesh Diwakar\",\r\n \"consignee_mobile\": \"9876543210\",\r\n \"consignee_phone\": \"01203216540\",\r\n \"consignee_emailid\": \"somesh.d@gmail.com\",\r\n \"consignee_address1\": \"Address Line 1\",\r\n \"consignee_address2\": \"Near Some Landmark\",\r\n \"address_type\": \"\",\r\n \"consignee_pincode\": \"201301\",\r\n \"consignee_city\": \"Noida\",\r\n \"consignee_state\": \"Uttar Pradesh\",\r\n \"consignee_country\": \"India\",\r\n \"invoice_number\": \"INVN - 23/21\",\r\n \"payment_mode\": \"COD\",\r\n \"express_type\": \"surface\",\r\n \"is_ndd\": \"0\",\r\n \"order_amount\": \"1499.00\",\r\n \"cod_amount\": \"1299\",\r\n \"shipment_weight\": \"0.5\",\r\n \"shipment_length\": \"10.00\",\r\n \"shipment_width\": \"10.00\",\r\n \"shipment_height\": \"10.00\",\r\n \"pick_address_id\": \"160\",\r\n \"return_address_id\": \"160\",\r\n \"seller_id\":\"\",\r\n \"ewaybill_number\":\"\",\r\n \"products\": [\r\n {\r\n \"product_name\": \"Product Name 1\",\r\n \"product_quantity\": \"1\",\r\n \"product_value\": \"100.00\",\r\n \"product_category\":\"\",\r\n \"product_description\": \"\",\r\n \"product_sku\": \"PN1SKU\",\r\n \"product_hsnsac\":\"\",\r\n \"product_taxper\": 18\r\n },\r\n {\r\n \"product_name\": \"Product Name 2\",\r\n \"product_quantity\": \"1\",\r\n \"product_value\": \"100.00\",\r\n \"product_category\":\"\",\r\n \"product_description\": \"\",\r\n \"product_sku\": \"PN2SKU\",\r\n \"product_hsnsac\":\"\",\r\n \"product_taxper\": 5\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/api/CreateOrder","description":"This API is employed to initiate a new forward order in our system. Upon the creation of each order, a unique order ID is dynamically assigned. Upon successful order processing, a unique waybill/tracking number is then allocated.
\nThis API facilitates single order only. For bulk order - Bulk Order option can be used within InTargos Dashboard.
\nThis API is utilized to initiate a new reverse order within our system. With each order creation, a unique order ID is dynamically assigned. Upon successful order completion, a distinctive waybill/tracking number is then allocated.
\nThis API facilitates single order only. For bulk order - Bulk Order option can be used in InTargos Dashboard.
\nThis API facilitates to initiate B2B or Multi Piece Shipments (MPS) orders. Every time an order is created, a unique order id is dynamically allocated to it. Upon successful order creation, an unique waybill/tracking numbers are assigned in Parent-Child format. Correspondingly, multiple shipping labels are generated, which can be affixed/paste to various boxes associated with the same order.
\nThis API facilitates single order only with multiple boxes in same order.
\nPass address id for pick_address_id, parameter. Address Id can be obtained from InTargos Dashboard, under Manage Warehouse, option.
\nBy default, Return Address (in case of RTO), will be same as pick address, if no return_address_id, is given.
\nPass return_address_id, if you want to get the shipment returned to different address from that of pick-up address, in case of RTO.
\nFor Multi Piece Shipments (MPS), several Air Way Bills (AWBs) will be generated according to the details of the number of boxes provided in the payload.
\nLikewise, multiple shipping labels will be generated for MPS orders. These labels can be acquired by submitting the Parent/Master waybill number in the ShippingLabelAPI
\nThis API furnishes all the necessary information that needs to be included on the shipment packing slip or shipping label. Clients have the flexibility to incorporate these details into their HTML, aligning with their specific design preferences for the shipping label. Alternatively, a PDF link of the shipping label, according to the design preferences set in the InTargos Dashboard, can be obtained in the response.
\nTo retrieve details for multiple shipments, one can pass comma-separated waybill numbers.
\nThis API helps you to get the printed document to get it signed by the pickup partner as proof of handover of the shipments. Different manifests get generated for different courier and pick up address.
\nTo retrieve details for multiple shipments, one can pass comma-separated waybill numbers.
\nThis API is employed to cancel shipments within the InTargos system that are in an appropriate state (such as Booked or Ready for Pickup), that is allowing the cancellation request is made before the pickup stage, only.
\nThis API spec offers endpoints for order management, providing functionalities for creating single forward orders, single reverse orders, MPS/B2B orders.
\nIt also includes APIs for generating shipping labels and canceling orders.
\n","_postman_id":"863d4214-2790-4749-b535-9d7d46e49025"},{"name":"Order Tracking","item":[{"name":"ShipmentTracking","id":"bb4a3b21-9711-489d-b8a6-f5355ddbb1c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"signature","value":"ENVIRONMENT'S TOKEN KEY","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"waybill\": \"5027010207546\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/api/ShipmentTracking","description":"This API can be consumed for tracking any shipment within InTargos system. It allows you to retrieve details of all scans throughout the entire travel lifecycle of the shipment.
\nThis API consumes single valid waybill number only, for getting scans of the shipment.
\nThis API can be used to fetch latest status of the shipment in InTargos system.
\nThis API consumes single valid waybill number only, for getting latest status of the shipment.
\nThis API specification enables you to retrieve tracking details for any order within the InTargos System. These APIs facilitate obtaining the latest status and comprehensive status scans for a requested AWB number(s).
\n","_postman_id":"5ee6894c-9a97-44e9-adb3-6cac04a9a3ce"},{"name":"NDR APIs","item":[{"name":"Re-Attempt","id":"076a9a5b-9e9a-412a-abf7-9a4a59fcc371","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"signature","value":"VNL3N8FGEWK67O4HPL5IUXBSRM2VPU"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"waybill_number\": \"4840610101581\",\n \"ndr_action\": \"re_attempt\"\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.intargos.com/api/CreateNDR","description":"This API collection handles NDR instruction for non-delivered or failed delivery shipments. NDR instructions can include the following options:
\nRe-Attempt: Attempt delivery for the next day.
\nRe-schedule: Schedule delivery on a specified date.
\nCancel Order: Cancel & Return back the order.
\nUpdate Details: Modify delivery details. (This feature only accepts a new address within the same city or within a specified distance range, which varies for different courier services)
\nThis API facilitates to get approximate charges for the any shipment/order carrier-wise, based on inputs given in request payload and carriers assigned.
\nIntegration of this API is completely optional, as the rates can also be obtained using InTargos Dashboard.
\nThis API facilitates to get approximate charges for the any shipment/order for B2B shipments carrier-wise, based on inputs given in request payload and carriers assigned.
\nIntegration of this API is completely optional, as the rates can also be obtained using InTargos Dashboard.
\nFor MPS/B2B shipments, we need to provide boxes details as per format below:
\nThis API allows to check serviceability of destination or source Pincode within InTargos system including other services available for queried pincode.
\nPincode serviceability can be checked using InTargos Dashboard also.
\nFollowing Pincodes can be tested in Staging:
\nThis API facilitates in giving us the list of carriers available for given pincode on real-time basis along with carrier id, which can be passed in CreateOrder API, (when you want to place order with specific courier).
\nThis API also allows you to get carrier-wise charges, when you change get_charges parameter to true.
These Utility APIs comprise an additional collection of APIs provided by InTargos, assisting you in obtaining details such as Rate Calculator, Pin Serviceability, and retrieving the list of carriers assigned to you for specific slab and zone.
\nThese APIs can be integrated and uses based on your specific business use cases.
\n","_postman_id":"65cbd9c6-6ed9-4efb-aca4-0d3f7fcf4e3f"},{"name":"Tracking Webhook","item":[{"name":"Push API","id":"401c8048-c297-4c59-ba0d-7a7f586fe668","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"awbNumber\" : \"23458521566855\" ,\r\n \"intargosOrderid\" : \"305421\",\r\n \"pushScan_refno\" : \"98754120\",\r\n \"status\" : \"In Transit\",\r\n \"statusCode\" : \"223\",\r\n \"statusDescription\" : \"Shipment in transit\",\r\n \"statusTimestamp\" : \"2024-01-24 18:34:16\",\r\n \"statusLocation\" : \"Mumbai-Hub\",\r\n \"rtoAWBNumber\" : \"\",\r\n \"rtoComment\" : \"\",\r\n \"expectedDelivery\" : \"2024-0-30\",\r\n \"shipmentPOD\" : \"POD Link\",\r\n \"ndr_code\" : \"\",\r\n \"ndr_reason\" : \"Reason for NDR\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://YourWebhookURL.com","description":"We offer a generic PUSH API callback for our customers, enabling them to receive real-time notifications for each status change in push notifications.
\nTracking Webhook or Push API can be used to received real-time tracking status updates for the shipments within InTargos system.
\n","_postman_id":"ccf64ee6-cbc3-426b-968c-b34e35c202b7"},{"name":"Tracking Statuses","id":"0931b8f6-3eea-4363-91dc-382614448d9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OPTIONS","header":[],"url":"InTargos Tracking Statuses","description":"Different Status and Scans For Every Package Life Cycle
\nInTargos provides below mentioned \"Status Code\" and \"Status\" for forward and reverse shipments giving more clarity on the status of package in the entire lifecycle.
\n","urlObject":{"host":["InTargos Tracking Statuses"],"query":[],"variable":[]}},"response":[],"_postman_id":"0931b8f6-3eea-4363-91dc-382614448d9c"},{"name":"NDR Codes","id":"b8dfa301-c376-4dca-8ab9-5393889c1f00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OPTIONS","header":[],"url":"InTargos NDR Status Codes","description":"With InTargos you get below mentioned \"NDR Status Codes\" along with reason for forward and reverse shipments, which are not delivered due to particular reason.
\n","urlObject":{"host":["InTargos NDR Status Codes"],"query":[],"variable":[]}},"response":[],"_postman_id":"b8dfa301-c376-4dca-8ab9-5393889c1f00"}],"event":[{"listen":"prerequest","script":{"id":"66142374-afb7-489e-ba5b-7f57c64b88dc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"dcc4a163-ba11-45dc-aeef-05014cd14679","type":"text/javascript","exec":[""]}}]}