Order facade client API mappings

6.0.0.2 Order facade client API mappings

+
Search Tips | Advanced Search

A map variable, called parameters, holds the values that a WebSphere Commerce command expects, then calls the corresponding OrderFacadeClient method. The following tables show the mapping of methods in the order facade client.

addOrderItem

Parameter Type Required Description

orderId String[] Yes The reference number of the order to which the order item should be added.
quantity String[] Yes The quantity of the item.
catEntryId String[] Yes The catalog entry ID of the item to add to the shopping cart.
contractId String[] No The identifier of the contract governing the order to which the item is being added; there is one default contract. If contractId is not specified then the default contract is used.
UOM String[] No Specifies the unit of measure for the quantity parameter.

updateOrderItem

Parameter Type Required Description

orderId String[] Yes The reference number of the order for which the order item is being updated.
quantity String[] Yes The quantity of the item.
orderItemId String[] Yes The order item to update.
contractId String[] No The identifier of the contract governing the order for which the item is being updated. If contractId is not specified then the contract will not change.
UOM String[] No Specifies the unit of measure for the quantity parameter.

deleteOrderItem

Parameter Type Required Description

orderId String[] Yes The reference number of the order from which to delete the order item.
orderItemId String[] Yes The order item to delete.

updateOrderShippingInfo

Parameter Type Required Description

orderId String[] Yes The reference number of the order for which to update shipping information.
ShipAsComplete String[] No Specifies whether partial shipment of the item is acceptable.
orderItemId String[] Yes The reference number of the order item for which to update shipping information.
requestedShipDate String[] No The requested shipping date for an order item.
shipModeId String[] No The order ship mode associated with the shipping instructions or shipping carrier account number.
isExpedited String[] No The default value for this parameter is N. If it is 'Y', order item will be marked as EXPEDITED.
addressId String[] No Contains a distinct addressId value if shipping instructions are provided and depending on what shipping information is being stored. If shipping instructions are being stored, the addressId is the identifier of the address associated with the shipping instructions.
shipInstructions String[] No The shipping instructions associated with an order, address ID, and ship mode ID.
tieShipCode String[] No Ship tie code.

cancelShoppingCart

Parameter Type Required Description

orderId String[] Yes The reference number of the order to delete.

addPaymentInstruction

Parameter Type Required Description

orderId String[] Yes The reference number of the order to which to add payment instructions.
payMethodId, String[] Yes The payment method.
piAmount, String[] Yes The amount in the order currency to be used for this payment method. The format of this number must fit the rules for a java.math.BigDecimal object. The number must use a period for a decimal place.
paymentTCId, String[] No The payment terms and conditions identifier for this payment instruction. This parameter is used by the B2B customer.
billing_address_id String[] No The billing address identifier.
protocol data String[] No Additional name-value pairs separated by an ampersand (&) that will be passed to the payment plug-in or payment processor as additional data required by that payment protocol. For example, for a credit card, &cc_brand=AMEX.

updatePaymentInstruction

Parameter Type Required Description

orderId String[] Yes The identifier of the order for which the payment method is to be changed.
Pild String[] Yes The numeric identifier of the payment instruction to modify. The Pild can be obtained from the EDPPaymentInstructionsDataBean data bean and represents the combination of the payment method, payment amount, and any protocol data.
payMethodId String[] Yes The payment method.
piAmount String[] No The new amount in the order currency to be used for this payment instruction. The format of this number must fit the rules for a java.math.BigDecimal object. The number must use a period for a decimal place.
paymentTCId String[] No The payment Term&Condition identifier for this payment instruction. This parameter is used by the business customer.
billing_address_id String[] No The Billing Address.
protocol data String[] No Additional name-value pairs separated by an ampersand (&) that will be passed to the payment plug-in or payment processor as additional data required by that payment protocol. If an existing keyword is passed in, the value for the keyword will be overwritten in the payment instruction.

removePaymentInstruction

Parameter Type Required Description

orderId String[] Yes The ID of the order from which to remove the payment instruction.
Pild String[] Yes The ID of the payment instruction to remove.

submitOrder

Parameter Type Required Description

orderId String[] Yes The identifier of the order from which the payment instruction is to be removed.
purchaseorder_id String[] No The Buyer purchase order number.
payMethodId, String[] Yes The payment method ID to add the payment instruction. If this parameter is not set, the command uses policyId to determine a payment method ID.
piAmount, String[] Yes The new amount in the order currency to be used for this payment instruction. The format of this number must fit the rules for a java.math.BigDecimal object. The number must use a period for a decimal place.
paymentTCId, String[] No The payment Term and Condition identifier for this payment instruction. This parameter is used by the business customer.
billing_address_id String[] No The reference number of the default address to bill for this customer.
protocol data String[] No Additional name-value pairs separated by an ampersand (&) that will be passed to the payment plug-in or payment processor as additional data required by that payment protocol. If an existing keyword is passed in, the value for the keyword is overwritten in the payment instruction.

prepareOrder

Parameter Type Required Description

orderId String[] Yes The identifier of the order to prepare.

Related Concepts

Order Management subsystem

Related Reference

Order Management subsystem URLs

Parameter	Type	Required	Description
orderId	String[]	Yes	The reference number of the order to which the order item should be added.
quantity	String[]	Yes	The quantity of the item.
catEntryId	String[]	Yes	The catalog entry ID of the item to add to the shopping cart.
contractId	String[]	No	The identifier of the contract governing the order to which the item is being added; there is one default contract. If contractId is not specified then the default contract is used.
UOM	String[]	No	Specifies the unit of measure for the quantity parameter.

Parameter	Type	Required	Description
orderId	String[]	Yes	The reference number of the order for which the order item is being updated.
quantity	String[]	Yes	The quantity of the item.
orderItemId	String[]	Yes	The order item to update.
contractId	String[]	No	The identifier of the contract governing the order for which the item is being updated. If contractId is not specified then the contract will not change.
UOM	String[]	No	Specifies the unit of measure for the quantity parameter.

Parameter	Type	Required	Description
orderId	String[]	Yes	The reference number of the order from which to delete the order item.
orderItemId	String[]	Yes	The order item to delete.

Parameter	Type	Required	Description
orderId	String[]	Yes	The identifier of the order for which the payment method is to be changed.
Pild	String[]	Yes	The numeric identifier of the payment instruction to modify. The Pild can be obtained from the EDPPaymentInstructionsDataBean data bean and represents the combination of the payment method, payment amount, and any protocol data.
payMethodId	String[]	Yes	The payment method.
piAmount	String[]	No	The new amount in the order currency to be used for this payment instruction. The format of this number must fit the rules for a java.math.BigDecimal object. The number must use a period for a decimal place.
paymentTCId	String[]	No	The payment Term&Condition identifier for this payment instruction. This parameter is used by the business customer.
billing_address_id	String[]	No	The Billing Address.
protocol data	String[]	No	Additional name-value pairs separated by an ampersand (&) that will be passed to the payment plug-in or payment processor as additional data required by that payment protocol. If an existing keyword is passed in, the value for the keyword will be overwritten in the payment instruction.

Parameter	Type	Required	Description
orderId	String[]	Yes	The ID of the order from which to remove the payment instruction.
Pild	String[]	Yes	The ID of the payment instruction to remove.

Parameter	Type	Required	Description
orderId	String[]	Yes	The identifier of the order from which the payment instruction is to be removed.
purchaseorder_id	String[]	No	The Buyer purchase order number.
payMethodId,	String[]	Yes	The payment method ID to add the payment instruction. If this parameter is not set, the command uses policyId to determine a payment method ID.
piAmount,	String[]	Yes	The new amount in the order currency to be used for this payment instruction. The format of this number must fit the rules for a java.math.BigDecimal object. The number must use a period for a decimal place.
paymentTCId,	String[]	No	The payment Term and Condition identifier for this payment instruction. This parameter is used by the business customer.
billing_address_id	String[]	No	The reference number of the default address to bill for this customer.
protocol data	String[]	No	Additional name-value pairs separated by an ampersand (&) that will be passed to the payment plug-in or payment processor as additional data required by that payment protocol. If an existing keyword is passed in, the value for the keyword is overwritten in the payment instruction.