NameDescriptionTypeAdditional information
UpdateCustomerShippingAccount

Request that the customer's shipping account be updated

boolean

Default value is False

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

None.

UpdateShipToAttention

Request that the ship to attention be updated

boolean

Default value is False

ShipToAttention

The person who the shipment is shipped to.

string

None.

UpdateShipToAddress

Should the ship to address be updated

boolean

Default value is False

ShipToAddress

The address to ship to. (All fields will be updated)

Address

None.

ShipToAddressValidated

Has the address been successfully validated.

boolean

None.

UpdateShipToPhone

Should the ship to phone number be updated

boolean

Default value is False

ShipToPhone

The phone number of the recipient of the shipment.

string

None.

UpdateShipToEmail

Should the ship to email be updated

boolean

Default value is False

ShipToEmail

Email address of the recipient of the shipment.

string

None.

UpdateTaxCode

Should the Tax code for the shipment be updated

boolean

Default value is False

TaxCode

Indicates the sales tax code for the shipment based upon the destination.

string

None.

UpdateShipFromAddress

Should the ship from address be updated

boolean

Default value is False

ShipFromAddress

The address to ship from. (All fields will be updated)

Address

None.

PackageUpdateRequests

Represents requested updates to one or more packages on the shipment

Collection of OrderShipmentPackageUpdateRequest

None.

UpdateShipmentNotifications

Should the email notifications be updated.

boolean

Default value is False

ShipmentNotifications

The new list of notifications to update the shipment with. (All items will be updated/replaced).

Collection of ShipmentEmailNotification

None.

UpdateSignatureRequired

Should the signature required be updated

boolean

Default value is False

SignatureRequired

The new Signature Required value.

boolean

Default value is False

UpdateSaturdayDelivery

Should the signature required be updated

boolean

Default value is False

SaturdayDelivery

The new Signature Required value.

boolean

Default value is False

UpdateShipmentReadyDateTime

Should the shipment ready datetime be updated.

boolean

Default value is False

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

Default value is null

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

UpdateCustomLabelData

Should the Custom label data be updated.

boolean

Default value is False

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