- Version 3
- Authentication
- Shipments
- Invoice
- Tracking
- StaticData
- Authentication
- Version 2
- Exports and Webhooks
PendingImport
POST
/services/api/rest/PendingImport
Request
Header Params
Accept
string
required
Example:
application/json
Body Params application/json
AuthenticationData
object (Authentication Data)
required
Username
string
required
Password
string
required
ClientRefNum
string | null
optional
LoadInfo
object (Loadinfo)
required
LoadID
integer
optional
ManifestID
string
optional
BOLNumber
string
optional
CustomerPO
string
optional
InvoiceID
string
optional
BillingID
string
optional
IncoTermID
enum<string>
optional
Allowed values:
Free Alongside ShipFree OnboardCost and FreightCost Insurance and FreightCarriage Paid ToCarriage and Insurance PaidDelivered at TerminalDelivered at PlaceDelivered Duty PaidDelivered at FrontierDelivered ExShipDelivered ExQuayDelivered Duty UnpaidFree CarrierExWorks
UltimateDestinationCountryCode
string
optional
PickupNumber
string
optional
EstimatedDeliveryDate
string <date-time>
optional
EstimatedPickupDate
string <date-time>
optional
ActualPickupDate
string <date-time>
optional
ActualDeliveryDate
string <date-time>
optional
BillTo
object (BillTo)
required
Name
string
optional
Note
string
optional
ShipType
enum<string>
required
Allowed values:
ShipperConsigneeThirdParty
PayType
enum<string>
required
Allowed values:
CollectPrepaid
AddressInfo
object (AddressInfo)
required
ContactInfo
object (ContactInfo)
required
UseDefaultBillTo
boolean
optional
UseDefaultShipType
boolean
optional
UseDefaultPayType
boolean
optional
RateServices
array[object (RateServices) {11}]
required
ServiceCode
enum<string>
required
Allowed values:
ParcelLTLVolumeAirOceanGFPLocal CarrierFTLDriveawayIntermodalExpedite
ShippingQty
integer
required
PackageType
enum<string>
required
Allowed values:
AccessorialsAttachmentsBagsBalesBasketsBulkheadsBundlesBoxesBarrelsBucketsCarboysCasesChestsCoilsCartonsCratesContainerCylindersDrumsEnvelopesFeetFirkinsGaylordsKegsLooseOctabinPackagesPailsPiecesPalletsRacksReelsRollsSkidsSlipSheets (Slip Sheets)SuperSack (Super Sack)TotesTruckloadTrailersTrunksTraysTubesUnitsUnpackagedVehiclesBinsTubsEachPlasticJerricans (Plastic Jerricans)
EquipmentType
enum<string>
required
Allowed values:
Trailer_28ftOtherTrailer_48ftTankerRailCar_20ftVanTrailer_StandardVanTrailer_53ftTrailer_26ftDumper_60ydCarCarrierDoubleDropRailCar_40ftDumper_80ydStraightTruck_24ft_LiftGateTrailer_24ftStraightTruck_24ftContainer_45ftTruck_4by4StraightTruck_26ft_LiftGateDumpTruckGooseneckDumper_40ydVanContainer_40HQTruckSprinterVanHopperBottomCarStraightTruck_26ftDumper_20ydAirCargoMaxiTrailerFrozenBoxTruck_LiftGateVan_LiftGateStepDeckTruck_LiftGateRollOffContainer_53ftContainer_20ftRefrigeratedWalkingFloorContainer_40ftRailCar_53ftLowBoyFlatBedPickupTruckBoxTruckParcelTruckVan_TriAxleBulk_TruckRemovable_GooseneckWinch_TruckTractorStraight16Straight18Cargo_VanTractor_TrailerFull_Size_VanMinivanDoublesTrailer53
AdditionalWeight
number <float>
optional
SpecialInstructions
string
optional
Length
number <float>
optional
Width
number <float>
optional
Height
number <float>
optional
WeightUom
enum<string>
optional
Allowed values:
LBSKG
SizeUom
enum<string>
optional
Allowed values:
INFTCM
Shipper
object (Shipper)
required
ContactInfo
object (ContactInfo)
required
AddressInfo
object (AddressInfo)
required
LocationName
string
required
CompanyName
string
optional
Note
string
optional
CompanyID
string
optional
VendorID
string
optional
DCRefNum
string
optional
Dock
object (Dock)
required
Consignee
object (Consignee)
required
ContactInfo
object (ContactInfo)
required
AddressInfo
object (AddressInfo)
required
LocationName
string
required
CompanyName
string
optional
Note
string
optional
CompanyID
string
optional
VendorID
string
optional
DCRefNum
string
optional
Dock
object (Dock)
required
PackageInfo
object (PackageInfo)
required
CODAmount
number | null
optional
DeclaredLiability
number | null
optional
RouteNumber
string | null
optional
Products
array[object (Product) {24}]
required
Quantity
integer
required
PackageType
enum<string>
required
Allowed values:
AccessorialsAttachmentsBagsBalesBasketsBulkheadsBundlesBoxesBarrelsBucketsCarboysCasesChestsCoilsCartonsCratesContainerCylindersDrumsEnvelopesFeetFirkinsGaylordsKegsLooseOctabinPackagesPailsPiecesPalletsRacksReelsRollsSkidsSlipSheets (Slip Sheets)SuperSack (Super Sack)TotesTruckloadTrailersTrunksTraysTubesUnitsUnpackagedVehiclesBinsTubsEachPlasticJerricans (Plastic Jerricans)
Weight
number <float>
required
Class
enum<string>
required
Allowed values:
Unspecifiedc50c55c60c65c70c775c85c925c100c110c125c150c175c200c250c300c400c500
NMFC
string | null
optional
SKU
string | null
optional
IsHazmat
boolean
required
UnNumber
string | null
optional
HazMatShippingName
string | null
optional
HazMatClass
string | null
optional
HazMatPkgGroup
string | null
optional
HazmatPhoneNumber
string | null
optional
HazmatPhoneExt
string | null
optional
HazMatContact
string | null
optional
HazMatPoison
boolean
optional
Description
string
optional
Length
number <float>
optional
Width
number <float>
optional
Height
number <float>
optional
UOM
enum<string>
required
Allowed values:
EnglishMetric
SortOrder
integer
required
ReferenceNumber
string | null
optional
ParcelOptions
object (ParcelOptions)
optional
InternationalOptions
object (InternationalOptions)
optional
ShipperAccessorials
object (ShipperAccessorials)
required
AppointmentRequired
boolean
required
InsidePickup
boolean
required
SortSegregate
boolean
required
PalletJack
boolean
required
ResidentialPickup
boolean
required
LiftgatePickup
boolean
required
MarkingTagging
boolean
required
TradeShowPickup
boolean
required
NYCMetro
boolean
required
NonBusinessHourPickup
boolean
required
LimitedAccessType
optional
ConsigneeAccessorials
object (ConsigneeAccessorials)
required
AppointmentRequired
boolean
required
InsideDelivery
boolean
required
SortSegregate
boolean
required
PalletJack
boolean
required
ResidentialDelivery
boolean
required
LiftgateDelivery
boolean
required
MarkingTagging
boolean
required
TradeShowDelivery
boolean
required
NYCMetro
boolean
required
DeliveryNotification
boolean
required
TwoHourSpecialDelivery
boolean
required
NonBusinessHourDelivery
boolean
required
LimitedAccessType
optional
LoadAccessorials
object (LoadAccessorials)
required
Guaranteed
boolean
required
TimeDefinite
boolean
required
Expedited
boolean
required
HolidayPickup
boolean
required
HolidayDelivery
boolean
required
WeightDetermination
boolean
required
BlindShipment
boolean
required
BlanketService
boolean
required
SingleShipment
boolean
required
CustomsInBond
boolean
required
OverDimension
boolean
required
Stackable
boolean
required
Turnkey
boolean
required
FoodGradeProducts
boolean
required
TSA
boolean
required
Bulkhead
boolean
required
SignatureRequired
boolean
required
BlanketServiceChilled
boolean
required
BlanketServiceFrozen
boolean
required
SaturdayDelivery
boolean
required
SecondMan
boolean
required
ReturnReceipt
boolean
required
ShipmentHold
boolean
required
ProactiveResponse
boolean
required
ShipperRelease
boolean
required
WhiteGlove
boolean
required
RestrictedDelivery
boolean
required
TankerEndorsedDriverRequired
boolean
required
Return Location
object (ReturnLocation)
optional
CompanyName
string
required
ContactInfo
object (ContactInfo)
required
AddressInfo
object (AddressInfo)
required
UserDefined
array[object (UserDefined) {2}]
optional
Name
string
required
Value
string
required
ReferenceField
array[object (ReferenceField) {4}]
optional
Type
string
required
Value
string
required
PrintOnBOL
boolean
required
PrintOnShippingLabel
boolean
required
InsuranceInfo
object (InsuranceInfo)
optional
InsuranceWanted
boolean
required
VendorCode
string
required
CommodityTypeCode
string
required
CommodityConditionCode
string
required
InsuredValue
number <float>
required
Example
{
"AuthenticationData": {
"Username": "username",
"Password": "password",
"ClientRefNum": ""
},
"LoadInfo": {
"LoadID": -22535613,
"ManifestID": "occaecat Lorem sunt ea in",
"BOLNumber": "id sunt aliqua mollit",
"CustomerPO": "in officia mollit consectetur nostrud",
"InvoiceID": "adipisicing cupidatat quis et voluptate",
"BillingID": "esse",
"IncoTermID": "Cost and Freight",
"UltimateDestinationCountryCode": "MD",
"PickupNumber": "https://loremflickr.com/640/480/transport",
"EstimatedDeliveryDate": "2024-03-06T09:13:35.633Z",
"EstimatedPickupDate": "2024-03-06T19:11:58.606Z",
"ActualPickupDate": "2024-03-06T06:31:58.092Z",
"ActualDeliveryDate": "2024-03-06T23:08:50.891Z"
},
"BillTo": {
"Name": "illum delectus fugiat",
"Note": "consectetur adipisicing voluptate aliqua",
"ShipType": "Shipper",
"PayType": "Prepaid",
"AddressInfo": {
"Address1": "4573 Rosalee Unions",
"Address2": "Apt. 193",
"City": "Merced",
"CountryName": "Kazakhstan",
"CountryCode": "SR",
"State": "ID",
"Zipcode": "08952-9151",
"LocationName": "Graham, Beahan and Koss"
},
"ContactInfo": {
"FirstName": "Georgette",
"LastName": "Legros",
"ContactName": "Sheldon Jacobs",
"Phone": "1-843-878-4435",
"PhoneExt": "ext. 123",
"Fax": "1-463-689-8125 x284",
"Email": "Hershel42@example.com"
},
"UseDefaultBillTo": true,
"UseDefaultShipType": true,
"UseDefaultPayType": false
},
"RateServices": [
{
"ServiceCode": "Driveaway",
"ShippingQty": 93292561,
"PackageType": "Drums",
"EquipmentType": "Container_40HQ",
"AdditionalWeight": -1650631.4441774487,
"SpecialInstructions": "pariatur tempor Ut",
"Length": 10141963.41249241,
"Width": -25095288.739375785,
"Height": 91045121.06362784,
"WeightUom": "LBS",
"SizeUom": "CM"
}
],
"Shipper": {
"ContactInfo": {
"FirstName": "Cesar",
"LastName": "Reynolds",
"ContactName": "Sherman Wilkinson DDS",
"Phone": "1-566-667-0534 x47348",
"PhoneExt": "ext. 123",
"Fax": "1-393-456-9886",
"Email": "Keshaun.Mraz9@example.org"
},
"AddressInfo": {
"Address1": "975 Aliza Drives",
"Address2": "Apt. 817",
"City": "Altenwerthfort",
"CountryName": "Brazil",
"CountryCode": "MN",
"State": "MO",
"Zipcode": "91391-1342",
"LocationName": "Kuvalis, Robel and Buckridge"
},
"LocationName": "quaerat ea asperiores",
"CompanyName": "culpa deleniti modi",
"Note": "nulla fugiat sit",
"CompanyID": "amet nulla sed Duis reprehenderit",
"VendorID": "commodo",
"DCRefNum": "aliqua Excepteur in dolor cupidatat",
"Dock": {
"Name": "asperiores ipsam repudiandae",
"Note": "Excepteur irure",
"OpenTime": "2024-03-06T18:43:31.305Z",
"ShipmentDateTime": "2024-03-06T17:23:49.771Z",
"CloseTime": "2024-03-06T16:43:35.678Z",
"ConfirmationNumber": "laborum irure sint sed dolore",
"FCFS": false
}
},
"Consignee": {
"ContactInfo": {
"FirstName": "Hertha",
"LastName": "Marks",
"ContactName": "Morris Haley",
"Phone": "535-296-6524 x6995",
"PhoneExt": "ext. 123",
"Fax": "905-378-7666 x441",
"Email": "Hilton4@example.org"
},
"AddressInfo": {
"Address1": "91362 Torp Meadows",
"Address2": "Suite 987",
"City": "Fort Germaineside",
"CountryName": "Ireland",
"CountryCode": "GH",
"State": "HI",
"Zipcode": "47371",
"LocationName": "Dach Group"
},
"LocationName": "ratione sint incidunt",
"CompanyName": "sapiente aperiam maxime",
"Note": "enim elit in",
"CompanyID": "laboris ipsum id Ut",
"VendorID": "adipisicing",
"DCRefNum": "non eu aliquip cillum",
"Dock": {
"Name": "quidem adipisci expedita",
"Note": "voluptate id",
"OpenTime": "2024-03-06T08:31:39.596Z",
"ShipmentDateTime": "2024-03-06T12:25:04.834Z",
"CloseTime": "2024-03-07T02:06:31.443Z",
"ConfirmationNumber": "nulla",
"FCFS": true
}
},
"PackageInfo": {
"CODAmount": -98065962.82594638,
"DeclaredLiability": null,
"RouteNumber": null
},
"Products": [
{
"Quantity": 6883924,
"PackageType": "Truckload",
"Weight": -97023217.87582596,
"Class": "c85",
"NMFC": "aliqua Ut nulla dolore quis",
"SKU": "laborum enim ullamco",
"IsHazmat": true,
"UnNumber": null,
"HazMatShippingName": "inventore iste illum",
"HazMatClass": "minim",
"HazMatPkgGroup": null,
"HazmatPhoneNumber": "1-517-362-0628 x4201",
"HazmatPhoneExt": "(756) 610-0145 x76874",
"HazMatContact": "ut eiusmod veniam consectetur",
"HazMatPoison": true,
"Description": "Atque eum sit laudantium molestiae reprehenderit ipsa sit. Totam omnis asperiores aperiam inventore. Maiores dignissimos cupiditate. Non ipsa voluptatem incidunt atque ad facere suscipit mollitia. Recusandae dolor voluptatibus laudantium recusandae vero aliquid magnam.",
"Length": -91955929.34796512,
"Width": -91967140.66911742,
"Height": -86582563.70710444,
"UOM": "English",
"SortOrder": -54836464,
"ReferenceNumber": null,
"ParcelOptions": {
"DeliveryConfirmation": "CertifiedMail",
"COD": "SecuredFunds",
"CODAmount": 68859411.53794491,
"AdditionalHandling": true,
"LargePackage": true,
"DeclaredValue": 61102266.03727424,
"UnitValue": -14520625.886732578,
"UnitWeight": null,
"UnitType": null
},
"InternationalOptions": {
"ScheduleBCode": null,
"HarmonizedSystemCode": "anim",
"ECCN": null,
"UnitOriginCountryCode": "BN"
}
}
],
"ShipperAccessorials": {
"AppointmentRequired": true,
"InsidePickup": true,
"SortSegregate": false,
"PalletJack": true,
"ResidentialPickup": false,
"LiftgatePickup": false,
"MarkingTagging": false,
"TradeShowPickup": true,
"NYCMetro": true,
"NonBusinessHourPickup": true,
"LimitedAccessType": null
},
"ConsigneeAccessorials": {
"AppointmentRequired": false,
"InsideDelivery": true,
"SortSegregate": true,
"PalletJack": true,
"ResidentialDelivery": false,
"LiftgateDelivery": true,
"MarkingTagging": true,
"TradeShowDelivery": true,
"NYCMetro": false,
"DeliveryNotification": true,
"TwoHourSpecialDelivery": false,
"NonBusinessHourDelivery": false,
"LimitedAccessType": null
},
"LoadAccessorials": {
"Guaranteed": true,
"TimeDefinite": false,
"Expedited": true,
"HolidayPickup": true,
"HolidayDelivery": false,
"WeightDetermination": false,
"BlindShipment": true,
"BlanketService": true,
"SingleShipment": false,
"CustomsInBond": false,
"OverDimension": true,
"Stackable": true,
"Turnkey": true,
"FoodGradeProducts": true,
"TSA": false,
"Bulkhead": true,
"SignatureRequired": false,
"BlanketServiceChilled": true,
"BlanketServiceFrozen": true,
"SaturdayDelivery": true,
"SecondMan": true,
"ReturnReceipt": true,
"ShipmentHold": false,
"ProactiveResponse": false,
"ShipperRelease": true,
"WhiteGlove": false,
"RestrictedDelivery": false,
"TankerEndorsedDriverRequired": false
},
"Return Location": {
"CompanyName": "rerum suscipit repellendus",
"ContactInfo": {
"FirstName": "Nathanial",
"LastName": "Harris",
"ContactName": "Kendra Bosco",
"Phone": "1-562-893-5506 x298",
"PhoneExt": "ext. 123",
"Fax": "899-222-0503 x69009",
"Email": "Consuelo29@example.com"
},
"AddressInfo": {
"Address1": "543 Stiedemann Mission",
"Address2": "Apt. 257",
"City": "North Lolita",
"CountryName": "Gibraltar",
"CountryCode": "TW",
"State": "SC",
"Zipcode": "02841-3595",
"LocationName": "Haley Group"
}
},
"UserDefined": [
{
"Name": "dicta dolorum architecto",
"Value": "ut ea"
}
],
"ReferenceField": [
{
"Type": "dolore eiusmod cupidatat",
"Value": "tempor",
"PrintOnBOL": true,
"PrintOnShippingLabel": true
}
],
"InsuranceInfo": {
"InsuranceWanted": true,
"VendorCode": "adipisicing",
"CommodityTypeCode": "Duis elit",
"CommodityConditionCode": "dolor",
"InsuredValue": 43176846.958997786
}
}
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 'https://ws.integration.banyantechnology.com/services/api/rest/PendingImport' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
"AuthenticationData": {
"Username": "username",
"Password": "password",
"ClientRefNum": ""
},
"LoadInfo": {
"LoadID": -22535613,
"ManifestID": "occaecat Lorem sunt ea in",
"BOLNumber": "id sunt aliqua mollit",
"CustomerPO": "in officia mollit consectetur nostrud",
"InvoiceID": "adipisicing cupidatat quis et voluptate",
"BillingID": "esse",
"IncoTermID": "Cost and Freight",
"UltimateDestinationCountryCode": "MD",
"PickupNumber": "https://loremflickr.com/640/480/transport",
"EstimatedDeliveryDate": "2024-03-06T09:13:35.633Z",
"EstimatedPickupDate": "2024-03-06T19:11:58.606Z",
"ActualPickupDate": "2024-03-06T06:31:58.092Z",
"ActualDeliveryDate": "2024-03-06T23:08:50.891Z"
},
"BillTo": {
"Name": "illum delectus fugiat",
"Note": "consectetur adipisicing voluptate aliqua",
"ShipType": "Shipper",
"PayType": "Prepaid",
"AddressInfo": {
"Address1": "4573 Rosalee Unions",
"Address2": "Apt. 193",
"City": "Merced",
"CountryName": "Kazakhstan",
"CountryCode": "SR",
"State": "ID",
"Zipcode": "08952-9151",
"LocationName": "Graham, Beahan and Koss"
},
"ContactInfo": {
"FirstName": "Georgette",
"LastName": "Legros",
"ContactName": "Sheldon Jacobs",
"Phone": "1-843-878-4435",
"PhoneExt": "ext. 123",
"Fax": "1-463-689-8125 x284",
"Email": "Hershel42@example.com"
},
"UseDefaultBillTo": true,
"UseDefaultShipType": true,
"UseDefaultPayType": false
},
"RateServices": [
{
"ServiceCode": "Driveaway",
"ShippingQty": 93292561,
"PackageType": "Drums",
"EquipmentType": "Container_40HQ",
"AdditionalWeight": -1650631.4441774487,
"SpecialInstructions": "pariatur tempor Ut",
"Length": 10141963.41249241,
"Width": -25095288.739375785,
"Height": 91045121.06362784,
"WeightUom": "LBS",
"SizeUom": "CM"
}
],
"Shipper": {
"ContactInfo": {
"FirstName": "Cesar",
"LastName": "Reynolds",
"ContactName": "Sherman Wilkinson DDS",
"Phone": "1-566-667-0534 x47348",
"PhoneExt": "ext. 123",
"Fax": "1-393-456-9886",
"Email": "Keshaun.Mraz9@example.org"
},
"AddressInfo": {
"Address1": "975 Aliza Drives",
"Address2": "Apt. 817",
"City": "Altenwerthfort",
"CountryName": "Brazil",
"CountryCode": "MN",
"State": "MO",
"Zipcode": "91391-1342",
"LocationName": "Kuvalis, Robel and Buckridge"
},
"LocationName": "quaerat ea asperiores",
"CompanyName": "culpa deleniti modi",
"Note": "nulla fugiat sit",
"CompanyID": "amet nulla sed Duis reprehenderit",
"VendorID": "commodo",
"DCRefNum": "aliqua Excepteur in dolor cupidatat",
"Dock": {
"Name": "asperiores ipsam repudiandae",
"Note": "Excepteur irure",
"OpenTime": "2024-03-06T18:43:31.305Z",
"ShipmentDateTime": "2024-03-06T17:23:49.771Z",
"CloseTime": "2024-03-06T16:43:35.678Z",
"ConfirmationNumber": "laborum irure sint sed dolore",
"FCFS": false
}
},
"Consignee": {
"ContactInfo": {
"FirstName": "Hertha",
"LastName": "Marks",
"ContactName": "Morris Haley",
"Phone": "535-296-6524 x6995",
"PhoneExt": "ext. 123",
"Fax": "905-378-7666 x441",
"Email": "Hilton4@example.org"
},
"AddressInfo": {
"Address1": "91362 Torp Meadows",
"Address2": "Suite 987",
"City": "Fort Germaineside",
"CountryName": "Ireland",
"CountryCode": "GH",
"State": "HI",
"Zipcode": "47371",
"LocationName": "Dach Group"
},
"LocationName": "ratione sint incidunt",
"CompanyName": "sapiente aperiam maxime",
"Note": "enim elit in",
"CompanyID": "laboris ipsum id Ut",
"VendorID": "adipisicing",
"DCRefNum": "non eu aliquip cillum",
"Dock": {
"Name": "quidem adipisci expedita",
"Note": "voluptate id",
"OpenTime": "2024-03-06T08:31:39.596Z",
"ShipmentDateTime": "2024-03-06T12:25:04.834Z",
"CloseTime": "2024-03-07T02:06:31.443Z",
"ConfirmationNumber": "nulla",
"FCFS": true
}
},
"PackageInfo": {
"CODAmount": -98065962.82594638,
"DeclaredLiability": null,
"RouteNumber": null
},
"Products": [
{
"Quantity": 6883924,
"PackageType": "Truckload",
"Weight": -97023217.87582596,
"Class": "c85",
"NMFC": "aliqua Ut nulla dolore quis",
"SKU": "laborum enim ullamco",
"IsHazmat": true,
"UnNumber": null,
"HazMatShippingName": "inventore iste illum",
"HazMatClass": "minim",
"HazMatPkgGroup": null,
"HazmatPhoneNumber": "1-517-362-0628 x4201",
"HazmatPhoneExt": "(756) 610-0145 x76874",
"HazMatContact": "ut eiusmod veniam consectetur",
"HazMatPoison": true,
"Description": "Atque eum sit laudantium molestiae reprehenderit ipsa sit. Totam omnis asperiores aperiam inventore. Maiores dignissimos cupiditate. Non ipsa voluptatem incidunt atque ad facere suscipit mollitia. Recusandae dolor voluptatibus laudantium recusandae vero aliquid magnam.",
"Length": -91955929.34796512,
"Width": -91967140.66911742,
"Height": -86582563.70710444,
"UOM": "English",
"SortOrder": -54836464,
"ReferenceNumber": null,
"ParcelOptions": {
"DeliveryConfirmation": "CertifiedMail",
"COD": "SecuredFunds",
"CODAmount": 68859411.53794491,
"AdditionalHandling": true,
"LargePackage": true,
"DeclaredValue": 61102266.03727424,
"UnitValue": -14520625.886732578,
"UnitWeight": null,
"UnitType": null
},
"InternationalOptions": {
"ScheduleBCode": null,
"HarmonizedSystemCode": "anim",
"ECCN": null,
"UnitOriginCountryCode": "BN"
}
}
],
"ShipperAccessorials": {
"AppointmentRequired": true,
"InsidePickup": true,
"SortSegregate": false,
"PalletJack": true,
"ResidentialPickup": false,
"LiftgatePickup": false,
"MarkingTagging": false,
"TradeShowPickup": true,
"NYCMetro": true,
"NonBusinessHourPickup": true,
"LimitedAccessType": null
},
"ConsigneeAccessorials": {
"AppointmentRequired": false,
"InsideDelivery": true,
"SortSegregate": true,
"PalletJack": true,
"ResidentialDelivery": false,
"LiftgateDelivery": true,
"MarkingTagging": true,
"TradeShowDelivery": true,
"NYCMetro": false,
"DeliveryNotification": true,
"TwoHourSpecialDelivery": false,
"NonBusinessHourDelivery": false,
"LimitedAccessType": null
},
"LoadAccessorials": {
"Guaranteed": true,
"TimeDefinite": false,
"Expedited": true,
"HolidayPickup": true,
"HolidayDelivery": false,
"WeightDetermination": false,
"BlindShipment": true,
"BlanketService": true,
"SingleShipment": false,
"CustomsInBond": false,
"OverDimension": true,
"Stackable": true,
"Turnkey": true,
"FoodGradeProducts": true,
"TSA": false,
"Bulkhead": true,
"SignatureRequired": false,
"BlanketServiceChilled": true,
"BlanketServiceFrozen": true,
"SaturdayDelivery": true,
"SecondMan": true,
"ReturnReceipt": true,
"ShipmentHold": false,
"ProactiveResponse": false,
"ShipperRelease": true,
"WhiteGlove": false,
"RestrictedDelivery": false,
"TankerEndorsedDriverRequired": false
},
"Return Location": {
"CompanyName": "rerum suscipit repellendus",
"ContactInfo": {
"FirstName": "Nathanial",
"LastName": "Harris",
"ContactName": "Kendra Bosco",
"Phone": "1-562-893-5506 x298",
"PhoneExt": "ext. 123",
"Fax": "899-222-0503 x69009",
"Email": "Consuelo29@example.com"
},
"AddressInfo": {
"Address1": "543 Stiedemann Mission",
"Address2": "Apt. 257",
"City": "North Lolita",
"CountryName": "Gibraltar",
"CountryCode": "TW",
"State": "SC",
"Zipcode": "02841-3595",
"LocationName": "Haley Group"
}
},
"UserDefined": [
{
"Name": "dicta dolorum architecto",
"Value": "ut ea"
}
],
"ReferenceField": [
{
"Type": "dolore eiusmod cupidatat",
"Value": "tempor",
"PrintOnBOL": true,
"PrintOnShippingLabel": true
}
],
"InsuranceInfo": {
"InsuranceWanted": true,
"VendorCode": "adipisicing",
"CommodityTypeCode": "Duis elit",
"CommodityConditionCode": "dolor",
"InsuredValue": 43176846.958997786
}
}'
Responses
🟢200PendingImport - 200 OK
application/json
Body
RatingComplete
boolean
required
Load
object
required
AuthenticationData
object (Authentication Data)
required
LoadInfo
object (Loadinfo)
required
BillTo
object (BillTo)
required
RateServices
array[object (RateServices) {11}]
required
Shipper
object (Shipper)
required
Consignee
object (Consignee)
required
PackageInfo
object (PackageInfo)
required
Products
array[object (Product) {24}]
required
ShipperAccessorials
object (ShipperAccessorials)
required
ConsigneeAccessorials
object (ConsigneeAccessorials)
required
LoadAccessorials
object (LoadAccessorials)
required
Return Location
object (ReturnLocation)
optional
UserDefined
array[object (UserDefined) {2}]
optional
ReferenceField
array[object (ReferenceField) {4}]
optional
InsuranceInfo
object (InsuranceInfo)
optional
Quotes
array[object (Quote) {21}]
required
LoadID
integer
required
QuoteID
integer
required
CarrierName
string
required
SCAC
string
required
ThirdPartyName
string
required
ThirdPartySCAC
string
required
ServiceID
string
required
RawPrice
object (PriceBreakout)
required
CarrierPrice
object (PriceBreakout)
required
CustomerPrice
object (PriceBreakout)
required
TransitTime
integer
required
QuoteNumber
string
optional
AccountNumber
string
optional
CarrierPerson
string
optional
CarrierNote
string
optional
Datestamp
string
required
Interline
boolean
required
Accepted
boolean
required
CurrencyType
enum<string>
required
Allowed values:
US_DollarCanadian_DollarMexican_Peso
Service
enum<string>
required
Allowed values:
ParcelLTLVolumeAirOceanGFPLocal CarrierFTLDriveawayIntermodalExpedite
InsuranceDetails
object (InsuranceDetails)
optional
FailedQuotes
array[object (FailedQuote) {6}]
optional
CarrierName
string
required
SCAC
string
required
ReasonCode
enum<string>
required
Allowed values:
GeneralIssueAuthorizationAccountTariffConfigurationManualRatingRequiredCoverageAreaHazardousMaterialPackageTypeEquipmentTypeShipTypePayTypeShipTypePayTypeCombinationPickupDateBillToFreightClassMaximumProductThresholdMissingProductDimensionsMaximumDimensionsProductDimensionsProductDescriptionNMFCMaximumWeightThresholdMinimumWeightThresholdShippingUnitsMinimumShippingUnitsMaximumShippingUnitsMissingShipmentDimensionsShipperConsigneeShipperOrConsigneeLimitedAccessTypeAccessorialCODAmount
Reason
enum<string>
required
Allowed values:
GeneralIssueAuthorizationAccountTariffConfigurationManualRatingRequiredCoverageAreaHazardousMaterialPackageTypeEquipmentTypeShipTypePayTypeShipTypePayTypeCombinationPickupDateBillToFreightClassMaximumProductThresholdMissingProductDimensionsMaximumDimensionsProductDimensionsProductDescriptionNMFCMaximumWeightThresholdMinimumWeightThresholdShippingUnitsMinimumShippingUnitsMaximumShippingUnitsMissingShipmentDimensionsShipperConsigneeShipperOrConsigneeLimitedAccessTypeAccessorialCODAmount
Datestamp
string <date-time>
required
Service
enum<string>
required
Allowed values:
ParcelLTLVolumeAirOceanGFPLocal CarrierFTLDriveawayIntermodalExpedite
Notes
array[object (Note) {4}]
required
Text
string
required
User
string
required
DateStamp
string
required
NoteType
enum<string>
required
Allowed values:
AccountingAdjustmentEmailArchivingQuoteUpdateCarrierAwardedQuoteTechnicalNoteWebTrackingEdiSystemEventInstructionsPublicBookReasonWebDispatchQuoteRequestPrivateContactAccountingTerminalUrlCustomerDockUpdateAddressDeleteQuotePackageRateExceptionBillingReasonAdditionalServiceValidationQuoteQuoteRequestEmail
Error
object (ErrorObject)
required
Message
string
required
Example
{
"Load": {
"AuthenticationData": {
"Username": "_",
"Password": "_",
"ClientRefNum": "_"
},
"DebugMode": false,
"Loadinfo": {
"LoadID": 62339090,
"ManifestID": "",
"BOLNumber": "DEMO03241",
"CustomerPO": "",
"InvoiceID": "",
"BillingID": "",
"IncoTermID": null,
"UltimateDestinationCountryCode": "",
"PickupNumber": null,
"EstimatedDeliveryDate": "0001-01-01T00:00:00",
"EstimatedPickupDate": "0001-01-01T00:00:00",
"ActualPickupDate": "0001-01-01T00:00:00",
"ActualDeliveryDate": "0001-01-01T00:00:00"
},
"BillTo": {
"Name": "",
"Note": "",
"ShipType": 0,
"PayType": 0,
"UseDefaultBillTo": false,
"AddressInfo": {
"Address1": "",
"Address2": "",
"City": "",
"CountryName": "United States",
"CountryCode": "USA",
"State": "",
"Zipcode": "",
"LocationName": ""
},
"ContactInfo": {
"FirstName": "",
"LastName": "",
"ContactName": "",
"Phone": "",
"PhoneExt": "",
"Fax": "",
"Email": ""
},
"UseDefaultShipType": false,
"UseDefaultPayType": false
},
"InsuranceInfo": null,
"RateServices": [
{
"ServiceCode": 1,
"ShippingQty": 3,
"PackageType": 29,
"EquipmentType": 5,
"AdditionalWeight": 50,
"SpecialInstructions": "Do not break",
"Length": null,
"Width": null,
"Height": null,
"WeightUom": 1,
"SizeUom": 1
}
],
"Shipper": {
"ContactInfo": {
"FirstName": "",
"LastName": "",
"ContactName": "",
"Phone": "",
"PhoneExt": "",
"Fax": "",
"Email": ""
},
"AddressInfo": {
"Address1": "123 test",
"Address2": "",
"City": "Chicago",
"CountryName": "United States",
"CountryCode": "USA",
"State": "IL",
"Zipcode": "60606",
"LocationName": "Test"
},
"CompanyName": "Test",
"Note": "",
"CompanyID": "",
"LocationName": null,
"VendorID": "",
"DCRefNum": "",
"Dock": {
"Name": "Main Dock",
"Note": "",
"OpenTime": "2018-07-11T08:00:00",
"ShipmentDateTime": "2018-07-11T12:00:00",
"CloseTime": "2018-07-11T17:00:00",
"ConfirmationNumber": "",
"FCFS": false
}
},
"Consignee": {
"ContactInfo": {
"FirstName": "",
"LastName": "",
"ContactName": "",
"Phone": "",
"PhoneExt": "",
"Fax": "",
"Email": ""
},
"AddressInfo": {
"Address1": "321 Test Street",
"Address2": "",
"City": "Cleveland",
"CountryName": "United States",
"CountryCode": "USA",
"State": "OH",
"Zipcode": "44133",
"LocationName": "Test1"
},
"CompanyName": "Test1",
"Note": "",
"CompanyID": "",
"LocationName": null,
"VendorID": "",
"DCRefNum": "",
"Dock": {
"Name": "Main Dock",
"Note": "",
"OpenTime": "2018-07-11T08:00:00",
"ShipmentDateTime": "2018-07-11T12:00:00",
"CloseTime": "2018-07-11T17:00:00",
"ConfirmationNumber": "",
"FCFS": false
}
},
"ReturnLocation": null,
"PackageInfo": {
"CODAmount": 0,
"DeclaredLiability": 0,
"RouteNumber": ""
},
"Products": [
{
"Quantity": 2,
"PackageType": 5,
"Weight": 1500,
"Class": 9,
"NMFC": "",
"SKU": "",
"IsHazmat": false,
"HazmatPhoneNumber": "",
"HazmatPhoneExt": "",
"Description": "Testing",
"Length": 48,
"Width": 48,
"Height": 24,
"UOM": 0,
"SortOrder": 1,
"ReferenceNumber": "",
"ParcelOptions": {
"DeliveryConfirmation": 0,
"COD": 0,
"CODAmount": 0,
"AdditionalHandling": false,
"LargePackage": false,
"DeclaredValue": 0,
"UnitValue": null,
"UnitWeight": null,
"UnitType": null
},
"UnNumber": "",
"HazMatShippingName": "",
"HazMatPkgGroup": "",
"HazMatClass": "",
"InternationalOptions": {
"ScheduleBCode": null,
"HarmonizedSystemCode": null,
"ECCN": null,
"UnitOriginCountryCode": null
},
"HazMatContact": "",
"HazMatPoison": false
}
],
"ShipperAccessorials": {
"AppointmentRequired": false,
"InsidePickup": false,
"SortSegregate": false,
"PalletJack": false,
"ResidentialPickup": false,
"LiftgatePickup": false,
"MarkingTagging": false,
"TradeShowPickup": false,
"NYCMetro": false,
"NonBusinessHourPickup": false,
"LimitedAccessType": null
},
"ConsigneeAccessorials": {
"AppointmentRequired": false,
"InsideDelivery": false,
"SortSegregate": false,
"PalletJack": false,
"ResidentialDelivery": false,
"LiftgateDelivery": false,
"MarkingTagging": false,
"TradeShowDelivery": false,
"NYCMetro": false,
"DeliveryNotification": false,
"TwoHourSpecialDelivery": false,
"NonBusinessHourDelivery": false,
"LimitedAccessType": null
},
"LoadAccessorials": {
"Guaranteed": false,
"TimeDefinite": false,
"Expedited": false,
"HolidayPickup": false,
"HolidayDelivery": false,
"WeightDetermination": false,
"BlindShipment": false,
"BlanketService": false,
"ProtectFromFreezing": false,
"SingleShipment": false,
"CustomsInBond": false,
"OverDimension": false,
"Stackable": false,
"Turnkey": false,
"FoodGradeProducts": false,
"TSA": false,
"Bulkhead": false,
"SignatureRequired": false,
"BlanketServiceChilled": false,
"BlanketServiceFrozen": false,
"SaturdayDelivery": false,
"SecondMan": false,
"ReturnReceipt": false,
"ShipmentHold": false,
"ProactiveResponse": false,
"ShipperRelease": false,
"WhiteGlove": false,
"RestrictedDelivery": false,
"TankerEndorsedDriverRequired": false
},
"UserDefined": [],
"ReferenceField": []
},
"Quotes": null,
"PendingQuotes": null,
"FailedQuotes": null,
"Notes": [
{
"Text": "Load Created",
"User": "Demo User",
"DateStamp": "2024-03-06T21:48:53",
"NoteType": 10
},
{
"Text": "Original BOLID: DEMO03241",
"User": "Automation",
"DateStamp": "2024-03-06T21:48:53",
"NoteType": 7
}
],
"RatingComplete": false,
"ErrorMessage": null
}
Modified at 2024-09-16 11:42:17