12 Feb 2022

1. PFA, new interface to for POD dispute visible in SR panel -

Please note - The TAT to raise POD remains the same as it was previously.

The seller can select the respective POD option depending upon the case -

For instance if the seller wants to raise a POD dispute for damage/partial shipment then a particular option has been provided in the new interface to the seller. Further, if the seller falls under green category then images /video option is not mandatory for him but if the seller falls under purple category then it is mandatory for the seller to raise a dispute along with images/videos.

2. Automation done in delay delivery cases runs on the below logic-

1. As per the automation in case delay delivery, the system will initiate the freight refund to the seller automatically without manual intervention.

2. In such cases, the SR will refund Rs.50 or 50% of freight value whichever is lower.

For example if the freight charges on a particular shipment is Rs.500 then the freight credited to the seller will be Rs.50.

3. Further as discussed, the CC agent will inform the seller the following-

"The freight initiated is a token for apology due to the delay in delivery"

4. In case, the EDD has crossed 5 days and above and the seller is unhappy with the automatic freight given to him , the CC agent can manually give freight to the seller as the last resort from the ICRM.

· API process Key pointers-

1. APIs are based around REST architecture and use the basic HTTP request methods. The first step is to register with Shiprocket and create an account. After the sign-up process is complete, follow the steps to create an API user:

· Open your Shiprocket account and navigate to the left-hand panel.

· Click On Settings => API => Configure => Create an API user.

· On the pop-up menu, fill in the email (this should be different from the one used to register to ShipRocket).

· Fill in an appropriate password and confirm the password.

· Click on 'Generate API Credential'. On successful completion, you should have a new API user-generated.

· The next step will be to generate the Authentication token using these credentials.

Steps to demonstrate how the order flow works via API:

1. POST Authentication API

Endpoint: https://apiv2.shiprocket.in/v1/external/auth/login

Use this endpoint to generate the Authentication token. The authentication token is an alphanumeric code, unique to your Shiprocket account, can be used from any system to validate your API calls to access Shiprocket's resources. The validity of each token is 10 days.

2. GET Check courier serviceability

Endpoint: https://apiv2.shiprocket.in/v1/external/courier/serviceability/

Use this API to check the availability of couriers between the pickup and delivery postal codes. You can check the serviceability before creating the order by passing just the Pickup and Delivery Postcode along with the weight and whether the order is COD or not. If you’ve already created the order, you just need to pass the order_id that you receive in response to your order creation request.

You will receive an array of all the serviceable couriers in the form of JSON objects in response which will contain information like Courier name, Shipping Fee, Courier Rating, Courier ID, EDD, etc. The couriers displayed in response will be in descending order and are based on the courier priority selected which is a one-time task while setting up the Shiprocket account. The user gets to select from 5 courier priorities:

· Fastest

· Cheapest

· Best Rated

· Recommended by Shiprocket (Based on Shiprocket Recommendation Engine Logic)

· Custom (Users can set up their own priority list)

3. POST Add a new Pickup location

Endpoint: https://apiv2.shiprocket.in/v1/external/settings/company/addpickup

Before an order is created, we are required to add all the pickup locations/warehouse locations to the Shiprocket account. This API will help you add those. You are required to add a pickup location name (a nickname) to each of the locations. This nickname will be passed as a parameter in all your Create Order requests.

4. POST Create Custom Order

Endpoint: https://apiv2.shiprocket.in/v1/external/orders/create/adhoc

Use this API to create a quick custom order. You have to pass all the required params at the minimum given in our API docs. You can add additional parameters as per your preference.

The 'order_id' returned in the response is the Shiprocket order_id. Please save this order ID as this will be used in future API calls.

5. POST Generate AWB for Shipment

Endpoint: https://apiv2.shiprocket.in/v1/external/courier/assign/awb

The next step is to assign a courier to your order. This API can be used to assign the AWB (Air Waybill Number) to your shipment. The AWB is a unique number that helps you track your order.

The shipment_id received in the response to the Create order API will be used here as a parameter. You can bypass the default courier priority of your account and pass the desired courier_id which you previously received in response to the “Check Courier Serviceability” API as a parameter in your request.

6. POST Request for Shipment Pickup

Endpoint: https://apiv2.shiprocket.in/v1/external/courier/generate/pickup

Once you’ve assigned a courier to your order, the next step is to schedule a pickup for that shipment. Use this API to create a pickup request for your order shipment. The API returns the pickup status along with the estimated pickup time.

7. POST Labels, Manifests, and Invoice

Label Endpoint: https://apiv2.shiprocket.in/v1/external/courier/generate/label

Manifest Endpoint: https://apiv2.shiprocket.in/v1/external/manifests/generate

Invoice Endpoint: https://apiv2.shiprocket.in/v1/external/orders/print/invoice

The above endpoints can be used to generate Labels, Manifests, and Invoice for your order. Multiple IDs are accepted for all three for a bulk generation. Manifest can only be generated after the pickup has been scheduled.

8. GET Tracking

Endpoint: https://apiv2.shiprocket.in/v1/external/courier/track/awb/{awb_code} OR

https://apiv2.shiprocket.in/v1/external/courier/track/shipment/{shipment_id}

Post pick up, get the tracking details of your shipment by entering the AWB code/shipment_id of the same in the endpoint URL itself. No other body parameters are required to access these APIs. The response is displayed in JSON format.

Users can also configure a webhook for real-time courier tracking.

Wrapper API

Endpoint: https://apiv2.shiprocket.in/v1/external/shipments/create/forward-shipment

Shiprocket also offers a wrapper API, which allows sellers to do multiple tasks in one go like adding a pickup location, order creation, AWB assignment, pickup schedule, label, and manifest generation in one single API. This allows the seller to process the order in one single click.

NDR

In case an order is marked undelivered by the courier, Shiprocket offers NDR workflow which can also be managed through NDR APIs