| Name | Description | Type | Additional information |
|---|---|---|---|
| LogonName |
The user name which matches the user name in MxTMS |
string |
Required Max length: 50 |
| CompanyID |
Company ID always 15693 for MNX |
integer |
Required |
| TrackingNumber |
The tracking number for shipment |
string |
Max length: 20 |
| AccountNumber |
The customer account number |
string |
Required Max length: 15 |
| ShipperName |
The name of person shipping the package |
string |
Required Max length: 50 |
| ShipperPhone |
The shippers phone number |
string |
Max length: 25 |
| ShipperEmail |
The shippers email address |
string |
Max length: 100 |
| PickupAddressID |
The system assigned pickup address identifier |
integer |
None. |
| PickupAddressCode |
The user assigned address identifier |
string |
None. |
| PickupCompanyName |
The pickup company name |
string |
Required Max length: 50 |
| PickupAddress1 |
The first line of the address |
string |
Max length: 50 |
| PickupAddress2 |
The second line of the address |
string |
Max length: 50 |
| PickupAddress3 |
The third line of the address |
string |
Max length: 50 |
| PickupCityName |
The city name at pickup |
string |
Required Max length: 50 |
| PickupStateProvID |
The state/province ID at pickup |
string |
Max length: 3 |
| PickupPostalCode |
The postal code at pickup |
string |
Max length: 10 |
| PickupCountryID |
The country identifier at pickup |
string |
Required Max length: 2 |
| PickupAirportID |
The airport at pickup |
string |
Required Max length: 3 |
| PickupPersonToSee |
The person to see at the pickup location |
string |
Max length: 50 |
| PickupPhoneNumber |
The phone number at pickup |
string |
Max length: 25 |
| PickupEmailAddress |
The email address at pickup |
string |
Max length: 100 |
| PickupInstructions |
The instructions at pickup |
string |
Max length: 500 |
| DeliveryAddressID |
The system assigned address identifier |
integer |
None. |
| DeliveryAddressCode |
The user assigned address identifier |
string |
None. |
| DeliveryCompanyName |
The company name at delivery |
string |
Required |
| DeliveryAddress1 |
Address line at delivery |
string |
None. |
| DeliveryAddress2 |
Address line at delivery |
string |
None. |
| DeliveryAddress3 |
Address line at delivery |
string |
None. |
| DeliveryCityName |
City name at delivery |
string |
Required |
| DeliveryStateProvID |
State/Province at delivery |
string |
None. |
| DeliveryPostalCode |
Postal code at delivery |
string |
None. |
| DeliveryCountryID |
Country ID at delivery |
string |
Required |
| DeliveryAirportID |
Airport code at delivery |
string |
Required |
| DeliveryAttention |
Attention name at delivery |
string |
None. |
| DeliveryPhoneNumber |
Phone number at delivery |
string |
None. |
| DeliveryEmailAddress |
Email address at delivery |
string |
None. |
| DeliveryInstructions |
Instructions at delivery |
string |
None. |
| ServiceCode |
Service code from MxTMS for this shipment |
string |
Required |
| Pieces |
Number of pieces |
integer |
Required |
| Weight |
Total weight of all pieces on shipment |
decimal number |
None. |
| WeightUOM |
Weight unit of measure (LB,KG) |
string |
Required |
| Length |
Length of each piece on shipment |
integer |
None. |
| Width |
Width of each piece on shipment |
integer |
None. |
| Height |
Height of each piece on shipment |
integer |
None. |
| SizeUOM |
Size unit of measure (IN,CM) |
string |
Required |
| Contents |
Contents of shipment |
string |
None. |
| DeclaredValue |
Declared value of shipment |
decimal number |
None. |
| DeclaredValueCurrencyID |
Currency of declared value (ie. USD) |
string |
None. |
| Reference |
Primary reference value on shipment |
string |
None. |
| OtherReference1 |
Other reference value on shipment |
string |
None. |
| OtherReference2 |
Other reference value on shipment |
string |
None. |
| OtherReference3 |
Other reference value on shipment |
string |
None. |
| OtherReference4 |
Other reference value on shipment |
string |
None. |
| OtherReference5 |
Other reference value on shipment |
string |
None. |
| OtherReference6 |
Other reference value on shipment |
string |
None. |
| OtherReference7 |
Other reference value on shipment |
string |
None. |
| OtherReference8 |
Other reference value on shipment |
string |
None. |
| OtherReference9 |
Other reference value on shipment |
string |
None. |
| OtherReferenceTypeCode1 |
Other reference type code on shipment |
string |
None. |
| OtherReferenceTypeCode2 |
Other reference type code on shipment |
string |
None. |
| OtherReferenceTypeCode3 |
Other reference type code on shipment |
string |
None. |
| OtherReferenceTypeCode4 |
Other reference type code on shipment |
string |
None. |
| OtherReferenceTypeCode5 |
Other reference type code on shipment |
string |
None. |
| OtherReferenceTypeCode6 |
Other reference type code on shipment |
string |
None. |
| OtherReferenceTypeCode7 |
Other reference type code on shipment |
string |
None. |
| OtherReferenceTypeCode8 |
Other reference type code on shipment |
string |
None. |
| OtherReferenceTypeCode9 |
Other reference type code on shipment |
string |
None. |
| WarehouseReference |
Internal warehouse reference value |
string |
None. |
| ReadyDateTime |
Date/time when shipment will be ready |
date |
Required |
| SchedPickupDateTime |
Quoted pickup date/time when shipment will be picked-up |
date |
None. |
| SchedDeliveryDateTime |
Quote delivery date/time when shipment will be delivered |
date |
None. |
| DropOff |
true=shipment will be dropped off (no pickup) |
boolean |
None. |
| HoldForPickup |
true=shipment will be held for pickup (no delivery) |
boolean |
None. |
| CarrierKey |
Carrier identifier that shipment will be transported |
string |
None. |
| CarrierService |
Carriers service used to transport shipment |
string |
None. |
| Notes |
Notes regarding shipment |
Collection of string |
None. |
| Documents |
Documents attached to this shipment |
Collection of Document |
None. |