Interface CreateShipment

Type declaration

• Response: { Alert: DefaultInfoFormatGeneric; ResponseStatus: DefaultInfoFormatGeneric; TransactionReference: { CustomerContext: string } }

  • Alert: DefaultInfoFormatGeneric

  • ResponseStatus: DefaultInfoFormatGeneric

  • TransactionReference: { CustomerContext: string }

    • CustomerContext: string

      The CustomerContext Information which will be echoed during response.

• ShipmentResults: { BillableWeightCalculationMethod?: "01" | "02"; BillingWeight?: any; CODTurnInPage?: any; ControlLogReceipt?: any; DGPaperImage?: undefined | string; Disclaimer: DefaultInfoFormatGeneric; FRSShipmentData?: any; Form?: any; HighValueReport?: any; LabelURL?: undefined | string; LocalLanguageLabelURL?: undefined | string; MIDualReturnShipmentKey?: undefined | string; MasterCartonID?: undefined | string; NegotiatedRateCharges?: any; PackageResults: any; RatingMethod?: "01" | "02"; ShipmentCharges?: any; ShipmentDigest?: undefined | string; ShipmentIdentificationNumber: string }

  • Optional BillableWeightCalculationMethod?: "01" | "02"

    BillableWeightCalculationMethod is to indicate whether the billable weight calculation method utilized was - the package level or shipment level. This information will be returned only if RatingMethodRequestedIndicator is present in the request.

    Valid values: 01 = Shipment Billable Weight

    02 = Package Billable Weight

  • Optional BillingWeight?: any

  • Optional CODTurnInPage?: any

  • Optional ControlLogReceipt?: any

  • Optional DGPaperImage?: undefined | string

  • Disclaimer: DefaultInfoFormatGeneric

    Disclaimer would be used to provide more information to shipper regarding the processed shipment. This would be used to notify shipper about possible taxes and duties that might have been added or might apply to the shipment.

    This field would be returned only if TaxInformationIndicator is present in a request.

  • Optional FRSShipmentData?: any

  • Optional Form?: any

  • Optional HighValueReport?: any

  • Optional LabelURL?: undefined | string

    URL will point to a page wherein label, receipt and other documents, if applicable, such as HighValueReport, CustomsInvoice and ImportControl instructions can be requested. LabelURL is returned only if the LabelLinksIndicator is requested for following shipments:

    • Print/Electronic ImportControl shipment
    • Print/Electronic Return shipment.
    • Forward shipment except for Mail Innovations Forward.

  • Optional LocalLanguageLabelURL?: undefined | string

  • Optional MIDualReturnShipmentKey?: undefined | string

  • Optional MasterCartonID?: undefined | string

  • Optional NegotiatedRateCharges?: any

  • PackageResults: any

  • Optional RatingMethod?: "01" | "02"

    RatingMethod is to indicate whether the Shipment was rated as shipment level or package level. This information will be returned only if RatingMethodRequestedIndicator is present in the request.

    Valid values:

    01 = Shipment level

    02 = Package level

  • Optional ShipmentCharges?: any

  • Optional ShipmentDigest?: undefined | string

  • ShipmentIdentificationNumber: string

    Returned UPS shipment ID number.1Z Number of the first package in the shipment.