• List of Messages with Links to DTDs, Schemas, and Sample XML
Overview: The following table presents the XML messages processed through CWSerenade, including the base CWIntegrate site(s), if any, that use the message. 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.
Not included in table: This table does not include unique CWIntegrate sites.
Opening the files: When you click on the link to a file, it opens in the default program associated with the file type on your computer. For example, if DTD files are associated with Notepad, clicking on the link for a DTD should open the DTD in Notepad.
How to set up the default program association: One way to associate each of these file types with a default program is to use the File Types option, available by selecting Tools > Folder Options in Windows Explorer. See your Microsoft Windows online help for more information on using this option.
The file extension for each of these file types is:
• DTD = .dtd
• schema = .xsd
• XML = .xml
How to tell if you have a default program association: Open one of the associated files by navigating to the folder where it is located and double-clicking. For example, to open a DTD, go to the DTDs folder through Windows Explorer. When you double-click the DTD file:
• if a program launches automatically to open the file, this is the default program associated with this file type.
• if a window prompts you to select a program, there is no default program associated with the file type. Use the steps above to set up the default program association, or select a program through the window and indicate to always use that program to open this type of file.
Troubleshooting:
• Your application (Acrobat or Internet Explorer) might display a warning in a pop-up window the first time you click the link to one of these file types. You can disable the warning by selecting Do not show this message again and then clicking Open.
• Depending on the configuration of your server, clicking on the link to a DTD might open a window indicating that the XML page cannot be displayed. To view the DTD, right-click anywhere on the page and select View Source.
• Certain applications, such as Wordpad, do not enable you to open a link to a file whose complete directory path includes any blank spaces (such as C:\CWI Documentation\sample.dtd). Instead, when you attempt to launch the application in order to view the file, you see an error message indicating that it cannot find a file at C:\CWI. You can change the default program association for the file type, or you can open the file directly within the external application using its File > Open command. Each of the sample file types are available in a subfolder of the online help main folder:
• DTDs are stored in the DTDs subfolder
• schemas are stored in the schemas subfolder
• sample XMLs are stored in the sample XMLs subfolder
For more information: See Integration Layer Processes and Web Services for background and troubleshooting information.
List of Messages with Links to DTDs, Schemas, and Sample XML
Message |
Process(es) |
In/Out |
CWIntegrate Site(s) |
DTD (in DTD subfolder) |
Schema (in schemas subfolder) |
Sample XML Layout (in sample XMLs subfolder) |
CWIntegrate 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. |
||||||
Inbound A/R Payment XML Message (ARPayment) Use this message to: Process batches of A/R payment information. |
ARBATCH_ IN; can also use the CWMessageIn Web Service |
inbound |
cw_ arpayments |
|||
Authorization Request XML Message (CWAuthorizationRequest) Use this message to: Request authorizations for credit cards, stored value cards, Bill Me Later transactions, and switch cards; activate or inquire on stored value cards; process stored value card reversals. Processing can be in interactive or batch mode. |
CCAUTH_ BTH CCAUTH_ ONL SVC_ BALANC SVC_OUT SVC_REVSL |
outbound |
cw_ paymentech
cw_ valuecard |
CWAuthorizationRequest_1_0.dtd
|
CWAuthorizationRequest_1_0.xsd
|
CWAuthorizationRequest_1_0.xml
|
Authorization Response XML Message (CWAuthorizationResponse) Use this message to: Receive a response to an authorization request from the credit bureau. |
inbound |
CWAuthorizationResponse_1_0.dtd
CWAuthorizationResponse_2_0.dtd
|
CWAuthorizationResponse_1_0.xsd
CWAuthorizationResponse_2_0.xsd
|
CWAuthorizationResponse_1_0.xml
CWAuthorizationResponse_2_0.xml
|
||
Deposit Request XML Message (CWDepositRequest) Use this message to: Send deposit requests to the service bureau. |
DEPOSITS |
outbound |
cw_ paymentech
cw_valuecard |
|
|
|
Deposit Response XML Message (CWDepositResponse) Use this message to: Receive deposit responses from the service bureau. |
inbound |
|||||
Inbound Customer Message (CWCustomerIn) Use this message to: Create or change a customer record. |
CWCustomer web service; can also use CWMessageIn Web Service |
inbound |
cw_store |
|
|
|
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 |
outbound |
cw_store |
|||
Customer Download XML Message (CWCustomerDownload) Use this message to: Send information on an existing customer to an external system. |
CUST_OUT |
outbound |
|
|||
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, CustSoldToCross References, CustSoldtoCross Reference, CustIndividuals, CustIndividual, CustTaxes and CustTax elements. |
|
outbound |
|
|||
Inbound Customer Search Message (CWCustomerInqRequest) Use this message to: Search for a customer in CWSerenade from an external system. |
CUST_SRCH; can also use CWMessageIn Web Service |
inbound |
cw_store |
|||
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. |
outbound |
cw_store |
|
|
|
|
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. |
CUST_HIST; can also use CWMessageIn Web Service |
inbound |
cw_store |
|
|
|
Customer History Response XML Message (CWCustHistOut) Use this message to: Provide a list of orders for a customer to an external system. |
outbound |
cw_store |
||||
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 |
outbound |
cw_store |
|
|
|
|
Use this message to: Send emails to CWSerenade for correspondence history purposes. |
EMAIL; can also use CWMessageIn Web Service |
inbound |
cw_email |
|||
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 |
outbound |
|
|
|
|
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. |
|
inbound |
|
|
|
|
Inventory Download XML Message (CWInventoryDownload) Use this message to: Send inventory updates to an external system. |
INV_ DOWNLD |
outbound |
cw_store |
|||
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 |
inbound |
|
|||
Inventory Inquiry Response XML Message (CWInventoryInquiryResponse) Use this message to: Send inventory information on a particular item to an external system. |
outbound |
|
||||
Item Availability Request XML Message (CWItemAvailabilityWeb) Use this message to: Receive an inventory inquiry on a particular item or group of items. |
inbound |
|
||||
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. |
outbound |
|
||||
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 |
outbound |
cw_store |
|
|
|
Inventory Transaction Upload XML Message (inCreateInvXaction) Use this message to: Process inventory transactions and update inventory. |
INVTRANS_ IN; can also use CWMessageIn Web Service |
inbound |
cw_store |
|||
Item Download XML Message (CWItemOut) Use this message to: Send information on an existing item to an external system. |
ITEM_OUT |
outbound |
cw_store |
|||
Manifest Pick Request Message (CWManifestPickRequest) Use this message to: Receive a request from the manifesting station for the details of a pick slip. |
CWManifest web service |
inbound |
|
|||
Manifest Ship Request Message (CWManifestShipRequest) Use this message to: Receive a request from the manifesting station to confirm the shipment of a pick slip. |
CWManifest web service |
inbound |
|
|||
Manifest Ship Response Message (CWManifestShipResponse) Use this message to: Confirm whether the shipment request was processed successfully. |
CWManifest web service |
outbound |
|
|||
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 |
inbound |
cw_store |
|
|
|
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 |
N/A |
Order Line History In Message (CWOrdLnHstIn) Use this message to: Create order line history records for a specified line on an order. |
inbound |
|
||||
Order Transaction History Message (CWOrderTransactionHistory) Use this message to: Create order transaction history records for a specified order. |
inbound |
|
CWOrderTransactionHistory_1.0.dtd
|
CWOrderTransactionHistory_1.0.xsd
|
CWOrderTransactionHistory_1.0.xml
|
|
|
Use this message to: Receive updates about pick slips from a warehouse management system. |
CWPickIn web service |
inbound |
|
|
|
|
Pick Message from CWSerenade (CWPickOut) Use this message to: Send information on pick slip to an external system. |
PICK_OUT |
outbound |
|
|
|
|
|
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 |
outbound |
|
|
|
|
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 |
inbound |
|
|||
Return Request Message (CWReturnIn) Use this message to: Create, receive, and credit a return against an order line. |
RETURN_IN; can also use CWMessageIn Web Service |
inbound |
|
|||
Return Response Message (CWReturnOut) Use this message to: Indicate whether the CWReturnIn message was processed successfully. |
outbound |
|||||
Return Authorization Outbound XML Message (CWReturnRAOut) Use this message to: Send a return authorization request to an external system. |
RETURN_OUT |
outbound |
|
CWReturnAuthorizationOut_1_0.dtd
|
CWReturnAuthorizationOut_1_0.xsd
|
CWReturnAuthorizationOut_1_0.xml
|
Customer Merge XML Message (CWFileTransfer) Use this message to: Indicate that customer records have been merged in CWSerenade. |
TRIGGER_ DL |
outbound |
|
|||
Vendor Download XML Message (CWVendorOut) Use this message to: Send vendor information to an external system. |
VENDOR_ OUT |
outbound |
cw_store |
|
|
|
Generic Workflow XML Message (CWWorkflow) Use this message to: Create a WF workflow event. |
WORKFLOW; can also use CWMessageIn Web Service |
inbound |
cw_workflow |
|||
E-Commerce Processes The following XML messages are processed through the Working with E-Commerce Job Control (EJCT) menu option. See E-Commerce Processes for a description of each process. |
||||||
E-Commerce Cancel Request Message (CWCancel) Use this message to: Cancel an order or order line. |
CANCELS; can also use CWMessageIn Web Service |
inbound |
|
|||
E-Commerce Catalog Request Message (CWCatRequest) Use this message to: Create a catalog request. |
CATALOG REQUESTS; can also use CWMessageIn Web Service |
inbound |
|
|||
E-Commerce Catalog Request Response Message (CWCatreqResponse) Use this message to: Respond to a catalog request. |
outbound |
|
||||
E-Commerce Return Request Message (CWReturn) Use this message to: Create a return authorization. |
RETURNS; can also use CWMessageIn Web Service |
inbound |
|
|||
E-Commerce Return Response Message (CWReturnResponse) Use this message to: Provide information on a return authorization created through the CWReturn message. |
outbound |
|
||||
E-Commerce Order Status Message (CWOrderStatus) Use this message to: Request summary information about an order. |
ORDER STATUS/ INQUIRY; can also use CWMessageIn Web Service |
inbound |
|
|||
E-Commerce Order Status Response Message (CWStatusResponse) Use this message to: Respond to the CWOrderStatus message with order summary information. |
outbound |
|
||||
