This command changes the assigned fulfillment center if the one specified is different from the one originally assigned, and it releases the order items. One or more releases can be created from the selected order items. (A release is a set of products in a given order that have the same ship-to address, fulfillment center, and shipping carrier.)
Command structure
- http://host_name/path/
- The fully qualified name of your WebSphere Commerce Server and the configuration path.
Parameter values
- storeId
- Specifies the store ID. This parameter is required.
- orderId
- Specifies the ID of an order with items to be released. This parameter can be repeated. This parameter is required.
- orderItemId_i
- Specifies the order items to be released. This parameter is required.
- ffmcenterId_i
- Specifies the fulfillment center IDs representing the centers to be used to fulfill the corresponding order items.
- fullfillmentOrderId
- Specifies the ID of an existing pending order in the fulfillment center store. This parameter is required if items are released to a fulfillment center with a fulfillment center store and the user wishes to add the items to an existing shopping cart that the user owns.
- fullfillmentOrderName
- Specifies the name to be used as the order description if a new fulfillment order is to be created in the fulfillment center store for the user. This parameter is ignored if the fulfillment order ID parameter is also specified.
- allocate
- Controls whether the inventory will be allocated after the fulfillment center assignment is made. A value of 1 specifies that the inventory will be allocated after the fulfillment center assignment is made. This parameter is required.
- release
- Controls whether specified order items are to be released as a result of running this command. A value of 1 specifies that the order items are to be released as a result of running this command. This parameter is required.
- redirectURL
- Specifies the redirection URL. The page corresponding to this URL loads when the command successfully completes execution.
- outFailedOrderCountName
- Specifies the output parameter name for the failedOrderCount output parameter. The default value is failedOrderCount.
- outFailedOrderName
- Specifies a name for the failedOrderId output parameter. The default value
is failedOrderId.
This name will be appended with "_i" for grouping the i-th order with its associated failedOderItemIds and failureMessage output parameters.
- outFailedOrderItemsName
- Specifies a name for the failedOderItemIds output parameter. The default
value is failedOrderItemIds.
This name will be appended with "_i" for associating the failed order item IDs with the failed order ID.
- outFailedOrderMessageName
- Specifies a name for the failureMessage output parameter. The default value
is failureMessage.
This name will be appended with "_i" for associating the failure message with the failed order ID and failed order item IDs.
Output parameters
- failedOrderCount
- The number of orders with items that were specified to be released but
failed. This output parameter is zero if there is no failure.
The IDs of the order and the order items are supplied in the failedOrderId_i and failedOrderItemIds_i output parameters. The reason for the failure is specified by the failureMessage_i output parameter.
- failedOrderId_i
- The i-th order that failed (i = 1, 2, 3, and so on).
- failedOderItemIds_i
- An array of order item IDs that failed to be released. This is null if all succeed or if the fulfillment center has a null EXTFFMSTORENUM attribute.
- failureMessage_i
- The failure message associated with the failedOrderId_i.
Example
http://myhostname/webapp/wcs/stores/sevlet/AssignToSpecifiedFulfillmentCenter? storeId=2066&orderId=1000&orderItemId_1=100011&orderItemId_2=100012 &orderItemId_3=100013&orderItemId_4=100014&ffmcenterId_1=1001&ffmcenterId_2=1001 &ffmcenterId_3=1001&ffmcenterId_4=206601&fulfillmentOrderId=8888&allocate=1&release=1
Behavior
- For each order specified, this command replaces the current fulfillment
center ID in the order items with the specified fulfillment center ID and
releases the order items. For order items destined to a fulfillment center with
a non-null EXTFFMSTORENUM attribute, the command performs one of the following
- Add the items to a new shopping cart with the specified name if fulfillmentOrderName is non-null.
- Add the items to an existing shopping cart if fulfillmentOrderId is non-null.
- Add the items to a new shopping cart per customer order with the generated name "Shopping cart for customer order n" if fulfillmentOrderId and fulfillmentOrderName are both null.
Exception conditions
- Exceptions will be thrown if any required parameters are missing.
- Any other exceptions or problems encountered will be communicated via the failure-output parameters.