Interface CreateShipment

Type declaration

• LabelSpecification: { CharacterSet?: "dan" | "nld" | "fin" | "fra" | "deu" | "itl" | "nor" | "pol" | "por" | "spa" | "swe" | "ces" | "hun" | "slk" | "rus" | "tur" | "ron" | "bul" | "est" | "ell" | "lav" | "lit" | "eng"; HTTPUserAgent?: undefined | string; Instruction?: any; LabelImageFormat: { Code: "EPL" | "SPL" | "ZPL" | "GIF" | "STARPL"; Description?: undefined | string }; LabelStockSize?: any }

  • Optional CharacterSet?: "dan" | "nld" | "fin" | "fra" | "deu" | "itl" | "nor" | "pol" | "por" | "spa" | "swe" | "ces" | "hun" | "slk" | "rus" | "tur" | "ron" | "bul" | "est" | "ell" | "lav" | "lit" | "eng"

    Language character set expected on label. Valid values:

    • dan = Danish (Latin-1)
    • nld = Dutch (Latin-1)
    • fin = Finnish (Latin-1)
    • fra = French (Latin1)
    • deu = German (Latin-1)
    • itl = Italian (Latin-1)
    • nor = Norwegian (Latin1)
    • pol = Polish (Latin-2)
    • por = Portuguese (Latin-1)
    • spa = Spanish (Latin-1)
    • swe = Swedish (Latin-1)
    • ces = Czech (Latin-2)
    • hun = Hungarian (Latin-2)
    • slk = Slovak (Latin-2)
    • rus = Russian (Cyrillic)
    • tur = Turkish (Latin-5)
    • ron = Romanian (Latin-2)
    • bul = Bulgarian (Latin-2)
    • est = Estonian (Latin-2)
    • ell = Greek (Latin-2)
    • lav = Latvian (Latin-2)
    • lit = Lithuanian (Latin-2)
    • eng = English (Latin-1)

    Default is English (Latin-1).

  • Optional HTTPUserAgent?: undefined | string

    Browser HTTPUserAgent String.

    This is the preferred way of identifying GIF image type to be generated. Required if {“ShipmentRequest”: {LabelSpecificationLabelSpecification/LabelImageFormat/Code = Gif.

    Default to Mozilla/4.5 if this field is missing or has invalid value.

  • Optional Instruction?: any

  • LabelImageFormat: { Code: "EPL" | "SPL" | "ZPL" | "GIF" | "STARPL"; Description?: undefined | string }

    • Code: "EPL" | "SPL" | "ZPL" | "GIF" | "STARPL"

      Label print method code determines the format in which Labels are to be generated. For EPL2 formatted Labels use EPL, for SPL formatted Labels use SPL, for ZPL formatted Labels use ZPL and for image formats use GIF, for Star Printer format formatted Labels use STARPL.

      For shipments without return service the valid value is GIF, ZPL, EPL and SPL. For shipments with PRL return service, the valid values are EPL, ZPL, SPL, STARPL and GIF. For Mail Innovations forward shipments STARPL is not supported.

    • Optional Description?: undefined | string

      Description of the label image format code.

  • Optional LabelStockSize?: any

• Shipment: { CostCenter?: undefined | string; CostCenterBarcodeIndicator?: undefined | string; DGSignatoryInfo?: any; Description?: undefined | string; DocumentsOnlyIndicator?: undefined | string; FreightShipmentInformation?: any; InvoiceLineTotal?: any; IrregularIndicator?: "1" | "2" | "3"; ItemizedChargesRequestedIndicator: string; Locale?: undefined | string; MIDualReturnShipmentIndicator?: undefined | string; MIDualReturnShipmentKey?: undefined | string; MILabelCN22Indicator?: undefined | string; MasterCartonID?: undefined | string; MasterCartonIndicator?: undefined | string; Package: Array<{ AdditionalHandlingIndicator?: undefined | string; Commodity?: any; Description?: undefined | string; DimWeight?: undefined | { UnitOfMeasurement: UnitOfMeasurement<"LBS" | "KGS">; Weight: string }; Dimensions?: undefined | { Height: string; Length: string; UnitOfMeasurement: UnitOfMeasurement<"IN" | "CM" | "00" | "01">; Width: string }; LargePackageIndicator?: undefined | string; NumOfPieces?: undefined | string; PackageServiceOptions?: any; PackageWeight?: undefined | { UnitOfMeasurement: UnitOfMeasurement<"LBS" | "KGS" | "OZS">; Weight: string }; Packaging: { Code: "01" | "02" | "03" | "04" | "21" | "24" | "25" | "30" | "2a" | "2b" | "2c" | "56" | "57" | "58" | "59" | "60" | "61" | "62" | "63" | "64" | "65" | "66" | "67"; Description?: undefined | string }; PalletDescription?: undefined | string; ReferenceNumber?: any; UnitPrice?: undefined | string }>; PackageID?: undefined | string; PackageIDBarcodeIndicator?: undefined | string; PaymentInformation?: undefined | { ShipmentCharge: { BillReceiver?: any; BillShipper?: any; BillThirdParty?: any; Type: "01" | "02" | "03" }; SplitDutyVATIndicator?: any }; PromotionalDiscountInformation?: any; RatingMethodRequestedIndicator?: undefined | string; ReferenceNumber?: undefined | { BarCodeIndicator?: undefined | string; Code?: undefined | string; Value: string }; ReturnService?: undefined | { Code: "2" | "3" | "5" | "8" | "9" | "10" | "11" | "12" | "13" | "14" | "15" | "16" | "17" | "18" | "19" | "20" }; Service: { Code: "01" | "02" | "03" | "07" | "08" | "11" | "12" | "13" | "14" | "17" | "54" | "59" | "65" | "M2" | "M3" | "M4" | "M5" | "M6" | "M7" | "70" | "71" | "72" | "74" | "82" | "83" | "84" | "85" | "86" | "96"; Description?: undefined | string }; ShipFrom: ShippingInfo & { CompanyDisplayableName?: undefined | string; EMailAddress?: undefined | string; Phone: PhoneNumber; ShipperNumber?: undefined | string; TaxIDType?: undefined | { Code: string }; TaxIdentificationNumber?: undefined | string }; ShipTo: ShippingInfo; ShipmentIndicationType?: any; ShipmentRatingOptions?: any; ShipmentServiceOptions?: any; Shipper: Object.Optional<ShippingInfo, "Name"> & { CompanyDisplayableName?: undefined | string; EMailAddress?: undefined | string; ShipperNumber?: undefined | string; TaxIdentificationNumber?: undefined | string }; SubClassification?: "IR" | "MA"; TaxInformationIndicator: string; USPSEndorsement?: "1" | "2" | "3" | "4" }

  • Optional CostCenter?: undefined | string

    Customer assigned identifier for report and billing summarization displays to the right of the Cost Center title.

    Required for Mail Innovations Return shipments. It is shown on the bottom of the shipping label as reference 2.

    Cost Center length is alphanumeric with a max length of 30 for Mail Innovations forward shipments.

    Cost Center length is numeric with a max length of 4 for Mail Innovations Return shipments.

  • Optional CostCenterBarcodeIndicator?: undefined | string

    Presence/Absence indicator. Presence of this indicator means that the customer is requesting for the CostCenter field to be barcoded at the bottom of the label.

  • Optional DGSignatoryInfo?: any

  • Optional Description?: undefined | string

    The Description of Goods for the shipment. Applies to international and domestic shipments. Provide a detailed description of items being shipped for documents and non-documents.

    Examples: "annual reports" and "9 mm steel screws".

    Required if all of the listed conditions are true:

    • ShipFrom and ShipTo countries or territories are not the same;
    • The packaging type is not UPS Letter;
    • The ShipFrom and or ShipTo countries or territories are not in the European Union or the ShipFrom and ShipTo countries or territories are both in the European Union and the shipments service type is not UPS Standard.

  • Optional DocumentsOnlyIndicator?: undefined | string

    Indicates a shipment contains written, typed, or printed communication of no commercial value. If DocumentsOnly is not specified then it implies that the shipment contains non documents or documents of commercial value.

    Default is a shipment contains non- documents or documents of commercial value. This is an empty tag, any value inside is ignored. Valid only for shipments with different origin and destination country or territory. The origin country or territory is not US

  • Optional FreightShipmentInformation?: any

  • Optional InvoiceLineTotal?: any

  • Optional IrregularIndicator?: "1" | "2" | "3"

    Mail classification defined by the USPS.

    Valid values:

    1 = Balloon

    2 = Oversize

    3 = Not Applicable

  • ItemizedChargesRequestedIndicator: string

  • Optional Locale?: undefined | string

  • Optional MIDualReturnShipmentIndicator?: undefined | string

  • Optional MIDualReturnShipmentKey?: undefined | string

  • Optional MILabelCN22Indicator?: undefined | string

    Indicates single label with both MI label and CN22 form. International CN22 form is required.

  • Optional MasterCartonID?: undefined | string

  • Optional MasterCartonIndicator?: undefined | string

  • Package: Array<{ AdditionalHandlingIndicator?: undefined | string; Commodity?: any; Description?: undefined | string; DimWeight?: undefined | { UnitOfMeasurement: UnitOfMeasurement<"LBS" | "KGS">; Weight: string }; Dimensions?: undefined | { Height: string; Length: string; UnitOfMeasurement: UnitOfMeasurement<"IN" | "CM" | "00" | "01">; Width: string }; LargePackageIndicator?: undefined | string; NumOfPieces?: undefined | string; PackageServiceOptions?: any; PackageWeight?: undefined | { UnitOfMeasurement: UnitOfMeasurement<"LBS" | "KGS" | "OZS">; Weight: string }; Packaging: { Code: "01" | "02" | "03" | "04" | "21" | "24" | "25" | "30" | "2a" | "2b" | "2c" | "56" | "57" | "58" | "59" | "60" | "61" | "62" | "63" | "64" | "65" | "66" | "67"; Description?: undefined | string }; PalletDescription?: undefined | string; ReferenceNumber?: any; UnitPrice?: undefined | string }>

    For Return Shipments up to and including 20 packages are allowed. US/PR origin return movements are limited to only one package. For Mail Innovations shipments only one package is allowed.

  • Optional PackageID?: undefined | string

    Customer-assigned unique piece identifier that returns visibility events.

    Required only for Mail Innovations forward shipments. Alpha numeric values only. It is shown on the bottom of the shipping label as reference 1.

  • Optional PackageIDBarcodeIndicator?: undefined | string

  • Optional PaymentInformation?: undefined | { ShipmentCharge: { BillReceiver?: any; BillShipper?: any; BillThirdParty?: any; Type: "01" | "02" | "03" }; SplitDutyVATIndicator?: any }

    Payment information container for detailed shipment charges. The two shipment charges that are available for specification are Transportation charges and Duties and Taxes. It is required for non-Ground Freight Pricing shipments only.

  • Optional PromotionalDiscountInformation?: any

  • Optional RatingMethodRequestedIndicator?: undefined | string

  • Optional ReferenceNumber?: undefined | { BarCodeIndicator?: undefined | string; Code?: undefined | string; Value: string }

    Reference Number information container.

  • Optional ReturnService?: undefined | { Code: "2" | "3" | "5" | "8" | "9" | "10" | "11" | "12" | "13" | "14" | "15" | "16" | "17" | "18" | "19" | "20" }

    Type of Return service. When this container exists, the shipment is a return shipment.

  • Service: { Code: "01" | "02" | "03" | "07" | "08" | "11" | "12" | "13" | "14" | "17" | "54" | "59" | "65" | "M2" | "M3" | "M4" | "M5" | "M6" | "M7" | "70" | "71" | "72" | "74" | "82" | "83" | "84" | "85" | "86" | "96"; Description?: undefined | string }

    • Code: "01" | "02" | "03" | "07" | "08" | "11" | "12" | "13" | "14" | "17" | "54" | "59" | "65" | "M2" | "M3" | "M4" | "M5" | "M6" | "M7" | "70" | "71" | "72" | "74" | "82" | "83" | "84" | "85" | "86" | "96"

      Valid values:

      01 = Next Day Air

      02 = 2nd Day Air

      03 = Ground

      07 = Express

      08 = Expedited

      11 = UPS Standard

      12 = 3 Day Select

      13 = Next Day Air Saver

      14 = UPS Next Day Air® Early

      17 = UPS Worldwide Economy DDU

      54 = Express Plus

      59 = 2nd Day Air A.M.

      65 = UPS Saver

      M2 = First Class Mail

      M3 = Priority Mail

      M4 = Expedited MaiI Innovations

      M5 = Priority Mail Innovations

      M6 = Economy Mail Innovations

      M7 = MaiI Innovations (MI) Returns 70 = UPS Access Point™ Economy

      71 = UPS Worldwide Express Freight Midday

      72 = UPS Worldwide Economy

      74 = UPS Express®12:00

      82 = UPS Today Standard

      83 = UPS Today Dedicated Courier

      84 = UPS Today Intercity

      85 = UPS Today Express

      86 = UPS Today Express Saver

      96 = UPS Worldwide Express Freight.

      Note: Only service code 03 is used for Ground Freight Pricing shipments

    • Optional Description?: undefined | string

      Description of the service code. Examples are Next Day Air, Worldwide Express, and Ground.

  • ShipFrom: ShippingInfo & { CompanyDisplayableName?: undefined | string; EMailAddress?: undefined | string; Phone: PhoneNumber; ShipperNumber?: undefined | string; TaxIDType?: undefined | { Code: string }; TaxIdentificationNumber?: undefined | string }

  • ShipTo: ShippingInfo

  • Optional ShipmentIndicationType?: any

  • Optional ShipmentRatingOptions?: any

  • Optional ShipmentServiceOptions?: any

  • Shipper: Object.Optional<ShippingInfo, "Name"> & { CompanyDisplayableName?: undefined | string; EMailAddress?: undefined | string; ShipperNumber?: undefined | string; TaxIdentificationNumber?: undefined | string }

  • Optional SubClassification?: "IR" | "MA"

    Valid values: IR = Irregular MA = Machineable SubClass is only required if the customer’s contract have them subclass the package not UPS.

  • TaxInformationIndicator: string

  • Optional USPSEndorsement?: "1" | "2" | "3" | "4"

    USPS endorsement is a Special handling for UPS SurePost shipments delivered by the USPS. Valid values:

    1 = Return Service Requested

    2 = Forwarding Service Requested

    3 = Address Service Requested

    4 = Change Service Requested

    If user does not select a value, UPS system will pass ""Carrier – Leave if No Response”. Note: For International Mail Innovations shipments use No Service Selected. International Mail Innovations shipments are applicable for Priority Mail Innovations and Mail Innovations Economy Mail Innovations services only. Required for Mail Innovations forward and return shipments.