Inbound | POST | /shipping-label/create
Summary
This API call is used to create an order on the logistic aggregator portal.
Description
This API will be used to create an order on the logistic aggregator portal. If the order is already created and just Shipping label needs to be generated, directly make the Pack Order API call.
Request
{
"billingAddress": {
"city": "Delhi",
"country": "India",
"email": "mohit@gmail.com",
"firstName": "Mohit",
"lastName": "Singh",
"middleName": "",
"phone": "9121726219",
"state": "DELHI",
"street1": "A-102, Balaji Residency",
"street2": "Motera",
"street3": "",
"zip": "110019"
},
"currencyCode": "INR",
"dropAddress": {
"city": "Delhi",
"country": "India",
"email": "mohit@gmail.com",
"firstName": "Mohit",
"lastName": "Singh",
"middleName": "",
"phone": "9121726219",
"state": "DELHI",
"street1": "A-102, Balaji Residency",
"street2": "Motera",
"street3": "",
"zip": "110019"
},
"regionType": "INDIAN",
"orderDetails": {
"codValue": 0,
"invoiceNumber": "INV-10",
"invoiceTime": "2021-06-18T12:00:01Z",
"invoiceValue": 100.00,
"isCod": false,
"orderDate": "2021-06-17T17:32:02Z",
"orderLineItemList": [
{
"clientSkuId": "sku-1",
"finalAmountPaid": 100.00,
"imageUrl": "xyz",
"name": "Shirt",
"price": 100.00,
"quantity": 1,
"storeCreditsUsed": 0.0
}
],
"orderNumber": "order12345"
},
"pickupAddress": {
"city": "Delhi",
"country": "India",
"email": "ram@gmail.com",
"firstName": "Ram",
"lastName": "Mehta",
"middleName": "",
"phone": "8135671272",
"state": "DELHI",
"street1": "Mathalli area",
"street2": "Opposite Ring road",
"street3": "",
"zip": "110020"
},
"sellerGstin": "29AADCP7081J1ZY",
"shipmentDimension": {
"breadth": 10,
"height": 10,
"length": 10,
"weight": 1
},
"shippingAndBillingAddressSame": true, Add payload for when this flag is false as well.
"logisticAggregatorType": "CLICKPOST",
"warehouseCode": "wh-1"
}
Parameter Name | Data Type | Description | Mandatory |
| Object | Billing Address of Customer | yes |
| String | City of Customer | yes |
| String | Country of Customer | yes |
| String | Email of Customer | yes |
| String | First Name of customer | yes |
| String | Last Name of customer | yes |
| String | Middle Name of customer | no |
| String | Phone Number of Customer | yes |
| String | State of customer | yes |
| String | 1st line of customer address | yes |
| String | 2nd line of customer address | no |
| String | 3rd line of customer address | no |
| String | Zip/Pin code of customer address | yes |
| String | Currency | yes |
| Object | Shipping Address of customer | |
| String | City of customer | yes |
| String | Country of customer | yes |
| String | Email of customer | yes |
| String | First Name of customer | yes |
| String | Last Name of customer | yes |
| String | Middle name of customer | no |
| String | Phone Number of customer | yes |
| String | State of customer | yes |
| String | 1st line of customer address | yes |
| String | 2nd line of customer address | no |
| String | 3rd line of customer address | no |
| String | Zip/Pin code of customer | yes |
| String | Can take two values:INDIAN and INTERNATIONAL, specifying the region type of order | yes |
| Object | Order Details | yes |
| Double | If order is of type COD, then this should be greater than 0 | yes |
| String | Invoice Id of the order | yes |
| Date | Invoice Time of the order | yes |
| Double | Invoice value | yes |
| Boolean | True if the order is of COD type | yes |
| Date | Order Date | yes |
| Object[] | Order Line Items | yes |
| String | SKU of the product | yes |
| Double | Final amount paid for the product | yes |
| String | Image url of the product | no |
| String | Name of the product | yes |
| Double | Price of the product | yes |
| Integer | Quantity of the product | yes |
| Double | Store credits for this line item | no |
| String | Order Number | yes |
| Object | Pickup Address | yes |
| String | City of Warehouse | yes |
| String | Country of Warehouse | yes |
| String | Email of Warehouse | yes |
| String | First name of Warehouse | yes |
| String | Last name of Warehouse | yes |
| String | Middle name of warehouse | no |
| String | Phone number of warehouse | yes |
| String | State of warehouse | yes |
| String | 1st line of warehouse address | yes |
| String | 2nd line of warehouse address | no |
| String | 3rd line of warehouse address | no |
| String | Zip/Pin code of warehouse | yes |
| String | Seller GSTIN | yes |
| Object | Package Dimensions | yes |
| Integer | Breadth of package (cms) | yes |
| Integer | Height of package(cms) | yes |
| Integer | Length of package(cms) | yes |
| Integer | Weight of package(grams for Clickpost/kilograms for Shiprocket) | yes |
| Boolean | True if billing and shipping address are the same | yes |
| String | Can be “CLICKPOST” or “SHIPROCKET”, specifies which aggregator type to use for Order Creation | yes |
| String | Warehouse Code | yes |
Reponse
No response
Generate Shipping Label
Inbound | POST | /shipping-label/pack
Summary
This API call is used to generate AWB and shipping label.
Description
This API call is used to generate AWB and shipping label.
Request
{
"billingAddress": {
"city": "Delhi",
"country": "India",
"email": "mohit@gmail.com",
"firstName": "Mohit",
"lastName": "Singh",
"middleName": "",
"phone": "9121726219",
"state": "DELHI",
"street1": "A-102, Balaji Residency",
"street2": "Motera",
"street3": "",
"zip": "110019"
},
"currencyCode": "INR",
"dropAddress": {
"city": "Delhi",
"country": "India",
"email": "mohit@gmail.com",
"firstName": "Mohit",
"lastName": "Singh",
"middleName": "",
"phone": "9121726219",
"state": "DELHI",
"street1": "A-102, Balaji Residency",
"street2": "Motera",
"street3": "",
"zip": "110019"
},
"regionType": "INDIAN",
"orderDetails": {
"codValue": 0,
"invoiceNumber": "INV-10",
"invoiceTime": "2021-06-18T12:00:01Z",
"invoiceValue": 100.00,
"isCod": false,
"orderDate": "2021-06-17T17:32:02Z",
"orderLineItemList": [
{
"clientSkuId": "sku-1",
"finalAmountPaid": 100.00,
"imageUrl": "xyz",
"name": "Shirt",
"price": 100.00,
"quantity": 1,
"storeCreditsUsed": 0.0
}
],
"orderNumber": "order12345"
},
"pickupAddress": {
"city": "Delhi",
"country": "India",
"email": "ram@gmail.com",
"firstName": "Ram",
"lastName": "Mehta",
"middleName": "",
"phone": "8135671272",
"state": "DELHI",
"street1": "Mathalli area",
"street2": "Opposite Ring road",
"street3": "",
"zip": "110020"
},
"sellerGstin": "29AADCP7081J1ZY",
"shipmentDimension": {
"breadth": 10,
"height": 10,
"length": 10,
"weight": 1
},
"shippingAndBillingAddressSame": true,
"logisticAggregatorType": "CLICKPOST",
"warehouseCode": "wh-1"
}
Response
{
"documentUrl": "https://pyck-res-bucket.s3.amazonaws.com:443/SELF/2021-06-18/order12345.pdf",
"courierName": "Self",
"awbNo": "order12345"
}
Parameter Name | Data Type | Description |
| String | PDF Url of the shipping label |
| String | Courier name |
| String | Awb Number |