oms CustomerOrder Web Service
Functional Description
This service is used by ORPOS to communicate details about customer orders with OMS and serves several functions throughout the lifecycle of the order. The first is the creation of the order that was captured at ORPOS for a customer order is being placed in the store via ORPOS that will be sourced and/or fulfilled from another location. This service also allows orders to be queried at ORPOS when processing a customer pickup, customer cancellation in store, or customer order return in the store.
Technical Description
Services
|
oms-CustomerOrderService |
|
|
Description |
A service to manage customer orders. It includes operations to create a customer order, query for customer orders, pickup/cancel items from a customer order, and return items from customer orders. |
|
Integration Catalog |
|
|
Service WSDL |
|
|
ServiceDefinition.xml |
Operations
|
Operation Name |
Description |
|
requestNewCustomerOrderId |
Request a new customer order id. |
|
cancelNewCustomerOrderId |
Cancel a new customer order id requested earlier so the order id can be reused for other orders. This operation is invoked when the creation of a new order is cancelled after its order id has been assigned. |
|
createCustomerOrder |
Create a new customer order. |
|
queryCustomerOrder |
Query for customer orders based on input criteria. |
|
pickupCustomerOrderItems |
Pickup or cancel order items in a customer order. |
|
returnCustomerOrderItems |
Return order items from one or more customer orders. |
|
updateReceipt |
update the Receipt of a customer order. |
Operation Business Objects (Payload)
|
Operation Name |
Input |
Input Sample |
Output |
Output Sample |
|
requestNewCustomerOrderId |
||||
|
cancelNewCustomerOrderId |
||||
|
createCustomerOrder |
||||
|
queryCustomerOrder |
||||
|
pickupCustomerOrderItems |
||||
|
returnCustomerOrderItems |
||||
|
updateReceipt |