| Name | Description | Type | Additional information |
|---|---|---|---|
| QuoteId |
Quote Id to be used for shipment. Id is provided in RateResponse |
string |
None. |
| RateId |
Id of a rate to be used for shipment. Id provided in RateResponse. |
string |
None. |
| ShippingNotes |
Optional. Free-text shipping notes. Trimmed; maximum 1000 characters (validated on the trimmed value). |
string |
None. |
| NonStackable |
Optional. Defaults to false. When true, applies non-stackable to all items on this shipment (OR'd with each item's own NonStackable). Omitting or false leaves item-level behavior unchanged. |
boolean |
None. |
| ShipDate |
Ship date in UTC |
date |
None. |
| ShipperAddress |
Shipper address |
ShipmentAddress |
None. |
| ReturnAddress |
Return Address |
Address |
None. |
| IncludeReturnLabel |
Include parcel return label |
boolean |
None. |
| ConsigneeAddress |
Consignee address |
ConsigneeAddressDto |
None. |
| SoldToAddress |
Sold to address. Optional — TaxIDNumber and address fields when provided. |
Address |
None. |
| Reference1 |
Reference 1 |
string |
None. |
| Reference2 |
Referece 2 |
string |
None. |
| Reference3 |
Referece 3 |
string |
None. |
| Reference4 |
Referece 4 |
string |
None. |
| Reference5 |
Referece 5 |
string |
None. |
| Reference6 |
Referece 6 |
string |
None. |
| ProductDetails |
Product details |
Collection of ProductDetail |
None. |
| ITN |
International transaction number |
string |
None. |
| PickupDetails |
Pickup details |
PickupDetails |
None. |
| AdditionalDetails |
Additional details |
AdditionalDetailsV4 |
None. |
| ZPLLabel |
Options 4x6ForAllThatApply, FedEx4x4.675 or UPS4x8 |
ZPLLabel |
Optional
|
| ShippingNotificationEmail |
Shipment confirmation email |
string |
Optional
|
| UsePro |
If populated, then this is going to be used as a PRO. |
string |
Optional
|
| PrinterUser |
Optional. Username of the user whose printer preferences should be used for printing. Must be a valid user in the same company. |
string |
Optional
|