ShipmentShipper
Container for the Shipper's information.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| name | str | ✅ | Shippers company name. For forward Shipment 35 characters are accepted, but only 30 characters will be printed on the label. |
| shipper_number | str | ✅ | Shipper's six digit alphanumeric account number. Must be associated with the UserId specified in the AccessRequest XML. The account must be a valid UPS account number that is active. For US, PR and CA accounts, the account must be either a daily pickup account, an occasional account, or a customer B.I.N account. Drop Shipper accounts are valid for return service shipments only if the account is Trade Direct (TD) enabled. All other accounts must be either a daily pickup account or an occasional account. |
| address | ShipperAddress | ✅ | Address tag Container. The package should be returned to this address if the package is undeliverable. This address appears on the upper left hand corner of the label. Note: If the ShipFrom container is not present then this address will be used as the ShipFrom address. If this address is used as the ShipFrom the shipment will be rated from this origin address. |
| attention_name | str | ❌ | Shippers Attention Name. For forward Shipment 35 characters are accepted, but only 30 characters will be printed on the label. Required if destination is international. Required if Invoice and CO International forms are requested and the ShipFrom address is not present. |
| company_displayable_name | str | ❌ | Shipper's CompanyDisplayableName. The CompanyDisplayableName will be displayed in tracking results and notification messages in place of the name associated with the shipper account. The original shipper account name will be displayed for all Return Services and Import Control Shipments. This is available for Shipper accounts enabled by UPS and applies to Forward Shipments. |
| tax_identification_number | str | ❌ | Shipper's Tax Identification Number. Conditionally required if EEI form (International forms) is requested and ship From is not mentioned. |
| phone | ShipperPhone | ❌ | Container tag for Phone Number. |
| fax_number | str | ❌ | Shipper's Fax Number. |
| e_mail_address | str | ❌ | Shipper's email address. Must be associated with the UserId specified in the AccessRequest XML. |
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs