Integration with Old Dashboard
      Back to home
      1. Knowledge Base
      2. Integrations
      3. Integration with Old Dashboard

      API Integration

      Standard Integration with Shipyaari

      Step 1 - Seller Onboarding with Shipyaari

      • Seller needs to open an account with Shipyaari before initiating the integrations.
      • Sellers need to share basic business information to enable Shipyaari to generate the distinct unique Key to access the APIs.
        Following are the seller’s business related information required:
        • Company Name
        • Email ID - This would be the email address for Seller’s Shipyaari Account
        • Contact Number - This would be the email address for Seller’s Shipyaari Account
        • GSTN / PAN

      Step 2 - Generation of AVN Key

      • AVN Key is the API key of Shipyaari’s APIs
      • AVN Key is critical requirement in the API Integration of the two systems (Shipyaari and Seller’s OMS)
      • AVN Key has a peculiar format : Client_id@ Parent_id
        Eg: 26594@19840 

      Step 3 - Staging Credentials

      • Once the seller is onboarded and AVN Key is generated, Seller will receive the Staging Credentials for the purpose of integration.
      • These credentials are: Username (Eg: info@seller.com) & AVN Key

      Step 4 - API Library and Integration

      • API's are based around REST engineering and utilize the essential HTTP demand strategies.
      • APIs provide responses in JSON format.
      • Staging Base URL: https://staging.shipyaari.com
      • Production Base URL: https://seller.shipyaari.com

      1. Search Service API

      Purpose: To check serviceability of pincodes and which all courier companies have services available on a mentioned set of pincodes.

      • You will require the AVN key to proceed with the function, the key is a combination of your client id and parent id. You can find client id on your dashboard and for parent id, you will need to connect with your sales coordinator.
      • Important Validations:
        • Enter proper pickup pincode
        • Enter proper delivery pincode
        • Enter proper payment mode – COD or Online
        • Enter proper weight
        • Enter proper total invoice value
        • Enter proper avnkey – which combination of clientId@parentId

      a. Search Service API (B2C)

      POST : https://seller.shipyaari.com/logistic/webservice/SearchAvailability_new.php

      Request Variables:

      Sr.No Parameter Description Mandatory Example
      1 pickup_pincode Pickup pincode for the Order Yes 411001
      2 delivery_pincode Delivery Pincode for the Order Yes 110001
      3 weight Weight of the consignment (in Kg) Yes 0.5
      4 paymentmode If the order is paid for the buyer online or is it COD Yes Online
      5 service_name Priority / Standard / Express service requested for Processing the said order Yes Standard
      6 total_invoice_value Total Value of the Order (in ₹) Yes 100
      7 avnkey AVN Key of the seller Yes 12345@54321


      Possible Errors:

      Sr.No Error Reason Resolution
      1 Code: 200 OKError :
      [{"status":"SY Failure : PICKUP
      PINCODE NOT AVAILABLE"}]      		 If Pickup Pincode is missing Make sure you’ve entered a valid Pickup pincode
      2 200 OKError : [{"status":"SY  
      Failure :DELIVERY PINCODE
      NOT AVAILABLE"}      		 If Delivery Pincode is missing Make sure you’ve entered a valid Delivery pincode
      3 200 OKError : {"status":"Please
      Enter the weight"}      		 If consignment Weight is missing Make sure you’ve entered accurate weight (in Kg)
      4 200 OKError : {"status":"Service
      not available"}      		 If Payment Mode is missing Make sure you’re passing the appropriate payment code for getting the accurate response. Please check with our Service team to know more about COD
      Payment
      5 200 OKError : {"status":" SY
      Failure : Please Enter Package
      invoice value"}      		 If the invoice value is missing Make sure you’ve entered accurate Invoice Value
      6 Code:500 Internal Server Error Incorrect URL Please verify if you’re using the correct API URL

      b. Search Service API (B2B)

      POST : https://seller.shipyaari.com/avn_ci/siteadmin/btob_search_service/index

      Search Service API designed specifically for the B2B Consignments

      Additional Request Variables: the B2B Search Service API requires some additional Product
      related request variables:

      Sr.No Parameter Description Mandatory Example
      1 pickup_pincode Pickup pincode for the Order Yes 411001
      2 delivery_pincode Delivery Pincode for the Order Yes 110001
      3 weight Weight of the consignment (in Kg) Yes 0.5
      4 paymentmode If the order is paid for the buyer online or is it COD Yes online
      5 service_name Priority / Standard / Express service requested for Processing the said order Yes Standard
      6 total_invoice_value Total Value of the Order (in ₹) Yes 100
      7 avnkey AVN Key of the seller Yes 12345@54321
      An Array of Product Data
      8 pod Proof Of Delivery Yes Yes/No
      9 prod_name Product Name Yes Product 1
      10 prod_qty Quantity to be shipped Yes 120
      11 total_qty Total Qty of the said product Yes 500
      12 prod_weight Weight of the individual product Yes 1.5
      13 prod_price Price of the Product Yes 50.00
      14 total Total Price Yes 50
      15 length Product Dimensions Yes 5
      16 width Yes 9
      17 height Yes 1

      c. Search Service API (International Shipments)

      POST : https://seller.shipyaari.com/avn_ci/siteadmin/international_search_service/index
      Returns the Service Providers for your International Shipping requirements

      Request Variables:

      Sr.No Parameter Description Mandatory Example
      1 pickup_pincode Pickup pincode for the Order Yes 411001
      2 delivery_pincode Delivery Pincode for the Order Yes 110001
      3 weight Weight of the consignment (in Kg) Yes 0.5
      4 paymentmode If the order is paid for the buyer online or is it COD Yes online
      5 service_name Priority / Standard / Express service requested for Processing the said order Yes Standard
      6 total_invoice_value Total Value of the Order (in ₹) Yes 100
      7 avnkey AVN Key of the seller Yes 12345@54321
      Additional Parameters:
      8 pod Proof of Delivery Yes Yes/No
      9 pickup_country Country of Origin Yes India
      10 delivery_country Country of Destination Yes England

      2. Create Consignment API

      Purpose: Api's to create consignments.

      • You will require an AVN key to proceed with the function, the key is a combination of your client id and parent id.

      POST : https://seller.shipyaari.com/logistic/webservice/create_consignment_api.php

      Request Variables:

      Sr.No Parameter Description Mandatory Example
      1 username Seller’s Username Yes 411001
      2 order_id Order identifier Yes 110001
      3 from_(all form parameters) Pick up location Yes  
      4 to_(all to parameters) Drop location Yes Online
      5 customer_(all customer
      parameters)      		 Customer Details Yes Standard
      6 total_invoice_value Total Value of the Order (in ₹) Yes 100
      7 created_by Order creation Log Yes  
      8 avnkey AVN Key of the seller Yes 12345@54321
      9 no_of_packages Package details and dimensions
      that would decide the service fees      		    
      10 package_details    
      11 package_weight    
      12 package_length    
      13 package_width    
      14 package_height    
      15 total      
      16 total_price_set      

      Note: Except "product_data","total_price_set","channel" parameters all other parameters should
      be base64encoded (Read more here: https://developer.mozilla.org/en-S/docs/Glossary/Base64)

      Possible Errors:

      a. Reverse Consignment

      POST : https://seller.shipyaari.com/logistic/webservice/create_consignment_api.php

      Use this API to create a Reverse Consignment Request

      b. Create Consignment (B2B)

      POST : https://seller.shipyaari.com/avn_ci/siteadmin/shipment_api/consignment_b2b_prod

      Use this API to create a Reverse Consignment Request

      3. Check Pincode API

      POST: https://seller.shipyaari.com/client/siteadmin/api/check_pincode

      Request Variables:

      Sr.No Parameter Description Mandatory Example
      1 avnkey Seller’s unique AVN Key Yes 1234@567
      2 pickup_pincode Pincode of Consignment Pickup Yes 400061
      3 delivery_pincode Pincode of the DEstination Yes 110001
      4 payment_mode Mode of Payment for the said order Yes Online

      4. Get Label API

      POST: https://seller.shipyaari.com/client/siteadmin/labels/getlabel_avn

      Purpose: Api's to generate Labels for the consignments.

      Request Variables:

      Sr.No Parameter Description Mandatory Example
      1 avnkey Seller’s unique AVN Key Yes 1234@567
      2 shipyaari_id Seller’s unique Shipyaari ID Yes SHIPYAARI-1462

      Possible Errors:

      Sr.No Error Reason Resolution
      1 Code: 200 OKError : No response (Empty Response) Empty Response AVN key is incorrect or wrong
      2 Code : 200 OK Error: {"label_pdf":null} If Delivery Pincode is missing Make sure you’ve entered a valid Delivery pincode

      a. Get Label B2B

      POST: https://seller.shipyaari.com/avn_ci/siteadmin/shipment_api/get_b2b_labels

      This API allows you to request Labels for Multiple orders in a single request

      5. Manifest API

      Purpose: Api's to generate Manifest for the consignments.

      Request Variables:

      Sr.No Parameter Description Mandatory Example
      1 avnkey Seller’s unique AVN Key Yes 1234@567
      2 shipyaari_id Seller’s unique Shipyaari ID Yes SHIPYAARI-1462
      3 type   Yes tracking_number

      Possible Errors:

      Sr.No Error Reason Resolution
      1 200 OK
      Error: {"status":false,"msg":"avn
      key not found"}      		 AVN Key is missing or incorrect Please verify your AVN Key and try again
      2 200 OK
      Error Respone:
      {"status":false,"msg":"Tracking
      Number not found "}      		 AVN Key is Null Please verify your AVN Key and try again
      3 200 OK
      Error: {"status":false,"msg":"Tracking
      Number not found"}      		 If Tracking ID is incorrect Tracking Number is incorrect
      4 200 OK
      Error: response = null      		 If Tracking ID is Null Tracking Number is missing

      6. Tracking API

      Purpose: Get the current status of a particular order through this API by passing
      the Shipyaari AVN key and tracking number.

      a. Track Current Status (B2C)

      POST : https://seller.shipyaari.com/avn_ci/siteadmin/track/trackstatus

      Request Variables:

      Sr.No Parameter Description Mandatory Example
      1 avnkey Seller’s unique AVN Key Yes 1234@567
      2 tracking_number AWB / Tracking number for the consignment Yes 1430910705434

      Status Codes:

      Id   Status Name

      1      Not Picked
      2      In Transit
      3      Out For Delivery
      4      Delivered
      5      RTO In Transit
      6      RTO Delivered
      7      Exception
      8      Lost/Damage
      9      Reverse Delivered
      10    RTO Exception
      11     RTO Created
      12     RTO out for delivery
      14     Reached Destination
      15     Reverse In Transit
      16     Reverse Exception
      17     Reverse Out for Deli
      18     Cancelled

      Possible Errors:
      Sr.No Error Reason Resolution
      1 200 OK
      Error: {"status":false,"msg":"avn
      key not found"}      		 AVN Key is missing or incorrect Please verify your AVN Key and try again
      2 200 OK
      Error Respone:
      {"status":false,"msg":"Tracking
      Number not found "}      		 AVN Key is Null Please verify your AVN Key and try again
      3 200 OK
      Error:
      {"status":false,"msg":"Tracking
      Number not found"}      		 If Tracking ID is incorrect Tracking Number is incorrect
      4 200 OK
      Error: response = null      		 If Tracking ID is Null Tracking Number is missing

      b. Track Current Status (B2B)

      POST : https://seller.shipyaari.com/client/siteadmin/api/b2b_tracking_number

      Request Variables:

      Sr.No Parameter Description Mandatory Example
      1 avnkey Seller’s unique AVN Key Yes 1234@567
      2 tracking_number AWB / Tracking number for the consignment Yes 1430910705434

      c. Track with entire Lifecycle V2

      Get the particular order’s current status and history of a particular order through this API by passing the Shipyaari AVN key and tracking number.

      POST : https://seller.shipyaari.com/avn_ci/siteadmin/track/trackdetails

      Request Variables:

      Sr.No Parameter Description Mandatory Example
      1 avnkey Seller’s unique AVN Key Yes 1234@567
      2 tracking_number AWB / Tracking number for the consignment Yes 1430910705434

      7. Hyperlocal APIs

      a. Create Hyperlocal Request:

      POST: https://seller.shipyaari.com/logistic/webservice/create_consignment_hyperlocal_api.php

      b. Cancel Hyperlocal Request:

      POST: https://seller.shipyaari.com/avn_ci/siteadmin/shipment_api/cancel_hyperlocal_shipment

      8. NDR APIs

      POST: https://seller.shipyaari.com/avn_ci/siteadmin/track/ndr_remark

      Request Variables:

      Sr.No Parameter Description Mandatory Example
      1 avnkey Seller’s unique AVN Key Yes 1234@567
      2 tracking_number AWB / Tracking number for the consignment Yes 1430910705434
      3 remark Remark for the NDR Yes Retry in 2 days
      4 update_address In case the address needs to be updated    
      5 delivery_date Updated delivery date    

      Possible Errors:

      Sr.No Error Reason Resolution
      1 200 OK
      Error: {"status":false,"msg":"avn
      key not found"}      		 AVN Key is missing or incorrect Please verify your AVN Key and try again
      2 200 OK
      Error:
      {"status":false,"msg":"Tracking
      Number not mark in NDR"}      		 Tracking Number is incorrect /
      not marked for NDR      		 Verify your tracking number

      9. Cancel APIs

      POST: https://seller.shipyaari.com/avn_ci/siteadmin/cancel_consignment/

      Use this API to cancel the order before being picked up by the courier partner

      Request Variables:

      Sr.No Parameter Description Mandatory Example
      1 avnkey Seller’s unique AVN Key Yes 1234@567
      2 tracking_number AWB / Tracking number for the consignment Yes 1430910705434

      Possible Errors:

      Sr.No Error Reason Resolution
      1 Status Code : 200 OK
      Error: {"status":false,"msg":"Avn
      key is required"}      		 AVN Key is missing AVN key is a mandatory field
      2 Status Code : 200 OK
      Error:
      {"status":false,"message":"Please
      check Shipyaari IDs"}      		 Shipyaari ID is incorrect Verify the entered Shipyaari ID
      3 Status Code : 200 OK
      Error:{"status": false,"massage":
      "Please provide either Shipyaari
      ids or Tracking ids"}      		 Shipyaari ID / AWB number is
      missing      		 Enter either of the two along with
      the AVN Key

      10. Wallet Recharge API

      POST: https://seller.shipyaari.com/avn_ci/siteadmin/payment_link/recharge

      Use this API to generate a payment link to recharge your wallet on Shipyaari.

      The minimum value that can be recharged is Rs 100

      Request Variables:

      Sr.No Parameter Description Mandatory Example
      1 avnkey Seller’s unique AVN Key Yes 1234@567
      2 Amount Amount to recharge the wallet with Yes 5000