POST order/importOrder/v3
Action will import the orders into the FreightPOP.
Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.
Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.
Request Information
URI Parameters
None.
Body Parameters
Collection of OrderV3dto| 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. |
| QuoteId |
Optional, need to be passed from Rates V3 API. Must not be greater than 10 characters if passed |
string |
None. |
| RateId |
Optional, need to be passed from Rates V3 API. |
string |
None. |
| CustomerId |
Company ID for customers when Logistics Provider flag is turned on. Otherwise it will be ignored. |
string |
None. |
| Carrier |
Provide carrier details to make shipment from that carrier. |
CarrierV2 |
None. |
| Items |
Shipment Items |
Collection of ShipmentItemV2dto |
None. |
| PaymentTerm |
Order payment terms |
PaymentTerm |
None. |
| ThirdPartyAccountInfo |
Third party account details |
AccountDetails |
None. |
| ShipDate |
Ship date in UTC |
date |
None. |
| ShipperAddress |
Shipper address |
OrderShipperAddressV3 |
None. |
| ReturnAddress |
Return Address |
Address |
None. |
| IncludeReturnLabel |
Include parcel return label |
boolean |
None. |
| ConsigneeAddress |
Consignee address |
OrderConsigineeAddressV3 |
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 ProductDetailV3 |
None. |
| ITN |
International transaction number |
string |
None. |
| AdditionalDetails |
Additional details |
AdditionalDetailsV3 |
Optional
|
| OrderType |
Type of the order i.e Sales Order, Invoice etc |
string |
None. |
| AutoprocessShipment |
Auto process Shipment of the order |
boolean |
Optional(Default value is false)
|
| TransactionType |
Type of the transaction i-e Sales or Purchasing |
OrderTransactionType |
Optional(Default transaction type is Sales)
|
| Documents |
Documents for the order |
Collection of OrderDocumentDto |
Optional(Documents for the order)
|
| CompanyErpId |
Company ERP Id |
integer |
Optional
|
Request Formats
application/json, text/json
Sample:
[
{
"OrderNumber": "sample string 1",
"QuoteId": "sample string 2",
"RateId": "sample string 3",
"CustomerId": "sample string 4",
"Carrier": {
"Id": 1,
"Name": "sample string 2",
"AccountNickName": "sample string 3",
"Service": {
"Id": 1,
"Name": "sample string 2"
}
},
"Items": [
{
"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",
"PerPieceCarrierInsuranceAmount": 1.0,
"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,
"FPHazmatId": 1,
"AutoTransportDetail": {
"Vin": "sample string 1",
"BuyerId": "sample string 2",
"Year": "sample string 3",
"Stock": "sample string 4",
"Make": "sample string 5",
"PicturesLink": "sample string 6",
"Model": "sample string 7",
"Vehicle": "sample string 8",
"VehicleCondition": 0,
"HaulerType": 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",
"PerPieceCarrierInsuranceAmount": 1.0,
"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,
"FPHazmatId": 1,
"AutoTransportDetail": {
"Vin": "sample string 1",
"BuyerId": "sample string 2",
"Year": "sample string 3",
"Stock": "sample string 4",
"Make": "sample string 5",
"PicturesLink": "sample string 6",
"Model": "sample string 7",
"Vehicle": "sample string 8",
"VehicleCondition": 0,
"HaulerType": 0
}
}
],
"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-13T09:56:33.7290683+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",
"RequiredArrivalDate": "2026-04-13T09:56:33.7300669+00:00",
"RequiredShipDate": "2026-04-13T09:56:33.7300669+00:00",
"CanArriveEarly": true,
"CanShipEarly": true,
"AllowConsolidations": true
},
"Reference1": "sample string 6",
"Reference2": "sample string 7",
"Reference3": "sample string 8",
"Reference4": "sample string 9",
"Reference5": "sample string 10",
"Reference6": "sample string 11",
"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-13T09:56:33.7310668+00:00",
"RequiredArrivalDate": "2026-04-13T09:56:33.7310668+00:00",
"CanShipEarly": true,
"CanArriveEarly": true,
"ItemWeight": "sample string 20",
"CustomerItem": "sample string 21",
"LotNumber": "sample string 22",
"Length": "sample string 23",
"Width": "sample string 24",
"Height": "sample string 25",
"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-13T09:56:33.7310668+00:00",
"RequiredArrivalDate": "2026-04-13T09:56:33.7310668+00:00",
"CanShipEarly": true,
"CanArriveEarly": true,
"ItemWeight": "sample string 20",
"CustomerItem": "sample string 21",
"LotNumber": "sample string 22",
"Length": "sample string 23",
"Width": "sample string 24",
"Height": "sample string 25",
"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 12",
"AdditionalDetails": {
"Accessorials": [
1,
1
],
"ReturnDutiesandTaxes": true,
"Vin": "sample string 2",
"BuyerId": "sample string 3",
"Year": 4,
"StockNumber": "sample string 5",
"Make": "sample string 6",
"PicturesLink": "sample string 7",
"Model": "sample string 8",
"SalvageId": "sample string 9",
"VehicleCondition": 0,
"UserDefinedField1": "sample string 10",
"UserDefinedField2": "sample string 11",
"UserDefinedField3": "sample string 12",
"UserDefinedField4": "sample string 13",
"UserDefinedField5": "2026-04-13T09:56:33.7320658+00:00",
"UserDefinedField6": "2026-04-13T09:56:33.7320658+00:00",
"MainIncoterm": "sample string 14",
"InvoiceComments": "sample string 15",
"PaymentTerms": "sample string 16",
"PackingSlipComments": "sample string 17",
"PaymentDueDate": "2026-04-13T09:56:33.7320658+00:00",
"Tins": "sample string 18",
"TinsType": "sample string 19",
"PostalCode": "sample string 20",
"PersonName": "sample string 21",
"CompanyName": "sample string 22",
"PhoneNumber": "sample string 23",
"EmailAddress": "sample string 24",
"StreetLine1": "sample string 25",
"StreetLine2": "sample string 26",
"City": "sample string 27",
"StateOrProvinceCode": "sample string 28",
"CountryCode": "sample string 29",
"IsBrokerSelected": true,
"FedExBrokerType": "sample string 31",
"ThirdPartyInsuranceAmount": 32.0,
"ThirdPartyInsuranceCommodityCode": "sample string 33",
"CarrierInsuranceAmount": 34.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 35",
"HazmatContact": "sample string 36",
"IsSaturdayDelivery": true,
"IsDeliveryDutyPaid": true,
"SpecialInstructions": "sample string 39",
"DeliveryDutyAccountNumber": "sample string 40",
"DeliveryDutyZipCode": "sample string 41",
"DeliveryDutyCountry": "sample string 42",
"ContentType": "sample string 43",
"PurposeOfShipment": "sample string 44",
"PickupSpecialInstructions": "sample string 45",
"Alcohol": true,
"EIN": "sample string 47"
},
"OrderType": "sample string 13",
"AutoprocessShipment": true,
"TransactionType": 0,
"Documents": [
{
"DocumentName": "sample string 1",
"DocumentBase64": "sample string 2",
"DocumentType": 0,
"IsForInternal": true,
"IsForCustomer": true,
"IsForVendor": true,
"IsForBroker": true
},
{
"DocumentName": "sample string 1",
"DocumentBase64": "sample string 2",
"DocumentType": 0,
"IsForInternal": true,
"IsForCustomer": true,
"IsForVendor": true,
"IsForBroker": true
}
],
"CompanyErpId": 15
},
{
"OrderNumber": "sample string 1",
"QuoteId": "sample string 2",
"RateId": "sample string 3",
"CustomerId": "sample string 4",
"Carrier": {
"Id": 1,
"Name": "sample string 2",
"AccountNickName": "sample string 3",
"Service": {
"Id": 1,
"Name": "sample string 2"
}
},
"Items": [
{
"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",
"PerPieceCarrierInsuranceAmount": 1.0,
"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,
"FPHazmatId": 1,
"AutoTransportDetail": {
"Vin": "sample string 1",
"BuyerId": "sample string 2",
"Year": "sample string 3",
"Stock": "sample string 4",
"Make": "sample string 5",
"PicturesLink": "sample string 6",
"Model": "sample string 7",
"Vehicle": "sample string 8",
"VehicleCondition": 0,
"HaulerType": 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",
"PerPieceCarrierInsuranceAmount": 1.0,
"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,
"FPHazmatId": 1,
"AutoTransportDetail": {
"Vin": "sample string 1",
"BuyerId": "sample string 2",
"Year": "sample string 3",
"Stock": "sample string 4",
"Make": "sample string 5",
"PicturesLink": "sample string 6",
"Model": "sample string 7",
"Vehicle": "sample string 8",
"VehicleCondition": 0,
"HaulerType": 0
}
}
],
"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-13T09:56:33.7290683+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",
"RequiredArrivalDate": "2026-04-13T09:56:33.7300669+00:00",
"RequiredShipDate": "2026-04-13T09:56:33.7300669+00:00",
"CanArriveEarly": true,
"CanShipEarly": true,
"AllowConsolidations": true
},
"Reference1": "sample string 6",
"Reference2": "sample string 7",
"Reference3": "sample string 8",
"Reference4": "sample string 9",
"Reference5": "sample string 10",
"Reference6": "sample string 11",
"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-13T09:56:33.7310668+00:00",
"RequiredArrivalDate": "2026-04-13T09:56:33.7310668+00:00",
"CanShipEarly": true,
"CanArriveEarly": true,
"ItemWeight": "sample string 20",
"CustomerItem": "sample string 21",
"LotNumber": "sample string 22",
"Length": "sample string 23",
"Width": "sample string 24",
"Height": "sample string 25",
"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-13T09:56:33.7310668+00:00",
"RequiredArrivalDate": "2026-04-13T09:56:33.7310668+00:00",
"CanShipEarly": true,
"CanArriveEarly": true,
"ItemWeight": "sample string 20",
"CustomerItem": "sample string 21",
"LotNumber": "sample string 22",
"Length": "sample string 23",
"Width": "sample string 24",
"Height": "sample string 25",
"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 12",
"AdditionalDetails": {
"Accessorials": [
1,
1
],
"ReturnDutiesandTaxes": true,
"Vin": "sample string 2",
"BuyerId": "sample string 3",
"Year": 4,
"StockNumber": "sample string 5",
"Make": "sample string 6",
"PicturesLink": "sample string 7",
"Model": "sample string 8",
"SalvageId": "sample string 9",
"VehicleCondition": 0,
"UserDefinedField1": "sample string 10",
"UserDefinedField2": "sample string 11",
"UserDefinedField3": "sample string 12",
"UserDefinedField4": "sample string 13",
"UserDefinedField5": "2026-04-13T09:56:33.7320658+00:00",
"UserDefinedField6": "2026-04-13T09:56:33.7320658+00:00",
"MainIncoterm": "sample string 14",
"InvoiceComments": "sample string 15",
"PaymentTerms": "sample string 16",
"PackingSlipComments": "sample string 17",
"PaymentDueDate": "2026-04-13T09:56:33.7320658+00:00",
"Tins": "sample string 18",
"TinsType": "sample string 19",
"PostalCode": "sample string 20",
"PersonName": "sample string 21",
"CompanyName": "sample string 22",
"PhoneNumber": "sample string 23",
"EmailAddress": "sample string 24",
"StreetLine1": "sample string 25",
"StreetLine2": "sample string 26",
"City": "sample string 27",
"StateOrProvinceCode": "sample string 28",
"CountryCode": "sample string 29",
"IsBrokerSelected": true,
"FedExBrokerType": "sample string 31",
"ThirdPartyInsuranceAmount": 32.0,
"ThirdPartyInsuranceCommodityCode": "sample string 33",
"CarrierInsuranceAmount": 34.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 35",
"HazmatContact": "sample string 36",
"IsSaturdayDelivery": true,
"IsDeliveryDutyPaid": true,
"SpecialInstructions": "sample string 39",
"DeliveryDutyAccountNumber": "sample string 40",
"DeliveryDutyZipCode": "sample string 41",
"DeliveryDutyCountry": "sample string 42",
"ContentType": "sample string 43",
"PurposeOfShipment": "sample string 44",
"PickupSpecialInstructions": "sample string 45",
"Alcohol": true,
"EIN": "sample string 47"
},
"OrderType": "sample string 13",
"AutoprocessShipment": true,
"TransactionType": 0,
"Documents": [
{
"DocumentName": "sample string 1",
"DocumentBase64": "sample string 2",
"DocumentType": 0,
"IsForInternal": true,
"IsForCustomer": true,
"IsForVendor": true,
"IsForBroker": true
},
{
"DocumentName": "sample string 1",
"DocumentBase64": "sample string 2",
"DocumentType": 0,
"IsForInternal": true,
"IsForCustomer": true,
"IsForVendor": true,
"IsForBroker": true
}
],
"CompanyErpId": 15
}
]
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"
}