Help Page Home

Order

Name	Type	Additional information
ShipmentGUID	string	Max length: 36
ShipmentNumber	integer	None.
CompanyID	integer	Required
OfficeID	integer	Required
State	string	Required Max length: 2
Status	integer	Required
StatusName	string	None.
StatusFullName	string	None.
ShipperName	string	Required Max length: 50
ShipperPhone	string	Max length: 25
ShipperEmail	string	Max length: 100
ShipperAtPickup	boolean	Required
ShipperCompanyName	string	Max length: 50
ShipperAddress1	string	Max length: 50
ShipperAddress2	string	Max length: 50
ShipperAddress3	string	Max length: 50
ShipperCityName	string	Max length: 50
ShipperStateProvID	string	Max length: 3
ShipperPostalCode	string	Max length: 10
ShipperCountryID	string	Max length: 2
OrderByName	string	Max length: 50
OrderByPhone	string	Max length: 25
OrderByEmail	string	Max length: 100
TotalDistance	integer	None.
TotalDistanceUOM	string	Required Max length: 2
ServiceID	integer	Required
ServiceCode	string	Max length: 15
ServiceName	string	Max length: 40
WorkflowID	string	Required Max length: 10
Pieces	integer	Required Range: inclusive between 1 and 9999
Weight	decimal number	None.
DimWeight	decimal number	None.
WeightUOM	string	None.
Length	integer	None.
Width	integer	None.
Height	integer	None.
SizeUOM	string	Required Max length: 2
BillToType	string	Required Max length: 1
BillToAttention	string	Max length: 50
CustomerID	integer	Required
AccountNumber	string	Max length: 20
CustomerName	string	None.
ConsigneeCustomerID	integer	None.
ConsigneeAccountNumber	string	Max length: 20
ConsigneeAccountName	string	None.
ThirdPartyCustomerID	integer	None.
ThirdPartyAccountNumber	string	Max length: 20
ThirdPartyAccountName	string	None.
Contents	string	Max length: 100
Reference	string	Max length: 50
TrackingNumber	string	Max length: 20
DeclaredValue	decimal number	None.
DeclaredValueCurrencyID	string	Required Max length: 3
AcknowledgedDateTime	date	None.
AcknowledgedUserID	integer	None.
AcknowledgedUserName	string	None.
MonitoredByUserID	integer	None.
MonitoredByUserName	string	None.
InsertUserID	integer	None.
InsertUserName	string	None.
InsertDateTime	date	None.
FuelSurchargePercent	decimal number	None.
SecuritySurchargePercent	decimal number	None.
CurrencySurchargePercent	decimal number	None.
TaxCode	string	None.
TaxPercent	decimal number	None.
DiscountPercent	decimal number	None.
QualityControlID	integer	None.
QualityControlName	string	None.
DeliveredDuty	string	None.
CarrierID	integer	None.
CarrierServiceID	integer	None.
CarrierAccountID	integer	None.
CarrierWaybillNumber	string	None.
CarrierDropDateTimeUTC	date	None.
CallbackRequired	boolean	None.
CallbackSpokeWith	string	None.
CallbackDateTime	date	None.
CallbackUserID	integer	None.
TSANameOnID	string	Max length: 50
TSATypeOfID	string	Max length: 50
TSAVerifierName	string	Max length: 50
InspectedByUserGUID	string	Max length: 36
ScreeningMethod	string	Max length: 3
ScreeningResult	string	Max length: 3
OutsideCCSFTSANumber	string	Max length: 30
PickupGUID	string	Max length: 36
PickupNumber	integer	None.
PuDispatchOfficeID	integer	None.
PuAddressID	integer	None.
PuAddressCode	string	Max length: 15
PuCompanyName	string	Required Max length: 50
PuAddress1	string	Max length: 50
PuAddress2	string	Max length: 50
PuAddress3	string	Max length: 50
PuCityName	string	Required Max length: 50
PuStateProvID	string	Max length: 3
PuPostalCode	string	Max length: 10
PuCountryID	string	Required Max length: 2
PuCountryName	string	None.
PuTimezoneID	string	Required Max length: 10
PuPhoneNumber	string	Max length: 25
PuAfterHoursNumber	string	Max length: 25
PuEmailAddress	string	Max length: 100
PuPersonToSee	string	Max length: 50
PuReadyDateTime	date	Required
PuCloseDateTime	date	None.
PuSchedPickupDateTime	date	Required
PuUpdatedPickupDateTime	date	Required
PuActualPickupDateTime	date	None.
PuWaitingTime	integer	None.
PuAttemptCount	integer	None.
DropAirportID	string	Required Max length: 3
PuDistance	integer	Required
PuDistanceUOM	string	Required Max length: 2
PuInstructions	string	Max length: 500
PuResidential	boolean	Required
PuDropOff	boolean	Required
PuHoldOvernight	boolean	Required
PuBonded	boolean	Required
PuMawbIdentifier	string	Max length: 30
PuAeoNumber	string	Max length: 30
PuCourierID	integer	None.
PuCourierServiceID	integer	None.
PuCourierNameAndPhone	string	None.
PuAlertStatus	integer	Required
PuAlertHow	string	Max length: 3
PuAlertVia	string	Max length: 100
PuAlertUserID	integer	None.
PuSpokeWith	string	Max length: 50
PuSentDateTime	date	None.
PuAcceptedDateTime	date	None.
PuActualWaitingTime	integer	None.
PuActualAttemptCount	integer	None.
PuActualDistance	integer	Required
PuActualDistanceUOM	string	Max length: 2
PuActualWeight	decimal number	None.
PuActualWeightUOM	string	Required Max length: 2
DeliveryGUID	string	Max length: 36
DeliveryNumber	integer	None.
DelDispatchOfficeID	integer	None.
DelAddressID	integer	None.
DelAddressCode	string	Max length: 15
DelCompanyName	string	Required Max length: 50
DelAddress1	string	Max length: 50
DelAddress2	string	Max length: 50
DelAddress3	string	Max length: 50
DelCityName	string	Required Max length: 50
DelStateProvID	string	Max length: 3
DelPostalCode	string	Max length: 10
DelCountryID	string	Required Max length: 2
DelCountryName	string	None.
DelTimezoneID	string	Required Max length: 10
DelPhoneNumber	string	Max length: 25
DelAfterHoursNumber	string	Max length: 25
DelEmailAddress	string	Max length: 100
DelAttention	string	Max length: 50
DelRequestedDeliveryDateTime	date	None.
DelSchedDeliveryDateTime	date	None.
DelUpdatedDeliveryDateTime	date	None.
DelLatestDeliveryDateTime	date	None.
DelActualDeliveryDateTime	date	None.
DelDeliverWhen	string	Required Max length: 1
DelConsigneeOnly	boolean	Required
DelOkLeave	boolean	Required
DelResidential	boolean	Required
DelWaitingTime	integer	None.
DelAttemptCount	integer	None.
DelDistance	integer	Required
DelDistanceUOM	string	Required Max length: 2
DelHoldForPickup	boolean	Required
RecoverAirportID	string	Max length: 3
DelInstructions	string	Max length: 500
DelHoldOvernight	boolean	Required
DelBonded	boolean	Required
DelMawbIdentifier	string	Max length: 30
DelAeoNumber	string	Max length: 30
DelCourierID	integer	None.
DelCourierServiceID	integer	None.
DelCourierNameAndPhone	string	None.
DelAlertStatus	integer	Required
DelAlertHow	string	Max length: 3
DelAlertVia	string	Max length: 100
DelAlertUserID	integer	None.
DelSpokeWith	string	Max length: 50
DelSentDateTime	date	None.
DelAcceptedDateTime	date	None.
DelActualWaitingTime	integer	None.
DelActualAttemptCount	integer	None.
DelActualDistance	integer	Required
DelActualDistanceUOM	string	Max length: 2
DelActualWeight	decimal number	None.
DelActualWeightUOM	string	Required Max length: 2
LockCostPickup	boolean	Required
LockCostDelivery	boolean	Required
LockCostShipment	boolean	Required
OrderInstructions	string	None.
ConsigneeOrderInstructions	string	None.
ShipmentLastUpdateDateTime	date	None.
PickupLastUpdateDateTime	date	None.
DeliveryLastUpdateDateTime	date	None.
NotifyShipperOrderAck	boolean	Required
NotifyShipperOrderRouted	boolean	Required
NotifyShipperDispatched	boolean	Required
NotifyShipperPickedUp	boolean	Required
NotifyShipperDepToAp	boolean	Required
NotifyShipperObcCheckin	boolean	Required
NotifyShipperDropped	boolean	Required
NotifyShipperConfirmed	boolean	Required
NotifyShipperDeparted	boolean	Required
NotifyShipperArrived	boolean	Required
NotifyShipperRecovered	boolean	Required
NotifyShipperDelivered	boolean	Required
NotifyShipperOrigQdt	boolean	Required
NotifyShipperChangeQdt	boolean	Required
NotifyShipperOutForDelivery	boolean	Required
NotifyShipperRelease	boolean	Required
NotifyConseeOrderAck	boolean	Required
NotifyConseeOrderRouted	boolean	Required
NotifyConseeDispatched	boolean	Required
NotifyConseePickedUp	boolean	Required
NotifyConseeDepToAp	boolean	Required
NotifyConseeObcCheckin	boolean	Required
NotifyConseeDropped	boolean	Required
NotifyConseeConfirmed	boolean	Required
NotifyConseeDeparted	boolean	Required
NotifyConseeArrived	boolean	Required
NotifyConseeRecovered	boolean	Required
NotifyConseeDelivered	boolean	Required
NotifyConseeOrigQdt	boolean	Required
NotifyConseeChangeQdt	boolean	Required
NotifyConseeOutForDelivery	boolean	Required
NotifyConseeRelease	boolean	Required
NotifyOtherEmail	string	Max length: 200
NotifyOtherOrderAck	boolean	Required
NotifyOtherOrderRouted	boolean	Required
NotifyOtherDispatched	boolean	Required
NotifyOtherPickedUp	boolean	Required
NotifyOtherDepToAp	boolean	Required
NotifyOtherObcCheckin	boolean	Required
NotifyOtherDropped	boolean	Required
NotifyOtherDeparted	boolean	Required
NotifyOtherConfirmed	boolean	Required
NotifyOtherArrived	boolean	Required
NotifyOtherRecovered	boolean	Required
NotifyOtherOutForDelivery	boolean	Required
NotifyOtherDelivered	boolean	Required
NotifyOtherOrigQdt	boolean	Required
NotifyOtherChangeQdt	boolean	Required
NotifyOtherRelease	boolean	Required
AccountStatus	string	None.
HoldNote	string	None.
LockCharge	boolean	Required
WarehouseReference	string	Max length: 20
IsNoShow	boolean	Required
HSCode	string	Max length: 15
AesITN	string	Max length: 15
AesStatus	string	Max length: 10
AesEIN	string	Max length: 10
SysDocPuMawb	boolean	Required
SysDocPuHawb	boolean	Required
SysDocPuCert	boolean	Required
SysDocPuManifest	boolean	Required
SysDocPuTsa	boolean	Required
SysDocPuSse	boolean	Required
SysDocDelMawb	boolean	Required
SysDocDelHawb	boolean	Required
SysDocDelCert	boolean	Required
SysDocDelManifest	boolean	Required
SysDocDelLongHawb	boolean	Required
CustomsExceptionGUID	string	None.
CustomsExceptionName	string	None.
CustomsBrokerGUID	string	None.
CustomsBrokerName	string	None.
CustomsReleaseRequired	boolean	Required
CustomsSchedRelease	date	None.
CustomsSchedReleaseUTC	date	None.
CustomsActualRelease	date	None.
CustomsActualReleaseUTC	date	None.
CustomsInboundStatus	string	None.
CustomsOutboundStatus	string	None.
CheckInDateTime	date	None.
ConseeType	string	Required Max length: 1
ConseeName	string	Max length: 50
ConseeAddress1	string	Max length: 50
ConseeAddress2	string	Max length: 50
ConseeAddress3	string	Max length: 50
ConseeCityName	string	Max length: 50
ConseeStateProvID	string	Max length: 3
ConseePostalCode	string	Max length: 10
ConseeCountryID	string	Max length: 2
ConseePhoneNumber	string	Max length: 25
ConseeEmailAddress	string	Max length: 100
CountryOfOrigin	string	Max length: 2
IsDangerousGoods	boolean	Required
DgUNNumber	string	None.
DgCommodityClass	string	None.
DgDryIceWeight	decimal number	None.
DgTransportationIndex	string	None.
DgTransportationLimit	string	None.
DgIsRadioactive	boolean	None.
DgPackingGroup	string	None.
DgQuantityAndPackType	string	None.
DgPackingInst	string	None.
DgAuthorization	string	None.
DgHandlingInfo	string	None.
DgEmergencyPhone	string	None.
DgSignatory	string	None.
DgProperName	string	None.
DgDate	date	None.
OrderSource	string	Required Max length: 1
IsBonded	boolean	Required
BondCloseDateTime	date	None.
BondCloseByWhom	string	Max length: 30
PostingDate	date	None.
CustomsPortOfEntry	string	Max length: 3
CustomsEntryDate	date	None.
CustomsPortOfExport	string	None.
DataChecked	boolean	Required
ShipperVerified	boolean	Required
ConseeVerified	boolean	Required
ThirdPartyVerified	boolean	Required
ECCN	string	Max length: 5
DutyFreeText	string	Max length: 30
BillingHold	boolean	Required
CustomsPreAlertSent	boolean	Required
DocsUpdated	boolean	Required
AdvocateUserName	string	None.
SplitShipment	boolean	Required
KsmsAddressID	integer	None.
KsmsIacShipperID	string	None.
KsmsStatus	string	None.
KsmsStatusIcon	string	None.
KsmsStatus_Customer	string	None.
KsmsStatus_Pickup	string	None.
CustomsExportRef	string	None.
CustomsExportRefType	string	None.