Edit Order

Edit Order API allows the enterprise to edit specific details for a shipment that has already been manifested.

Payload Example

{
    "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
}

Important Links

Run in Postman API Reference

Query Parameters

Field NameData TypeFieldDescription
usernameStringMandatoryUsername of the registered enterprise
keyStringMandatoryUnique license key for the enterprise user

Request Payload

Field NameData TypeFieldDescription
carrier_partnerIntegerMandatoryPartner ID of the carrier partner
order_typeStringMandatoryOrder type of the shipment

1. COD
2. PREPAID
awbStringMandatoryThe Air Waybill of the shipment that needs to be edited
qc_typeENUMOptionalThe values it takes

1. doorstep
2. null

doorstep denotes Quality Check should be done at the doorstep

null denotes that a Quality Check is not required
skuSTRINGSKU of the item.

If the customer wishes QC on the entire shipment they should ignore this field.

If they wish QC on a specific shipment they should pass the SKU value of the shipment.
cod_valueFloatConditionalAmount to be collected at the doorstep for cash on delivery mode. (Only required when prepaid to cod conversion is being done)

Response

The sample response can have the following fields

Field NameData TypeDescription
metaObjectMetadata for the result, e.g. status code, error messages.

Response Meta

Field NameData TypeDescription
statusIntegerStatus code of the response (including, but not limited to HTTP Status codes)
messageStringError message (if any errors) for the request.
successBooleanWhether the request is successful or not.
Language
Click Try It! to start a request and see the response here!