/
Generate Shipping Label API (Beta)

Generate Shipping Label API (Beta)

Owned by Raghav Mehta
Last updated: Oct 06, 2024
5 min read

Outbound | POST

Overview

This API is used to generate the Shipping label for the shipment created in logistic aggregator system on invoke trigger received from Increff OMS/WMS system.



Summary

  • Increff system will make this API call to logistic aggregator APIs to generate the AWB and the shipping label PDF against a reference number.

  • From the list of couriers fetched via the Get Courier Recommendation API , Increff system will choose the courier with the highest priority and will pass it in the payload of the generate shipping label call.

  • The logistic aggregator will generate the AWB and shipping label against this courier passed.

Ā 

Payload Samples

Sample Forward Order Request

{ "pickupAddress": { "firstName": "firstName_f537b199d560", "lastName": "lastName_7bcca28063db", "middleName": "middleName_5f5d3076351c", "addressLine1": "addressLine1_c7661cb7274c", "addressLine2": "addressLine2_872027741b02", "addressLine3": "addressLine3_c1386fd2639e", "city": "city_2d3174aabdda", "state": "state_80af07511cdd", "zip": "zip_3c9bf644d0e8", "country": "country_e9ebac6fe54c", "email": "email_5ab9405dba3f", "phone": "phone_ce2b9ca7ec58" }, "dropAddress": { "firstName": "firstName_434c629c6213", "lastName": "lastName_286f308fc97f", "middleName": "middleName_c8ef9b6a192c", "addressLine1": "addressLine1_af9101f80ca2", "addressLine2": "addressLine2_118c16a861d3", "addressLine3": "addressLine3_de7eda47d6d3", "city": "city_bbcb46ff01f0", "state": "state_b6a472bb5ba9", "zip": "zip_cb5912f0bee8", "country": "country_f87f2d9cc5f1", "email": "email_11c0c14d9add", "phone": "phone_0e0d7e27633a" }, "orderDetails": { "orderNumber": "orderNumber_07cceb8d9c69", "forwardOrderNumber": "forwardOrderNumber_7b90f35fcbfb", "forwardShipmentNumber": "forwardShipmentNumber_b7b2f348a80e", "shipmentCode": "shipmentCode_d7ddea2380f2", "paymentType": "PREPAID", "shipmentType": "FORWARD", "orderAmount": 0.00, "orderDate": "orderDate_24161536ad06", "orderLineItems": [ { "name": "name_3fd917bcfe27", "sku": "sku_b94ce9cede06", "sellingPricePerUnit": 0.00, "quantity": 0, "finalAmountPaid": 0.00 } ], "channelName": "channelName_0793acf0744e", "storeId": "storeId_67c22f3f4cb8" }, "shipmentDimension": { "length": 0.00, "breadth": 0.00, "height": 0.00, "weight": 0.00 }, "courierId": "courierId_ce3c332b3ffa", "warehouseCode": "warehouseCode_6a2bb3241713", "logisticWarehouseId": "logisticWarehouseId_a73da76e088e" }

Field Description

Parameter Name

Data Type

Description

Mandatory

pickupAddress

Object

Address from where the shipment is picked up (eg. the warehouse address)

yes

pickupAddress.city

String

City of warehouse address

yes

pickupAddress.country

String

Country of warehouse address

yes

pickupAddress.email

String

Email

no

pickupAddress.firstName

String

First Name

yes

pickupAddress.lastName

String

Last Name

no

pickupAddress.middleName

String

Middle Name

no

pickupAddress.phone

String

Phone Number

no

pickupAddress.state

String

State

yes

pickupAddress.addressLine1

String

1st line of warehouse address

yes

pickupAddress.addressLine2

StringĀ 

2nd line of warehouse address

no

pickupAddress.addressLine3

String

3rd line of warehouse address

no

pickupAddress.zip

String

Zip/Pin code of warehouse address

yes

dropAddress

Object

Shipping Address of customer

yes

dropAddress.city

String

City of customer

yes

dropAddress.country

String

Country of customer

yes

dropAddress.email

String

Email of customer

no

dropAddress.firstName

String

First Name of customer

yes

dropAddress.lastName

String

Last Name of customer

no

dropAddress.middleName

String

Middle name of customer

no

dropAddress.phone

String

Phone Number of customer

no

dropAddress.state

String

State of customer

yes

dropAddress.addressLine1

StringĀ 

1st line of customer address

yes

dropAddress.addressLine2

String

2nd line of customer address

no

dropAddress.addressLine3

String

3rd line of customer address

no

dropAddress.zip

String

Zip/Pin code of customer

yes

orderDetails

Object

Order Details

yes

orderDetails.paymentType

String

PREPAID / COD

yes

orderDetails.orderDate

Date

Order Date

yes

orderDetails.orderNumber

String

The order id for which the shipping label is being generated

Yes

orderDetails.orderAmount

Double

The total order amount

Yes

orderDetails.shipmentType

String

Can be FORWARD or RETURN, based on the order type

yes

orderDetails.shipmentCode

String

A shipment identifier to be passed, since an order can have multiple shipments. So, for the pair (orderCode,shipmentNumber) would be unique and will be used to identify a shipment for the particular client.

yes

orderDetails.channelName

String

Name of the Shopfront channel for which order was created

no

orderDetails.forwardOrderNumber

String

Only for return orders

The forward order orderNumber field corresponding to the return order

no

orderDetails.forwardShipmentNumber

String

Only for return orders

The forward order shipmentCode field corresponding to the return order

no

orderDetails.storeId

String

Shopify Store ID of the brand

no

orderDetails.orderLineItemList

Object[]

Order Line Items

yes

orderDetails.orderLineItemList.sku

String

SKU of the product

yes

orderDetails.orderLineItemList.sellingPricePerUnit

Double

Selling price of the product

yes

orderDetails.orderLineItemList.name

String

Name of the product

yes

orderDetails.orderLineItemList.quantity

Integer

Quantity of the product

yes

orderDetails.orderLineItemList.finalAmountPaid

Double

Aggregated value of final amount paid by customer (selling price + shipping charges + additional charges)

no

shipmentDimension

Object

Package Dimensions

yes

shipmentDimension.breadth

Integer

Breadth of package in cm

yes

shipmentDimension.height

Integer

Height of package in cm

yes

shipmentDimension.length

Integer

Length of package in cm

yes

shipmentDimension.weight

Integer

Weight of package in grams

yes

warehouseCode

String

Warehouse Code

no

courierId

Integer

Courier Id for which the shipping label is being generated

no

logisticWarehouseId

String

The warehouse id that is there on the logistic aggregators end

no

Sample Return Order Request

  • This is almost the same as the generate shipping label request body.

  • One additional field is there - returnReason. This is a mandatory field.

  • The orderNumber passed would be a unique string that is used to uniquely identify each return order.

  • The shipment type passed would be RETURN in this case.

{ "pickupAddress": { "firstName": "firstName_f537b199d560", "lastName": "lastName_7bcca28063db", "middleName": "middleName_5f5d3076351c", "addressLine1": "addressLine1_c7661cb7274c", "addressLine2": "addressLine2_872027741b02", "addressLine3": "addressLine3_c1386fd2639e", "city": "city_2d3174aabdda", "state": "state_80af07511cdd", "zip": "zip_3c9bf644d0e8", "country": "country_e9ebac6fe54c", "email": "email_5ab9405dba3f", "phone": "phone_ce2b9ca7ec58" }, "dropAddress": { "firstName": "firstName_434c629c6213", "lastName": "lastName_286f308fc97f", "middleName": "middleName_c8ef9b6a192c", "addressLine1": "addressLine1_af9101f80ca2", "addressLine2": "addressLine2_118c16a861d3", "addressLine3": "addressLine3_de7eda47d6d3", "city": "city_bbcb46ff01f0", "state": "state_b6a472bb5ba9", "zip": "zip_cb5912f0bee8", "country": "country_f87f2d9cc5f1", "email": "email_11c0c14d9add", "phone": "phone_0e0d7e27633a" }, "orderDetails": { "orderNumber": "orderNumber_07cceb8d9c69", "forwardOrderNumber": "forwardOrderNumber_7b90f35fcbfb", "forwardShipmentNumber": "forwardShipmentNumber_b7b2f348a80e", "shipmentCode": "shipmentCode_d7ddea2380f2", "paymentType": "PREPAID", "shipmentType": "FORWARD", "orderAmount": 0.00, "orderDate": "orderDate_24161536ad06", "orderLineItems": [ { "name": "name_3fd917bcfe27", "sku": "sku_b94ce9cede06", "sellingPricePerUnit": 0.00, "quantity": 0, "finalAmountPaid": 0.00 } ], "channelName": "channelName_0793acf0744e", "storeId": "storeId_67c22f3f4cb8" }, "shipmentDimension": { "length": 0.00, "breadth": 0.00, "height": 0.00, "weight": 0.00 }, "courierId": "courierId_ce3c332b3ffa", "warehouseCode": "warehouseCode_6a2bb3241713", "logisticWarehouseId": "logisticWarehouseId_a73da76e088e", "returnReason": "Wrong product" }

Ā 

Field Description

Parameter Name

Data Type

Description

Mandatory

pickupAddress

Object

Address from where the shipment is picked up (eg. the warehouse address)

yes

pickupAddress.city

String

City of warehouse address

yes

pickupAddress.country

String

Country of warehouse address

yes

pickupAddress.email

String

Email

no

pickupAddress.firstName

String

First Name

yes

pickupAddress.lastName

String

Last Name

no

pickupAddress.middleName

String

Middle Name

no

pickupAddress.phone

String

Phone Number

no

pickupAddress.state

String

State

yes

pickupAddress.addressLine1

String

1st line of warehouse address

yes

pickupAddress.addressLine2

StringĀ 

2nd line of warehouse address

no

pickupAddress.addressLine3

String

3rd line of warehouse address

no

pickupAddress.zip

String

Zip/Pin code of warehouse address

yes

dropAddress

Object

Shipping Address of customer

yes

dropAddress.city

String

City of customer

yes

dropAddress.country

String

Country of customer

yes

dropAddress.email

String

Email of customer

no

dropAddress.firstName

String

First Name of customer

yes

dropAddress.lastName

String

Last Name of customer

no

dropAddress.middleName

String

Middle name of customer

no

dropAddress.phone

String

Phone Number of customer

no

dropAddress.state

String

State of customer

yes

dropAddress.addressLine1

StringĀ 

1st line of customer address

yes

dropAddress.addressLine2

String

2nd line of customer address

no

dropAddress.addressLine3

String

3rd line of customer address

no

dropAddress.zip

String

Zip/Pin code of customer

yes

orderDetails

Object

Order Details

yes

orderDetails.paymentType

String

PREPAID / COD

yes

orderDetails.orderDate

Date

Order Date

yes

orderDetails.orderNumber

String

The order id for which the shipping label is being generated

Yes

orderDetails.orderAmount

Double

The total order amount

Yes

orderDetails.shipmentType

String

Can be FORWARD or RETURN, based on the order type

yes

orderDetails.shipmentCode

String

A shipment identifier to be passed, since an order can have multiple shipments. So, for the pair (orderCode,shipmentNumber) would be unique and will be used to identify a shipment for the particular client.

yes

orderDetails.orderLineItemList

Object[]

Order Line Items

yes

orderDetails.orderLineItemList.sku

String

SKU of the product

yes

orderDetails.orderLineItemList.sellingPricePerUnit

Double

Selling price of the product

yes

orderDetails.orderLineItemList.name

String

Name of the product

yes

orderDetails.orderLineItemList.quantity

Integer

Quantity of the product

yes

shipmentDimension

Object

Package Dimensions

yes

shipmentDimension.breadth

Integer

Breadth of package in cm

yes

shipmentDimension.height

Integer

Height of package in cm

yes

shipmentDimension.length

Integer

Length of package in cm

yes

shipmentDimension.weight

Integer

Weight of package in grams

yes

warehouseCode

String

Warehouse Code

no

courierId

Integer

Courier Id for which the shipping label is being generated

no

returnReason

String

End customer return reason

no

Response

{ "orderId": "11012", "orderNumber": "asdf1234", "awb": "71902671", "carrierName": "Delhivery", "shippingLabelUrl": "https://shipping-label-pdf.com/asdf1234" }

Parameter Name

Data Type

Description

Mandatory

orderId

String

This is the unique order id with which the logistic aggregator identifies each order.

yes

orderNumber

String

This is the order number passed in the request body.

yes

awb

String

The tracking number assigned for the order

yes

carrierName

String

The carrier of this order

yes

shippingLabelUrl

String

The shipping label pdf url, this will not be passed for returns.

no