POST order/importOrder
Deprecated This API will be removed in Dec. of 2023. Please use /order/importOrder/v3 instead.
Action will import the orders into the FreightPOP.Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.
Request Information
URI Parameters
None.
Body Parameters
Collection of OrderRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderNumber |
This variable will be used to bind your order in FreightPop. Must be unique from Previous orders imported. |
string |
None. |
| Carrier |
Provide carrier details to make shipment from that carrier. |
Carrier2 |
None. |
| Items |
Shipment Items |
Collection of ShipmentItem |
None. |
| PaymentTerm |
Order payment terms |
PaymentTerm |
None. |
| ThirdPartyAccountInfo |
Third party account details |
AccountDetails |
None. |
| ShipDate |
Ship date in UTC |
date |
None. |
| ShipperAddress |
Shipper address |
OrderShipperAddress |
None. |
| ReturnAddress |
Return Address |
Address |
None. |
| IncludeReturnLabel |
Include parcel return label |
boolean |
None. |
| ConsigneeAddress |
Consignee address |
OrderConsigineeAddress |
None. |
| Reference1 |
Reference 1 |
string |
None. |
| Reference2 |
Referece 2 |
string |
None. |
| Reference3 |
Reference 3 |
string |
None. |
| Reference4 |
Reference 4 |
string |
None. |
| Reference5 |
Reference 5 |
string |
None. |
| Reference6 |
Reference 6 |
string |
None. |
| ProductDetails |
Product details |
Collection of ProductDetail |
None. |
| ITN |
International transaction number |
string |
None. |
| AdditionalDetails |
Additional details |
AdditionalDetails2 |
Optional
|
| OrderType |
Type of the order i.e Sales Order, Invoice etc |
string |
None. |
| TransactionType |
Type of the transaction i-e Sales or Purchasing |
OrderTransactionType |
Optional(Default transaction type is Sales)
|
Request Formats
application/json, text/json
Sample:
[
{
"OrderNumber": "sample string 1",
"Carrier": {
"Id": 1,
"Name": "sample string 2",
"AccountNickName": "sample string 3",
"Other": 0,
"Service": {
"Id": 1,
"Name": "sample string 2"
}
},
"Items": [
{
"PerPieceCarrierInsuranceAmount": 1.0,
"PerPieceCODAmount": 1.0,
"InnerPieces": {
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1,
"InnerMostPieces": [
{
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1,
"FourthLevel": [
{
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1
},
{
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1
}
]
},
{
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1,
"FourthLevel": [
{
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1
},
{
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1
}
]
}
]
},
"Reference1": "sample string 1",
"Reference2": "sample string 2",
"Reference3": "sample string 3",
"Reference4": "sample string 4",
"Reference5": "sample string 5",
"Reference6": "sample string 6",
"Description": "sample string 7",
"FreightClass": 8.1,
"Height": 9.1,
"Length": 10.1,
"PackageType": 1,
"Quantity": 11,
"Weight": 12.1,
"Unit": 1,
"Width": 13.1,
"PackageId": "sample string 14",
"NMFC": "sample string 15",
"Hazmat": true,
"UnNo": "sample string 17"
},
{
"PerPieceCarrierInsuranceAmount": 1.0,
"PerPieceCODAmount": 1.0,
"InnerPieces": {
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1,
"InnerMostPieces": [
{
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1,
"FourthLevel": [
{
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1
},
{
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1
}
]
},
{
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1,
"FourthLevel": [
{
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1
},
{
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1
}
]
}
]
},
"Reference1": "sample string 1",
"Reference2": "sample string 2",
"Reference3": "sample string 3",
"Reference4": "sample string 4",
"Reference5": "sample string 5",
"Reference6": "sample string 6",
"Description": "sample string 7",
"FreightClass": 8.1,
"Height": 9.1,
"Length": 10.1,
"PackageType": 1,
"Quantity": 11,
"Weight": 12.1,
"Unit": 1,
"Width": 13.1,
"PackageId": "sample string 14",
"NMFC": "sample string 15",
"Hazmat": true,
"UnNo": "sample string 17"
}
],
"PaymentTerm": 1,
"ThirdPartyAccountInfo": {
"AccountNumber": "sample string 1",
"Address": "sample string 2",
"City": "sample string 3",
"Country": "sample string 4",
"Email": "sample string 5",
"Name": "sample string 6",
"Phone": "sample string 7",
"State": "sample string 8",
"Zip": "sample string 9"
},
"ShipDate": "2026-04-13T13:49:01.1488739+00:00",
"ShipperAddress": {
"AttentionTo": "sample string 1",
"City": "sample string 2",
"CompanyId": "sample string 3",
"Company": "sample string 4",
"Country": "sample string 5",
"Email": "sample string 6",
"State": "sample string 7",
"Street1": "sample string 8",
"Street2": "sample string 9",
"Phone": "sample string 10",
"Zip": "sample string 11"
},
"ReturnAddress": {
"AttentionTo": "sample string 1",
"City": "sample string 2",
"CompanyId": "sample string 3",
"Company": "sample string 4",
"Country": "sample string 5",
"Email": "sample string 6",
"State": "sample string 7",
"Street1": "sample string 8",
"Street2": "sample string 9",
"Phone": "sample string 10",
"Zip": "sample string 11",
"OrderType": "sample string 12",
"TaxIDNumber": "sample string 13"
},
"IncludeReturnLabel": true,
"ConsigneeAddress": {
"AttentionTo": "sample string 1",
"City": "sample string 2",
"CompanyId": "sample string 3",
"Company": "sample string 4",
"Country": "sample string 5",
"Email": "sample string 6",
"State": "sample string 7",
"Street1": "sample string 8",
"Street2": "sample string 9",
"Phone": "sample string 10",
"Zip": "sample string 11",
"OrderType": "sample string 12"
},
"Reference1": "sample string 3",
"Reference2": "sample string 4",
"Reference3": "sample string 5",
"Reference4": "sample string 6",
"Reference5": "sample string 7",
"Reference6": "sample string 8",
"ProductDetails": [
{
"Country": "sample string 1",
"HTSCode": "sample string 2",
"Description": "sample string 3",
"Number": "sample string 4",
"PackageId": "sample string 5",
"PricePerPiece": 6.0,
"PricePerPiece2": 7.0,
"PricePerPiece3": 8.0,
"PricePerPiece4": 9.0,
"Quantity": 10,
"Quantity2": 11,
"Quantity3": 12,
"Quantity4": 13,
"Unit": "sample string 14",
"OrderNumber": "sample string 15",
"LineType": "sample string 16",
"LineNumber": "sample string 17",
"RequiredShipDate": "2026-04-13T13:49:01.1508732+00:00",
"RequiredArrivalDate": "2026-04-13T13:49:01.1508732+00:00",
"CanShipEarly": true,
"CanArriveEarly": true,
"ItemWeight": 20.0,
"CustomerItem": "sample string 21",
"LotNumber": "sample string 22",
"Length": 23.0,
"Width": 24.0,
"Height": 25.0,
"FreightClass": "sample string 26",
"NMFC": "sample string 27",
"UserDefined1": "sample string 28",
"UserDefined2": "sample string 29",
"UserDefined3": "sample string 30",
"TechnicalName": "sample string 31",
"FPHazmatId": 32,
"UNID": "sample string 33",
"SKU": "sample string 34",
"UPC": "sample string 35",
"Category": "sample string 36",
"DDTCQuantityUOM": "sample string 37",
"ECCN": "sample string 38",
"License": "sample string 39",
"ItemNotes": "sample string 40"
},
{
"Country": "sample string 1",
"HTSCode": "sample string 2",
"Description": "sample string 3",
"Number": "sample string 4",
"PackageId": "sample string 5",
"PricePerPiece": 6.0,
"PricePerPiece2": 7.0,
"PricePerPiece3": 8.0,
"PricePerPiece4": 9.0,
"Quantity": 10,
"Quantity2": 11,
"Quantity3": 12,
"Quantity4": 13,
"Unit": "sample string 14",
"OrderNumber": "sample string 15",
"LineType": "sample string 16",
"LineNumber": "sample string 17",
"RequiredShipDate": "2026-04-13T13:49:01.1508732+00:00",
"RequiredArrivalDate": "2026-04-13T13:49:01.1508732+00:00",
"CanShipEarly": true,
"CanArriveEarly": true,
"ItemWeight": 20.0,
"CustomerItem": "sample string 21",
"LotNumber": "sample string 22",
"Length": 23.0,
"Width": 24.0,
"Height": 25.0,
"FreightClass": "sample string 26",
"NMFC": "sample string 27",
"UserDefined1": "sample string 28",
"UserDefined2": "sample string 29",
"UserDefined3": "sample string 30",
"TechnicalName": "sample string 31",
"FPHazmatId": 32,
"UNID": "sample string 33",
"SKU": "sample string 34",
"UPC": "sample string 35",
"Category": "sample string 36",
"DDTCQuantityUOM": "sample string 37",
"ECCN": "sample string 38",
"License": "sample string 39",
"ItemNotes": "sample string 40"
}
],
"ITN": "sample string 9",
"AdditionalDetails": {
"Accessorials": [
1,
1
],
"CarrierInsuranceAmount": 1.0,
"CODDetails": {
"Amount": 1.0,
"ChargeCode": "sample string 2",
"PaymentType": 1,
"RemitAddress": {
"AttentionTo": "sample string 1",
"City": "sample string 2",
"CompanyId": "sample string 3",
"Company": "sample string 4",
"Country": "sample string 5",
"Email": "sample string 6",
"State": "sample string 7",
"Street1": "sample string 8",
"Street2": "sample string 9",
"Phone": "sample string 10",
"Zip": "sample string 11",
"OrderType": "sample string 12",
"TaxIDNumber": "sample string 13"
}
},
"DeliveryConfirmation": 1,
"HazmatEmergencyNo": "sample string 2",
"HazmatContact": "sample string 3",
"IsSaturdayDelivery": true,
"IsDeliveryDutyPaid": true,
"SpecialInstructions": "sample string 6",
"DeliveryDutyAccountNumber": "sample string 7",
"DeliveryDutyZipCode": "sample string 8",
"DeliveryDutyCountry": "sample string 9",
"ContentType": "sample string 10",
"PurposeOfShipment": "sample string 11",
"PickupSpecialInstructions": "sample string 12",
"Alcohol": true,
"EIN": "sample string 14"
},
"OrderType": "sample string 10",
"TransactionType": 0
},
{
"OrderNumber": "sample string 1",
"Carrier": {
"Id": 1,
"Name": "sample string 2",
"AccountNickName": "sample string 3",
"Other": 0,
"Service": {
"Id": 1,
"Name": "sample string 2"
}
},
"Items": [
{
"PerPieceCarrierInsuranceAmount": 1.0,
"PerPieceCODAmount": 1.0,
"InnerPieces": {
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1,
"InnerMostPieces": [
{
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1,
"FourthLevel": [
{
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1
},
{
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1
}
]
},
{
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1,
"FourthLevel": [
{
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1
},
{
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1
}
]
}
]
},
"Reference1": "sample string 1",
"Reference2": "sample string 2",
"Reference3": "sample string 3",
"Reference4": "sample string 4",
"Reference5": "sample string 5",
"Reference6": "sample string 6",
"Description": "sample string 7",
"FreightClass": 8.1,
"Height": 9.1,
"Length": 10.1,
"PackageType": 1,
"Quantity": 11,
"Weight": 12.1,
"Unit": 1,
"Width": 13.1,
"PackageId": "sample string 14",
"NMFC": "sample string 15",
"Hazmat": true,
"UnNo": "sample string 17"
},
{
"PerPieceCarrierInsuranceAmount": 1.0,
"PerPieceCODAmount": 1.0,
"InnerPieces": {
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1,
"InnerMostPieces": [
{
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1,
"FourthLevel": [
{
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1
},
{
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1
}
]
},
{
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1,
"FourthLevel": [
{
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1
},
{
"Unit": 1,
"PackageType": 1,
"Quantity": 1,
"ItemNumber": "sample string 2",
"Length": 3.1,
"Width": 4.1,
"Height": 5.1,
"Weight": 6.1,
"Description": "sample string 7",
"FreightClass": "sample string 8",
"NMFC": "sample string 9",
"Hazmat": true,
"UnNumber": "sample string 11",
"TechnicalName": "sample string 12",
"CompanyPredefinedPackageTypeId": 1
}
]
}
]
},
"Reference1": "sample string 1",
"Reference2": "sample string 2",
"Reference3": "sample string 3",
"Reference4": "sample string 4",
"Reference5": "sample string 5",
"Reference6": "sample string 6",
"Description": "sample string 7",
"FreightClass": 8.1,
"Height": 9.1,
"Length": 10.1,
"PackageType": 1,
"Quantity": 11,
"Weight": 12.1,
"Unit": 1,
"Width": 13.1,
"PackageId": "sample string 14",
"NMFC": "sample string 15",
"Hazmat": true,
"UnNo": "sample string 17"
}
],
"PaymentTerm": 1,
"ThirdPartyAccountInfo": {
"AccountNumber": "sample string 1",
"Address": "sample string 2",
"City": "sample string 3",
"Country": "sample string 4",
"Email": "sample string 5",
"Name": "sample string 6",
"Phone": "sample string 7",
"State": "sample string 8",
"Zip": "sample string 9"
},
"ShipDate": "2026-04-13T13:49:01.1488739+00:00",
"ShipperAddress": {
"AttentionTo": "sample string 1",
"City": "sample string 2",
"CompanyId": "sample string 3",
"Company": "sample string 4",
"Country": "sample string 5",
"Email": "sample string 6",
"State": "sample string 7",
"Street1": "sample string 8",
"Street2": "sample string 9",
"Phone": "sample string 10",
"Zip": "sample string 11"
},
"ReturnAddress": {
"AttentionTo": "sample string 1",
"City": "sample string 2",
"CompanyId": "sample string 3",
"Company": "sample string 4",
"Country": "sample string 5",
"Email": "sample string 6",
"State": "sample string 7",
"Street1": "sample string 8",
"Street2": "sample string 9",
"Phone": "sample string 10",
"Zip": "sample string 11",
"OrderType": "sample string 12",
"TaxIDNumber": "sample string 13"
},
"IncludeReturnLabel": true,
"ConsigneeAddress": {
"AttentionTo": "sample string 1",
"City": "sample string 2",
"CompanyId": "sample string 3",
"Company": "sample string 4",
"Country": "sample string 5",
"Email": "sample string 6",
"State": "sample string 7",
"Street1": "sample string 8",
"Street2": "sample string 9",
"Phone": "sample string 10",
"Zip": "sample string 11",
"OrderType": "sample string 12"
},
"Reference1": "sample string 3",
"Reference2": "sample string 4",
"Reference3": "sample string 5",
"Reference4": "sample string 6",
"Reference5": "sample string 7",
"Reference6": "sample string 8",
"ProductDetails": [
{
"Country": "sample string 1",
"HTSCode": "sample string 2",
"Description": "sample string 3",
"Number": "sample string 4",
"PackageId": "sample string 5",
"PricePerPiece": 6.0,
"PricePerPiece2": 7.0,
"PricePerPiece3": 8.0,
"PricePerPiece4": 9.0,
"Quantity": 10,
"Quantity2": 11,
"Quantity3": 12,
"Quantity4": 13,
"Unit": "sample string 14",
"OrderNumber": "sample string 15",
"LineType": "sample string 16",
"LineNumber": "sample string 17",
"RequiredShipDate": "2026-04-13T13:49:01.1508732+00:00",
"RequiredArrivalDate": "2026-04-13T13:49:01.1508732+00:00",
"CanShipEarly": true,
"CanArriveEarly": true,
"ItemWeight": 20.0,
"CustomerItem": "sample string 21",
"LotNumber": "sample string 22",
"Length": 23.0,
"Width": 24.0,
"Height": 25.0,
"FreightClass": "sample string 26",
"NMFC": "sample string 27",
"UserDefined1": "sample string 28",
"UserDefined2": "sample string 29",
"UserDefined3": "sample string 30",
"TechnicalName": "sample string 31",
"FPHazmatId": 32,
"UNID": "sample string 33",
"SKU": "sample string 34",
"UPC": "sample string 35",
"Category": "sample string 36",
"DDTCQuantityUOM": "sample string 37",
"ECCN": "sample string 38",
"License": "sample string 39",
"ItemNotes": "sample string 40"
},
{
"Country": "sample string 1",
"HTSCode": "sample string 2",
"Description": "sample string 3",
"Number": "sample string 4",
"PackageId": "sample string 5",
"PricePerPiece": 6.0,
"PricePerPiece2": 7.0,
"PricePerPiece3": 8.0,
"PricePerPiece4": 9.0,
"Quantity": 10,
"Quantity2": 11,
"Quantity3": 12,
"Quantity4": 13,
"Unit": "sample string 14",
"OrderNumber": "sample string 15",
"LineType": "sample string 16",
"LineNumber": "sample string 17",
"RequiredShipDate": "2026-04-13T13:49:01.1508732+00:00",
"RequiredArrivalDate": "2026-04-13T13:49:01.1508732+00:00",
"CanShipEarly": true,
"CanArriveEarly": true,
"ItemWeight": 20.0,
"CustomerItem": "sample string 21",
"LotNumber": "sample string 22",
"Length": 23.0,
"Width": 24.0,
"Height": 25.0,
"FreightClass": "sample string 26",
"NMFC": "sample string 27",
"UserDefined1": "sample string 28",
"UserDefined2": "sample string 29",
"UserDefined3": "sample string 30",
"TechnicalName": "sample string 31",
"FPHazmatId": 32,
"UNID": "sample string 33",
"SKU": "sample string 34",
"UPC": "sample string 35",
"Category": "sample string 36",
"DDTCQuantityUOM": "sample string 37",
"ECCN": "sample string 38",
"License": "sample string 39",
"ItemNotes": "sample string 40"
}
],
"ITN": "sample string 9",
"AdditionalDetails": {
"Accessorials": [
1,
1
],
"CarrierInsuranceAmount": 1.0,
"CODDetails": {
"Amount": 1.0,
"ChargeCode": "sample string 2",
"PaymentType": 1,
"RemitAddress": {
"AttentionTo": "sample string 1",
"City": "sample string 2",
"CompanyId": "sample string 3",
"Company": "sample string 4",
"Country": "sample string 5",
"Email": "sample string 6",
"State": "sample string 7",
"Street1": "sample string 8",
"Street2": "sample string 9",
"Phone": "sample string 10",
"Zip": "sample string 11",
"OrderType": "sample string 12",
"TaxIDNumber": "sample string 13"
}
},
"DeliveryConfirmation": 1,
"HazmatEmergencyNo": "sample string 2",
"HazmatContact": "sample string 3",
"IsSaturdayDelivery": true,
"IsDeliveryDutyPaid": true,
"SpecialInstructions": "sample string 6",
"DeliveryDutyAccountNumber": "sample string 7",
"DeliveryDutyZipCode": "sample string 8",
"DeliveryDutyCountry": "sample string 9",
"ContentType": "sample string 10",
"PurposeOfShipment": "sample string 11",
"PickupSpecialInstructions": "sample string 12",
"Alcohol": true,
"EIN": "sample string 14"
},
"OrderType": "sample string 10",
"TransactionType": 0
}
]
Response Information
Resource Description
BadResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Data |
Data returned by api |
Object |
None. |
| Code |
Response code returned by api |
HttpStatusCode |
None. |
| Message |
Human readable message |
string |
None. |
| TraceId | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Code": 100,
"Message": "sample string 2",
"Data": {},
"TraceId": "sample string 3"
}