Overview

This endpoint provides the user the ability to schedule a pickup for their LTL shipments.

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

POST /LTLShip

Request Body

Property	Data Type	Notes
transactionHistoryProcess	enum	ApiPackStation Api
includeTransactionXmls	boolean
freightTerm	enum	Shipper Receiver Consignee ThirdParty

carrier

Property	Data Type	Notes
isProduction	boolean
name	string
carrierServiceCodes	string
carrierServiceNames	string

accountAssignment

Property	Data Type	Notes
accountNumber	string
additionalAccountNumber	string
accessKey	string
userName	string
password	string

shipper

Property	Data Type	Notes
name	string	max length: 100
company	string	max length: 150
attentionTo	string	max length: 150
addressLines	string
city	string	max length: 150
postalCode	string	max length: 15
stateProvinceCode	string	max length: 5
country	string
countryCode	string	max length: 5
phoneNumber	string	max length: 20
residential	boolean
taxId	string
emailAddress	string	max length: 400
county	string	max length: 30

identificationNumbers

Property	Data Type	Notes
vat	string
eori	string

shipFrom

Property	Data Type	Notes
name	string	max length: 100
company	string	max length: 150
attentionTo	string	max length: 150
addressLines	string
city	string	max length: 150
postalCode	string	max length: 15
stateProvinceCode	string	max length: 5
country	string
countryCode	string	max length: 5
phoneNumber	string	max length: 20
residential	boolean
taxId	string
emailAddress	string	max length: 400
county	string	max length: 30

identificationNumbers

Property	Data Type	Notes
vat	string
eori	string

shipTo

Property	Data Type	Notes
name	string	max length: 100
company	string	max length: 150
attentionTo	string	max length: 150
addressLines	string
city	string	max length: 150
postalCode	string	max length: 15
stateProvinceCode	string	max length: 5
country	string
countryCode	string	max length: 5
phoneNumber	string	max length: 20
residential	boolean
taxId	string
emailAddress	string	max length: 400
county	string	max length: 30

identificationNumbers

Property	Data Type	Notes
vat	string
eori	string

shipment

Property	Data Type	Notes
orderNumber	string
freightClass	number	decimal
weight	number	decimal
description	string
estimateId	string
proNumber	string
currencyCode	enum	USD, CAD, AUD, GBP, EUR, DKK, SEK, NOK, CZK, CHF, HUF, PLN, MXN, PHP, SAR, JPY, AFN, ALL, DZD, AOA, XCD, ARS, AMD, AWG, AZN, BSD, BHD, BDT, BBD, BYN, BZD, XOF, BMD, INR, BTN, BOB, BOV, BAM, BWP, BRL, BND, BGN, BIF, CVE, KHR, XAF, KYD, CLP, CLF, CNY, COP, COU, KMF, CDF, NZD, CRC, CUP, CUC, ANG, DJF, DOP, EGP, SVC, ERN, SZL, ETB, FKP, FJD, XPF, GMD, GEL, GHS, GIP, GTQ, GNF, GYD, HTG, HNL, HKD, ISK, IDR, XDR, IRR, IQD, ILS, JMD, JOD, KZT, KES, KPW, KRW, KWD, KGS, LAK, LBP, LSL, ZAR, LRD, LYD, MOP, MKD, MGA, MWK, MYR, MVR, MRU, MUR, XUA, MXV, MDL, MNT, MAD, MZN, MMK, NAD, NPR, NIO, NGN, OMR, PKR, PAB, PGK, PYG, PEN, QAR, RON, RUB, RWF, SHP, WST, STN, RSD, SCR, SLL, SLE, SGD, XSU, SBD, SOS, SSP, LKR, SDG, SRD, CHE, CHW, SYP, TWD, TJS, TZS, THB, TOP, TTD, TND, TRY, TMT, UGX, UAH, AED, USN, UYU, UYI, UYW, UZS, VUV, VES, VED, VND, YER, ZMW, ZWL, XBA, XBB, XBC, XBD, XTS, XXX, XAU, XPD, XPT, XAG
items	string
ltlAccessorials	string	max length: 400

pickupAppointment

Property	Data Type	Notes
startDateTime	string	date-time
endDateTime	string	date-time
closeDateTime	string	date-time

deliveryAppointment

Property	Data Type	Notes
startDateTime	string	date-time
endDateTime	string	date-time
closeDateTime	string	date-time

ltlHazMatDetails

Property	Data Type	Notes
hazMatEmergencyContact	string
hazMatEmergencyPhone	string

containers

Property	Data Type	Notes
weight	number	decimal
freightClass	number	decimal
containerId	string
description	string
height	number	decimal
length	number	decimal
lengthUom	enum	Inch Cm
value	number	decimal
weightUom	enum	Lb Oz Kg
width	number	decimal
ltlHazMatContainerDetails
stackable	boolean

lines

Property	Data Type	Notes
id	string
lineId	string
weight	number	decimal
description	string
freightClass	number	decimal
height	number	decimal
length	number	decimal
lengthUom	enum	Inch Cm
lineNumber	string
quantity	number	decimal
value	number	decimal
weightUom	enum	Lb Oz Kg
width	number	decimal
quantityUom	string

ltlHazMatLineDetail

Property	Data Type	Notes
hazMatClass	string
hazMatDivision	string
hazMatProperShippingName	string
hazMatTechnicalName	string
hazMatId	string
hazMatLabelText	string
hazMatPackingInstructions	string
hazMatRegulationSet	string
hazMatPackingGroup	string
hazMatQuantity	number	decimal
hazMatUom	string
hazMatCargoOnly	boolean
hazMatTransportationMode	string
hazMatTransportCategory	string
hazMatRegulationCode	string

ltlHazMatContainerDetails

Property	Data Type	Notes
hazMatPackagingType	string
hazMatPackagingQuantity	integer	int32
hazMatPackagingUnit	string

items

Property	Data Type	Notes
id	string
lineId	string
weight	number	decimal
description	string
freightClass	number	decimal
height	number	decimal
length	number	decimal
lengthUom	enum	Inch Cm
lineNumber	string
quantity	number	decimal
value	number	decimal
weightUom	enum	Lb Oz Kg
width	number	decimal
quantityUom	string

ltlHazMatLineDetail

Property	Data Type	Notes
hazMatClass	string
hazMatDivision	string
hazMatProperShippingName	string
hazMatTechnicalName	string
hazMatId	string
hazMatLabelText	string
hazMatPackingInstructions	string
hazMatRegulationSet	string
hazMatPackingGroup	string
hazMatQuantity	number	decimal
hazMatUom	string
hazMatCargoOnly	boolean
hazMatTransportationMode	string
hazMatTransportCategory	string
hazMatRegulationCode	string

ltlAccessorials

cod

Property	Data Type	Notes
enabled	boolean
amount	number	decimal

insurance

Property	Data Type	Notes
enabled	boolean
additionalInsuranceAmount	number	decimal
shipmentValue	number	decimal

notificationDeliver

Property	Data Type	Notes
enabled	boolean

appointmentRequiredAtDelivery

Property	Data Type	Notes
enabled	boolean

appointmentRequiredAtPickup

Property	Data Type	Notes
enabled	boolean

hazardousMaterial

Property	Data Type	Notes
enabled	boolean

insideDelivery

Property	Data Type	Notes
enabled	boolean

insidePickup

Property	Data Type	Notes
enabled	boolean

liftGateRequiredAtDelivery

Property	Data Type	Notes
enabled	boolean

liftGateRequiredAtPickup

Property	Data Type	Notes
enabled	boolean

limitedAccessDelivery

Property	Data Type	Notes
enabled	boolean

limitedAccessPickup

Property	Data Type	Notes
enabled	boolean

oversized

Property	Data Type	Notes
enabled	boolean

residentialPickup

Property	Data Type	Notes
enabled	boolean

residentialDelivery

Property	Data Type	Notes
enabled	boolean

securedLimitedAccessDelivery

Property	Data Type	Notes
enabled	boolean

securedLimitedAccessPickup

Property	Data Type	Notes
enabled	boolean

sortAndSegregate

Property	Data Type	Notes
enabled	boolean
pieces	integer	int32

markedOrTagged

Property	Data Type	Notes
enabled	boolean
count	integer	int32

guaranteedRate

Property	Data Type	Notes
enabled	boolean

Response

Property	Data Type	Notes
runTime	integer	int64
transactionId	string

shipResultDto

transactionHistoryInterfaces

Property	Data Type	Notes
carrierRequest	string
carrierResponse	string
sccRequest	string
sccResponse	string
carrierTransactionId	string

shipResult

Property	Data Type	Notes
proNumber	string

additionalInformation

Property	Data Type	Notes
key	string
value	string

Browser not supported