[v1] Dispatch

Overview

This endpoint allows you to schedule a pickup for LTL shipments and to cancel any LTL pickup requests.

You can define pickup availability and accessorials, such as liftgate services, at origin or destination.

POST /CancelDispatch

Request Body

Dispatch cancellation request provided from external systems to create a dispatch in a specified carrier integration's webservice.

Property	Data Type	Notes
includeTransactions	boolean	Gets or sets a flag that dictates if this request should include transactions in the response.
isProduction	boolean	Gets or sets a flag that dictates to send to test or production endpoints.
confirmationNumber	string	Gets or sets the pickup id.
reason	string	Gets or sets the reason.
proNumber	string	Gets or sets the PRO number.

carrier

Gets or sets the PRO carrier.

Property	Data Type	Notes
integrationName	string	Sets the name of the carrier's integration.
carrierName	string	Sets the name of the carrier used for the provided integration.
credentialSetName	string	Sets the identifier for the set of account credentials to be looked up for the provided integration.
billingAccountNumber	string	Sets the account number to be billed for this request.
thirdPartyBillingAccountNumber	string	Sets the account number to be billed when the request requires another account to pay.

shipper

Gets or sets the shipper's address.

Property	Data Type	Notes
countryCode	string	Gets or sets the country code, expecting ISO2 formatting.
postalCode	string	Gets or sets the postal code in different country formats.
city	string	Gets or sets the name of the city.
addressLines	string	Gets or sets the address lines that represent the street address.
stateProvinceCode	string	Gets or sets the state or province code in the expected country format.
companyName	string	Gets or sets the name of the company that this address represents.
name	string	Gets or sets the name of the contact.
emailAddress	string	Gets or sets the email address of the contact.
phoneNumber	string	Gets or sets the phone number of the contact.

Response

Cancel dispatch response provided to external systems when a cancel dispatch request has been made for a specific carrier's webservice.

Property	Data Type	Notes
runTime	integer	Gets or sets the run time for creating a response for the incoming request in the LTL API. int64

messages

Gets or sets list of response messages.

Property	Data Type	Notes
value	string	Gets or sets the message text content.
severity	enum	Gets or sets the type of message severity. Information Warning Error

carrierCancelDispatchResponse

Carrier cancel dispatch response provided from cancel dispatch operation executed in a specified carrier integration's webservice.

Property	Data Type	Notes
transactionId	string	Gets or sets the transaction ID.
confirmationNumber	string	Gets or sets the pickup ID.

messages

Gets or sets list of response messages.

Property	Data Type	Notes
value	string	Gets or sets the message text content.
severity	enum	Gets or sets the type of message severity. Information Warning Error

transactions

Gets or sets list of transactions.

Property	Data Type	Notes
transactionId	string	Gets or sets the transaction ID used for the request.
endpoint	string	Gets or sets the endpoint used for the request.
request	string	Gets or sets the transaction request content.
response		Gets or sets the transaction response content.

POST /Dispatch

Request Body

Property	Data Type	Notes
includeTransactions	boolean	Gets or sets a flag that dictates if this request should include transactions in the response.
isProduction	boolean	Gets or sets a flag that dictates to send to test or production endpoints.

carrier

Gets or sets the carrier webservice details in the request.

Property	Data Type	Notes
integrationName	string	Sets the name of the carrier's integration.
carrierName	string	Sets the name of the carrier used for the provided integration.
credentialSetName	string	Sets the identifier for the set of account credentials to be looked up for the provided integration.
billingAccountNumber	string	Sets the account number to be billed for this request.
thirdPartyBillingAccountNumber	string	Sets the account number to be billed when the request requires another account to pay.
carrierServiceName	string	Sets the carrier integration service name.
documentFormat	enum	Sets the DocumentFormat. ZPL PDF PNG GIF Other

shipment

Details the goods being shipped.

Property	Data Type	Notes
shipmentId	string	Gets or sets the identifier for this shipment.
freightClass	string	Gets or sets the less than truckload (LTL) internationally recognized freight class for this shipment.
description	string	Gets or sets the description for the shipment.
currencyCode	enum	Gets or sets the currency code for all values within the shipment. USD, CAD, AUD, GBP, EUR, DKK, SEK, NOK, CZK, CHF, HUF, PLN, MXN, PHP, SAR, JPY, XCD, ARS, AWG, BSD, BHD, BBD, BMD, INR, BRL, BND, BGN, KYD, CLP, CNY, COP, NZD, CRC, ANG, DOP, EGP, GTQ, HKD, IDR, ILS, JMD, KZT, KES, KRW, KWD, ZAR, LYD, MOP, MYR, MUR, MZN, PKR, PAB, RON, RUB, WST, SGD, SBD, THB, TOP, TTD, TND, TRY, UGX, AED, UYU, VES, VND, TWD
shipFromReferenceId	string	Gets or sets the host ship from reference id.
freightTerm	enum	Gets or sets the FreightTerm for this shipment. Shipper Receiver ThirdParty
termsOfTrade	enum	Gets or sets the TermsOfTrade for this shipment. Ddp Dap Fca Fob Cip Cpt Exw Ddu Dpu
estimateId	string	Gets or sets the identifier of rate estimations that the carrier has previously promised.
proNumber	string	Gets or sets the PRO number that was previously generated.
masterBillOfLadingNumber	string	Gets or sets the master bill of lading number that was previously generated.
additionalBillOfLadingNumbers	string	Gets or sets the collection of additional bill of lading numbers.

accessorials

Details the possible accessorials that can be enabled for a shipment.

airportDelivery

Details the added service identifying that this shipment needs to be delivered at the airport.

Property	Data Type	Notes
enabled	boolean	When enabled, the carrier will make the delivery at the airport.

airportPickup

Details the added service identifying that this shipment needs to be picked up at the airport.

Property	Data Type	Notes
enabled	boolean	When enabled, the carrier will make the pickup at the airport.

appointmentRequiredAtDelivery

Details the added service that ensures an appointment will be created at the delivery address.

Property	Data Type	Notes
enabled	boolean	When enabled, the carrier will create an appointment at delivery to the ShipTo.

appointmentRequiredAtPickup

Details the added service that ensures an appointment will be created at the pickup address.

Property	Data Type	Notes
enabled	boolean	When enabled, the carrier will create an appointment at pickup from the ShipFrom.

cod

Details the added service Cash on Delivery (COD).

Property

Data Type

Notes

enabled

boolean

When enabled, the carrier will collect payment at delivery.

amount

number

Gets or sets the amount to be collected on delivery.

decimal

guaranteedRate

Details the added service identifying that the rate that is returned by the carrier will be guaranteed.

Property	Data Type	Notes
enabled	boolean	When enabled, the rate that is returned by the carrier will be guaranteed.

hazardousMaterial

Details the added service identifying that this shipment is carrying hazardous material.

Property	Data Type	Notes
enabled	boolean	When enabled, the shipment will be marked as carrying hazardous material by the carrier.

insideDelivery

Details the added service identifying that this shipment needs to be delivered inside the shipTo address.

Property	Data Type	Notes
enabled	boolean	When enabled, the carrier will make the delivery inside the ShipTo facility.

insidePickup

Details the added service identifying that this shipment needs to be picked up from inside the shipFrom address.

Property	Data Type	Notes
enabled	boolean	When enabled, the carrier will make the pickup from inside the ShipFrom facility.

insurance

Details the added service identifying that this shipment needs to be insured by the carrier.

Property

Data Type

Notes

enabled

boolean

When enabled, the carrier will insure the shipment for a monetary amount specified in the accessorial.

shipmentValue

number

Gets or sets the monetary value of the insurance.

decimal

additionalInsuranceAmount

number

Gets or sets the additional monetary value of the insurance.

decimal

liftGateRequiredAtDelivery

Details the added service ensuring that the carrier utilizes a truck with a lift gate when making the delivery.

Property	Data Type	Notes
enabled	boolean	When enabled, the carrier will make the delivery with a truck that has a lift gate.

liftGateRequiredAtPickup

Details the added service ensuring that the carrier utilizes a truck with a lift gate when arriving to pickup the goods.

Property	Data Type	Notes
enabled	boolean	When enabled, the carrier will make the pickup with a truck that has a lift gate.

limitedAccessDelivery

Details the added service that informs the carrier that the delivery address will have limited access for the truck.

Property	Data Type	Notes
enabled	boolean	When enabled, the carrier will make the delivery at a location that is more difficult or has limited accessibility for a truck.

limitedAccessPickup

Details the added service that informs the carrier that the pickup address will have limited access for the truck.

Property	Data Type	Notes
enabled	boolean	When enabled, the carrier will make the pickup at a location that is more difficult or has limited accessibility for a truck.

markedOrTagged

Details the added service that informs the carrier they will need to mark or tag the package with a new address to ensure it goes to the correct location.

Property

Data Type

Notes

enabled

boolean

When enabled, the carrier will mark or tag the handling units with new labels.

count

integer

The number of handling units that will need to be marked or tagged.

int32

notificationDeliver

Details the added service that will provide a notification when the goods have been delivered.

Property	Data Type	Notes
enabled	boolean	When enabled, the carrier will provide a notification when the shipment has been delivered.

oversized

Details the added service that identifies the shipment will be oversized to the carrier.

Property	Data Type	Notes
enabled	boolean	When enabled, the carrier is informed that the shipment contains oversized handling units.

residentialPickup

Details the added service for when the carrier must pickup from a residential address.

Property	Data Type	Notes
enabled	boolean	When enabled, the carrier will make the pickup from a residential address.

residentialDelivery

Details the added service for when the carrier must deliver to a residential address.

Property	Data Type	Notes
enabled	boolean	When enabled, the carrier will make the delivery to a residential address.

securedLimitedAccessDelivery

Details the added service for when the carrier must deliver to a facility that is difficult to access and has security to navigate.

Property	Data Type	Notes
enabled	boolean	When enabled, the carrier will make the delivery at a location that is more difficult or has limited accessibility and security for a truck.

securedLimitedAccessPickup

Details the added service for when the carrier must pickup from a facility that is difficult to access and has security to navigate.

Property	Data Type	Notes
enabled	boolean	When enabled, the carrier will make the pickup from a location that is more difficult or has limited accessibility and security for a truck.

sortAndSegregate

Details the added service for unloading and sorting the goods before reaching the shipTo.

Property

Data Type

Notes

enabled

boolean

When enabled, the carrier will sort and segregate the goods in the shipment.

pieces

integer

Gets or sets the number of pieces to be sorted and segregated.

int32

tradeshowDelivery

Details the added service identifying that this shipment needs to be delivered at the Tradeshow.

Property	Data Type	Notes
enabled	boolean	When enabled, the carrier will make the delivery at the tradeshow.

tradeshowPickup

Details the added service identifying that this shipment needs to be picked up at the Tradeshow.

Property	Data Type	Notes
enabled	boolean	When enabled, the carrier will make the pickup at the tradeshow.

pickupAppointment

Gets or sets the window of time where the shipment can be picked up for delivery.

Property

Data Type

Notes

startDateTime

string

Gets or sets the start date and time of the appointment.

date-time

endDateTime

string

Gets or sets the end date and time of the appointment.

date-time

closeDateTime

string

Gets or sets the closing time of the facility or absolute latest that an appointment can be fulfilled.

date-time

deliveryAppointment

Gets or sets the window of time where the shipment can be delivered.

Property

Data Type

Notes

startDateTime

string

Gets or sets the start date and time of the appointment.

date-time

endDateTime

string

Gets or sets the end date and time of the appointment.

date-time

closeDateTime

string

Gets or sets the closing time of the facility or absolute latest that an appointment can be fulfilled.

date-time

weight

Gets or sets the weight of the shipment.

Property	Data Type	Notes
weightValue	number	Gets or sets the weight value. decimal
weightUom	enum	Lb Oz Kg

hazMatShipmentDetail

Gets or sets the details of the shipment that is relevant in hazardous material shipping.

emergencyContact

Gets or sets the details of the emergency contact for hazardous material shipping.

Property	Data Type	Notes
name	string	Gets or sets the name of the contact.
phoneNumber	string	Gets or sets the phone number of the contact.
emailAddress	string	Gets or sets the email address of the contact.

handlingUnits

Gets or sets the handling units being sent.

Property	Data Type	Notes
handlingUnitId	string	Gets or sets the identifier for the handling unit.
freightClass	number	Gets or sets the less than truckload (LTL) internationally recognized freight class for the handling unit. decimal
description	string	Gets or sets the description of the handling unit.
value	number	Gets or sets the monetary value of the handling unit. decimal
packagingType	enum	Gets or sets the PackagingType for this handling unit. Bag, Barrel, Basket, Box, Bucket, Bundle, Cage, Carton, Case, Chest, Container, Crate, Cylinder, Drum, Envelope, Hamper, Package, Pail, Pallet, Parcel, Piece, Reel, Roll, Sack, ShrinkWrapped, Skid, Tank, ToteBin, Tube, Unit

weight

Gets or sets the weight of the handling unit.

Property	Data Type	Notes
weightValue	number	Gets or sets the weight value. decimal
weightUom	enum	Lb Oz Kg

dimensions

Gets or sets the dimensions for the handling unit.

Property	Data Type	Notes
height	number	Gets or sets the height. decimal
length	number	Gets or sets the length. decimal
width	number	Gets or sets the width. decimal
dimensionUom	enum	Gets or sets the unit of measure for the dimensions. In Cm

pieces

Gets or sets the collection of piece under the handling unit.

Property	Data Type	Notes
pieceId	string	Gets or sets the identifier of the piece.
freightClass	number	Gets or sets the less than truckload (LTL) internationally recognized freight class for this shipment. decimal
description	string	Gets or sets the description of the piece detail.
value	number	Gets or sets the monetary value of the piece. decimal
harmonizedCode	string	Gets or sets the harmonized code.
countryManufactured	string	Gets or sets the country of manufacture.
quantity	number	Gets or sets the quantity. decimal
quantityUom	string	Gets or sets the quantity UOM.
packagingType	enum	Gets or sets the packaging type that is expected by the carrier. Bag, Barrel, Basket, Box, Bucket, Bundle, Cage, Carton, Case, Chest, Container, Crate, Cylinder, Drum, Envelope, Hamper, Package, Pail, Pallet, Parcel, Piece, Reel, Roll, Sack, ShrinkWrapped, Skid, Tank, ToteBin, Tube, Unit

weight

Gets or sets the weight of the piece.

Property	Data Type	Notes
weightValue	number	Gets or sets the weight value. decimal
weightUom	enum	Lb Oz Kg

dimensions

Gets or sets the dimensions of the piece.

Property	Data Type	Notes
height	number	Gets or sets the height. decimal
length	number	Gets or sets the length. decimal
width	number	Gets or sets the width. decimal
dimensionUom	enum	Gets or sets the unit of measure for the dimensions. In Cm

pieceDetails

Gets or sets the collection of pallet details.

Property	Data Type	Notes
pieceDetailId	string	Gets or sets the PieceDetail identifier.
description	string	Gets or sets the description of the piece detail.
countryManufactured	string	Gets or sets the country where the piece detail is produced.
nmfc	string	Gets or sets the NMFC.
stackable	boolean	Gets or sets a value indicating whether is stackable.

weight

Gets or sets the weight of the piece detail.

Property	Data Type	Notes
weightValue	number	Gets or sets the weight value. decimal
weightUom	enum	Lb Oz Kg

hazardousPieceDetails

Gets or sets the hazardous piece details.

Property	Data Type	Notes
unNaNumber	string	Gets or sets the UN NA number.
properShippingName	string	Gets or sets the proper shipping name.
technicalName	string	Gets or sets the technical name.
packingGroupNumber	string	Gets or sets the packing group number.
contractNumber	string	Gets or sets the contract number.

broker

Gets or sets the broker's address.

Property	Data Type	Notes
countryCode	string	Gets or sets the country code, expecting ISO2 formatting.
postalCode	string	Gets or sets the postal code in different country formats.
city	string	Gets or sets the name of the city.
addressLines	string	Gets or sets the address lines that represent the street address.
stateProvinceCode	string	Gets or sets the state or province code in the expected country format.
companyName	string	Gets or sets the name of the company that this address represents.
name	string	Gets or sets the name of the contact.
emailAddress	string	Gets or sets the email address of the contact.
phoneNumber	string	Gets or sets the phone number of the contact.
brokerType	enum	Gets or sets the broker type. Export Import

shipper

Gets or sets the shipper's address.

Property	Data Type	Notes
countryCode	string	Gets or sets the country code, expecting ISO2 formatting.
postalCode	string	Gets or sets the postal code in different country formats.
city	string	Gets or sets the name of the city.
addressLines	string	Gets or sets the address lines that represent the street address.
stateProvinceCode	string	Gets or sets the state or province code in the expected country format.
companyName	string	Gets or sets the name of the company that this address represents.
name	string	Gets or sets the name of the contact.
emailAddress	string	Gets or sets the email address of the contact.
phoneNumber	string	Gets or sets the phone number of the contact.

shipFrom

Gets or sets the address being shipped from.

Property	Data Type	Notes
countryCode	string	Gets or sets the country code, expecting ISO2 formatting.
postalCode	string	Gets or sets the postal code in different country formats.
city	string	Gets or sets the name of the city.
addressLines	string	Gets or sets the address lines that represent the street address.
stateProvinceCode	string	Gets or sets the state or province code in the expected country format.
companyName	string	Gets or sets the name of the company that this address represents.
name	string	Gets or sets the name of the contact.
emailAddress	string	Gets or sets the email address of the contact.
phoneNumber	string	Gets or sets the phone number of the contact.

shipTo

Gets or sets the address being shipped to.

Property	Data Type	Notes
countryCode	string	Gets or sets the country code, expecting ISO2 formatting.
postalCode	string	Gets or sets the postal code in different country formats.
city	string	Gets or sets the name of the city.
addressLines	string	Gets or sets the address lines that represent the street address.
stateProvinceCode	string	Gets or sets the state or province code in the expected country format.
companyName	string	Gets or sets the name of the company that this address represents.
name	string	Gets or sets the name of the contact.
emailAddress	string	Gets or sets the email address of the contact.
phoneNumber	string	Gets or sets the phone number of the contact.

billTo

Gets or sets the address being billed to.

Property	Data Type	Notes
countryCode	string	Gets or sets the country code, expecting ISO2 formatting.
postalCode	string	Gets or sets the postal code in different country formats.
city	string	Gets or sets the name of the city.
addressLines	string	Gets or sets the address lines that represent the street address.
stateProvinceCode	string	Gets or sets the state or province code in the expected country format.
companyName	string	Gets or sets the name of the company that this address represents.
name	string	Gets or sets the name of the contact.
emailAddress	string	Gets or sets the email address of the contact.
phoneNumber	string	Gets or sets the phone number of the contact.

dimensions

Gets or sets the dimensions.

Property	Data Type	Notes
height	number	Gets or sets the height. decimal
length	number	Gets or sets the length. decimal
width	number	Gets or sets the width. decimal
dimensionUom	enum	Gets or sets the unit of measure for the dimensions. In Cm

customsDetails

Gets or sets the customs details.

taxInformation

Gets or sets the tax information.

Property	Data Type	Notes
taxIdentificationType	enum	Gets or sets the tax identification type. BusinessNational BusinessState
taxIdentificationNumber	string	Gets or sets the tax identification number.

electronicExportInformation

Gets or sets the electronic export information.

Property

Data Type

Notes

value

string

Gets or sets the international transaction number/exemption code value.

exportType

enum

Gets or sets the electronic export type.

InternationalTransactionNumber
ExemptionCode

statementType

enum

Gets or sets the statement type.

DepartmentOfCommerce
DepartmentOfState

commercialInvoiceDetails

Gets or sets the commercial invoice details.

Property	Data Type	Notes
declarationStatement	string	Gets or sets the declaration statement.
comments	string	Gets or sets the comments.

Response

Dispatch response provided to external systems when a dispatch request has been made for a specific carrier's webservice.

Property	Data Type	Notes
runTime	integer	Gets or sets the run time for creating a response for the incoming request in the LTL API. int64

messages

Gets or sets list of response messages.

Property	Data Type	Notes
value	string	Gets or sets the message text content.
severity	enum	Gets or sets the type of message severity. Information Warning Error

carrierDispatchResponse

Gets or sets the carrier dispatch response.

Property	Data Type	Notes
confirmationNumber	string	Gets or sets the confirmation number.
proNumber	string	Gets or sets the PRO number.
billOfLadingNumber	string	Gets or sets the bill of lading number.
estimateNumber	string	Gets or sets the estimate number.

messages

Gets or sets list of response messages.

Property	Data Type	Notes
value	string	Gets or sets the message text content.
severity	enum	Gets or sets the type of message severity. Information Warning Error

transactions

Gets or sets list of transactions.

Property	Data Type	Notes
transactionId	string	Gets or sets the transaction ID used for the request.
endpoint	string	Gets or sets the endpoint used for the request.
request	string	Gets or sets the transaction request content.
response		Gets or sets the transaction response content.

Ship + Buy + Tender + Orchestrate

[v1] Dispatch

Overview

POST /CancelDispatch

POST /Dispatch

Feedback