Skip to content

Latest commit

 

History

History
59 lines (55 loc) · 80.8 KB

shipmentextra.md

File metadata and controls

59 lines (55 loc) · 80.8 KB

ShipmentExtra

An object holding optional extra services to be requested.

Fields

Field Type Required Description
accounts_receivable_customer_account Optional[components.UPSReferenceFields] ➖ N/A
alcohol Optional[components.Alcohol] ➖ Indicates that a shipment contains Alcohol (Fedex and UPS only).
ancillary_endorsement Optional[components.AncillaryEndorsement] ➖ Specify an ancillary service endorsement to provide the USPS with instructions on how to handle undeliverable-as-addressed pieces (DHL eCommerce only).
appropriation_number Optional[components.UPSReferenceFields] ➖ N/A
authority_to_leave Optional[bool] ➖ Request true to give carrier permission to leave the parcel in a safe place if no one answers the
door (where supported). When set to false, if no one is available to receive the item, the parcel
will not be left (*surcharges may be applicable).
bill_of_lading_number Optional[components.UPSReferenceFields] ➖ N/A
billing Optional[components.Billing] ➖ Specify billing details (UPS, FedEx, and DHL Germany only).
bypass_address_validation Optional[bool] ➖ Bypasses address validation (USPS, UPS, & LaserShip only).
carbon_neutral Optional[bool] ➖ Request carbon offsets by passing true (UPS only).
carrier_hub_id Optional[str] ➖ Identifies the carrier injection site.
carrier_hub_travel_time Optional[int] ➖ Travel time in hours from fulfillment center to carrier injection site.
cod Optional[components.Cod] ➖ Specify collection on delivery details (UPS only).
cod_number Optional[components.UPSReferenceFields] ➖ N/A
container_type Optional[str] ➖ Specify container type.
critical_pull_time Optional[str] ➖ Carrier arrival time to pickup packages from the fulfillment center.
UTC format: %Y-%m-%dT%H:%M:%SZ
customer_branch Optional[str] ➖ Specify customer branch (Lasership only).
customer_reference Optional[components.CustomerReference] ➖ Specify the reference field on the label (FedEx and UPS only).
dangerous_goods Optional[components.DangerousGoodsObject] ➖ Container for specifying the presence of dangerous materials. This is specific to USPS, and if any contents
are provided, only certain USPS service levels will be eligible. For more information, see our
guide on hazardous or dangerous materials shipping.
dangerous_goods_code Optional[components.DangerousGoodsCode] ➖ Dangerous Goods Code (DHL eCommerce only). See Category Codes
dealer_order_number Optional[components.UPSReferenceFields] ➖ N/A
delivery_instructions Optional[str] ➖ Specify delivery instructions. Up to 500 characters. (FedEx and OnTrac only).
dept_number Optional[components.DepartmentNumber] ➖ Specify the department number field on the label (FedEx and UPS only).
dry_ice Optional[components.DryIce] ➖ Specify that the package contains Dry Ice (FedEx, Veho, and UPS only).
fda_product_code Optional[components.UPSReferenceFields] ➖ N/A
fulfillment_center Optional[str] ➖ The fulfilment center where the package originates from.
insurance Optional[components.Insurance] ➖ To add 3rd party insurance powered by XCover,
specify
amount, content, and currency.
Alternatively, you can choose carrier provided insurance
by additionally specifying provider (UPS, FedEx and OnTrac only).

If you do not want to add insurance
to your shipment, do not set these parameters.
invoice_number Optional[components.InvoiceNumber] ➖ Specify the invoice number field on the label (FedEx and UPS only).
is_return Optional[bool] ➖ This field specifies if it is a scan-based return shipment. See the Create a return shipment section for more details.
lasership_attrs List[components.ShipmentExtraLasershipAttributesEnum] ➖ Specify Lasership Attributes (Lasership only). Multiple options accepted.
lasership_declared_value Optional[str] ➖ Declared value (Lasership only). Defaults to 50.00.
manifest_number Optional[components.UPSReferenceFields] ➖ N/A
model_number Optional[components.UPSReferenceFields] ➖ N/A
part_number Optional[components.UPSReferenceFields] ➖ N/A
po_number Optional[components.PoNumber] ➖ Specify the PO number field on the label (FedEx and UPS only).
preferred_delivery_timeframe Optional[components.PreferredDeliveryTimeframe] ➖ Required for DHL Germany Paket Sameday. Designates a desired timeframe for delivery. Format is HHMMHHMM
premium Optional[bool] ➖ Add premium service to a shipment (DHL Germany international shipments only).
production_code Optional[components.UPSReferenceFields] ➖ N/A
purchase_request_number Optional[components.UPSReferenceFields] ➖ N/A
qr_code_requested Optional[bool] ➖ Request a QR code for a given transaction when creating a shipping label (USPS domestic and Evri UK only).
reference_1 Optional[str] ➖ Optional text to be printed on the shipping label if supported by carrier. Up to 50 characters.
reference_2 Optional[str] ➖ Optional text to be printed on the shipping label if supported by carrier. Up to 50 characters. For DHL eCommerce, this field can be used for billing reference.
request_retail_rates Optional[bool] ➖ Returns retail rates instead of account-based rates (UPS and FedEx only).
return_service_type Optional[components.ReturnServiceType] ➖ Request additional return option for return shipments (UPS and Lasership only).
rma_number Optional[components.RmaNumber] ➖ Specify the RMA number field on the label (FedEx and UPS only).
saturday_delivery Optional[bool] ➖ Marks shipment as to be delivered on a Saturday.
salesperson_number Optional[components.UPSReferenceFields] ➖ N/A
serial_number Optional[components.UPSReferenceFields] ➖ N/A
signature_confirmation Optional[components.SignatureConfirmation] ➖ Request standard or adult signature confirmation. You can alternatively request Certified Mail (USPS only)
or Indirect signature (FedEx only) or Carrier Confirmation (Deutsche Post only).
store_number Optional[components.UPSReferenceFields] ➖ N/A
transaction_reference_number Optional[components.UPSReferenceFields] ➖ N/A