public interface ReleaseShipConfirmCmd extends ToolsControllerCommand
UpdateReleaseManifestStatusCmd
task command will be called to update order status and fulfillment status after shipment
tracking information is recorded.
Parameters
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>
Response Parameters
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.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
The internal copyright field.
|
static java.lang.String |
defaultCommandClassName
The default implementation class name is "com.ibm.commerce.inventory.commands.ReleaseShipConfirmCmdImpl".
|
static java.lang.String |
NAME
The name of this interface is "com.ibm.commerce.inventory.commands.ReleaseShipConfirmCmd".
|
Modifier and Type | Method and Description |
---|---|
void |
setDateShipped(java.lang.String newDateShipped)
Sets the date the package shipped.
|
void |
setLastupdate(java.lang.String newLastupdate)
Sets the timestamp of last update.
|
void |
setManifestId(java.lang.String newManifestId)
Sets the manifest (package) identifier.
|
void |
setManifestStatus(java.lang.String newManifestStatus)
Sets the status of the manifest (package).
|
void |
setOrdersId(java.lang.String newOrdersId)
Sets the order identifier.
|
void |
setOrdReleaseNum(java.lang.String newOrdReleaseNum)
Sets the order release number.
|
void |
setPackageId(java.lang.String newPackageId)
Sets the package identifier.
|
void |
setPickupRecordId(java.lang.String newPickupRecordId)
Sets the pickup record identifier.
|
void |
setSetCCurr(java.lang.String newSetCCurr)
Sets the currency in which the shipment was charged.
|
void |
setShipModeId(java.lang.String newShipModeId)
Sets the shipping provider.
|
void |
setShippingCosts(java.lang.String newShippingCosts)
Sets the shipping costs.
|
void |
setTrackingId(java.lang.String newTrackingId)
Sets the tracking identifier.
|
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.
|
void |
setWeight(java.lang.String newWeight)
Sets the weight of the package.
|
void |
setWeightMeasure(java.lang.String newWeightMeasure)
Sets the unit of measure of the package weight.
|
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache
getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties
accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
fulfills, getOwner
static final java.lang.String COPYRIGHT
static final java.lang.String NAME
static final java.lang.String defaultCommandClassName
void setDateShipped(java.lang.String newDateShipped)
newDateShipped
- shipped datevoid setLastupdate(java.lang.String newLastupdate)
newLastupdate
- timevoid setManifestId(java.lang.String newManifestId)
newManifestId
- package idvoid setManifestStatus(java.lang.String newManifestStatus)
newManifestStatus
- statusvoid setOrdersId(java.lang.String newOrdersId)
newOrdersId
- order idvoid setOrdReleaseNum(java.lang.String newOrdReleaseNum)
newOrdReleaseNum
- release numbervoid setPackageId(java.lang.String newPackageId)
newPackageId
- package idvoid setPickupRecordId(java.lang.String newPickupRecordId)
newPickupRecordId
- pickup record idvoid setSetCCurr(java.lang.String newSetCCurr)
newSetCCurr
- currencyvoid setShipModeId(java.lang.String newShipModeId)
newShipModeId
- shipping providervoid setShippingCosts(java.lang.String newShippingCosts)
newShippingCosts
- shipping costsvoid setTrackingId(java.lang.String newTrackingId)
newTrackingId
- tracking idvoid setUpdateManifestStatus(java.lang.String newUpdateManifestStatus)
newUpdateManifestStatus
- status flagvoid setWeight(java.lang.String newWeight)
newWeight
- package weightvoid setWeightMeasure(java.lang.String newWeightMeasure)
newWeightMeasure
- weight measure