| Name | Description | Type | Additional information |
|---|---|---|---|
| ShippingMethod |
How is the shipment to be rate shopped. |
ShippingMethod |
Required Range: inclusive between 96 and 99 |
| OverrideShippingProfileId |
Desired alternate shipping profile id. Null will use default profile. |
integer |
Minimum value: 1 |
| CompanyId |
Represents the Id of the company the shipment is for. |
integer |
Required Minimum value: 1 |
| PricingSheetId |
Represents the Id of the pricing sheet of the company the shipment is for. |
integer |
Minimum value: 1 |
| ShopLocationId |
Represents the Id of the ABC Shop Location to ship from. The location must be an AbcShop, FM, or VFM. |
integer |
Minimum value: 1 |
| ShipFromAddress |
The address from which to ship if the ShopLocationId is not specified |
Address |
None. |
| ShipFromCompany |
The company from which to ship if the ShopLocationId is not specified |
string |
String length: inclusive between 0 and 100 |
| ShipFromPhoneNumber |
The phone number of the company to ship from if the ShopLocationId is not specified |
string |
Must be an acceptably formed phone number String length: inclusive between 1 and 32 |
| RateForReturnLabel |
Get rates as if for a return shipment from the ShipFromAddress to the ShipToAddress. |
boolean |
None. |
| Packages |
Represents the packages belonging to this shipment. |
Collection of ShipmentRateShopPackage |
Minimum Count: 1 |
| ShippingServiceCode |
Indicates the specific shipping service for the shipping method. |
string |
Required String length: inclusive between 1 and 50 |
| ShipToCompany |
The company the shipment is being shipped to. |
string |
String length: inclusive between 0 and 100 |
| ShipToAttention |
The person who the shipment is shipped to. |
string |
Required String length: inclusive between 1 and 100 |
| ShipToAddress |
The address to ship to. This address will override ShipToLocationId and ShipToAddressBookEntryId. |
Address |
None. |
| ShipToPhoneNumber |
The phone number of the recipient of the shipment. |
string |
Required String length: inclusive between 1 and 32 |
| ShipToLocationId |
Indentifying Id for the customer's location to ship to. |
integer |
Minimum value: 1 |
| ShipToAddressBookEntryId |
Indentifying Id for the customer's address book entry to ship to. This will override ShipToLocationId. |
integer |
Minimum value: 1 |
| ShipToIsResidential |
Indicates of the shipment is going to a residential address. |
boolean |
None. |
| SaturdayDelivery |
Is Saturday Delivery requested for the shipment. |
boolean |
Default value is False |
| SignatureRequired |
Is a signature required for the shipment. |
boolean |
Default value is False |