POST Create Order

https://api.cmswebservice.in/api/shipment/create

This endpoint allows you to create a shipment order by providing sender, receiver, service, package, and additional shipment details.

Request

  • Method: POST
  • URL: https://api.cmswebservice.in/api/shipment/create
  • Content-Type: application/json

Request Parameters

Parameter Name Type Required Description
AccountCode string Yes Unique code provided by billing department for the account making the shipment.
Sender object Yes Details of the sender.
SenderName string(35) Yes Name of the sender.
SenderContactPerson string(50) Yes Contact person for the sender.
SenderAddressLine1 string(35) Yes First line of sender's address.
SenderAddressLine2 string(35) Yes Second line of sender's address.
SenderAddressLine3 string(35) No Third line of sender's address.
SenderPincode string(6) Yes Pincode for sender's address.
SenderCity string(35) Yes City of the sender.
SenderState string(2) Yes State of the sender.
SenderTelephone string(15) Yes Telephone number of the sender.
SenderEmailId string(50) No Email ID of the sender.
KYCType string Yes Type of KYC document provided by the sender.Valid values: GSTIN (Normal), PAN Number, Aadhaar Number, Voter Id, Passport Number
KYCNo string(20) Yes KYC number of the sender.
Receiver object Yes Details of the receiver.
ReceiverName string(35) Yes Name of the receiver.
ReceiverContactPerson string(50) Yes Contact person for the receiver.
ReceiverAddressLine1 string(35) Yes First line of receiver's address.
ReceiverAddressLine2 string(50) Yes Second line of receiver's address.
ReceiverAddressLine3 string(35) No Third line of receiver's address.
ReceiverZipcode string(10) Yes Zipcode for receiver's address.
ReceiverCity string(35) Yes City of the receiver.
ReceiverState string(2) Yes State of the receiver.Required for US or CA
ReceiverCountry string(2) Yes Country of the receiver.2 letter ISO Country Code.Please see apendix
ReceiverTelephone string(15) Yes Telephone number of the receiver.
ReceiverEmailid string(50) No Email ID of the receiver.
VatId string(20) No VAT ID of the receiver.
ServiceDetails object Yes Details of the service selected for shipment.
Service string(30) Yes Type of service for the shipment.Call API Get Services List.
GoodsType string(5) Yes Type of goods being shipped.Valid value:NDox,Dox
PackageType string(10) Yes Type of package used for shipment.Valid values: PACKAGE, PAK, ENVELOPE.
PackageDetails object Yes Details of the package.
PackageDetail array Yes List of package details.
Length number Yes Length of the package.
Width number Yes Width of the package.
Height number Yes Height of the package.
ActualWeight number Yes Actual weight of the package.
AdditionalDetails object Yes Additional details related to the shipment.
ProductDetails array Yes List of product details included in the shipment.
BoxNo number Yes Box number for the product.
Description string(90) Yes Description of the product.
HSNCode string(10) Yes HSN code for the product.
UnitType string(3) Yes Type of unit for the product.Valid value:PCS,PKG
Qty number Yes Quantity of the product.
UnitRate number Yes Rate per unit of the product.
ShipPieceIGST number No IGST applicable per piece.
PieceWt number No Weight of each piece.
InvoiceCurrency string(3) Yes Currency for the invoice.Please see apendix
InvoiceNo string(10) Yes Invoice number for the shipment.
InvoiceDate string Yes Date of the invoice.
TermsOfSale string(3) Yes Terms of sale for the shipment.Valid values: CIF, DAP, FOB, DDP,EXW,FCA,CPT,CIP,DPU,FAS,CFR
ReasonForExport string(10) Yes Reason for exporting the goods.Valid value:SALE,GIFT,SAMPLE,RETURN,REPAIR,REPLACEMENT,PERSONAL_USE
FreightCharge number No Freight charges for the shipment.
InsuranceCharge number No Insurance charges for the shipment.
CSB_Type string Yes Type of CSB applicable.Valid values are: CSB 4, CSB 5, COMMERICAL
CustomerRefNo string Yes Customer reference number.
DeliveryConfirmation string(3) Yes Method of delivery confirmation.Only for UPS label of signature required
DutyTax string(3) Yes Duty tax applicable for the shipment.Valid values:DDU,DDP
DutiesAccountNo string(10) No Duties account number.
TransactionId string(8) No Unique transaction ID for the shipment.Required only for DHL label
ShipperImage string Optional Base64 encoded image of the shipper.Only for DHL (Optional)
ShipperKYC string Yes Base64 encoded KYC document of the shipper.Required for DHL label for individual shipment
FileName string Yes Name of the KYC document file.

Sample Request

curl --location 'https://api.cmswebservice.in/api/shipment/create' \
--data-raw '{
    "AccountCode": "TEST",
    "Sender": {
        "SenderName": "XYZ COMPANY NAME",
        "SenderContactPerson": "John Doe",
        "SenderAddressLine1": "123 Export Street",
        "SenderAddressLine2": "Industrial Area",
        "SenderAddressLine3": "Phase II",
        "SenderPincode": "400001",
        "SenderCity": "Mumbai",
        "SenderState": "MH",
        "SenderTelephone": "+919876543210",
        "SenderEmailId": "sender@example.com",
        "KYCType": "GSTIN (Normal)",
        "KYCNo": "27ABCDE1234F1Z5"
    },
    "Receiver": {
        "ReceiverName": "XYZ Imports LLC",
        "ReceiverContactPerson": "Jane Smith",
        "ReceiverAddressLine1": "789 Import Ave",
        "ReceiverAddressLine2": "Suite 101",
        "ReceiverAddressLine3": "",
        "ReceiverZipcode": "10001",
        "ReceiverCity": "New York",
        "ReceiverState": "NY",
        "ReceiverCountry": "US",
        "ReceiverTelephone": "+12125557890",
        "ReceiverEmailid": "receiver@example.com",
        "VatId": "US123456789"
    },
    "ServiceDetails": {
        "Service": "UPS_SAVER",
        "GoodsType": "NDox",
        "PackageType": "PACKAGE"
    },
    "PackageDetails": {
        "PackageDetail": [
            {
                "Length": 30.5,
                "Width": 20.0,
                "Height": 15.0,
                "ActualWeight": 1.0
            }
            
        ]
    },
    "AdditionalDetails": {
        "ProductDetails": [
            {
                "BoxNo": "1",
                "Description": "Cotton Shirts",
                "HSNCode": "61051000",
                "HTSCode": "6105100000",
                "UnitType": "PCS",
                "Qty": 50,
                "UnitRate": 250.00,
                "ShipPieceIGST": 0.00,
                "PieceWt": 0.3
            }
        ],
        "InvoiceCurrency": "INR",
        "InvoiceNo": "INV-2025-001",
        "InvoiceDate": "2025-08-30T00:00:00Z",
        "TermsOfSale": "FOB",
        "ReasonForExport": "GIFT",
        "FreightCharge": 0,
        "InsuranceCharge": 0,
        "CSB_Type": "CSB 4",
        "CustomerRefNo": "CUSTREF-98765",
        "DeliveryConfirmation": "No",
        "DutyTax": "DDU",
        "DutiesAccountNo": "",
        "TransactionId": "TXN789654",
        "ShipperImage": "base64-encoded-image-string",
        "ShipperKYC": "base64-encoded-kyc-doc-string",
        "FileName": "kyc_document.pdf"
    }
}'

Response

Response Parameters

Parameter Name Type Description
Status boolean Indicates success or failure of the request.
Error string/null Error message if the request fails.
Data object Contains shipment details when request succeeds.
AwbNo string Airway bill number generated for the shipment.
Destination string Destination country of the shipment.
ChargeableWeight string Chargeable weight for the shipment.
TotalCharges string Total charges applicable.
AdditionalCharges array List of any extra charges applied.
Description string Description of the additional charge.
Amount number Amount of the additional charge.
Airwaybill object Airwaybill number objects.
AirwaybillUrl string Download URL for the AirwaybillUrl label.
BoxlabelUrl string Download URL for the Boxlabel label.
CustomInvoiceUrl string Download URL for the CustomInvoice label.
TrackingNumbers array List of tracking number objects.
TrackingNo string Tracking number assigned to the shipment.
LabelUrl string Download URL for the shipment label.
InvoiceUrl string Download URL for the invoice.
Timestamp string Time the response was generated.
RequestId string Unique ID for tracking the API request.

Sample JSON Response

{
    "Status": true,
    "Error": null,
    "Data": {
        "AwbNo": "55000062",
        "Destination": "USA",
        "ChargeableWeight": "3.66(KG)",
        "TotalCharges": "0.00",
        "AdditionalCharges": [
            {
                "Description": "",
                "Amount": 0.0
            }
        ], 
       "Airwaybill": {
            "AirwaybillUrl": "https://sandbox.overseaslogistic.com/PrintLabel/55000077_Airwaybill.pdf",
            "BoxlabelUrl": "https://sandbox.overseaslogistic.com/PrintLabel/55000077_Airwaybill4X6.pdf",
            "CustomInvoiceUrl": null
        },
        "TrackingNumbers": [
            {
                "TrackingNo": "1ZXXXXXXXXXXXXXXXX",
                "LabelUrl": "https://sandbox.overseaslogistic.com/Label/1ZXXXXXXXXXXXXXXXX.pdf",
                "InvoiceUrl": "https://sandbox.overseaslogistic.com/Invoice/1ZXXXXXXXXXXXXXXXX.pdf"
            }
        ]
    },
    "Timestamp": "2025-09-06T14:46:43.1037088Z",
    "RequestId": "9870c4c2-7061-4d2e-b33b-1b9fa0cda0ab"
}