• List of Messages with Links to DTDs and Schemas
Overview: The following table presents the XML messages processed through Order Management System. It also includes links to the DTD and schema for each message, and a link to a sample XML file illustrating the appearance of the message with every element and attribute populated with character strings.
Opening the files: When you click on the link to a file, it opens in the default program associated with the file. See Integration Layer Processes and Web Services for background and troubleshooting information.
List of Messages with Links to DTDs and Schemas
|
Message |
Process(es) |
In/Out |
DTD (in DTD subfolder) |
Schema (in schemas subfolder) |
|---|---|---|---|---|
|
IJCT Processes and Generic Web Services Any of the following XML messages that are processed through the Working with Integration Layer Processes (IJCT) menu option are indicated below. |
||||
|
Authorization Request XML Message (CWAuthorizationRequest) This message is not currently used by any base integration. |
|
out |
||
|
Authorization Response XML Message (CWAuthorizationResponse) This message is not currently used by any base integration. |
in |
CWAuthorizationResponse_1_0.dtd |
CWAuthorizationResponse_1_0.xsd |
|
|
Deposit Request XML Message (CWDepositRequest) This message is not currently used by any base integration. |
|
out |
||
|
Deposit Response XML Message (CWDepositResponse) This message is not currently used by any base integration. |
in |
|||
|
Inbound Customer Message (CWCustomerIn) Use this message to: Create or change a customer record. |
CWCustomer web service; can also use CWMessageIn Web Service |
in |
||
|
Outbound Customer Response Message (CWCustomerOut) Use this message to: Indicate whether the create, change, or delete request from the CWCustomerIn message succeeded. |
CWCustomer web service; can also use CWMessageIn Web Service |
out |
||
|
Customer Download XML Message (CWCustomerDownload) Use this message to: Send information on an existing customer to an external system. |
CUST_OUT |
out |
||
|
Mass Customer Download XML Message (CWCustomerDownload) Use this message to: Send information on an existing customer to an external system. Note: This message is a subset of the Customer Download message and only includes the Message, CustSoldTo, CustSoldToCrossReferences, CustSoldtoCrossReference, CustTaxes and CustTax elements. |
|
out |
||
|
Inbound Customer Search Message (CWCustomerInqRequest) Use this message to: Search for a customer in Order Management System from an external system. |
CUST_SRCH; can also use CWMessageIn Web Service |
in |
||
|
Outbound Customer Search Response (CWCustomerInqResponse) Use this message to: Provide one or more customers who match the search criteria submitted by an external system in the CWCustomerInqRequest. |
out |
|||
|
Customer History Request XML Message (CWCustHistIn) Use this message to: Receive a request for customer history or details on a particular order from an external system. Xstore integration: The CWCustHistIn message is used as part of the Xstore integration. Contact your Oracle support representative for formatting details and configuration requirements for integration with Xstore. |
CUST_HIST; can also use CWMessageIn Web Service |
in |
|
|
|
Customer History Response XML Message (CWCustHistOut) Use this message to: Provide a list of orders for a customer to an external system. |
out |
CWCustHistOut_1_0.dtd CWCustHistOut_2_0.dtd
|
||
|
Detailed Order XML Response (CWORDEROUT) or Summary Order Inquiry Response XML Message (CWORDEROUT) and Order Acknowledgement XML Message (CWORDEROUT)) Use this message to: Send information on an order to an external system, either in response to a customer history inquiry or to the CWOrderIn message (order API). |
CUST_HIST ORDER_IN |
out |
|
|
|
Use this message to: Send emails to Order Management System for correspondence history purposes. |
EMAIL; can also use CWMessageIn Web Service |
in |
||
|
Email Request Message (CWEmailRequest) Use this message to: Generate the store pickup email, notifying the customer that a store pickup order is ready at the selected store. |
|
in |
||
|
Outbound Email XML Message (CWEmailOut) Use this message to: Send email notifications to an external system in order to generate a reformatted email, possibly including promotional information. Note: Version 7.0 or later of the CWEmailOut message is required to generate all possible email notification types. |
EMAIL_OUT |
out |
|
|
|
Inventory Download XML Message (CWInventoryDownload) Use this message to: Send inventory updates to an external system. |
INV_ DOWNLD |
out |
||
|
Inventory Inquiry Request XML Message (CWInventoryInquiry) Use this message to: Receive an inventory inquiry on a particular item. |
INV_INQURY; can also use CWMessageIn Web Service |
in |
||
|
Inventory Inquiry Response XML Message (CWInventoryInquiryResponse) Use this message to: Send inventory information on a particular item to an external system. |
out |
|||
|
Item Availability Request XML Message (CWItemAvailabilityWeb) Use this message to: Receive an inventory inquiry on a particular item or group of items. |
in |
|||
|
Item Availability Response XML Message (CWItemAvailabilityResponseWeb) Use this message to: Send inventory information on a particular item or group of items to an external system. |
out |
|||
|
E-Commerce Availability Web Request XML Message (AvailabilityWebRequest) Use this message to: Receive an inventory inquiry on the items in a specified company and optionally offer. |
in |
|||
|
E-Commerce Availability Web Response XML Message (AvailabilityWebResponse) Use this message to: Indicate to the external system whether the request was successful. Note: The actual inventory information is included in the E-Commerce Availability Web XML File (AvailabilityWeb). |
out |
|||
|
Invoice Download XML Message (CWInvoiceOut) Use this message to: Send information on an invoice for a shipment or return to an external system. |
INVOICE_ OUT |
out |
||
|
Inventory Transaction Upload XML Message (inCreateInvXaction) Use this message to: Process inventory transactions and update inventory. |
INVTRANS_ IN; can also use CWMessageIn Web Service |
in |
||
|
Item Download XML Message (CWItemOut) Use this message to: Send information on an existing item to an external system. Message version: The message version of the ITEM_OUT process should be set to 2.0, as version 1.0 of the CWItemOut message includes tags that are not currently supported. See XML Versions for a discussion on setting outbound message versions. |
ITEM_OUT |
out |
|
|
|
Note: The CWMerchLocRequest and CWMerchLocResponse messages are used only to support processing the LocateItems request and response messages and the Merchandise Locator API, and are not themselves generic API messages. |
||||
|
Inbound Order XML Message (CWORDERIN) Use this message to: Create an order that originated at the web storefront or in an external system. |
CWOrderIn web service; can also use ORDER_IN IJCT job or CWMessageIn Web Service |
in |
|
|
|
Order Reject Request Message (CWORDERREJECT) This is a variation on the CWORDERIN message and does not have a separate DTD or schema. Use this message to: Reject an order. |
|
|
N/A |
N/A |
|
Order Line History In Message (CWOrdLnHstIn) Use this message to: Create order line history records for a specified line on an order. |
in |
|||
|
Order Transaction History Message (CWOrderTransactionHistory) Use this message to: Create order transaction history records for a specified order. |
in |
|||
|
Use this message to: Receive updates about pick slips from a warehouse management system. |
CWPickIn web service |
in |
|
|
|
Pick Message from Order Management System (CWPickOut) Use this message to: Send information on pick slip to an external system. Message version: The message version of the PICK_OUT process should be set to 5.0 or higher, as versions 1.0 through 4.0 of the CW message includes tags that are not currently supported. See XML Versions for a discussion on setting outbound message versions. |
PICK_OUT |
out |
\ |
|
|
Use this message to: Submit a periodic process. |
See Using the CWProcessIn Message to Start a Periodic Process for more information. |
|||
|
PO Download XML Message (CWPurchaseOrderOut) Use this message to: Send information on a purchase order to an external system. |
PO_OUT |
out |
||
|
PO Receipt In XML Message (CWReceiptIn) Use this message to: Process purchase order receipts based on information received from an external system. |
CWReceiptIn web service |
in |
||
|
Return Request Message (CWReturnIn) Use this message to: Create, receive, and credit a return against an order line. Xstore integration: The CWReturnIn message is used as part of the Xstore integration. Contact your Oracle support representative for formatting details and configuration requirements for integration with Xstore. |
RETURN_IN; can also use CWMessageIn Web Service |
in |
||
|
Return Response Message (CWReturnOut) Use this message to: Indicate whether the CWReturnIn message was processed successfully. |
out |
|||
|
Return Authorization Outbound XML Message (CWReturnRAOut) Use this message to: Send a return authorization request to an external system. |
RETURN_OUT |
out |
||
|
Tax Request Message (CWTaxRequest) Use this message to: Send tax information to an external tax system. |
TAX_INT |
out |
||
|
Tax Response Message (CWTaxResponse) Use this message to: Receive calculated tax from an external tax system. |
in |
|||
|
Vendor Download XML Message (CWVendorOut) Use this message to: Send vendor information to an external system. Message version: The message version of the VENDOR_OUT process should be set to 2.0, as version 1.0 of the CWVendorOut message includes tags that are not currently supported. See XML Versions for a discussion on setting outbound message versions. |
VENDOR_ OUT |
out |
||
|
Generic Workflow XML Message (CWWorkflow) Use this message to: Create a WF workflow event. |
WORKFLOW; can also use CWMessageIn Web Service |
in |
||
|
E-Commerce Product Web XML File (ProductWeb) Use this message to: Send item offer information to an external web storefront. |
Downloading E-Commerce Offer Files (EOFR) if the Generate E-Commerce Offer Tables (M29) system control value is unselected |
out |
||
|
E-Commerce Cancel Request Message (CWCancel) Use this message to: Cancel an order or order line. |
in |
|||
|
E-Commerce Catalog Request Message (CWCatRequest) Use this message to: Create a catalog request. |
in |
|||
|
E-Commerce Catalog Request Response Message (CWCatreqResponse) Use this message to: Respond to a catalog request. |
out |
|||
|
E-Commerce Customer Merge Web XML File (CustomerMergeWeb) Use this message to: Send customer sold to merge records to an external web storefront. |
Working with Merge/Purge Sold-to Names (MMCS) if the Generate E-Commerce Customer Merge Staging Files (H86) system control value is selected |
out |
||
________________________________
Contents SCVs Reports XML Messages Glossary
Copyright © 2022, Oracle and/or its affiliates. All rights reserved.
Legal Notices