| Name | Description | Type | Additional information |
|---|---|---|---|
| ShippingMethod |
How is the shipment to be shipped |
ShippingMethod |
Required Range: inclusive between 1 and 8 |
| DescriptionOverride |
Description text to override the default text when shipping charges are consolidated. |
string |
String length: inclusive between 0 and 200 |
| TaxCode |
Indicates the sales tax code for the shipment based upon the destination. |
string |
Required String length: inclusive between 1 and 30 |
| ShipToEmail |
Email address of the recipient of the shipment. |
string |
String length: inclusive between 0 and 100 |
| ShipToAddressValidated |
Has the address been successfully validated. |
boolean |
None. |
| ShipFromAddressOverride |
Override the ship from address. |
Address |
None. |
| ShipFromPhoneNumberOverride |
Override the phone number of the sender. |
string |
String length: inclusive between 1 and 32 |
| ShipFromEmailOverride |
Override the email of the sender. |
string |
String length: inclusive between 0 and 100 |
| ShipFromCompanyOverride |
Company name or shipper name when overriding the ship from address. |
string |
String length: inclusive between 0 and 100 |
| UseCustomerAccountForShipping |
When shipping, should the customer's account be charged. |
boolean |
None. |
| CustomerShippingAccountCode |
When charging the customer's account, code associated with the account to charge. |
string |
String length: inclusive between 0 and 10 |
| Packages |
Represents the packages belonging to this shipment. |
Collection of OrderCreationRequestShipmentPackage |
Minimum Count: 1 |
| Notifications |
Notifications to register for the shipment |
Collection of ShipmentEmailNotification |
None. |
| ShipmentReadyDateTimeLocal |
If the shipper is to pick up the package, when will the shipment be ready. Time is local to the ship from location. |
date |
None. |
| CustomerCloseTimeLocal |
If the shipper is to pick up the package, what is the latest time the shipment will be accessible. Time is local to the ship from location. Defaults to 6:00 PM if not specified. |
date |
Default value is null |
| CustomLabelDataHeader |
An identifying header for custom label data. Defaults to "Note" when CustomLabelDataValue is specified; |
string |
String length: inclusive between 0 and 4 |
| CustomLabelDataValue |
Custom label data to be printed on the label. |
string |
String length: inclusive between 0 and 25 |
| 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 |