Shipping Label

Using this API customers can create shipping label for one or multiple shipping orders at a time.

Create a Shipping Label

POST /order/shippinglabel/

Use this API to generate the shipping label of orders.

The order numbers are sufficient to create the shipping label or the order payload can be sent in which awb_number, shipping_address along with pincode and mobile no. are mandatory.

Query Parameters

Name	Type	Description
API_KEY*	String	API key obtained by the Customer/Partner

Request Body

Name	Type	Description
order_numbers[]*	String	Single or set of order numbers to which shipment label needs to be created. Note: This is conditionally optional. Either 'order_numbers[]' or payload containing shipment details mentioned ALL below as required should be provided.
awb_number*	String	Received AWB number for the order received from Blowhorn.
primary_mobile_no*	String	Phone number of the end consumer / recipient of the shipment
shipping_address*	String	The address where the shipment is expected to be delivered.
delivery_pincode*	String	The pincode of the delivery address where the shipment is expected to be delivered.
order_id	String	Reference number of the orders sent when the shipment order was created in the Blowhorn system.
customer_name	String	End customer name to whom the package needs to be delivered.
return_address	String	Return address of the seller partner in case of the item needs to be returned when package cannot be delivered.
is_cod	Boolean	Flag to indicate if the order is cash on delivery. Default is false.
amount_to_collect	String	Total amount to be collected from the end customer if the order is of COD type else it should be '0.00'
date_placed	String	Date when the order is placed. Ex: "2022-03-18 05:41:08"
weight	String	The weight of the items in grams
dimensions	String	The dimensions of the package defined by below three parameters length, breadth and height
length	String	Length of the package to be delivered.
breadth	String	breadth of the package to be delivered.
height	String	height of the package to be delivered
sku_details	String	This is set containing details of all the shipment items inside the package. This includes name, quantity, price per item, total price for an item and weight etx.
name	String	The SKU name. It should be unique for each item sent like in the host systems like EAN / UPC code.
quantity	String	The quantity of the SKU that should be fulfilled
weight	String	The weight of the line item in grams
each_item_price	String	Selling price of the SKU
total_item_price	String	The sell price of the entire line taking into account the discounts(invoice value).

200: OK Successful creation of shipping label

{
    "status": "SUCCESS",
    "url": "https://dhalf0kt5yvr3.cloudfront.net/media/uploads/documents/orders/161/shipment/2022-05-23/22Z1WU8/BD72C191894447EDB9B7B302797CEF30.PDF?Expires=1653449032&Signature=Vw~9K4TVBwGWBIwiu1h4Tr4OwdoGNICTZB5YL62qjGPl2CEPewt4-eWonLwPFbJViHcC5EuYxRL3Pqs~Qji2gjqxIrh8uGl6zSi-FzgsneE5JrHIr2hyotpkbVgUeYAtG~nbeEg~Nk-WJVEQUF4NPw5oJpQ0G4OioHSj1TBH7d9ZoXnh5U0lE7fjBl9oFIC0XpSgf5beTOWgK8~4AAES-L6XvV8IyGvR8IJ11cQY5-OUrE25F48G6S2hBNsAZwvjGDxbYsuYo4kDtJeOUfJbRBoe3H3Oo1e9L1SnQyhntBe0FPztJo8TGEUzg-dmln1CAoWuf97t8Wi4UG87L-rTMQ__&Key-Pair-Id=APKAIPXF7DN7UR2FCFUQ"
}

400: Bad Request Missing required parameters

{
    "status": "FAIL",
    "message": "AWB Number is mandatory for shipping label"
}

500: Internal Server Error Unexpected Error

{
  "status": "FAIL",
  "message": "Unexpected error"
}

401: Unauthorized Unauthorized/Wrong API key

{
  "status": "FAIL",
  "message": "Unauthorized"
}

Example Schema 01

{
    "order_numbers[]" : "SH-1XN9S3B,SH-1XNM3A8"
}

Example Schema 02

{
    "awb_number": "SH-1WY3U5C",
    "order_id": 4881968,
    "date_placed": "18 Oct 2021",
    "weight": "12",
    "amount_to_collect": "100",
    "dimensions": {
        "length": 10,
        "breadth": 11,
        "height": 10,
        "uom" : "cc"
    },
    "primary_mobile_no" : 9886555078,
    "customer_name": "Mahadevappa",
    "shipping_address" : "413, 2nd cross",
    "delivery_pincode": "560045",
    "return_address": "b-205, Nagarjuna Green Ridge, 560045"
}