| Name | Description | Type | Additional information |
|---|---|---|---|
| auth | string |
None. |
|
| ShipmentGUID | string |
None. |
|
| OfficeID | integer |
Required |
|
| State | string |
Required Max length: 2 |
|
| Status | integer |
Required |
|
| ShipperName | string |
Required Max length: 50 |
|
| ShipperPhone | string |
Max length: 25 |
|
| ShipperFax | string |
Max length: 25 |
|
| ShipperEmail | string |
Max length: 100 |
|
| OrderByName | string |
Required Max length: 50 |
|
| OrderByPhone | string |
Max length: 25 |
|
| OrderByFax | string |
Max length: 25 |
|
| OrderByEmail | string |
Max length: 100 |
|
| TotalDistance | integer |
None. |
|
| TotalDistanceUOM | string |
Required Max length: 2 |
|
| DeliveryGUID | string |
Required Max length: 36 |
|
| PickupGUID | string |
Required Max length: 36 |
|
| PickupNumber | integer |
None. |
|
| ServiceID | integer |
Required |
|
| Pieces | integer |
Required |
|
| Weight | decimal number |
None. |
|
| DimWeight | decimal number |
None. |
|
| WeightUOM | string |
Max length: 2 |
|
| CustomerID | integer |
Required |
|
| BillToAttention | string |
Max length: 50 |
|
| BillToType | string |
Required Max length: 1 |
|
| PodSignature | string |
Max length: 50 |
|
| 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 |
|
| MonitoredByUserID | 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 |
|
| PuTimezoneID | string |
Required Max length: 10 |
|
| PuPhoneNumber | string |
Max length: 25 |
|
| PuAfterHoursNumber | string |
Max length: 25 |
|
| PuFaxNumber | 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 |
None. |
|
| PuActualPickupArrival | date |
None. |
|
| PuActualPickupDepart | date |
None. |
|
| PuWaitingTime | integer |
None. |
|
| PuAttemptCount | integer |
None. |
|
| DropAirportID | string |
Max length: 3 |
|
| PuInstructions | string |
Max length: 500 |
|
| PuDistance | integer |
Required |
|
| PuDistanceUOM | string |
Required Max length: 2 |
|
| PuCourierID | 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 |
|
| DelTimezoneID | string |
Required Max length: 10 |
|
| DelPhoneNumber | string |
Max length: 25 |
|
| DelAfterHoursNumber | string |
Max length: 25 |
|
| DelFaxNumber | 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. |
|
| DelActualDeliveryArrival | date |
None. |
|
| DelActualDeliveryDepart | date |
None. |
|
| DelDeliverWhen | string |
Required Max length: 1 |
|
| DelConsigneeOnly | boolean |
Required |
|
| DelWaitingTime | integer |
None. |
|
| DelAttemptCount | integer |
None. |
|
| RecoverAirportID | string |
Max length: 3 |
|
| DelInstructions | string |
Max length: 500 |
|
| DelRouteCode | string |
Max length: 3 |
|
| DelDistance | integer |
Required |
|
| DelDistanceUOM | string |
Required Max length: 2 |
|
| DelCourierID | integer |
None. |
|
| ConsigneeCustomerID | integer |
None. |
|
| ThirdPartyCustomerID | integer |
None. |
|
| FuelSurchargePercent | decimal number |
None. |
|
| SecuritySurchargePercent | decimal number |
None. |
|
| CurrencySurchargePercent | decimal number |
None. |
|
| TaxPercent | decimal number |
None. |
|
| TaxCode | string |
Max length: 25 |
|
| DiscountPercent | decimal number |
None. |
|
| QualityControlID | integer |
None. |
|
| DeliveredDuty | string |
Max length: 3 |
|
| CarrierID | integer |
None. |
|
| CarrierServiceID | integer |
None. |
|
| CarrierAccountID | integer |
None. |
|
| CarrierWaybillNumber | string |
Max length: 20 |
|
| CarrierDropDateTimeUTC | date |
None. |
|
| Length | integer |
None. |
|
| Width | integer |
None. |
|
| Height | integer |
None. |
|
| SizeUOM | string |
Required Max length: 2 |
|
| CallbackRequired | boolean |
Required |
|
| CallbackSpokeWith | string |
Max length: 50 |
|
| PuResidential | boolean |
Required |
|
| DelResidential | boolean |
Required |
|
| DelOkLeave | boolean |
Required |
|
| ReferenceTypeID1 | integer |
None. |
|
| ReferenceTypeID2 | integer |
None. |
|
| ReferenceTypeID3 | integer |
None. |
|
| ReferenceTypeID4 | integer |
None. |
|
| ReferenceTypeID5 | integer |
None. |
|
| ReferenceTypeID6 | integer |
None. |
|
| ReferenceTypeID7 | integer |
None. |
|
| ReferenceTypeID8 | integer |
None. |
|
| ReferenceValue1 | string |
Max length: 100 |
|
| ReferenceValue2 | string |
Max length: 100 |
|
| ReferenceValue3 | string |
Max length: 100 |
|
| ReferenceValue4 | string |
Max length: 100 |
|
| ReferenceValue5 | string |
Max length: 100 |
|
| ReferenceValue6 | string |
Max length: 100 |
|
| ReferenceValue7 | string |
Max length: 100 |
|
| ReferenceValue8 | string |
Max length: 100 |
|
| DelHoldForPickup | boolean |
Required |
|
| 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 |
|
| LockCostPickup | boolean |
Required |
|
| LockCostDelivery | boolean |
Required |
|
| LockCostShipment | boolean |
Required |
|
| ShipmentNumber | integer |
Required |
|
| LockCharge | boolean |
Required |
|
| WorkflowID | string |
Required Max length: 10 |
|
| CustomsValue | decimal number |
None. |
|
| InsuranceValue | decimal number |
None. |
|
| 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: 10 |
|
| WarehouseReference | string |
Max length: 20 |
|
| IsNoShow | boolean |
Required |
|
| HSCode | string |
Max length: 15 |
|
| KsmsAddressID | integer |
None. |
|
| PuDropOff | boolean |
Required |
|
| AesITN | string |
Max length: 15 |
|
| 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 |
|
| AesStatus | string |
Max length: 10 |
|
| AesEIN | string |
Max length: 10 |
|
| CustomsExceptionGUID | string |
Max length: 36 |
|
| CustomsBrokerGUID | string |
Max length: 36 |
|
| CustomsReleaseRequired | boolean |
Required |
|
| CustomsSchedRelease | date |
None. |
|
| CustomsActualRelease | date |
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 |
|
| ConseeFaxNumber | string |
Max length: 25 |
|
| ConseeEmailAddress | string |
Max length: 100 |
|
| CountryOfOrigin | string |
Max length: 2 |
|
| IsDangerousGoods | boolean |
Required |
|
| DgUNNumber | string |
Max length: 10 |
|
| DgCommodityClass | string |
Max length: 10 |
|
| DgDryIceWeight | decimal number |
None. |
|
| DgTransportationIndex | string |
Max length: 10 |
|
| DgTransportationLimit | string |
Max length: 1 |
|
| DgIsRadioactive | boolean |
Required |
|
| DgPackingGroup | string |
Max length: 300 |
|
| DgQuantityAndPackType | string |
Max length: 300 |
|
| DgPackingInst | string |
Max length: 100 |
|
| DgAuthorization | string |
Max length: 40 |
|
| DgHandlingInfo | string |
Max length: 500 |
|
| DgEmergencyPhone | string |
Max length: 25 |
|
| DgSignatory | string |
Max length: 80 |
|
| DgProperName | string |
Max length: 100 |
|
| DgDate | date |
None. |
|
| OrderSource | string |
Required Max length: 1 |
|
| CustomsInboundStatus | string |
Max length: 3 |
|
| CustomsOutboundStatus | string |
Max length: 3 |
|
| MarginPercent | decimal number |
None. |
|
| IsBonded | boolean |
Required |
|
| BondCloseDateTime | date |
None. |
|
| BondCloseByWhom | string |
Max length: 30 |
|
| CustomsEntryDate | date |
None. |
|
| CustomsPortOfEntry | string |
Max length: 3 |
|
| CustomsPortOfExport | string |
Max length: 3 |
|
| DataChecked | boolean |
Required |
|
| PuHoldOvernight | boolean |
Required |
|
| DelHoldOvernight | boolean |
Required |
|
| PuBonded | boolean |
Required |
|
| DelBonded | boolean |
Required |
|
| ECCN | string |
Max length: 5 |
|
| DutyFreeText | string |
Max length: 30 |
|
| BillingHold | boolean |
Required |
|
| CustomsPreAlertSent | boolean |
Required |
|
| DocsUpdated | boolean |
Required |
|
| PuMawbIdentifier | string |
Max length: 30 |
|
| DelMawbIdentifier | string |
Max length: 30 |
|
| PuAeoNumber | string |
Max length: 30 |
|
| DelAeoNumber | string |
Max length: 30 |
|
| SplitShipment | boolean |
Required |
|
| CustomsExportRef | string |
None. |
|
| CustomsExportRefType | string |
None. |