Edit Order

Overview

This API enables enterprises to edit specific details for a shipment that has already been manifested. This API only works for the following mentioned fields, for the respective mentioned carrier partners

Usecases Supported

1. Conversion of order from QC to NON-QC
   1. You can use this API to convert a shipment from QC to Non QC flow in case the shipment pickup has to be done and QC check if failing within carrier systems. Once this API is called, Carrier partner will pick the shipment next day without doing QC.
2. Conversion of Order from COD to Prepaid.
3. Conversion of Order from Prepaid to COD.
4. Update Eway Bill Number

Process Flow for COD to Prepaid Conversion:

The COD to Prepaid conversion API allows you to convert a shipment from COD to Prepaid till a particular state of the shipment [in general: Out For Delivery].

1. Once the COD order is placed by the customer, show them an option to convert the order from COD to Prepaid on My orders section, via SMS/Whatsapp communications.
2. When the customer makes the payment for the order, if the label is generated for the shipment, you can call the COD to Prepaid conversion API for the corresponding courier partner to convert the order to Prepaid.
3. Once the courier sends a confirmation, you can make the transaction successful. In case you receive any failure from the courier partner, revert the transaction and disable conversion on the product.

Eway Bill Update Process

What is an Eway Bill Number?

An Eway Bill Number is a unique identifier mandated by the government for the transportation of goods valued at more than ₹50,000.

Flow

1. During the order creation process, enterprises may not have the Eway Bill Number readily available. As a result, they often input empty or placeholder values in the API.
2. Subsequently, enterprises generate the Eway Bill Number from the designated portal. This number then needs to be updated at the carrier partner's end.
3. ClickPost's edit order API facilitates enterprises in updating the Eway Bill Number post-order creation, ensuring compliance and smooth logistics operations.

Important Notes:

1. Enable webhooks enabled from the courier partners on Clickpost and you are consuming the same for getting the status updates. You would want to disable the payment link as soon as the order is marked as Out for Delivery.
2. Before you start using the APIs, have a discussion with your courier partner POCs to keep them aligned that you are planning to use “edit order API” (couriers call the COD to Prepaid conversion API as Edit order) to convert orders from COD to Prepaid.

Geography

This API supports conversions for carriers in India.

📘

Please refer to the list of supported carrier partners below

Supported Carrier Partners for COD to Prepaid

Carrier Partners who support conversion of COD orders to PREPAID and are active on this API:

1. Delhivery
2. Ecom Express
3. Xpressbees
4. Shadowfax
5. Shadowfax HLD
6. Loadshare
7. Shipsy

Carrier Partner who are in pipeline

1. Ekart
2. Smartr

Carrier Partner who support conversion of order from QC to Non-QC:

1. Shadowfax Reverse

Supported Carrier Partners for Prepaid to COD

1. Delhivery

Carrier Partner who support update of Eway Bill Number

1. Ekart
2. Bluedart

URL

GET <https://www.clickpost.in/api/v1/edit-order/>

Query Parameters

Request Payload

Response

The sample response can have the following fields

Response Meta

Sample Payload

{
    "awb_number": "20719799",
    "order_type": "PREPAID",
    "courier_partner": 220
}

{
    "awb_number": "999999999",
    "qc_type": "doorstep",
    "courier_partner": 11
}

{
    "awb_number": "20719789",
    "order_type": "COD",
    "cod_value" : 123.50,
    "courier_partner": 3
}

{   
	"awb_number": "76973977426",
    "ewaybill_serial_number":"234567799999", 
    "invoice_number":"new123", 
    "invoice_date":"2024-01-20", 
    "courier_partner": 5
}

Sample Response

{
    "meta": {
        "message": "ACCEPTED",
        "success": true,
        "status": 200
    }
}