com.ibm.commerce.inventory.commands

Interface PickBatchGenerateCmd

  • 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:
    PickBatchGenerateCmdImpl


    public interface PickBatchGenerateCmd
    extends ToolsControllerCommand
    Generates a pick batch for specified fulfillment center and store.

    This controller command will call GeneratePickBatchCmd to generate a pick batch. The order releases with 'SHIP' status for the specified fulfillment center and store will be included in the pick batch generation. If there are more than the maximum number of order releases, which are eligible, when a pick batch is generated. Only the maximum number of order releases are picked up in this pick batch. And the rest will be picked up by the next pick batch generation. A pack slip XML will be generated for each eligible order release and a pick ticket XML will be generated for the whole batch. An invoice XML may also be generated for each eligible order release.

    This command requires to have the store id and language id set in the command context.

    If you run this command from the scheduler, run it at a store-level command. Do not run it as a site-level command.

    URL calling syntax

    https://host_name/path/PickBatchGenerate?ffmcenterId=ffmcenterId_value&URL=return_url

    Parameters

    ffmcenterId
    The identifier of the fulfillment center this pick batch is generated on.
    URL
    The URL to be called when the command completes successfully.

    Response Parameters

    moreOrderReleases
    Return the flag to indicate if there are still more eligible order releases not included in this pick batch.
    pickbatchId
    Return the identifier of the new pick batch.

    Exceptions

    When the required fields are missing or not in the right datatype, 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.PickBatchGenerateCmd".
        See Also:
        Constant Field Values
      • defaultCommandClassName

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

      • setFfmcenterId

        void setFfmcenterId(java.lang.String newFfmcenterId)
        Sets fulfillment center identifier.
        Parameters:
        newFfmcenterId - fulfillment center identifier
      • setMoreOrderReleases

        void setMoreOrderReleases(java.lang.String newMoreOrderReleases)
        Sets the moreOrderReleases flag to indicate if there are more eligible order releases not included in this pick batch. Valid values are "Yes" and "No".
        Parameters:
        newMoreOrderReleases - flag identifying more order releases
      • setIsExpedited

        void setIsExpedited(java.lang.String newExpedited)
        Set the expedited setting
        Parameters:
        newExpedited -