ShippingLabelRequestV4

Request for creating a shipping label

Name Type Description Additional information
Carrier string

Desired shipping carrier

ServiceType string

Desired Shipping carrier service type

UniqueRequestId string

Unique transaction ID for the shipping label.

Required

Max length: 36

IntegratorClientID string

Optional. An identifier for the client of the integrator. This will be provided by Visible if needed.

CustomText1 string

Custom text to show on the label

CustomText2 string

Custom text to show on the label

PreferredFormat LabelTypeV4

Preferred format for the shipping label

PreferredSize ShipLabelSizeV4

Ship label size

PreferredDPI LabelDPIV4

Label DPI to print

ShipDate date

Shipping date for the label being created. Cannot be in the past.

Required

ToAddress AddressV4

Ship To Address

Required

FromAddress AddressV4

Ship From Address

Required

ReturnAddress AddressV4

Return address if different from the ship address.

Packages Collection of PackageRequestV4

Packages for the shipment

Required

CustomsInfo CustomsInfoRequestV4

Customs Request

ProductReference string

Product Reference