com.ibm.commerce.inventory.commands

Interface ReleaseShipConfirmCmd

  • All Superinterfaces:
    AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ControllerCommand, ECCommand, Protectable, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, ToolsControllerCommand
    All Known Implementing Classes:
    ReleaseShipConfirmCmdImpl


    public interface ReleaseShipConfirmCmd
    extends ToolsControllerCommand
    Records carrier and shipment tracking information when the order release is packed and shipped. If the updateManifestStatus flag is set to "1", the UpdateReleaseManifestStatusCmd task command will be called to update order status and fulfillment status after shipment tracking information is recorded.

    Parameters

    EC_XMLObject
    An input xml_string that contains all required data for recording carrier and shipment tracking information.

    Example xml_string for recording carrier and shipment tracking information:

     
     <?xml version="1.0" encoding="UTF-8"?>
     <XML>
     <XMLFile>inventory.PackageDetail</XMLFile>
     <dateShipped>2001-10-30 00:00:00.0</dateShipped>
     <ordersId>100</ordersId>
     <ordReleaseNum>1</ordReleaseNum>
     <packageId>Package 123</packageId>
     <pickupRecordId>Record 456</pickupRecordId> 
     <setCCurr>CAD</setCCurr>
     <shipModeId>100</shipModeId>
     <shippingCosts>120.5</shippingCosts>
     <trackingId>track 789</trackingId>
     <updateManifestStatus>0</updateManifestStatus>
     <weight>28</weight> 
     <weightMeasure>KGM</weightMeasure>
     <product SKU="00000001">
     <component Quantity="1" SKU="00000001-1">
     <serialNumber>00000001-1-00000001</serialNumber>
     </component>
     </product>
     </XML>
    
     
    URL
    The URL to be called when the command completes successfully.

    Response Parameters

    manifestId
    Return the identifier of the manifest updated.
    manifestFound
    Return the manifest found status flag.

    Exceptions

    When the required fields are missing or not in the right data type, this command will throw exception to indicate which field is missing or bad.

    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        The internal copyright field.
        See Also:
        Constant Field Values
      • NAME

        static final java.lang.String NAME
        The name of this interface is "com.ibm.commerce.inventory.commands.ReleaseShipConfirmCmd".
        See Also:
        Constant Field Values
      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The default implementation class name is "com.ibm.commerce.inventory.commands.ReleaseShipConfirmCmdImpl".
        See Also:
        Constant Field Values
    • Method Detail

      • setDateShipped

        void setDateShipped(java.lang.String newDateShipped)
        Sets the date the package shipped.
        Parameters:
        newDateShipped - shipped date
      • setLastupdate

        void setLastupdate(java.lang.String newLastupdate)
        Sets the timestamp of last update.
        Parameters:
        newLastupdate - time
      • setManifestId

        void setManifestId(java.lang.String newManifestId)
        Sets the manifest (package) identifier.
        Parameters:
        newManifestId - package id
      • setManifestStatus

        void setManifestStatus(java.lang.String newManifestStatus)
        Sets the status of the manifest (package).
        Parameters:
        newManifestStatus - status
      • setOrdersId

        void setOrdersId(java.lang.String newOrdersId)
        Sets the order identifier.
        Parameters:
        newOrdersId - order id
      • setOrdReleaseNum

        void setOrdReleaseNum(java.lang.String newOrdReleaseNum)
        Sets the order release number.
        Parameters:
        newOrdReleaseNum - release number
      • setPackageId

        void setPackageId(java.lang.String newPackageId)
        Sets the package identifier.
        Parameters:
        newPackageId - package id
      • setPickupRecordId

        void setPickupRecordId(java.lang.String newPickupRecordId)
        Sets the pickup record identifier.
        Parameters:
        newPickupRecordId - pickup record id
      • setSetCCurr

        void setSetCCurr(java.lang.String newSetCCurr)
        Sets the currency in which the shipment was charged.
        Parameters:
        newSetCCurr - currency
      • setShipModeId

        void setShipModeId(java.lang.String newShipModeId)
        Sets the shipping provider.
        Parameters:
        newShipModeId - shipping provider
      • setShippingCosts

        void setShippingCosts(java.lang.String newShippingCosts)
        Sets the shipping costs.
        Parameters:
        newShippingCosts - shipping costs
      • setTrackingId

        void setTrackingId(java.lang.String newTrackingId)
        Sets the tracking identifier.
        Parameters:
        newTrackingId - tracking id
      • setUpdateManifestStatus

        void setUpdateManifestStatus(java.lang.String newUpdateManifestStatus)
        Sets the flag to indicate if the order and fulfillment status should be updated after the carrier and shipment tracking information is recorded.
        Parameters:
        newUpdateManifestStatus - status flag
      • setWeight

        void setWeight(java.lang.String newWeight)
        Sets the weight of the package.
        Parameters:
        newWeight - package weight
      • setWeightMeasure

        void setWeightMeasure(java.lang.String newWeightMeasure)
        Sets the unit of measure of the package weight.
        Parameters:
        newWeightMeasure - weight measure