FM_APIs
  1. Shipment Order
FM_APIs
  • Shipment Order
    • /shipmentorder
      POST
  • Shipment Processing
    • /RTS/markRTS
      POST
    • /shipmentDetails/labelLink
      POST
    • /RTS/bulkMarkRTS
      POST
    • /ShipmentCancellation/markCancellation
      POST
    • /orderProcessing/printLabel
      POST
    • /orderProcessing/printInvoice
      POST
    • /orderProcessing/searchOrders
      POST
  • Shipment Tracking
    • /ClientOrderIn/orderTrackingDetails
      GET
    • /ClientOrderIn/eventDetails
      GET
    • /api/shipmentTracking/{awbNumber}
      GET
  1. Shipment Order

/shipmentorder

POST
/shipmentorder
Shipment Order
The API allows to create shipment order for given input parameters

Request

Body Params application/json
clientCode
string 
required
Unique identifier for the client
Example:
CN-LKO001-1
shipmentType
string 
required
Type of shipment, can be either FORWARD or REVERSE
Example:
FORWARD
clientRefId
string 
required
Client's reference ID for the shipment
Example:
f03264c434d94f23b1a6403af3bfca74
destinationDetails
object 
required
consigneeName
string 
optional
Name of the consignee
Example:
Tarun Dharmashya
gstRegNumber
string 
optional
GST registration number of the consignee
Example:
27AADCK2478Q1ZA
destinationAddress
#/definitions/3343797
optional
Could not resolve '#/definitions/3343797'
destinationContactDetails
#/definitions/3343798
optional
Could not resolve '#/definitions/3343798'
shipmentDimension
#/definitions/3343799
optional
Could not resolve '#/definitions/3343799'
serviceType
string 
required
Type of service for the shipment, from HYPER_LOCAL/PREMIUM/EXPRESS/ECONOMY/CARGO/HEAVY_BULKY/RVP/RVP QC
Example:
ECONOMY
paymentMode
string 
required
Payment mode for the shipment, either COD (Cash on Delivery) or PREPAID.
Example:
COD
collectAmount
number 
required
Amount to collect if payment mode is COD
Example:
3291.8
shipmentValue
number 
required
Declared value of the shipment
Example:
5000
itemDetails
object 
optional
orderID
string 
optional
The shipper's order number for the item or product purchased
Example:
ORD123456
orderTime
number 
optional
The shipper's order time for the item or product purchased
Example:
1702351318
orderChannel
string 
required
The channel through which the order was placed
Example:
Manual
essential
boolean 
optional
Indicates whether the item is essential
Example:
true
invoiceNumber
string 
required
The billing details of the items or product purchased
Example:
INV123456
invoiceDate
string 
required
The date when the invoice was issued
Example:
2023-09-01T00:00:00.000Z
itemClassification
array[string]
required
Array of item classifications, such as Fragile, Essential or Dangerous Goods
Example:
["Fragile","Dangerous Goods"]
itemName
string 
required
The name of the item
Example:
Laptop
itemReferenceNumber
string 
required
A unique reference number for the item
Example:
ITEM123456
itemType
string 
optional
The type of the item
Example:
Electronics
itemHsnCode
string 
required
must have 8 characters, mandatory only for shipments above INR 50000. The value must be from the list here https://tutorial.gst.gov.in/downloads/HSN_SAC.xlsx
Example:
83021020
itemQuantity
number 
required
The quantity of the item
Example:
1
itemUnitPrice
number 
required
The unit price of the item
Example:
500
itemTaxableAmount
number 
optional
The amount subject to tax
Example:
900
itemTaxAmount
number 
optional
The total tax amount.
Example:
180
itemCGSTAmount
number 
optional
The Central Goods and Services Tax (CGST) amount.
Example:
90
itemSGSTAmount
number 
optional
The State Goods and Services Tax (SGST) amount.
Example:
90
itemIGSTAmount
number 
optional
The Integrated Goods and Services Tax (IGST) amount .
Example:
0
itemDiscount
number 
optional
The discount given on the item purchased
Example:
0
itemValue
number 
required
The total value of the item after applying discounts and taxes
Example:
900
itemCGST
number 
optional
The CGST rate.
Example:
9
itemSGST
number 
optional
The SGST rate.
Example:
9
itemIGST
number 
optional
The IGST rate.
Example:
0
taxInclusive
boolean 
optional
Indicates whether the tax is inclusive in the price.
Example:
false
shipmentGrossValue
number 
optional
The gross value of the shipment
Example:
1200
shipmentTaxableValue
number 
optional
The total taxable value of the shipment
Example:
1000
shipmentTotalTaxAmount
number 
optional
The total tax amount for the shipment
Example:
200
shipmentCGSTAmount
number 
optional
The CGST amount for the shipment
Example:
100
shipmentSGSTAmount
number 
optional
The SGST amount for the shipment
Example:
100
shipmentIGSTAmount
number 
optional
The IGST amount for the shipment
Example:
0
shipmentDiscountValue
number 
optional
The total discount applied to the shipment
Example:
100
skuCount
number 
optional
The number of SKUs (Stock Keeping Units) in the shipment
Example:
2
ERN
string 
optional
Export Reference Number, mandatory for shipment value>=50000
Example:
ERN123456
EwayBillNumber
string 
optional
12-digit number, mandatory for shipments above INR 50000 (this is applicable for India only), Eway-bill describes a document required to be carried by a person in charge of the conveyance carrying any consignment of goods of value exceeding fifty thousand rupees as mandated by the Government in terms of Section 68 of the Goods and Services Tax Act read with Rule 138 of the rules framed thereunder
Example:
876567654323
consignorGroupCode
string 
required
The code identifying the consignor group
Example:
CN-LKO001
sellerDetails
object 
optional
sellerCode
string 
optional
The code identifying the seller
Example:
CN-LKO001-1
sellerName
string 
optional
The name of the seller
Example:
Tanya Aggarwal
gstRegNumber
string 
optional
The GST registration number of the seller (Mandatory if shipment value is greater than 50000)
Example:
29ABCDE1234F2Z5
sellerAddress
#/definitions/3343797
optional
(Mandatory if shipment value is greater than 50000)
Could not resolve '#/definitions/3343797'
sellerContactNumber
string 
optional
The contact number of the seller.(Mandatory if shipment value is greater than 50000)
Example:
9876543210
originDetails
object 
required
The shipment origin address details. Provide full location address details or location code
pickupCode
string 
required
The code for the pickup location.
Example:
CN-LKO001-1
returnDetails
object 
optional
The shipment order return location. This address is used to return the shipment if it is undeliverable. If the value is not provided it is defaulted to origin address
returnAddressCode
string 
optional
preferredCourierCode
string 
optional
The code for the preferred courier service
Example:
ECOM
awbNo
string 
optional
Airway bill number.
Example:
AWB123456789
originHandoverMode
string 
required
Indicates how the shipment is handed over at origin. "PICKUP/DROPOFF"
Example:
PICKUP
clientVASServices
object 
optional
The special services supported by the assigned courier
collectOnDelivery
boolean 
optional
The field indicates whether cash on delivery(COD) is supported by the courier
Example:
true
proofOfDelivery
boolean 
optional
The field indicates whether proof of delivery is supported by the courier
Example:
false
exchange
boolean 
optional
The field indicates whether exchange of shipment items is supported by the courier
Example:
true
doorstepQC
boolean 
optional
The field indicates whether QC is supported by the courier during return journey of the shipment
Example:
false
openBoxDelivery
boolean 
optional
The field indicates whether open box delivery is supported by the courier
Example:
true
installation
boolean 
optional
The field indicates whether installation of product is supported by the courier
Example:
true
shipmentPurposeType
string 
required
The purpose of shipment determines whether it is a forward or reverse shipment.
The table below defines each value of Shipment Purpose:
PurposeDescription
SALEForward shipment journey, product or item sale
NON_COMMERCIALUsed for any non-commercial item shipments
RETURNReverse shipment journey. Use it for item or product return from customer
preferredPickupWindow
object 
optional
start
string 
optional
UTC ISO String: 2023-03-30T20:00:00.015Z
end
string 
optional
UTC ISO String: 2023-03-30T20:00:00.015Z
preferredDeliveryWindow
object 
optional
start
string 
optional
UTC ISO String: 2023-03-30T20:00:00.015Z
end
string 
optional
UTC ISO String: 2023-03-30T20:00:00.015Z
rtsFlag
boolean 
optional
flag indicating if the shipment is ready to ship
Default:
false
Example:
false
shipmentReturnDetails
object 
optional
Details about the return shipment, if applicable.
returnReason
string 
optional
Reason for the return.
Example:
Damaged item
originalOrderID
string 
optional
Original order ID associated with the return.
Example:
ORD45678
originalClientRefId
string 
optional
Original client reference ID associated with the return.
Example:
CLIREF123
qualityCheck
boolean 
optional
Indicates if a quality check is required.
Example:
true
qcDetails
$ref(#/definitions/3343800)[]
optional
List of quality check details.
Could not resolve '#/definitions/3343800'
consignorLocationCode
string 
optional
Location code of the consignor (sender) for the shipment.
Example:
LKO001
shipmentClass
enum<string> 
optional
Classification of the shipment, which can be B2C, B2B, or C2C.
Allowed values:
B2CB2BC2C
Default:
B2C
Example:
B2C
shippingCharges
number 
optional
Total shipping charges for the order.
Example:
250.75
Example
{
    "clientRefId": "332992272-4",
    "shipmentType": "FORWARD",
    "destinationDetails": {
        "gstRegNumber": "NA",
        "destinationAddress": {
            "addressLine1": "RAMAMURTHY NAGAR",
            "addressLine2": null,
            "pincode": "560016",
            "city": "Banglore",
            "state": "Karnataka",
            "addressType": "HOME"
        },
        "destinationContactDetails": {
            "contactPersonName": "Ravikiran",
            "primaryContactNumber": "9518793421",
            "email": "sontakker5@gmail.com"
        }
    },
    "shipmentDimension": {
        "length": 10,
        "breadth": 10,
        "height": 10,
        "weight": 0.42,
        "volumetricWeight": 0.2
    },
    "serviceType": "ECONOMY",
    "paymentMode": "PREPAID",
    "collectAmount": 0,
    "shipmentValue": 603.82,
    "itemDetails": [
        {
            "orderID": "testlogistiex04",
            "orderTime": 1738754406000,
            "orderChannel": "Manual",
            "essential": false,
            "invoiceNumber": 332992272,
            "itemClassification": [],
            "itemName": "Mixer",
            "itemReferenceNumber": "12541",
            "itemType": "Electical",
            "itemHsnCode": "14875241",
            "itemQuantity": 2,
            "itemUnitPrice": 77.93,
            "itemTaxableAmount": 155.93,
            "itemTaxAmount": 28.06,
            "itemCGSTAmount": 14.03,
            "itemSGSTAmount": 14.03,
            "itemIGSTAmount": 0,
            "itemDiscount": 0,
            "itemValue": 183.99,
            "itemCGST": 9,
            "itemSGST": 9,
            "itemIGST": 0,
            "taxInclusive": true
        },
        {
            "orderID": "testlogistiex",
            "orderTime": 1738754406000,
            "orderChannel": "Manual",
            "essential": false,
            "invoiceNumber": 332992272,
            "itemClassification": [],
            "itemName": "DLV-COMBO2",
            "itemReferenceNumber": "DLV-COMBO2",
            "itemType": "Clothes",
            "itemHsnCode": null,
            "itemQuantity": 2,
            "itemUnitPrice": 169.44,
            "itemTaxableAmount": 338.98,
            "itemTaxAmount": 61.01,
            "itemCGSTAmount": 30.50,
            "itemSGSTAmount": 30.50,
            "itemIGSTAmount": 0,
            "itemDiscount": 0,
            "itemValue": 399.99,
            "itemCGST": 9,
            "itemSGST": 9,
            "itemIGST": 0,
            "taxInclusive": true
        }
    ],
    "shipmentGrossValue": 603.82,
    "shipmentTotalTaxAmount": 92.10,
    "shipmentCGSTAmount": 44.54,
    "shipmentSGSTAmount": 44.54,
    "shipmentIGSTAmount": 0,
    "shipmentTotalDiscount": 0,
    "skuCount": 2,
    "consignorGroupCode": "CGJAI001",
    "sellerDetails": {
        "sellerName": "Gugris",
        "gstRegNumber": "29AADCE8914H1ZE",
        "sellerContactNumber": "8808528338",
        "sellerAddress": {
            "addressLine1": "RAMAMURTHY NAGAR",
            "pincode": "560016",
            "city": "Karnataka",
            "state": "Karnataka",
            "addressType": "OFFICE"
        }
    },
    "originDetails": {
        "pickupCode": "CGJAI001-1"
    },
    "returnDetails": {
        "returnAddressCode": "CGJAI001-1"
    },
    "shippingCharges": 19.83,
    "originHandoverMode": "PICKUP",
    "shipmentPurposeType": "SALE",
    "consignorLocationCode": "",
    "rtsFlag": false,
    "shipmentClass": "B2C"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/shipmentorder' \
--header 'Content-Type: application/json' \
--data-raw '{
    "clientRefId": "332992272-4",
    "shipmentType": "FORWARD",
    "destinationDetails": {
        "gstRegNumber": "NA",
        "destinationAddress": {
            "addressLine1": "RAMAMURTHY NAGAR",
            "addressLine2": null,
            "pincode": "560016",
            "city": "Banglore",
            "state": "Karnataka",
            "addressType": "HOME"
        },
        "destinationContactDetails": {
            "contactPersonName": "Ravikiran",
            "primaryContactNumber": "9518793421",
            "email": "sontakker5@gmail.com"
        }
    },
    "shipmentDimension": {
        "length": 10,
        "breadth": 10,
        "height": 10,
        "weight": 0.42,
        "volumetricWeight": 0.2
    },
    "serviceType": "ECONOMY",
    "paymentMode": "PREPAID",
    "collectAmount": 0,
    "shipmentValue": 603.82,
    "itemDetails": [
        {
            "orderID": "testlogistiex04",
            "orderTime": 1738754406000,
            "orderChannel": "Manual",
            "essential": false,
            "invoiceNumber": 332992272,
            "itemClassification": [],
            "itemName": "Mixer",
            "itemReferenceNumber": "12541",
            "itemType": "Electical",
            "itemHsnCode": "14875241",
            "itemQuantity": 2,
            "itemUnitPrice": 77.93,
            "itemTaxableAmount": 155.93,
            "itemTaxAmount": 28.06,
            "itemCGSTAmount": 14.03,
            "itemSGSTAmount": 14.03,
            "itemIGSTAmount": 0,
            "itemDiscount": 0,
            "itemValue": 183.99,
            "itemCGST": 9,
            "itemSGST": 9,
            "itemIGST": 0,
            "taxInclusive": true
        },
        {
            "orderID": "testlogistiex",
            "orderTime": 1738754406000,
            "orderChannel": "Manual",
            "essential": false,
            "invoiceNumber": 332992272,
            "itemClassification": [],
            "itemName": "DLV-COMBO2",
            "itemReferenceNumber": "DLV-COMBO2",
            "itemType": "Clothes",
            "itemHsnCode": null,
            "itemQuantity": 2,
            "itemUnitPrice": 169.44,
            "itemTaxableAmount": 338.98,
            "itemTaxAmount": 61.01,
            "itemCGSTAmount": 30.50,
            "itemSGSTAmount": 30.50,
            "itemIGSTAmount": 0,
            "itemDiscount": 0,
            "itemValue": 399.99,
            "itemCGST": 9,
            "itemSGST": 9,
            "itemIGST": 0,
            "taxInclusive": true
        }
    ],
    "shipmentGrossValue": 603.82,
    "shipmentTotalTaxAmount": 92.10,
    "shipmentCGSTAmount": 44.54,
    "shipmentSGSTAmount": 44.54,
    "shipmentIGSTAmount": 0,
    "shipmentTotalDiscount": 0,
    "skuCount": 2,
    "consignorGroupCode": "CGJAI001",
    "sellerDetails": {
        "sellerName": "Gugris",
        "gstRegNumber": "29AADCE8914H1ZE",
        "sellerContactNumber": "8808528338",
        "sellerAddress": {
            "addressLine1": "RAMAMURTHY NAGAR",
            "pincode": "560016",
            "city": "Karnataka",
            "state": "Karnataka",
            "addressType": "OFFICE"
        }
    },
    "originDetails": {
        "pickupCode": "CGJAI001-1"
    },
    "returnDetails": {
        "returnAddressCode": "CGJAI001-1"
    },
    "shippingCharges": 19.83,
    "originHandoverMode": "PICKUP",
    "shipmentPurposeType": "SALE",
    "consignorLocationCode": "",
    "rtsFlag": false,
    "shipmentClass": "B2C"
}'

Responses

🟢200OK
application/json
Order Placed Successfully
Body
array of:
clientCode
string 
optional
Unique identifier for the client
Example:
CN-LKO001-1
shipmentType
string 
optional
Type of shipment, can be either FORWARD or REVERSE
Example:
FORWARD
clientRefId
string 
optional
Client's reference ID for the shipment
Example:
f03264c434d94f23b1a6403af3bfca74
destinationDetails
object 
optional
consigneeName
string 
optional
Name of the consignee
Example:
Tarun Dharmashya
gstRegNumber
string 
optional
GST registration number of the consignee
Example:
27AADCK2478Q1ZA
destinationAddress
#/definitions/3343797
optional
Could not resolve '#/definitions/3343797'
destinationContactDetails
#/definitions/3343798
optional
Could not resolve '#/definitions/3343798'
shipmentDimension
#/definitions/3343799
optional
Could not resolve '#/definitions/3343799'
serviceType
string 
optional
Type of service for the shipment, from HYPER_LOCAL/PREMIUM/EXPRESS/ECONOMY/CARGO/HEAVY_BULKY/RVP/RVP QC
Example:
ECONOMY
paymentMode
string 
optional
Payment mode for the shipment, either COD (Cash on Delivery) or PREPAID.
Example:
COD
collectAmount
number 
optional
Amount to collect if payment mode is COD
Example:
3291.8
shipmentValue
number 
optional
Declared value of the shipment
Example:
5000
itemDetails
object 
optional
orderID
string 
optional
The shipper's order number for the item or product purchased
Example:
ORD123456
orderTime
number 
optional
The shipper's order time for the item or product purchased
Example:
1702351318
orderChannel
string 
optional
The channel through which the order was placed
Example:
Manual
essential
boolean 
optional
Indicates whether the item is essential
Example:
true
invoiceNumber
string 
optional
The billing details of the items or product purchased
Example:
INV123456
invoiceDate
string 
optional
The date when the invoice was issued
Example:
2023-09-01T00:00:00.000Z
itemClassification
array[string]
optional
Array of item classifications, such as Fragile, Essential or Dangerous Goods
Example:
["Fragile","Dangerous Goods"]
itemName
string 
optional
The name of the item
Example:
Laptop
itemReferenceNumber
string 
optional
A unique reference number for the item
Example:
ITEM123456
itemType
string 
optional
The type of the item
Example:
Electronics
itemHsnCode
string 
optional
must have 8 characters, mandatory only for shipments above INR 50000. The value must be from the list here https://tutorial.gst.gov.in/downloads/HSN_SAC.xlsx
Example:
83021020
itemQuantity
number 
optional
The quantity of the item
Example:
1
itemUnitPrice
number 
optional
The unit price of the item
Example:
500
itemTaxableAmount
number 
optional
The amount subject to tax
Example:
900
itemTaxAmount
number 
optional
The total tax amount.
Example:
180
itemCGSTAmount
number 
optional
The Central Goods and Services Tax (CGST) amount.
Example:
90
itemSGSTAmount
number 
optional
The State Goods and Services Tax (SGST) amount.
Example:
90
itemIGSTAmount
number 
optional
The Integrated Goods and Services Tax (IGST) amount .
Example:
0
itemDiscount
number 
optional
The discount given on the item purchased
Example:
0
itemValue
number 
optional
The total value of the item after applying discounts and taxes
Example:
900
itemCGST
number 
optional
The CGST rate.
Example:
9
itemSGST
number 
optional
The SGST rate.
Example:
9
itemIGST
number 
optional
The IGST rate.
Example:
0
taxInclusive
boolean 
optional
Indicates whether the tax is inclusive in the price.
Example:
false
shipmentGrossValue
number 
optional
The gross value of the shipment
Example:
1200
shipmentTaxableValue
number 
optional
The total taxable value of the shipment
Example:
1000
shipmentTotalTaxAmount
number 
optional
The total tax amount for the shipment
Example:
200
shipmentCGSTAmount
number 
optional
The CGST amount for the shipment
Example:
100
shipmentSGSTAmount
number 
optional
The SGST amount for the shipment
Example:
100
shipmentIGSTAmount
number 
optional
The IGST amount for the shipment
Example:
0
shipmentDiscountValue
number 
optional
The total discount applied to the shipment
Example:
100
skuCount
number 
optional
The number of SKUs (Stock Keeping Units) in the shipment
Example:
2
ERN
string 
optional
Export Reference Number, mandatory for shipment value>=50000
Example:
ERN123456
EwayBillNumber
string 
optional
12-digit number, mandatory for shipments above INR 50000 (this is applicable for India only), Eway-bill describes a document required to be carried by a person in charge of the conveyance carrying any consignment of goods of value exceeding fifty thousand rupees as mandated by the Government in terms of Section 68 of the Goods and Services Tax Act read with Rule 138 of the rules framed thereunder
Example:
876567654323
consignorGroupCode
string 
optional
The code identifying the consignor group
Example:
CN-LKO001
sellerDetails
object 
optional
sellerCode
string 
optional
The code identifying the seller
Example:
CN-LKO001-1
sellerName
string 
optional
The name of the seller
Example:
Tanya Aggarwal
gstRegNumber
string 
optional
The GST registration number of the seller
Example:
29ABCDE1234F2Z5
sellerAddress
#/definitions/3343797
optional
Could not resolve '#/definitions/3343797'
sellerContactNumber
string 
optional
The contact number of the seller.
Example:
9876543210
originDetails
object 
optional
The shipment origin address details. Provide full location address details or location code
pickupCode
string 
optional
The code for the pickup location.
Example:
CN-LKO001-1
gstRegNumber
string 
optional
The GST registration number for the origin location
Example:
29ABCDE1234F2Z5
originAddress
#/definitions/3343797
optional
Could not resolve '#/definitions/3343797'
originContactDetails
#/definitions/3343798
optional
Could not resolve '#/definitions/3343798'
returnDetails
object 
optional
The shipment order return location. This address is used to return the shipment if it is undeliverable. If the value is not provided it is defaulted to origin address
returnAddressCode
string 
optional
returnAddress
#/definitions/3343797
optional
Could not resolve '#/definitions/3343797'
returnContactDetails
#/definitions/3343798
optional
Could not resolve '#/definitions/3343798'
preferredCourierCode
string 
optional
The code for the preferred courier service
Example:
ECOM
awbNo
string 
optional
Airway bill number.
Example:
AWB123456789
promiseDeliveryWindow
object 
optional
start
string 
optional
UTC ISO String: 2023-03-30T20:00:00.015Z
end
string 
optional
UTC ISO String: 2023-03-30T20:00:00.015Z
promiseShipWindow
object 
optional
start
string 
optional
UTC ISO String: 2023-03-30T20:00:00.015Z
end
string 
optional
UTC ISO String: 2023-03-30T20:00:00.015Z
originHandoverMode
string 
optional
Indicates how the shipment is handed over at origin. "PICKUP/DROPOFF"
Example:
PICKUP
destinationHandoverMode
string 
optional
Indicates how the shipment is handed over at the destination "PICKUP/DROPOFF"
Example:
PICKUP
recommendedPackaging
string 
optional
shipmentReferenceNumber
string 
optional
The reference number for the shipment
Example:
123456789
consignorType
string 
optional
consineeType
string 
optional
clientVASServices
object 
optional
The special services supported by the assigned courier
collectOnDelivery
boolean 
optional
The field indicates whether cash on delivery(COD) is supported by the courier
Example:
true
proofOfDelivery
boolean 
optional
The field indicates whether proof of delivery is supported by the courier
Example:
false
exchange
boolean 
optional
The field indicates whether exchange of shipment items is supported by the courier
Example:
true
doorstepQC
boolean 
optional
The field indicates whether QC is supported by the courier during return journey of the shipment
Example:
false
openBoxDelivery
boolean 
optional
The field indicates whether open box delivery is supported by the courier
Example:
true
installation
boolean 
optional
The field indicates whether installation of product is supported by the courier
Example:
true
shipmentPurposeType
string 
optional
The purpose of shipment determines whether it is a forward or reverse shipment.
The table below defines each value of Shipment Purpose:
PurposeDescription
SALEForward shipment journey, product or item sale
NON_COMMERCIALUsed for any non-commercial item shipments
RETURNReverse shipment journey. Use it for item or product return from customer
preferredPickupWindow
object 
optional
start
string 
optional
UTC ISO String: 2023-03-30T20:00:00.015Z
end
string 
optional
UTC ISO String: 2023-03-30T20:00:00.015Z
preferredDeliveryWindow
object 
optional
start
string 
optional
UTC ISO String: 2023-03-30T20:00:00.015Z
end
string 
optional
UTC ISO String: 2023-03-30T20:00:00.015Z
rtsFlag
boolean 
optional
flag indicating if the shipment is ready to ship
Default:
false
Example:
false
orderStatus
number 
optional
Current status of the order.
Default:
100
Example:
100
creationTime
number 
optional
Time of creation of the shipment, in epoch format (seconds since 1970-01-01).
Example:
1702351318
shipByTime
number 
optional
Latest time by which the shipment should be dispatched, in epoch format.
Example:
1702351318
shipmentRefId
string 
optional
Reference ID for the shipment order.
Example:
SH12345REF
shipmentReturnDetails
object 
optional
Details about the return shipment, if applicable.
returnReason
string 
optional
Reason for the return.
Example:
Damaged item
originalOrderID
string 
optional
Original order ID associated with the return.
Example:
ORD45678
originalClientRefId
string 
optional
Original client reference ID associated with the return.
Example:
CLIREF123
qualityCheck
boolean 
optional
Indicates if a quality check is required.
Example:
true
qcDetails
$ref(#/definitions/3343800)[]
optional
List of quality check details.
Could not resolve '#/definitions/3343800'
integrationMode
string 
optional
Mode of integration used for the shipment (e.g., API, Manual).
Example:
API
assignedCourierCode
string 
optional
Code of the courier assigned to the shipment.
Example:
ECOM
assignedAWBNumber
string 
optional
Assigned Airway bill number for the shipment order
Example:
116850098
consignorLocationCode
string 
optional
Location code of the consignor (sender) for the shipment.
Example:
LKO001
shipmentClass
enum<string> 
optional
Classification of the shipment, which can be B2C, B2B, or C2C.
Allowed values:
B2CB2BC2C
Default:
B2C
Example:
B2C
shippingCharges
number 
optional
Total shipping charges for the order.
Example:
250.75
Example
{
    "success": true,
    "msg": "Order Placed Successfully",
    "data": {
        "clientCode": "fm-api",
        "shipmentType": "FORWARD",
        "clientRefId": "1332992272-4",
        "destinationDetails": {
            "gstRegNumber": "NA",
            "destinationAddress": {
                "addressLine1": "RAMAMURTHY NAGAR",
                "addressLine2": null,
                "state": "Karnataka",
                "city": "Banglore",
                "pincode": "560016",
                "addressType": "HOME",
                "_id": "67a8ddc8bb87b9c90fc31762"
            },
            "destinationContactDetails": {
                "contactPersonName": "Ravikiran",
                "primaryContactNumber": "9518793421",
                "email": "sontakker5@gmail.com",
                "_id": "67a8ddc8bb87b9c90fc31763"
            }
        },
        "shipmentDimension": {
            "length": 10,
            "breadth": 10,
            "height": 10,
            "weight": 0.42,
            "_id": "67a8ddc8bb87b9c90fc3176d",
            "volumetricWeight": 0.2
        },
        "serviceType": "ECONOMY",
        "paymentMode": "PREPAID",
        "collectAmount": 0,
        "shipmentValue": 603.82,
        "itemDetails": [
            {
                "orderID": "testlogistiex04",
                "orderTime": 1738754406000,
                "orderChannel": "Manual",
                "essential": false,
                "invoiceNumber": "332992272",
                "itemClassification": [],
                "itemName": "Mixer",
                "itemReferenceNumber": "12541",
                "itemType": "Electical",
                "itemHsnCode": "14875241",
                "itemQuantity": 2,
                "itemUnitPrice": 77.93,
                "itemTaxableAmount": 155.93,
                "itemTaxAmount": 28.06,
                "itemCGSTAmount": 14.03,
                "itemSGSTAmount": 14.03,
                "itemIGSTAmount": 0,
                "itemDiscount": 0,
                "itemValue": 183.99,
                "itemCGST": 9,
                "itemSGST": 9,
                "itemIGST": 0,
                "taxInclusive": true,
                "_id": "67a8ddc8bb87b9c90fc31765",
                "invoiceDate": "5/2/2025"
            },
            {
                "orderID": "testlogistiex",
                "orderTime": 1738754406000,
                "orderChannel": "Manual",
                "essential": false,
                "invoiceNumber": "332992272",
                "itemClassification": [],
                "itemName": "DLV-COMBO2",
                "itemReferenceNumber": "DLV-COMBO2",
                "itemType": "Clothes",
                "itemHsnCode": null,
                "itemQuantity": 2,
                "itemUnitPrice": 169.44,
                "itemTaxableAmount": 338.98,
                "itemTaxAmount": 61.01,
                "itemCGSTAmount": 30.5,
                "itemSGSTAmount": 30.5,
                "itemIGSTAmount": 0,
                "itemDiscount": 0,
                "itemValue": 399.99,
                "itemCGST": 9,
                "itemSGST": 9,
                "itemIGST": 0,
                "taxInclusive": true,
                "_id": "67a8ddc8bb87b9c90fc31766",
                "invoiceDate": "5/2/2025"
            }
        ],
        "shipmentGrossValue": 603.82,
        "shipmentTotalTaxAmount": 92.1,
        "shipmentCGSTAmount": 44.54,
        "shipmentSGSTAmount": 44.54,
        "shipmentIGSTAmount": 0,
        "skuCount": 2,
        "consignorGroupCode": "CGJAI001",
        "sellerDetails": {
            "sellerCode": "",
            "sellerName": "Gugris",
            "gstRegNumber": "29AADCE8914H1ZE",
            "sellerAddress": {
                "addressLine1": "RAMAMURTHY NAGAR",
                "addressLine2": "",
                "latitude": "26.91681706377075",
                "longitude": "75.82038156650398",
                "state": "Karnataka",
                "city": "Karnataka",
                "pincode": "560016",
                "addressType": "HOME",
                "addressConfidenceScore": null,
                "_id": "67a8ddc8bb87b9c90fc31767"
            },
            "sellerContactNumber": "8808528338"
        },
        "originDetails": {
            "pickupCode": "CGJAI001-1",
            "gstRegNumber": "22AAAAA0000A1Z5",
            "originAddress": {
                "addressLine1": "Shop no 22",
                "addressLine2": "",
                "latitude": "26.91681706377075",
                "longitude": "75.82038156650398",
                "state": "Rajasthan",
                "city": "Jaipur",
                "pincode": "110001",
                "addressType": "HOME",
                "addressConfidenceScore": null,
                "_id": "67a8ddc8bb87b9c90fc31768"
            },
            "originContactDetails": {
                "contactPersonName": "Tarun",
                "primaryContactNumber": "9910939792",
                "secondaryContactNumber": "",
                "email": "wejimap340@ubinert.com",
                "_id": "67a8ddc8bb87b9c90fc31769"
            }
        },
        "returnDetails": {
            "returnAddressCode": "CGJAI001-1",
            "returnAddress": {
                "addressLine1": "Shop no 22",
                "addressLine2": "",
                "latitude": "26.91681706377075",
                "longitude": "75.82038156650398",
                "state": "Rajasthan",
                "city": "Jaipur",
                "pincode": "110001",
                "addressType": "HOME",
                "addressConfidenceScore": null
            },
            "returnContactDetails": {
                "contactPersonName": "Tarun",
                "primaryContactNumber": "9910939792",
                "secondaryContactNumber": "",
                "email": "wejimap340@ubinert.com"
            }
        },
        "originHandoverMode": "PICKUP",
        "destinationHandoverMode": "DROPOFF",
        "isOffLoad": false,
        "packagingScanAction": 0,
        "shipmentReferenceNumber": "250209-4615-9789",
        "shipmentPurposeType": "SALE",
        "rtsFlag": false,
        "labelStatus": 0,
        "invoiceStatus": 0,
        "orderStatus": 100,
        "shipmentReturnDetails": {
            "qcDetails": []
        },
        "consignorLocationCode": "",
        "shipmentClass": "B2C",
        "shippingCharges": 19.83,
        "_id": "67a8ddc8bb87b9c90fc31761",
        "creationTime": 1739120071127,
        "requestedServiceType": "ECONOMY",
        "assignedCourierCode": "DELHIVERY",
        "shipmentRefId": "ece63fb1-4867-4e39-9969-0d4c6ba325be",
        "awbNo": "6677112024400",
        "assignedAWBNumber": "6677112024400",
        "integrationMode": "api",
        "labelLink": "",
        "courierRouteCode": ""
    }
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🔴500Server Error
Next
/RTS/markRTS
Built with