The authentication token is an alphanumeric code, unique to your Shipyaari account, can be used from any system to validate your API calls to access Shipyaari's resources. Shipyaari API uses JWT tokens for validation.
\nUse this API to validate your API user and obtain the authentication token. Copy this token and use it further to validate your API calls.
\nYour API keys carry many privileges, so be sure to keep them secure! Do not share your secret token in publicly accessible areas such as GitHub, client-side code, and so forth.
\nSteps To Use Token:
\nCopy the token received in response.
\nInclude 'Authorization: Bearer [yourtokenvalue]' in the appropriate field of your code.
\nThat's all! In case of any error, try checking your parameters.
\nNote:
\norder_id field cannot be equal to an already existing id. Doing so does not change or affect the existing order.
\nNew orders cannot be created with order id's same as that of cancelled orders. If error 422 shows up despite filling in the correct details, consider changing the order_id.
\nBe sure to input the correct calculated sub_total amount. The total is not calculated automatically through the API.
\nThe 'order_id' returned in the response is the Shipyaari order_id. Please save this order ID as we will use this in future API calls
\nIn a the Order type is B2B then gst Number is alway required for Pickup Details and And delhivery Details. ( for B2B shipment KYC type should be Business/company ).
\nThis draft order serves as a preliminary document to facilitate pickup arrangements and ensure timely processing of the order before the pickup stage.
\nThis API allows retrieval of the AWB for Delhivery B2B shipments using the Job ID.
\n","_postman_id":"5713731b-61cf-4cef-8ad2-707cd257380f"},{"name":"Labels | Manifests | Invoice","item":[{"name":"Generate Label","id":"93b6de4f-e524-429b-b98a-a9aebf8126a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Generate the label of order by passing the shipment id in the form of an array. This API displays the URL of the generated label.
\nNote:
\nThe AWB must be assigned to the shipment to generate the label.
\n'AWB' must be passed as an array.
\nUsing this API, you can generate the manifest for your order. This API generates the manifest and displays the download URL of the same.
\nNote:
\nMultiple AWBs can also be passed as an array for bulk generation of manifests.
\nAWB must be assigned and pickup requested on the shipment id to generate manifest.
\nUse this API to generate the invoice for your order by passing the respective Shipyaari order ids.
\nThe generated invoice URL is displayed as a response. Multiple ids can be passed together as an array.
\nNote
\nThese APIs are designed for the generation of manifests, invoices and labels for your shipment. You can also get manifest details and print a manifest using the respective API's.
\nSample Label
\nSample Invoice
\nSample Manifest
\nNote : Encountering difficulty in saving successful calls for label, manifest, and invoice generation due to the direct generation of PDFs.
\n","_postman_id":"8794c3db-1e09-4bd3-935f-a1a39e9fdf88"},{"name":"Cancel Order","item":[{"name":"Cancel Shipment","id":"50768a45-03bd-4ad6-991d-20c92407cac4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"awbs\": [\r\n \"76947842882\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-seller.shipyaari.com/api/v1/order/cancelAWBs","urlObject":{"protocol":"https","path":["api","v1","order","cancelAWBs"],"host":["api-seller","shipyaari","com"],"query":[],"variable":[]}},"response":[{"id":"d732afaf-00a4-475a-be14-162970ac2bd7","name":"Cancel Shipment","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"awbs\": [\r\n \"76947842882\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-seller.shipyaari.com/api/v1/order/cancelAWBs"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Jan 2024 06:53:07 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"RateLimit-Limit","value":"500"},{"key":"RateLimit-Remaining","value":"498"},{"key":"RateLimit-Reset","value":"18"},{"key":"ETag","value":"W/\"41-sug/7myno5Opgf1MT/OhZjIIbcM\""},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=HyrkDq%2FB3WQvEOh341e5AHFbqMhaaZcaXUQKFhaMqLOtP43kk%2BeDNGIpjAz6dGqcZVibAv4QkCpN%2FDrQeSgCmIpQ1Hgp9muE3FP8Vwl6KunuE7%2BsSYK3Wg6ckYE4npnuMta62zjpuF%2BlEXA%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"843b3da6fe240aaf-IAD"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [],\n \"message\": \"AWB Cancel Process Started\"\n}"}],"_postman_id":"50768a45-03bd-4ad6-991d-20c92407cac4"}],"id":"d8faa88f-c11f-471d-91fe-99c2241915a6","description":"Use this API to cancel a created shipment before the \"Out for Pickup\" state. Multiple AWBs can be passed together as an array to cancel them simultaneously.
\nLimit: 2000 AWBs
\nGet the tracking details of your shipment by entering the AWB Number of the same in the endpoint URL itself. No other body parameters are required to access this API.
\nThe response is displayed in JSON format.
\nTracking Statuses
\nBOOKED
\nNOT PICKED
\nPICKED UP
\nIN TRANSIT
\nREACHED DESTINATION
\nOUT FOR DELIVERY
\nDELIVERED
\nEXCEPTION
\nRTO IN TRANSIT
\nRTO REACHED DESTINATION
\nRTO OUT FOR DELIVERY
\nRTO DELIVERED
\nLOST/DAMAGE
\nRTO EXCEPTION
\nCANCELLED
\nREVERSE DELIVERED
\nREVERSE EXCEPTION
\nREVERSE IN TRANSIT
\nName : Search Service Availability Smart API
\nRule : All parameters are required.
\nValidation: Enter proper pickup pincode,
\nEnter proper delivery pincode,
\nEnter proper payment mode – COD or Online,
\nEnter proper weight,
\nEnter proper Length , Width , Height
\nEmter proper invoiceValue
\nPurpose: To check serviceability of pincodes and which all courier company has services available on a mentioned set of pincodes.
\nDescription: Check pincode serviceability is a function which shows all kinds of services available on a particular set of pincodes and which all courier company is available for service along with its rates. You can then decide which courier company you want to choose and then can proceed with creating a consignment procedure.
\n","_postman_id":"41bfa1f8-114d-45ff-8df5-963d40ed833c"},{"name":"Mark Order RTO / Re-attempt","item":[{"name":"Mark RTO / Re-attempt","id":"63a19597-4afd-4181-9427-b9137d7969d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"These APIs can be used to get details about your shipments that are in NDR,
\nNDR (Non-Delivery Report) provides details about shipments that couldn't be delivered. It includes reasons for non-delivery and allows actions like:
\nFetching Shipment Details: View all or specific NDR shipments.
\nTaking Actions: Initiate Reattempt delivery or RTO (Return to Origin) based on the non-delivery reason.
\nGenerated from cURL: curl --location 'https://tracking.shipyaari.com/api/v1/tracking/weight-discrepancy-recon'
--header 'Content-Type: application/json'
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6ImJoYWd5YXNocmVlLmdvdGVAc2hpcHlhYXJpLmNvbSIsInNlbGxlcklkIjoxNDA3NTksImNvbXBhbnlJZCI6IjAwYThkZDZmLTlhNzAtNDk3ZS1iN2JkLTJjMTQ5NTIxZmRhZCIsInByaXZhdGVDb21wYW55SWQiOjEzOTIxMiwiaWF0IjoxNzY5NTAzNTE0LCJleHAiOjE3NzAxMDgzMTR9.dTeWeXdMlBUZpVcneS7F8yavju6C21FJsYj_0h447kIeyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6ImJoYWd5YXNocmVlLmdvdGVAc2hpcHlhYXJpLmNvbSIsInNlbGxlcklkIjoxNDA3NTksImNvbXBhbnlJZCI6IjAwYThkZDZmLTlhNzAtNDk3ZS1iN2JkLTJjMTQ5NTIxZmRhZCIsInByaXZhdGVDb21wYW55SWQiOjEzOTIxMiwiaWF0IjoxNzY5NTAzNTE0LCJleHAiOjE3NzAxMDgzMTR9.dTeWeXdMlBUZpVcneS7F8yavju6C21FJsYj_0h447kI'
--data ' {\"orderId\": \"3627\"}'
Use this API to get the weight discrepancy details of your order.
\n","_postman_id":"5cc5c94c-cf68-41ce-ad0b-4839869427cc"},{"name":"Modify Order","item":[{"name":"Change Buyer Details","id":"d55360ff-0536-483f-9f63-f594bc441659","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"This API is used to update buyer details for orders booked through Sprint partners only.
\nUpdates are limited to the receiver/buyer’s name and phone number.
\nChanges can be made only after the order is booked and before it is picked up.
\nBuyer details cannot be modified for cancelled orders.
\nWelcome to Shipyaari's API Documentation. We've designed this document to help developers and Shipyaari users fully understand and integrate our API for a seamless and easy deployment. These APIs enable you to utilize most of your Shipyaari account's panel features fully.
\nWe've listed all the APIs, their required parameters, and their example requests and responses on the right for easy understanding. The easiest way to start using the Shipyaari APIs is by clicking the Run in Postman button above. The Postman is a free tool that helps developers run and debug API requests.
\nOur APIs are based around REST architecture and use the basic HTTP request methods. Our APIs accept JSON - encoded body requests and return data in the same form.
\nRead through the following sections for the integration process.
\nHey there, thanks for visiting Shipyaari API Documentation. This report is intended to support designers and Shipyaari clients in completely understanding and incorporating our API's for consistent and simple integration. These API's empower you to completely use practically all the functions of Shipyaari is having n its dashboard.
\nOur API's are based around REST engineering and utilize the essential HTTP demand strategies. We provide results in JSON format.
\nProduction Base URL: https://api-seller.shipyaari.com
\nStaging Base URL : https://stage-api-seller.shipyaari.com
\nAll the necessary information on integration is laid out in this document. Please read it thoroughly.
For any integration and API related support, you can feel free to drop us an email at tech@shipyaari.com.
Our APIs use the basic HTTP request codes: POST, GET
\nYou can select the required response and request code language by selecting it from the drop-down menu on the top.
\nYou can import and test all our full API collection in the Postman app by clicking on the ' Run in Postman' button.
\nAuthorization: Bearer
\nAll the APIs are provided with their appropriate example requests and responses for successful and failed calls. The example definitions are:
\nSuccessful Call: The API call was correct.
\nInvalid Data: The data entered was incorrect.
\nMissing Fields: Some of the required fields are missing.
\nWrong Format: There is a syntax error in the code.
\nWhile using Shiyaari's APIs, you may run into some standard response and error codes. The most common ones are listed along with their descriptions as follows:
\n","_postman_id":"992c7ff3-47fc-4eca-9171-6d63fd1e9c33"}]}