import * as z from "zod/v4-mini"; import { ClosedEnum } from "../../types/enums.js"; import { Result as SafeParseResult } from "../../types/fp.js"; import { SDKValidationError } from "../errors/sdkvalidationerror.js"; import { Alcohol, Alcohol$Outbound } from "./alcohol.js"; import { Billing, Billing$Outbound } from "./billing.js"; import { Cod, Cod$Outbound } from "./cod.js"; import { CustomerReference, CustomerReference$Outbound } from "./customerreference.js"; import { DangerousGoodsObject, DangerousGoodsObject$Outbound } from "./dangerousgoodsobject.js"; import { DepartmentNumber, DepartmentNumber$Outbound } from "./departmentnumber.js"; import { DryIce, DryIce$Outbound } from "./dryice.js"; import { Insurance, Insurance$Outbound } from "./insurance.js"; import { InvoiceNumber, InvoiceNumber$Outbound } from "./invoicenumber.js"; import { PoNumber, PoNumber$Outbound } from "./ponumber.js"; import { RmaNumber, RmaNumber$Outbound } from "./rmanumber.js"; import { ShipmentExtraLasershipAttributesEnum } from "./shipmentextralasershipattributesenum.js"; import { ShipmentExtraReturnServiceTypeLasershipEnum } from "./shipmentextrareturnservicetypelasershipenum.js"; import { ShipmentExtraReturnServiceTypeUPSEnum } from "./shipmentextrareturnservicetypeupsenum.js"; import { UPSReferenceFields, UPSReferenceFields$Outbound } from "./upsreferencefields.js"; /** * Specify an ancillary service endorsement to provide the USPS with instructions on how to handle undeliverable-as-addressed pieces (DHL eCommerce only). */ export declare const AncillaryEndorsement: { readonly ForwardingServiceRequested: "FORWARDING_SERVICE_REQUESTED"; readonly ReturnServiceRequested: "RETURN_SERVICE_REQUESTED"; }; /** * Specify an ancillary service endorsement to provide the USPS with instructions on how to handle undeliverable-as-addressed pieces (DHL eCommerce only). */ export type AncillaryEndorsement = ClosedEnum; /** * Dangerous Goods Code (DHL eCommerce only). See Category Codes */ export declare const DangerousGoodsCode: { readonly One: "01"; readonly Two: "02"; readonly Three: "03"; readonly Four: "04"; readonly Five: "05"; readonly Six: "06"; readonly Seven: "07"; readonly Eight: "08"; readonly Nine: "09"; }; /** * Dangerous Goods Code (DHL eCommerce only). See Category Codes */ export type DangerousGoodsCode = ClosedEnum; /** * Required for DHL Germany Paket Sameday. Designates a desired timeframe for delivery. Format is `HHMMHHMM` */ export declare const PreferredDeliveryTimeframe: { readonly TenMillionOneThousandTwoHundred: "10001200"; readonly TwelveMillionOneThousandFourHundred: "12001400"; readonly FourteenMillionOneThousandSixHundred: "14001600"; readonly SixteenMillionOneThousandEightHundred: "16001800"; readonly EighteenMillionTwoThousand: "18002000"; readonly NineteenMillionTwoThousandOneHundred: "19002100"; }; /** * Required for DHL Germany Paket Sameday. Designates a desired timeframe for delivery. Format is `HHMMHHMM` */ export type PreferredDeliveryTimeframe = ClosedEnum; /** * Request additional return option for return shipments (UPS and Lasership only). */ export type ReturnServiceType = ShipmentExtraReturnServiceTypeUPSEnum | ShipmentExtraReturnServiceTypeLasershipEnum; /** * Request standard or adult signature confirmation. You can alternatively request Certified Mail (USPS only) * * @remarks * or Indirect signature (FedEx only) or Carrier Confirmation (Deutsche Post only). */ export declare const SignatureConfirmation: { readonly Standard: "STANDARD"; readonly Adult: "ADULT"; readonly Certified: "CERTIFIED"; readonly Indirect: "INDIRECT"; readonly CarrierConfirmation: "CARRIER_CONFIRMATION"; }; /** * Request standard or adult signature confirmation. You can alternatively request Certified Mail (USPS only) * * @remarks * or Indirect signature (FedEx only) or Carrier Confirmation (Deutsche Post only). */ export type SignatureConfirmation = ClosedEnum; /** * An object holding optional extra services to be requested. */ export type ShipmentExtra = { accountsReceivableCustomerAccount?: UPSReferenceFields | undefined; /** * Indicates that a shipment contains Alcohol (Fedex and UPS only). */ alcohol?: Alcohol | undefined; /** * Specify an ancillary service endorsement to provide the USPS with instructions on how to handle undeliverable-as-addressed pieces (DHL eCommerce only). */ ancillaryEndorsement?: AncillaryEndorsement | undefined; appropriationNumber?: UPSReferenceFields | undefined; /** * Request `true` to give carrier permission to leave the parcel in a safe place if no one answers the * * @remarks * 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). */ authorityToLeave?: boolean | undefined; billOfLadingNumber?: UPSReferenceFields | undefined; /** * Specify billing details (UPS, FedEx, and DHL Germany only). */ billing?: Billing | undefined; /** * Bypasses address validation (USPS, UPS, & LaserShip only). */ bypassAddressValidation?: boolean | undefined; /** * Request carbon offsets by passing true (UPS only). */ carbonNeutral?: boolean | undefined; /** * Identifies the carrier injection site. */ carrierHubId?: string | undefined; /** * Travel time in hours from fulfillment center to carrier injection site. */ carrierHubTravelTime?: number | undefined; /** * Specify collection on delivery details (UPS only). */ cod?: Cod | undefined; codNumber?: UPSReferenceFields | undefined; /** * Specify container type. */ containerType?: string | undefined; /** * Carrier arrival time to pickup packages from the fulfillment center. * * @remarks * UTC format: `%Y-%m-%dT%H:%M:%SZ` */ criticalPullTime?: string | undefined; /** * Specify customer branch (Lasership only). */ customerBranch?: string | undefined; /** * Specify the reference field on the label (FedEx and UPS only). */ customerReference?: CustomerReference | undefined; /** * Container for specifying the presence of dangerous materials. This is specific to USPS, and if any contents * * @remarks * are provided, only certain USPS service levels will be eligible. For more information, see our * guide on hazardous or dangerous materials shipping. */ dangerousGoods?: DangerousGoodsObject | undefined; /** * Dangerous Goods Code (DHL eCommerce only). See Category Codes */ dangerousGoodsCode?: DangerousGoodsCode | undefined; dealerOrderNumber?: UPSReferenceFields | undefined; /** * Specify delivery instructions. Up to 500 characters. (FedEx and OnTrac only). */ deliveryInstructions?: string | undefined; /** * Specify the department number field on the label (FedEx and UPS only). */ deptNumber?: DepartmentNumber | undefined; /** * Specify that the package contains Dry Ice (FedEx, Veho, and UPS only). */ dryIce?: DryIce | undefined; fdaProductCode?: UPSReferenceFields | undefined; /** * The fulfilment center where the package originates from. */ fulfillmentCenter?: string | undefined; /** * To add 3rd party insurance powered by XCover, * * @remarks * 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. */ insurance?: Insurance | undefined; /** * Specify the invoice number field on the label (FedEx and UPS only). */ invoiceNumber?: InvoiceNumber | undefined; /** * This field specifies if it is a scan-based return shipment. See the Create a return shipment section for more details. */ isReturn?: boolean | undefined; /** * Specify Lasership Attributes (Lasership only). Multiple options accepted. */ lasershipAttrs?: Array | undefined; /** * Declared value (Lasership only). Defaults to `50.00`. */ lasershipDeclaredValue?: string | undefined; manifestNumber?: UPSReferenceFields | undefined; modelNumber?: UPSReferenceFields | undefined; partNumber?: UPSReferenceFields | undefined; /** * Specify the PO number field on the label (FedEx and UPS only). */ poNumber?: PoNumber | undefined; /** * Required for DHL Germany Paket Sameday. Designates a desired timeframe for delivery. Format is `HHMMHHMM` */ preferredDeliveryTimeframe?: PreferredDeliveryTimeframe | undefined; /** * Add premium service to a shipment (DHL Germany international shipments only). */ premium?: boolean | undefined; productionCode?: UPSReferenceFields | undefined; purchaseRequestNumber?: UPSReferenceFields | undefined; /** * Request a QR code for a given transaction when creating a shipping label (USPS domestic and Evri UK only). */ qrCodeRequested?: boolean | undefined; /** * Optional text to be printed on the shipping label if supported by carrier. Up to 50 characters. */ reference1?: string | undefined; /** * 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. */ reference2?: string | undefined; /** * Returns retail rates instead of account-based rates (UPS and FedEx only). */ requestRetailRates?: boolean | undefined; /** * Request additional return option for return shipments (UPS and Lasership only). */ returnServiceType?: ShipmentExtraReturnServiceTypeUPSEnum | ShipmentExtraReturnServiceTypeLasershipEnum | undefined; /** * Specify the RMA number field on the label (FedEx and UPS only). */ rmaNumber?: RmaNumber | undefined; /** * Marks shipment as to be delivered on a Saturday. */ saturdayDelivery?: boolean | undefined; salespersonNumber?: UPSReferenceFields | undefined; serialNumber?: UPSReferenceFields | undefined; /** * Request standard or adult signature confirmation. You can alternatively request Certified Mail (USPS only) * * @remarks * or Indirect signature (FedEx only) or Carrier Confirmation (Deutsche Post only). */ signatureConfirmation?: SignatureConfirmation | undefined; storeNumber?: UPSReferenceFields | undefined; transactionReferenceNumber?: UPSReferenceFields | undefined; /** * UPS only. Request USMCA (United States-Mexico-Canada Agreement) preferential tariff treatment. * * @remarks * When enabled, it includes the USMCA eligibility declaration in customs documentation. * * Supported routes and value limits: * - USA/Canada → Mexico: ≤ $1,000 USD * - Canada/Mexico → USA: ≤ $2,500 USD * - USA/Mexico → Canada: ≤ $3,300 CAD * * Only for declaration-only shipments, full USMCA - FormType 04 (Certificate of Origin) is not supported. */ usmcaEligible?: boolean | undefined; }; /** @internal */ export declare const AncillaryEndorsement$inboundSchema: z.ZodMiniEnum; /** @internal */ export declare const AncillaryEndorsement$outboundSchema: z.ZodMiniEnum; /** @internal */ export declare const DangerousGoodsCode$inboundSchema: z.ZodMiniEnum; /** @internal */ export declare const DangerousGoodsCode$outboundSchema: z.ZodMiniEnum; /** @internal */ export declare const PreferredDeliveryTimeframe$inboundSchema: z.ZodMiniEnum; /** @internal */ export declare const PreferredDeliveryTimeframe$outboundSchema: z.ZodMiniEnum; /** @internal */ export declare const ReturnServiceType$inboundSchema: z.ZodMiniType; /** @internal */ export type ReturnServiceType$Outbound = string | string; /** @internal */ export declare const ReturnServiceType$outboundSchema: z.ZodMiniType; export declare function returnServiceTypeToJSON(returnServiceType: ReturnServiceType): string; export declare function returnServiceTypeFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const SignatureConfirmation$inboundSchema: z.ZodMiniEnum; /** @internal */ export declare const SignatureConfirmation$outboundSchema: z.ZodMiniEnum; /** @internal */ export declare const ShipmentExtra$inboundSchema: z.ZodMiniType; /** @internal */ export type ShipmentExtra$Outbound = { accounts_receivable_customer_account?: UPSReferenceFields$Outbound | undefined; alcohol?: Alcohol$Outbound | undefined; ancillary_endorsement?: string | undefined; appropriation_number?: UPSReferenceFields$Outbound | undefined; authority_to_leave?: boolean | undefined; bill_of_lading_number?: UPSReferenceFields$Outbound | undefined; billing?: Billing$Outbound | undefined; bypass_address_validation?: boolean | undefined; carbon_neutral?: boolean | undefined; carrier_hub_id?: string | undefined; carrier_hub_travel_time?: number | undefined; COD?: Cod$Outbound | undefined; cod_number?: UPSReferenceFields$Outbound | undefined; container_type?: string | undefined; critical_pull_time?: string | undefined; customer_branch?: string | undefined; customer_reference?: CustomerReference$Outbound | undefined; dangerous_goods?: DangerousGoodsObject$Outbound | undefined; dangerous_goods_code?: string | undefined; dealer_order_number?: UPSReferenceFields$Outbound | undefined; delivery_instructions?: string | undefined; dept_number?: DepartmentNumber$Outbound | undefined; dry_ice?: DryIce$Outbound | undefined; fda_product_code?: UPSReferenceFields$Outbound | undefined; fulfillment_center?: string | undefined; insurance?: Insurance$Outbound | undefined; invoice_number?: InvoiceNumber$Outbound | undefined; is_return?: boolean | undefined; lasership_attrs?: Array | undefined; lasership_declared_value?: string | undefined; manifest_number?: UPSReferenceFields$Outbound | undefined; model_number?: UPSReferenceFields$Outbound | undefined; part_number?: UPSReferenceFields$Outbound | undefined; po_number?: PoNumber$Outbound | undefined; preferred_delivery_timeframe?: string | undefined; premium?: boolean | undefined; production_code?: UPSReferenceFields$Outbound | undefined; purchase_request_number?: UPSReferenceFields$Outbound | undefined; qr_code_requested?: boolean | undefined; reference_1?: string | undefined; reference_2?: string | undefined; request_retail_rates?: boolean | undefined; return_service_type?: string | string | undefined; rma_number?: RmaNumber$Outbound | undefined; saturday_delivery?: boolean | undefined; salesperson_number?: UPSReferenceFields$Outbound | undefined; serial_number?: UPSReferenceFields$Outbound | undefined; signature_confirmation?: string | undefined; store_number?: UPSReferenceFields$Outbound | undefined; transaction_reference_number?: UPSReferenceFields$Outbound | undefined; usmca_eligible?: boolean | undefined; }; /** @internal */ export declare const ShipmentExtra$outboundSchema: z.ZodMiniType; export declare function shipmentExtraToJSON(shipmentExtra: ShipmentExtra): string; export declare function shipmentExtraFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=shipmentextra.d.ts.map