Oracle Retail Order Management System (CWSerenade) E ... · Oracle® Retail Order Management System...

Oracle® Retail Order Management System (CWSerenade)

E-Commerce Guide Release 5.0

April 2018

E95327-02

ii

Oracle® Retail Order Management System E-Commerce Guide, Release 5.0

Copyright © 2018, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

E95327-02

Contact Information

30500 Bruce Industrial Parkway Cleveland, OH 44139 USA Toll Free: 888.328.2826 Tel: 440.498.4414 Fax: 440.542.3043

1800 West Park Drive Westboro, MA 01581 Tel:508.655.7500 Fax:508.647.9495

7031 Columbia Gateway Drive Columbia, MD 21046‐2289 Tel: 443.285.6000

3/24/15 4

Contents

E-Commerce Overview Types of E-Commerce Transactions

E-Commerce Order Transaction ......................................................................... 15E-Commerce Order Reject Transaction .............................................................. 17E-Commerce Catalog Request Transaction ....................................................... 18E-Commerce Order Status Transaction .............................................................. 19E-Commerce Return Transaction ....................................................................... 20E-Commerce Cancel Transaction ....................................................................... 21E-Commerce Customer Transaction ................................................................... 22E-Commerce Customer History Transaction ...................................................... 23E-Commerce Inventory Inquiry Transaction ........................................................ 25E-Commerce Inventory Download Transaction .................................................. 26

E-Commerce Messages Generic Order Interface (Order API)

Order API Processing Overview ......................................................................... 30Suppressing Deposits and Refunds ................................................................. 35Batching Orders Through the Order API .......................................................... 36Creating a Quote through the Order API .......................................................... 37Processing a Return ......................................................................................... 38Performing Credit Card Tokenization on Web Orders ..................................... 39Performing Online Credit Card Authorization on Web Orders ......................... 40Creating Authorization History for Orders Authorized on the Web ................... 40

Typical Order Interface Scenarios ....................................................................... 43Sending a Separate Payment Message ........................................................... 44

Order API Setup Requirements .......................................................................... 47Order API-Related System Control Values ......................................................... 50Customer Creation, Matching and Update Logic in the Order API ..................... 54

Customer Sold To Selection, Creation and Update ......................................... 54Creating or Selecting Shipping Addresses or Customers ................................ 58Customer Bill To Selection and Creation ......................................................... 62Individual Customer Creation and Selection .................................................... 63

Resolving the Item and SKU in the Order API .................................................... 65User-Defined Fields in the CWOrderIn Message ................................................ 66Selecting the Sales Rep ...................................................................................... 68Discounted and Added Items in the CWOrderOut Response Message ............. 70

Discounting and Added Items in the CWOrderOut Response Summary ......... 71Rejecting the Order (Order API) .......................................................................... 77

CWSerenade 5.0 Contents

3/24/15 5

Order Interface XML Message Formats

Inbound Order XML Message (CWORDERIN)Inbound Order Message: Sample XMLs .......................................................... 172

Initial order message ...................................................................................... 172Payment-only order message ........................................................................ 172Sales transaction order message ................................................................... 172Quote order message .................................................................................... 173Customer return order message .................................................................... 173CWOrderIn message with custom special handling ....................................... 174

Detailed Order XML Response (CWORDEROUT)Detailed Order Response Message: Sample XML ........................................... 206

Order Acknowledgement XML Message (CWORDEROUT)Order Acknowledgement Message: Sample XML ............................................ 209

Order Reject Request Message (CWORDERREJECT)Order Reject Request Message: Sample .......................................................... 212Order Reject Response Message: Samples ..................................................... 213

Order Creation ErrorsTranslating Special Characters ......................................................................... 224

E-Commerce Catalog RequestsCustomer Creation/Update Logic in E-Commerce Catalog Requests .............. 226

Creating/Updating Sold To Customers in E-Commerce Catalog Requests ... 226Creating/Updating Individuals in E-Commerce Catalog Requests ................. 227

E-Commerce Catalog Request Response ........................................................ 228E-Commerce Catalog Request Message (CWCatRequest) ............................. 229

E-Commerce Catalog Request Message: Sample XML ................................ 236E-Commerce Catalog Request Response Message (CWCatreqResponse) .... 238

E-Commerce Catalog Request Response Message: Sample XML ............... 239

E-Commerce Order Status ProcessingRegistered customer? .................................................................................... 240Order status response includes response type? ............................................ 241

E-Commerce Order Status Message (CWOrderStatus) ................................... 242E-Commerce Order Status Message: Sample XML ...................................... 244

E-Commerce Order Status Response Message (CWStatusResponse) ........... 245E-Commerce Order Status Response Message: Sample XML ..................... 250

Creating Return Authorizations from the Web StorefrontE-Commerce Return Authorization Processing ............................................. 252

E-Commerce Return Request Message (CWReturn) ....................................... 256E-Commerce Return Request Message: Sample XML .................................. 258

E-Commerce Return Response Message (CWReturnResponse) .................... 259


3/24/15 6

E-Commerce Return Response Message: Sample XML ............................... 261

Working with Batch Order Maintenance Transactions (WBOM)E-Commerce Cancel Process Overview ........................................................... 264

When is an Order Eligible for Cancellation through the E-Commerce Interface? ....................................................................................................... 264Order Inquiry/Maintenance Message Flow .................................................... 264Processing the Request ................................................................................. 265E-Commerce Cancellation Transactions ........................................................ 266Emails for E-Commerce Cancels ................................................................... 267Order History Messages ................................................................................ 267

Work with Batch OM Transactions Screen ....................................................... 268Display Batch OM Transactions Screen (Header) ............................................ 270Display Batch OM Transactions Screen (Detail) ............................................... 272Display Batch OM Detail Screen ....................................................................... 274Display Batch OM Errors Screen ...................................................................... 275Batch Order Cancel Errors ................................................................................ 276E-Commerce Cancel Request Message (CWCancel) ...................................... 278

E-Commerce Cancel Request Message: Sample XML ................................. 280

Generic Customer API

Customer API SetupSystem Control Values used by the Customer API ........................................ 284Default Customer for Customer API ............................................................... 285Message Log used by the Customer API ....................................................... 286CWCustomer or CWMessageIn Web Service ............................................... 286

Determining Whether to Add or Change a Customer

Adding a Customer using the Customer APIRequired Attributes for Add Requests ............................................................ 291Duplicate Checking for Add Requests ........................................................... 292Duplicate Check S: If Single Match Found, Update Customer ...................... 293Duplicate Check A: If Multiple Matches Found, Update Best Match Customer ........................................................................................................ 295Duplicate Check Y: If Any Match Found, Do Not Update Customer .............. 297Duplicate Check N: Do Not Perform Duplicate Checking .............................. 298Error Checking for Add Requests .................................................................. 298Send Response for Add Request? ................................................................. 299Fixing Errors and Reprocessing an Add Request .......................................... 299

Changing a Customer using the Customer APIRequired Attributes for Change Requests ..................................................... 300Determining the Customer to Update ............................................................. 301Using a Default Customer as a Guideline for Change Requests ................... 305Error Checking for Change Requests ............................................................ 306


3/24/15 7

Send Response for Change Request? .......................................................... 307Fixing Errors and Reprocessing a Change Request ...................................... 307

Sample Customer API XML MessagesCustomer Message: Successful Add Request ............................................... 308Customer Message: Duplicate Add Request ................................................. 309Customer Message: Failure Add Request ..................................................... 310Customer Message: Successful Change Request ......................................... 311Customer Message: Failure Change Request ............................................... 312Customer Message: Failure Delete Request ................................................. 313

Inbound Customer Message (CWCustomerIn)

Outbound Customer Response Message (CWCustomerOut)

Working with Customer API (WCAI)Work with Customer API Screen .................................................................... 367

Change Customer API Screen .......................................................................... 370Work with Customer API User Field Screen ..................................................... 378Change Customer API User Field Screen ........................................................ 379Work with Customer API Email Screen ............................................................. 380Change Customer API Email Screen ................................................................ 381

Generic Customer History APITypical Flow ................................................................................................... 382When is the Response Message Empty? ...................................................... 384Setup Requirements ...................................................................................... 386

Customer History Request XML Message (CWCustHistIn) .............................. 387Customer History Request Message: Sample XMLs ..................................... 393

Customer History Response XML Message (CWCustHistOut) ........................ 395Customer History Response Message: Sample XML .................................... 396

Detailed Order Inquiry Response XML Message (CWORDEROUT) ................ 400Detailed Order Inquiry Response Message: Sample XML ............................. 418

Summary Order Inquiry Response XML Message (CWORDEROUT) .............. 420Summary Order Inquiry Response Message: Sample XML .......................... 420

Generic Inventory Inquiry APITypical Flow ................................................................................................... 422When is the Response Message Empty? ...................................................... 423Resolving the Item and SKU .......................................................................... 423Setup Requirements ...................................................................................... 424

Inventory Inquiry Request XML Message (CWInventoryInquiry) ...................... 425Inventory Inquiry Request: Sample XML ........................................................ 427

Inventory Inquiry Response XML Message (CWInventoryInquiryResponse) ... 428Inventory Inquiry Response: Sample XML ..................................................... 441

Item Availability API


3/24/15 8

Item Availability API Setup ................................................................................ 444Item Availability API Process ............................................................................ 446

Resolving the Item and SKU .......................................................................... 446Item Availability Web Service Errors .............................................................. 447

Item Availability API: Sample Messages ........................................................... 449Successful Item Availability Request ............................................................. 449Unsuccessful Item Availability Request ......................................................... 451

Item Availability Request XML Message (CWItemAvailabilityWeb) .................. 452Item Availability Response XML Message (CWItemAvailabilityResponseWeb) 455

Generic Inventory Download APIInventory Download Process ............................................................................ 467

Creating Inventory Download Triggers through a Batch Process .................. 467Creating Inventory Download Triggers Interactively Due to Changes in Availability ...................................................................................................... 468Creating Inventory Download Triggers through Purchase Order Creation or Maintenance ................................................................................................... 472Which Activities Generate Inventory Download Triggers? ............................. 475Identifying Inventory Download Triggers ........................................................ 477Inventory Download Processing ..................................................................... 477Inventory Download Trigger Rules ................................................................. 477Item Warehouses Excluded from the Inventory Download ............................ 478Inventory Download XML Inclusion ................................................................ 479Inventory Download Troubleshooting ............................................................. 480

Inventory Download Setup ................................................................................ 481System Control Values Related to Inventory Download API .......................... 482Menu Options Related to Inventory Download API ........................................ 483

Inventory Download XML Message (CWInventoryDownload) .......................... 484Sample Inventory Download XML Message ..................................................... 492

Generic Item Download APIItem/SKU Download Process ............................................................................ 495

Identifying Item Download Triggers ................................................................ 495When are Item Download Triggers Created? ................................................. 495Item/SKU Download Processing .................................................................... 497Item Outbound Trigger Activities .................................................................... 498Item Outbound Trigger Rules ......................................................................... 503Item Trigger Cleanup ..................................................................................... 504Processing Item Delete Triggers .................................................................... 505Item Outbound XML Inclusion ........................................................................ 507

CWSerenade Setup for the Item Download APISystem Control Value .................................................................................... 515Menu Options ................................................................................................. 515Periodic Functions .......................................................................................... 516

Item Download XML Message (CWItemOut)


3/24/15 9

Item Download Message: Sample XML ......................................................... 589

E-Commerce-Related Setup in CWSerenade Additional E-Commerce Setup

System Control Values Related to E-Commerce .............................................. 593Table Setup for Download ................................................................................. 595Additional Setup ................................................................................................ 597

Additional Table Settings ............................................................................... 597E-Commerce Periodic Functions ................................................................... 597

Working with E-Mail Notification Templates (WEMT)Summary of Customer Correspondence ........................................................... 602When Does the System Generate an Email Notification? ................................. 609

Order Confirmation Emails ............................................................................. 609Shipment and Return Confirmation Emails .................................................... 612Stored Value Card Notification Emails ........................................................... 614Gift Certificate Notification Emails .................................................................. 614Quote Confirmation Emails ............................................................................ 615Membership Cancellations ............................................................................. 616Purchase Order Emails .................................................................................. 617Store Pickup Notifications .............................................................................. 618Relate Loyalty Registration Notifications ........................................................ 618Other Email Notifications ................................................................................ 618Determining the Opt-in/out Setting ................................................................. 621Additional Information about Email Notifications ............................................ 621

HTML Format Notification Samples and Contents ............................................ 622Order Confirmation Email Sample and Contents ........................................... 623Shipment Confirmation Email Sample and Contents ..................................... 626Return Confirmation Email Sample and Contents ......................................... 628Backorder Notification Email Sample and Contents ...................................... 629Credit Card Credit Acknowledgement Email Sample and Contents .............. 632Soldout Notification Email Sample and Contents ........................................... 634Stored Value Card Notification Sample and Contents ................................... 635“Contact Us” Notification Sample and Contents ............................................. 639Credit Card Decline Notification Sample and Contents ................................. 641Quote Confirmation Email Sample and Contents .......................................... 643Membership Cancellation Notification Sample and Contents ........................ 646Order Cancellation Confirmation Email Sample and Contents ...................... 647Order Line Cancellation Confirmation Email Sample and Contents .............. 650Store Pickup Notification Sample and Contents ............................................ 652Relate Loyalty Registration Notification Sample and Contents ...................... 655

Simple Format Notification Sample ................................................................... 657Work with E-Mail Template Screen ................................................................... 658Change E-Mail Template Screen ...................................................................... 660


3/24/15 10

Testing Email Generation (UEML)Send Email Message Screen ......................................................................... 662

E-Commerce-Related Jobs in CWSerenade Working with E-Commerce Job Control (EJCT)

Work with E-Commerce Job Control Screen ................................................. 665E-Commerce Processes ................................................................................... 667Changing the Number of Sessions ................................................................... 671

Change E-Commerce Job Control Pop-up Window ....................................... 671Changing Process Status .................................................................................. 672

Change Status Pop-up Window ..................................................................... 672Hiding an E-Commerce Process ....................................................................... 673Work with E-Commerce Queues Screen .......................................................... 674Change Image Paths Screen (Working with Default Image Paths) .................. 675

E-Commerce Item Availability ProcessingExtracting Item Availability Information to the EC Item Availability Table ......... 679

Item Availability Periodic Function ................................................................. 679Item Availability Web Threshold ..................................................................... 679What Item Availability Data is Included? ........................................................ 680

Extracting Item Availability Information with Stored Procedures ....................... 685What Item Availability Data is Included? ........................................................ 685

Downloading E-Commerce Static Tables (ESTF)E-Commerce Download Overview .................................................................... 690

Types of Downloads ....................................................................................... 690Periodic Functions Related to E-Commerce .................................................. 690Download Process ......................................................................................... 693Process E-Commerce Downloads Screen ..................................................... 693

Static Table Download Summary ...................................................................... 697

Downloading E-Commerce Offer Tables (EOFR)Process E-Commerce Downloads Screen ..................................................... 702

Offer-Related Table Extract Summary .............................................................. 706

Removing Offers and Items from Download (ERMV)Remove Offers and Items from Download Screen ......................................... 712

Sending Internet Order Ship Confirmation (ESCF)Send Internet Shipment Confirmations Screen .............................................. 717Stopping and Restarting Shipment and Return Confirmation Emails ............ 717

E-Commerce Tables


3/24/15 11

E-Commerce Static Tables ............................................................................... 720Company ........................................................................................................ 720Country ........................................................................................................... 720State .............................................................................................................. 720Payment type ................................................................................................. 721Personalization ............................................................................................... 721Personalization detail ..................................................................................... 721Personalization values ................................................................................... 721SCF/Ship via .................................................................................................. 722Shipping method ............................................................................................ 722Holiday arrival date ........................................................................................ 722Return reason ................................................................................................ 723Cancel reason ................................................................................................ 723SCF state ....................................................................................................... 723

E-Commerce Offer Tables ................................................................................ 724Offer .............................................................................................................. 724Source ............................................................................................................ 724Category: ........................................................................................................ 724Item category ................................................................................................. 724Class .............................................................................................................. 725Cross-Sell ....................................................................................................... 725Department .................................................................................................... 725Extra shipping ................................................................................................ 726Hazard ............................................................................................................ 726Item .............................................................................................................. 726Item break point ............................................................................................. 727Item image ..................................................................................................... 727Offer item link ................................................................................................. 728Offer SKU link ................................................................................................ 728SKU .............................................................................................................. 728SKU break point ............................................................................................. 729Upsell ............................................................................................................. 730Keyword: ........................................................................................................ 730Alias item ........................................................................................................ 730Item ship via override ..................................................................................... 730

E-Commerce B2B Static Tables ....................................................................... 731Individual department ..................................................................................... 731Individual position ........................................................................................... 731Price table item .............................................................................................. 731Source code/price table ................................................................................. 732Customer extension ....................................................................................... 733

Additional Downloads ........................................................................................ 734Item availability ............................................................................................... 734Gift certificate ................................................................................................. 734Ship exclusion ................................................................................................ 734


3/24/15 12

Document Type Definitions (DTDs)CWORDERIN .................................................................................................... 738CWORDEROUT ................................................................................................ 744CWCatRequest ................................................................................................. 748CWCatResponse .............................................................................................. 749CWOrderStatus ................................................................................................. 750CWStatusResponse .......................................................................................... 751CWReturn ......................................................................................................... 752CWReturnResponse ......................................................................................... 753CWCancel ......................................................................................................... 754CWInventoryDownload ..................................................................................... 755

3/24/15 13

E-Commerce OverviewNote: The rebranding for the latest version of this documentation set is in development

as part of post MICROS acquisition activities. References to former MICROS product names may exist throughout this existing documentation set.

The E-Commerce integration allows you to send data between CWSerenade and your web storefront. To set up the e-commerce integration you will need to understand:

• Types of E-Commerce Transactions: The types of transactions you can process between CWSerenade and your web storefront.

• E-Commerce Messages: The layout and description of each of the messages transmitted between CWSerenade and your web storefront.

• E-Commerce-Related Setup in CWSerenade: The setup in CWSerenade related to the e-commerce integration.

• E-Commerce-Related Jobs in CWSerenade: The jobs that run within CWSerenade to support the e-commerce integration.

• E-Commerce Tables: The database that is supplied with CWSerenade to be used with a web storefront.

• Document Type Definitions (DTDs): The layout of the DTD for each documented message.

Relate customer integration: If you use the Relate Customer integration along with the E-Commerce integration, any time you create or update a customer based on information received from the web storefront, CWSerenade sends the customer information to Relate so that the customer records in both CWSerenade and Relate remain synchronized.

CWSerenade 5.0 E-Commerce Overview

3/24/15 Types of E-Commerce Transactions 14

Types of E-Commerce Transactions

The E-Commerce integration supports the following transactions.

• E-Commerce Order Transaction

• E-Commerce Order Reject Transaction

• E-Commerce Catalog Request Transaction

• E-Commerce Order Status Transaction

• E-Commerce Return Transaction

• E-Commerce Cancel Transaction

• E-Commerce Customer Transaction

• E-Commerce Customer History Transaction

• E-Commerce Inventory Inquiry Transaction

• Item Availability API

• E-Commerce Inventory Download Transaction

• Generic Item Download API



E-Commerce Order Transaction

The e-commerce order transaction allows the web storefront to send order information to CWSerenade. CWSerenade processes the order information and, if all of the information is valid, creates an order.

Process used: You can use the generic order interface (Order API) to send order transactions into CWSerenade via CWIntegrate or directly from a remote system using the CWOrderIn web service or CWMessageIn web service. Your options through the generic order interface include:

• separate payment message: sending the payment information separately or in the same message as the rest of the order information.

• batching: sending a batch of orders in a single transaction or each order separately.

• deposit and refund suppression: suppressing the order from deposit processing and refund generation.

• returns: entering a return by specifying a negative order quantity.

• customer updates: updating or creating a sold to customer, bill to customer, individual, or permanent ship to customer.

• credit card tokenization: replacing the credit card number for the credit card payment on the order with a token provided by the service bureau if you use credit card tokenization.

• online credit card authorization: authorizing the credit card payment on the order.

• subsequent order information: sending a subsequent message not flagged for payment_only in order to delete an existing order and recreate it using the information provided in the inbound message. You can use this option if the first message for an order contained errors and you wish to send the corrected order information in the second message.

• order confirmation: generating an order confirmation email or CWEmailOut XML message.

Response returned? CWSerenade generates a response based on the response_type specified in the inbound message. The response_type can indicate to return:

• a detailed response message.

• a detailed response message listing any errors on the order.

• a summary response message.

• no response beyond a simple message indicating OK.

Errors: If there are any errors on the order, or if the order does not include payment information, CWSerenade places the order in an error status and the order ship to in a



suspended status. The order is retained in the Default Batch for E-Commerce Orders in Error (G41). However, if the order_channel is P and the order is not part of a batch, the system places the order in the Batch Number for Retail Channel Orders (I78) if it has errors.You can use batch order entry to review, work with, and approve these orders. When the order is accepted, the system clears the batch number from the order header if the batch number matches the system control value and the order displays in regular order maintenance and inquiry.

Messages used:

• Inbound Order XML Message (CWORDERIN)

• Detailed Order XML Response (CWORDEROUT)

• Order Acknowledgement XML Message (CWORDEROUT)

For more information: See:

• Generic Order Interface (Order API) for processing details.

• Order API Setup Requirements for the setup required for the generic order interface.

• Customer Creation, Matching and Update Logic in the Order API for more information on how the generic order interface selects and updates an existing customer and when the system creates a new customer.

• Order Creation Errors for a listing of the errors that can occur on an order received through the generic order interface.



E-Commerce Order Reject Transaction

The e-commerce order reject transaction allows the web storefront to send an order reject request to CWSerenade.

Process used: You can use the generic order interface (Order API) to send order reject transactions into CWSerenade using the CWOrderIn web service.

To be eligible for rejection through the reject message, the order must currently be in error and not have a payment method. The reject message needs to specify the company code and either the order number or order cross-reference number (web order number) for an existing order. For a multi-recipient order, the system rejects all recipients; you cannot reject a single order recipient.

Response returned? CWSerenade returns a simple response message indicating whether the reject request was successful (pass) or unsuccessful (fail), for example:

<Message>PASS</Message>

Message used: Order Reject Request Message (CWORDERREJECT)

For more information: See Rejecting the Order (Order API) for processing details.



E-Commerce Catalog Request Transaction

The e-commerce catalog request transaction allows a customer on the web storefront to send a catalog request to CWSerenade.

Process used: You can use the EC_CAT_REQ job, started through Work with E-Commerce Job Control (EJCT), to receive and create a catalog request when a customer enters the request on the web storefront. This job:

• receives and processes catalog requests for sold to or individual customers.

• creates the sold to customer or individual customer if the customer does not exist.

• updates the sold to customer or individual customer based on the information in the catalog request.

If the Edit for Duplicate Catalog Requests (E46) system control value is selected, the system checks for duplicate catalog requests, based on match code. If a duplicate catalog request exists, the system does not create the catalog request.

Response returned? If the response_returned in the catalog request is 1, the system sends a catalog request response back to the web storefront.

Errors: If the catalog request contains an error, the system places the catalog request in the Catalog Request Interface table. You can correct the error using the Work with Catalog Request Interface (WCRU) menu option.

Messages used:

• E-Commerce Catalog Request Message (CWCatRequest)

• E-Commerce Catalog Request Response Message (CWCatreqResponse)

For more information: See E-Commerce Catalog Requests for processing details.



E-Commerce Order Status Transaction

The e-commerce order status transaction allows the web storefront to request order summary information from CWSerenade. Typically, customers request order summary information before:

• cancelling an order or order line on an order.

• returning an order.

Process used: You can use the EC_STS_INQ job, started through Work with E-Commerce Job Control (EJCT), to receive and process an order status request from the web storefront. This job uses the company, sold to customer, order number, and optionally, individual or bill to customer to find the order.

Response returned? The response returned to the web storefront includes a status flag indicating whether the order is eligible for maintenance, and the quantity of each item that is eligible for cancellation, if any. Once the customer selects an order for review, all of the order ship-to detail is available for display on the web storefront.

If the customer is registered on the web storefront, the status response includes a listing of all the customer’s e-commerce orders and all ship-tos.

If the customer is not registered on the web storefront, the level of detail in the status response is based on the ship_to_details flag in the status request:

• If the ship_to_details flag is Y, the status response includes each ship-to on an order, so that the customer can review the items separately for each ship-to address.

• If the ship_to_details flag is N, the status response does not include the ship-to information; all items on the order display together regardless of ship-to address.

Messages used:

• E-Commerce Order Status Message (CWOrderStatus)

• E-Commerce Order Status Response Message (CWStatusResponse)

For more information: See E-Commerce Order Status Processing for processing details.



E-Commerce Return Transaction

The e-commerce return transaction allows a customer to create a return on the web storefront for specific item(s) on a shipped order.

Process used: You can use the EC_RETURNS job, started through Work with E-Commerce Job Control (EJCT), to receive and process a return from the web storefront.

This job confirms that each item is eligible for return; that is, the customer is not attempting to return more than the shipped, unreturned quantity. If the item can be returned, the system creates the return authorization for the order ship to.

Response returned? If the return request was successful and CWSerenade was able to create a return authorization, the system sends a return response to the web storefront. The response includes the return authorization number and the address to print on the return label. You can enable the customer to print a return label with the correct address for returning the shipment if the web storefront supports it.

Errors: If the request is unsuccessful and CWSerenade is unable to create the return authorization, the system does not return a return authorization number in the response.

Additional processing: You can use Work with Return Authorizations (WRTA) to complete the processing of the return once the returned item is received at your warehouse. Also, you can use this menu option to delete the return authorization if you are not completing the return.

Return confirmations: The system generates a return confirmation email or Outbound Email XML message (CWEmailOut) when you:

• process a return through billing if the Send Shipment Confirmation from Billing (L98) system control value is selected.

• generate return confirmations using the Send Internet Order Ship Confirmations menu option (ESCF).

• execute the ECSHCNF periodic function.

Messages used:

• E-Commerce Return Request Message (CWReturn)

• E-Commerce Return Response Message (CWReturnResponse)

For more information: See Creating Return Authorizations from the Web Storefront for processing details.



E-Commerce Cancel Transaction

The e-commerce cancel transaction allows a customer on the web storefront to submit a cancel request for a web order or specific line on a web order.

Process used: You can use the ECOMM_CANC job, started through Work with E-Commerce Job Control (EJCT), to receive and process a cancel request from the web storefront. This job:

• determines if the cancel request contains any errors.

• if no errors are found, processes the cancellation.

Response returned? CWSerenade does not send a response to the web storefront for a cancel request.

Errors: If the cancel request contains an error, the system creates a record in the Work with Batch Order Maintenance Transactions (WBOM) menu option and generates the E-Commerce Order Maintenance Errors Report. Based on the error, you can complete the requested transaction yourself or you might need to contact the customer for further information if the desired transaction is not clear. However, you cannot edit and resubmit the cancel request through the Batch Order Maintenance menu option. Once you have resolved the request through research, order maintenance, or customer contact, you should delete the related error record.

Order cancellation email: Depending on customer preference and setup, the system:

• generates a maintenance failure email if the cancellation attempt was unsuccessful.

• generates an order or order line cancellation confirmation email indicating that the cancellation attempt was successful.

Message used: E-Commerce Cancel Request Message (CWCancel)


• Working with Batch Order Maintenance Transactions (WBOM)

• E-Commerce Cancel Process Overview for processing details.

• Batch Order Cancel Errors for a list of errors.



E-Commerce Customer Transaction

The e-commerce customer transaction allows the web storefront to send new or changed customer information to CWSerenade.

Process used: You can use the CWCustomer web service or the CWMessageIn web service to process a customer transaction from the web storefront. With either web service, the type in the Inbound Customer message (CWCustomerIn) must be CWCustomerIn.

Response returned? CWSerenade generates a response to the customer transaction if the cst_send_response in the Inbound Customer message (CWCustomerIn) is set to Y.

Errors: If the Inbound Customer message (CWCustomerIn) contains an error, CWSerenade saves the information from the request in the Customer API Work table. If the request also includes email or user-defined field information, this additional information is stored in the Customer API E-mail Work table and the Customer API UDF Work table. You can use the Work with Customer API (WCAI) menu option to review, work with, delete, or resubmit customer requests that are in error.

Messages used:

• Inbound Customer Message (CWCustomerIn)

• Outbound Customer Response Message (CWCustomerOut)


• Generic Customer API for an overview.

• Customer API Setup for the setup required for the Customer API.

• Working with Customer API (WCAI) for more information on working with customer requests that are in error.



E-Commerce Customer History Transaction

The e-commerce customer history transaction allows you to provide a customer’s order history, or detailed information about a single order, to the web storefront.

The web storefront can request and receive information on:

• all orders for the customer, a limited number of the customer’s most recent orders, or a single order.

• all orders regardless of channel, such as e-commerce orders, or excluding a particular channel.

• all ship-to’s for a multi-recipient order, or a particular ship-to.

• detailed information that includes all items, payment methods, and ship-to’s on the order, or summary information about the header only.

Process used: You can use the CUST_HIST process, started through Work with Integration Layer Processes (IJCT), or the CWMessageIn web service, to process a customer history transaction from the web storefront.

Response returned?

• If the customer history request includes a customer number and not a specific order number, CWSerenade sends a customer history response to the web storefront with the most recent order information for the customer. The number_of_orders in the customer history request defines the maximum number of orders to include in the response. You should limit the number of orders to no more than 15 orders to prevent a negative effect on response time.

• If the customer history request includes a specific order number, CWSerenade sends an order inquiry response to the web storefront. If the send_detail flag in the customer history request is Y, CWSerenade sends a detailed order inquiry response to the web storefront; if the send_detail flag is N, CWSerenade sends a summary order inquiry response to the web storefront.

Errors: The CUST_HIST process sends an “empty” response to the web storefront when the request does not include sufficient valid data. The empty response indicates to the web storefront that CWSerenade received the request, but it was incomplete or invalid.

Messages used:

• Customer History Request XML Message (CWCustHistIn)

• Customer History Response XML Message (CWCustHistOut)

• Detailed Order Inquiry Response XML Message (CWORDEROUT)

• Summary Order Inquiry Response XML Message (CWORDEROUT)




• Generic Customer History API for an overview.

• Setup Requirements for the setup required for the Customer History API.



E-Commerce Inventory Inquiry Transaction

The e-commerce inventory inquiry transaction allows you to send current inventory information to the web storefront.

Process used: You can use the INV_INQURY process, started through Work with Integration Layer Processes (IJCT), to process an inventory inquiry request from the web storefront.

Response returned? The response includes information about the item/SKU, the warehouse(s) where it is stored, and current inventory levels such as the quantity on-hand, available, backordered, and so on.

Messages used:

• Inventory Inquiry Request XML Message (CWInventoryInquiry)

• Inventory Inquiry Response XML Message (CWInventoryInquiryResponse)

For more information: See Generic Inventory Inquiry API.



E-Commerce Inventory Download Transaction

The e-commerce inventory download transaction allows you to send inventory information from CWSerenade to the web storefront. When certain inventory conditions are met, CWSerenade creates an inventory download trigger in the IL Outbound Trigger table.

Process used: The Inventory Download job in Work with Integration Layer Processes (IJCT) monitors the IL Outbound Trigger table for inventory download triggers to process and generates an inventory download to send to the web storefront. The inventory download contains information on the item and SKU, any UPC codes, warehouse, and item warehouse, including the available quantity and other inventory levels, such as on-hand quantity.

Response returned? The web storefront does not send a response to CWSerenade when it receives an inventory download.

Message used: Inventory Download XML Message (CWInventoryDownload)

For more information: See Generic Inventory Download API for processing details.

3/24/15 27

E-Commerce MessagesThis section describes the XML messages between CWSerenade and the web storefront that support the e-commerce integration:

• Generic Order Interface (Order API)

• Rejecting the Order (Order API)

• E-Commerce Catalog Requests

• E-Commerce Order Status Processing

• Creating Return Authorizations from the Web Storefront

• Working with Batch Order Maintenance Transactions (WBOM)

• Generic Customer API

• Generic Customer History API

• Generic Inventory Inquiry API

• Generic Inventory Download API

3/24/15 Generic Order Interface (Order API) 28

Generic Order Interface (Order API)

Purpose: Use the generic order interface to send orders into CWSerenade via CWIntegrate or directly from a remote system. You can use this interface for any type of order, including retail point of sale transactions, orders received through a remote call center, and orders taken at a web storefront.

Options: Your options through the generic order interface include:

• response: generating a detailed response listing errors, a detailed response that does not list errors, a simple response, or no response.

• separate payment message: sending the payment information separately or in the same message as the rest of the order information.

• batching: batched or non-batched orders.

• deposit and refund suppression: suppressing the order from deposit processing and refund generation.

• returns: entering a return by specifying a negative order quantity.

• customer updates: updating an existing sold-to, or creates a new sold-to, bill-to, individual, or permanent ship-to customer.

Batch message processing: You can also process a file containing a batch of CWOrderIn messages by placing the file in a designated folder on a server.

In this topic:

• Order API Processing Overview

• Suppressing Deposits and Refunds• Batching Orders Through the Order API• Creating a Quote through the Order API• Processing a Return• Performing Credit Card Tokenization on Web Orders• Performing Online Credit Card Authorization on Web Orders• Creating Authorization History for Orders Authorized on the Web

• Typical Order Interface Scenarios

• Sending a Separate Payment Message

• Order API Setup Requirements

• Order API-Related System Control Values

• Customer Creation, Matching and Update Logic in the Order API

CWSerenade 5.0


• Customer Sold To Selection, Creation and Update• Creating or Selecting Shipping Addresses or Customers• Customer Bill To Selection and Creation• Individual Customer Creation and Selection

• Resolving the Item and SKU in the Order API

• User-Defined Fields in the CWOrderIn Message

• Selecting the Sales Rep

• Discounted and Added Items in the CWOrderOut Response Message

• Rejecting the Order (Order API)

• Order Interface XML Message Formats

• Inbound Order XML Message (CWORDERIN)• Inbound Order Message: Sample XMLs• Detailed Order XML Response (CWORDEROUT)• Detailed Order Response Message: Sample XML• Order Acknowledgement XML Message (CWORDEROUT)• Order Acknowledgement Message: Sample XML

CWSerenade 5.0


Order API Processing Overview

Typical process: A typical generic order interface process includes the following steps:

1. Receive message: The generic order API web service receives the Inbound Order XML Message (CWORDERIN) and sends it to the order API program.

2. Parse message: The order API program parses the message (identifies its components). If the message is not well-formed XML, or if any of the numeric fields passed exceed their maximum length, the program returns an error indicating the XML is invalid and does not continue.

3. Review header and customer: If the message passes the initial validation, the program begins identifying the information in the message, including:

• sold-to customer

• bill-to customer

• individual

The program performs much of the same processing that applies in interactive order entry, such as checks for duplicate customers. The program also processes other updates related to the order header, such as customer ownership and user fields. At this point, customer information is written to the database.

4. Review ship-to: The program continues processing the order ship-to information. If there is a separate shipping address for the order (permanent, order-level, or recipient customer), the information is processed at this time.

5. Review details and begin writing to database: The program processes the items on the order, as well as performing related calculations (pricing, freight, tax, and so on), and reserves available inventory. At this point the program writes all the header, ship-to, and detail data available to the database, setting the order header status to E (error) and the order ship-to status to S (suspended) pending further processing.Order cross reference: The program writes a record in the Order Cross-Reference table to track the CWSerenade order number and the web order number. This step is necessary for situations when the initial inbound message does not include all required information for the order, such as when payment information is sent separately from the header and details; the order cross reference enables the program to determine which order to update. The EC_CLEANUP job also uses the order cross reference when it deletes abandoned orders.

6. Review additional order data: The program processes additional information, such as coupons, special handling, and detail message, once the items are identified, and updates the database.

CWSerenade 5.0


7. Repeat for additional ship-tos: The previous three steps are repeated for each separate ship-to for the order.

8. If payment is sent (non-batch): If the message includes any payment information and the order is not part of a batch, the program:

• processes and saves the payment method(s) to the database, using encryption as specified for your company.

• performs normal end-of-order processing, such as repricing, adding promotional inserts, and credit checking.

• looks at the setting of the Delay Order API Edit (I56) system control value to determine how to submit the order API edit.

• If selected, the system performs the order edit in asynchronous sequence, or in parallel with the remaining order processing. In this situation, the system continues with order processing and will generate the response message before the order edit completes. The order will remain in an error status and the order ship-to in a suspended status until the order finishes processing through the asynchronous order edit.

• If unselected, the system performs the order edit in synchronous, or interactive, sequence.

• generates the response message based on the response_type specified in the inbound message. The response_type can indicate to return:

• a detailed response message• a detailed response message listing any errors on the order• a summary response message• no response beyond a simple message indicating OK

CWSerenade 5.0


• after performing the order edit:

• if there are no errors and the Quote field for the order type is unselected, the program puts the order in open or held status, deletes the Order Cross-Reference record, and submits the order to the order async job.

• if there are no errors and the Quote field for the order type is selected, the program puts the quote in a quote status and deletes the Order Cross-Reference record. The system does not submit the quote to the order async job since background updates are not performed on a quote until it is converted to an order.

• if there are any errors, the program leaves the order in error status and the order ship-to in suspended status. (Note: The ship-to status is the status displayed in standard order inquiry.)

• if the inbound order is a duplicate of an existing order and the Reject Duplicate Web Orders (K64) is selected, the order API program checks for a duplicate order with payment and discards it. A response message is returned indicating the order is a duplicate.

• determines if the order qualifies for pick slip preparation.

Orders in error: If the order does not pass the edit, or if it does not include payment information, it is retained in the Default Batch for E-Commerce Orders in Error (G41). However, if the order_channel is P and the order is not part of a batch, the system places the order in the Batch Number for Retail Channel Orders (I78) if it has errors. You can use batch order entry to review, work with, and approve these orders. When the order is accepted, the system clears the batch number from the order header if the batch number matches this system control value and the order displays in regular order maintenance and inquiry.

CWSerenade 5.0


9. If payment is not sent on a regular order or if the order is identified as a batch order: If the message does not include payment information or is part of an order batch, the program puts the order through the order edit process based on the response_type specified in the inbound message:

• If the response_type is E, indicating to include information on errors in the response message, the program performs the order edit and returns the response message. The setting of the Delay Order API Edit (I56) system control value determines whether the system submits the order API edit in synchronous or asynchronous sequence.

• If the response_type is a value other than E, the program generates the type of response requested (detailed, acknowledgement, or none) and waits to receive an additional message before performing the order edit and attempting to complete the order.

Since there are no payment methods on the order, the order remains in an error status.

Batch orders remain in suspended status until you use batch order entry to edit and approve the batch.

If payment is not sent on a quote: If the message does not include payment information and the Quote field for the order type is selected, the program looks at the setting of the pay_incl tag in the message.

• If the pay_incl tag is N, the system places the quote in an error status and waits for a second CWOrderIn message that includes the payment information to complete the quote. If a second message is not received, you will need to correct or delete the incomplete quote in batch order entry.

• If the pay_incl tag is Y, the system looks at the Pay method required field for the order type.

• If the Pay method required field is selected, the system requires a pay method on the quote. If a pay method is not defined, the system places the quote in an error status. You will need to correct the quote in batch order entry.

• If the Pay method required field is unselected, the system does not require a pay method on the quote and continues with regular processing.

CWSerenade 5.0


10. If an additional message is received: You can send subsequent messages to complete an order with payment information or update an order with errors:

• If the subsequent message is flagged payment_only, the program adds the payment information to the order and submits it to the same processing as if the order had been submitted in a single message.

• If the subsequent message is not flagged payment_only, then the program deletes the existing order and recreates it using the information provided in the inbound message. As a result, it is important that the subsequent message include all information required to complete the order, or the information that was not included in the subsequent message will be lost.

Note: The program identifies the order based on the record in the Order Cross Reference table.

11. If an order remains incomplete: If the order does not include payment information, it is eligible to be deleted by the EC_CLEANUP job once the Time Limit for Suspended E-Commerce Orders (G43) has passed.

Note: Because a quote does not reserve inventory and may not require a payment method, the EC_CLEANUP job does not include quotes. You will need to manually delete quotes that are incomplete in batch order entry.

12. Generate order confirmation email? If the order is not in suspended status because of errors, it is eligible to generate an order confirmation email or CWEmailOut XML message based on the criteria described under When Does the System Generate an Email Notification?. If the order has errors, then the Suppress Order Confirmations for Orders in Error (K09) system control value indicates whether to generate the order confirmation or CWEmailOut message, or wait until you correct the order and it is processed by the ORDR_ASYNC background job.

Generate quote confirmation email? If the Quote field for the order type is selected and the quote is not in suspended status because of errors, it is eligible to generate a quote confirmation email or CWEmailOut XML message based on the following criteria:

• The Quote field and Email notification field for the order type on the quote are selected, and

• The Opt in/out setting for the sold to customer on the quote is O1 or O2, and

• An email address is defined for the quote or sold to customer.

Note: The system does not generate an order confirmation for a quote until it is converted to an order.

CWSerenade 5.0


Logging: The order API program writes the inbound and outbound messages, plus any errors, to the ORDER.log file, depending on your logging level.

Features not supported: Interactive order entry features that require the operator to make a selection from a pop-up window are typically not supported through the generic order interface. For example, the following are not supported:

• variable sets

• telemarketing specials

• item comments

For more information: See Discounted and Added Items in the CWOrderOut Response Message for a listing of discount and free gift options, indicating whether the order API supports them.

Also, certain individual features, such as specifying an individual originator in addition to an individual placer, are not currently supported through the order API.

Set and continuity items: To include a set (other than a variable set) or continuity item on an order created through the generic order API, the inbound order message should include the master set or continuity item only, and none of its components. The set or continuity item is “exploded” once the order is created, adding all of the components to the order just as it would in interactive order entry.

Zone reservation items: If an item is subject to zone reservation, the system applies the standard or alternate zone reservation rules based on your setup. However, if the zone reservation rules that apply to the item would normally display the Select Order Line Option window in order entry, the system always adds the item as a future order. See the CWSerenade online help for a complete discussion.

Suppressing Deposits and Refunds

You can use the suppress_deposit_flag and the suppress_refund_flag to suppress processing of deposits and refunds for orders you receive through the generic order interface. For example, it might not be appropriate to process a deposit or generate a refund for a retail outlet order if the transactions have already taken place at the store.

What happens when you set these flags? When the system creates the order, it sets the corresponding flags for the Order Payment Method. You can review the settings of the Suppress refund and the Suppress deposit flags at the Display Order Pay Type screen (1 of 2) in order entry.

Note: Regardless of the setting in the message, the Suppress deposit flag for the order payment method is selected only if the payment method is a credit card.

Suppressing the deposit: If the suppress_deposit_flag is selected in the message, the first time you bill a shipment against the payment method, the system sets the Suppress deposit flag for the Invoice Payment Method to selected. This setting prevents

CWSerenade 5.0


the invoice payment method amount from being included the next time you use Process Auto Deposits (SDEP) for the related authorization service.

Note: Once the system has billed the first shipment against an order payment method, it sets the Suppress deposit flag for the payment method to unselected. Future shipments against the payment method will be eligible for deposit.

Suppressing refunds: If the suppress_refund_flag is selected in the message, the system prevents a refund from being generated. If you generate a refund for the order, the refund is created in a status of N (cancel pending). When you use Processing Refunds (MREF), the refund status changes to C (canceled).

You cannot change the setting of the Suppress refund flag for a payment method, and the system will never generate a refund for the order payment method. In order to generate a refund, you need to deactivate the payment method and enter a new one; however, you will need to process any cancel-pending refund for the payment method before you can deactivate the payment method on the order.

Batching Orders Through the Order API

You can receive batched orders through the Inbound Order Message. The following attributes in the message control batching:

• batch_number: Must be a number that has not yet been used for an order batch. When the system receives the beginning order for a batch it confirms that the batch number does not exist in the Used Phone Batch table; however, the order API assigns a different batch number in CWSerenade.

Note: All orders that come in with the same batch_number are assigned to the same batch.

• batch_date: Indicates the date of the batch, as displayed at the Work with Order Batches screen in order entry.

• batch_beg_end_flag: The first order in the batch should have this flag set to B. The last order in the batch should have this flag set to E. Otherwise, leave the field blank.

• batch_order_count: Indicates the number of orders in the batch, as displayed at the Work with Order Batches screen in order entry. The batch will be out of balance if the number of orders received for the batch is not the same as this value.

• batch_qty_count: The total order line quantity of all orders in the batch, as displayed in the # of units field at the Change Order Batch screen in order entry. The batch will be out of balance if the total number of units is not the same as this value.

• batch_prepaid_total: The total prepaid dollar amount for the batch, used if you are batching cash.

Required values for orders in the batch: When sending batched orders, complete the following attributes in the Inbound Order Message:

CWSerenade 5.0


• First order:

• batch_number• batch_date• batch_beg_end_flag = B• batch_order_count• batch_qty_count• batch_prepaid_total (if you use cash batching)

• Last order:

• batch_number = same as first order• batch_beg_end_flag = E

• All other orders: batch_number = same as first order

Editing and approving the batch: Select Edit/Accept on the Work with Order Batches screen in order entry to edit and approve the batch. Even if the batch is error-free, you will still need to approve it manually.

Important: Each order, including batched orders, must have a unique order_number to avoid errors in creating and processing.

Note: You should stop and restart the background jobs and the ORDER_IN process after changing any order-related system control values.

Creating a Quote through the Order API

The system considers an order received through the order API a quote if the Quote field for the order type on the order is selected. In this situation, the system performs the same validations as it does for a regular order and also validates that the quote is a valid quote.

You can send a quote through the order API using the one-pass or two-pass option.

If the message does not include payment information and the Quote field for the order type is selected, the program looks at the setting of the pay_incl tag in the message.

• If the pay_incl tag is N, the system places the quote in an error status and waits for a second CWOrderIn message that includes the payment information to complete the quote. If a second message is not received, you will need to correct or manually delete the incomplete quote in batch order entry.

• If the pay_incl tag is Y, the system looks at the Pay method required field for the order type on the quote.

• If the Pay method required field is selected, the system requires a pay method on the quote. If a pay method is not defined, the system places the quote in an error status. You will need to correct the quote in batch order entry.

CWSerenade 5.0


• If the Pay method required field is unselected, the system does not require a pay method on the quote and continues with regular processing.

CWOrderOut Response message: The CWOrderOut Response message for a quote does not include any item availability information since the system does not reserve inventory on a quote.

Quotes that fail web order validation: If a quote received through the order API fails validation, the system treats the quote the same as a regular order: The system updates the Status of the quote to E (Error) and places the quote in the e-commerce error batch. You can review the quotes in error on the Work with Orders within a Batch screen in order entry.

The system performs the following validation specifically for quotes:

• The quote cannot contain an express-bill ship via: Invalid Ship Via.

• The quote cannot contain a negative order line: Price cannot be negative.

• The quote cannot contain more than one ship to customer. If more than one ship to customer is defined, the system assigns the first ship to customer to the quote and ignores any other ship tos that are passed in the message.

• The quote cannot contain a cash/check pay type: Invalid Pay Type.

Quote confirmation: When a quote is created through the order API, the system sends a Quote Confirmation email if:

• The quote passes web order validation, and

• The Quote field and Email notification field for the order type on the quote are selected, and

• The Opt in/out setting for the sold to customer on the quote is O1 or O2, and

• An email address is defined for the quote or sold to customer.

See Quote Confirmation Email Sample and Contents for a sample.

Quote form: The system does not automatically print a quote form for a quote received through the order API. You can print a quote form for the quote through the Print/Email Quote window.

• Quote maintenance, cancellation, and conversion: The order API allows you to create new quotes; you cannot maintain, cancel, or convert a quote to an order using the order API. These functions are available in CWSerenade.

Processing a Return

You can use the generic order interface to process a return by specifying a negative order line quantity.

CWSerenade 5.0


Other information used to process a return (see the descriptions of each attribute in the Item element for a complete description of each):

• line_warehouse: indicates the warehouse where the returned merchandise is placed. There must be a record of the item in this warehouse, or the order will be in error with a reason of Item not valid for whs.

• location: indicates the location where the returned merchandise is placed. If the item has not been previously placed in this location, the system creates an Item Location record.

• return_reason: Used to track the return; use the Display Order Line History screen in order inquiry to review the return reason code used for an order detail line.

• return_disposition: Used to indicate how to process the return. If the message does not specify a valid return disposition value, the system uses the return disposition code defined in the Default Disposition Code (C18) system control value. Note: The system uses this return disposition code to determine whether the return updates inventory and the warehouse and location to which the item is returned; however, the system does NOT store this return disposition on the RA Detail record.

Return processing: The system uses the same general rules for processing a return as when you use the Enter Return/Exchange Reason window in order maintenance or return authorizations. When you process a return through the generic order interface, it does not generate an order confirmation email, although it might generate a return confirmation email. See Working with E-Mail Notification Templates (WEMT) for more information on email generation and logic.

Return authorization download triggers: If the Create Return Download Triggers (K28) system control value is selected, the system creates a return authorization download (RAD) trigger when you post a return using the generic order interface, based on the trigger rules defined for the Return Authorization Download (RETURN_OUT) integration layer job. The RETURN_OUT integration layer job monitors for return authorization download triggers and generates a Return Authorization Outbound XML message (CWReturnRAOut) to send the return authorization information to a remote system.

Performing Credit Card Tokenization on Web Orders

Credit card tokenization allows you to replace the credit card number with a token provided by the service bureau.

CWSerenade calls the tokenization process for a web order if the Use Credit Card Tokenization (L18) system control value is selected, the Request token field for the service bureau defined for the pay type is selected, the Card type for the pay type is C Credit Card, and the already_tokenized tag for the credit card payment in the Inbound Order XML Message (CWORDERIN) is N or blank.

CWSerenade 5.0


Performing Online Credit Card Authorization on Web Orders

Online credit card authorization allows you to send and receive the information required to authorize a credit card at the time the order is placed instead of at the time the pick slip is generated for the order.

The system performs online authorization when CWSerenade receives the web order after determining if the order should go on hold, applying any discounts and promotions to the order, and performing credit card tokenization. If the order is placed on hold, the system does not perform online authorization for the web order; the order will go out for authorization during batch order entry.

If the order is eligible to receive a credit card authorization during order entry, the system sends the amount requiring authorization to the service bureau and waits for a response.

The service bureau sends back a response code, authorization code, AVS response code (if you are performing AVS verification), CID response code (if you are performing credit card identification verification), and date. Also, if a hold reason code has been defined for the vendor response received, the system places the order on hold.

Note: In order to perform online authorization on web orders, the Online Authorization setting for the order type on the web order must be set to Without Window.

Credit cards requiring authorizations less than $1.00: If the credit card amount to authorize is less than $1.00 and the Authorization Number for Authorizations Under $1.00 (I08) system control value specifies an authorization number, the system does not send the credit card to the service bureau for authorization; instead, it assigns the authorization number from the system control value. If the system control value is blank, the system sends the credit card to the service bureau for authorization, regardless of the amount that requires authorization.

Performing Online Verification Only: If the Online Auth Verification Only (I96) system control value is selected, the system processes online authorizations for $1.00 for the purpose of validating the card. During batch authorizations, the system authorizes the card for the shippable dollar amount and voids the online authorization for $1.00.

Creating Authorization History for Orders Authorized on the Web

CWSerenade creates an authorization history record with a status of A (Approved) for an order that received an approved credit card authorization on the web storefront if an auth_number and auth_amount are defined for the credit card payment on the order. If an auth_date, transaction_id, vendor_response, avs_response, or cid_response is defined for the credit card payment, the system also updates the authorization history record with this information.

If an authorization amount is not defined: If an auth_number is defined for the credit card payment but an auth_amount is not defined, the system:

CWSerenade 5.0


• creates the authorization history record with a status of D (Declined) since an authorization amount was not defined.

• During pick slip preparation, the system creates a new authorization history record in a G Generated status, using the information from the declined authorization and the Total Order Amount on the Pick Control Header as the authorization amount. If an auth_date is not defined, the system defaults the current date to the manual authorization. Once a pick associated with a manual authorization is printed, the system updates the status to A Authorized. However, during pick slip generation, if the approved authorization amount is less than the amount required during pick slip generation, the credit card payment will go out for batch authorization for the difference.

If an authorization date is not defined: If an auth_number and auth_amount is defined for the credit card payment but an auth_date is not defined, the system creates the authorization history record with a status of A (Approved) and defaults the current date as the authorization date.

If an authorization number is not defined: If an auth_number is not defined for the credit card payment, but an auth_date, auth_amount, transaction_id, vendor_response, avs_response, or cid_response is defined, the system:

• does not create an authorization history record.

• if the order is eligible for online authorization, the system sends the credit card payment to the service bureau for authorization and creates an authorization history record based on the results returned for the service bureau. See Performing Online Credit Card Authorization on Web Orders.

• if the order is not eligible for online authorization, the system sends the credit card payment to the service bureau during batch authorization. See Using Batch Authorization in the Online Help.

Vendor response processing: Before the order is accepted and placed in an open status, the system:

• Looks at the CC Vendor Response table for the authorization service defined for the credit card payment method to find a match to the vendor_response, avs_response, and cid_response from the authorization service. If the response is associated with a hold reason, or the vendor_response, avs_response, or cid_response does not exist in the CC Vendor Response table, the system:

• places the order on AT Declined Credit Card hold.• places the payment method on the hold reason defined in the CC Vendor

Response table. If the response does not exist in the CC Vendor Response table, the system places the payment method on AV Invalid Response Code hold.

• If the credit card is approved, but is placed on AVS or CID hold, updates the status of the authorization history record to O Authorized But Not Used.

See Hierarchy for Placing the Credit Card On Hold in the Online Help.

CWSerenade 5.0


• If an entity dollar limit by item class or postal code is defined for the response code, the system:

• places the order on hold using the hold reason defined for the entity dollar limit if the authorization amount exceeds the dollar limit. See Vendor Response Processing above for the updates the system performs.

• releases the order from AVS hold if the authorization amount is less than the dollar limit.

See Entity Setup in the Online Help for an overview.

Note: If the order fails web validation, the system places the order in an error status in batch order entry; in this situation, the system determines if the order should be placed on hold for the response code received from the authorization service when you edit and accept the order batch.

Viewing authorization history: You can review authorization history for an order on the Display Authorization History screen in Order Inquiry.

Expired authorizations: If the authorization for the web order has expired by the time you run pick slip generation for the order, the system will resend the credit card payment method to the service bureau for authorization during pick slip generation.

Transaction ID in deposit transactions: If a transaction ID is defined for an authorization history record, the system includes the transaction ID in the deposit transaction to provide a link between the authorization and deposit transaction.

CWSerenade 5.0


Typical Order Interface Scenarios

Some typical uses of the generic order interface are described below. Additional information on setup and specific values in the Inbound Order XML Message (CWORDERIN) are provided later in this topic.

Retail point-of-sale transaction: In this example, you receive sale information from a retail location. It is not necessary to send an acknowledgement, reserve or ship inventory, or process deposits. The typical inbound order message scenario includes:

• messages are sent in batch at a scheduled time each day

• no acknowledgements are necessary

• payment information is included for each order and not sent in a separate message

• the item number might not be included in the message; instead, a related value, such as a product ID, is used to look up the item

• order lines do not affect inventory, an express-bill ship via is used and the retail warehouse represents the store

• order lines are not repriced in CWSerenade; the pricing provided in the message is used

• no upselling or promotions apply

• deposits and refunds are suppressed

• if an order is prepaid, the payment amount is the same as the order total (to prevent refunds from being generated)

• when setting up the process queue for these orders, it is not necessary to create multiple inbound sessions

Note: If an express-billed order includes an A/P payment method, the order might briefly go into held status before it is processed by billing and its status changes to closed.

Remote order entry service: In this example, you receive orders that were entered at a remote call center. It is not necessary to acknowledge the order, although you must perform all normal order processing. The typical remote order entry message scenario is similar to the retail point-of-sale information, except:

• a regular ship via, rather than an express-bill ship via is used; order lines do affect inventory

• deposits or refunds are not suppressed

• if an order is prepaid, the actual check amount is indicated

CWSerenade 5.0


E-commerce order: In this example, you receive orders entered by customers at your web storefront. It is necessary to acknowledge the order and perform all order processing, such as shipment and deposits, just as if you had taken the order by phone or mail. The typical inbound order message scenario includes:

• orders are sent interactively, not in batch

• CWSerenade item information has been downloaded to the web storefront, so the item and SKU code is included in the message

• promotions and discounts can be offered as long as they do not require pop-up windows

• payment information for an order might be included in one message, or sent in a separate message (see Sending a Separate Payment Message)

• when setting up the process queue for these orders in Integration Layer Job Control (IJCT), you might create multiple inbound sessions to avoid delays for customers at your web storefront

• if the Reject Duplicate Web Orders (K64) system control value is selected, the system matches the order_number field of the inbound message to the e-commerce order number in the Order Header Extended table. If they match and both orders contain payment information, the order is discarded as a duplicate.

Sending a Separate Payment Message

You can receive the entire order in a single message, or receive the payment information in a separate message from the rest of the order. You might want to receive the payment information separately if you are processing orders from your web storefront; in this situation, receiving the payment information separately allows you to first generate a detailed order acknowledgement listing all of the information received to date from the web storefront, including availability and non-payment related discounts, so you can display this information to the customer before requiring entry of payment.

What does the initial order message consist of? When the payment information will be received after the rest of the order, the initial order message includes all of the typical header-level and detail-level information except the Payments element, and the Header element includes:

• payment_only: set to N

• response_type:

• set to D to generate the Detailed Order XML Response (CWORDEROUT) without listing any errors found on the order;

• set to A to generate the Order Acknowledgement XML Message (CWORDEROUT);

• pay_incl: set to N

CWSerenade 5.0


What does the payment-only order message consist of? The payment-only message includes the Message element, the Payments element, plus the following attributes in the Header element:

• company_code

• one or both of the following:

• rdc_order_nbr: the CWSerenade order_id, which is included in the order response message

• order_number: the order number identifying the order in the external system (the e-commerce order number or cross-reference number.

See below for more information on how CWSerenade identifies the order.

• payment_only: set to Y

• response_type:

• set to D to generate the Detailed Order XML Response (CWORDEROUT); • set to E to generate the Detailed Order XML Response (CWORDEROUT), listing

errors found on the order;• set to A to generate the Order Acknowledgement XML Message

(CWORDEROUT)• set to N to not generate a response

• pay_incl: set to Y

Note: If the Reject Duplicate Web Orders(K64) system control value is selected, sending payment as described above does not result in the order being considered a duplicate.

What if CWSerenade cannot identify the order? To identify the order when it receives the payment-only message, the order API uses the following rules:

• Match on CWSerenade order number?

• If the message includes both the rdc_order_nbr (CWSerenade order number), apply the payment to the order that matches the specified order number. In this situation, even if the message includes the order_number (e-commerce order number or cross-reference number), but it does not match the order cross-reference assigned to the CWSerenade order, the order API can still apply the payment to the correct order.

• If there is an order that matches the rdc_order_nbr, but it already has a payment method, return the regular response message based on the response_type, as described above; however, in this situation, the order API does not update the order.

• Match on e-commerce order number?

CWSerenade 5.0


• If no order matches the rdc_order_nbr, or if the rdc_order_nbr is not included in the message, apply the payment to the order that matches the order_number (e-commerce order number or cross-reference number).

• If there is no order that matches the order_number, or if the matching order already has a payment method, return the error: <Message>Error: The order could not be located.</Message>

CWSerenade 5.0


Order API Setup Requirements

Overview: In addition to the setting of any Order API-Related System Control Values, the setup required for the generic order interface consists of the following.

CWOrderIn Web Service

The CWOrderIn web service allows an external system to post the Inbound Order XML Message (CWOrderIn) directly to CWSerenade and receive responses without the need of any queues.

Web service authentication? The Require_Auth field in the Webservice table defines whether the web service requires basic web service authentication.

If you are using the CWOrderIn RESTful web service: You POST inbound CWOrderIn messages to the web service’s URI, or endpoint, of the RESTful service. The individual URL for the CWOrderIn RESTful service uses the following format: http://server:port/SerenadeSeam/sxrs/application/CWOrderIn, where server:port identifies the application server where the RESTful service is located and CWOrderIn is the name of the web service to call.

If you are using the CWOrderIn SOAP-based web service: The endpoint specified in the CWOrderIn.wsdl file is where you need to post messages in order for the CWOrderIn web service to process them. The endpoint is typically set to http://server:port/CWDirectCPService/services/CWOrderIn, where server:port identifies the application server where the wsdl is located and CWOrderIn is the name of the web service to call.

The CWOrderIn web service requires that inbound messages be embedded in SOAP envelope tags. A sample XML message embedded in a SOAP envelope is presented below.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dom="http://dom.w3c.org"> <soapenv:Header /> <soapenv:Body> <dom:performAction type="xsd:string"> <![CDATA[

<Message source="String" target="String" type="CWORDERIN" > <Header company_code="6" order_number="ABCDE" payment_only="N" nbr_ship_tos="1" pay_incl="Y" source_code="SOURCE" response_type="E" order_channel="I" sold_to_fname="Eddie" sold_to_lname="Conga" sold_to_address1="10 Main Street" sold_to_city="NATICK" sold_to_state="MA" sold_to_zip="01760" sold_to_country="USA" order_type="W" >

<Payments> <Payment payment_type="45" cc_number="7777567890123456" start_date="0108" card_issue_nbr="2" />

</Payments> <ShipTos>

<ShipTo shipping_method="04" customer_ship_to_number="13163" ship_to_type="3" permanent_ship_to_number="1" discount_pct="5.00" ship_to_po_number="PONBR" >

CWSerenade 5.0


<Items> <Item quantity="10" item_id="AB100" > </Item>

</Items> </ShipTo>

</ShipTos> </Header>

</Message>

]]></dom:performAction></soapenv:Body></soapenv:Envelope>

CWMessageIn Web Service

You can use the CWMessageIn web service to route Order In messages. In this situation, the target for each inbound message must match the Inbound program name for the integration layer process queue, as specified at the Integration Layer Process Queue screen.


If you are using the CWMessageIn RESTful web service: You POST inbound CWMessageIn messages to the web service’s URI, or endpoint, of the RESTful service. The individual URL for the CWMessageIn RESTful service uses the following format: http://server:port/SerenadeSeam/sxrs/application/CWMessageIn, where server:port identifies the application server where the RESTful service is located and CWMessageIn is the name of the web service to call.

If you are using the CWMessageIn SOAP-based web service: The endpoint specified in the CWMessageIn.wsdl file is where you need to post messages in order for the CWMessageIn web service to process them. The endpoint is typically set to http://server:port/CWDirectCPService/services/CWMessageIn, where server:port identifies the application server where the wsdl is located and CWMessageIn is the name of the web service to call. The CWMessageIn SOAP-based web service requires that inbound messages be embedded in SOAP envelope tags.

ORDER_IN Process and Process Queues

If you integrate with external systems that require reading from or writing to queues, use Integration Layer Job Control (IJCT) to set up the ORDER_IN process and create a process queue for each order channel, such as a web site or a remote order entry service.In this situation, each process queue monitors a separate queue for incoming messages.

Note: Creating the process queues is not required if you receive and send messages using the ORDER_IN web service (default setting).

Message version: Use the Integration Layer Job Control (IJCT) to specify the version of the outbound CWORDERDEROUT response message to generate.

CWSerenade 5.0


CWIntegrate site: The ORDER_IN process must receive a correctly formatted XML Inbound Order XML Message (CWORDERIN). You can use the CWIntegrate cw_store site to translate incoming orders into this format and send the resulting messages to CWSerenade. See the CWSerenade/CWStore integration manual for more information.

Default User for ORDER_IN

Your default user is used to determine secured feature authority and the default Entered by user to write to the Order Header.

Used how?

• Each time the order API receives an order that is in error, it generates a copy of the Order Error Listing report. You can review the generated reports by advancing to the Document Management screen for your default user.

• Your default user is the Entered by user on the Order Header if the CWOrderIn message does not specify an entered_by_user.

• The authority settings of your default user control some of the edits that apply to the order API:

• your default user’s authority under the Override Price Override Limit (A64) controls whether to put an order in error status when it exceeds the Price Override Limit Percent (E55).

• your default user’s authority under the Allow Maximum Order Line Value Override (A69) controls whether to put an order in error status when it exceeds the Maximum Order Line Value (E98).

• your default user’s authority under the Allow Maximum Order Quantity Override (A70) controls whether to put an order in error status when it exceeds the Maximum Order Quantity (C60).

CWSerenade 5.0


Order API-Related System Control Values

Overview: Most system control values that affect interactive order entry also control the generic order interface. Please note the following values whose function in the generic order interface differs from regular order entry.

System Control Value Function in Generic Order Interface

Create/Assign Bill To Customers in Order Entry (A76)

Having this system control value unselected does not prevent you from specifying an existing bill-to in the message and assigning it to the order.

Dynamic Creation of Coupons (B21)

If you specify a coupon number that does not match a record in the Coupon Redemption table, the system creates a coupon or credit payment method on the order; however, if this system control value is not selected, the order will be in error because of an Invalid coupon.

PO Required for A/R Orders (D79)

Indicates whether a PO number is required for an order that uses an accounts receivable payment method.

Verify Duplicate PO Numbers for A/R Orders (D80)

Indicates whether to prevent a sold-to customer from using the same PO number more than once on different orders.

Individuals Required in Order Entry (E01)

Indicates whether an individual is required on orders you create through the order API. If this system value is selected and there is no individual specified on the order, the order goes into error status with the error message Placer Invalid.

Default Source for Internet Orders (E65)

If no source code is specified at the header or on a detail line in the message, this value defaults.

Require Salesrep Number in Order Entry/Order Maintenance (E87)

When this value is selected, the order will be in error if the system cannot resolve the sales rep.

Phone Interface Values (F70) The system uses these values when matching a sold-to customer.

Get Orders from E-Commerce (G35)

When this value is selected, the EC_CLEANUP job purges “abandoned” (partially created) e-commerce orders after the Time Limit for Suspended E-Commerce Orders (G43) has elapsed.

CWSerenade 5.0


E-Commerce Order Type (G42)

If no order_type is specified in the message, the system uses this value. Also, the system uses this system control value to identify e-commerce orders for the purposes of email generation, putting the order on hold based on the Maximum Order Amount for E-Commerce Orders (H54), and cleanup of suspended (“abandoned”) orders.

Time Limit for Suspended E-Commerce Orders (G43)

Defines the number of minutes to wait before an “abandoned” (partially created) order is eligible for cleanup.

Default Batch for E-Commerce Orders in Error (G41)

Any order API orders in error are assigned to this batch number, so that you can correct them through batch order entry.

Order Acknowledgement Program (G50)

The program to use for generating order acknowledgment emails.

Shipment Confirmation Program (G51)

The program to use for generating shipment confirmation emails.

Price Override Reason for E-Commerce (G73)

The price override reason code to use if you process price overrides on order API orders.

Backorder Notification E-Mail Program (G95)

The program to use for generating backorder notice emails.

Soldout Notification E-Mail Program (G96)

The program used to generate soldout notification emails.

Default Opt In/Opt Out Flag (G97)

The default Opt in/Opt out setting to use when creating a new customer, indicating the customer’s preferences regarding contact by email.

Gift Certificate E-Mail Program (H07)

The program used to create gift certificate emails.

Credit Card Credit Acknowledgement E-Mail Program (H08)

The program used to create credit card credit acknowledgement emails.

Default Salesrep for E-Commerce Interface (H24)

The salesrep number to default to e-commerce orders if the Require Salesrep Number in Order Entry/Order Maintenance (E87) system control value is selected. See Selecting the Sales Rep.


CWSerenade 5.0


E-Mail Order Confirmations for All Orders (H51)

Defines whether CWSerenade sends an email confirmation when any order is accepted or only when a customer on the web storefront accepts an order.

E-Mail Shipment Confirmations for All Orders (H52)

Defines whether CWSerenade sends an email confirmation when any order or return is shipped or only when an e-commerce order or return is shipped.

Return Confirmation E-Mail Program (H53)

The program to generate email, rather than printed, return confirmations.

Maximum Order Amount for E-Commerce Orders (H54)

Orders that exceed this merchandise total go on EH hold.Note: The Maximum Order Amount (A92) system control value does not put generic order interface orders on hold; however, you must specify an amount for this system control value in order for evaluation based on the Maximum Order Amount for E-Commerce Orders (H54) to take place in the order API.

Delay Order API Edit (I56) Indicates whether the order edit and accept runs interactively or asynchronously for orders received through the Generic Order Interface (Order API).

Batch Number for Retail Channel (I78)

If the order_channel is P and the order is not part of a batch, the system places the order in this order batch if it has errors. You can correct the errors in batch order entry.


CWSerenade 5.0


Default Individual Email Address (J17)

Controls whether the system defaults the individual email address to the Order email address field on an order.The system uses the following hierarchy in updating the order-level email address when creating orders through the Generic Order Interface (Order API):• If an order_email is specified in the Inbound Order Message, use that email address; otherwise,• If there is an email address specified for the individual placer (either specified in the ind_email_address in the message, or an existing email address for the individual), and the Default Individual Email Address (J17) system control value is selected, use that email address; otherwise,• If there is an email address specified for the sold-to customer (either specified in the sold_to_email in the message, or an existing email address for the customer), use that email address; otherwise,• Leave the order-level email address blank.

Suppress Order Confirmations for Orders in Error (K09)

Controls whether the order API generates an order confirmation regardless of whether the order is in error. If this system control value is selected and the order is in error, the order confirmation is not generated until you correct any errors and the ORDR_ASYNC background job processes the order; otherwise, if this system control value is unselected, the order API generates order confirmations for all eligible orders, regardless of whether there are errors.

Reject Duplicate Web Orders (K64)

Controls whether the order API creates a duplicate web order. If this system control value is selected, the system matches the inbound order_number field with the order number in the e-commerce Order Header Extended table. If both orders contain payments, the inbound order is a duplicate and an error response message is sent.However, if the order numbers match but one order does not contain the payment method; the inbound order is not a duplicate and the existing order is updated or replaced.If this system control value is unselected, the order API creates duplicate web orders.


CWSerenade 5.0


Customer Creation, Matching and Update Logic in the Order API

Customer Sold To Selection, Creation and Update

The system uses the following basic logic in selecting a sold-to customer for the order (see below for exceptions and examples):

1. Customer number: If a valid customer_number is specified in the message, use that customer; otherwise,

2. Alternate customer number: If an alternate_sold_to_id is specified in the message (but no valid customer_number):

• If there is just one customer whose Alt cust # or Alternate customer # cross-reference matches the alternate_sold_to_id, use that customer; otherwise,

• If there are any customers with matching Alt cust #’s, use the customer with the highest customer number (most recently created customer); otherwise,

• Use the customer with the matching Alternate customer # cross-reference with the highest customer number (most recently created customer); otherwise,

3. Evening phone: If the Include Telephone Number in Customer Search (I20) system control value is selected, and a sold_to_eve_phone is specified in the message (but no valid customer_number or existing alternate_sold_to_id):

• If there is just one customer whose Evening phone number matches the sold_to_eve_phone, use that customer; otherwise,

• Of the customers with matching Evening phone numbers whose name and address information matches the information in the message (using the matching rules specified through the Phone Interface Values (F70) system control value), use the matching customer with the lowest customer number (customer created first); otherwise,

CWSerenade 5.0


4. Daytime phone: If the Include Telephone Number in Customer Search (I20) system control value is selected, and sold_to_day_phone is specified in the message (but no valid customer_number, existing alternate_sold_to_id or sold_to_eve_phone):

• If there is just one customer whose Day phone number matches the sold_to_day_phone, use that customer; otherwise,

• Of the customers with matching Day phone numbers whose name and address information matches the information in the message (using the matching rules specified through the Phone Interface Values (F70) system control value), use the matching customer with the lowest customer number (customer created first); otherwise,

5. Prospect ID: If a valid prospect_id is specified in the message (but no valid customer_number, existing alternate_sold_to_id, sold_to_eve_phone, or sold_to_day_phone):

• Find the Prospect Finder record whose Prospect finder number matches the prospect_id. If there is just one customer whose name and address matches the name and address for the Prospect Finder record (using the matching rules specified through the Phone Interface Values (F70) system control value), use that customer; otherwise,

• If there are multiple customers whose name and address (including specified country or the Default Country for Customer Address (B17) if no country is specified in the message) match the selected Prospect Finder record, use the customer with the highest customer (most recently created customer); otherwise,

6. Name and address match: If none of the above matches work, use the matching rules specified through the Phone Interface Values (F70) system control value to search for a customer who matches the name and address information specified in the message. Note: When matching on street address or address line 2, the system does not include the roadway descriptive in the match if it is the last word in the address line;.

• If there is just one customer who matches the name and address information, use that customer; otherwise,

• If there are multiple customers who match the name and address information, use the customer with the highest customer number (most recently created customer); otherwise,

7. Create customer: If there is no matching customer, create a new customer for the order. If the message does not include complete, valid information on the customer’s name and address, the order will be in error.

CWSerenade 5.0


After searching based on alternate customer number, the system searches based on evening and daytime telephone number only if the Include Telephone Number in Customer Search (I20) system control value is selected/

Ghost customer: If the customer selected through the process described above is flagged as a Ghost, the system creates the order using the target customer with whom

CWSerenade 5.0


the ghost customer was merged (identified through the Customer number cross-reference field in the Customer Sold To table). For example, if the above process selects customer 123, and customer 123 has been merged with customer 456, the order is created for customer 456. In making this assignment, the system does not check that the name or address information for customer 456 matches the information in the message.

Updating the customer: The system always updates the following fields if they are provided in the message:

• alternate customer number

• phone numbers (daytime, evening, or third number (fax or mobile))

• opt-in/out flag

• rent flag

• mail flag

• customer class

• customer price group (provided the customer is not already assigned to a price group). If you do not assign a customer price group to a customer, the system assigns the customer price group defined in the Customer Price Group Code for CPG Pricing Only (L58) system control value to the customer.

The following flags in the Inbound Order XML Message (CWORDERIN) control any additional updates to the customer:

• If the sold_to_address_ update flag is selected and address information is provided in the message the system updates:

• Customer name (prefix, first name, middle initial, last name, suffix, company)• Address (Address lines 1-4, city, state, zip, country)• Delivery code (if no sold_to_busres is specified in the message, the system uses

the Default Delivery Code for New Order Entry Customers (D13))• Day, evening, and third (fax or mobile) phone numbers

Note:

• The system does not update the customer address if it finds a match based on a phone number of customer name and address match.

• When the system does update the customer’s name and address, it updates it completely; however, if no phone numbers are provided in the message, the system does not clear the customer’s existing phone numbers.

• If the sold_to_email_update flag is selected, the system updates the email address at the customer sold-to level and in the Customer Sold To Email table. The email provided in the message becomes the customer’s primary email address.

CWSerenade 5.0


• The setting of one flag does not control the effect of the other. For example, even if the sold_to_address_update flag is set to N, the system still updates the email address if the sold_to_email_update flag is selected.

• If the customer_number passed in the message is not valid, the system does not put the order in error; instead, it continues through the customer search and matching logic.

Relate customer integration: When you use the Relate customer integration, if you create or update a customer through the order API, CWSerenade sends the information about the customer to Relate so that the customer records in the two systems are synchronized.

Creating or Selecting Shipping Addresses or Customers

In addition to the customer sold-to address, there are three types of shipping addresses for an order. Each is described in the following table.

Van delivery processing: When an order is received through the generic order interface, the system evaluates the shipping address defined for the web order to determine if it qualifies for van delivery, and if it does, performs several updates to the order.

The rules for matching an existing customer or creating a new customer are summarized below.

Description How to add in Inbound Order Message

Defining an order-level shipping address on a web order

An order-level shipping address is specified just for a particular order. This is the type of shipping address that you create by selecting Order Ship To at the Work with Order screen in order entry.

• ship_to_type or Default Recipient Type for E-Commerce Orders (H33) = 1

• customer_ship_to_number = blank

• ship-to name and address attributes (starting with ship_to_prefix) = must provide a valid shipping address for the order

• permanent_ship_to_number = blank

CWSerenade 5.0


Defining a recipient customer on a web order

A recipient customer is another customer sold-to, different from the customer who places the order, who receives all or part of the order. This is the type of shipping address that you create or select by selecting Sold To/Recip at the Work with Order screen in order entry, or selecting Accept/Add Rcp or Sold To/Recip at several screens in order entry.

Existing customer:

• ship_to_type or Default Recipient Type for E-Commerce Orders (H33) = 2, and,

• customer_ship_to_number = valid customer number, or

• ship_to name and address attributes (starting with ship_to_prefix) = must match an existing sold-to customer

Note: If the system does not find a matching customer using the information listed above, it creates a new customer sold-to to use as the recipient customer for the order.


New customer:

• ship_to_type = 2

• customer_ship_to_number = blank

• ship_to name and address attributes (starting with ship_to_prefix) = must provide a valid shipping address to create the new customer sold to


Note: If the ship_to name and address provided in the message are an exact match to an existing sold-to customer based on the fields specified with the Phone Interface Values (F70), the system uses the existing customer for the order.


CWSerenade 5.0


Summary:

• Matching an existing customer: The system uses the ship_to name and address attributes to match an existing customer or permanent ship-to as follows:

• customer sold-to (recipient customer): When the ship_to_type is 2 and the system cannot select a customer based on the customer_ship_to_number, the system selects an existing sold-to customer as the order recipient if the ship_to name and address information in the message is an exact match based on the fields specified with the Phone Interface Values (F70).

Defining a permanent shipping address on a web order

A permanent shipping address is permanently attached to the customer sold-to; you can track order and item history for each permanent shipping address as well as for the sold-to customer. This is the type of shipping address that you create or select by selecting Ship To at the Work with Order screen in order entry.

Existing permanent ship-to:


• customer_ship_to_number = number of the sold-to customer for the order

• permanent_ship_to_number = valid permanent ship-to number for the sold-to customer

Note: If the ship_to name and address information is provided, the system uses it to create a new permanent ship-to for the sold-to customer only if it cannot find an existing permanent ship-to using the other information provided, and if the ship-to name and address information does not match an existing permanent ship-to for the sold-to customer.New permanent ship-to:


• customer_ship_to_number = number of the sold-to customer for the order

• ship_to name and address attributes (starting with ship_to_prefix) = must provide a valid shipping address to create the new permanent ship-to


Note: If the ship-to name and address provided in the message are an exact match to an existing permanent ship-to customer, the system uses the existing customer for the order.


CWSerenade 5.0


• permanent ship-to: When the ship_to_type is 3 and the system cannot select a permanent ship_to based on the customer_ship_to_number and permanent_ship_to_number, the system selects an existing permanent ship-to for the order if the ship_to name and address information in the message is an exact match based on the fields specified with the Phone Interface Values (F70).

The system does not update an existing recipient or permanent ship-to customer based on the information in the ship_to attributes.

• Creating a new customer: The system uses the ship_to name and address attributes to create a new customer or permanent ship-to as follows:

• customer sold-to (recipient customer): If the ship_to_type is 2 and the system cannot select a customer based on the customer_ship_to_number, and if the ship_to name and address information do not match an existing sold-to customer based on the fields specified with the Phone Interface Values (F70), the system uses the information to create a new sold-to customer for the order recipient.

• permanent ship-to: If the ship_to_type is 3 and the system cannot select a permanent ship_to based on the customer_ship_to_number and permanent_ship_to_number, and if the ship_to name and address information in the message are not an exact match to an existing permanent ship-to for the sold-to customer based on the fields specified with the Phone Interface Values (F70),

CWSerenade 5.0


the system uses the name and address information to create a new permanent ship-to for the order.

Customer Bill To Selection and Creation

The system uses the following logic in selecting a bill-to customer for an order that uses an A/R payment method:

1. If a valid bill_to_number is specified in the message, use that bill-to customer on the order; otherwise,

2. If there is bill-to name and address information specified in the message:

• If that information matches a single existing bill-to customer based on the Phone Interface Values (F70), use that bill-to; or,

• If that information matches more than one existing bill-to customer based on the Phone Interface Values (F70), use the bill-to customer created the most recently (highest bill-to number); or,

• If that information does not match an existing bill-to customer, create a new bill-to using the information in the message; otherwise,

CWSerenade 5.0


Note:

• The system does not update an existing bill-to customer through the Inbound Order Message.

• The bill-to information, if any, provided in the message is used on the order, regardless of whether the customer sold-to is already assigned to another bill-to.

• When the system creates a new bill-to based on the sold-to information in the message and the customer sold-to is not already assigned to a bill-to, the sold-to will be assigned to that bill-to.

• The bill-to assignment takes place regardless of the setting of the Create/Assign Bill To Customers in Order Entry (A76) system control value and regardless of whether the customer placing the order is a new or existing customer.

Individual Customer Creation and Selection1. The system uses the valid individual number, if any, provided in the message. 2. If a valid individual number is not specified, but the individual in the order message

matches an existing individual for the sold-to customer, the system uses the existing individual.

3. Otherwise, the system creates a new individual using the information provided in the message. To be considered a match to an existing customer, the first three characters of the first name and the first four characters of the last name must be the same.

Note:

• If the Individuals Required in Order Entry (E01) system control value is unselected, incomplete or invalid individual information does not put the order in error status.

• If the Individuals Required in Order Entry (E01) system control value is selected, or if there is an existing individual for the sold-to customer, an individual is required in the order message. See the system control value for a complete discussion.

3. Use the valid Bill to number currently assigned to the sold-to customer, if any; otherwise,

4. Search the Customer Bill To table for a bill-to customer that matches the name and address of the sold-to customer; if there is more than one match, use the bill-to with the highest number (bill-to created last); otherwise,

5. Create a new bill-to customer based on the sold-to customer information. In this situation, the new bill-to number is also assigned to the customer sold-to as well as to the order.

CWSerenade 5.0


CWSerenade 5.0


Resolving the Item and SKU in the Order API

For each order detail line, the system determines the item and SKU to use by checking the following attributes in the sequence indicated:

1. item_id and sku2. short_sku_number3. retail_ref_number4. upc_type and upc_code5. alias_item

If any of the attributes listed above is blank or invalid, the system checks the next attribute in the order indicated.

If all of the attributes listed above are blank or invalid, the order is suspended with the error, Base item does not exist.

Note: You cannot use the SKU cross reference set up through Maintaining SKU Cross Reference Codes (MSKR) to identify an item and SKU through the order API.

CWSerenade 5.0


User-Defined Fields in the CWOrderIn Message

Overview: The Order Header User Field table is available to store information about the order that does not belong in any of the system-defined tables or fields. Although this table is not accessible from a screen, you can create order-related records in this table by passing the information in the CWOrderIn message.

Setup: Before you can process user-defined fields in the CWOrderIn message, you must first create user-defined detail to identify the type of information you expect to receive. For example, in order to use the Order Header User Field table to store an additional external source code for the order, you would use the Create User Defined Field screen to create a user field record such as:

• File code = OHD

• File description = Order header (or similar description)

You then use the Create User Defined Field screen to create a user-defined detail record such as:

• Field label = source (or similar label)

• Field type = T (text)

• Field usage = I (input)

The Display sequence field is required, but the setting does not matter in this case, because the user-defined fields are not listed on a screen. However, you need to check the User Defined Field Detail table and determine the Sequence number, because the system uses this number for processing. The Sequence number is not listed on any screen.

Note: You can set up and use as many user-defined field types as you want for the Order Header User Field table, although you can receive and store only one field of each type for an order. For example, you could not receive and store two external Source fields for the same order.

Processing: When the system receives a CWOrderIn message, it compares the user_field_det_seq_number in the message with the Sequence number in the User Defined Field Detail table to determine the format of the user field information received in the message. If there is no sequence number, or the sequence number is invalid, the system compares the user_field_Label in the message with the Field label in the User Defined Field Detail table.

If the system finds a match based on sequence number or label, it creates a record in the Order Header User Field table for the order. If the system does not find a match, or if it

CWSerenade 5.0


finds a duplicate message type, it ignores the information. The system creates no more than one record in the Order Header User Field table for each record type.

Example: You have created a user-defined detail record such as the one described above. The Sequence number is 1. You receive the following information in the new order message:

User Field Information Matches?

user_field_det_seq_number = 9user_field_Label = SOURCE

yes, based on label

user_field_det_seq_number = blankuser_field_Label = SOURCE

yes, based on label

user_field_det_seq_number = 1user_field_Label = SRC

yes, based on sequence number

user_field_det_seq_number = 9user_field_Label = SRC

no (neither sequence number or label match)

CWSerenade 5.0


Selecting the Sales Rep

Overview: The system uses the sales_rep_number and sales_rep_name in the Inbound Order XML Message (CWORDERIN) to determine the correct sales rep to use on the order.

Related system control values:

• Default Salesrep for E-Commerce Interface (H24): When a default sales rep is specified here, the system assigns this rep to orders if it cannot resolve the rep based on the information in the inbound order message.

• Require Salesrep Number in Order Entry (E87): When this value is selected, the order will be in error if the system cannot resolve the sales rep.

sales_rep_number

sales_rep_name

Result

blank specified • If there is a Default Salesrep for E-Commerce Interface (H24), use that rep on the order.• Otherwise, if:

• the sales_rep_name matches an existing rep, use that rep on the order.

• the sales_rep_name does not match an existing rep, create a new rep using the next available number, and use that rep on the order.

specified blank Uses the sales_rep_number specified in the message on the order; if the number does not match an existing rep, place the order in error: Invalid Salesman Number.

blank blank • If there is a Default Salesrep for E-Commerce Interface (H24), use that rep on the order.• Otherwise, the system does not assign a rep to the order. If the Require Salesrep Number in Order Entry (E87) system control value is selected, place the order in error because of the missing rep: Invalid Salesman Number.

specified specified • If the sales_rep_number matches an existing rep, uses that rep on the order. The system does not update the existing rep with the sales_rep_name specified in the message, even if it is different.• If the sales_rep_number does not match an existing rep, creates a new rep and uses that rep on the order.

CWSerenade 5.0


Important: The system does not use the Salesrep # specified for the sold-to customer on the order.

Error: If the salesrep is not active, the system places the order in error: Sales Rep Inactive.

Salesrep store: If you do not pass a sales_rep_store and a Home Store is defined for the sales_rep_number assigned to the order, the system defaults this store number to the Originating Store field in the Order Header table. However, if the Home Store defined for the salesrep is inactive, the system places the order in error: Sales Rep Store Inactive.

Creating a salesrep: If the system creates a new salesrep, the system sets the Active flag for the new salesrep in the Salesman table to Y. The system will NOT assign the store number defined for the order to the new salesrep.

CWSerenade 5.0


Discounted and Added Items in the CWOrderOut Response Message

When order information is passed back to the customer in the CWOrderOut response message, the system includes certain discounts and promotions that have been applied to the order in the Promotion element of the response message.

You can use this information to display to the customer on the web storefront the types of promotions for which the order qualifies, such as a ship via upgrade, reduced or free freight, or free items. You can use this information to simulate the promotion and free gift windows that display during interactive order entry.

Response type: The system includes discounts and promotions that have been applied to the order only in the Detailed version of the CWOrderOut response message. The response_type specified in the Inbound Order XML Message (CWORDERIN) controls whether an order response is generated when the order goes through the edit.

If the response_type is:

• D (detailed): The system sends the Detailed Order XML Response (CWORDEROUT). This message includes any discounts and promotions that have been applied to the order.

• E (errors): The system sends the Detailed Order XML Response (CWORDEROUT), including descriptions of any errors currently on the order. This message also includes any discounts and promotions that have been applied to the order. However, some promotions may not apply to the remote order until the error is corrected in batch order entry. In this situation, the CWOrderOut response message may not reflect all of the promotions that apply to the order.

• A (acknowledgement): The system sends the Order Acknowledgement XML Message (CWORDEROUT). This message does not include any discounts and promotions that have been applied to the order.

• N (no response): The system does not send a response. However, any eligible discounts and promotions have been applied to the order.

Sending payment information separately: If the payment information is sent separately from the rest of the order in the generic order API, the CWOrderOut response message might be generated twice: once when you receive the initial order message and once when you receive the payment information. In this situation:

• Any discounts or promotions that are applied to the order as a result of the pay type on the order are not included in the CWOrderOut response message that is generated for the initial order message. In addition, the Order Audit Discounts that have been applied to the order during the initial order message are stored in the Order Discount Audit Table (OEODIS) until payment information is received and the

CWSerenade 5.0


order is accepted. Once the order is accepted, the system removes the records from the Order Discount Audit table.

• The CWOrderOut response message that is generated after the payment information is received will contain all discounts and promotions that have been applied to the order.

Order confirmation email: The system generates an Order Confirmation email (based on the program defined in the Order Acknowledgement Program (G50) system control value) even if the remote order is in error (E) status, and must be corrected through batch order entry. Depending on the type of error, some promotions may not apply to the remote order until the error is corrected in batch order entry. In this situation, the Order Confirmation email may not reflect all of the promotions that apply to the order.

Special handling: If a package insert item or free gift contains special handling you will need to go into order maintenance to specify the special handling for the item. This is because when the order is received in CWSerenade, the system reevaluates the order to see if it still qualifies for the item, and if it does, the system adds the item back to the order.

Freight by weight: If you are using the freight by order weight freight method to calculate freight and the freight for the order changes as a result of adding a new item to an order, the system updates the shipping amount in the CWOrderOut response message. For example, if an item is added to the order as a result of a price table premium or free gift, the system updates the shipping amount to reflect the new item that has been added to the order.

Batch order entry: If a web order contains errors and needs to be corrected in batch order entry, the system reevaluates the discounts and promotions that have been applied to the order when you correct the order in the order batch. Once the order has been corrected and the order batch has been accepted, the system reapplies any discounts and promotions for which the order qualifies and removes the records associated with the orders in the order batch from the Order Discount Audit Table (OEODIS). Note: While you are working with the orders in an order batch, the discounts and promotions that are applied to an order may not represent the final discounts and promotions that are applied to the order once the order batch is accepted. To view the final discounts and promotions that have been applied to an order, review the order in standard order inquiry after the order batch has been accepted.

Discounting and Added Items in the CWOrderOut Response Summary

The following table summarizes when the CWOrderOut response message reflects repricing and free or accompanying items.

Type of Discount Applies to Web Order?

Reflected in First Response?

Based on Source Code or Offer, or on Item Offer or SKU Offer

CWSerenade 5.0


free gifts by offer or source codeNote: • Free gifts set up for the source code override free gifts set up for the offer. If an order would qualify for both the offer and source code free gifts, only the source code's free gift is added to the order.• If the order qualifies for a free gift by source or offer, but also qualifies for other promotions which bring the merchandise total below the amount required for the free gift, the system removes the free gift from the order.

yes yes; included in the Promotion element (promotion_type_code FG). In addition, the system adds the free gift to the Detail element.

additional charge discount based on offerNote: If the Prorate Dollar Discounts and Coupons (D90) system control value is unselected, the system adds these discounts to the order as a negative additional charge, or credit. However, if this system control value is selected, the dollar discount is applied on a pro-rata basis to each item on the order and is reflected in the selling price.

yes yes; included in the Promotion element (promotion_type_code RA) and additional_charges tag if the Prorate Dollar Discounts and Coupons (D90) system control value is unselected; otherwise the discount is reflected in the actual_price for each item in the Detail element.

additional charge discount based on sourceNote: If the Prorate Dollar Discounts and Coupons (D90) system control value is unselected, the system adds these discounts to the order as a negative additional charge, or credit. However, if this system control value is selected, the dollar discount is applied on a pro-rata basis to each item on the order and is reflected in the selling price.

yes yes; included in the Promotion element (promotion_type_code SA) and additional_charges tag if the Prorate Dollar Discounts and Coupons (D90) system control value is unselected; otherwise the discount is reflected in the actual_price for each item in the Detail element.



CWSerenade 5.0


source percentage discount yes yes; the discount is reflected in the actual_price for the item.

quantity break by itemThe system reprices items on an order based on quantity break by item only if the Quantity Break/Item (A87) system control value is selected.

yes yes; the discount is reflected in the actual_price for the qualified item.

accompanying items yes yes; the system adds the accompanying item to the Detail element.

associate pricing yes yes; the discount is reflected in the actual_price for the item.

Promotions (WPRO)

free freight promotion yes yes; included in the Promotion element (promotion_type_code FF); in addition, the shipping tag is not included since the shipping amount is zero.

freight override promotion yes yes; included in the Promotion element (promotion_type_code FO). In addition, the freight discount is reflected in the shipping tag.

additional charge discount for additional freight promotion

yes yes; included in the Promotion element (promotion_type_code AA) and additional_charges tag.



CWSerenade 5.0


additional charge discount for freight promotion

yes yes; included in the Promotion element (promotion_type_code FA) and additional_charges tag.

additional charge discount for order promotionNote: If you specify an additional charge code for the promotion, the discount will appear on the order as a credit additional charge; otherwise, the discount amount is prorated against the items on the order.

yes yes; included in the Promotion element (promotion_type_code OA) and additional_charges tag if an additional charge code is defined for the promotion; otherwise the discount is reflected in the actual_price for each item in the Detail element.

additional charge discount for tiered promotion

yes yes; included in the Promotion element (promotion_type_code TA) and additional_charges tag.

free gift for tiered promotionNote: If the order qualifies for a free gift for tiered promotion, but also qualifies for other promotions which bring the merchandise total below the amount required for the free gift, the system still applies the free gift to the order.

yes yes; included in the Promotion element (promotion_type_code TG). In addition, the system adds the free gift to the Detail element.

free gift for BOGO (Buy One/Get One Free) promotion

yes yes; included in the Promotion element (promotion_type_code FB). In addition, the system adds the free gift to the Detail element.

other promotion discounts not applied through an additional charge code or adding a free gift

yes the discount is reflected in the actual_price for the qualified item.

Price Tables (WPTB)



CWSerenade 5.0


price table premiumsNote: The system automatically adds premium items that are offered as a free item to the order. However, if the premium item is offered at a discounted price, instead of offered as a free item, the system does not automatically add the premium item to the order.

yes yes if the item is a free item. Included in the Promotion element (promotion_type_code PT). In addition, the system adds the premium item to the Detail element.

price table discounting yes yes; the discount is reflected in the actual_price for the qualified item.

Additional Promotions, Free Gifts, Discounts, and Price Breaks

package insertsNote: The system adds package insert items to the order only if the Evaluate Promotional Items/Inserts in Order Entry/Maintenance (E48) system control value is selected.

yes yes; included in the Promotion element (promotion_type_code PI). In addition, the system adds the package insert item to the Detail element.

price codesNote: The system reprices items on an order based on price codes only if the Price Codes (D93) system control value is selected.


quantity price matrixThe system reprices items on an order based on the quantity price matrix only if the Quantity Price Matrix Pricing (K41) system control value is selected.


customer percentage discount yes yes; the discount is reflected in the actual_price for the item.

membership discount yes yes; the discount is reflected in the actual_price for the item.



CWSerenade 5.0


Rewards certificatesThe system reprices items on an order based on the applied certificates only if the Use Rewards Integration (K86) system control value is selected and the Rewards Certificates Pay Type (L54) system control value is blank.

yes yes; the discount is reflected in the actual_price for the item.

Relate award amountThe system reprices items on the order based on the relate_award_amount included in the ShipTo element of the Inbound Order XML Message (CWORDERIN) only if the amount is .01 or greater and the Use Relate Loyalty (M06) and Prorate Dollar Discounts and Coupons (D90) system control values are selected.

yes yes; the discount is reflected in the actual_price for the item.

telemarketing specials no no

promotional pricing no no



CWSerenade 5.0


Rejecting the Order (Order API)

Purpose: After beginning creation of an order through the order API, the web storefront or other external system can send a message indicating to reject the order, provided no payment information has been sent.

Required information: The reject message (CWORDERREJECT) needs to specify the company code and either the order number or order cross-reference number (web order number) for an existing order. Optionally, the message can include both the order number and the order cross-reference number.

Example:

<Message source="String" target="String" type="CWORDERREJECT" > <Header company_code="6" order_number="1010mu123" rdc_order_nbr="10851" > </Header>

</Message>

Eligible for rejection? To be eligible for rejection through the reject message, the order must currently be in error and not have a payment method. It does not matter if the order has additional errors besides the lack of a payment method.

Response: The API returns a simple response message indicating whether the reject request was successful (pass) or unsuccessful (fail), for example:


Multi-recipient order? When the API receives a reject message for a multi-recipient order, it rejects all recipients. It is not possible to reject a single order recipient.

Supersedes CWOrderReject: Prior to release 3.5 of CWSerenade, the CWOrderReject message was available through Working with E-Commerce Job Control (EJCT) to reject an e-commerce order. With release 3.5, the CWOrderReject message is no longer implemented, and the CWORDERREJECT message is available instead.

No separate DTD: The order reject message does not have a separate DTD or schema from the CWOrderIn message; it just needs to specify a type of CWORDERREJECT, while the CWOrderIn message specifies a type of CWORDERIN. See the Inbound Order XML Message (CWORDERIN) and the Order Reject Request Message (CWORDERREJECT) for background.

Update to Deleted Order table: When you process an order rejection through the reject message, the system writes a record in the Deleted Order table. The record includes:

• Company code

• Order number

• Job: ORDREJTAPI

• User ID: your default user

CWSerenade 5.0


• Program stack: CALLED FROM ORDER API TYPE=CWORDERREJECT - BUILDORDERREJECTBO

• Date deleted: includes the date and time

• Process: Order Reject API

• System date

• Ecommerce order: The E-commerce order number in the Order Header Extended table and in the E-Commerce Order Reference table. From the order_number passed in the Inbound Order XML Message (CWORDERIN).

If no reject message sent: The EC_CLEANUP job deletes abandoned orders if no reject message is received.

3/24/15 Order Interface XML Message Formats 79

Order Interface XML Message Formats

In this topic:

• Inbound Order XML Message (CWORDERIN)

• Inbound Order Message: Sample XMLs

• Initial order message• Payment-only order message• Sales transaction order message• Quote order message• Customer return order message• CWOrderIn message with custom special handling

• Detailed Order XML Response (CWORDEROUT)

• Detailed Order Response Message: Sample XML

• Order Acknowledgement XML Message (CWORDEROUT)

• Order Acknowledgement Message: Sample XML

• Order Reject Request Message (CWORDERREJECT)

• Order Reject Request Message: Sample• Order Reject Response Message: Samples

For more information: See the CWSerenade Online Help for a complete discussion of the order API.

CWSerenade 5.0

3/24/15 Inbound Order XML Message (CWORDERIN) 80

Inbound Order XML Message (CWORDERIN)

Numeric values: All numeric values with decimal positions should be passed as explicit decimals. For example, a dollar value of $10.00 should be passed as 10.00. A dollar value passed as 100 indicates a price of $100.00, not $1.00.

Date format: If any date passed is not the right number of positions or indicates a nonexistent month or day of the month, the system ignores the invalid date and uses the default. For example, if the message includes an order_date of 123456, the system ignores this information and uses the current date as the order date.

Case:

• Email addresses are always saved in the database in lowercase.

CWSerenade 5.0


• Message text (order messages, order line messages, custom personalization text, and standard custom special handling text) is saved in upper and lowercase if that is how they are passed in the inbound message.

• All other alphanumeric fields are saved in all uppercase, regardless of their case in the inbound message.

Invalid data: If invalid data is passed in the message, the order API returns an Invalid XML Message: followed by the submitted message and a listing of the resulting errors. If a credit card is part of the message, all but the last four of the credit card number is masked with asterisks (*). You can review the CWSerenade MQ Log for details. To avoid passing invalid data:

• Do not pass an alphanumeric value in a numeric field.

• Do not exceed the specified length of any field that is stored as a non-date number in the database; doing so prevents the system from being able to process the message at all, and the order will not be created.

• Alphanumeric fields that are defined in and validated against the database (such as the item code) or are part of the key identifying fields for a table should not exceed the maximum field length, or they put the order in error status. Other alphanumeric fields (such as order messages and address information) that exceed the maximum field length are truncated.

Invalid message format: If the message is incorrectly formatted, the order API returns a Cannot Parse XML Message: followed by the submitted message. If a credit card is part of the message, the system replaces the credit card number with ** REMOVED **. You can review the CWSerenade MQ Log for details.

Message Attribute

Alpha/numeric

Positions Comments

MessageOne Message element is required.

source alphanumeric IDC

target alphanumeric RDC

type alphanumeric CWORDERIN

resp_qmgr alphanumeric 44 Not currently implemented.

resp_q alphanumeric 44 Not currently implemented.

CWSerenade 5.0


HeaderOne header element is required.Special characters: If you pass a special character in the Header element, the system does not process the message and writes a message in the CWDirect Log. Example: • If you pass Mary&Joe in the sold_to_fname tag, an error message similar to the following is written in the CWDirect log: 2008-06-18 11:25:59,934 99184497 ERROR [STDERR] (43049:) (LoggerStream.java:152) [Fatal Error] :1:214: The reference to entity "Joe" must

end with the ';' delimiter.• If you pass Mary& in the sold_to_fname tag, the order API returns an Invalid XML response and writes an error message similar to the following to the CWDirect log: 2008-06-18 11:10:29,315 98253878 ERROR [STDERR] (43049:) (LoggerStream.java:152) [Fatal Error]

:1:110: The entity name must immediately follow the '&' in the entity reference.

company_code

numeric 3 Identifies the company for the order. Validated against the Company table. Padding with zeroes (for example, 005) is optional. Required.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


order_number alphanumeric 30 Use this number to identify the order in the external system or the session ID from the web storefront. Updates the E-commerce order number in the Order Header Extended table, and creates a record in the E-Commerce Order Reference table. Labeled the Web order number at the Display Order Properties screen.Important: A unique order_number is required for every order received through the Inbound Order Message to avoid the risk of having an unaccepted order replaced when another order message is received.Note: If the Reject Duplicate Web Orders(K64) system control value is selected, duplicate orders are discarded.Invalid order number? If a payment-only message specifies an order number that does not exist, the order API returns an error: <Message>Error: The order could not be located.</Message>

Separate payment message: If the payment is sent in a separate message, the order API uses the order_number to identify the order only if there is not a valid rdc_order_nbr specified. See Sending a Separate Payment Message for more information.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


offer_id alphanumeric 3 The offer to default to each order detail line to control pricing and track demand. The system applies this offer to the order detail line only if there is a record of the item or SKU in this offer. The line_offer, if any is passed, overrides this default. If the message does not specify an offer_id at the header or a line_offer for an item, the offer associated with the source code defaults. However, the offer on the order detail line is overridden if the Override Offer on Order Detail (D49) system control value is selected and the price for the item is found in a different offer.

rdc_order_nbr numeric 9 Indicates the CWSerenade order number to update when the payment information is sent separately from the rest of the order. See Sending a Separate Payment Message.

payment_only alphanumeric 1 Indicates whether the order message includes just the payment information for an order whose other information was sent on a previous message. Valid values are:• Y = Payment information only• N or blank = Not a payment-onlyIf this flag is set to Y, then the pay_incl flag should also be set to Y.See Sending a Separate Payment Message for more information.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


source_code alphanumeric 9 Updates the Source code field in the Order Header table. If this value exceeds the maximum length of 9 positions, it will be truncated. Source code selection:1. Valid source? Use the source code specified here if it is valid and unrestricted. Otherwise, if the source code is invalid or restricted or no source code is specified,2. Line-level source?

• Is there a valid, unrestricted line_source_code specified for one of the Item lines on the order? If so, the line-level source code defaults to the header.

Note: If a line-level source code is invalid, the order will be suspended with an error of Invalid Source Code.

• If there is a line_source_code specified for more than one line, the first one on the order defaults to the header.

Otherwise, if no valid or unrestricted line-level source code is specified,3. Mail history? If the Load Order Header Source from Mailing History (F05) system control value is selected and the customer has mailing history, use the most recent source code from the customer’s mailing history. Otherwise, if the system control value is unselected or the customer has no mailing history,

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


4. Current source? If the Use Default Current Source Code (C46) system control value is selected and the customer has a current source code, use that source code. Otherwise, if the system control value is unselected or the customer does not have a current source code, 5. Default source for internet orders: Use the Default Source for Internet Orders (E65).Otherwise, if the system cannot determine the source code for the order, it puts the order in error with a reason of Invalid Source Code.Note: If the order header source code matches the source code in the Default Unknown Source Code (I58) system control value, the system changes the source code on the order header to the source code associated with the offer on the first order detail line.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


response_type alphanumeric 1 Indicates the type of response required. Valid values are:• N or no response_type passed = No response• A = Acknowledge: Send Order Acknowledgement XML Message (CWORDEROUT)• D = Details: Send Detailed Order XML Response (CWORDEROUT)• E = Errors: Send the Detailed Order XML Response (CWORDEROUT), including a listing of any errors found on the order.Note: If the response_type is any setting other than N, A, D, or E, the order API returns a response of <Message>OK</OK>.Available in XML version: A setting of E is valid in version 2.0, available in release 1.1 of CWSerenade.If payment information sent separately: When you receive the payment information separately from the rest of the order, the system always sends a response message upon receiving the first part of the order message. If the response_type is D or E, the system sends the detailed message; otherwise, if the response_type is A or N, or if no response_type is specified, the system sends the acknowledgement.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0



• Typical Order Interface Scenarios for examples of when you might choose to include a response.• Sending a Separate Payment Message for a discussion of when you might choose to send payment information separately• Order Creation Errors for a listing of errors that might be included if the response_type = E

order_date numeric 8 Updates the Order date in the Order Header table. Displayed on the Order Inquiry Header screen. Uses a date in the past if provided in the message; otherwise, if the message does not provide a date or if the date is invalid, uses the current date. MMDDYYYY format.

enter_date numeric 8 Updates the Entered date in the Order Header table. Uses a date in the past if provided in the message; otherwise, if the message does not provide a date or if the date is invalid, uses the current date. A past or future date does not create an error. MMDDYYYY format.

enter_time numeric 6 Entered time in the Order Header table, which you can review at the Display Order Properties screen.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


order_channel alphanumeric 2 Updates the Internet order field in the Order Header table. A value of I indicates an internet order. Internet orders are treated differently in evaluating orders for automatic email confirmations, authorizations, and determining whether the customer can maintain the order on the web storefront. A value of P indicates a retail channel order. If the order_channel is P and the order is not part of a batch, the system places the order in the Batch Number for Retail Channel Orders (I78) if it has errors.If this value exceeds the maximum length of 2 positions, it will be truncated.

customer_number

numeric 9 Updates the Customer # field in the Order Header table. See Customer Creation, Matching and Update Logic in the Order API for an overview.

alternate_sold_to_id

alphanumeric 15 Used to identify the sold-to customer; see Customer Sold To Selection, Creation and Update. Updates the Alternate customer # for the customer; see the Alt cust # field at the Second Create Customer Sold To. This update always takes place, regardless of the setting of the sold_to_address_ update flag if you also pass the customer number.

prospect_id alphanumeric 8 Used to identify the sold-to customer. See Customer Sold To Selection, Creation and Update.

Note: • See Customer Creation, Matching and Update Logic in the Order API for an overview on how each of the customer sold to name and address fields listed below are updated.• When creating or updating a customer address, the system validates the customer address and ship via as it does in order entry.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


Note: If you leave any of the customer name fields blank when you are updating the customer name and address, then the system deletes the fields left blank in the message provided the result is a complete, valid customer record. For example, if an existing customer record includes the first and last names, and the CWOrderIn specifies a company name but no first or last names, then the existing first and last names are deleted from the customer record.

sold_to_prefix alphanumeric 3 Maps to the Prefix field in the Customer Sold To table. If the Validate Prefix (I27) system control value is selected, the prefix is validated against the Prefix table. In this situation, if the customer’s prefix is invalid, the order will be in error with a reason of Invalid Prefix Code (however, this message can also indicate a problem with the bill_to_prefix). Otherwise, if the system control value is not selected, a prefix that exceeds the field length of three positions is truncated.

sold_to_fname alphanumeric 15 Maps to the First name field in the Customer Sold To table.

sold_to_initial alphanumeric 1 Maps to the Initial field in the Customer Sold To table.

sold_to_lname alphanumeric 25 Maps to the Last name field in the Customer Sold To table. Note: • If you change a customer address but do not specify either a last name or a sold_to_company, none of the changes specified for the Customer Sold To table will take place; however, updates to related tables, such as the Customer Sold To Phone # or Customer Sold To Extended, will still take place.

sold_to_suffix alphanumeric 3 Maps to the Suffix field in the Customer Sold To table.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


sold_to_company

alphanumeric 30 Maps to the Company name field in the Customer Sold To table.If you change a customer address but do not specify either a sold_to_lname or a company, none of the changes specified for the Customer Sold To table will take place; however, updates to related tables, such as the Customer Sold To Phone # or Customer Sold To Extended, will still take place.

sold_to_busres

alphanumeric 1 Maps to the Delivery code field in the Customer Sold To table. Valid values are:• B = business• R = residenceIf this value is not specified and you are creating or updating the customer address, the system uses the Default Delivery Code for New Order Entry Customers (D13).

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


sold_to_address1

alphanumeric 32 Maps to the Street address field in the Customer Sold To table. Shipping to a Post Office BoxTo ship to a Post Office Box, enter POST OFFICE BOX, POST BOX, or any variation of PO BOX (with or without spaces or non-alphabet characters, such as P.O. BOX), and the box number in the customer’s street address. During order processing, the system validates that the carrier can ship to a post office box (as defined in the Ship Via table).Example: Enter P.O. Box 9999 in the Street field to indicate delivery to a post office box instead of a home or company address.Note: If you type POST OFFICE BOX, POST BOX, or any variation of PO BOX in the customer’s street address during order entry or through the Order API, the system automatically selects the PO box field for the customer. However, if you remove this text from the customer’s street address, the system does not automatically unselect the PO box flag.

sold_to_address2

alphanumeric 32 Maps to the Address line 2 field in the Customer Sold To table.

sold_to_address3

alphanumeric 32 Maps to the Address line 3 field in the Customer Sold To Extended table.

sold_to_address4

alphanumeric 32 Maps to the Address line 4 field in the Customer Sold To Extended table.

sold_to_apartment

alphanumeric 10 Maps to the Apartment field in the Customer Sold To table. Typically includes a preface such as “Apt” so the apartment number is easily identified in the printed address.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


sold_to_city alphanumeric 25 Maps to the City field in the Customer Sold To table. If this field is not passed but a valid postal code (zip) is passed and the Use Zip/City/State Defaulting? (B13) system control value is selected, the city associated with the postal code defaults.

sold_to_state alphanumeric 2 Maps to the State field in the Customer Sold To table. If this field is not passed but a valid postal code (zip) is passed and the Use Zip/City/State Defaulting? (B13) system control value is selected, the state associated with the postal code defaults. Required only if the Require state? flag is selected for the country.

sold_to_zip alphanumeric 10 Maps to the Zip field in the Customer Sold To table. Required only if the Require postal code? flag is selected for the country. If a postal code is required, it is validated against the Zip/City/State (Postal Code) table.If the SCF related to the zip code is invalid, the order will be in error with a reason of SCF not Found (however, this message can also indicate a problem with the bill_to_zip).If the SCF or the ship via/SCF combination is not valid, the order will be in error with the reason of Invalid Ship Via for SCF. This error occurs only if the Perform ship via edit? flag is selected for the country.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


sold_to_country

alphanumeric 3 Maps to the Country field in the Customer Sold To table. If no country code is specified here, the Default Country for Customer Address (B17) defaults when you are creating a new customer or updating an existing customer. If the country is invalid, the order will be in error with a reason of Country Not Found (however, this message can also indicate a problem with the bill_to_country).

sold_to_email alphanumeric 50 If the sold_to_email_update flag is set to Y, updates an existing customer’s email address at the customer sold-to level, and primary email address in the Customer Sold To Email table. If the email address is not properly formatted, the order will be in error. Case: The email address is always saved in lowercase; for example, if the sold_to_email is [email protected], the system saves it as [email protected]. Also, the system does not consider case in evaluating whether the sold_to_email matches the email address for an existing customer; the two email addresses above would be considered exact matches.If the sold_to_email_update flag is not set to Y, then the order API does not update an existing customer’s email address.

sold_to_email_update

alphanumeric 1 If set to Y, indicates to update an existing customer’s primary email address. When you update the email address, the new email address is added to the Customer Sold To Email table, and is flagged as the primary email address.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


sold_to_day_phone

alphanumeric 14 Used to identify the sold-to customer.The phone number should be unformatted; or, if it is formatted, it should be correctly formatted based on the phone number formatting specified for the customer’s country to create, match, or update the customer correctly.See Customer Sold To Selection, Creation and Update for more information on how the system finds a matching customer based on phone numbers.The system updates these phone numbers, if provided, regardless of the setting of the sold_to_address_ update flag (provided it did not select the customer based on name/address or phone number information).

sold_to_eve_phone

alphanumeric 14

sold_to_fax_phone

alphanumeric 14 Updates the third (fax or mobile) number for the customer; see the Fax or Mobile field at the Second Create Customer Sold To screen. The third phone number should be unformatted; or, if it is formatted, it should be correctly formatted based on the phone number formatting specified for the customer’s country to create, match, or update the customer correctly.The system updates this field, if provided, regardless of the setting of the sold_to_address_ update flag (provided it did not select the customer based on name/address or phone number information).

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


sold_to_opt_in alphanumeric 2 Updates the Opt-in out setting for the customer’s primary email address; see the Opt in/opt out field at the First Create Sold To Customer screen. The system updates this field, if provided, regardless of the setting of the sold_to_address_ update flag. If no value is specified in the message and you are creating a new customer, the Default Opt In/Opt Out Flag (G97) defaults. If a value is not specified for this system control value or an invalid value is passed, O2 defaults.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


sold_to_address_ update

alphanumeric 1 Indicates whether to update an existing Customer Sold To with name and address information in the message. Valid values are:

• Y = Update the existing Customer Sold To

• N = Do not update the Customer Sold To

Regardless of the setting of this flag, the system always updates the following fields if they are provided in the message:

• alternate customer number

• phone numbers (daytime, evening, or third (fax or mobile))

• opt-in/out flag

• rent flag

• mail flag

• customer class

• customer price group

See Customer Creation, Matching and Update Logic in the Order API for more information.Note: The system checks this setting only if name and address information is provided in the message.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


allow_rent alphanumeric 1 Updates the Rent flag for the customer; see the Rent flag at the First Create Sold To Customer screen. The system updates this field, if provided, regardless of the setting of the sold_to_address_ update flag. If no value is specified in the message and you are creating a new customer, the Default Rent Name (D11) setting defaults.Valid values are:Y = allow rentN = do not allow rent

allow_email Not currently implemented.

allow_mail alphanumeric 1 Updates the Mail flag for the customer; see the Mail flag at the First Create Sold To Customer screen. The system updates this field, if provided, regardless of the setting of the sold_to_address_ update flag. If no value is specified in the message and you are creating a new customer, the Default Mail Name (D10) setting defaults.Valid values are:Y = allow mailN = do not allow mail

nbr_ship_tos Not currently implemented.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


pay_incl alphanumeric 1 Indicates whether the message includes payment method information. If the payment method information will be sent in a separate message, the order remains suspended until the payment method message is received. Valid values are:• Y = payment method information is included in the message, or this is a payment-only message (see Sending a Separate Payment Message)• N = payment information will be sent in a separate message.Note: If this flag is set to N, no payment methods will be added to the order even if the information is included in the message. Require Payment on Quotes? If the message does not include payment information and the Quote field for the order type is selected, the program looks at the setting of the pay_incl tag in the message. • If the pay_incl tag is N, the system places the quote in an error status and waits for a second CWOrderIn message that includes the payment information to complete the quote.• If the pay_incl tag is Y, the system looks at the Pay method required field for the order type on the quote.

• If Pay method required is selected, the system requires a pay method on the quote. If a pay method is not defined, the system places the quote in an error status. You will need to correct the quote in batch order entry.

• If Pay method required is unselected, the system does not require a pay method on the quote and continues with regular processing.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


Note: If any of the information provided for the individual is invalid, the order will be in error with a reason of Placer Invalid.

ind_number numeric 3

ind_dept alphanumeric 3

ind_position alphanumeric 3

ind_prefix alphanumeric 3

ind_fname alphanumeric 15

ind_initial alphanumeric 1

ind_lname alphanumeric 25

ind_suffix alphanumeric 3

ind_day_phone

alphanumeric 14 The phone number should be unformatted; or, if it is formatted, it should be correctly formatted based on the phone number formatting specified for the customer’s country to create, match, or update the customer correctly.The third number is displayed on screens and reports as the fax or mobile number, based on the setting of the Third Phone Number Type (L53) system control value.

ind_eve_phone

alphanumeric 14

ind_fax_phone alphanumeric 14

ind_email_address

alphanumeric 50 If the Default Individual Email Address (J17) system control value is selected, and an order_email is not specified, the system defaults the individual’s email address to the Order email address field on the order. Case: The email address is always saved in lowercase; for example, if the ind_email_address is [email protected], the system saves it as [email protected].

ind_opt_in alphanumeric 2 If you do not specify a setting here, the OptIn setting for the individual defaults from the Default Opt In/Opt Out Flag (G97) system control value.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


ind_mail_flag alphanumeric 1 If you do not specify Y here, the Mail flag for the individual will be unselected.

ind_rent_flag alphanumeric 1 If you do not specify Y here, the Rent flag for the individual will be unselected.

bill_to_number numeric 7 Updates the CBT Account # field in the Order Header table. See Customer Bill To Selection and Creation for an overview.Note: • The system does not update an existing bill-to customer record through the Inbound Order Message.• Having the Create/Assign Bill To Customers in Order Entry (A76) system control value unselected does not prevent you from specifying an existing bill-to here and assigning it to the order.• If the payment method on the order is accounts receivable and there is not currently a valid bill-to customer assigned to the customer placing the order, the system creates a new bill-to customer based on the sold-to customer’s name and address, and assigns that bill-to customer to the order and to the sold-to customer. This assignment takes place regardless of the setting of the Create/Assign Bill To Customers in Order Entry (A76) system control value and regardless of whether the customer placing the order is a new or existing customer.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


Note:

• If bill-to name and address information is specified in the following attributes, it is used to create a new bill-to customer (A/R account) and assign it to the order. See Customer Bill To Selection and Creation for an overview.

• If you are creating a new bill-to customer, but the bill-to name and address provided in the message does not specify a complete, valid bill-to name and address, the order will be in error.Fax flag = N

• EDI flag = N• Delivery code = B

• The bill-to information, if any, provided in the following attributes is used on the order, regardless of whether the customer sold-to is already assigned to another bill-to.

• When the system creates a new bill-to based on the sold-to information in the message and the customer sold-to is not already assigned to a bill-to, the sold-to will be assigned to that bill-to.

• . If any of the bill-to information in the message is invalid, the order will be in error with a reason of Invalid Bill to Address.

alternate_bill_to_id

Not currently implemented.

bill_to_prefix alphanumeric 3 Validate Prefix (I27) system control value is selected, the prefix is validated against the Prefix table. See the sold_to_prefix for more information. Otherwise, if the system control value is not selected, a prefix that exceeds the field length of three positions is truncated.

bill_to_fname alphanumeric 15

bill_to_initial alphanumeric 1

bill_to_lname alphanumeric 25

bill_to_suffix alphanumeric 3

bill_to_company_name

alphanumeric 30

bill_to_address1

alphanumeric 32

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


bill_to_address2

alphanumeric 32

bill_to_address3

alphanumeric 32

bill_to_address4

alphanumeric 32

bill_to_apt alphanumeric 10

bill_to_city alphanumeric 25 If this field is not passed but a valid postal code (zip) is passed and the Use Zip/City/State Defaulting? (B13) system control value is selected, the city associated with the postal code defaults.

bill_to_state alphanumeric 2 If this field is not passed but a valid postal code (zip) is passed and the Use Zip/City/State Defaulting? (B13) system control value is selected, the state associated with the postal code defaults. Required only if the Require state? flag is selected for the country.

bill_to_zip alphanumeric 10 Required only if the Require postal code? flag is selected for the country.

bill_to_country alphanumeric 3 Required if the message includes bill-to information.

bill_to_email alphanumeric 50 Case: The email address is always saved in lowercase; for example, if the bill_to_email is [email protected], the system saves it as [email protected].

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


bill_to_day_phone

alphanumeric 14 The phone number should be unformatted; or, if it is formatted, it should be correctly formatted based on the phone number formatting specified for the bill-to customer’s country to create, match, or update the customer correctly.The third number is displayed on screens and reports as the fax or mobile number, based on the setting of the Third Phone Number Type (L53) system control value.

bill_to_eve_phone

alphanumeric

bill_to_fax_phone

alphanumeric

bill_to_print_statement

alphanumeric 1 Valid values are:Y = Print statementN or blank = Do not print statement

bill_to_opt_in alphanumeric 2 Not currently implemented.

user_hold_reason

alphanumeric 2 Updates the Hold reason field in the Order Header table, displayed at the Order Inquiry Header screen and puts the order on hold. Defined in and validated against the Order Hold Reason table. If this value exceeds the maximum length of 2 positions, it will be truncated.

Note: See Batching Orders Through the Order API for an overview on how to use the following attributes.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


batch_number numeric 12 Must be a number that has not yet been used for an order batch. When the system receives the beginning order for a batch it confirms that the batch number does not exist in the Used Phone Batch table; however, it then assigns a different batch number to the batch. All orders that are received with the same batch_number are assigned to the same batch number in CWSerenade. For example, if the first order you send has a batch_number of 782, and the order API assigns the order to batch 888, all subsequent orders received with batch_number 782 are also assigned to batch 888.

batch_date alphanumeric 8 Updates the Batch date in the Order Batch table. MMDDYYYY format. Indicates the date of the batch, as displayed at the Work with Order Batches screen. Specify this date for the first order in the batch.

batch_beg_end_flag

alphanumeric 1 Indicates when a batch begins or ends; otherwise, this value should be blank. Valid values are:• B = Begin batch; use for the first order in a batch.• E = End batch: use for the last order in a batch.Note: Even after you have sent a batch_beg_end_flag of E, if you send an additional order message with the same batch_number, the additional order is assigned to the same batch. For example, if you send an order with a batch_number of 782 and the batch_beg_end_flag set to E, then subsequently send an additional order that also has a batch_number of 782, the additional order will be added to the existing batch.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


approve_batch alphanumeric 1 Not currently implemented. The batch remains open until you select Edit/Accept on the Work with Order Batches screen in order entry to edit and approve it manually.

batch_order_count

numeric 5 Indicates the number of orders in the batch, as displayed at the Work with Order Batches screen. The batch will be out of balance if the number of orders received for the batch is not the same as this value.Specify this quantity for the first order in the batch.

batch_qty_count

numeric 7 The total order line quantity of all orders in the batch, as displayed in the # of units field at the Change Order Batch screen. The batch will be out of balance if the total number of units is not the same as this value. This quantity should be specified for the first order in the batch. Specify this quantity for the first order in the batch.

batch_prepaid_total

numeric 9.2 Updates the Actual $ received field in the Order Batch table. The total amount of cash payments for all orders in the batch. This amount should be specified for the first order in the batch. Specify this total for the first order in the batch.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


order_type alphanumeric 1 Updates the Order type field in the Order Header table. Defined in and validated against the Order Type table. If this value exceeds the maximum length of one position, it will be truncated.If no order_type is specified here, the system uses the E-Commerce Order Type (G42).If the Retail warehouse field for the order type contains a non-allocatable warehouse and the Reserve from Non-Allocatable Warehouse (J25) system control value is selected, the system allows you to reserve inventory against the non-allocatable warehouse defined for the order type. However, if a warehouse override is defined for the ship to or for an order line, the system uses the warehouse override.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


sales_rep_number

numeric 7 Updates the Salesman # field in the Order Header table. See Selecting the Sales Rep for more information on how the system assigns a salesrep to the order.Error: If the salesrep is not active, the system places the order in error: Sales Rep Inactive. Salesrep store: If you do not pass a sales_rep_store and a Home Store is defined for the sales_rep_number assigned to the order, the system defaults this store number to the Originating Store field in the Order Header table. However, if the Store Cross Reference record for the Home Store defined for the salesrep is inactive, the system places the order in error: Sales Rep Store Inactive.Creating a salesrep: If the system creates a new salesrep (see Selecting the Sales Rep), the system sets the Active flag for the new salesrep in the Salesman table to Y. The system will NOT assign the store number defined for the order to the new salesrep. Note: Because the sales rep number is a numeric field, if the number passed here exceeds seven positions, the order API returns an “Invalid XML” error and cannot process the order.

sales_rep_name

alphanumeric 30 See Selecting the Sales Rep.

entered_by_user

alphanumeric 10 Updates the USR user field in the Order Header table, labeled Entered by at the Display Order Properties screen. If no user is specified in the message, your default user defaults. If the entered_by_user exceeds the maximum length of 10 positions, it will be truncated. This field does not need to be a valid user.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


customer_class

alphanumeric 2 Updates the Customer class for the customer; see the Class field at the First Create Sold To Customer screen. The system updates this field, if provided, regardless of the setting of the sold_to_address_ update flag. If no customer_class is provided in the Inbound Order Message, the system uses the Default Customer Class in Order Entry (D63). If there is no customer_class in the message, no default customer class specified in the system control value, and the Require Customer Class in OE, WCAT, and WCST (H85) system control value is selected, the order will be in error with a reason of Invalid/Missing Cust Cls.

order_email alphanumeric 50 Updates the order-level email address. If no order_email is provided, the system uses the: • ind_email_address or existing email address for the placer on the order if the Default Individual Email Address (J17) system control value is selected• sold_to_email or existing primary email address for the sold-to customerCase: The email address is always saved in lowercase; for example, if the order_email is [email protected], the system saves it as [email protected].

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


ip_addr alphanumeric 15 Updates the IP address in the Order Header Extended table, displayed at the Display Order Properties screen. IP address validation: If the IP address is invalid, the system writes an Order Transaction History message such as INVALID IP ADDRESS: 1.2.3 where 1.2.3 represents the invalid IP address received, and does not update this field. The IP address is made up of a series of four numbers separated by three periods (for example, 192.168.255.255). Each number between the periods must be from 1 to 255. The IP address must:• not include any non-numeric characters besides the periods• not include any blank spaces• include all three periods• include all four numbers, each from 1 to 255

Fraud checking: If the IP address received matches an entry in the Miscellaneous Fraud table, the system puts the order on IP (IP address) hold and writes a message reading SYS HLD---IP ADDRESS HOLD to the Order Transaction History table.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


sold_to_price_group

alphanumeric 4 The customer price group to assign to the sold-to customer. Available in XML version: 4.0 (release 2.5 of CWSerenade).About price groups: You can use a customer price group to control quantity price matrix pricing, customer price group pricing, or as a qualifier for promotions. If you assign a price group through the CWOrderIn message, the order is eligible for any pricing or promotions related to the price group.Updated when? If the message specifies a valid customer price group and the customer does not already have a price group assignment, the system updates the customer record regardless of the setting of the sold_to_address_ update flag. The system does not update the customer’s price group if there is already a group assigned.Default: If you do not assign a customer price group to a customer, the system assigns the customer price group defined in the Customer Price Group Code for CPG Pricing Only (L58) system control value to the customer.

For more information: Errors? The system continues with normal processing and does not put the order in error status if the price group code specified is not valid, or if the customer is already assigned to a price group.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


sales_rep_store

alphanumeric 10 The store number assigned to the order. Store numbers are defined in and validated against the Store Cross Reference table. The store number assigned to the order displays in the Sales Rep Store field on the Display Order Properties screen.Errors:

• If the store number passed is not a valid store number in the Store Cross Reference table, the system places the order in error: Sales Rep Store Invalid.

• If the Active flag for the store number passed is not set to Y in the Store Cross Reference table, the system places the order in error: Sales Rep Store Inactive.

Default: If you do not pass a sales_rep_store and a Home Store is defined for the sales_rep_number passed in the message, the system defaults this store number to the Originating Store field in the Order Header table. However, if the Home Store defined for the salesrep is inactive, the system places the order in error. Included in CWEmailOut: If the order is not a retail pickup, delivery, ship-to-store, or store pickup order, the CWEmailOut message includes the store’s description, phone number, and address. See the OriginatingStore element in the Outbound Email XML Message (CWEmailOut) for more information.Available in XML version: 6.0 (release 3.5 of CWSerenade).

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


ecommerce_id alphanumeric 32 The customer number identifying the customer in the e-commerce site. Used as part of the Relate customer integration to help synchronize customer information between CWSerenade and Relate. Available in XML version: 8.0 (release 4.5 of CWSerenade).

relate_cust_ sync_success

alphanumeric 1 Indicates whether the e-commerce site has successfully synchronized information about the customer with Relate. Used as part of the Relate customer integration to help synchronize customer information between CWSerenade and Relate. Available in XML version: 8.0 (release 4.5 of CWSerenade).

CustOwnershipIf you pass valid data in the following attributes, it updates the Customer Ownership table, available for review at the Work with Customer Ownership screen in customer maintenance.The CustOwnerships element, if provided, can include one or more CustOwnership elements.

cust_own_ID alphanumeric 10 A code that represents a product the customer owns or previously owned.Updates the Ownership ID field in the Customer Ownership table. Required to create or update a customer ownership record. If a CustOwnership does not include cust_own_ID but does include other values, the system creates a customer note: Missing Ownership ID: Ownership Description. The system does not place the order in an error status because of customer ownership errors.

cust_own_desc

alphanumeric 40 A description of the product.Updates the Description field in the Customer Ownership table.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


cust_own_active

alphanumeric 1 Indicates if the customer currently owns the product.• Y = The customer currently owns the product.• N = The customer previously owned the product.Updates the Act field in the Customer Ownership table. If this attribute is included but does not specify one of the valid values listed above, the order API sets the flag to Y.

cust_own_entry_date

numeric 8 The date the customer ownership record was created, in MMDDYYYY format.If passed, updates the Entry date field in the Customer Ownership table. If a valid date is not passed and you are creating a new ownership, the current date defaults.

cust_own_confirm_date

numeric 8 The most recent date when the customer confirmed ownership of the product, in MMDDYYYY format.If passed, updates the Confirm date field in the Customer Ownership table. If a valid date is not passed and you are creating a new ownership, the current date defaults.

CustUserFieldUse the following attributes to update the Customer Sold To User Field table, available for review at the Work with User Fields screen in customer maintenance. The CustUserFields element, if provided, can include one or more CustUserField elements.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


cust_usr_fld_dtl_seq_nbr

numeric 3 Identifies the Sequence # in the Cust Sold To User Field table, labeled the Key at the Change User Field screen. Required to update a customer user field if you do not specify a cust_usr_fld_label. If this entry does not match an existing customer user field, as specified through Setting Up User-Defined Fields (WUDF), the user field data in the message will not be saved.Note: The Sequence # in the Cust Sold To User Field table is not the same as the display sequence number.

cust_usr_fld_label

alphanumeric 15 Identifies the field label for a customer user field, as displayed at the Work with User Fields screen in customer maintenance. If you specify either the cust_usr_fld_dtl_seq_nbr or the label, or both, the system updates the customer user field identified by the sequence number.

cust_usr_fld_data

alphanumeric 30 Updates the Text, Number, or Date field in the Cust Sold To User Field table. Note: • If the data exceeds 16 positions for a Number field, it is truncated. • If the data for a Number field includes non-numeric characters, they are removed.• Dates must be passed in MMDDYYYY format in order to update the Cust Sold To User Field table.

UserFieldNote: The contents of the Order Header User Field table is not available for display on any screen.

For more information: The UserFields element, if provided, can include one or more UserField elements.

usr_fld_dtl_seq_number

numeric 3 Identifies the Sequence # in the Order Header User Field table.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


usr_fld_label alphanumeric 15 Identifies the type of field to update in the Order Header User Field table.

usr_fld_data alphanumeric 30 Updates the Text, number, or Date field in the Order Header User Field table. If the field is a date, the information passed must be a valid date in MMDDYYYY format, or the order API sets the date field to 0.

PaymentThe Payments element can include one or more Payment elements. At least one payment method is required.

payment_type numeric 2 Identifies the Pay type field in the Order Payment Method table. If the message does not include a valid payment method, it will be in error status with an error reason of Invalid Pay Type, and the system creates a payment method on the order of 0. Defined in and validated against the Pay Type table.

charge_sequence

numeric 2 Updates the Charge sequence field in the Order Payment Method table. See the Chg seq field at the Display Order Payment Methods screen.

suppress_deposit_flag

alphanumeric 1 Updates the Suppress deposit field in the Order Payment Method table. Valid values are:Y = Suppress depositN or blank = Do not suppress depositYou can review the setting of this flag at the Display Order Pay Type screen (1 of 2).

suppress_refund_flag

alphanumeric 1 Updates the Suppress refund field in the Order Payment Method table. Valid values are:Y = Suppress refundN or blank = Do not suppress refundYou can review the setting of this flag at the Display Order Pay Type screen (1 of 2).

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


cc_name Not currently implemented.

cc_type Not currently implemented.

cc_number alphanumeric 20 Updates the Credit card number field in the Order Payment Method table; see the Credit card # field at the Display Order Pay Type screen (1 of 2). CWSerenade retains the case of the value passed in this field. Required for credit card payment methods except for Bill Me Later and On Account, or the order will be in error with a reason of Invalid Credit Card. Tokenization: If you use Credit Card Tokenization, the system looks at the setting of the already_tokenized tag to determine if the number in the cc_number tag is the actual credit card number or a token provided by the service bureau. Encryption: If you use credit card encryption, once the order is created in CWSerenade, the system encrypts the value in this field in the CWSerenade database to provide additional security of credit card data.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


cc_exp_month numeric 2 Updates the first two positions of the Expiration date field in the Order Payment Method table; see the Expiration date at the Display Order Pay Type screen (1 of 2). The Require expiration date flag for the pay type controls whether an expiration date is required for credit card payment methods. The expiration month passed must represent a valid month of the year; that is, it must be a number from 1 or 01 (January) to 12 (December); also the expiration month and year must not be more than 20 years in the future. If the pay type requires an expiration date and it is not passed correctly in the message, the order will be in error with a reason of CC Expiration/Start Date.

cc_exp_year numeric 2 Updates the second two positions of the Expiration date field in the Order Payment Method table; see the Expiration date at the Display Order Pay Type screen (1 of 2). The Require expiration date flag for the pay type controls whether an expiration date is required for credit card payment methods. The expiration month and year must not be more than 20 years in the future. If the pay type requires an expiration date and a valid date is not passed in the message, the order will be in error with a reason of CC Expiration/Start Date.

cc_sec_value Not currently implemented.

cc_sec_presence


cc_iss_bank alphanumeric 10 Updates the Issuing bank field in the Order Payment Method table. This field is not currently used.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


defer_bill alphanumeric 1 Indicates whether to automatically apply a default payment plan if the order qualifies. Valid values are:• Y = Automatically assign a payment plan to the order using the normal hierarchy; however, if there is a flexible_payment_code specified in the message, use that payment plan• N or blank = Do not assign a payment plan automatically

flexible_payment_code

alphanumeric 5 Updates the FPO payment code field in the Order Payment Method table; this value indicates the deferral or installment details to specify for the order payment method. If this attribute specifies a valid payment plan, the system does not use the regular hierarchy to select a payment plan for the order. Used for credit card payment methods. Defined in and validated against the Flexible Payment Option table. See the Display Order Pay Type screen (2 of 2) for the flexible payment code assigned to the order. If the flexible payment code specified is not valid, the order will be in error.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


amt_to_charge numeric 9.2 Updates the Amount to charge field in the Order Payment Method table; see the Amount to charge field at the Display Order Pay Type screen (1 of 2). For a coupon/gift certificate or cash/check payment method, also updates the Amount collected field. Required if the payment method is not the only one on the order. A negative amount represents a credit against the payment method.If you do not specify an amount and there is another payment method on the order without an amount specified, the order will be in error with a reason of Multiple CCs with $0. This error indicates that the order can have only one “catch-all” payment method.

auth_number alphanumeric 16 Used for credit card payment methods.Relate stored value card integration: If you are using the Relate stored value card integration and the web order contains an approved Relate stored value card pay type, the auth_number attribute should contain the transaction ID received from Relate and not the authorization code received from Relate. Updates the Authorization number field in the Order Payment Method table; see the Authorization number at the Display Order Pay Type screen (1 of 2). Creates an authorization history record; see Creating Authorization History for Orders Authorized on the Web.

auth_date numeric 8 Updates the Authorization date field in the Order Payment Method table; see the Authorization date at the Display Order Pay Type screen (1 of 2). MMDDYYYY format. Used for credit card payment methods.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


auth_amount numeric 9.2 Updates the Manual auth amount field in the Order Payment Method table; see the Authorization amount at the Display Order Pay Type screen (1 of 2). Used for credit card payment methods.

gc_type Not currently implemented.

gift_certificate_number

numeric 7 Updates the Gift cert/coupon field in the Order Payment Method table. Required if the payment_type in the message is a coupon/credit. If this number:• Matches a record in the Coupon Redemption table, this coupon, credit or gift certificate is applied to the order as a payment method; the Coupon $, if any, specified in the table updates the Amount to charge at the Display Order Pay Type screen (1 of 2). In this situation, the amount_to_chg specified in the message is ignored when creating the payment method.• Does not match a record in the Coupon Redemption table, the system creates a coupon or credit payment method on the order; however, the Dynamic Creation of Coupons (B21) system control value must be selected, or the order will be in error because of an Invalid coupon.

gift_certificate_amount


expiration_date


hold_id Not currently implemented.

ar_type Not currently implemented.

po_number Not currently implemented.

check_number numeric 9 Updates the Check number field in the Order Payment Method table. Used for cash/check payment methods.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


check_amount Not currently implemented.

checking_account

alphanumeric 20 Updates the Checking account field in the Order Payment Method table; see the Acct# field at the Display Order Pay Type screen (1 of 2). Used for cash/check payment methods.

routing_number

numeric 9 Updates the Routing number field in the Order Payment Method table; see the Routing# field at the Display Order Pay Type screen (1 of 2). Used for cash/check payment methods.

svc_id numeric 9 The ID number for the stored value card payment. Define an ID number only if your stored value card processor supports it. CWSerenade stores the ID number in the OPM SVC ID Storage field in the Order Payment Method table and includes it in the authorization request and deposit request sent for the stored value card payment.Available in XML version: 4.0 (release 2.5 of CWSerenade).

cash_control_number

numeric 5 Updates the Cash control number field in the Order Payment Method table; see the Cash control # at the Display Order Pay Type screen (1 of 2). Used for cash/check payment methods.

start_date numeric 4 Indicates the first date when the card is effective. MMYY format. The Require start date flag for the pay type controls whether a start date is required for credit card pay types. If a start date is required and it is not provided in the message, the order will be in error with a reason of CC Expiration/Start Date.Typically used for debit card or stored value card pay types.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


card_issue_nbr

alphanumeric 2 A sequential issue number, issued by the bank, indicating how many times the card has been replaced. The Require issue # flag for the pay type controls whether an issue number is required for credit card pay types. If an issue number is required and it is not provided in the message, the order will be in error with a reason of Invalid Card Issue#.

soc_sec_nbr numeric 9 Used for a Bill Me Later pay type. Because the social security number is treated here as a numeric value, it should be zero-filled if just the last four digits are included. For example, if the customer enters 1234 as the last four digits of the social security number, this attribute should be set to 000001234 in order to update the Customer Sold To BML table correctly. The social security number is not required if the customer already has a Bill Me Later account number, as shown at the Display Customer Order History screen. However, if the customer does not already have a Bill Me Later account and the last four digits of the social security number are not provided, the order will be in error with a reason of Invalid social security number. The system updates the Customer Sold To BML table with the social security number provided, so this information will be available when you send the order out for authorization.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


bml_version numeric 5 Used as the terms and conditions (T&C) code when creating an account for a customer with a Bill Me Later payment method. If a T&C code is not included in the message, the system uses the BML T&C version (web site) specified for the Bill Me Later pay type. The terms and conditions code should be zero-filled in order to update the Customer Sold To BML table correctly. For example, a terms and conditions code of 123 should be passed as a bml_version of 00123.

birthdate numeric 8 Used for a Bill Me Later pay type. MMDDYYYY format. The date of birth should be zero-filled in order to update the Customer Sold To BML table correctly. For example, if the customer’s date of birth is August 25, 1953, the birth date should be 08251953. The date of birth is not required if the customer already has a Bill Me Later account number, as shown at the Display Customer Order History screen. However, if the customer does not already have a Bill Me Later account and the date of birth is not provided, the order will be in error with a reason of Invalid date of birth. The system updates the Customer Sold To BML table with the birth date provided, so this information will be available when you send the order out for authorization.

authentication_value

alpha 40 A code received from an authentication service, such as Visa’s Verified by Visa program or MasterCard’s SecureCode program, indicating whether the card authentication password the cardholder provided was approved for the credit card. Updates the Authentication value field in the Order Payment Method table.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


ecommerce_indicator

alpha 4 Represents either:• An electronic commerce indicator code, received from an authentication service such as Visa’s Verified by Visa program or MasterCard’s SecureCode program, indicating the level of security provided for a credit card transaction placed over the internet.• A value indicating if the order was placed on a web storefront. Valid values are:

• YES = The order was placed over the web storefront.

• NO = The order was not placed over the web storefront.

Updates the Ecomm Indic field in the Order Payment Method table.

cc_last_four numeric 4 The last four digits of the credit card number in order to verify the card with the customer. Updates the CC Last 4 field in the Order Payment Method table. If this value is not passed, the system updates the CC Last 4 field with the last four digits of the cc_number. Available in XML version: 4.0 (release 2.5 of CWSerenade).

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


already_tokenized

alphanumeric 1 Indicates whether the number in the cc_number tag is a token. Y = The number in the cc_number tag is a token and not the actual credit card number. N or blank = The number in the cc_number tag is the actual credit card number. If the Use Credit Card Tokenization (L18) system control value is selected, the Request token field for the service bureau defined for the pay type is selected, the system performs credit card tokenization when CWSerenade receives the web order Updates the Tokenized field in the Order Payment Method table. Available in XML version: 4.0 (release 2.5 of CWSerenade).

cc_bin_nbr alphanumeric 6 The first six digits of the actual credit card number in order to perform Level II and III discounting on the card during deposit processing. Updates the Bin field in the Order Payment Method table if the credit card number is replaced with a token (the Tokenized field for the Order Payment Method record is Y; otherwise, the system does not store the bin number. If this value is not passed and the credit card number is replaced with a token, the system updates the Bin with the first 6 positions of the cc_number. Available in XML version: 5.0 (release 3.0 of CWSerenade).

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


transaction_id alphanumeric 40 The transaction ID, or reference number, associated with the authorization defined for the credit card payment.If a transaction ID and authorization number are defined for a credit card payment, the system creates an authorization history record for the payment when the web order is successfully created in CWSerenade; you can review authorization history on the Display Authorization History screen in Order Inquiry. See Creating Authorization History for Orders Authorized on the Web. Updates the Transaction ID in the Authorization History table. Available in XML version: 5.0 (release 3.0 of CWSerenade).

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


vendor_response

alphanumeric 10 The authorization response code received from the authorization service for the credit card payment method.If a vendor response and authorization number are defined for a credit card payment, the system creates an authorization history record for the payment when the web order is successfully created in CWSerenade; you can review authorization history on the Display Authorization History screen in Order Inquiry. See Creating Authorization History for Orders Authorized on the Web. The system looks at the Credit Card Vendor Response table to find a match to the authorization response code from the authorization service. If the authorization response is associated with a hold reason, the system:

• places the order on AT Declined Credit Card hold.

• places the credit card payment method on the hold reason defined in the CC Vendor Response table. If the response does not exist in the CC Vendor Response table, the system places the payment method on AV Invalid Response Code hold.

• if the credit card is approved, but is placed on AVS or CID hold, updates the status of the authorization history record to O Authorized But Not Used.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


If an entity dollar limit by item class or postal code is defined for the response code, the system:



Note: CWSerenade does not validate that the response code is a valid response for the authorization service defined for the credit card payment method.Updates AUH vendor response in the Authorization History table. Available in XML version: 6.0 (release 3.5 of CWSerenade).

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


avs_response alphanumeric 10 The address verification response code received from the authorization service for the credit card payment method. If a vendor response, AVS response, and authorization number are defined for a credit card payment, the system creates an authorization history record for the payment when the web order is successfully created in CWSerenade; you can review authorization history on the Display Authorization History screen in Order Inquiry. See Creating Authorization History for Orders Authorized on the Web.The system looks at the Credit Card Vendor Response table to find a match to the AVS response code from the authorization service. If the AVS response is associated with a hold reason, the system:




Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0





Note: CWSerenade does not validate that the response code is a valid response for the authorization service defined for the credit card payment method.Updates AUH AVS response in the Authorization History table. Available in XML version: 6.0 (release 3.5 of CWSerenade).

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


cid_response alphanumeric 10 The credit card identification response code received from the authorization service for the credit card payment method.If a vendor response, CID response, and authorization number are defined for a credit card payment, the system creates an authorization history record for the payment when the web order is successfully created in CWSerenade; you can review authorization history on the Display Authorization History screen in Order Inquiry. See Creating Authorization History for Orders Authorized on the Web.The system looks at the Credit Card Vendor Response table to find a match to the AVS response code from the authorization service. If the AVS response is associated with a hold reason, the system:




Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0





Note: CWSerenade does not validate that the response code is a valid response for the authorization service defined for the credit card payment method. Available in XML version: 6.0 (release 3.5 of CWSerenade).

ShipToThe ShipTos element can include one or more ShipTo elements. At least one ship to is required.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


arrival_date numeric 8 The date when the customer wants to receive the order. MMDDYYYY format.You can enter a future date to ship the order at a later date. If the message does not provide a date or if the date is invalid, the system uses the current date.Note: The system allows you to pass an arrival date earlier than the order date. Influence on ReservationThe arrival date on the order controls whether inventory is reserved for each order detail line. The system uses this calculation: arrival date - reservation lead days (B27) = reservation date.The system will not reserve inventory if the system calculated date is greater than today’s date. This is considered a future order. The system identifies each item on the order as a future order line and assigns a backorder status to each item.Note: If the Reservation Lead Days (B27) system control value is 0, the system does not calculate whether the order is a future order and reserves inventory for the lines on the order. Updates the Arrival date in the Order Ship To table; see the Arrival date at the Display Order Properties screen.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


cancel_bo alphanumeric 1 Updates the Cancel BO? field in the Order Ship To table. Defaults to N if this value is not set to Y.If this field is selected, any unshipped line on an order will be canceled during billing using the Auto Soldout Cancel Reason (C20), provided this system control value specifies a valid cancel reason code.Note: If you do not pass a value in the cancel_bo attribute and the Auto Cancel B/O field for the sold to customer is selected, the system updates the Cancel BO? field in the Order Ship To table to Y. However, if you pass N in the cancel_bo attribute and the Auto Cancel B/O field for the sold to customer is selected, the system updates the Cancel BO? field in the Order Ship To table to N.

cancel_bo_date

numeric 8 Updates the Cancel date field in the Order Ship To table. Uses a date in the past if provided in the message; otherwise, if the message does not provide a date or if the date is invalid, leaves the cancel date blank. If the cancel date has already passed, the order will be in error. MMDDYYYY format.

contact_name alphanumeric 30 Updates the Contact name field in the Order Ship To table.

fedex_number alphanumeric 10 Updates the Federal express # field in the Order Ship To table

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


freight numeric 7.2 A flat freight fee for the order ship to. This fee will be used as the shipping charge on the order, regardless of any system-calculated freight charges.Updates Freight in the Order Ship To table, and sets the Freight override? flag to Y. Use the freight_tax_amount attribute to define the tax override amount on freight.Note: If a freight override exists, the system does not apply any additional freight, item charges, weight charges, or service charges to the order.

freight_tax_amount

numeric 7.2 The tax override amount on freight. If an override amount is passed, the system does not calculate tax on freight. Note: Used only if a freight override amount is passed in the freight attribute.Updates OST Freight tax override in the Order Ship To table. The system uses the freight tax amount to calculate the tax rate for the freight override using the following calculation: (freight override amount / freight tax override) x 100 = freight tax rate

The system stores the tax rate for the freight override in the OST Freight tax rate field in the Order Ship To table; the system uses the freight tax rate during return and cancellation processing to determine the amount of tax on freight that should be returned or deducted during cancellation.No freight tax amount will be charged for the order if you pass the freight_tax_amount as 0.00 or blank and enter Y in the freight_tax_override attribute. Available in XML version: 6.0 (release 3.5 of CWSerenade).

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


freight_tax_override

alpha 1 If set to Y and you pass the freight_tax_amount as 0.00 or blank, no freight tax amount will be charged for the order. The system also updates the Freight Tax Override Y/N field in the Order Ship To table to Y.If any other value is passed, the order API uses the amount, if any, passed in the freight_tax_amount as the tax override amount on freight.

Available in XML version: 6.0 (release 3.5 of CWSerenade).

shipping_method

numeric 2 Updates the VIA ship via code in the Order Ship To table. The ship via must be eligible to ship the items on the order.Ship via codes are defined in and validated against the Ship Via table. If the shipping address on the order qualifies for van delivery, the system defaults the ship via code defined in the Default Van Delivery Ship Via (L07) system control value to the order header. If you define the van delivery ship via in this attribute, the system validates that the shipping address on the order qualifies for van delivery and that the ship_to_warehouse is either blank or contains the Reserve warehouse defined for the shipping address. If no shipping method is specified here and the shipping address on the order does not qualify for van delivery, the system uses the Default Ship Via (A77) from the System Control table. If this ship via matches the Best Way Ship Via for Auto-Assignment (J67), then the system automatically assigns the “best way” ship via with the lowest overall shipping charges to the order.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


SCF/ship via validation: The Perform ship via edit? flag for the country controls whether to validate the SCF and ship via on an order or order line against the SCF Ship Via table.

gift alphanumeric 1 Updates the Gift order flag in the Order Ship To table. Defaults to N if this value is not set to Y.

tax_exempt alpha 1 Allows you to pass exemption/resale information for the order ship to, regardless of the tax status of the sold to customer on the order.• E = Exempt. Indicates that the order ship to is considered tax-exempt. A tax-exempt certificate number is required in the resale_exempt_id attribute if an exempt certificate is not defined for the sold to customer; otherwise, the system ignores the setting of this attribute. The system does not calculate standard tax or VAT, if applicable, on the order ship to.• R = Resale. Indicates that the order qualifies as a reseller. A reseller is a person or company who purchases goods to sell to someone else. A reseller certificate number is required in the resale_exempt_id attribute if an exempt certificate is not defined for the sold to customer; otherwise, the system ignores the setting of this attribute. The system does not calculate standard tax or VAT, if applicable, on the order ship to.• Blank or any other value= Use existing logic to determine whether the purchases for the order ship to are taxed, and if they are, how to calculate tax. Updates Tax code in the Order Ship To table.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


Note:

• The exemption/resale information you pass applies to the order ship to only; the system does not update the customer sold to with the exemption/resale information.

• If the sold to customer on the order is tax exempt (the Tax exempt field is set to either Exempt or Resale for the sold to customer) and you do not pass a tax_exempt code, the system places the order in error: Invalid Tax Code. Tax Code Required.

• If you pass a freight override and freight tax override in the freight and freight_tax_amount attributes, the system applies tax and freight charges to the order, regardless of whether the sold to customer or order is exempt from tax.


Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


resale_exempt_id

alphanumeric 15 The resale or exempt certificate number.Used if the sold to customer is tax exempt (the Tax exempt field is set to either Exempt or Resale for the sold to customer) or if you pass E (Exempt) or R (Resale) in the tax_exempt attribute.Note:

• The exemption/resale information you pass applies to the order ship to only; the system does not update the customer sold to with the exemption/resale information.

• If the sold to customer on the order is tax exempt (the Tax exempt field is set to either Exempt or Resale for the sold to customer) and you do not pass a tax_exempt code, the system places the order in error: Invalid Tax Code. Tax Code Required.

• If you pass a freight override and freight tax override in the freight and freight_tax_amount attributes, the system applies tax and freight charges to the order, regardless of whether the sold to customer or order is exempt from tax.

Updates the Resale/exempt # in the Order Ship To table.

ship_complete alphanumeric 1 Updates the Ship complete? field in the Order Ship To table. Defaults to N if this value is not set to Y.

priority numeric 1 Updates the Priority field in the Order Ship To table. If no priority is passed in the message, this field defaults from the source code.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


calc_frt alphanumeric 1 Updates the Calculate freight flag for the order ship-to. Valid values are:• blank or Y = calculate freight using the regular calculation• N = do not calculate freight (no freight will be added)

discount_pct numeric 5.2 Updates the Discount % field in the Order Ship To table. If a discount percentage is specified here, the system applies it to item prices in addition to other discounts that might apply, such as a Price discount % specified for the customer or a Discount % for the source code.

customer_ship_to_number

numeric 9 Updates the CST customer # field in the Order Ship To table. Complete this attribute only when the order is shipping to:• another customer sold-to, different from the customer who places the order, who receives all or part of the order (recipient customer). In this situation, the ship_to_type is 2; or,• a permanent ship-to address for the customer. In this situation, the ship_to_type is 3, and this number should identify the sold-to customer number for the order.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


ship_to_type alphanumeric 1 Indicates the type of shipping address to use for the order. Valid values are:• 1 = order-level shipping address• 2 = recipient customer sold-to, indicate with the customer_ship_to_number• 3 = permanent ship-to, indicated with the permanent_ship_to_number; in this case, the customer_ship_to_number should match the sold-to customer• blank = use the shipping address of the sold-to customer on the orderIf no ship_to_type is specified and there is an alternate shipping address in the message, the Default Recipient Type for E-Commerce Orders (H33) defaults. See Creating or Selecting Shipping Addresses or Customers for an overview.

Use the following attributes if the shipping address is different from the sold-to customer. The system uses the ship_to name and address attributes listed below to:• match to an existing sold-to or permanent ship-to customer, or• create a new sold-to or permanent ship-to customerSee Creating or Selecting Shipping Addresses or Customers for an overview.Note: • If you are creating a new sold-to or permanent ship-to customer and the name and address information specified in the message does not represent a complete, valid name and address, the order will be in error. Also, the order will be in error if the information in the message represents an existing sold-to or permanent ship-to customer whose name and address is currently invalid.

ship_to_prefix alphanumeric 3 Validate Prefix (I27) system control value is selected, the prefix is validated against the Prefix table. See the sold_to_prefix for more information. Otherwise, if the system control value is not selected, a prefix that exceeds the field length of three positions is truncated.

ship_to_fname alphanumeric 15

ship_to_initial alphanumeric 1

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


ship_to_lname alphanumeric 25

ship_to_suffix alphanumeric 3

ship_to_company

alphanumeric 30

ship_to_address1

alphanumeric 32 Shipping to a Post Office BoxTo ship to a Post Office Box, enter POST OFFICE BOX, POST BOX, or any variation of PO BOX (with or without spaces or non-alphabet characters, such as P.O. BOX), and the box number in the customer’s street address. During order processing, the system validates that the carrier can ship to a post office box (as defined in the Ship Via table).Example: Enter P.O. Box 9999 in the Street field to indicate delivery to a post office box instead of a home or company address.Note: If you type POST OFFICE BOX, POST BOX, or any variation of PO BOX in the customer’s street address during order entry or through the Order API, the system automatically selects the PO box field for the customer. However, if you remove this text from the customer’s street address, the system does not automatically unselect the PO box flag.

ship_to_address2

alphanumeric 32

ship_to_address3

alphanumeric 32

ship_to_address4

alphanumeric 32

ship_to_apartment

alphanumeric 10

ship_to_city alphanumeric 25

ship_to_state alphanumeric 2 Required only if the Require state? flag is selected for the country.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


ship_to_zip alphanumeric 10 Required only if the Require postal code? flag is selected for the country.

ship_to_country

alphanumeric 3 Required if a ship-to address is provided.

ship_to_email alphanumeric 50 If the email address is not properly formatted, the order will be in error. Case: The email address is always saved in lowercase; for example, if the ship_to_email is [email protected], the system saves it as [email protected].

ship_to_busres

alphanumeric 1 Valid values are:• B = business• R = residence

ship_to_day_phone

alphanumeric 14 The phone numbers, if provided, should be unformatted; or, if it is formatted, it should be correctly formatted based on the phone number formatting specified for the customer’s country to create, match, or update the customer correctly.The third number is displayed on screens and reports as the fax or mobile number, based on the setting of the Third Phone Number Type (L53) system control value.Updating the one-time ship-to address: If the ship_to_type is 1, indicating to create a one-time ship-to address, the phone number for the one-time ship-to address is derived from the ship_to_day_phone, if it is provided in the message; otherwise, the one-time ship-to phone number is from the ship_to_evening_phone. The ship_to_fax_phone does not update the one-time ship-to address, even if it is the only phone number provided for the ship-to address.

ship_to_evening_phone

alphanumeric

ship_to_fax_phone

alphanumeric

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


email_gc alphanumeric 1 Updates the Email gift certificate field in the Order Ship To table. Defaults to blank if this value is not set to Y.

permanent_ship_to_number

numeric 3 Used for ship_to_type 3 to identify the permanent shipping address to use. In this case, the customer_ship_to_number should indicate the sold-to customer on the order. See Creating or Selecting Shipping Addresses or Customers.

ship_to_warehouse

numeric 3 The warehouse used to ship the entire ship-to order; this warehouse code defaults to the order header. Leave blank if you want the system to select the warehouse.Warehouse Default Hierarchy for the Ship-To1. Use the ship_to_warehouse attribute

in the CWOrderIn message. Overrides all warehouse codes except those entered for an individual order line.

2. Use the Reserve warehouse from the shipping address on the order if it qualifies for van delivery.

3. Use the non-allocatable warehouse from the order type on the order if the Reserve from Non-Allocatable Warehouse (J25) system control value is selected.

4. Leave the Warehouse field on the order header blank.

Updates the warehouse for the order ship to. Defined in and validated against the Warehouse table.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


ship_to_po_number

alphanumeric 15 Updates the Purchase order # field in the Order Ship To table. If the Verify Duplicate PO Numbers for A/R Orders (D80) system control value is selected and the purchase order number is a duplicate, the order will be in error with a reason of Duplicate PO#. Also, if the PO Required for A/R Orders (D79) system control value is selected and no purchase order number is specified, the order will be in error with a reason of Missing PO#-Req for A/R.

gift_message N/A N/A Not currently implemented.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


promotion alphanumeric 7 If the Allow Manual Entry of Promotion Code (I63) system control value is:• selected: the promotion listed here is applied to the order, provided the order qualifies, the promotion’s Required entry flag is selected, and there is not another promotion of the same type that comes before this promotion in the hierarchy. If a promotion is specified and the order does not qualify for it, the system continues creating the order and writes an order history message such as: Promotion (ADDFRT) not applied. However, if a promotion code specified in the message does not actually exist, the order will be in error with a reason of Invalid Promotion Code. Also, additional promotions whose Required entry flag are unselected might also apply to the order. • unselected: the system ignores any promotion code passed and determines which promotions, if any, to apply to the order based on the hierarchy based on the setting of the Best Way Promotions (K44) system control value.Note: You can use this promotion attribute to apply a promotion to the order, or you can use the Promotion element to apply one or more promotions.

store_code alphanumeric 12 The store code where the customer wants to pick up a ship-to-store or store pickup order. Must be a valid store code identifying a store location; see below for more information on validation of the store_code and the delivery_type. The name and address from the Store Cross Reference record defaults as the ship-to address for the order. Available in XML version: 4.0 (release 2.5 of CWSerenade).

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


delivery_type alphanumeric 1 A setting of P identifies a store pickup order, and a setting of S identifies a ship-to-store order. Not included for any other type of order; see below for more information on validation of the store_code and the delivery_type. Errors:

• For a store pickup order, the customer must have an email address with its opt-in/out flag set to either O1 (all emails) or O2 (order-related emails) or the order will be in error with a reason of Email Missing/Ineligible.

• If the Payment at POS for Ship to Store (L60) system control value is selected, this is a ship-to-store order, the order type does not match the Order Type for Special Orders (L15) system control value, and the order includes a payment method that is not a credit card with a Card type of Credit, the order will be in error with a reason of Non-CC on Ship To Store.


Validation of the store_code and delivery_type:

• If the delivery_type is S (ship-to-store) or P (store pickup) and the store_code is a valid store, creates a ship-to-store or store pickup order.

• If the delivery_type is anything but S or P or is not included, or if there is a delivery_type but no store_code, creates a regular order with no error (assuming no other problems with the order).

• If the delivery_type is S or P and there is not a valid store_code, puts the order in error; however, you can correct the order in batch order entry and when you accept the batch, the order is created correctly. (To correct, select a store for a ship-to-store order, or do a store pickup search for a store pickup order.)

alternate_ship_to_id

N/A N/A Not currently implemented.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


add_chg_count

N/A N/A Not currently implemented.

already_eval_by_promote

alphanumeric 1 Defines whether the order has already been evaluated by an external promotion engine for eligible discounts. • Y = The order has already been evaluated by an external promotion engine for eligible discounts. • N or blank = The order has not been evaluated by an external promotion engine for eligible discounts.Updates Promote already evaluated in Order Ship To table.Note: This field is not currently implemented.Available in: 7.0 (release 4.0 of CWSerenade).

promote_maint

alphanumeric 1 Defines whether the system calls an external promotion engine during Order Maintenance for this order. • Y = The system calls an external promotion engine during Order Maintenance for this order. • N or blank = The system does not call an external promotion engine during Order Maintenance for this order. Updates Allow Promote in OM in Order Ship To table. Note: This field is not currently implemented.Available in: 7.0 (release 4.0 of CWSerenade).

relate_award_amount

numeric 7.2 The award coupon amount to apply to the order as a pro-rated merchandise discount. Evaluated only if the amount is .01 or greater and the Use Relate Loyalty (M06) and Prorate Dollar Discounts and Coupons (D90) system control values are selected. Available in: 8.0 (release 4.5 of CWSerenade).

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


AdditionalChargeThe AdditionalCharges element, if provided, can include one or more AdditionalCharge elements.

additional_charge_seq_nbr

numeric 3 Not currently implemented.

additional_charge_code

alphanumeric 2 Updates the Add’l chg code in the Order Additional Charge table. Not validated against the Additional Charge table.

additional_charge_amount

numeric 7.2 Updates the Add’l charges field in the Order Additional Charge table. Can include a minus sign before or after the amount if the charge is negative, applying a credit to the order.Note: If no additional_charge_amount is passed in the message and there is a Default charge amount specified for the additional charge code, the default charge applies.

Ord_MsgThe Ord_Msgs element, if provided, can include one or more Ord_Msg elements.Note: You can include up to 250 order message lines.

ord_msg_text alphanumeric 60 Updates the Message field in the Order Message table. Saved in the upper and lowercase if that is how the text is passed in the inbound message. Messages longer than 60 positions are truncated.Note: The User displayed for the message is the first six positions of the entered_by_user.

ord_msg_code alphanumeric 1 Updates the Print? flag in the Order Message table. Note: If the value specified here is not a valid value for the Print flag, or if no value is specified here, the message is still created, but the Print flag is set to blank (which is the same as N or do not print).

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


PromotionIf the Allow Manual Entry of Promotion Code (I63) system control value is:• selected: the promotions listed here are applied to the order, provided the order qualifies, the promotion’s Required entry flag is selected, and there is not another promotion of the same type that comes before this promotion in the hierarchy. If a promotion is specified and the order does not qualify for it, the system continues creating the order and writes an order history message such as: Promotion (ADDFRT) not applied. However, if a promotion code specified in the message does not actually exist, the order will be in error with a reason of Invalid Promotion Code. Also, additional promotions whose Required entry flag is unselected might also apply to the order. • unselected: the system ignores any promotion code passed and uses its regular hierarchy in determining which promotions, if any, to apply to the order.Note: You can use this promotion attribute to apply one or more promotions to an order, or use the promotion attribute to apply a single promotion to the order.


promotion_code

alphanumeric 7 The promotion code to apply to the order. See the description of the Promotion element, above, for more information.

CertificateCertificates are coupons provided by the Rewards system that a sold to customer who is enrolled in the Rewards membership program can apply to an order. The setting of the Rewards Certificates Pay Type (L54) system control value controls whether the system applies the certificates to the order as order payments or as a pro-rated merchandise discount. Available in XML version: 4.0 (release 2.5 of CWSerenade).

certificate_number

alphanumeric 40 The certificate number to apply to the order. Updates the Certificate # field in the Order Rewards Certificate table.

certificate_amount

numeric 7.2 The dollar amount of the certificate to apply to the order. Updates the Certificate amount field in the Order Rewards Certificate table.

transaction_id alphanumeric 40 The transaction ID returned by the Rewards system, authorizing the certificate as a discount for the order.Updates the Transaction # field in the Order Rewards Certificate table.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


ItemThe Items element can include one or more Item elements. At least item is required.Note: To create an order that includes a set or continuity item, the message should include the master set or continuity item only. The set or continuity will be "exploded" once the order is created, and all of the component items will be added to the order.

drop_ship alphanumeric 1 If the item is not flagged as Drop ship in the Item table: enter D to update the Drop ship flag field in the Order Detail table. Flagging the item as a drop ship on the order prevents it from reserving, even if you have inventory available, and prevents the system from submitting the order line as a brokered backorder to Locate.If the item is flagged as Drop ship in the Item table: enter O to override the order line to exclude it from drop ship processing and fulfill it from your warehouse.

no_charge alphanumeric 1 Updates the No charge field in the Order Detail table. If this flag is set to Y, the order detail line will be “no charge”; otherwise, regular pricing applies.A prc_ovr_rsn is required for a no-charge order line.

affect_inventory

alphanumeric 1 Updates the Affect inventory? field in the Order Detail table. Valid values:• Y or blank = Update inventory. If this is an express-bill order and the item does not exist in the line_warehouse specified, the order will be in error. If this is an express-bill order and the item exists in the line_warehouse and location, but there is no inventory available, the system creates an inventory transaction (WITE) error.• N = Do not update inventory. The system does not perform an inventory transaction and does not create an inventory transaction error.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


line_arrival_date

numeric 8 The date when the customer wants to receive the item. MMDDYYYY format.You can enter a future date to ship the item at a later date. If the message does not provide a date or if the date is invalid, the system uses the current date.Note: The system allows you to pass an arrival date earlier than the order date. Influence on ReservationThe arrival date on the order line controls whether inventory is reserved for the line. The system uses this calculation: arrival date - reservation lead days (B27) = reservation date.The system will not reserve inventory if the system calculated date is greater than today’s date. This is considered a future order line. The system identifies the item on the order as a future order line and assigns a backorder status to the item.Note: If the Reservation Lead Days (B27) system control value is 0, the system does not calculate whether the order line is a future order line and reserves inventory for the line on the order. Updates the Arrival date field in the Order Detail table.

line_cancel_date

numeric 8 Updates the Cancel date field in the Order Detail table. Uses a date in the past if provided in the message; otherwise, if the message does not provide a date or if the date is invalid, leaves the line cancel date blank. MMDDYYYY format.

cord_group numeric 3 Updates the Coordinate group field in the Order Detail table.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


actual_price numeric 7.2 Updates the Price field in the Order Detail table if a prc_ovr_rsn is specified and the price_override flag is set to Y.

prc_ovr_rsn alphanumeric 1 Updates the Price Override Code field in the Order Detail table and the actual_price is used if the price_override attribute is set to Y. If the price override reason code specified here is not valid, the system uses the Price Override Reason for E-Commerce (G73), if any, or the Default Price Override Reason (B35); however, if no price override reason code is passed in the message, the system does not override the price on the order detail line, even if an actual_price is specified. Price table override: If the order uses price table pricing, no actual_price is specified for the item in the message, and the prc_ovr_rsn matches the Price Table Level Override Code (E05), then the order API applies the best price level available to the order line.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


Quantity price matrix: If the order uses quantity price matrix pricing and no actual_price is specified for the item in the message, then the order API uses the Quantity Price Matrix price hierarchy to apply a quantity price matrix price to the order line. If the item on the order line qualifies for a Quantity Price Matrix customer special, the system applies the discount price to the order line and assigns the Price Override Reason for Price Matrix Customer Specials (K42) to the order line during end of order pricing. Note: Do not use the Price Override Reason for Price Matrix Customer Specials (K42) as the override reason code for any manually entered price that you define in the actual_price. Order history message: Unlike interactive order entry, the order API does not write an order history message when the price is explicitly (rather than automatically) overridden.

quantity numeric 5 Updates the Qty ordered field in the Order Detail table. If no quantity is specified here, the system uses the Default Order Quantity (B30).A negative quantity (indicated by a minus sign (-) preceding the number) indicates a return. See Processing a Return for an overview.If the quantity specified here is not evenly divisible by the Sell quantity for the item/SKU, the order line will be in error with a reason of Multiples error.

bypass_reserve

alphanumeric 1 Updates the Bypass reservation field in the Order Detail table, and prevents the line from being reserved when set to Y.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


tax_override alphanumeric 1 Updates the Tax override field in the Order Detail table.If this flag is set to Y, the system does not call the regular tax routine or Vertex to calculate tax, and instead just uses the tax_amount passed in the message.Shipments: If you process multiple shipments against the line, the system prorates the tax override amount across the units shipped on the order line to determine the new tax override amount and the tax amount to apply to each shipment. Example: If the tax override amount for the order line is 9.00 and the order quantity is 3, the system charges 3.00 if you ship 1 unit of the item and then charges 6.00 if you ship the remaining 2 units of the item. Returns: If you process a return, the system prorates the tax override amount across the units ordered on the order line to determine the new tax override amount and the tax amount to return.

tax_amount numeric 10.5 Updates the Tax field in the Order Detail table if the tax_override flag is set to Y.

gst_amount numeric 10.5 Updates the GST field in the Order Detail table if:• the tax_override flag is set to Y• the tax_amount specifies a total tax amount for the order detail line• the customer is subject to Canadian tax (GST and PST) based on regular tax logicNote: The total GST and PST should equal the tax_amount; however, the system does not validate that the total gst_amount and pst_amount does not exceed the tax_amount specified.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


pst_amount numeric 10.5 Updates the PST field in the Order Detail table if:• the tax_override flag is set to Y• the tax_amount specifies a total tax amount for the order detail line• the customer is subject to Canadian tax (GST and PST) based on regular tax logicThe total GST and PST should equal the tax_amount; however, the system does not validate that the total gst_amount and pst_amount does not exceed the tax_amount specified.

gift_wrap alphanumeric 1 If set to Y, updates the Gift wrap flag in the Order Detail table and adds the gift wrap charge to the order; see the G/W and G/W $ at the Display Order Detail screen. If the item/offer or SKU/offer does not allow gift wrap, the order will be in error with a reason of Gift wrap not allowed.

cost_override_amount

numeric 11.4 Updates the Cost override field in the Order Detail table.

line_priority numeric 1 Updates the Priority field in the Order Detail table.

line_freight_override

alphanumeric 1 If set to Y, updates the Freight override? field in the Order Detail table and applies the line_freight_override_amount as the freight amount for the order detail line. If any other value is passed, the order API sets the Freight override? field to N. If the line_freight_override_amount is blank, then no freight will be charged for the order detail line.If the freight method on the order is not a line-level freight method, the order will be in error with a reason of Invalid line frt override.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


line_freight_override_amt

numeric 7.2 If the line_freight_override is set to Y and the freight method on the order is a line-level freight method, updates the Freight charge field in the Order Detail table; otherwise, the system ignores this value.

line_coupon_flag

alphanumeric 1 If set to Y, indicates that the line_coupon_amount should be applied to the order detail line. The same as setting the Cpn field at the Work with Order Line screen in interactive order entry.

line_coupon_amount

numeric 7.2 The discount amount to apply to the order detail line. This discount amount is the same as entering the Coupon amt field at the Work with Order Line screen in interactive order entry.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


personalization_id

alphanumeric 2 Updates the Add’l chg code in the Order Detail table. Overrides the additional charge code, if any, from the Item Offer or SKU Offer. Required if the item should have special handling; if no personalization_id is specified, the additional charge code from the Item Offer or SKU Offer does not default, regardless of the setting of the Suppress S/H window flag for the additional charge code. Use the personalization_line element to specify the special handling details for the order line. If the Item Offer or SKU Offer does not have the Special handling flag selected, the order will be in error with a reason of S/H code not allowed. If the value specified here does not represent a special handling code as set up through Work with Additional Charge Codes (WADC), the order will be in error with a reason of S/H code is invalid.You might use pass a personalization_id but no personalization charges or information in order to automatically put an order line on hold if the special handling format’s S/H hold flag is selected.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


personalization_cost

numeric 7.2 Updates the Special handling $ field in the Order Detail table. If no charge is specified here, the system uses the regular hierarchy to determine the special handling charge or price. Note: It is possible to add special handling charges without actually creating the special handling instructions for the order line if:• complete instructions are not specified in the personalization_line element, and• a personalization_id is specified, and

• a personalization_cost is specified here, or

• a S/H price is specified for the Item Offer or SKU Offer

You might use the above information to automatically put an order line on hold if the special handling format’s S/H hold flag is selected.

gc_number numeric 7 The system uses this number only when:• the item ordered on this order detail line is a gift certificate• the gift certificate number specified here is not already assignedOtherwise, if the item is a gift certificate, the system assigns a gift certificate number through the normal process.Note: Do not specify a gift certificate number if the quantity for the order detail line is more than 1; if you specify a gift certificate number, the system creates just one gift certificate.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


alias_item alphanumeric 12 Updates the Alias field in the Order Detail table. Used to identify the item and SKU for the order detail line. See Resolving the Item and SKU in the Order API. If Display Item Alias (D56) is selected, order inquiry displays the alias rather than the item code when you pass the alias rather than the item code in the message.

item_id alphanumeric 12 Updates the ITM number field in the Order Detail table. Used to identify the item and SKU for the order detail line. Must be a valid item code in CWSerenade. See Resolving the Item and SKU in the Order API. Note: • To create an order that includes a set or continuity item, the message should include the master set or continuity item only. The set or continuity will be “exploded” once the order is created, and all of the component items will be added to the order.• To create a customer membership, the item_id needs to be an item code that is identical to an active membership program. For example, to create a customer membership for membership program MEMB01, the item_id needs to be MEMB01; and MEMB01 needs to be a valid item code flagged as a membership item. • When a customer purchases a membership item and the payment information is passed separately, the system does not create the customer membership or apply any membership discount until receiving the payment message. In this situation, the system initially applies an error to the order: Missing Membership.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


sku alphanumeric 14 Updates the SKU code field in the Order Detail table. Used to identify the item and SKU for the order detail line. See Resolving the Item and SKU in the Order API.

short_sku_number

numeric 7 Used to identify the item and SKU for the order detail line. See Resolving the Item and SKU in the Order API.Note: When passing the UPC code, make sure to include any leading zeros. For example, if the UPC code is 06012011, pass 06012011 and not 6012011.

retail_ref_number

numeric 15

upc_type alphanumeric 3

upc_code alphanumeric 14

line_offer alphanumeric 3 Updates the OFR number field in the Order Detail table to control pricing and track demand. The system applies the offer to the order detail line only if there is a record of the item or SKU in this offer.

line_source_code

alphanumeric 9 Updates the Source code field in the Order Detail table. Also defaults to the order header if no header-level source code is specified in the message; see the source_code attribute for more information.Note: If a line-level source code is invalid, the order will be suspended with an error of Invalid Source Code.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


line_shipping_method

numeric 2 Updates the VIA ship via code field in the Order Detail table. The ship via must be eligible to ship the item on the order line.If you leave this attribute blank and the order line does not qualify for an item ship via override, the system uses the ship via code defined on the order header for the order line. If the ship via in this attribute matches the ship via in the Default Van Delivery Ship Via (L07) system control value, or if you leave this attribute blank and the ship via on the order header matches the van delivery ship via, the system validates that the shipping address on the order qualifies for van delivery and that the line_warehouse either contains the Reserve warehouse defined for the shipping address or is blank and the warehouse on the order header matches the Reserve warehouse defined for the shipping address.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


Returns and express bills: You can use the following values to process a return (see Processing a Return) or an express bill if the order has already shipped. If the message does not specify a warehouse and location for a return or express bill, the system uses the default warehouse and primary primary location for the item from the SKU table.Inventory transaction errors: Whether the warehouse and location are specified in the message or default from the SKU table, they must be eligible for the transaction or an inventory transaction error occurs with an error reason of Negative On Hand. A warehouse and location cannot process an express bill or a return if:

• the location is frozen

• the location is not pickable

• the warehouse is not allocatable

• there is no record of the item in the location, or not a sufficient quantity on-hand to process the express bill

Even though the order API creates the inventory transaction error record, it still creates the order without leaving it suspended due to the inventory transaction error, and the order is then eligible to be processed for billing. Order errors: If the warehouse or location that default or that are specified in the message are invalid, the order API does not create an inventory transaction error; instead, it leaves the order suspended and returns an error in the Detailed Order XML Response (CWORDEROUT) if the response_type is E. The warehouse or location are invalid if:

• the warehouse does not exist

• the location does not exist in the warehouse

See Order Creation Errors for more information on possible order API errors.

Note: If an express-billed order includes an A/R payment method, the order might briefly go into held status before it is processed by billing and its status changes to closed.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


line_warehouse

numeric 3 Defines the warehouse where the item will be reserved from. If the item cannot be reserved from this warehouse, the system places the item on backorder in this warehouse. Also used when processing a return (the quantity is negative) or an express bill. If the warehouse is not eligible for the express bill or return transaction, the order API creates an inventory transaction error. Updates the WHS warehouse field in the Order Detail table. If no warehouse is specified here, the order API: • uses the warehouse defined on the order header. • looks for a warehouse list for the SCF of the order ship to address. • uses the default warehouse for the item from the SKU record. If the item warehouse does not exist, the order will be in error with a reason of Item not valid for whs.

location alphanumeric 7 Indicates the location where the returned merchandise is placed, or where to affect inventory for an express bill line. If the item has not been previously placed in this location, the system creates an Item Location record.If no location is specified here, the order API uses the primary primary location for the item from the SKU record. If the location does not exist in the specified warehouse, the order will be in error with a reason of Missing Whse/Loc-No IT Ln. If the location is not eligible for the express bill or return transaction, the order API creates an inventory transaction error; see the discussion above for more information.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


return_reason numeric 3 Used to track a return. Use the Display Order Line History screen to review the return reason code used for an order detail line. The system leaves the return reason code for the order line blank if no reason is specified in the message. Similarly, if the message specifies a return reason code that does not exist in the Return Reason table, the system does not put the order in error; instead, it writes the value passed to the Order Line History and other tables that are normally updated as part of processing a return.

return_disposition

alphanumeric 2 Used to indicate how to process a return. If the message does not specify a valid return disposition value (that is, the return_disposition is invalid or is blank), the system uses the Default Disposition Code (C18).Note: The system uses this return disposition code to determine whether the return updates inventory and the warehouse and location to which the item is returned; however, the system does NOT store this return disposition on the RA Detail record.

price_override alphanumeric 1 If this field is set to Y and there is no prc_ovr_rsn specified, the system uses the Price Override Reason for E-Commerce (G73), if any, or the Default Price Override Reason (B35) when creating the order line.

Note: The following three values relate to creating a store fulfillment request. This option is not currently implemented.

pickup_type alphanumeric 2 Not currently implemented.

pickup_system_location

alphanumeric 10 Not currently implemented.

pickup_location

alphanumeric 10 Not currently implemented.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


line_entered_date


line_entered_time


line_hyperlink alphanumeric 256 Updates the Hyperlink field in the Order Detail table. If a link is passed, you can review it from the Display Hyperlink screen in order inquiry. Saved in upper and lowercase if that is how the link is passed in the inbound message. See Translating Special Characters for information on how to pass certain special characters using replacement text strings.Available in XML version: Version 4.0 (release 2.5 of CWSerenade).

Lin_MsgThe Lin_Msgs element, if provided, can include one or more Lin_Msg elements.

lin_msg_code alphanumeric 1 Updates the Print? field in the Order Line Message table.

lin_msg_text alphanumeric 60 Updates the Message field in the Order Line Message table.Saved in upper and lowercase if that is how the text is passed in the inbound message. Messages longer than 60 positions are truncated.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


personalization_lineThe personalization_lines element, if provided, can include one or more personalization_line elements. The system uses the following information to build special handling instructions for the order detail line if a valid personalization_id is specified:• Standard special handling:

• The personalization_type should be set to S (standard).• You can include one or more standard_text attributes to build one or multiple lines

of custom special handling instructions. If any standard_text entry exceeds 30 positions, the additional data in the special handling instructions is truncated.

• Custom special handling: • The personalization_type should be set to C (custom).• The message should always include data or a blank space in each

personalization line, and all lines sent in the sequence in which they were set up through Work with Custom Special Handling Formats (WSHF). If the personalization lines do not represent a complete, valid set of instructions according to the special handling format, the special handling code and charge are still added to the order; however, the order will either be in error, or the order line will include the special handling code and charge, but the instructions will be incomplete or missing.

Putting the order line on hold: If you use a special handling format whose S/H hold flag is selected, the order API automatically puts the order line on hold.

For more information: See the sample message formats under Inbound Order Message: Sample XMLs.

personalization_type

alphanumeric 1 Indicates the type of special handling. Valid values are:• C = Custom• S = StandardNote: If this value is the wrong type for the personalization_id, the order will not be in error; however, no special handling instructions will be built.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


personalization_text

alphanumeric 45 Used for custom special handling instructions. Updates the Input field in the Order Special Format table for custom special handling. Saved in the upper and lowercase if that is how the text is passed in the inbound message. You should send the personalization_line with the personalization_text set to “ “ in order to create a blank custom special handling line for the order so that the personalization information is created correctly. Note: Default text defined for the special handling format does not default for orders created through the Inbound Order Message.

Errors:If the text is not a valid entry for the custom special handling format, the order is in error with a reason of Input not valid response.If the text exceeds the maximum specified for the custom special handling format, the order is in error with a reason of Exceeds maximum character.If the text does not conform to a rule set up for the custom special handling format, the order is in error with a reason of SH Resp fail defined rule.

standard_text alphanumeric 30 Used for standard special handling instructions. Updates the S/H info field in the Order Special Handling table for standard special handling. Saved in the upper and lowercase if that is how the text is passed in the inbound message. There can be more than one lines of standard text included in multiple standard_text attributes. Any standard_text entry that exceeds 30 positions is truncated from the special handling instructions.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


CouponDetailAvailable in XML version: 2.0 (release 1.1 of CWSerenade).

coupon_detail_code

alphanumeric 6 Optionally, specify a detail-level coupon (Coupon type = D) to apply against an order detail line, or an order-level coupon (Coupon type = O) to apply against the order. The customer can apply multiple coupons against an item or order provided they pass all coupon edits.

ProfileThe profile data, if any, passed through this element updates the customer’s demographic data. You can review a customer’s demographic data at the Work with Customer Profile screen. You define customer profile categories, such as age, income, or gender, and the valid values for each category through Setting Up Customer Profiles (WPFL).Available in XML version: 3.0 (release 2.0 of CWSerenade).

profile_code numeric 3 Optionally, specify a profile code to identify demographic data for the customer. The profile_code represents the Profile code specified through Setting Up Customer Profiles (WPFL). In order to update the customer’s demographic data, the profile code you pass must already exist in the Profile table; however, if the profile code specified is invalid, the system does not put the order in error. You can review a customer’s demographic data at the Work with Customer Profile screen.• If the profile value you pass does not currently exist for the customer, the system creates the value for the customer.• If the profile value you pass already exists for the customer, the system updates the value. Updates the Profile code in the Customer Profile table.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


profile_value alphanumeric 1 The valid value set up for the Profile code. In order to update the customer’s demographic data, the profile value you pass must already exist in the Profile Data table; however, if the profile value specified is invalid, the system does not put the order in error. You can review a customer’s demographic data at the Work with Customer Profile screen.• If the profile value you pass does not currently exist for the customer, the system creates the value for the customer.• If the profile value you pass already exists for the customer, the system updates the value. Updates the PDA Profile data code in the Customer Profile table.

CouponAvailable in XML version: 2.0 (release 1.1 of CWSerenade).

coupon_code alphanumeric 6 Optionally, specify an order-level coupon (Coupon type = O) to apply against the order. The customer can apply multiple coupons against an order provided they pass all coupon edits.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


Inbound Order Message: Sample XMLs

Samples of the Inbound Order XML Message (CWORDERIN) are presented below.

Initial order message<Message source="String" target="String" type="CWORDERIN" >

<Header company_code="6" order_number="ABCDE" payment_only="N" nbr_ship_tos="1" pay_incl="Y" source_code="SOURCE" response_type="E" order_channel="I" sold_to_fname="Eddie" sold_to_lname="Conga" sold_to_address1="10 Main Street" sold_to_city="NATICK" sold_to_state="MA" sold_to_zip="01760" sold_to_country="USA" order_type="W" >



<ShipTo shipping_method="04" customer_ship_to_number="13163" ship_to_type="3" permanent_ship_to_number="1" discount_pct="5.00" ship_to_po_number="PONBR" >

<Items> <Item quantity="10" item_id="AB100" > </Item>

</Items> </ShipTo>


</Message>

Payment-only order message<Message source="String" target="String" type="CWORDERIN" >

<Header company_code="6" order_number="ZXYZ" payment_only="Y" nbr_ship_tos="1" pay_incl="Y" source_code="SOURCE" response_type="E" order_channel="I" >


</Payments> </Header>

</Message>

Sales transaction order message<Message source="cws_85_doc" target="cws_xx_doc" type="CWORDERIN">

<Header company_code="5" order_number="30000049" source_code="RETAIL" response_type="N" order_date="10132008" order_channel="P" customer_number="705" pay_incl="Y" order_type="P">

<Payments><Payment payment_type="1" suppress_refund_flag="Y" amt_to_charge="500" /><Payment payment_type="1" suppress_refund_flag="Y" amt_to_charge="-288" />

</Payments><ShipTos>

<ShipTo><Ord_Msgs>

<Ord_Msg ord_msg_text="POS Transaction #30000049" /></Ord_Msgs><Items>

<Item affect_inventory="N" actual_price="20.2" prc_ovr_rsn="P" quantity="1" tax_override="Y" tax_amount="0.01010"

CWSerenade 5.0


cost_override_amount="0.0000" item_id="KABSKU1 " sku="GRN " line_shipping_method="98">

<Lin_Msgs><Lin_Msg /></Lin_Msgs>

</Item></Items>

</ShipTo></ShipTos>

</Header></Message>

Quote order message<Message source="IDC" target="RDC" type="CWORDERIN" resp_qmgr="CWIAS400">

<Header company_code="7" order_number="120121" payment_only="N" source_code="SOURCE7" response_type="E" customer_number="56" pay_incl="N" order_type="T" sales_rep_number="1">

<ShipTos> <ShipTo arrival_date="01042010" ship_to_number="1" shipping_method="" gift="N">

<Items> <Item quantity="1" item_id="RF1234567890" /> <Item quantity="1" item_id="RF123SKU4567" sku="ROSE XSML WMNS" />

</Items> </ShipTo>


</Message>

Customer return order message<Message source="cws_xx_doc" target="cws_xx_doc" type="CWORDERIN">

<Header company_code="5" order_number="30000047" source_code="RETAIL" response_type="N" order_date="10132008" order_channel="P" alternate_sold_to_id="439" sold_to_prefix="MS." sold_to_fname="SARAH" sold_to_lname="BROWN" sold_to_address1="257 APPLE Street" sold_to_city="Worcester" sold_to_state="MA" sold_to_zip="01602" sold_to_country="USA" sold_to_day_phone="5085550100" sold_to_eve_phone="5085550101" sold_to_address_update="N" pay_incl="Y" order_type="P">

<Payments><Payment payment_type="99" suppress_deposit_flag="Y" suppress_refund_flag="Y" cc_number="511111111111118" cc_exp_month="01" cc_exp_year="39" auth_date="10132008" auth_amount="-26.25" />


<ShipTo><Ord_Msgs>

<Ord_Msg ord_msg_text="POS Transaction #30000047" /><Ord_Msg ord_msg_text="Original Transaction #30000016" />

</Ord_Msgs><Items>

<Item affect_inventory="N" actual_price="25.00" prc_ovr_rsn="P" quantity="-1" tax_override="Y" tax_amount="-1.25000" cost_override_amount="0.0000" item_id="2VSSHIRT-976" line_shipping_method="98" return_reason="44" return_disposition="SR">

<Lin_Msgs><Lin_Msg /></Lin_Msgs>

</Item></Items>

CWSerenade 5.0


</ShipTo></ShipTos>

</Header></Message>

CWOrderIn message with custom special handling<Message source="string" target="string" type="CWORDERIN" >

<Header company_code="6" payment_only="N" source_code="SOURCE" response_type="E" order_channel="I" customer_number="13108" pay_incl="Y" order_type="P" order_number="special10">

<Payments><Payment payment_type="5" cc_number="6011111111111117" cc_exp_month="12" cc_exp_year="10" auth_number="AUTH" auth_date="07082008" auth_amount="50.00"></Payment>


<ShipTo shipping_method="04"><Items>

<Item quantity="2" item_id="YOURNAME" personalization_id="C" ><personalization_lines>

<personalization_line personalization_type="C" personalization_text="first" /> <personalization_line personalization_type="C" personalization_text="blue" /><personalization_line personalization_type="C" personalization_text=" " />

</personalization_lines> </Item>

</Items></ShipTo>

</ShipTos></Header>

</Message>

CWSerenade 5.0

3/24/15 Detailed Order XML Response (CWORDEROUT) 175

Detailed Order XML Response (CWORDEROUT)

The system generates this response to the Inbound Order XML Message (CWORDERIN) if the response_type is D (detail) or E (errors).

Note:

• All numeric values with decimal positions are passed as explicit decimals. For example, a dollar value of $10.00 is passed as 10.00.

• Attributes are included in the response only if they contain a value. Blank attributes are not passed.

See Detailed Order Response Message: Sample XML for a sample message.

Message Attribute

Alpha/numeric

Positions Comments

Message

source alphanumeric Identifies the source of the XML message. RDC indicates the XML message originates from CWSerenade.

target alphanumeric Identifies the target of the XML message. IDC indicates the XML message is sent to CWIntegrate.

CWSerenade 5.0


type alphanumeric Identifies the type of information in the XML message.

Header

company_code

numeric 3 The company_code from the Inbound Order Message.

order_id numeric 8 The order number assigned by the system.

reference_order_number

alphanumeric 30 The order_number from the Inbound Order Message.

customer_number

numeric 9 The number identifying the customer specified in the Inbound Order Message, or created by the system.


alphanumeric 15 The Alt cust # field at the Second Create Customer Sold To screen.

bill_to_number numeric 7 The number identifying the bill-to customer specified in the Inbound Order Message, created by the system, or assigned to the sold-to customer. Passed only if the customer or order has a bill-to account.

order_date numeric 8 The order_date from the Inbound Order Message. MMDDYYYY format.

order_channel alpha 2 The order_channel from the Inbound Order Message.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


bill_me_later_ind

alpha 1 Valid values are:• Y = The customer has an existing Bill Me Later account• N = The customer does not have an existing Bill Me Later accountThe system determines the setting of this flag based on whether there is an account number in the Customer Sold To BML table, regardless of whether the customer actually uses a Bill Me Later payment method on this order. For example, if the customer is applying for a Bill Me Later account with this order, then this flag is set to N, because the order has not gone out for authorization yet and the account number has not yet been established.The customer’s Bill Me Later account number, if it exists, is shown on the Display Customer Order History screen.

order_status alpha 1 The current status of the order. Valid values are:• H = Held• S = Suspended• E = In errorIncluded only if the status is not open (blank).

order_type alpha 1 The order_type from the Inbound Order message or from the E-Commerce Order Type (G42).

order_type_description

alpha 30 The description from the Order Type table.

b2b_order alpha 1 From the B2B order? flag in the Order Header table. This flag will always be set to N. Valid values are:• Y = This is a B2B order• N = This is not a B2B orderThis flag is set only for B2B orders and orders you receive through the Inbound Order Message.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


store_restock_order

alpha 1 From the Store restock order? flag in the Order Header table. This flag will always be set to N. Valid values are:• Y = This is a retail store restock order• N = This is not a retail store restock order Note: This flag is set only for orders you receive through the Inbound Order Message.

entered_date numeric 8 The enter_date from the Inbound Order Message. MMDDYYYY format.

entered_time numeric 6 The enter_time from the Inbound Order Message. HHMMSS format.

email_confirm_date

numeric 8 From the email confirmation date on the Order Header. MMDDYYYY format.

source_code alphanumeric 9 The source_code assigned to the order.

offer_id alphanumeric 3 The offer associated with the source code assigned to the order header.

Each of the components of the sold-to customer’s name and address, listed below, are passed only if the related field for the customer record has a value specified.

sold_to_prefix alphanumeric 3

sold_to_fname alphanumeric 15

sold_to_initial alphanumeric 1

sold_to_lname alphanumeric 25

sold_to_suffix alphanumeric 3

sold_to_company

alphanumeric 30

sold_to_busres

alphanumeric 1

sold_to_address1

alphanumeric 32

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


sold_to_address2

alphanumeric 32

sold_to_address3

alphanumeric 32

sold_to_address4

alphanumeric 32

sold_to_apartment

alphanumeric 10

sold_to_city alphanumeric 25

sold_to_state alphanumeric 2

sold_to_state_description

alphanumeric 25 As set up through Working with Countries (WCTY).

sold_to_zip alphanumeric 10

sold_to_country

alphanumeric 3

sold_to_day_phone

alphanumeric 14

sold_to_eve_phone

alphanumeric 14

sold_to_fax_phone

alphanumeric 14 This phone number is displayed on screens and reports as the fax or mobile number, based on the setting of the Third Phone Number Type (L53) system control value.

allow_rent alphanumeric 1

allow_mail alphanumeric 1

sold_to_opt_in alphanumeric 2

ind_number numeric 3 The ind_number from the Inbound Order Message, or assigned by the system. Passed only if there is an individual on the order.

Note: The bill-to name and address is from the Customer Bill To table, and is included only if there is a bill-to customer on the order.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


bill_to_prefix alphanumeric 3

bill_to_fname alphanumeric 15

bill_to_initial alphanumeric 1

bill_to_lname alphanumeric 25

bill_to_suffix alphanumeric 3

bill_to_company

alphanumeric 30

bill_to_busres alphanumeric 1

bill_to_address1

alphanumeric 32

bill_to_address2

alphanumeric 32

bill_to_address3

alphanumeric 32

bill_to_address4

alphanumeric 32

bill_to_apartment

alphanumeric 10

bill_to_city alphanumeric 25

bill_to_state alphanumeric 2

bill_to_state_description

alphanumeric 25 As set up through Work with Countries (WCTY).

bill_to_zip alphanumeric 10

bill_to_country alphanumeric 3

bill_to_day_phone

alphanumeric 14

bill_to_eve_phone

alphanumeric 14

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


bill_to_fax_phone

alphanumeric 14 This phone number is displayed on screens and reports as the fax or mobile number, based on the setting of the Third Phone Number Type (L53) system control value.

sales_rep_number

numeric 7 The salesman number assigned to the order. From the SLS Salesman # field in the Order Header table. Available in XML version: 4.0 (release 2.5 of CWSerenade).

sales_rep_name

alphanumeric 30 The name of the salesman assigned to the order. From the SLS Name field in the Salesman table. Available in XML version: 4.0 (release 2.5 of CWSerenade).

sales_rep_store

alphanumeric 10 The store number assigned to the order. Store numbers are defined in and validated against the Store Cross Reference table; see Work with Store Cross Reference (WSCR). Note: The store number defined for the order does not have to be associated with the salesrep defined on the Order Header.Available in XML version: 6.0 (release 3.5 of CWSerenade).

Payment

payment_seq_number

numeric 2 Indicates the sequence in which the payment methods were added to the order. From the Order Payment Method table.

pay_type numeric 2 The payment_type from the Inbound Order Message.

pay_type_desc alpha 30 The description associated with the pay type.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


credit_card_nbr

alpha 20 The cc_number from the Inbound Order Message. If you use credit card encryption, the system decrypts the credit card number before sending it to the external system. The number is masked (for example, credit_card_nbr="************3456").

credit_card_exp_dt

numeric 4 The cc_exp_month and the cc_exp_year from the Inbound Order Message.

credit_card_auth_dt

numeric 8 The auth_date from the Inbound Order Message. MMDDYYYY format.

credit_card_auth_nbr

alpha 16 The auth_number from the Inbound Order Message.

start_date numeric 4 The start_date from the Inbound Order Message.

card_issue_nbr

alpha 2 The card_issue_nbr from the Inbound Order Message.

check_nbr numeric 9 The check_number from the Inbound Order Message.

gift_cert_nbr numeric 7 The gift_certificate_number from the Inbound Order Message.

amt_to_chg numeric 9.2 The amt_to_charge from the Inbound Order Message.

ShipTo

Note: The dollar totals for the ship-to are subject to change until payment is received and the order goes into open status because repricing, promotions, and other final calculations take place at that point.

ship_to_number

numeric 3 The number identifying the ship-to address on the order. Assigned by the system.

sub_total numeric 9.2 The merchandise total on the order ship-to, after applying any repricing or discounts.

discount_total numeric 11.2 The discount total on the order ship-to.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


shipping numeric 7.2 Total freight charges for the order ship-to. If the system calculates freight as a percentage of the merchandise charges, there might be a penny variation in total freight amount due to rounding differences. Not included if the order qualifies for free shipping.

tax numeric 7.2 The total tax for the order ship-to.

additional_shipping

numeric 7.2 The total additional freight (Freight +) for the order ship-to.

additional_charges

numeric 7.2 The total additional charges for the order ship-to.

handling numeric 7.2 The total handling charges for the order ship-to.

order_total numeric 11.2 The total of all merchandise, shipping, charges, handling, and tax for the order ship-to.

ship_to_status alpha 1 Indicates the status of this shipping address. This status could differ from the order_status if, for example, the order has multiple shipping addresses and you canceled just one. Included only if the status is not open (blank).

gst numeric 7.2 The total Canadian Goods and Service Tax, if any, that applies to the order shipping address. The GST and the PST are included in the tax total.

pst numeric 7.2 The total Canadian Provincial Services Tax, if any, that applies to the order shipping address. The GST and the PST are included in the tax total.

gift_order alpha 1 The gift flag from the Inbound Order Message.

purchase_order_nbr

alpha 15 The ship_to_po_number from the Inbound Order Message.

discount_pct numeric 5.2 The discount percentage, if any, from the Order Ship To table.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


ship_via_code numeric 2 The shipping_method from the Inbound Order Message, or the current ship via if the system has overridden it.

ship_via_description

alpha 30 The description of the ship via, as set up through Work with Ship Via Codes (WVIA).

shipping_override

alpha 1 Indicates whether the Freight override flag is set. Set to Y if a freight amount was specified in the inbound order message; otherwise, not included. The Display Order Properties screen displays the Freight override flag on the order.

customer_number

numeric 9 Indicates the recipient customer for the order. Passed only if the shipping address is not the same as the sold-to customer.


numeric 3 Indicates the permanent ship-to customer on the order. Passed only if there is a permanent ship-to.

Each of the ship_to name and address attributes listed below is passed only if the related field for the customer, recipient, permanent ship-to or order ship-to specifies a value.

ship_to_prefix alphanumeric 3

ship_to_fname alphanumeric 15

ship_to_initial alphanumeric 1

ship_to_lname alphanumeric 25

ship_to_suffix alphanumeric 3

ship_to_company

alphanumeric 30

ship_to_busres

alphanumeric 1

ship_to_address1

alphanumeric 32

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


ship_to_address2

alphanumeric 32

ship_to_address3

alphanumeric 32

ship_to_address4

alphanumeric 32

ship_to_apartment

alphanumeric 10

ship_to_city alphanumeric 25

ship_to_state alphanumeric 2

ship_to_state_description

alpha 25 As set up through Work with Countries (WCTY).

ship_to_zip alphanumeric 10

ship_to_country

alphanumeric 3

cancel_date numeric 7 The date when the order will be canceled if all lines have not shipped, in MMDDYY format. The system will not reserve inventory one day prior to the cancellation date, because the order would not reach the customer in time. Any items that have not shipped one day prior to the cancellation date display on the Order Cancellation List. Customer service uses this list of pending order cancellations to contact each customer and request more time. If this is not possible, Customer Service must cancel the order manually through Order Maintenance. For pre-order quotes, this is the date the quote for an order expires. From the OST Cancel date field in the Order Ship To table. Available in XML version: 4.0 (release 2.5 of CWSerenade).

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


delivery_type alphanumeric 13 Identifies an order using the Order Broker integration:Store Pickup = the customer picks the entire order up at a store location where the inventory is availableShip To Store = the order is shipped to a store location, where the customer picks it up after arrivalThe ship-to address indicates the selected store for either a store pickup or a ship-to-store order. The Detail element in the response message for a store pickup order also includes the order broker status, pickup location, and pickup system.


Detail

line_seq_number

numeric 3 A unique number to identify each detail line on the order.

short_sku_number

numeric 7 From the SKU table; see short_sku_number for more information. Passed regardless of whether the short SKU was specified in the Inbound Order Message.

retail_ref_number

numeric 15 See retail_ref_number. Passed only if a retail reference number exists for the item, but regardless of whether it was specified in the Inbound Order Message.

status alphanumeric 1 Set to S if the item is sold out; otherwise, not passed.

item_id alphanumeric 12 Always passed.

item_description

alphanumeric 40 The description of the item.

sku alphanumeric 14 Passed only if the item has SKUs.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


sku_description

alphanumeric 40 The description of the SKU.

actual_price numeric 7.2 The unit price of the item from the Order Detail table. Not included for free gift or no-charge items.

offer_price numeric 7.2 The unit price of the item as defined for the Item Offer or SKU offer and saved in the Order Detail table.

original_retail_price

numeric 7.2 The original retail price from the SKU table.

drop_ship alphanumeric 1 A Y indicates the item is a drop ship item; otherwise, N is passed.

detail_ship_via numeric 2 Passed only if the order detail line has a ship via override. See line_shipping_method.

The three following values are related to store pickup orders.

pickup_type alphanumeric 2 Set to SP for a store pickup order.


alphanumeric 10 A code identifying the system associated with the store pickup location. From the System Name in Locate for Point of Sale (L09) system control value. Passed only for a store pickup order.

pickup_location

alphanumeric 10 A code identifying the location where the customer picks up the item. Passed only for a store pickup order.

order_quantity numeric 5 The quantity from the Inbound Order Message. Always passed.

cancel_quantity

numeric 5 From the Order Detail table. Not used in the order API. If you enter a cancel quantity, the system recalculates the tax on the order.

ship_quantity numeric 5 From the Order Detail table. Not used in the order API.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


return_quantity

numeric 5 From the Order Detail table. Not used in the order API.

reserved_warehouse

numeric 3 The warehouse where the item is reserved. Passed only if the item is reserved. If the order detail line is reserved across multiple warehouses, the message specifies the first reserved warehouse only.

reserve_quantity

numeric 5 Passed only if the item is reserved. May be less than the order_quantity. If the order detail line is reserved across multiple warehouses, the message specifies the total reserved quantity across all warehouses.

sold_out_quantity

numeric 5 Passed only if the item is sold out. May be less than the order_quantity. If you enter a sold out quantity, the system recalculates the tax on the order.

expected_ship_date

numeric 8 Passed only if the item is backordered and there is an open purchase order for the item. MMDDYYYY format.This date is included for drop ship items only if the Assign Drop Ship Expected Ship Date (I59) system control value is selected. See that system control value for more information.

last_ship_date numeric 8 From the Order Detail table. MMDDYYYY format. Not used in the order API.

tax numeric 10.5 The total tax amount applied to the order detail line.

gst_tax numeric 10.5 The total GST tax, if any, applied to the order detail line.

pst_tax numeric 10.5 The total PST tax, if any, applied to the order detail line.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


set_main_item alpha 1 Indicates whether the item is the main item of a set:Y = a main set itemN = not a main set itemAvailable in XML version: 2.0 (release 1.1 of CWSerenade).

set_component_item

alpha 1 Indicates whether the item was added to the order as a component of a set:Y = a set componentN = not a set componentAvailable in XML version: 2.0 (release 1.1 of CWSerenade).

set_seq_number

numeric 3 Indicates the sequence number that uniquely identifies a set and its components on this order. The main set item and its components have the same set sequence number. This attribute is not included for items that are not part of a set.Available in XML version: 2.0 (release 1.1 of CWSerenade).

country_of_origin

alpha 3 A code representing the country where the item originated. From the SKU Country of Origin field in the SKU table. Available in XML version: 4.0 (release 2.5 of CWSerenade).

harmonize_code

alphanumeric 16 A code that prints on customs documents for international shipments. If you charge duty on international orders, use this field to define the item’s duty rate. From the Harmonize code field in the SKU table. Available in XML version: 4.0 (release 2.5 of CWSerenade).

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


broker_status alphanumeric 15 A status of Acknowledged indicates that a store pickup order has been submitted to Locate, where it was created successfully. Otherwise, not used as part of the generic order interface (order API).Available in XML version: 5.0 (release 3.0 of CWSerenade).

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


line_locate_eligible

alphanumeric 1 Indicates if a backordered line meets the rules for a brokered backorder:

• the Send B/O to Locate (K08) system control value is selected

• the item is flagged as Locate eligible in the Item table

• the order is not:

• a gift order if the Order Broker Include Gift Orders (K14) system control value is unselected

• flagged to ship complete if the Order Broker Include Ship Complete Orders (L12) system control value is unselected

• a retail pickup, delivery, or ship-to-store order

• for a customer flagged to bypass reservation

• the order detail line:

• is in open status• is fully backordered• is not gift wrapped• does not have special handling• is not coordinate grouped if the

Order Broker Include Coordinate Grouped Orders (K13) is unselected

• does not have a future arrival date

• is not excluded based on trigger rules for the BROKER job

• is not a drop ship item• does not have an open

purchase order that is expected within the Order Broker Due Date Threshold (K11)

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


Note: This flag is included regardless of whether the order is suspended, provided the item is valid. Even if this flag is set to Y, it is possible that the line cannot be fulfilled as a brokered backorder if, for example, the Order Broker cannot find a location that has the item available.Available in XML version: 6.0 (release 3.5 of CWSerenade).

gift_wrap alphanumeric 1 Indicates whether the item is gift wrapped. Y = The item is gift wrapped. The system also includes order messages with a Print flag of G Gift Message in the Ord_Msg element. N = The item is not gift wrapped. From the Gift wrap field in the Order Detail table. Note: Any gift wrap charges are included in the Handling field for the Order Ship To. Available in XML version: 7.0 (release 4.0 of CWSerenade).

ShipmentThe information in this element is derived from PC manifesting, the generic pick in API, or the Order Broker integration. Note: This element is not used as part of the generic order interface (order API). See Generic Customer History API in the Online Help.

invoice_nbr numeric 7 A unique number to identify an invoice. The system creates an invoice when you confirm shipment or process a return.

invoice_ship_quantity

numeric 5 The total unit quantity of the item shipped and billed on this invoice. The quantity is negative for a return.

invoice_ship_date

numeric 8 The date when the shipment was confirmed, or when the return was credited. MMDDYYYY format.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


invoice_tracking_nbr

alpha 30 From the Manifest Upload Audit table. The system includes all tracking numbers in the Manifest Upload Audit table that are defined for the invoice detail (for example, the item shipped in more than one carton). Brokered backorders: Since there is no Manifest Upload Audit record for a brokered backorder, the message includes a tracking number if there is an Order Transaction History record of a shipment for the same date as the invoice. The system identifies the tracking number for an order line based on Order Transaction History notes, including:

• the line number in a note such as Ln#: 5 Shipped by Broker

• the tracking number in a note beginning with ----TRK#. Anything to the right of ----TRK#. in the invoice_tracking_nbr attribute. For example, if the Order Transaction History note is ----TRK#: GHI123, the invoice_tracking_nbr is GHI123.

Note: If the system writes the Order Transaction History for the shipment of a brokered backorder on a date that differs from the invoice date, then no tracking information is included in the customer history response. This situation might occur if, for example, CWSerenade receives the status update of the shipment before midnight, but the billing async job does not create the invoice until after the job is automatically stopped and restarted, so that the next date is assigned to the invoice.

invoice_ship_via_code

numeric 2 From the Manifest Upload Audit table. Not included for brokered backorders.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


invoice_ship_via_desc

alpha 30 From the ship via description, as set up through Work with Ship Via Codes (WVIA). Brokered backorders: From the Order Transaction History note beginning with ----VIA. See the invoice_tracking_nbr, above, for a discussion.

invoice_ship_via_type

alpha 2 The one-position or two-position code that identifies the type of ship via. Included for brokered backorders only if the shipping agent passed from the Order Broker matches a valid ship via in CWSerenade.Available in XML version: 6.0 (release 3.5 of CWSerenade).

invoice_tracking_URL

alpha 300 The URL to use when linking to shipment tracking information on the shipper’s web site. Built from the record in the TRACKVIA table with a matching ship via type: for example, if the ship via type is FX, the tracking URL should create a link to the Federal Express web site. All Parcel Post ship via types (PP, P1, P2, P3, and P4) use the TRACKVIA record whose ship via type is PP. Included only if there is a ship via type in the TRACKVIA table that matches the ship via used.Available in XML version: 6.0 (release 3.5 of CWSerenade).

SpecialHandlingFormatThe SpecialHandlingFormat element includes standard and custom special handling information for the items on the order that have a valid personalization_id defined and special handling instructions in the personalization_line element.

For more information: See personalization_id for more information on adding special handling to an item using the Inbound Order XML Message (CWORDERIN).


custom special handling:

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


special_format_seq_number

numeric 5 The sequence number assigned to the order line associated with custom special handling.From the Seq # field in the Order Special Format table.Available in XML version: 8.0 (release 4.7 of CWSerenade).

special_handling_code

alphanumeric 2 The type of special handling that applies to the item. Special handling refers to any type of item personalization, such as monogramming, alterations, and emblems. Special handling codes are defined in and validated against the Additional Charge Code table. From the OSF SHF Code field in the Order Special Format table.Available in XML version: 8.0 (release 4.7 of CWSerenade).

special_handling_format_seq_number

numeric 3 The special handling format sequence number assigned to the order special format.From the OSF Seq # field in the Order Special Format table.Available in XML version: 8.0 (release 4.7 of CWSerenade).

special_format_label

alphanumeric 15 The special handling option defined for the custom special handling format; for example: thread color. From the OSF Label field in the Order Special Format table.Available in XML version: 8.0 (release 4.7 of CWSerenade).

special_format_text

alphanumeric 45 The response selected for the special handling option in the custom special handling format; for example: black. From the OSF Input field in the Order Special Format table.Available in XML version: 8.0 (release 4.7 of CWSerenade).

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


special_format_charge

numeric 7.2 The charge associated with the special handling option in the custom special handling format. This charge is added to the Handling bucket of the order totals. From the OSF Charge field in the Order Special Format table.Available in XML version: 8.0 (release 4.7 of CWSerenade).

standard special handling:

special_handling_seq_number

numeric 2 The special handling sequence number assigned to the order special handling.This is populated only for standard special handling. From the Osh Seq # field in the Order Special Handling table.Available in XML version: 8.0 (release 4.7 of CWSerenade).

special_handling_information

alphanumeric 30 Input for the special handling.This is populated only for standard special handling. From the Osh S/H Info field in the Order Special Handling table. Available in XML version: 8.0 (release 4.7 of CWSerenade).

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


PromotionThe Promotion element lists the type of order audit discounts and promotions that were applied to the order. You can use this information on the web storefront to display to the customer the type of discounts and promotions for which the order qualifies, such as a ship via upgrade, reduced or free freight, or free items.

Note:

• The Promotion element is included only if the response_type in the Inbound Order XML Message (CWORDERIN) is set to D (detail) or E (errors).

• Not all promotions are listed here. For example, if an order promotion uses an additional charge code to apply a discount, it is listed; otherwise, if it decreases the prices of the items on the order, the discounted prices are included in the response message, but the promotion applied is not listed here.

See Discounted and Added Items in the CWOrderOut Response Message for more information. Available in XML version: 3.0 (release 2.0 of CWSerenade).

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


promotion_type_code

alphanumeric 2 A code used to identify the type of promotion applied to the order. Valid values:AA = additional charge on additional freightpromotionAV = ship via override on additional freight promotionFA = additional charge on freight promotionFB = free gift for BOGO (Buy One/Get One Free) promotionFF = free freightFO = freight overrideFV = ship via override on freight promotionOA = additional charge on order promotionOV = ship via override on order promotionPI = package insertPT = premiumRA = additional charge on offer promotionRG = free gift on offer promotionSA = additional charge on sourcepromotionSG = free gift on source promotionTA = additional charge on tiered promotionTG = free gift on tiered promotionSee Discounted and Added Items in the CWOrderOut Response Message for more information about each promotion type.From the Type field in the Order Discount Audit table.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


promotion_type_code_desc

alphanumeric 25 A description of the type of promotion applied to the order. See the promotion_type_code, above, for a listing.See Discounted and Added Items in the CWOrderOut Response Message for more information about each promotion type.

promotion_original_freight_amt

numeric 7.2 The freight amount for the order ship to before it was discounted by a freight promotion.This value is populated only for the FF (free freight) or FO (freight override) promotion types.From the Original freight amt field in the Order Discount Audit table.

promotion_freight_amt

numeric 7.2 The freight amount for the order ship to after the freight promotion has been applied to the order.If freight is not being charged for the order ship to (the freight amount is 0.00), this tag does not display in the message.This value is populated only for the FO (freight override) promotion type.From the Promotion freight amt field in the Order Discount Audit table.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


promotion_addl_charge_code

numeric 2 The additional charge code that was added to the order as a result of the promotion.This value is populated only for the following promotion types:• AA (additional charge on additional freight promotion)• FA (additional charge on freight promotion)• OA (additional charge on order promotion)• RA (additional charge on offer promotion)• SA (additional charge on source promotion)• TA (additional charge on tiered promotion)From the Add’l chg code field in the Additional Charge table. Based on the Additional chg seq # field in the Order Discount Audit table.

promotion_addl_charge_code_desc

alphanumeric 30 The description of the additional charge code that was added to the order as a result of the promotion.From the Description field in the Additional Charge table.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


promotion_addl_charge_amt

numeric 7.2 The amount of the additional charge that was applied to the order as a result of the promotion. Typically, this amount is a negative amount.This value is populated only for the following promotion types:• AA (additional charge on additional freight promotion)• FA (additional charge on freight promotion)• OA (additional charge on order promotion)• RA (additional charge on offer promotion)• SA (additional charge on source promotion)• TA (additional charge on tiered promotion)From the Additional chg amt field in the Order Discount Audit table.

promotion_original_shipping_method

numeric 2 The ship via for the order ship to before it was overridden by the promotion.This value is populated only for the following promotion types:• AV (ship via override on additional freight promotion)• FV (ship via override on freight promotion)• OV (ship via override on order promotion)From the Original ship via field in the Order Discount Audit table.

promotion_original_shipping_method_desc

alphanumeric 30 The description of the ship via that was assigned to the order before it was overridden by the promotion.From the Shipper name field in the Ship Via table.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


promotion_shipping_method

numeric 2 The ship via for the order ship to after the promotion has been applied to the order.This value is populated only for the following promotion types:• AV (ship via override on additional freight promotion)• FV (ship via override on freight promotion)• OV (ship via override on order promotion)From the Promotion ship via field in the Order Discount Audit table.

promotion_shipping_method_desc

alphanumeric 30 The description of the ship via that was assigned to the order as a result of thepromotion.From the Shipper name field in the Ship Via table.

promotion_item_id

alphanumeric 12 A code for the item that was added to the order as a result of a free gift, premium, or package insert.This value is populated only for the following promotion types:• FB (free gift on BOGO promotion)• PI (package insert)• PT (premium)• RG (free gift on offer promotion)• SG (free gift on source promotion)• TG (free gift on tiered promotion)From the ITM number field in the Order Detail table. Based on the ODT seq # field in the Order Discount Audit table.

promotion_item_desc

alphanumeric 40 A description of the item that was added to the order as a result of a free gift, premium, or package insert.From the Description field in the Item table.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


promotion_sku

alphanumeric 14 A code for the SKU of the item that was added to the order as a result of a free gift, premium, or package insert.This value is populated only for the following promotion types:• FB (free gift on BOGO promotion)• PI (package insert)• PT (premium)• RG (free gift on offer promotion)• SG (free gift on source promotion)• TG (free gift on tiered promotion)From the SKU code field in the Order Detail table. Based on the ODT seq # field in the Order Discount Audit table.

promotion_sku_desc

alphanumeric 40 A description of the SKU that was added to the order as a result of a free gift, premium, or package insert.From the Description field in the SKU table.

promotion_offer_price

numeric 7.2 The offer price for the order detail line associated with the promotion, if one exists.This value is populated only for the following promotion types:• FB (free gift on BOGO promotion)• PI (package insert)• PT (premium)• RG (free gift on offer promotion)• SG (free gift on source promotion)• TG (free gift on tiered promotion)From the Offer price field in the Order Detail table.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


promotion_price

numeric 7.2 The selling price of the order detail line associated with the promotion. If the item is free of charge (the selling price is 0.00), this tag does not display in the message.This value is populated only for the following promotion types:• PI (package insert)• PT (premium)• RG (free gift on offer promotion)• SG (free gift on source promotion)• TG (free gift on tiered promotion)From the ODT price field in the Order Detail table.

promotion_line_seq_nbr

numeric 5 The sequence number of the order line associated with the promotion.From the ODT seq # field in the Order Discount Audit table.

Ord_MsgThe Ord_Msg element lists order messages whose Print flag is G Gift Message. Note: The Ord_Msg element is included only if the response_type in the Inbound Order XML Message (CWORDERIN) is set to D (detail) or E (errors). Available in XML version: 7.0 (release 4.0 of CWSerenade).

ord_msg_text alphanumeric 60 The text for an order message whose Print flag is G Gift Message. From the Message field in the Order Message table. Available in XML version: 7.0 (release 4.0 of CWSerenade).

ord_msg_code alphanumeric 1 Defines where the order message prints. The system includes only messages whose Print flag is G Gift Message. From the Print? field in the Order Message table.Available in XML version: 7.0 (release 4.0 of CWSerenade).

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


ErrorThe response message includes any errors on the order if the response_type sent in the CWOrderIn message is E.Available in XML version: 2.0 (release 1.1 of CWSerenade).

error_type alpha 4 Indicates whether the error is related to header or detail information:HDR = The error is related to the header, ship-to, or payment methodDTLS = The error is related to an item on the order

error_code alpha 2 A code identifying the error. See Order Creation Errors for a listing.

error_ship_to numeric 3 Identifies order ship-to related to the error.

error_odt_seq numeric 5 Identifies the detail line related to the error. Included only for detail errors.

error_text alpha 25 The description of the error. See Order Creation Errors for a listing and more information.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


Detailed Order Response Message: Sample XML

A sample of the Detailed Order XML Response (CWORDEROUT) that does not include errors is presented below. The ORDER_IN job produces this response format if the response_type for the Inbound Order XML Message (CWORDERIN) is set to E. The response generated when the response_type is set to D is similar except that no errors are included.

<Message source="RDC" target="IDC" type="CWORDEROUT"> <Header company_code="6" order_id="4787" reference_order_number="081908AT" customer_number="13164" alternate_sold_to_id="000000105" bill_to_number="320" order_date="08192008" order_channel="I" bill_me_later_ind="N" order_status="E" order_type="W" order_type_description="WEB ORDER" b2b_order="N" store_restock_order="N" entered_date="08192008" entered_time="140152" source_code="SOURCE" offer_id="OFR" sold_to_fname="MARY" sold_to_lname="JOHNSON" sold_to_busres="R" sold_to_address1="257 APPLE STREET" sold_to_city="WORCESTER" sold_to_state="MA" sold_to_state_description="MASSACHUSETTS" sold_to_zip="01602" sold_to_country="USA" sold_to_day_phone="5085550100" sold_to_opt_in="O1" allow_rent="Y" allow_mail="Y" bill_to_fname="MARY" bill_to_lname="JOHNSON" bill_to_busres="R" bill_to_address1="257 APPLE STREET" bill_to_city="WORCESTER" bill_to_state="MA" bill_to_state_description="MASSACHUSETTS" bill_to_zip="01602" bill_to_country="USA">

<Payments> <Payment payment_seq_number="1" payment_type="5" pay_type_desc="MASTERCARD" credit_card_nbr="********1111" credit_card_auth_dt="1080815" credit_card_auth_nbr="AUTH"/>


<ShipTo ship_to_number="1" sub_total="27.50" discount_total="3.75" shipping="2.75" tax="1.82" additional_charges="4.29" order_total="36.36" ship_to_status="S" gift_order="N" ship_via_code="4" ship_via_description="BEST WAY" shipping_override="N" ship_to_fname="MARY" ship_to_lname="JOHNSON" ship_to_busres="R" ship_to_address1="257 APPLE STREET" ship_to_city="WORCESTER" ship_to_state="MA" ship_to_state_description="MASSACHUSETTS" ship_to_zip="01602" ship_to_country="USA">

<Details> <Detail line_seq_number="1" short_sku_number="605" item_id="BELT" item_description="STYLISH LEATHER-LOOK MEN'S BELT" actual_price="20.00" offer_price="20.00" drop_ship="N" order_quantity="1" tax="1.20" set_main_item="N" set_component_item="N"/> <Detail line_seq_number="2" short_sku_number="542" item_id="PEN" item_description="GEL WRITER 10/16/07" sku="BLUE" sku_description="BLUE PEN" actual_price="1.50" offer_price="2.25" drop_ship="N" order_quantity="5" reserve_quantity="5" tax="0.45" set_main_item="N" set_component_item="N" />

</Details> <Errors>

<Error error_type="HDR" error_code="Z4" error_text="CC Expiration/Start Date"/>

</Errors> </ShipTo>


</Message>

CWSerenade 5.0

3/24/15 Order Acknowledgement XML Message (CWORDEROUT) 207

Order Acknowledgement XML Message (CWORDEROUT)

The system generates this response to the Inbound Order XML Message (CWORDERIN) if the response_type is A (acknowledge).

Note:

• All numeric values with decimal positions are passed as explicit decimals. For example, a dollar value of $10.00 is passed as 10.00.


See Order Acknowledgement Message: Sample XML for a sample message.

Message Attribute

Alpha/numeric

Positions Comments

Message

source alphanumeric

Identifies the source of the XML message. RDC indicates the XML message originates from CWSerenade.

target alphanumeric

Identifies the target of the XML message. IDC indicates the XML message is sent to CWIntegrate.

type alphanumeric

Identifies the type of information in the XML message.

Header

company_code

numeric 3 The company_code from the Inbound Order Message.

order_id numeric 8 The order number assigned by the system.


alphanumeric

30 The order_number from the Inbound Order Message.

CWSerenade 5.0


customer_number

numeric 9 The number identifying the customer specified in the Inbound Order Message, or created by the system.


alphanumeric

15 The Alt cust # field at the Second Create Customer Sold To screen.

bill_to_number numeric 7 The number identifying the bill-to customer specified in the Inbound Order Message, created by the system, or assigned to the sold-to customer. Passed only if the customer or order has a bill-to account.

order_date numeric 8 The order_date from the Inbound Order Message.

order_channel alpha 2 The order_channel from the Inbound Order Message

bill_me_later_ind

alpha 1 Valid values are:• Y = The customer has an existing Bill Me Later account• N = The customer does not have an existing Bill Me Later accountThe system determines the setting of this flag based on whether there is an account number in the Customer Sold To BML table, regardless of whether the customer actually uses a Bill Me Later payment method on this order. For example, if the customer is applying for a Bill Me Later account with this order, then this flag is set to N, because the order has not gone out for authorization yet and the account number has not yet been established.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


Order Acknowledgement Message: Sample XML

A sample of the Order Acknowledgement XML Message (CWORDEROUT) is presented below.

<Message source="RDC" target="IDC" type="CWORDEROUT"> <Header company_code="6" order_id="5219" reference_order_number="093008B" customer_number="13164" alternate_sold_to_id="000000105" bill_to_number="320" order_date="09302008" order_channel="I" bill_me_later_ind="N"/>

</Message>

CWSerenade 5.0

3/24/15 Order Reject Request Message (CWORDERREJECT) 210

Order Reject Request Message (CWORDERREJECT)

Message structure: There is not a separate DTD or schema for the reject message. This message is based on the same structure as the Inbound Order XML Message (CWORDERIN); however, it is not necessary to include any tags besides those listed below. See the Order Reject Request Message: Sample below for an example.

When the message does include additional tags beyond those listed below, the order API returns an Invalid XML Message error if any of the additional information is invalid.

For more information: See Rejecting the Order (Order API) for background.

Message Attribute

Alpha/numeric

Positions Comments

Message

source alphanumeric

Identifies the source of the XML message.

target alphanumeric

Identifies the target of the XML message.

type alphanumeric

Must be set to CWORDERREJECT. Note: Not case-sensitive. For example, a setting of CWOrderReject is also acceptable.

Header

company_code

numeric 3 Identifies the company for the order. Validated against the Company table. Padding with zeroes (for example, 005) is optional. Required.

Identifying the Order:The reject message must specify either an order_number or rdc_order_nbr identifying an existing order in the company indicated. The order must be in error and not have a payment method.If the message includes both the order_number and the rdc_order_nbr, they should both point to the same order.Multi-recipient order? If the reject message specifies a multi-recipient order, the system cancels all recipients.

CWSerenade 5.0


order_number alphanumeric

30 The E-commerce order number in the Order Header Extended table and in the E-Commerce Order Reference table. From the order_number passed in the Inbound Order XML Message (CWORDERIN).

rdc_order_nbr numeric 9 The order number assigned by CWSerenade.

Message Attribute

Alpha/numeric

Positions Comments

CWSerenade 5.0


Order Reject Request Message: Sample

The following sample includes all of the tags that could potentially be used to identify an order for rejection. The message can specify the order_number, rdc_order_nbr, or both, in addition to the company number.

<Message source="String" target="String" type="CWORDERREJECT" > <Header company_code="6" order_number="1010mu123" rdc_order_nbr="10851" > </Header>

</Message>

CWSerenade 5.0


Order Reject Response Message: Samples

The order API returns a response such as one of the following examples provided the Order Reject Request Message (CWORDERREJECT) if the reject request message was valid, such as the sample above.

If the order rejection is successful, the response passed is:


Otherwise, if the order rejection is unsuccessful, the response passed is:

<Message>FAIL</Message>

A rejection is unsuccessful if the request message did not specify an existing order that is currently in error status without a payment method.

3/24/15 Order Creation Errors 214

Order Creation Errors

Purpose: The following table describes errors that can occur when you create orders through the order API. These errors might be listed on an error report such as the Order Batch Listing, and included in the Detailed Order XML Response (CWORDEROUT) if the response_type in the Inbound Order XML Message (CWORDERIN) is E.

For more information: See Generic Order Interface (Order API).

Code Error Explanation

01 Entered Price Exceeds Lim

The requested price of a new or existing item is below the maximum discount percentage, as specified in the Price Override Limit Percent (E55) system control value. For example, if this system control value specifies a limit of 10%, and the requested price of an item was 15% below the regular price, this would produce an error.Note: This error based on the setting of the Override Price Override Limit (A64) secured feature:

• if there is a valid entered_by_user specified in the message, the system checks the secured feature authority of that user;

• otherwise, if the entered_by_user is not a valid user ID in CWSerenade, or if there is no entered_by_user specified in the message, the system checks the secured feature authority of your default user.

A0 Invalid Promotion Code

The promotion code specified in the message does not actually exist.

A1 Multiples error The order line quantity is not evenly divisible by the Sell quantity for the item/SKU.

A4 Price is zero No price was found for the item/offer, but the item is not eligible for a price override to zero.

A7 Item not valid for whs

The line_warehouse indicated for a return or express bill does not exist.

A8 Invalid line frt override

A line freight override is indicated, but the freight method on the order is not a line-level freight method.

A9 S/H code is invalid

The Special handling code specified for the item is invalid.

CWSerenade 5.0


B0 Placer Invalid The order does not have a valid placer, and the Individuals Required in Order Entry (E01) system control value is selected, or an individual is assigned to the sold-to customer.

B1 Restricted item/SKU

The Restrict flag for an item on the order is selected.

B2 SKU does not exist

The short SKU specified in the message is not associated with a valid SKU.

B3 Base item does not exist

The system cannot identify the item/SKU for an order detail line based on the information provided in the message.

B4 Discount limit exceeded

The discount on the order ship to exceeds the Order Discount Percentage Limit (D16) system control value.

C0 Invalid offer The item specified is associated with an invalid offer.

C1 Item/Cust cls restriction

The customer’s class is restricted from shipment of items of this item class, as defined through the Item Class Restrictions by Customer Class screen.

C3 S/H code not allowed

Special handling is not allowed for the item, as defined at the Create Item Offer screen or the Create SKU Offer screen.

C4 Invalid/Missing Cust Cls

There is no valid customer class indicated in the message, the Default Customer Class in Order Entry (D63) system control value is blank, and the Require Customer Class in OE, WCAT, and WCST (H85) system control value is selected.

C5 Gift wrap not allowed

The gift_wrap field is selected and gift wrapping is not allowed for the offer.

C8 Invalid Ship Via • The Require postal code? flag is selected for the country and the ship via specified for the order does not exist, OR

• There is an invalid line_shipping_method specified for an item on the order, OR

• The order represents a pre-order quote (the Quote field for the order type is selected) and the ship via entered on the quote is an express bill ship via.


CWSerenade 5.0


D0 A/R and COD Not Allowed

The order includes both an accounts receivable and a C.O.D. payment method.

D3 A/R,COD Amount must be 0

There is an accounts receivable or C.O.D. payment method with an amount to charge specified. If an order uses either of these payment types, it must be the “catch-all.”

D4 Multiple CCs with $0

There is more than one “catch-all” payment method.

D8 Missing Whse/Loc-No IT Ln

The line_warehouse or location indicated for a return or express bill does not exist.

E2 State not found The state is not valid for the country, as defined through Work with Countries (WCTY). If a state is specified, it must be a valid state for the country, regardless of the setting of the Require state? flag for the country.

E3 Order qty > max allowed

The item quantity exceeds the maximum specified in the Maximum Order Quantity (C60) system control value.Note: This error based on the setting of the Allow Maximum Order Quantity Override (A70) secured feature:


• otherwise, if the entered_by_user is not a valid user ID in CWSerenade, or if there is no entered_by_user specified in the message, the system checks the secured feature authority of your default user

E5 Line $value > max allowed

The extended price of the order detail line exceeds the limit specified in the Maximum Order Line Value (E98).Note: This error based on the setting of the Allow Maximum Order Line Value Override (A69) secured feature:


• otherwise, if the entered_by_user is not a valid user ID in CWSerenade, or if there is no entered_by_user specified in the message, the system checks the secured feature authority of your default user


CWSerenade 5.0


E6 Price can not be negative

• The item has a price that is negative and the Allow Negative Prices in Order Entry (E97) system control value is not selected, OR• The order represents a pre-order quote (the Quote field for the order type is selected) and the quantity for an item on the quote is a negative quantity.

E7 Multiple CC with pay plan

There is more than one credit card on an order that includes a flexible payment option.

E8 CC Pmt Req w/Store Ship

There is no credit card payment method specified for a store shipment request.Note: Store fulfillment is not currently implemented.

E9 Email invalid The email address is not properly formatted.

EM Exceeds maximum char

The personalization text exceeds the maximum specified for the custom special handling format. See the personalization_line element in the Inbound Order XML Message (CWORDERIN) for more information.

F3 Missing Membership

The item is a membership item, but there is not a membership program with the same name as the item, as defined through Work with Membership Programs (WWMP), or the membership program identified has expired (the End date for the membership program has passed). This error occurs when a customer purchases a membership item and the payment information is passed separately; in this case, the system does not create the customer membership or apply any membership discount until receiving the payment message.

F5 Inv qty for ShipToStore

There is a ship-alone item with a quantity greater than one on a ship-to-store order.

F8 Item Ctry/St Restriction

The item is restricted from shipment to that country or state, as defined through the Work with Item Restriction by Country/State screen.

F9 Ship Via invalid for Item

The shipper is not eligible to ship the item to its destination, based on the Item Ship Via Override table.

G5 Invalid Prefix Code

The Validate Prefix (I27) system control value is selected, and the prefix does not exist in the Prefix table.


CWSerenade 5.0


G9 Missing PO#-Req for A/R

The PO Required for A/R Orders (D79) system control value is selected and no purchase order number is specified.

GA SH Resp fail defined rule

The custom special handling for the item does not conform to a rule set up for the custom special handling format.

H2 Invalid Flexible Payment

There is an invalid flexible payment option specified for an order payment method.

H3 Van Delivery via not allowed

• The ship via code defined in the Default Van Delivery Ship Via (L07) system control value is specified as the shipping_method and:

• the shipping address on the order does not qualify for van delivery, or

• the ship_to_warehouse contains a warehouse code other than the Reserve warehouse defined for the shipping address on the order.

• The ship via code defined in the Default Van Delivery Ship Via (L07) system control value is specified as the line_shipping_method for an order line and:

• the shipping address on the order does not qualify for van delivery, or

• the line_warehouse contains a warehouse code other than the Reserve warehouse defined for the shipping address on the order.

I1 Duplicate item for cust

The Duplicate Item Check (C09) system control value is selected and an item is included on more than one order for the customer within the number of days specified in the Duplicate Item Days (C58) system control value.

Note: After you accept or edit the order batch that includes the order with the duplicate item, the error status of the order line(s) is cleared, and the system does not reevaluate the order for a duplicate item error.

I2 Invalid Card Issue#

An issue number is required for the credit card pay type (based on the Require issue # flag), but an issue number was not provided.


CWSerenade 5.0


I3 Bill Me Later trans limit

The customer is applying for a Bill Me Later account, and the total order value exceeds the BML trans limit.

IM Required Input missing

Required information is missing from the custom special handling instructions.

M1 Invalid email/opt in-SVC

There is a virtual stored value card on the order and a valid email address was not provided. The system requires an email address in order to send a Stored Value Card Notification email to the recipient of the stored value card.

NC No catch all pay method

There is no payment method on the order with the amt_to_charge field blank.

OD Invalid Order date

The accounting period associated with the date could not be found or the G/L period for the date has been closed.

SA Non-CC on Ship To Store

The Payment at POS for Ship to Store (L60) system control value is selected, this is a ship-to-store order, the order type does not match the Order Type for Special Orders (L15) system control value, and the order includes a payment method that is not a credit card with a Card type of Credit or that matches the Rewards Certificate Pay Type (L54).

S1 Store Fulfillment Loc Msg

No store_code was passed for a store pickup order.

S3 Store Fulfillment Con Mas

You cannot generate a store pickup request for a continuity master item, although you can generate a request for the continuity components.

S4 Store Fulfillment Subscrp

You cannot generate a store pickup request for a subscription item.

S5 Store Fulfillment Mbrship

You cannot generate a store pickup request for a membership item.

S6 Store Fulfillment Neg Qty

You cannot generate a store pickup request for a negative quantity.

S7 Invalid Store Code

The store_code passed to create a ship-to-store or store pickup order is not a valid code as set up through Work with Store Cross Reference (WSCR).


CWSerenade 5.0


S8 Invalid Delivery Type

The delivery_type was not set to P (store pickup) or S (ship-to-store). Additional information will be provided by MICROS at a later date.

S9 Ineligible for Store Pick

The message indicates to create a store pickup order, but the order is not eligible. Possible reasons include a payment method that is not a credit card; items on the order that are not flagged as Locate eligible; items on the order that have gift wrap or special handling instructions; or the store_code indicated is invalid. If the store_code is invalid, then there are additional errors related to the ship-to address on the order.

SE Email Missing/Ineligible

This is a store pickup order, and there is not an email address with an opt-in/out flag of O1 (all emails) or O2 (order-related emails) on the order. The email address and opt-in/out setting are required so that you can notify the customer when the order is ready for pickup at the selected store.

SI Sales Rep Inactive

The Active field for the sales_rep_number assigned to the order in the Salesman table is N.

SJ Sales Rep Store Inactive

The Active field for the sales_rep_store assigned to the order in the Store Cross Reference table is N.

SK Sales Rep Store Invalid

The sales_rep_store assigned to the order is not a valid store number in the Store Cross Reference table.

UU SKU Blocked The item is not allowed on the order based on information received from an external system via the SKU Blocker interface. The system sends item and order information to an external system to determine whether the item/SKU is allowed on the order if the second compatibility code for the item matches the code defined in the Second Compatibility Code used to Trigger SKU Blocking (K84) system control value. See this system control value for more information.

VR Input not valid response

The personalization text is not a valid entry for the custom special handling format. See the personalization_line element in the Inbound Order XML Message (CWORDERIN) for more information.

W3 City Blank No city is specified for the shipping address.

W4 Country Not Found The country code is invalid or no country was specified.


CWSerenade 5.0


W5 Duplicate PO# The ship_to_po_number is a duplicate (the system checks for duplicate PO numbers only if the Verify Duplicate PO Numbers for A/R Orders (D80) system control value is selected.

W7 Invalid Cancel Date

The cancel date specified in the message is earlier than the current date.

W8 Invalid Cancel/Arrival DT

X0 Invalid date of birth

The customer is using a Bill Me Later pay type for the first time, and there is no date of birth provided.

X1 Invalid Order Hold Reason

The order hold reason code indicated does not exist in the Order Hold Reason table.

X2 Invalid Order Type

The order type indicated does not exist in the Order Type table.

X3 Invalid Salesman Number

The Require Salesrep Number in Order Entry/Order Maintenance (E87) system control value is selected and the order does not have a valid sales rep.

X4 Invalid Ship Via for FEDX

There is a Federal Express tracking number indicated, but the ship via on the order does not have a Type of FX.

X5 Invalid Ship Via for POB

The ship via for the order does not deliver to P.O. boxes, as specified by the PO box delivery field for the ship via. This error can occur regardless of the setting of the Perform ship via edit? flag for the country.

X6 Invalid Ship Via for SCF

Either the SCF or the ship via/SCF combination is not valid. This error occurs only if the Perform ship via edit? flag is selected for the country.

X7 Invalid Source Code

The source code specified on an order detail line is not valid.Note: Normally, even if the source code on the header is not specified or is invalid or restricted, the system selects a valid header-level source code from the customer’s mail history, current source code, or a system control value default.

X9 Invalid State for Zip

The state is not valid for the postal code, as defined through Work with Postal Code/City/States (WZIP).

Y0 Invalid social security #

The customer is applying for a Bill Me Later account, but the soc_sec_nbr was blank.


CWSerenade 5.0


Y1 Invalid Tax Code There is a resale/exempt number specified but the customer is not tax exempt, or R or E is not passed in the tax_exempt attribute.

Y2 Last Name & Comp Blank

Both the last name and the company field for the sold-to customer are blank; at least one is required.

Y3 SCF not Found The SCF is not valid for the country, as defined through Work with SCF Codes (WSCF). This error occurs only if the Require postal? flag is selected for the country.

Y4 State Blank No state is specified. This error occurs only if the Require state? flag is selected for the country.

Y5 Street Address Blank

No street address is specified.

Y8 Zip Code Blank No postal code is specified. This error occurs only if the Require postal code? flag is selected for the country.

Z0 Direct Disbursement N/A

The order includes a Direct Bank Disbursement pay type; you cannot enter a Direct Bank Disbursement pay type on an e-commerce order.

Z1 No Detail lines No items were specified for the order.

Z2 No Paytypes for Order

No payment methods have been provided.

Z3 Invalid Coupon The gift certificate number indicated does not match a record in the Coupon Redemption table, and the Dynamic Creation of Coupons (B21) system control value is unselected.

Z4 CC Expiration/Start Date

If an expiration date is required for the credit card pay type (based on the Require expiration date flag):

• the credit card payment method did not include a valid expiration date; for example, the cc_exp_month or cc_exp_year exceeded two positions each, or the cc_exp_month is not a valid month (1 through 12)

• the expiration date is in the past

• the expiration date is more than 20 years in the future

if a start date is required for the credit card pay type (based on the Require start date flag), the credit card payment method did not include a start date.


CWSerenade 5.0


Z5 Invalid Credit Card

• No credit card number was provided for a credit card pay type.• The credit card number failed validation against the credit card length, leading digits, or bin number defined for the credit card pay type. • The Require Credit Card Token (L40) system control value is selected and the credit card number was not replaced with a token.

Z6 Invalid Pay Type • No payment method was passed, or the payment method passed was invalid, OR• The order represents a pre-order quote (the Quote field for the order type is selected) and a cash/check pay type is defined on the quote.

Z7 Invalid Bill To Address

Some part or all of the bill-to (A/R) information in the message is invalid.

Z8 Invalid Sold to Address

There is a problem with the sold-to customer’s address. This error accompanies the error message indicating the specific problem.

Z9 Invalid Ship to Address

Any of the entries for the shipping address are invalid. This error appears with one or more other error messages describing the fields that are invalid.

ZZ No Order I/T Line for Item

You attempted to send an express-billed order without specifying the warehouse and location where the item(s) were taken.


3/24/15 224

Translating Special Characters

Certain special characters cannot be passed in an attribute of an XML message except through the use of replacement text strings. For outbound XML messages, CWSerenade replaces these with the text strings listed below. Similarly, for inbound messages, you can pass the special characters listed below by replacing them with the related text strings. For example, if the item description includes a double quote, CWSerenade replaces it in the item_description attribute in the Detailed Order Response Message: Sample XML with ". Similarly, you can pass a single quote in the line_hyperlink attribute in the Inbound Order XML Message (CWORDERIN) by replacing it with '

If an inbound message includes any of the special characters listed below without using the replacement text string, the system returns an error: Cannot Parse XML Message or Invalid XML Message.

Other special characters (such as $ or !) can be passed in an attribute of an XML message without using replacement text strings.

Special Character Description Replacement Text String

’ single quote '

" double quote "

> greater than >

< less than <

& ampersand &

3/24/15 E-Commerce Catalog Requests 225

E-Commerce Catalog Requests

Purpose: The EC_CAT_REQ job, started through Working with E-Commerce Job Control (EJCT), creates a catalog request when the customer enters a request on the web storefront. The main purposes of this job:

• receive and process catalog requests for sold to or individual customers.

• create the sold to customer or individual customer if the customer does not exist.

• update the sold to customer or individual customer if the customer information is updated.

Additionally, if the response_required field is 1, the system sends an E-Commerce Catalog Request Response message back to the web storefront.

Duplicate catalog requests: If the Edit for Duplicate Catalog Requests (E46) system control value is selected, the system checks for duplicate catalog requests, based on match code. If a duplicate catalog request exists, the system does not create the duplicate catalog request. However, the system will still send an E-Commerce Catalog Request Response Message (CWCatreqResponse) back to the web storefront.

E-Commerce catalog requests in error: If the E-Commerce Catalog Request Message (CWCatRequest) contains an error, the system places the catalog request in the Catalog Request Interface table. You can correct the errors using the Work with the Catalog Request Interface (WCRU) menu option.

CTI Telephone Scan table: If you create a new sold to customer or new individual customer in an e-commerce catalog request and the Use Computer Telephony Integration (F26) system control value is selected, the system creates a record in the CTI Telephone Scan table.

Relate customer integration: When you use the Relate customer integration, if you create a customer through a catalog request, CWSerenade sends the customer information to Relate so that the customer records in the two systems are synchronized.

In this topic:

• Customer Creation/Update Logic in E-Commerce Catalog Requests

• Creating/Updating Sold To Customers in E-Commerce Catalog Requests• Creating/Updating Individuals in E-Commerce Catalog Requests• E-Commerce Catalog Request Response

• E-Commerce Catalog Request Message (CWCatRequest)

• E-Commerce Catalog Request Response Message (CWCatreqResponse)

CWSerenade 5.0


Customer Creation/Update Logic in E-Commerce Catalog Requests

In addition to creating a catalog request, the E-Commerce Catalog Request Message (CWCatRequest) allows you to create or update a sold to customer and/or individual customer.

Creating/Updating Sold To Customers in E-Commerce Catalog Requests

Creation sold to logic: If you receive a catalog request from the web storefront for a customer that does not exist, the system creates a new customer.

If the Edit for Duplicate Catalog Requests (E46) system control value is selected, the system checks for duplicate catalog requests, based on match code. If a duplicate catalog request exists, the system does not create the duplicate catalog request. However, the system will still send a catalog request response back to the web storefront.

When you create a new customer through the E-Commerce Catalog Request Message (CWCatRequest), the system creates the new customer in the Customer Sold To table. The current and original mail type fields are set to C (catalog request). If the Track Customer History at Entity Level (F89) system control value is selected, the system also creates a Customer Entity record for the entity associated with the source code.

Opt in/opt out flag: If the catalog request received from the web storefront does not contain a value in the bill_to_opt_in flag, the system defaults the setting of the Default Opt In/Opt Out (G97) system control value.

Update sold to logic: If the catalog request is for an existing customer and the value of an existing field changes, such as the Email address field, the system updates the customer. See Work with Customers (WCST).

Customer ownership: You can create or update customer ownership records for the sold to customer using the CustOwnership element in the E-Commerce Catalog Request Message (CWCatRequest). Customer ownership allows you to capture and confirm information about the products a customer currently owns or previously owned.

The system looks at the Company, Customer #, and Ownership ID fields in the Customer Ownership table to determine if the customer ownership record on the catalog request is a new record or updated record.

• If the company, customer number, and ownership ID values on the catalog request match a record in the Customer Ownership table, the system updates the Active flag, Entry date, Confirm date, and Description fields for the existing customer ownership record.

• If the company, customer number, and ownership ID values on the catalog request do not match a record in the Customer Ownership table, the system creates a new customer ownership record for the sold to customer.

CWSerenade 5.0


If a value is not defined for the cust_own_ID field, the system creates a customer note indicating the customer ownership record was not created/updated: Missing Ownership ID: Ownership Description. The system does not place the e-commerce catalog request in an error status because of customer ownership errors.

Note: If the catalog request contains errors, the system places the catalog request in the Catalog Request Interface table. You will need to correct the errors in the Work with Catalog Request Interface (WCRU) menu option. If this happens, the system does not retain the customer ownership information when you correct the errors and reprocess the catalog request.

Creating/Updating Individuals in E-Commerce Catalog Requests

The Enable Catalog Request at Customer Individual Level (H81) system control value controls whether you can specify an individual on a catalog request. This system control value must be selected to enter a catalog request at the individual level; if this system control value is unselected, the system places catalog requests containing individual information in an error status in the Work with Catalog Request Interface (WCRU) menu option.

Creation sold to logic: If a new individual is defined for the sold to customer on the catalog request message, the system creates the new individual for the customer in the Customer Individual table, using the next sequential number. The individual’s Original mail type and Current mail type will be C, the Mail and Rent flags will default from the sold to customer’s, and the Mail code will default from the Mail flag.

Update sold to logic: If an existing individual is defined for the sold to customer on the catalog request message, the system updates the individual’s address, mail flag, and opt-in/opt-out flag if you have changed them.

CWSerenade 5.0


E-Commerce Catalog Request Response

The response_required field in the E-Commerce Catalog Request Message (CWCatRequest) indicates if the system sends an E-Commerce Catalog Request Response Message (CWCatreqResponse) back to the web storefront.

• 0, blank, or a value other than 1 indicates a catalog request response message is not sent to the web storefront.

• 1 indicates a catalog request response message is sent to the web storefront.

The catalog request response message indicates the company, customer number, and optionally, individual number, used to create the catalog request.

• The customer_number in the catalog response message identifies the sold to customer on the catalog request.

• If the customer_ number is 000000000, the catalog request did not process correctly and needs to be corrected through the Work with Catalog Request Interface (WCRU) menu option.

• If the system created a new customer, the customer_number identifies the newly assigned customer number; otherwise the customer_number identifies the existing sold to customer.

• The individual_number in the catalog response message identifies the individual on the catalog request.

• If the individual_number is 000, an individual is not associated with the catalog request.

• If the individual_number is 000 and the customer_number is 000000000, the catalog request did not process correctly and needs to be corrected through the Work with Catalog Request Interface (WCRU) menu option.

• If the system created a new individual, the individual_number identifies the newly assigned individual number; otherwise, the individual_number identifies the existing individual.

3/24/15 229

E-Commerce Catalog Request Message (CWCatRequest)

The EC_CAT_REQ job, started through E-Commerce Job Control (EJCT), creates a catalog request when the customer enters a request on the web storefront. The main purposes of this job:

• receive and process catalog requests for sold to or individual customers.

• create the sold to customer or individual customer if the customer does not exist.

• update the sold to customer or individual customer if the customer information is updated.

Additionally, if the response_required field is 1, the system sends an E-Commerce Catalog Request Response Message (CWCatreqResponse) back to the web storefront.


• E-Commerce Catalog Requests for more information on processing

• E-Commerce Catalog Request Message: Sample XML

Additionally, you can update or create a sold to customer and individual using this message; see Customer Creation/Update Logic in E-Commerce Catalog Requests.

Attribute Name Type Length Comments


source alpha Identifies the source of the message. WEB indicates the XML message is from the web storefront.

target alpha Identifies the target of the message. RDC indicates the XML message is sent to CWSerenade.

type alpha Identifies the type of information in the XML message. CWCatRequest indicates the message contains a catalog request.

CWSerenade 5.0

3/24/15 230

CatRequestOne CatRequest element is required.

company_code numeric

3 The company associated with the catalog request. Maps to the CMP company field in the Catalog Request table.

response_required

alpha 1 1 indicates the system sends an E-Commerce Catalog Request Response Message (CWCatreqResponse) back to the web storefront.

offer_id alpha 3 The code for the catalog that the customer is requesting. Maps to the Offer number field in the Catalog Request table.

source_code alpha 9 A code that identifies a list of names for the catalog mailing. Maps to the SRC Source code field in the Catalog Request table.

The bill_to fields represent the sold to customer. If the sold to customer does not exist in CWSerenade, the system creates a new customer. If the catalog request is for an existing sold to customer and the name or address changes, such as the bill_to_email, the system updates the customer. See Creating/Updating Sold To Customers in E-Commerce Catalog Requests for more processing information.In addition, if the Edit for Duplicate Catalog Requests (E46) system control value is selected, the system checks for duplicate catalog requests, based on match code. If a duplicate catalog request exists, the system does not create the duplicate catalog request. However, the system will still send an E-Commerce Catalog Request Response Message (CWCatreqResponse) back to the web storefront.

bill_to_prefix alpha 3 The prefix of the sold to customer.Maps to the NAM Prefix field in the Customer Sold To table.

bill_to_fname alpha 15 The first name of the sold to customer.Maps to the NAM First name field in the Customer Sold To table.

bill_to_initial alpha 1 The middle initial of the sold to customer.Maps to the NAM Initial field in the Customer Sold To table.


CWSerenade 5.0

3/24/15 231

bill_to_lname alpha 25 The last name of the sold to customer.Maps to the NAM Last name field in the Customer Sold To table.

bill_to_suffix alpha 3 The suffix of the sold to customer.Maps to the NAM Suffix field in the Customer Sold To table.

bill_to_company alpha 30 The company name for the sold to customer address.Maps to the NAM Company name field in the Customer Sold To table.

bill_to_busres alpha 1 A code that identifies the address as a business or residence. B = BusinessR = ResidenceMaps to the NAM Delivery code field in the Customer Sold To table.

bill_to_address1 alpha 32 The street address of the sold to customer address.Maps to the NAM Street address field in the Customer Sold To table.

bill_to_address2 alpha 32 The second address line of the sold to customer address.Maps to the NAM Address line 2 field in the Customer Sold To table.

bill_to_address3 alpha 32 The third address line of the sold to customer address.Maps to the Address line 3 field in the Customer Sold To Extended table.

bill_to_address4 alpha 32 The fourth address line of the sold to customer address.Maps to the Address line 4 field in the Customer Sold To Extended table.

bill_to_apartment alpha 10 The apartment/suite number of the sold to customer address.Maps to the NAM Apartment field in the Customer Sold To table.

bill_to_city alpha 25 The city of the sold to customer address.Maps to the NAM City field in the Customer Sold To table.


CWSerenade 5.0

3/24/15 232

bill_to_state alpha 2 The state code of the sold to customer address. Required only if the Require state? flag for the country is selected.Maps to the NAM State field in the Customer Sold To table.

bill_to_country alpha 3 The country code of the sold to customer address.Maps to the RPR Country field in the Customer Sold To table.

bill_to_zip alpha 10 The postal code of the sold to customer address. Required only if the Require postal code? flag for the country is selected. If the postal code is required, it is validated against the Zip/City/State table.Maps to the NAM Zip field in the Customer Sold To table.

bill_to_email alpha 50 The email address assigned to the sold to customer.Maps to the E-mail field in the Customer Sold To table.

allow_rent alpha 1 Indicates whether you sell the customer’s name to other companies.Y = Sell the customer’s name to other companies.N = Do not sell the customer’s name to other companies. Maps to the CST Rent name? field in the Customer Sold To table.

allow_email alpha 1 This field is not currently implemented. Maps to the CST Rent e-mail field in the Customer Sold To table.

allow_mail alpha 1 Indicates whether the customer wants to receive future catalog mailings.Y = Mail catalogs to this customer.N = Do not mail catalogs to this customer.Maps to the CST Mail name? field in the Customer Sold To table.


CWSerenade 5.0

3/24/15 233

bill_to_day_phone

alpha 14 The day phone number for the sold to customer.Maps to the Phone field in the Customer Sold To Phone # table whose CS# Phone # type field is D.

bill_to_evening_phone

alpha 14 The evening phone number for the sold to customer.Maps to the Phone field in the Customer Sold To Phone # table whose CS# Phone # type field is E.

bill_to_fax_phone alpha 14 The third (fax or mobile) phone number for the sold to customer.Maps to the Phone field in the Customer Sold To Phone # table whose CS# Phone # type field is F.

bill_to_opt_in alpha 2 Determines the preferred method of correspondence for the sold to customer’s email address.O1 (Email): Email is the preferred method of correspondence. O2 (Order-only email): Use email for order-related correspondence only; generate a document for other correspondence.O3 (No email): Do not use email for any correspondence; generate a document instead.O4 (Do not ask the customer): Do not ask the customer for his/her email address.Maps to the CST E-mail status field in the Customer Sold To table.


CWSerenade 5.0

3/24/15 234

The indiv fields represent the individual customer. The Enable Catalog Request at Individual Level (H81) system control value controls whether you can specify an individual on a catalog request. This system control value must be selected to enter a catalog request at the individual level; if this system control value is unselected, the system places catalog requests containing individual information in an error status in the Work with Catalog Request Interface (WCRU) menu option.If a new individual is defined for the sold to customer on the catalog request message, the system creates the new individual for the customer in the Customer Individual table, using the next sequential number. The individual’s Original mail type and Current mail type will be C, the Mail and Rent flags will default from the sold to customer’s, and the Mail code will default from the Mail flag.If an existing individual is defined for the sold to customer on the catalog request message, the system updates the individual’s address, mail flag, and opt-in/opt-out flag if you have changed them.

indiv_prefix alpha 3 The prefix of the individual customer.Maps to the CIF Name prefix field in the Customer Individual table.

indiv_fname alpha 15 The first name of the individual customer.Maps to the CIF First name field in the Customer Individual table.

indiv_lname alpha 25 The last name of the individual customer.Maps to the CIF Last name field in the Customer Individual table.

indiv_initial alpha 1 The middle initial of the individual customer. Maps to the CIF Middle initial field in the Customer Individual table.

indiv_suffix alpha 3 The suffix of the individual customer. Maps to the CIF Name suffix field in the Customer Individual table.

indiv_day_phone alpha 14 The day phone number for the individual customer.Maps to the Day phone field in the Customer Individual table.

indiv_eve_phone alpha 14 The evening phone number of the individual customer.Maps to the Eve phone field in the Customer Individual table.


CWSerenade 5.0

3/24/15 235

indiv_fax_phone alpha 14 The third (fax or mobile) number of the individual customer.Maps to the Fax phone field in the Customer Individual table.

indiv_email alpha 50 The email address assigned to the individual customer.Maps to the CIF E-Mail address field in the Customer Individual table.

indiv_mailstop alpha 32 The individual’s delivery address within the organization.Maps to the CIF Mail stop field in the Customer Individual table.

indiv_position alpha 3 A code that represents the individual’s position within the organization.Maps to the CIF Position field in the Customer Individual table.

indiv_department alpha 3 A code the represents the individual’s department within the organization.Maps to the CIF Department field in the Customer Individual table.

indiv_opt_in alpha 2 Determines the preferred method of correspondence for the individual customer’s email address.O1 (Email): Email is the preferred method of correspondence. O2 (Order-only email): Use email for order-related correspondence only; generate a document for other correspondence.O3 (No email): Do not use email for any correspondence; generate a document instead.O4 (Do not ask the customer): Do not ask the customer for his/her email address.Maps to the CIF Opt in/opt out field in the Customer Individual table.

CustOwnershipThe CustOwnerships element, if provided, can include one or more CustOwnership elements.To create a customer ownership record for the sold to customer, at minimum, you must enter the ownership ID in the cust_own_ID field.


CWSerenade 5.0

3/24/15 236

E-Commerce Catalog Request Message: Sample XML

A sample of the E-Commerce Catalog Request Message (CWCatRequest) in XML format is presented below.

- <Message source="WEB" target="RDC" type="CWCatRequest"> - <CatRequest company_code="555" response_required="1" offer_id="204" source_code="2006" bill_to_fname="BERNADETTE" bill_to_initial="T" bill_to_lname="MIRANDA" bill_to_busres="R" bill_to_address1="109 RIVER LN" bill_to_city="TEMPLETON" bill_to_state="MA" bill_to_country="USA" bill_to_zip="01468"

cust_own_ID alpha 10 A code that represents a product the sold to customer owns or previously owned. If a value is not defined in this field, the system creates a customer note indicating the customer ownership record was not created/updated: Missing Ownership ID: Ownership Description. The system does not place the e-commerce catalog request in an error status because of customer ownership errors. Maps to the Ownership ID field in the Customer Ownership table.

cust_own_desc alpha 40 A description of the product.Maps to the Description field in the Customer Ownership table.

cust_own_active alpha 1 Indicates if the customer currently owns the product.Y = The customer currently owns the product.N = The customer previously owned the product.Maps to the Act field in the Customer Ownership table.

cust_own_entry_date

numeric

8 The date the customer ownership record was created, in MMDDYYYY format.Maps to the Entry date field in the Customer Ownership table.

cust_own_confirm_date

numeric

8 The most recent date when the customer confirmed ownership of the product, in MMDDYYYY format.Maps to the Confirm date field in the Customer Ownership table.


CWSerenade 5.0

3/24/15 237

bill_to_email="[email protected]" allow_rent="Y" allow_email="Y" allow_mail="Y" bill_to_day_phone="9786233344" bill_to_evening_phone="6663334444" bill_to_fax_phone="4443335555" bill_to_opt_in="O2">

- <CustOwnerships> <CustOwnership />

</CustOwnerships> </CatRequest>

</Message>

CWSerenade 5.0

3/24/15 238

E-Commerce Catalog Request Response Message (CWCatreqResponse)

The Catalog Requests e-commerce job sends a catalog request response to the web storefront if the response_required field in the e-commerce catalog request message is set to Y.

If the Edit for Duplicate Catalog Requests (E46) system control value is selected, the system checks for duplicate catalog requests, based on match code. If a duplicate catalog request exists, the system does not create the duplicate catalog request. However, the system will still send a catalog request response back to the web storefront.

For more information: See E-Commerce Catalog Request Response for more information on processing and E-Commerce Catalog Request Response Message: Sample XML.



source alpha Identifies the source of the XML message. RDC indicates the XML message is from CWSerenade.

target alpha Identifies the target of the XML message. WEB indicates the XML message is sent to the web storefront.

type alpha Identifies the type of information in the XML message. CWCatreqResponse indicates the message contains a catalog request response.

CWCatreqResponseOne CWCatreqResponse element is required.


3 A code for the company associated with the catalog request.From the CMP Company field in the Catalog Request table.

CWSerenade 5.0

3/24/15 239

E-Commerce Catalog Request Response Message: Sample XML

A sample of the E-Commerce Catalog Request Response Message (CWCatreqResponse) in XML format is presented below.

- <Message source="RDC" target="IDC" type="CWCatreqResponse"> <CWCatreqResponse company_code="555" customer_number="000000460" individual_number="000" />

</Message>

customer_number numeric

9 The sold to customer number associated with the catalog request. This may represent a new sold to customer or an existing sold to customer. If this number is 000000000, the catalog request did not process correctly and needs to be corrected through Work with Catalog Request Interface (WCRU).From the CST Customer # field in the Catalog Request table.

individual_number

numeric

3 The individual customer number associated with the catalog request. This may represent a new individual customer or an existing individual customer.If this number is 000, an individual is not associated with the catalog request. If this number is 000 and the customer_number is 000000000, the catalog request did not process correctly and needs to be corrected through Work with Catalog Request Interface (WCRU).From the CIF Customer individual # field in the Catalog Request Cust Indv table.


3/24/15 E-Commerce Order Status Processing 240

E-Commerce Order Status Processing

Purpose: The EC_STS_INQ job, started through Working with E-Commerce Job Control (EJCT), receives an E-Commerce Order Status Message (CWOrderStatus) from the web storefront, based on company, sold-to customer, order number, and, optionally, individual and/or bill-to customer. The E-Commerce Order Status Response Message (CWStatusResponse) returned to the web storefront includes order summary information.

What is order status used for? Typically, customers request order summary information before:

• cancelling the order or an order line on the order; see E-Commerce Cancel Process Overview.

• returning the order; see Creating Return Authorizations from the Web Storefront.

In this topic:

• Registered customer?

• Order status response includes response type?

• E-Commerce Order Status Message (CWOrderStatus)

• E-Commerce Order Status Response Message (CWStatusResponse)

Registered customer?

If the customer is not registered at the web storefront, the E-Commerce Order Status Message (CWOrderStatus) includes a ship_to_details flag you can use to indicate whether to display ship-to detail:

• If this flag is selected, the E-Commerce Order Status Response Message (CWStatusResponse) includes each ship-to on an order, so that the customer can review the items separately for each ship-to address.

• If this flag is unselected, the E-Commerce Order Status Response Message (CWStatusResponse) does not include the ship-to information; all items on the order will appear together regardless of ship-to address.

If the customer is registered, the E-Commerce Order Status Response Message (CWStatusResponse) includes a listing of all the customer’s e-commerce (order API) orders and all ship-tos. This message also includes a status flag indicating whether the order is eligible for maintenance, and the quantity of each item that is eligible for cancellation, if any. Once the customer selects an order for review, all the order ship-to detail is available for display on the web storefront.

CWSerenade 5.0

3/24/15 E-Commerce Order Status Processing 241

Order status response includes response type?

If the Pass E-Commerce Order Status Response Type (H68) system control value is selected, the E-Commerce Order Status Response Message (CWStatusResponse) includes a response type code indicating if an order was found that matches the order status inquiry.

• 1 indicates an order was found that matches the order status inquiry. The Order Status Response message includes order information.

• 2 indicates an order was found that matches the order status inquiry, but the last name defined for the inquiry (bill_to_lname, ind_lname, or company_name) does not match the last name on the order. The Order Status Response message includes order information; however the response type 2 indicates the last name defined on the order status inquiry does not match the last name on the order.

• 3 indicates an order was not found that matches the order status inquiry. The Order Status Response message includes company, order number, and a response type of 3, but does not include order information.

If this system control value is unselected, the system only sends an Order Status Response message to the web storefront when an order number is found that matches the order_id in the Order Status message and a match is found on at least one of the name fields in the request (bill_to_lname, ind_lname, or company_name).

Note: The system sends the sequence number rather than the order line number from the Order Detail table in the E-Commerce Order Status Response Message (CWStatusResponse).

3/24/15 242

E-Commerce Order Status Message (CWOrderStatus)

The EC_STS_INQ job, started through Working with E-Commerce Job Control (EJCT), receives E-Commerce Order Status messages from the web storefront. The Order Status message defines the order number whose summary information you wish to review. The system sends an E-Commerce Order Status Response Message (CWStatusResponse) back to the web storefront containing the order summary information.


• E-Commerce Order Status Processing for additional processing information.

• E-Commerce Order Status Message: Sample XML


MessageOne Message is required.

source alpha Identifies the source of the message. WEB indicates the message is from the web storefront. Required.

target alpha Identifies the target of the message. RDC indicates the message is sent to CWSerenade.Required.

type alpha Identifies the type of information in the message.Required.

resp_qmgr alpha 44 The queue manager (if using WebSphere MQ) or connection factory (if using HornetQ) identified for the process queue in Working with E-Commerce Job Control (EJCT).

resp_q alpha 44 The queue identified for the process queue in Working with E-Commerce Job Control (EJCT).

CWSerenade 5.0

3/24/15 243

OrderStatusOne OrderStatus is required.


3 A code for the company where the order is located. Maps to the CMP Company field in the Order Header table. Required.

order_id numeric

8 The CWSerenade order number. Maps to the Order # field in the Order Header table. Required.

bill_to_lname alpha 25 The last name of the sold to customer on the order. Maps to the NAM Last name field in the Customer Sold To table, based on the Cust # field in the Order Header table.

ind_lname alpha 25 The last name of the placer of the order. Maps to the CIF Last name field in the Customer Individual table, based on the OHE Placer field in the Order Header Extended table.

company_name alpha 30 The company name defined for the sold to customer on the order. Maps to the NAM Company name field in the Customer Sold To table, based on the Cust # field in the Order Header table.


CWSerenade 5.0

3/24/15 244

E-Commerce Order Status Message: Sample XML

A sample of the E-Commerce Order Status Message (CWOrderStatus) in XML format is presented below.

- <Message source="WEB" target="RDC" type="CWOrderStatus"> <OrderStatus company_code="555" order_id="7564" bill_to_lname="MIRANDA" ship_to_details="1" />

</Message>

ship_to_details alpha 1 Included if the customer is not registered on the web storefront. Indicates whether the E-Commerce Order Status Response Message (CWStatusResponse) includes ship to detail. 1 = The Order Status Response message includes each ship to on an order, so that the customer can review the items separately for each ship to address.0 or blank = The Order Status Response message does not include the ship to information; all items on the order will appear together regardless of the ship to address. If the customer is registered on the web storefront, the Order Status Response message includes a listing of all the customer’s e-commerce (order API) orders and all ship tos.


CWSerenade 5.0

3/24/15 245

E-Commerce Order Status Response Message (CWStatusResponse)

The EC_STS_INQ job, started through Working with E-Commerce Job Control (EJCT), generates an Order Status Response message when an E-Commerce Order Status Message (CWOrderStatus) is received from the web storefront. The Order Status Response message contains order summary information.


• E-Commerce Order Status Processing for additional processing information.

• E-Commerce Order Status Response Message: Sample XML



source alpha Identifies the source of the message. RDC indicates the message is from CWSerenade.

target alpha Identifies the target of the message. WEB indicates the message is sent to the web storefront.

type alpha Identifies the type of information in the message.

HeaderOne Header element is required.

company_code numeric 3 A code for the company where the order is located. From the CMP Company field in the Order Header table.

CWSerenade 5.0

3/24/15 246

offer_id alpha 3 A code for the offer associated with the order.From the Offer number field in the Source table, based on the OHD SRC Source code field in the Order Header table.

order_id numeric 8 The CWSerenade order number.From the Order # field in the Order Header table.

response_type numeric 2 Included if the Pass E-Commerce Order Status Response Type (H68) system control value is selected. Indicates if an order was found that matches the order status inquiry. 1 = An order was found that matches the order status inquiry. The Order Status Response message includes order information. 2 = An order was found that matches the order status inquiry, but the last name defined for the inquiry does not match the last name on the order. The Order Status Response message includes order information; however the response type 2 indicates the last name defined on the order status inquiry does not match the last name on the order.3 = An order was not found that matches the order status inquiry. The Order Status Response message includes company_code. order_id, and a response_type of 3, but does not include order information.

If the Pass E-Commerce Order Status Response Type (H68) system control value is unselected, the system only sends an Order Status Response message to the web storefront if an order number is found that matches the order_id in the Order Status message and a match is found on at least one of the name fields in the request (bill_to_lname, ind_lname, or company_name).


CWSerenade 5.0

3/24/15 247

date_placed numeric 8 The date the order was placed.From the OHD Order date field in the Order Header table.

ShipToThe ShipTos element can include one or more ShipTo elements.

ship_to_number numeric 3 The order ship to number on the order. From the Ship to # field in the Order Ship To table.

ship_to_fname alpha 15 The first name of the ship to customer on the order.From the:• NAM First name field in the Order Ship To table.• NAM First name field in the Customer Ship To table, or• NAM First name field in the Customer Sold To table.

ship_to_lname alpha 25 The last name of the ship to customer on the order. From the: • NAM Last name field in the Order Ship To Address table, or• NAM Last name field in the Customer Ship To table, or• NAM Last name field in the Customer Sold To table.

allow_maint alpha 1 Indicates if the order is eligible for maintenance. Y = The order is eligible for maintenance; see E-Commerce Cancel Process Overview.N = The order is not eligible for maintenance.

InvoiceThe Invoices element can include one or more Invoice elements.

date_shipped numeric 8 The date the order was shipped. From the IDT Date shipped field in the Invoice Detail table.


CWSerenade 5.0

3/24/15 248

tracking_id alpha 30 The shipment tracking number assigned to the order shipment. From the MUA Tracking # field in the Manifest Upload Audit table. This number is stored in the Manifest Upload Audit table if you use PC manifesting, the generic Pick In API, or manually confirming shipments to ship an order.

ship_via numeric 2 The shipper assigned to the order shipment. From the VIA Ship via code field in the Manifest Upload Audit table.

ItemThe Items element can include one or more Item elements.

sku numeric 7 The short SKU code of the item on the order line. Maps to the Short SKU field in the SKU table.

item_id alpha 12 The item number on the order line.Maps to the ITM Number field in the Order Detail table.

line_nbr numeric 3 The order line sequence number.Maps to the Seq # field in the Order Detail table.

description alpha 40 A description of the item on the order line.Maps to the Description field in the Item table.

sku_description1 alpha 10 A description of the first SKU element. Maps to the Element 1 desc field in the SKU Element 1 table.

sku_description2 alpha 10 A description of the second SKU element.Maps to the Element 2 desc field in the SKU Element 2 table.

sku_description3 alpha 10 A description of the third SKU element.Maps to the Element 3 desc field in the SKU Element 3 table.


CWSerenade 5.0

3/24/15 249

quantity numeric 5 The quantity of the item ordered on the order line. Maps to the ODT Qty ordered field in the Order Detail table.

list_price numeric 7.2 The selling price of the item on the order line. Maps to the ODT Price field in the Order Detail table.

status alpha 40 Indicates the status of the item on the order line, based on the ODT Line status field in the Order Detail table. Valid values:Item sent to store for pickup (SP)Your membership is being processed (Y)Item is no longer available (S)Item will be shipped directly from the vendor (D)In stock and reserved (IN)Item is backordered (BO)X reserved (1, partial backorder)


CWSerenade 5.0

3/24/15 250

E-Commerce Order Status Response Message: Sample XML

A sample of the E-Commerce Order Status Response Message (CWStatusResponse) in XML format is presented below.

- <Message source="RDC" target="WEB" type="CWStatusResponse">

rtn_qty numeric 5 The quantity of the item on the order line that has been shipped, and so is eligible to be returned.Note: When the order is a:

• retail pickup or delivery order: If the Suppress Returns for Retail Pickup/Delivery (L88) system control value is selected, the E-Commerce Order Status Response Message (CWStatusResponse) might indicate that there is a rtn_qty eligible for return; however, in this situation you cannot create a return authorization for the order, and if the web sends the E-Commerce Return Request Message (CWReturn), the E-Commerce Return Response Message (CWReturnResponse) does not include a return authorization number.

• ship-to-store order: If the Payment at POS for Ship to Store (L60) system control value is selected, the E-Commerce Order Status Response Message (CWStatusResponse) might indicate that there is a rtn_qty eligible for return; however, in this situation you cannot create a return authorization for the order, and if the web sends the E-Commerce Return Request Message (CWReturn), the E-Commerce Return Response Message (CWReturnResponse) does not include a return authorization number.

cancel_qty numeric 5 The quantity of the item on the order line that is open, and so is eligible to be canceled.


CWSerenade 5.0

3/24/15 251

<Header company_code="555" offer_id="204" order_id="7564" response_type="01" date_placed="07192006" /> - <ShipTos>

- <ShipTo ship_to_number="001" ship_to_fname="BERNADETTE" ship_to_lname="MIRANDA"> - <Invoices>

<Invoice date_shipped="07192006" ship_via="1" /> </Invoices> - <Items>

<Item sku="1748" item_id="2004ITEM2" line_nbr="2" description="2004ITEM2 ITEM DESCRIPTION" quantity="1" list_price="0001000" status="1 unit shipped on 07/19/2004" /> <Item sku="1745" item_id="2004ITEM1" line_nbr="11" description="2004ITEM1 DESCRIPTION" quantity="1" list_price="0000500" status="" /> <Item sku="1750" item_id="2004ITEM3" line_nbr="13" description="2004ITEM3 ITEM DESCRIPTION" quantity="1" list_price="0001000" status="" />

</Items> </ShipTo>

</ShipTos> </Message>

3/24/15 Creating Return Authorizations from the Web Storefront 252

Creating Return Authorizations from the Web Storefront

Purpose: You can enable customers to create return authorizations on the web through the e-commerce interface if your storefront supports it. Using this option, the customer specifies the item(s) on a shipped order to return and the reason for the return. The system confirms that each item is eligible for return; that is, the customer is not attempting to return more than the shipped, unreturned quantity. You can then enable the customer to print a return label with the correct address for returning the shipment. Once the return authorization is created, you can either complete processing by receiving the return into inventory and crediting it, or you can delete the return authorization if necessary.

In this topic:

• E-Commerce Return Authorization Processing

• E-Commerce Return Request Message (CWReturn)

• E-Commerce Return Response Message (CWReturnResponse)

E-Commerce Return Authorization Processing

The steps to creating a return authorization through the e-commerce interface are:

1. The customer inquires about an order: First, the customer inquires on a specific order. Typically, the web storefront processes the inquiry by sending the E-Commerce Order Status Message (CWOrderStatus). When the system receives the status inquiry request from the web, it returns an E-Commerce Order Status Response Message (CWStatusResponse). Included in that response message is the rtn_qty for each line on the order. Each item on an order has a rtn_qty only if:

• there is a return disposition code defined in the Default Disposition Code (C18) system control value, and

• there is a shipped, unreturned quantity for the item on the order.

The rtn_qty excludes any units that have been returned, even if the return authorization process is not complete. For example, if you originally shipped the customer 5 units, and you have created a return authorization for 2 units, then the rtn_qty for the order detail line is 3.

Note:

• The system sends the sequence number, not the order line number, from the Order Detail table in the E-Commerce Order Status Response Message (CWStatusResponse).

CWSerenade 5.0


• If the order is a retail pickup or delivery order, and the Suppress Returns for Retail Pickup/Delivery (L88) system control value is selected, the E-Commerce Order Status Response Message (CWStatusResponse) might indicate that there is a rtn_qty eligible for return; however, in this situation you cannot create a return authorization for the order, and if the web sends the E-Commerce Return Request Message (CWReturn), the E-Commerce Return Response Message (CWReturnResponse) does not include a return authorization number.

• If the order is a ship-to-store order, and the Payment at POS for Ship to Store (L60) system control value is selected, the E-Commerce Order Status Response Message (CWStatusResponse) might indicate that there is a rtn_qty eligible for return; however, in this situation you cannot create a return authorization for the order, and if the web sends the E-Commerce Return Request Message (CWReturn), the E-Commerce Return Response Message (CWReturnResponse) does not include a return authorization number.

2. The customer requests the return: The E-Commerce Return Request Message (CWReturn) from the web storefront includes the order line sequence number, the quantity to return, and the return reason code. You can download return reason codes to the web storefront through Downloading E-Commerce Static Tables (ESTF).

3. The system creates the return authorization: If the request is valid and the order line is eligible for return, the system creates the return authorization using the following defaults:

• the return disposition code defaults from the Default Disposition Code (C18) system control value

• the Refund freight, Refund add’l chgs, and Refund handling flags are unselected

• the Refund duty charges flag is selected

The system creates a new return authorization for the order ship to, using the next RA # available for the order ship to in the RA Header table. If the Use CWCollaborate (H13) system control value is selected, when the system creates a new return authorization, the system looks at the highest RA# assigned to the order ship to in the RA Header table and compares it to the highest RA # assigned to the order ship to in the CSF Transaction table. Whichever table has the higher RA # defined for the order ship to, the system uses the next available number to create the return authorization. For example, if the highest RA # in the RA Header table for an order ship to is 1, but the highest RA # in the CSF Transaction table for an order ship to is 2, the system creates a new return authorization for the order ship to using RA # 3.

Note: The system does not validate that all the information it receives is correct when it creates the return authorization. For example, if the return reason code is not valid, or the line number is not correct, these issues will not be visible to the customer at the web storefront.

4. The system writes an order history message: If the system creates the return authorization, it writes a message such as:

CWSerenade 5.0


7/21/00 N RA 5297-1-1 created from the web.

If the system can create the return authorization, but not for the total requested quantity, the system also writes a message such as:

7/21/06 N Web rtn qty changed from 2 to 1.

The system might change the return quantity because, for example, the customer specified a return quantity of 2, but only 1 unit was shipped.

You can review these messages at the Display Order History screen in order inquiry.

5. The system determines whether to create a return authorization download trigger: If the Create Return Download Triggers (K28) system control value is selected, the system creates a return authorization download (RAD) trigger when you create a return authorization from the web storefront, based on the trigger rules defined for the Return Authorization Download (RETURN_OUT) integration layer job. The RETURN_OUT integration layer job monitors for return authorization download triggers and generates a Return Authorization Outbound XML Message (CWReturnRAOut) to send the return authorization information to a remote system.

6. The system responds to the return request: If the return request was successful and the system is able to create a return authorization, the system sends an E-Commerce Return Response Message (CWReturnResponse) to the web. This message includes:

• the return authorization number

• the address to print on the return label: you can enable the customer to print a return label if the web storefront supports it.

Unsuccessful returns: If the request is unsuccessful and the system is not creating a return authorization, the system does not return a return authorization number in the response; instead, the ra_number returned is none. For example, a request would be unsuccessful if:

• there is no rtn_qty eligible for return on the order line, or

• the order is a retail pickup or delivery order, and the Suppress Returns for Retail Pickup/Delivery (L88) system control value is selected, or

• the order is a ship-to-store order, and the Payment at POS for Ship to Store (L60) system control value is selected, or

• the SECRISK periodic function deactivated the payment method; see the Credit Card Retention Days (K65) system control value for background

If the process cannot create a return authorization for the order line, it writes an Order Transaction History message: Web Return failed to process. You can review these messages at the Display Order History screen in order inquiry.

CWSerenade 5.0


7. Completing or deleting the return: You can use Work with Return Authorizations (WRTA) to complete the processing of the return once the returned item is received at your warehouse. Also, you can use this menu option to delete the return authorization if you are not completing the return

Return confirmations: The system generates a return confirmation email or Outbound Email XML Message (CWEmailOut) when you:

• process a return through billing if the Send Shipment Confirmation from Billing (L98) system control value is selected.

• generate return confirmations using the Send Internet Order Ship Confirmations menu option (ESCF).

• execute the ECSHCNF periodic function.

3/24/15 256

E-Commerce Return Request Message (CWReturn)

The EC_RETURNS job, started through Working with E-Commerce Job Control (EJCT), receives E-Commerce Return Request messages from the web storefront. The Return Request message defines the order line(s) you wish to return. The E-Commerce Return Response Message (CWReturnResponse) sends the return authorization information back to the web storefront.


• Creating Return Authorizations from the Web Storefront for an overview.

• E-Commerce Return Request Message: Sample XML



source alpha Identifies the source of the message. WEB indicates the message is from the web storefront.Required.

target alpha Identifies the target of the message. RDC indicates the message is sent to CWSerenade.Required.

type alpha Identifies the type of information in the message. CWReturn indicates the message contains a return request. Required.

resp_qmgr alpha 44 The queue manager (if using WebSphere MQ) or connection factory (if using HornetQ) in Working with E-Commerce Job Control (EJCT).

CWSerenade 5.0

3/24/15 257

resp_q alpha 44 The queue identified for the process queue in Working with E-Commerce Job Control (EJCT).

ReturnOne Return element is required.


3 A code for the company where the order to return is located. Maps to the CMP company field in the Order Detail table.Required.

order_id numeric

8 The order number containing the item(s) to return.Maps to the Order # field in the Order Detail table.Required.

ship_to numeric

3 The order ship to number containing the item(s) to return.Maps to the Ship to # field in the Order Detail table.Required.

LineThe Lines element can include one ore more Line elements.

line_number numeric

5 The order line sequence number containing the item to return.Maps to the Seq # field in the Order Detail table.Required.

qty numeric

5 The quantity of the item to return.Maps to the RAD Qty to return field in the RA Detail table.Required.

reason numeric

3 The reason for returning the item. Maps to the RTR Return reason code field in the RA Detail table.Required.


CWSerenade 5.0

3/24/15 258

E-Commerce Return Request Message: Sample XML

A sample of the E-Commerce Return Request Message (CWReturn) in XML format is presented below.

- <Message source="web" target="rdc" type="CWReturn"> - <Return company_code="555" order_id="7616" ship_to="1">

- <Lines> <Line line_number="1" qty="1" reason="2" /> <Line line_number="2" qty="1" reason="1" />

</Lines> </Return>

</Message>

CWSerenade 5.0

3/24/15 259

E-Commerce Return Response Message (CWReturnResponse)

The EC_RETURNS job, started through Working with E-Commerce Job Control (EJCT), generates an E-Commerce Return Response message when it receives an E-Commerce Return Request Message (CWReturn) from the web storefront. The Return Response message contains information about the return that was processed and information to print on a confirmation label.


• Creating Return Authorizations from the Web Storefront for an overview.

• E-Commerce Return Response Message: Sample XML



source alpha Identifies the source of the message. RDC indicates the message is from CWSerenade.

target alpha Identifies the target of the message. WEB indicates the message is sent to the web storefront.

type alpha Identifies the type of information in the message. CWReturnResponse indicates the message contains a return response.

ReturnResponseOne ReturnResponse element is included.


3 A code for the company where the return was processed. From the Company field in the RA Header table.

CWSerenade 5.0

3/24/15 260

order_id numeric

8 The order number containing the item(s) returned. From the Order # field in the RA Header table.

ship_to numeric

3 The order ship to number containing the item(s) returned. From the Ship to # field in the RA Header table.

ra_number alpha 16 The order number + ship to number + return authorization number associated with the return.An RA number of none indicates that the return was rejected. See Creating Return Authorizations from the Web Storefront for information on why a return authorization request might be rejected.From the Order #, Ship to #, and RAH RA# field in the RA Header table.

total_weight numeric

7.3 The total weight of the returned items. From the Ship weight field in the SKU table or Item table.

date_entered numeric

8 The date the return was processed in MMDDYYYY format. From the RAH Date entered field in the RA Header table.

name alpha 30 The name of the warehouse where the item will be returned.From the Name field in the Warehouse table.

address alpha 32 The street address for the warehouse address.From the Address field in the Warehouse table.

address2 alpha 32 The second address line of the warehouse address.From the Address line 2 field in the Warehouse table.

city alpha 25 The city for the warehouse address.From the City field in the Warehouse table.


CWSerenade 5.0

3/24/15 261

E-Commerce Return Response Message: Sample XML

A sample of the E-Commerce Return Response Message (CWReturnResponse) in XML format is presented below.

- <Message source="RDC" target="WEB" type="CWReturnResponse"> <ReturnResponse company_code="555" order_id="7616" ship_to="001" ra_number="7616-1-1" total_weight="12000" date_entered="07262006" name="KAB Co." address="24 WALNUT STREET" address2="WALNUT PLACE" city="WESTBOROUGH" state="MA" zip="01581" country="USA" phone_number="508 555-0100" />

</Message>

state alpha 2 The state code for the warehouse address.From the State field in the Warehouse table.

zip alpha 10 The postal code for the warehouse address.From the Zip code field in the Warehouse table.

country alpha 3 The country code for the warehouse address.From the RPR country field in the Warehouse table.

phone_number alpha 14 The warehouse’s phone number. From the Phone field in the Warehouse table.


3/24/15 Working with Batch Order Maintenance Transactions (WBOM) 262

Working with Batch Order Maintenance Transactions (WBOM)

Purpose: Use this menu option to work with errors resulting from order cancel requests from the web storefront.

About order cancel requests from the web: You can enable your customers to submit cancel requests from the web storefront if you use the e-commerce interface. Each cancel request on the web storefront generates a message to CWSerenade indicating whether to cancel the order or a specific order line. Occasionally, the system cannot process the request. For example, the customer might attempt to cancel an order line that has recently shipped.

Fixing errors: When there is an error, you might choose to complete the requested transaction yourself; or you might need to contact the customer for further information if the desired transaction is not clear. However, you cannot edit and resubmit the maintenance requests through the Batch Order Maintenance menu option. Once you have resolved the request through research, order maintenance, or customer contact, you should delete the related error record.

What if the order includes a membership item? If the cancel request attempts to cancel a membership item, the order cancellation process does not automatically cancel the customer membership created by the membership item. You need to use Working with Customer Memberships (WWCM) in order to cancel the customer membership.

What if the order includes an order line assigned to the Order Broker? If the cancel request attempts to cancel a brokered backorder, the request goes into error status with an error of Order Has Picks Open. You need to use order maintenance or the cancel option in Work with Order Broker to cancel the order line.

What if the order is a retail pickup or delivery order received from the Order Broker? If the cancel request is for a retail pickup or delivery order, the process sends a status update to the Order Broker indicating that the order is canceled. The Order Broker does not attempt to find another location to fulfill the order.

What if the order is a store pickup order? You cannot cancel a store pickup order through the CWCancel message.

In this topic:

• E-Commerce Cancel Process Overview

• When is an Order Eligible for Cancellation through the E-Commerce Interface?• Order Inquiry/Maintenance Message Flow• Processing the Request• E-Commerce Cancellation Transactions• Emails for E-Commerce Cancels

CWSerenade 5.0


• Order History Messages

• Work with Batch OM Transactions Screen

• Display Batch OM Transactions Screen (Header)

• Display Batch OM Transactions Screen (Detail)

• Display Batch OM Detail Screen

• Display Batch OM Errors Screen

• Batch Order Cancel Errors

• E-Commerce Order Maintenance Errors Report

• E-Commerce Cancel Request Message (CWCancel)

CWSerenade 5.0


E-Commerce Cancel Process Overview

When is an Order Eligible for Cancellation through the E-Commerce Interface?

In order to be fully or partially canceled through the e-commerce interface, the order must:

• have originated on the web storefront. If an order originated on the web, the Internet order field on the Order Header table is set to I.

• be in an open (O) or held (H) status

• have no pick slips printed

• not be assigned to the Order Broker for fulfillment

Also, you will not be able to complete cancellation of the order or order line if the order is in use. The system determines that an order is “in use” if the User field on the Order Header table is not blank; for example, the system populates this field when you are maintaining an order, and clears it when you are done with maintenance.

What if the order includes a membership item? If the cancel request includes a membership item, the order cancellation process does not automatically cancel the customer membership created by the membership item. You need to use Working with Customer Memberships (WWCM) in order to cancel the customer membership.

What if the order includes an order line assigned to the Order Broker? If the cancel request attempts to cancel an order line that is assigned to the Order Broker for fulfillment, the request goes into error status with an error of Order Has Picks Open. You need to use order maintenance or the Work with Order Broker (WOBR) option to cancel the order line.

Order Inquiry/Maintenance Message Flow

The e-commerce jobs manage communication between the web storefront and CWSerenade; see Working with E-Commerce Job Control (EJCT). Order inquiry and maintenance through the e-commerce interface use the following messages:

Message Direction Purpose

To check status:

E-Commerce Order Status Message (CWOrderStatus)

web storefront to CWSerenade

Inquires on the status of the order.

CWSerenade 5.0


Processing the Request

In response to a cancellation request from the web storefront, the system:

• Locks the order: The system sets the User field on the Order Header table to E-COMMERCE to prevent another user or process from attempting to update the order at the same time.

• Creates batch order maintenance error records: The system uses these records, if necessary, to track any errors in the cancellation request. See Work with Batch OM Transactions Screen.

• Edit: Next, the ECOMM_CANC job checks whether there are any errors for the request.

• If there are no errors, the ECOMM_CANC job:

• processes the requested update(s) to the order. • deletes the batch order maintenance error records.• unlocks the order.

• If there are errors, the ECOMM_CANC job:

• updates the batch order maintenance error record with one or more error codes. See Display Batch OM Errors Screen.

• depending on customer preference, sends the customer an email indicating that the cancellation attempt was not successful. See Emails for E-Commerce Cancels.

E-Commerce Order Status Response Message (CWStatusResponse)

CWSerenade to web storefront

Provides information on the order header and detail. If the Allow_maint field is 1, this indicates that the order is eligible for cancellation. Also, the cancel_qty field for each order line indicates the quantity of the item that is eligible for cancellation.

To cancel:

E-Commerce Cancel Request Message (CWCancel)

web storefront to CWSerenade

Attempts to cancel:• individual items, or reduce the quantities of selected items; or,• the entire order ship-to (a separate cancel request is required to cancel each separate shipping address for the order)This message also indicates the reason for the cancellation. See E-Commerce Cancellation Transactions.

Message Direction Purpose

CWSerenade 5.0


• writes an order history message indicating that the attempt to update the order was not successful and that an email was generated. See Order History Messages.

• places the order on hold if there is a hold reason specified in the Hold Reason for Failed E-Commerce Maintenance Transactions (H11) system control value.

• produces the E-Commerce Order Maintenance Errors Report.• unlocks the order.

You can use the Work with Batch OM Transactions Screen to review any cancel requests that are in error.

Note: If there are any errors in the request, none of the requested changes will be processed until the errors are corrected and the edit resubmitted.

E-Commerce Cancellation Transactions

Required for each cancel request:

• Company_code: three positions, alphanumeric; for example, company 7 is indicated by 007

• Order_id: order number

• Ship_to: the number identifying the shipping address on the order; for example, an order with a single shipping address has a ship-to number of 001

• Cancel_type:

• O = order• L = line

Whole order, single ship-to: The Cancel_type must be O and the Order_reason must specify a valid cancel reason code for the order.

Note: If there are multiple shipping addresses, the cancel request for each ship-to must be sent separately.

Single item, reducing quantity or canceling the entire order line: the Cancel_type must be L and the following information is also required:

• Line_number: the order line number to be cancelled or have its quantity reduced

• Qty: the total quantity to cancel

• Reason: the valid cancel reason code

CWSerenade 5.0


Emails for E-Commerce Cancels

Cancellation email: The ORDR_ASYNC job generates an order or order line cancellation email to the customer if:

• the cancellation attempt is successful, and

• you have specified an:

• Order Line Cancellation Email Program (K79), if no shipments have occurred, or• Order Cancellation Email Program (K78), and

• the cancel reason code you use does not match the Cancel Reason Code to Suppress Email (L08), and

• the customer is eligible to receive email notifications; see When Does the System Generate an Email Notification?

See the Order Cancellation Confirmation Email Sample and Contents and the Order Line Cancellation Confirmation Email Sample and Contents for more information.

If the cancellation attempt is unsuccessful, the system generates the maintenance failure email.

The system selects the order cancellation, order line cancellation, or maintenance failure email template as appropriate. See Work with E-Mail Template Screen. If the system sends an email, this information is noted in the order history message.

Order History Messages

The system writes the following message to order history if the cancellation request fails:

Web cancel request failed.

If the cancel request is successful:

Web maintenance request processed.

If the system generates an email notification (see Emails for E-Commerce Cancels), it writes a message such as the following:

Ord Can Conf to [email protected].

You can review order history messages at the Display Order History screen in order inquiry.

CWSerenade 5.0


Work with Batch OM Transactions Screen

Purpose: Use this screen to review any errors that have resulted when customers attempt to cancel orders from the web storefront. Also, you can use this screen to delete error records once you have resolved the errors, as the system does not delete them automatically.

Fixing errors: You might choose to complete the requested transaction yourself; or you might need to contact the customer for further information if the desired transaction is not clear. However, you cannot edit and resubmit the cancellation requests through this menu option.

For more information: See E-Commerce Cancel Process Overview.

How to display this screen: Enter WBOM in the Fast path field at the top of any menu, or select Work with Batch OM Transactions from a menu.

Field Description

Order number An order that a customer has attempted to cancel from the web storefront.Numeric, 8 positions; optional.

St# (Ship-to number)

This number indicates the order ship-to address that the customer attempted to cancel.Numeric, 3 positions; optional.

Activity The type of transaction that the customer attempted to perform. Valid values are:• Cancel Order• Line CancelThis field is blank if the cancel request message from the web storefront did not specify a valid cancel type code.Display-only.

Screen Option Procedure

Delete a batch order maintenance error record

Select Delete for an error record to delete it. The system does not delete errors automatically, so typically you will delete errors as you resolve them.

CWSerenade 5.0


Display a cancel request in error Select Display for an error record to display the header-level information for the cancel request. You advance to the Display Batch OM Transactions Screen (Header).If the request includes serious errors, you will not be able to review the error record; instead, the system displays a message such as the following:Order 5493-7 is invalid -- cannot display. Print list to see errors. See E-Commerce Order Maintenance Errors Report.

Display the error message(s) for a cancel request

Select Errors for an error record to review the error message(s) for the cancel request. You advance to the Display Batch OM Errors Screen.

Advance to standard order inquiry Select Order Inquiry for an error record to advance to order inquiry.

Print a listing of all batch order maintenance errors in your company

Select Error List to print the E-Commerce Order Maintenance Errors Report, including all errors in your company.


CWSerenade 5.0


Display Batch OM Transactions Screen (Header)

Purpose: Use this screen to review the header-level information that was included in the cancel request from the web storefront that was in error, so that you can determine the transaction that the customer was attempting to process.

Note: If the request includes serious errors, you will not be able to review the error record; instead, the system displays a message such as the following:

Order 5493-7 is invalid -- cannot display. Print list to see errors. You can use the Display Batch OM Errors Screen to review the errors.

How to display this screen: Select Display for a cancellation error at the Work with Batch OM Transactions Screen.

Field Description

Order number An order that a customer has attempted to cancel from the web storefront. The order ship-to address is separated from the order number by a hyphen.Order number: numeric, 8 positions; display-only.Ship-to number: numeric, 3 positions; display-only.

Activity The type of transaction that the customer attempted to perform. Valid values are:• Cancel Order• Line CancelThis field is blank if the cancel request message from the web storefront did not specify a valid cancel type.Display-only.

Cancel reason The cancel reason code to use when cancelling the order. This information is included only for an order-level cancel request. You can download cancel reasons to the web storefront through the Downloading E-Commerce Static Tables (ESTF) menu option.Numeric, 2 positions; display-only.


Select a detail line transaction from the cancel request for review

Select Details to advance to the Display Batch OM Transactions Screen (Detail) if the cancel request was a line cancel.

CWSerenade 5.0


Display the error message(s) for this cancel request

Select Errors to advance to the Display Batch OM Errors Screen.

Advance to standard order inquiry Select Order Inquiry to advance to order inquiry.

Print a listing of the errors for this cancel request

Select Error List to print the E-Commerce Order Maintenance Errors Report, including all errors for this cancel request only.


CWSerenade 5.0


Display Batch OM Transactions Screen (Detail)

Purpose: Use this screen to select a detail line for review if a cancel request in error included order line-level information. Line-level information could include either canceling a particular line or reducing the quantity.

If the request was to cancel the order, there will not be any detail information on this screen.

How to display this screen: Select Details at the Display Batch OM Transactions Screen (Header).

Field Description

Order number An order that a customer has attempted to cancel from the web storefront. The order ship-to address is separated from the order number by a hyphen.Order number: numeric, 8 positions; display-only.Ship-to number: numeric, 3 positions; display-only.

Action The action that the customer has attempted to perform against the order detail line. The only valid value is:Line cancellation = Reduce the quantity of the order detail line or cancel it entirelyDisplay-only.

Line number The order detail line number to be cancelled.Numeric, 3 positions; display-only.

Cnr (Cancel reason code)

The cancel reason code specified in the cancel request to describe why the customer wants to cancel or reduce the quantity of the order detail line. This information is included only for a detail-level cancel request.You can download cancel reasons to the web storefront through the Downloading E-Commerce Static Tables (ESTF) menu option.Numeric, 2 positions; display-only.

Qty The quantity of the item that the customer has attempted to cancel. Numeric, 3 positions; display-only.

CWSerenade 5.0


Item The item that the customer has attempted to cancel. The system determines which item the customer has selected by the order detail line (when working with an existing order detail line) or the short SKU number (when adding a new item to the order). The short SKU number is stored in the SKU table. If the request does not specify a valid short SKU, the item and SKU information listed on this screen may be inconsistent; for example, even if the item code is valid, the SKU information may not represent a valid SKU for the item.Alphanumeric, 12 positions; display-only.

SKU The item’s unique characteristics, such as its color and size.Alphanumeric, three 4-position fields; display-only.


Select a detail transaction in error to review Select Display for a detail line to advance to the Display Batch OM Detail Screen.

Review header information for the maintenance or cancel request

Select Header to advance to the Display Batch OM Transactions Screen (Header).

Display the error message(s) for the maintenance or cancel request

Select Errors to advance to the Display Batch OM Errors Screen.

Advance to standard order inquiry Select Order Inquiry to advance to order inquiry.

Print a listing of the errors for this maintenance or cancel request

Select Error List to print the E-Commerce Order Maintenance Errors Report, including all errors for this maintenance or cancel request only.

Field Description

CWSerenade 5.0


Display Batch OM Detail Screen

Purpose: Use this screen to review detail information on a cancel line request from the web storefront that is in error.

How to display this screen: Select Display for a detail line at the Display Batch OM Transactions Screen (Detail).

Field Description

Order number The order and line number that a customer has attempted to cancel from the web storefront. The order ship-to address is separated from the order number by a hyphen, and the order line number follows:order number - ship-to number - order line number

Order number: numeric, 8 positions; display-only.Ship-to number: numeric, 3 positions; display-only.Order line number: numeric, 3 positions; display-only.

Activity The action that the customer has attempted to perform against the order detail line. The only valid value is:Line cancellation = Reduce the quantity of the order detail line or cancel it entirelyDisplay-only.

Item/SKU The item that the customer has attempted to cancel. The system determines which item the customer has selected by the order detail line (when working with an existing order detail line) or the short SKU number (when adding a new item to the order). The short SKU number is stored in the SKU table.Alphanumeric, 12 positions; display-only.

Quantity The quantity of the item that the customer has attempted to cancel.Numeric, 3 positions; display-only.

Cancel reason The cancel reason code specified in the cancel request to describe why the customer wants to cancel or reduce the quantity of the order detail line. This information is included only for a detail-level cancel request.You can download cancel reasons to the web storefront through the Downloading E-Commerce Static Tables (ESTF) menu option.Numeric, 2 positions; display-only.

CWSerenade 5.0


Display Batch OM Errors Screen

Purpose: Use this screen to review the errors that have prevented a cancel request from being processed.

How to display this screen: Select Errors for an error record at the Work with Batch OM Transactions Screen, or select Errors at the Display Batch OM Transactions Screen (Header) or the Display Batch OM Transactions Screen (Detail).

Field Description

Order number An order that a customer has attempted to cancel from the web storefront. The order ship-to number is separated from the order number by a hyphen.Order number: numeric, 8 positions; display-only.Ship-to number: numeric, 3 positions; display-only.

Line number The order detail number associated with the error. This field is blank if the error is associated with header-level information, or if the system could not determine which line number was involved.Numeric, 3 positions; display-only.

Error description The description of the error that prevented the cancel request from being processed. See Batch Order Cancel Errors.Alphanumeric, 25 positions; display-only.

Notes For certain errors, this field displays the description of the error that prevented the maintenance or cancel request from being processed. If the error is the result of an item on the order that already existed and was not part of the maintenance or cancel request, the message is: Error from a line that was not maintained.


Print a listing of the errors for this cancel request

Select Error List to print the E-Commerce Order Maintenance Errors Report, including all errors for this cancel request only.

CWSerenade 5.0


Batch Order Cancel Errors

Error Message Occurs When:

Detail Errors

Invalid Order Detail

The order line number specified in the cancel request does not exist on the order.

Line is not Open The order line has a status of X (closed).

Pick Exists for Line

There is currently a printed pick slip for the order line.

Cpn Item Required The order line specified for cancellation is required for an order-level coupon. Note: Although the error is retained for review, the system does cancel the order line and does not automatically remove the coupon from the order.

Order Tot < Cpn Requires

The cancel request has reduced the order total below the minimum required for a coupon on the order.Note: • Although the error is retained for review, the system does not automatically remove the coupon from the order.• This error is listed on the Display Batch OM Errors Screen for each order detail line on the order.

Header Errors

Order Has Picks Open

Any order detail lines on the order have pick slips printed or are assigned to the Order Broker for fulfillment.

Order In Use The order is locked from update because a user is maintaining it, or another process on the system is updating it. Use Unlock Stranded Order or Batch (MULO) to unlock the order.

Order Not Open or Held

The order status is not open (blank) or held (H).

Invalid Cancel Quantity

The quantity specified in the cancel request exceeds the quantity eligible for cancellation for the order detail line.

Invalid Cancel Reason

The cancel reason is not valid, as defined through Work with Cancel Reasons (WCNR).

CWSerenade 5.0

3/24/15 277

E-Commerce Order Maintenance Errors ReportHow to print: This report is generated automatically through the ECOMM_CANC job when a cancel request from the web storefront fails. You can also generate this report on demand by selecting Error List at the Work with Batch OM Transactions Screen, Display Batch OM Transactions Screen (Header), Display Batch OM Transactions Screen (Detail), or Display Batch OM Errors Screen.

Contents:

• order number with ship-to number

• sold-to customer

• ship-to customer

• maintenance activity:

• cancel lines on an order• cancel order

• cancel reason, if included in a cancel request

• email address (not currently implemented)

• description of each error at the header level; see Batch Order Cancel Errors

For each requested detail-level transaction that resulted in an error:

• activity (line cancellation)

• order line number

• cancel reason

• quantity to cancel

• description of each error at the detail level; see Batch Order Cancel Errors

3/24/15 278

E-Commerce Cancel Request Message (CWCancel)

The EC_CANCELS job, started through Working with E-Commerce Job Control (EJCT), handles Cancel Request messages from the web storefront. The Cancel Request message can specify the entire order ship-to, or specific items on the order. An email confirmation indicates whether the cancellation request was successful.


• E-Commerce Cancel Process Overview for additional processing information

• E-Commerce Cancel Request Message: Sample XML



source alpha Identifies the source of the message.WEB indicates the XML message is from the web storefront.Required.

target alpha Identifies the target of the message. RDC indicates the XML message is sent to CWSerenade.Required.

type alpha Identifies the type of information in the XML message. CWCancel indicates the message contains a cancellation request.Required.

CancelOne Cancel element is required.To cancel the entire order ship to, the cancel_type must be O and the order_reason must specify a valid cancel reason code. Note: If there are multiple shipping addresses, the cancel request for each ship to must be sent separately.

CWSerenade 5.0

3/24/15 279


3 The company where the order is located. Maps to the CMP Company field in the Order Ship To table.Required.

order_id numeric

8 The CWSerenade order number you wish to cancel.Maps to the Order # field in the Order Ship To table.Required.

ship_to numeric

3 The order ship to you wish to cancel. Maps to the Ship to # field in the Order Ship To table.Required.

cancel_type alpha 1 Indicates the type of cancel to perform. Valid values:O = Order cancel.L = Line cancel.Required.

order_reason numeric

2 A code that represents the reason for canceling the order. Maps to the CNR Cancel reason code field in the Order Detail table.

LineThe Lines element, if provided, can include one or more Line elements.To cancel an order line, the cancel_type must be L and you must specify the line_number to cancel, the qty on the order line to cancel, and the reason.

line_number numeric

5 The order detail line sequence number to cancel.Maps to the Seq # field in the Order Detail table.

qty numeric

5 The quantity on the order line to cancel. Maps to the ODT Qty cancelled field in the Order Detail table.

reason numeric

2 A code that represents the reason for canceling the order line. Maps to the CNR Cancel reason code field in the Order Detail table.


CWSerenade 5.0

3/24/15 280

E-Commerce Cancel Request Message: Sample XML

A sample of the E-Commerce Cancel Request Message (CWCancel) in XML format is presented below.

<Message source="WEB" target="RDC" type="CWCancel"> <Cancel company_code="555" order_id="7602" ship_to="1" cancel_type="O" order_reason="1" />

<Lines> <Line line_number="1" qty="1" reason="1" />

<Line /> </Lines>

</Message>

3/24/15 Generic Customer API 281

Generic Customer API

Purpose: Use the generic customer API to add or change customers based on XML messages from an external system.

Note: You cannot use the Generic Customer API to delete a customer.

Relate customer integration: If you use the Relate customer integration, when you create or change a customer through the generic customer API, the new or changed customer information is also sent to Relate so that the name, address, email address, phone numbers, and contact permissions in the two systems are synchronized.

In this topic:

• Customer API Setup

• System Control Values used by the Customer API• Default Customer for Customer API• CWCustomer or CWMessageIn Web Service

• Determining Whether to Add or Change a Customer

• Adding a Customer using the Customer API

• Required Attributes for Add Requests• Duplicate Checking for Add Requests• Error Checking for Add Requests• Send Response for Add Request?• Fixing Errors and Reprocessing an Add Request

• Changing a Customer using the Customer API

• Required Attributes for Change Requests• Determining the Customer to Update• Using a Default Customer as a Guideline for Change Requests• Error Checking for Change Requests• Send Response for Change Request?• Fixing Errors and Reprocessing a Change Request

• Sample Customer API XML Messages

• Customer Message: Successful Add Request• Customer Message: Duplicate Add Request• Customer Message: Failure Add Request• Customer Message: Successful Change Request• Customer Message: Failure Change Request

CWSerenade 5.0

3/24/15 Generic Customer API 282

• Customer Message: Failure Delete Request

• Inbound Customer Message (CWCustomerIn)

• Outbound Customer Response Message (CWCustomerOut)

For more information: See Working with Customer API (WCAI) to review, work with, delete, or resubmit customer API requests that are in error.

CWSerenade 5.0

3/24/15 Customer API Setup 283

Customer API Setup

Before you can use the Generic Customer API, you must complete the necessary setup.

• System Control Values used by the Customer API

• Default Customer for Customer API

• Message Log used by the Customer API

• CWCustomer or CWMessageIn Web Service

CWSerenade 5.0


System Control Values used by the Customer API

System Control Value Description

Assign Alternate Customer # (I88)

Indicates whether the system should automatically assign an alternate customer number when creating a customer through the customer API or any other means. However, if there is a cst_interface_cust_nbr specified in the Add request, the system does not assign a different alternate customer number, but uses the specified number instead.

Default Customer for Customer API (I90)

Indicates the customer to use as a guideline to determine which fields can be cleared if they are not specified in a Change request.

Perform Address Standardization in Customer API (I99)

Indicates whether to use the QAS Address interface to standardize the customer’s address before processing an Add or Change request through the Customer API.

Validate Prefix (I27) If this system control value is selected, the system validates the prefix code included in the request against the Prefix table.

Require Customer Class in OE, WCAT, and WCST (H85)

If this system control value is selected, a customer class must be included in an Add request (or use the default defined in the Default Customer Class in Order Entry (D63) system control value) or the system will place the message in error.

Bypass Customer API Edit (L93)

If this system control value is selected, customer API transactions bypass validation when creating or changing a customer with an original source code of XSTORE.

The following system control values provide default values to apply to an Inbound Customer Message (CWCustomerIn).

Default Country for Customer Address (B17) system control value

If an Add request does not include a country, the system defaults the country code from this system control value.

Default Customer Class in Order Entry (D63)

If an Add request does not include a customer class, the system defaults the customer class from this system control value.

CWSerenade 5.0


Default Customer for Customer API

Use Work with Customers (WCST) to configure the customer defined as the Default Customer for Customer API (I90). The default customer determines which fields can be cleared if they are not specified in a Change request.

Default Mail Name (D10) • If an Add request does not include a mail name or it is invalid, the system defaults the mail name from this system control value.

• If an Add request does not include a mail code or mail name, the system defaults the mail code from this system control value.

• If a Change request does not include a mail name or it is invalid and a Default Customer for Customer API (I90) is not defined, the system defaults the mail name from this system control value.

Default Rent Name (D11) • If an Add request does not include a rent name or it is invalid, the system defaults the rent name from this system control value.

• If a Change request does not include a rent name or it is invalid and a Default Customer for Customer API (I90) is not defined, the system defaults the rent name from this system control value.

Default Associate Code (D09)

If an Add request does not include an associate flag, the system defaults the associate flag from this system control value.

Default Item History Tracking (B18)

If an Add request does not include an item history tracking setting, the system defaults the setting from this system control value; if this system control value is blank, the system sets item history tracking to blank.

Default Delivery Code for New Order Entry Customers (D13)

If an Add request does not include a delivery type, the system defaults the delivery code from:1. The Zip/City/State record for the postal code in the

cst_zip tag.2. The Default Delivery Code for New Order Entry

Customers (D13) system control value.

Default Opt In/Opt Out Flag (G97)

If an Add request does not include an email status, the system defaults the Opt in/out setting from this system control value.


CWSerenade 5.0


For each field that is not provided in the Inbound Customer Message (CWCustomerIn), the Customer API checks the corresponding field for the default customer.

• If that field contains any data in the default customer record, then the Customer API does not clear the information in that field for the customer being updated. Example: The default customer has data in the home phone number field. The Customer API receives a change request through the CWCustomerIn message. No home phone number is specified in the CWCustomerIn message, and the specified customer currently has a home phone number on record. The Customer API does not clear (blank out) the customer’s home phone number.

• If that field does not contain data in the default customer record, then the Customer API clears that field when updating the customer. Example: The default customer does not have data in the home phone number field. The Customer API receives a change request through the CWCustomerIn message. No home phone number is specified in the CWCustomerIn message, and the specified customer currently has a home phone number on record. The Customer API clears (blanks out) the customer’s home phone number.

Note: It does not matter what the data is in the corresponding field for the default customer record; the process simply checks to see whether there is any data.

Important: While defining a default customer is not required for the Generic Customer API, MICROS recommends you create it to avoid errors when processing a Change CWCustomerIn request.

For more information: See the Default Customer for Customer API (I90) for a discussion.

Message Log used by the Customer API

CWSerenade writes the Inbound Customer Message (CWCustomerIn) to the CWSerenade MQ Message Log if its Logging Level is set to INFO or lower.

When you are use Customer API integration with Xstore, the system writes the messages to the Customer API Log if its Logging Level is set to INFO or lower.

CWCustomer or CWMessageIn Web Service

You can use the CWCustomer web service or the CWMessageIn web service to process CWCustomerIn XML messages received from an external system and to send the CWCustomerOut XML message back to the external system. With either web service the type in the Inbound Customer Message (CWCustomerIn) must be CWCustomerIn.


• CWCustomer Web Service

CWSerenade 5.0


• CWMessageIn Web Service

CWCustomer Web Service

The CWCustomer web service allows an external system to post the CWCustomerIn XML message directly to CWSerenade and receive responses without the need of the CUSTOMR_IN job in Work with Integration Layer Processes (IJCT) or any queues.

If you are using the CWCustomerIn RESTful web service: You POST inbound CWCustomerIn messages to the web service’s URI, or endpoint, of the RESTful service. The individual URL for the CWCustomerIn RESTful service uses the following format: http://server:port/SerenadeSeam/sxrs/application/CWCustomerIn, where server:port identifies the application server where the RESTful service is located and CWCustomerIn is the name of the web service to call.

If you are using the CWCustomerIn SOAP-based web service: The endpoint specified in the CWCustomerIn.wsdl file is where you need to post messages in order for the CWCustomerIn web service to process them. The endpoint is typically set to http://server:port/CWDirectCPService/services/CWCustomerIn, where server:port identifies the application server where the wsdl is located and CWCustomerIn is the name of the web service to call.

The CWCustomerIn SOAP-based web service requires that inbound messages be embedded in SOAP envelope tags. A sample XML message embedded in a SOAP envelope is presented below.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dom="http://dom.w3c.org">

<soapenv:Header /> <soapenv:Body>

<dom:performAction type="xsd:string"> <![CDATA[

<Message source="CWIntegrate" target="CUST35" type="CWCustomerIn" resp_qmgr="QM_CWINTEGRATE_QA4">

<CustSoldTo cst_company="2" cst_send_response="Y" cst_duplicate="Y" cst_cust_nbr="14442" cst_salesman_nbr="" cst_interface_cust_nbr="" cst_language="ENG" cst_job_title="" cst_relate_id="" cst_prefix="" cst_fname="2Carnie" cst_minitial="" cst_lname="Loll" cst_suffix="" cst_company_name="" cst_street_addr="21 Ball Street" cst_addr_line_2="" cst_addr_line_3="" cst_apt="" cst_city="Westborough" cst_state="MA" cst_zip="01581" cst_country="USA" cst_day_phone="5085550100" cst_day_ext="1234" cst_eve_phone="5085550101" cst_eve_ext="5678" cst_fax_phone="5085550102" cst_fax_ext="9012" cst_mail_name="N" cst_rent_name="N" cst_seed_name="N" cst_rent_email="N" cst_original_source="" cst_current_source="" cst_hold_bypass_fraud="" cst_orig_mail_type="" cst_curr_mail_type="" cst_tax_exempt="" cst_exempt_certificate="" cst_exempt_expiry="" cst_associate="N" cst_cancel_bo="N" cst_commercial="N" cst_cust_type="" cst_discount_pct="" cst_entry_date="" cst_inactive="N" cst_bypass_reservation="N" cst_pop_window_1="" cst_pop_window_2="" cst_item_hist_tracking="2" cst_do_not_fax="N" cst_email_status="O1" cst_account_nbr="" cst_cust_class="" cst_cust_company="" cst_mail_code="" cst_call_code="" cst_currency="USD" cst_user_field_1="USER1" cst_user_field_2="USER2" cst_user_field_3="USER3" cst_user_field_4="USER4">

<CustEmails><CustEmail cst_email_seq="1" cst_email_address="[email protected]" cst_email_primary="Y" cst_email_status="O1" cst_display_name="1Tyne Kwan"/>

CWSerenade 5.0


<CustEmail cst_email_seq="2" cst_email_address="[email protected]" cst_email_primary="N" cst_email_status="O2" cst_display_name="2Tyne Kwan"/><CustEmail cst_email_seq="3" cst_email_address="[email protected]" cst_email_primary="N" cst_email_status="O3" cst_display_name="3Tyne Kwan"/>

</CustEmails></CustSoldTo>

</Message>

]]></dom:performAction>

</soapenv:Body></soapenv:Envelope>


You can use the CWMessageIn web service to route messages for the Generic Customer API if you prefer to use a single endpoint for all messages rather than using the separate endpoint specified for the CWCustomerIn message.

The CUSTOMR_IN integration layer process can remain inactive and a queue is not required if the target is CUSTCRT_IN in the XML message.


If you are using the CWMessageIn SOAP-based web service: The endpoint specified in the CWMessageIn.wsdl file is where you need to post messages in order for the CWMessageIn web service to process them. The endpoint is typically set to http://server:port/CWDirectCPService/services/CWMessageIn, where server:port identifies the application server where the wsdl is located and CWMessageIn is the name of the web service to call.

The CWMessageIn SOAP-based web service requires that inbound messages be embedded in SOAP envelope tags. A sample XML message embedded in a SOAP envelope is presented below.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dom="http://dom.w3c.org">

<soapenv:Header /> <soapenv:Body>

<dom:performAction type="xsd:string"> <![CDATA[


<CustSoldTo cst_company="2" cst_send_response="Y" cst_duplicate="Y" cst_cust_nbr="14442" cst_salesman_nbr="" cst_interface_cust_nbr="" cst_language="ENG" cst_job_title="" cst_relate_id="" cst_prefix="" cst_fname="Mary" cst_minitial="" cst_lname="Johnson" cst_suffix="" cst_company_name="" cst_street_addr="21 Walnut Street" cst_addr_line_2="" cst_addr_line_3="" cst_apt="" cst_city="Westborough" cst_state="MA" cst_zip="01581" cst_country="USA" cst_day_phone="5085550100"

CWSerenade 5.0


cst_day_ext="1234" cst_eve_phone="5085550101" cst_eve_ext="5678" cst_fax_phone="5085550102" cst_fax_ext="9012" cst_mail_name="N" cst_rent_name="N" cst_seed_name="N" cst_rent_email="N" cst_original_source="" cst_current_source="" cst_hold_bypass_fraud="" cst_orig_mail_type="" cst_curr_mail_type="" cst_tax_exempt="" cst_exempt_certificate="" cst_exempt_expiry="" cst_associate="N" cst_cancel_bo="N" cst_commercial="N" cst_cust_type="" cst_discount_pct="" cst_entry_date="" cst_inactive="N" cst_bypass_reservation="N" cst_pop_window_1="" cst_pop_window_2="" cst_item_hist_tracking="2" cst_do_not_fax="N" cst_email_status="O1" cst_account_nbr="" cst_cust_class="" cst_cust_company="" cst_mail_code="" cst_call_code="" cst_currency="USD" cst_user_field_1="USER1" cst_user_field_2="USER2" cst_user_field_3="USER3" cst_user_field_4="USER4">

<CustEmails><CustEmail cst_email_seq="1" cst_email_address="[email protected]" cst_email_primary="Y" cst_email_status="O1" cst_display_name="1Tyne Kwan"/><CustEmail cst_email_seq="2" cst_email_address="[email protected]" cst_email_primary="N" cst_email_status="O2" cst_display_name="2Tyne Kwan"/><CustEmail cst_email_seq="3" cst_email_address="[email protected]" cst_email_primary="N" cst_email_status="O3" cst_display_name="3Tyne Kwan"/>

</CustEmails></CustSoldTo>

</Message>

]]></dom:performAction>

</soapenv:Body></soapenv:Envelope>

CWSerenade 5.0

3/24/15 Determining Whether to Add or Change a Customer 290

Determining Whether to Add or Change a Customer

The system uses the following logic to determine whether to add a new customer or change an existing one when it receives an Inbound Customer Message (CWCustomerIn).

Note: The cst_action_type attribute indicates whether the Inbound Customer Message (CWCustomerIn) is an Add or Change request; however, this attribute is informational only and CWSerenade uses the customer information in the message to determine whether to create a new customer or change an existing one.

The system considers an Inbound Customer Message (CWCustomerIn) an Add request if:

• the message does not include a cst_cust_nbr (sold to customer number), cst_interface_cust_nbr (alternate customer number), or cst_relate_id (Relate ID).

• the message includes a cst_relate_id (Relate ID) but no cst_cust_nbr (sold to customer number) and the cst_relate_id does not match an existing customer.

• the message includes a cst_interface_cust_nbr (alternate customer number) but no cst_cust_nbr (sold to customer number) or cst_relate_id (Relate ID) and the cst_interface_cust_nbr does not match an existing customer based on the records in the Customer Sold To Xref table.

See Adding a Customer using the Customer API for processing details. Note: After determining an Inbound Customer Message (CWCustomerIn) is an Add request, the system determines whether the customer information in the Add request matches an existing customer, and based on the cst_duplicate flag in the Add request, may update the existing customer; see Duplicate Checking for Add Requests.

If the Inbound Customer Message (CWCustomerIn) does not meet the requirements for an Add request, the system considers the message a Change request; see Changing a Customer using the Customer API for processing details.

CWSerenade 5.0

3/24/15 Adding a Customer using the Customer API 291

Adding a Customer using the Customer API

When CWSerenade determines the Inbound Customer Message (CWCustomerIn) is an Add request (see Determining Whether to Add or Change a Customer), the system creates the customer based on the information provided in the message.

• Required Attributes for Add Requests

• Duplicate Checking for Add Requests

• Duplicate Check S: If Single Match Found, Update Customer• Duplicate Check A: If Multiple Matches Found, Update Best Match Customer• Duplicate Check Y: If Any Match Found, Do Not Update Customer• Duplicate Check N: Do Not Perform Duplicate Checking

• Error Checking for Add Requests

• Send Response for Add Request?

• Fixing Errors and Reprocessing an Add Request

Bypass validation? If the Bypass Customer API Edit (L93) system control value is selected, customer API transactions bypass validation when creating or changing a customer with an original source code of XSTORE. For Add requests, the system bypasses all edits except Duplicate Checking for Add Requests.

Required Attributes for Add Requests

To create a customer, at minimum you must define the following attributes in the Inbound Customer Message (CWCustomerIn):

• type = CWCustomerIn

• cst_ company

• cst_lname or cst_company_name

• cst_street_addr

• cst_city

• cst_state if the cst_country requires a state; otherwise, optional

• cst_zip if the cst_country requires a postal code; otherwise, optional

• cst_country unless a default is defined in the Default Country for Customer Address (B17) system control value

• cst_cust_class if the Require Customer Class in OE, WCAT, WCST (H85) system control value is selected; otherwise, optional

CWSerenade 5.0


• cst_email_status unless a default is defined in the Default Opt In/Opt Out Flag (G97) system control value

QAS address interface: The system first submits a customer address to QAS for address standardization if the Perform Address Standardization in Customer API (I99) system control value is selected and you are using the QAS Address Interface. The address standardization is applied before any duplicate checking or other edits, and takes place only if there is a single matching address (the QAS Address Response Match Level is Verified). See Using the QAS Address Interface for an overview and required setup.

Duplicate Checking for Add Requests

Before creating a customer, the system determines whether the customer information in an Add request matches an existing customer.

Types of duplicate checking: The cst_duplicate flag defines how the system checks for duplicates:

• Duplicate Check S: If Single Match Found, Update Customer

• Duplicate Check A: If Multiple Matches Found, Update Best Match Customer

• Duplicate Check Y: If Any Match Found, Do Not Update Customer

• Duplicate Check N: Do Not Perform Duplicate Checking

CWSerenade 5.0


Duplicate Check S: If Single Match Found, Update Customer

The system performs the following logic when the cst_duplicate flag is set to S.

1. Check for duplicates: The system determines whether the customer information specified in the Add request matches an existing customer using:

• Match code: The system checks for duplicates using the match code. If there are no existing customers with the same match code as the customer information in the Add request, the system does not consider the Add request a duplicate and proceeds to check the message for errors (see Error Checking for Add Requests); otherwise,

• Phone interface values: If there are existing customers with the same match code as the customer information in the Add request, the system uses the Phone Interface Values (F70) as a guideline to check for duplicates. For example, if these values indicate that the customer’s first name does not need to be an exact match, the system does not consider this type of customer information to constitute a match, and continues to the next step. Note: When matching on street address or address line 2, the system does not include the roadway descriptive in the match if it is the last word in the address line; see Exact Match Required on Street Address for Phone Interface and Exact Match Required on Address Line 2 for Phone Interface for a list of road descriptives the system excludes.

2. Single match found? If a single duplicate match is found, the system updates the existing customer with the information in the Inbound Customer Message (CWCustomerIn). See Changing a Customer using the Customer API.

If the cst_send_response flag in the request is set to:

• Y: the system generates the Outbound Customer Response Message (CWCustomerOut) with a cst_action_result of Success. The updated customer information is provided in the CustSoldTo element. See Sample Customer API XML Messages.

• N: the system does not send the CWCustomerOut message.

CWSerenade 5.0


Duplicate Check S Example: The Inbound Customer Message (CWCustomerIn) contains the following customer information:

Julie Robinson 100 Walnut StreetWestborough, MA 01581Email jrobinsexample.com508-555-0100

CWSerenade finds a single customer with the same match code and an exact match based on the Phone Interface Values (F70).

Customer 13962:

Juliette Robinson100 Walnut StreetWestborough, MA 01581Email [email protected]

Because a single match is found and the cst_duplicate flag is set to S, the system validates the information in the Inbound Customer Message (CWCustomerIn) and updates customer 13962 if the validation is successful. If the cst_send_response flag in the request is set to Y, the system sends the updated customer information in the Outbound Customer Response Message (CWCustomerOut).

3. Multiple matches found? If the system finds multiple duplicate existing customers based on the match code and Phone Interface Values (F70), the system does not create or update any customers.


• Y: the system generates the Outbound Customer Response Message (CWCustomerOut) with a cst_action_result of Duplicate. The first duplicate customer record that the system found is provided in the CustSoldTo element, and any additional duplicate customers are provided in a Duplicate element. See Sample Customer API XML Messages.


CWSerenade 5.0


Duplicate Check S Flowchart:

Duplicate Check A: If Multiple Matches Found, Update Best Match Customer

The system performs the following logic when the cst_duplicate flag is set to A.



• Phone interface values: If there are existing customers with the same match code as the customer information in the Add request, the system uses the Phone Interface Values (F70) as a guideline to check for duplicates. For example, if these values indicate that the customer’s first name does not need to be an exact match, the system does not consider this type of customer information to constitute a match, and continues to the next step.

CWSerenade 5.0


Duplicate Check A Example: The Inbound Customer Message (CWCustomerIn) contains the following customer information:

Robert Dryer100 Walnut StreetWestborough, MA 01581Email [email protected]

CWSerenade finds multiple customers with the same match code and exact match based on the Phone Interface Values (F70). The first customer match (the customer with the highest customer number) is customer 14551:

Bob Dryer100 Walnut StreetWestborough, MA 01581Email [email protected]

Because customer 14551 has been identified as the best match and the cst_duplicate flag is set to A, the system validates the information in the Inbound Customer Message (CWCustomerIn) and updates customer 14551 if the validation is successful. If the cst_send_response flag in the request is set to Y, the system sends the updated customer information in the Outbound Customer Response Message (CWCustomerOut).

2. Single match found? If a single duplicate match is found, the system updates the existing customer with the information in the Inbound Customer Message (CWCustomerIn). See Changing a Customer using the Customer API.




3. Multiple matches found? If the system finds multiple duplicate existing customers based on the match code and Phone Interface Values (F70), the system updates the first customer match (this is the customer with the highest customer number) with the information in the Inbound Customer Message (CWCustomerIn). See Changing a Customer using the Customer API.




CWSerenade 5.0


Duplicate Check A Flowchart:

Duplicate Check Y: If Any Match Found, Do Not Update Customer

The system performs the following logic when the cst_duplicate flag is set to Y.



• Phone interface values: If there are existing customers with the same match code as the customer information in the Add request, the system uses the Phone Interface Values (F70) as a guideline to check for duplicates. For example, if these values indicate that the customer’s first name does not need to be an exact match, the system does not consider this type of customer information to constitute a match, and continues to the next step.

CWSerenade 5.0


Duplicate Check Y Flowchart:

Duplicate Check N: Do Not Perform Duplicate Checking

If the cst_duplicate flag is N or any other value, the system does not perform any duplicate checking based on name and address.

Error Checking for Add Requests

After completing any duplicate checking, or if the cst_duplicate setting in the Add request is N, the system determines if the Add request contains any errors:

• No errors: The system creates the customer. If the cst_send_response flag in the request is Y, the system generates the Outbound Customer Response Message (CWCustomerOut) with a cst_action_result of Success. The response indicates the customer name, address, and customer number created. See Sample Customer API XML Messages.

2. Duplicates found? If the system finds one or more duplicate existing customers based on the match code and Phone Interface Values (F70), the system does not create or update any customers.


• Y: the system generates the Outbound Customer Response Message (CWCustomerOut) with a cst_action_result of Duplicate. The first duplicate customer record (this is the duplicate with the highest customer number) that the system found is provided in the CustSoldTo element, and any additional duplicate customers are provided in a Duplicate element. See Sample Customer API XML Messages.


CWSerenade 5.0


• Errors: If any of the required values for a customer are missing or invalid, the system places the message in error in Working with Customer API (WCAI). If the cst_send_response flag in the request is Y, the system generates the Outbound Customer Response Message (CWCustomerOut) with a cst_action_result of Failure. See Sample Customer API XML Messages.

For more information: See the Inbound Customer Message (CWCustomerIn) for complete information on field edits and possible errors.

Error Checking for Add Requests:

Send Response for Add Request?

If the cst_send_response flag is Y, the system generates an Outbound Customer Response Message (CWCustomerOut) such as the following:

• Customer Message: Successful Add Request if the add request was successful

• Customer Message: Duplicate Add Request if the add request failed duplicate checking

• Customer Message: Failure Add Request if the add request failed

Fixing Errors and Reprocessing an Add Request

You can use the Change Customer API Screen in Working with Customer API (WCAI) to identify and correct errors related to an Add request. When you advance to the Change Customer API screen and select OK, the system indicates any errors in the Add request. You can then correct the error and reprocess the request to create the customer, or delete the request if you do not want to create the new customer.

CWSerenade 5.0

3/24/15 Changing a Customer using the Customer API 300

Changing a Customer using the Customer API

When CWSerenade determines the Inbound Customer Message (CWCustomerIn) is a Change request (see Determining Whether to Add or Change a Customer), the system updates the customer based on the information provided in the message.

• Required Attributes for Change Requests

• Determining the Customer to Update

• Using a Default Customer as a Guideline for Change Requests

• Error Checking for Change Requests

• Send Response for Change Request?

• Fixing Errors and Reprocessing a Change Request

Bypass validation? If the Bypass Customer API Edit (L93) system control value is selected, customer API transactions bypass validation when creating or changing a customer with an original source code of XSTORE. For Change requests, the system bypasses all edits except Customer Does not Exist.

Required Attributes for Change Requests

To change a customer, at minimum you must define the following attributes in the Inbound Customer Message (CWCustomerIn):

• type = CWCustomerIn

• cst_cust_nbr, cst_relate_id, OR cst_interface_cust_nbr; see Determining the Customer to Update

• If a Default Customer for Customer API (I90) is defined and you do not define a value for an attribute, the system uses this customer to determine whether to update the field for the customer to blank or to retain the customer’s existing value. See Using a Default Customer as a Guideline for Change Requests.

If a Default Customer for Customer API (I90) is not defined, you must also define the following attributes:• cst_ company• cst_lname or cst_company_name• cst_street_addr• cst_city• cst_state if the cst_country requires a state; otherwise, optional• cst_zip if the cst_country requires a postal code; otherwise, optional

CWSerenade 5.0


• cst_country unless a default is defined in the Default Country for Customer Address (B17) system control value

• cst_cust_class if the Require Customer Class in OE, WCAT, and WCST (H85) system control value is selected; otherwise, optional

• cst_email_status unless a default is defined in the Default Opt In/Opt Out Flag (G97) system control value

QAS address interface: The system first submits a customer address to QAS for address standardization if the Perform Address Standardization in Customer API (I99) system control value is selected and you are using the QAS Address Interface. The address standardization is applied before any duplicate checking or other edits, and takes place only if there is a single matching address (the QAS Address Response Match Level is Verified).

Determining the Customer to Update

The system uses the cst_cust_nbr, cst_interface_cust_nbr, and cst_relate_id included in the Inbound Customer Message (CWCustomerIn) to determine the customer to update.

If the message includes a customer number only: If the message includes a cst_cust_nbr but no cst_interface_cust_nbr or cst_relate_id:

• Match: If the cst_cust_nbr matches an existing customer, CWSerenade selects this customer for update.

• No match: If the cst_cust_nbr does not match an existing customer, CWSerenade places the request in E (error) status. You cannot correct this type of error through Working with Customer API (WCAI); you must delete the message in error and either resend the message or manually update the customer in Work with Customers (WCST).

If the message includes a customer number and alternate customer number: If the message includes a cst_cust_nbr and cst_interface_cust_nbr but no cst_relate_id:

• Match: If the cst_cust_nbr matches an existing customer, CWSerenade selects this customer for update and adds the cst_interface_cust_nbr to the Customer Sold To Xref table if it does not already exist.

• No match: If the cst_cust_nbr does not match an existing customer, CWSerenade places the request in E (error) status. You cannot correct this type of error through Working with Customer API (WCAI); you must delete the message in error and either resend the message or manually update the customer in Work with Customers (WCST).

CWSerenade 5.0


If the message includes a customer number and Relate ID: If the message includes a cst_cust_nbr and cst_relate_id, the system uses the following logic.

Does matching CWSerenade customer have Relate ID?

Do other CWSerenade customers have Relate ID?

Results:

If the cst_cust_nbr matches an existing customer, but the customer is not associated with the specified cst_relate_id...

and other customers are not associated with the specified cst_relate_id...

CWSerenade selects this customer for update and updates the Relate ID in the Customer Sold To table with the cst_relate_id included in the message. If the message also contains a cst_interface_cust_nbr, the system adds the cst_interface_cust_nbr to the Customer Sold To Xref table if it does not already exist.

and one or more other customers are associated with the specified cst_relate_id...

CWSerenade places the message in E Error status for the reason Relate ID matched multiple customers. You cannot correct this type of error through Working with Customer API (WCAI); you must delete the message in error and either resend the message or manually update the customer in Work with Customers (WCST).

CWSerenade 5.0


If the cst_cust_nbr matches an existing customer, and the customer is associated with the specified cst_relate_id...

regardless of whether other customers are associated with the specified cst_relate_id...

CWSerenade selects this customer for update and retains the Relate ID in the Customer Sold To table since it matches the cst_relate_id included in the message. If the message also contains a cst_interface_cust_nbr, the system adds the cst_interface_cust_nbr to the Customer Sold To Xref table if it does not already exist.

If the cst_cust_nbr matches an existing customer, but the customer’s Relate ID does not match the specified cst_relate_id...

and other customers are not associated with the specified cst_relate_id...

CWSerenade selects this customer for update and updates the Relate ID in the Customer Sold To table with the cst_relate_id included in the message. If the message also contains a cst_interface_cust_nbr, the system adds the cst_interface_cust_nbr to the Customer Sold To Xref table if it does not already exist.

and other customers are associated with the specified cst_relate_id...

CWSerenade places the message in E Error status for the reason Relate ID matched multiple customers. You cannot correct this type of error through Working with Customer API (WCAI); you must delete the message in error and either resend the message or manually update the customer in Work with Customers (WCST).



Results:

CWSerenade 5.0


If the message includes a Relate ID and no customer number: If the message includes a cst_relate_id but no cst_cust_nbr:

• No match: If the cst_relate_id does not match an existing customer, CWSerenade considers the message an Add request; see Adding a Customer using the Customer API.

• Single match: If the cst_relate_id matches a single customer, CWSerenade selects this customer for update. If the message also contains a cst_interface_cust_nbr, the system adds the cst_interface_cust_nbr to the Customer Sold To Xref table if it does not already exist.

• Multiple match: If the cst_relate_id matches more than one customer, CWSerenade places the request in E Error status for the reason Relate ID matched multiple customers. You cannot correct this type of error through Working with Customer API (WCAI); you must delete the message in error and either resend the message or manually update the customer in Work with Customers (WCST).

If the message includes an alternate customer number and no customer number or Relate ID: If the message includes a cst_interface_cust_nbr but no cst_cust_nbr or cst_relate_id:

• No match: If the cst_interface_cust_nbr does not match an existing customer based on the records in the Customer Sold To Xref table, CWSerenade considers the message an Add request; see Adding a Customer using the Customer API.

• Single match: If the cst_interface_cust_nbr matches a single customer based on the records in the Customer Sold To Xref table, CWSerenade selects this customer for update.

• Multiple match: If the cst_interface_cust_nbr matches multiple customers based on the records in the Customer Sold To Xref table, CWSerenade places the request in E

If the cst_cust_nbr does not match an existing customer...

regardless of whether other customers are associated with the specified cst_relate_id...

CWSerenade places the request in E (error) status. You cannot correct this type of error through Working with Customer API (WCAI); you must delete the message in error and either resend the message or manually update the customer in Work with Customers (WCST).



Results:

CWSerenade 5.0


Error status for the reason Alternate customer # matched multiple customers. You cannot correct this type of error through Working with Customer API (WCAI); you must delete the message in error and either resend the message or manually update the customer in Work with Customers (WCST).

Note: Regardless of the setting of the Display Alternate Customer Cross Reference Window (I84) system control value, the system attempts to match the cst_interface_cust_nbr to any of the alternate customer numbers stored in the Customer Sold To Xref table and does not try to match the cst_interface_cust_nbr to the alternate customer number stored in the Customer Sold To table.

For more information: See Working with Alternate Customer Number Cross-References for more information on the Customer Sold To Xref table.

Using a Default Customer as a Guideline for Change Requests

The system uses the customer defined in the Default Customer for Customer API (I90) system control value to identify which fields can be cleared if they are not specified in a Change request.

For each field that is not provided in the Inbound Customer Message (CWCustomerIn), the Customer API checks the corresponding field for the default customer.

• If that field contains any data in the default customer record, then the Customer API does not clear the information in that field for the customer being updated.

• If that field does not contain data in the default customer record, then the Customer API clears that field when updating the customer.

Note: It does not matter what the data is in the corresponding field for the default customer record; the process simply checks to see whether there is any data.

Default Customer Examples:

If the Default Customer has:

and the Change Request:

The system:

The first, middle and last name populated

does not include a first, middle or last name

Retains the first, middle, and last name of the customer being updated in the Change request

includes a last name but no first or middle name

Updates the last name and retains the first and middle name of the customer being updated in the Change request

CWSerenade 5.0


For more information: See the Default Customer for Customer API (I90) for a discussion.

Error Checking for Change Requests

After Determining the Customer to Update, the system determines if the Change request contains any errors:

• No errors: The system updates the customer. If the cst_send_response flag in the request is Y, the system generates the Outbound Customer Response Message (CWCustomerOut) with a cst_action_result of Success. The response indicates the customer name, address, and customer number updated. See Sample Customer API XML Messages.

• Errors: If any of the required values for a customer are missing or invalid, the system places the message in error in Working with Customer API (WCAI). If the cst_send_response flag in the request is Y, the system generates the Outbound Customer Response Message (CWCustomerOut) with a cst_action_result of Failure. See Sample Customer API XML Messages.

Note: A Change request does not normally go into error status because of missing information, because the use of the Default Customer for Customer API (I90) usually prevents essential information from being cleared from an existing customer record.

For more information: See the Inbound Customer Message (CWCustomerIn) for complete information on field edits and possible errors.

The last name populated, but the first and middle name are blank

does not include a first, middle or last name

Retains the last name and clears the first and middle name of the customer being updated in the Change request

includes a last name but no first or middle name

Updates the last name and clears the first and middle name of the customer being updated in the Change request

If the Default Customer has:

and the Change Request:

The system:

CWSerenade 5.0


Error Checking for Change Requests:

Send Response for Change Request?

If the cst_send_response flag is Y, the system generates an Outbound Customer Response Message (CWCustomerOut) such as the following:

• Customer Message: Successful Change Request if the change request was successful

• Customer Message: Failure Change Request if the change request failed

Fixing Errors and Reprocessing a Change Request

You can use the Change Customer API Screen in Working with Customer API (WCAI) to identify and correct errors related to a Change request. When you advance to the Change Customer API screen and select OK, the system indicates any errors in the Change request. You can then correct the error and reprocess the request to update the customer, or delete the request if you do not want to process the update.

CWSerenade 5.0

3/24/15 Sample Customer API XML Messages 308

Sample Customer API XML Messages

• Customer Message: Successful Add Request

• Customer Message: Duplicate Add Request

• Customer Message: Failure Add Request

• Customer Message: Successful Change Request

• Customer Message: Failure Change Request

• Customer Message: Failure Delete Request

Customer Message: Successful Add Request

A sample CWCustomerIn Add request that successfully creates a customer is presented below. See Adding a Customer using the Customer API for more information.

CWCustomerIn: See Inbound Customer Message (CWCustomerIn) for message details.


<CustSoldTo cst_company="007" cst_action_type="K" cst_send_response="Y" cst_duplicate="N" cst_cust_nbr="" cst_salesman_nbr="" cst_interface_cust_nbr="" cst_language="ENG" cst_job_title="" cst_relate_id="" cst_prefix="" cst_fname="Helen" cst_minitial="" cst_lname="Smith" cst_suffix="" cst_company_name="" cst_street_addr="10 Walnut Street" cst_addr_line_2="Line 2" cst_addr_line_3="" cst_addr_line_4="" cst_apt="" cst_city="Westborough" cst_state="MA" cst_zip="01581" cst_country="USA" cst_day_phone="(508)555-0100" cst_day_ext="1234" cst_eve_phone="(508)555-0102" cst_eve_ext="5678" cst_fax_phone="5085550103" cst_fax_ext="9012" cst_mail_name="" cst_rent_name="" cst_seed_name="" cst_rent_email="" cst_original_source="" cst_current_source="" cst_hold_bypass_fraud="" cst_orig_mail_type="S" cst_curr_mail_type="B" cst_tax_exempt="" cst_exempt_certificate="" cst_exempt_expiry="" cst_associate="K" cst_cancel_bo="K" cst_commercial="N" cst_cust_type="" cst_discount_pct="" cst_entry_date="10112009" cst_inactive="N" cst_bypass_reservation="N" cst_pop_window_1="POP1" cst_pop_window_2="POP2" cst_pop_window_3="" cst_pop_window_4="" cst_price_column="" cst_item_hist_tracking="2" cst_vat_nbr="" cst_do_not_fax="N" cst_deliverable="" cst_delivery_type="" cst_email_status="O1" cst_account_nbr="" cst_cust_class="" cst_cust_company="" cst_mail_code="" cst_call_code="" cst_change_user="" cst_create_user="" cst_currency="USD" cust_po_box="" cst_warehouse="2" cst_user_field_1="USER1" cst_user_field_2="USER2" cst_user_field_3="USER3" cst_user_field_4="USER4" cst_reserve_warehouse="11" cst_van_route="" cst_van_route_seq="" cst_price_group="">

<CustEmails> <CustEmail cst_email_seq="1" cst_email_address="[email protected]" cst_email_primary="Y" cst_email_status="O1" cst_email_format="" cst_display_name="1Tyne Kwan" /> <CustEmail cst_email_seq="2" cst_email_address="[email protected]" cst_email_primary="N" cst_email_status="O2" cst_email_format="" cst_display_name="2Tyne Kwan" />

</CustEmails> <CustUserDefinedFields>

<CustUserDefinedField cst_udf_seq="" cst_udf_text="" cst_udf_nbr="" cst_udf_date="" />

CWSerenade 5.0


</CustUserDefinedFields> <CustProfiles>

<CustProfile cst_profile_code="" cst_profile_value="" /> </CustProfiles>

</CustSoldTo> </Message>

CWCustomerOut: See Outbound Customer Response Message (CWCustomerOut) for message details.

<Message source="CWSerenade" target="CUST35" type="CWCustomerOut" date_created="2011-10-20" time_created="09:47:42">

<CustSoldTo cst_company="7" cst_cust_nbr="139" cst_action_type="A" cst_action_result="Success" cst_fname="HELEN" cst_lname="SMITH" cst_street_name="10 SULLIVAN STREET" cst_addr_line_2="LINE 2" cst_city="WESTBOROUGH" cst_state="MA" cst_zip="01581" cst_country="USA" cst_match_code="HELSMI10S015" cst_ghost="N" />

</Message>

Customer Message: Duplicate Add Request

A sample CWCustomerIn Add request where the system finds a duplicate customer is presented below. The cst_duplicate tag defines how the system performs duplicate checking; see Duplicate Checking for Add Requests for more information.



<CustSoldTo cst_company="007" cst_action_type="K" cst_send_response="Y" cst_duplicate="S" cst_cust_nbr="" cst_salesman_nbr="" cst_interface_cust_nbr="" cst_language="ENG" cst_job_title="" cst_relate_id="" cst_prefix="" cst_fname="Hellen" cst_minitial="" cst_lname="Smith" cst_suffix="" cst_company_name="" cst_street_addr="10 Walnut St" cst_addr_line_2="" cst_addr_line_3="" cst_addr_line_4="" cst_apt="" cst_city="Westborough" cst_state="MA" cst_zip="01581" cst_country="USA" cst_day_phone="(508)555-0100" cst_day_ext="1234" cst_eve_phone="(508)555-0102" cst_eve_ext="5678" cst_fax_phone="5085550103" cst_fax_ext="9012" cst_mail_name="" cst_rent_name="" cst_seed_name="" cst_rent_email="" cst_original_source="" cst_current_source="" cst_hold_bypass_fraud="" cst_orig_mail_type="S" cst_curr_mail_type="B" cst_tax_exempt="" cst_exempt_certificate="" cst_exempt_expiry="" cst_associate="" cst_cancel_bo="K" cst_commercial="N" cst_cust_type="" cst_discount_pct="" cst_entry_date="10112009" cst_inactive="N" cst_bypass_reservation="N" cst_pop_window_1="POP1" cst_pop_window_2="POP2" cst_pop_window_3="" cst_pop_window_4="" cst_price_column="" cst_item_hist_tracking="2" cst_vat_nbr="" cst_do_not_fax="N" cst_deliverable="" cst_delivery_type="" cst_email_status="O1" cst_account_nbr="" cst_cust_class="" cst_cust_company="" cst_mail_code="" cst_call_code="" cst_change_user="" cst_create_user="" cst_currency="USD" cust_po_box="" cst_warehouse="2" cst_user_field_1="USER1" cst_user_field_2="USER2" cst_user_field_3="USER3" cst_user_field_4="USER4" cst_reserve_warehouse="11" cst_van_route="" cst_van_route_seq="" cst_price_group="">

<CustEmails> <CustEmail cst_email_seq="1" cst_email_address="[email protected]" cst_email_primary="Y" cst_email_status="O1" cst_email_format="" cst_display_name="1HSmith" /> <CustEmail cst_email_seq="2" cst_email_address="[email protected]" cst_email_primary="N" cst_email_status="O2" cst_email_format="" cst_display_name="2HSmith" />

</CustEmails>

CWSerenade 5.0


<CustUserDefinedFields> <CustUserDefinedField cst_udf_seq="" cst_udf_text="" cst_udf_nbr="" cst_udf_date="" />






<CustSoldTo cst_company="7" cst_cust_nbr="141" cst_action_type="DUP" cst_action_result="Duplicate" cst_fname="HELLEN" cst_lname="SMITH" cst_street_name="10 SULLIVAN ST" cst_city="WESTBOROUGH" cst_state="MA" cst_zip="01581" cst_country="USA" cst_match_code="HELSMI10S015" cst_ghost="N">

<Duplicates> <Duplicate dup_cust_nbr="140" dup_fname="HELEN" dup_lname="SMITH" dup_street_name="10 SULLIVAN ST" dup_city="WESTBOROUGH" dup_state="MA" dup_zip="01581" dup_country="USA" dup_match_code="HELSMI10S015" dup_ghost="N" />

</Duplicates> </CustSoldTo>

</Message>

Customer Message: Failure Add Request

A sample CWCustomerIn Add request that is placed in error in Working with Customer API (WCAI) is presented below. See Adding a Customer using the Customer API for more information.



<CustSoldTo cst_company="007" cst_action_type="" cst_send_response="Y" cst_duplicate="S" cst_cust_nbr="" cst_salesman_nbr="" cst_interface_cust_nbr="" cst_language="ENG" cst_job_title="" cst_relate_id="" cst_prefix="" cst_fname="Helen" cst_minitial="R" cst_lname="Smith" cst_suffix="" cst_company_name="" cst_street_addr="10 Rose Street" cst_addr_line_2="" cst_addr_line_3="" cst_addr_line_4="" cst_apt="" cst_city="Westboro" cst_state="MASS" cst_zip="01581" cst_country="US" cst_day_phone="(508)555-0100" cst_day_ext="1234" cst_eve_phone="(508)555-0101" cst_eve_ext="5678" cst_fax_phone="5085550102" cst_fax_ext="9012" cst_mail_name="" cst_rent_name="" cst_seed_name="" cst_rent_email="" cst_original_source="" cst_current_source="" cst_hold_bypass_fraud="" cst_orig_mail_type="S" cst_curr_mail_type="B" cst_tax_exempt="" cst_exempt_certificate="" cst_exempt_expiry="" cst_associate="" cst_cancel_bo="K" cst_commercial="N" cst_cust_type="" cst_discount_pct="" cst_entry_date="" cst_inactive="N" cst_bypass_reservation="N" cst_pop_window_1="POP1" cst_pop_window_2="POP2" cst_pop_window_3="" cst_pop_window_4="" cst_price_column="" cst_item_hist_tracking="2" cst_vat_nbr="" cst_do_not_fax="N" cst_deliverable="" cst_delivery_type="" cst_email_status="O1" cst_account_nbr="" cst_cust_class="" cst_cust_company="" cst_mail_code="" cst_call_code="" cst_change_user="" cst_create_user="" cst_currency="USD" cust_po_box="" cst_warehouse="2" cst_user_field_1="USER1" cst_user_field_2="USER2" cst_user_field_3="USER3"

CWSerenade 5.0


cst_user_field_4="USER4" cst_reserve_warehouse="11" cst_van_route="" cst_van_route_seq="" cst_price_group="">

<CustEmails> <CustEmail cst_email_seq="1" cst_email_address="[email protected]" cst_email_primary="Y" cst_email_status="O1" cst_email_format="" cst_display_name="1H Smith" /> <CustEmail cst_email_seq="2" cst_email_address="[email protected]" cst_email_primary="N" cst_email_status="O2" cst_email_format="" cst_display_name="2H Smith" />


<CustUserDefinedField cst_udf_seq="1" cst_udf_text="date" cst_udf_nbr="101112" cst_udf_date="101112" />






<CustSoldTo cst_company="7" cst_action_type="A" cst_action_result="Failure" /> </Message>

Customer Message: Successful Change Request

A sample CWCustomerIn Change request that successfully updates a customer is presented below. See Changing a Customer using the Customer API for more information.



<CustSoldTo cst_company="007" cst_action_type="" cst_send_response="Y" cst_duplicate="S" cst_cust_nbr="111" cst_salesman_nbr="" cst_interface_cust_nbr="" cst_language="ENG" cst_job_title="" cst_relate_id="" cst_prefix="" cst_fname="James" cst_minitial="R" cst_lname="Jones" cst_suffix="" cst_company_name="" cst_street_addr="10 River St" cst_addr_line_2="" cst_addr_line_3="" cst_addr_line_4="" cst_apt="" cst_city="Templeton" cst_state="MA" cst_zip="01581" cst_country="USA" cst_day_phone="(508)555-0100" cst_day_ext="1234" cst_eve_phone="(508)555-0101" cst_eve_ext="5678" cst_fax_phone="5085550102" cst_fax_ext="9012" cst_mail_name="" cst_rent_name="" cst_seed_name="" cst_rent_email="" cst_original_source="" cst_current_source="" cst_hold_bypass_fraud="" cst_orig_mail_type="S" cst_curr_mail_type="B" cst_tax_exempt="" cst_exempt_certificate="" cst_exempt_expiry="" cst_associate="" cst_cancel_bo="K" cst_commercial="N" cst_cust_type="" cst_discount_pct="" cst_entry_date="" cst_inactive="N" cst_bypass_reservation="N" cst_pop_window_1="POP1" cst_pop_window_2="POP2" cst_pop_window_3="" cst_pop_window_4="" cst_price_column="" cst_item_hist_tracking="2" cst_vat_nbr="" cst_do_not_fax="N" cst_deliverable="" cst_delivery_type="" cst_email_status="O1" cst_account_nbr="" cst_cust_class="" cst_cust_company="" cst_mail_code="" cst_call_code="" cst_change_user="" cst_create_user="" cst_currency="USD" cust_po_box="" cst_warehouse="2" cst_user_field_1="USER1"

CWSerenade 5.0


cst_user_field_2="USER2" cst_user_field_3="USER3" cst_user_field_4="USER4" cst_reserve_warehouse="11" cst_van_route="" cst_van_route_seq="" cst_price_group="">

<CustEmails> <CustEmail cst_email_seq="1" cst_email_address="[email protected]" cst_email_primary="Y" cst_email_status="O1" cst_email_format="" cst_display_name="1J Jones" /> <CustEmail cst_email_seq="2" cst_email_address="[email protected]" cst_email_primary="N" cst_email_status="O2" cst_email_format="" cst_display_name="2J Jones" />








<CustSoldTo cst_company="7" cst_cust_nbr="111" cst_action_type="C" cst_action_result="Success" cst_prefix="MR." cst_fname="JAMES" cst_minitial="R" cst_lname="JONES cst_street_name="10 RIVER ST" cst_city="TEMPLETON" cst_state="MA" cst_zip="01581" cst_country="USA" cst_match_code="JAMCRO10D015" cst_ghost="N" />

</Message>

Customer Message: Failure Change Request

A sample CWCustomerIn Change request that is placed in error in Working with Customer API (WCAI) is presented below. See Changing a Customer using the Customer API for more information.



<CustSoldTo cst_company="007" cst_action_type="" cst_send_response="Y" cst_duplicate="S" cst_cust_nbr="111" cst_salesman_nbr="" cst_interface_cust_nbr="" cst_language="ENG" cst_job_title="" cst_relate_id="" cst_prefix="" cst_fname="James" cst_minitial="R" cst_lname="Jones" cst_suffix="" cst_company_name="" cst_street_addr="10 River St" cst_addr_line_2="" cst_addr_line_3="" cst_addr_line_4="" cst_apt="" cst_city="Templeton" cst_state="MA" cst_zip="01581" cst_country="US" cst_day_phone="(508)555-0100" cst_day_ext="1234" cst_eve_phone="(508)555-0101" cst_eve_ext="5678" cst_fax_phone="5085550102" cst_fax_ext="9012" cst_mail_name="" cst_rent_name="" cst_seed_name="" cst_rent_email="" cst_original_source="" cst_current_source="" cst_hold_bypass_fraud="" cst_orig_mail_type="S" cst_curr_mail_type="B" cst_tax_exempt="" cst_exempt_certificate="" cst_exempt_expiry="" cst_associate="" cst_cancel_bo="K" cst_commercial="N" cst_cust_type="" cst_discount_pct="" cst_entry_date="" cst_inactive="N" cst_bypass_reservation="N" cst_pop_window_1="POP1" cst_pop_window_2="POP2" cst_pop_window_3="" cst_pop_window_4="" cst_price_column="" cst_item_hist_tracking="2" cst_vat_nbr="" cst_do_not_fax="N" cst_deliverable="" cst_delivery_type="" cst_email_status="O1" cst_account_nbr="" cst_cust_class="" cst_cust_company=""

CWSerenade 5.0


cst_mail_code="" cst_call_code="" cst_change_user="" cst_create_user="" cst_currency="USD" cust_po_box="" cst_warehouse="2" cst_user_field_1="USER1" cst_user_field_2="USER2" cst_user_field_3="USER3" cst_user_field_4="USER4" cst_reserve_warehouse="11" cst_van_route="" cst_van_route_seq="" cst_price_group="">









<CustSoldTo cst_company="7" cst_cust_nbr="111" cst_action_type="C" cst_action_result="Failure" />

</Message>

Customer Message: Failure Delete Request

A sample CWCustomerIn Delete request that is placed in error in Working with Customer API (WCAI) is presented below.

Note: If the cst_action_type in an Inbound Customer Message (CWCustomerIn) is D, the system places the message in error in Working with Customer API (WCAI) with the error reason Invalid Type. You cannot delete a customer through the Generic Customer API.



<CustSoldTo cst_company="007" cst_action_type="D" cst_send_response="Y" cst_duplicate="S" cst_cust_nbr="111" cst_salesman_nbr="" cst_interface_cust_nbr="" cst_language="ENG" cst_job_title="" cst_relate_id="" cst_prefix="" cst_fname="James" cst_minitial="R" cst_lname="Jones" cst_suffix="" cst_company_name="" cst_street_addr="10 River St" cst_addr_line_2="" cst_addr_line_3="" cst_addr_line_4="" cst_apt="" cst_city="Templeton" cst_state="MA" cst_zip="01581" cst_country="USA" cst_day_phone="(508)555-0100" cst_day_ext="1234" cst_eve_phone="(508)555-0101" cst_eve_ext="5678" cst_fax_phone="5085550102" cst_fax_ext="9012" cst_mail_name="" cst_rent_name="" cst_seed_name="" cst_rent_email="" cst_original_source="" cst_current_source="" cst_hold_bypass_fraud="" cst_orig_mail_type="S" cst_curr_mail_type="B" cst_tax_exempt="" cst_exempt_certificate="" cst_exempt_expiry="" cst_associate="" cst_cancel_bo="K" cst_commercial="N"

CWSerenade 5.0


cst_cust_type="" cst_discount_pct="" cst_entry_date="" cst_inactive="N" cst_bypass_reservation="N" cst_pop_window_1="POP1" cst_pop_window_2="POP2" cst_pop_window_3="" cst_pop_window_4="" cst_price_column="" cst_item_hist_tracking="2" cst_vat_nbr="" cst_do_not_fax="N" cst_deliverable="" cst_delivery_type="" cst_email_status="O1" cst_account_nbr="" cst_cust_class="" cst_cust_company="" cst_mail_code="" cst_call_code="" cst_change_user="" cst_create_user="" cst_currency="USD" cust_po_box="" cst_warehouse="2" cst_user_field_1="USER1" cst_user_field_2="USER2" cst_user_field_3="USER3" cst_user_field_4="USER4" cst_reserve_warehouse="11" cst_van_route="" cst_van_route_seq="" cst_price_group="">









<CustSoldTo cst_company="7" cst_cust_nbr="111" cst_action_type="D" cst_action_result="Failure" />

</Message>

CWSerenade 5.0

3/24/15 Inbound Customer Message (CWCustomerIn) 315

Inbound Customer Message (CWCustomerIn)

The CWCustomer or CWMessageIn Web Service processes this message and populates the Customer API Work tables. See Adding a Customer using the Customer API for more information, and see Generic Customer API for an overview.

Special characters: Certain special characters cannot be defined in an attribute of an XML message except through the use of replacement text strings. See Translating Special Characters for a list of special characters and their corresponding replacement text string.

Attribute length: If a value defined for an attribute is greater than the allowed number of positions, the system does not place the message in error, and instead truncates the value to the maximum allowed positions. For example, if the maximum length for an attribute is 2 and you define a value that is 3 positions, the system truncates the value to 2 positions. If the attribute requires a valid value, the truncated value must be valid or the message will be placed in Error status.

Sample message: See Sample Customer API XML Messages.



source alpha 20 Informational.

target alpha 20 Informational.

type alpha 20 Required. Must be CWCustomerIn.

resp_qmgr alpha 48 Informational.

resp_q alpha 48 Informational.

CustSoldToOne CustSoldTo element is required.

CWSerenade 5.0


cst_ company numeric 3 Required.A code for the company where the customer creation or update should take place.Company codes are defined in and validated against the Company table.Updates CMP Company in the Customer Sold To table.

cst_action_type alpha 1 Optional.Informational value that indicates the type of action to take; however, regardless of the value defined, the system determines whether to create a new customer or change an existing one. See Determining Whether to Add or Change a Customer.

• A = Add

• C = Change

Error: If set to D, the system places the message in error in Working with Customer API (WCAI) with the error reason Invalid action type. You cannot delete a customer through the Generic Customer API.

cst_send_response

alpha 1 Optional. • Y = Send the Outbound Customer Response Message (CWCustomerOut).• N or any other value = Do not send the Outbound Customer Response Message.


CWSerenade 5.0


cst_duplicate alpha 1 Not used for a Change request.Valid values are:• S = Check for duplicates and if single match found, update customer.• A = Check for duplicates and if multiple matches found, update best match customer.• Y = Check for duplicates and if match found, do not update customer.• N or not passed = No duplicate checking.See Duplicate Checking for Add Requests for a complete discussion.

cst_salesman_nbr numeric 7 Optional.Validated against the Salesman table.Error: If the request includes an invalid salesman number, the system places the message in error in Working with Customer API (WCAI) with the error reason Salesman not found.Updates Salesman # in the Customer Sold To table; see Salesrep # on the First Create Sold To Customer screen.


CWSerenade 5.0


cst_interface_cust_nbr

alpha 15 Optional for an Add request. Required for a Change request if a cst_cust_nbr and cst_relate_id are not defined; see Determining the Customer to Update.Add request:

• If a cst_interface_cust_nbr is specified, assign this number to the new customer both at the customer level (the Alternate customer number) and in the Customer Sold To Xref table.

• If no cst_interface_cust_nbr is specified and the Assign Alternate Customer # (I88) system control value is selected, the system assigns the next available alternate customer number to the new customer.

Updates Interface cust code in the Customer Sold To table and creates a record in the Customer Sold To Xref table if it does not already exist; see Alternate customer number on the Second Create Customer Sold To screen and in Work with Alternate Customer Number Cross-References.

cst_cust_nbr numeric 9 Do not include for an Add request. Required for a Change request if a cst_interface_cust_nbr and cst_relate_id are not defined; see Determining the Customer to Update.Indicates the customer number to update.Error: If the request includes an invalid customer number, the system places the message in error in Working with Customer API (WCAI) with the error reason Customer is not valid.Corresponds to the Customer # in the Customer Sold To table.


CWSerenade 5.0


cst_language alpha 3 Optional. Validated against the Language table (fast path = WLAN).Error: If the request includes an invalid language code, the system places the message in error in Working with Customer API (WCAI) with the error reason Language not found.Updates Language Code in the Customer Sold To table; see the Language field on the First Create Sold To Customer screen.

cst_job_title alpha 25 Optional. Updates Job title in the Customer Sold To table; see the Job title field on the Second Create Customer Sold To screen.

cst_prefix alpha 3 Optional.Validated against the Prefix table if the Validate Prefix (I27) system control value is selected. Error: If the Validate Prefix (I27) system control value is selected and the request includes an invalid prefix code, the system places the message in error in Working with Customer API (WCAI) with the error reason Prefix Code not found.Updates Prefix in the Customer Sold To table; see the Prefix field on the First Create Sold To Customer screen.

cst_fname alpha 15 Optional. Updates First Name in the Customer Sold To table; see the First name field on the First Create Sold To Customer screen.

cst_minitial alpha 1 Optional. Updates Initial in the Customer Sold To table; see the Initial field on the First Create Sold To Customer screen.


CWSerenade 5.0


cst_lname alpha 25 Required for an Add request if a cst_company_name is not defined. Required for a Change request if a cst_company_name is not defined and a Default Customer for Customer API (I90) is not set up. Error: If an Add request does not include a last name or company, the system places the message in error in Working with Customer API (WCAI) with the error reason Both Last name and Company name cannot be blank. Note: This error also occurs for a Change request if a Default Customer for Customer API (I90) has not been defined. Updates Last Name in the Customer Sold To table; see the Last name field on the First Create Sold To Customer screen.

cst_suffix alpha 3 Optional. Updates Suffix in the Customer Sold To table; see the Suffix field on the First Create Sold To Customer screen.

cst_company_name

alpha 30 Required for an Add request if a cst_lname is not defined. Required for a Change request if a cst_company_name is not defined and a Default Customer for Customer API (I90) is not set up.Error: If an Add request does not include a last name or company, the system places the message in error in Working with Customer API (WCAI) with the error reason Both Last name and Company name cannot be blank. Note: This error also occurs for a Change request if a Default Customer for Customer API (I90) has not been defined. Updates Company name in the Customer Sold To table; see the Company field on the First Create Sold To Customer screen.

Note: Standard address validation applies.


CWSerenade 5.0


cst_street_addr alpha 32 Required for an Add request. Required for a Change request if a Default Customer for Customer API (I90) is not defined.Shipping to a Post Office BoxTo ship to a Post Office Box, enter POST OFFICE BOX, POST BOX, or any variation of PO BOX (with or without spaces or non-alphabet characters, such as P.O. BOX), and the box number in the customer’s street address. During order processing, the system validates that the carrier can ship to a post office box (as defined in the Ship Via table).Example: Enter P.O. Box 9999 in the Street field to indicate delivery to a post office box instead of a home or company address.Note: If you type POST OFFICE BOX, POST BOX, or any variation of PO BOX in the customer’s street address during order entry or through the Order API, the system automatically selects the PO box field for the customer. However, if you remove this text from the customer’s street address, the system does not automatically unselect the PO box flag.Note: When you create a customer outside of order processing, you need to select the PO box field manually.Error: If an Add request does not include a street address, the system places the message in error in Working with Customer API (WCAI) with the error reason Street Address cannot be blank. Note: This error also occurs for a Change request if a Default Customer for Customer API (I90) has not been defined. Updates Street Address in the Customer Sold To table; see the Street field on the First Create Sold To Customer screen.


CWSerenade 5.0


cst_addr_line_2 alpha 32 Optional. Updates Address line 2 in the Customer Sold To table and Address line 3 and Address line 4 in the Customer Sold To Extended table; see the three additional Address fields on the First Create Sold To Customer screen.

cst_addr_line_3 alpha 32


cst_apt alpha 10 Optional. Updates Apartment in the Customer Sold To table; see the Apt/suite field on the First Create Sold To Customer screen.

cst_city alpha 25 Required for an Add request. Required for a Change request if a Default Customer for Customer API (I90) is not defined.Error: If an Add request does not include a city, the system places the message in error in Working with Customer API (WCAI) with the error reason City cannot be blank. Note: This error also occurs for a Change request if a Default Customer for Customer API (I90) has not been defined. Updates City in the Customer Sold To table; see the City field on the First Create Sold To Customer screen.


CWSerenade 5.0


cst_state alpha 2 Required for an Add request if the cst_country requires a state; otherwise, optional. Optional for a Change request.State codes are defined in and validated against the State table. Errors:

• If an Add request does not include a state code and the specified cst_country requires a state, the system places the message in error in Working with Customer API (WCAI) with the error reason State is required for this country.

• If you define an invalid state code for the specified cst_country, the system places the message in error in Working with Customer API (WCAI) with the error reason State not found for country.

Updates State in the Customer Sold To table; see the State field on the First Create Sold To Customer screen.


CWSerenade 5.0


cst_zip alpha 10 Required for an Add request if the cst_country requires a postal code. Optional for a Change request.Postal codes are defined in and validated against the SCF table.Errors:

• If the cst_country requires a postal code and an Add request does not include a postal code, the system places the message in error in Working with Customer API (WCAI) with the error reason Zip cannot be blank.

• If the cst_country requires a postal code and you define a postal code that does not exist in the SCF table, the system places the message in error in Working with Customer API (WCAI) with the error reason Invalid SCF entered.

• If the cst_country requires a postal code and you define a postal code that exists in the SCF table, but whose valid states do not match the state defined for the customer, the system places the message in error in Working with Customer API (WCAI) with the error reason Invalid state for zip.

• If the cst_country does not require a postal code and you define a postal code, no validation of the postal code occurs.

Updates Zip and Postal Code Scan in the Customer Sold To table; see the Postal code field on the First Create Sold To Customer screen.


CWSerenade 5.0


cst_country alpha 3 Required for an Add request if the Default Country for Customer Address (B17) system control value is blank. Optional for a Change request.Default: If an Add request does not include a country, the system defaults the value from the Default Country for Customer Address (B17) system control value.Validated against the Country table; see Setting Up the Country Table (WCTY).Error: If the request includes an invalid country code, the system places the message in error in Working with Customer API (WCAI) with the error reason Country is not valid.Updates Country in the Customer Sold To table; see the Country field on the First Create Sold To Customer screen.

cst_day_phone alpha 14 Optional.Updates CS # Phone and CS# Extension in the Customer Sold To Phone # table for CS# Phone # type D (day), E (eve), and F (fax); see the related Phone # and Extension fields on the Second Create Sold To Customer screen.Note:

• The system formats phone numbers according to the rules in effect for the cst_country passed in the message.

• The Third Phone Number Type (L53) system control value determines whether the third phone number is labeled the Fax or Mobile number on screens and reports.

• If you define a phone extension, you must also include the corresponding phone number.

cst_day_ext alpha 4

cst_eve_phone alpha 14

cst_eve_ext alpha 4

cst_fax_phone alpha 14

cst_fax_ext alpha 4


CWSerenade 5.0


cst_mail_name alpha 1 Optional.Valid values are:• Y = Mail catalogs to the customer.• N = Do not mail catalogs to the customer.Default:

• If an Add request does not include a mail name or it is invalid, the system defaults the value from the Default Mail Name (D10) system control value.

• If a Change request does not include a mail name or it is invalid and a Default Customer for Customer API (I90) is not defined, the system defaults the value from the Default Mail Name (D10) system control value.

Error: If a request includes an invalid mail flag and the system places the message in error in Working with Customer API (WCAI) for some other reason, the system validates the mail name setting and displays an error if it is invalid: Mail flag must be Y or N.Updates Mail name? in the Customer Sold To table; see the Mail flag on the First Create Sold To Customer screen.


CWSerenade 5.0


cst_rent_name alpha 1 Optional. Valid values are:• Y = You can sell the customer's name to another company.• N = Do not sell the customer's name to another company.Default:

• If an Add request does not include a rent name or it is invalid, the system defaults the value from the Default Rent Name (D11) system control value.

• If a Change request does not include a rent name or it is invalid and a Default Customer for Customer API (I90) is not defined, the system defaults the value from the Default Rent name (D11) system control value.

Error: If a request includes an invalid rent flag and the system places the message in error in Working with Customer API (WCAI) for some other reason, the system validates the rent flag setting and displays an error if it is invalid: Rent flag must be Y or N.Updates Rent name? in the Customer Sold To table; see the Rent flag on the First Create Sold To Customer screen.

cst_seed_name alpha 1 Optional.Valid values are:• Y = This customer is a seed.• N = This customer is not a seed.Error: If a request includes an invalid seed flag, the system places the message in error in Working with Customer API (WCAI) with the error reason Seed flag must be Y or N.Updates Seed name? in the Customer Sold To table; see the Seed flag on the Second Create Sold To Customer screen.


CWSerenade 5.0


cst_rent_email alpha 1 Optional. Set to Y, N or blank.Updates Rent E-Mail in the Customer Sold To table. Note: This flag is not displayed on any screens, and the system does not validate the value in the message.

cst_original_source

alpha 9 Optional. Validated against the Source table. If the original source code is XSTORE, the system looks at the setting of the Bypass Customer API Edit (L93) system control value to determine if this transaction should bypass validation. Error: If a request includes an invalid source code, the system places the message in error in Working with Customer API (WCAI) with the error reason Source code does not exist.Updates Original Source in the Customer Sold To table; see the Original source code field on the Second Create Sold To Customer screen.

cst_current_source

alpha 9 Optional.Validated against the Source table.Error: If a request includes an invalid source code, the system places the message in error in Working with Customer API (WCAI) with the error reason Source code does not exist.Updates Source code in the Customer Sold To table; see the Current source code field on the Second Create Sold To Customer screen.


CWSerenade 5.0


cst_hold_bypass_fraud

alpha 1 Optional. No validation. • H = Hold; the system places the customer's orders on hold automatically so you can review, then manually release each order.• B = Bypass; orders for the customer are not included in the A/R credit check function in order entry; however, the customer is still subject to other fraud-checking, as described in for the Fraud Checking (A68) system control value.• F = Fraud; the system places the customer's orders on “fraud” hold automatically so you can review each order and release it as needed.• blank = Regular customer.Note: If a request includes a value other than H, B, or F, the system processes the message and does not place it in error.Updates Hold/Bypass/Fraud in the Customer Sold To table; see the Hold/bypass/fraud field on the First Create Sold To Customer screen.


CWSerenade 5.0


cst_orig_mail_type alpha 1 Optional. Valid values are:• B = Buyer; a customer who places an order (the “sold-to” customer).• C = Catalog Request; a person who requested a catalog.• R = Recipient; the customer who receives the order (also known as the Ship To customer).• S = Suspect; a customer whose name you acquired through a telemarketing effort or a public or industry listing, or a customer who places an order that is then rejected.• L = Rental.Errors:

• If an Add request specifies an invalid mail type, the system processes the message and leaves the field blank.

• If a Change request specifies an invalid mail type, the system processes the message and updates the field to blank unless a value is specified for the Default Customer for Customer API (I90).

Updates Original mail type in the Customer Sold To table; see the Original mail type field on the Second Create Customer Sold To screen.


CWSerenade 5.0


cst_curr_mail_type

alpha 1 Optional. Valid values are:• B = Buyer; a customer who places an order (the “sold-to” customer).• C = Catalog Request; a person who requested a catalog.• R = Recipient; the customer who receives the order (also known as the Ship To customer).• S = Suspect; a customer whose name you acquired through a telemarketing effort or a public or industry listing, or a customer who places an order that is then rejected.• L = Rental.Errors:

• If an Add request specifies an invalid mail type, the system processes the message and leaves the field blank.

• If a Change request specifies an invalid mail type, the system processes the message and updates the field to blank unless a value is specified for the Default Customer for Customer API (I90).

Updates Current mail type in the Customer Sold To table; see the Current mail type field on the Second Create Sold To Customer screen.


CWSerenade 5.0


cst_tax_exempt alpha 1 Optional. Valid values are:

• E = Exempt; the customer is not required to pay tax on purchases. If the order is shipping to a Canadian address, it is exempt from both GST and PST. If set to E you must also define a cst_exempt_certificate.

• G = GST Only; the customer is a Canadian customer and subject to the Goods and Services Tax on purchases only, not PST.

• N = Non Taxable; the system determines the customer’s tax status in order entry based on whether you enter a Resale/Exempt # and on the shipping address.

• P = PST Only; the customer is a Canadian customer and subject to the Provincial Services Tax only, not GST.

• R = Resale; the customer is a reseller and not subject to tax. If the order is shipping to a Canadian address, it is exempt from both GST and PST. If set to R you must also define a cst_exempt_certificate.

• T = Standard Tax; the customer is subject to all taxes. Canadian customers are subject to both GST and PST tax.

• blank = Not defined.


CWSerenade 5.0


Errors:

• If you define an invalid value, the system places the message in error in Working with Customer API (WCAI); however, no error message displays and the system allows you to reprocess the request without correcting the error.

• If set to E or R and you do not specify a cst_exempt_certificate, the system places the message in error in Working with Customer API (WCAI) with the error reason Tax exemption certification number required.

Updates Tax exempt status in the Customer Sold To table; see the Tax exempt status field on the Second Create Sold To Customer screen.

cst_exempt_certificate

alpha 15 Required for an Add request if the cst_tax_exempt tag is E or R. Error: If you do not define an exempt certificate and the cst_tax_exempt setting is E or R, the system places the message in error in Working with Customer API (WCAI) with the error reason Tax exemption certification number required.Updates Exempt certificate in the Customer Sold To table; see the Exempt certificate field on the Second Create Sold To Customer screen.

cst_exempt_expiry numeric 7 Optional.MMDDYYYY format; converted to YYMMDD format in database.Updates Exempt expiry date in the Customer Sold To table; see the Exempt expiry field on the Second Create Sold To Customer screen.


CWSerenade 5.0


cst_associate alpha 1 Optional. No validation. • Y = The customer is an associate customer.• N = The customer is not an associate customer.Default: If an Add request does not include an associate flag, the system: • defaults the value to N if the message is from XStore. • defaults the value from the Default Associate Code (D09) system control value if the message is not from XStore. Note: If a request includes a value other than Y or N, the system processes the message and does not place it in error.Updates Associate customer? in the Customer Sold To table; see the Associate flag on the Second Create Sold To Customer screen.

cst_cancel_bo alpha 1 Optional. No validation.• Y = Cancel backordered items automatically with the first shipment on the order.• N = Do not cancel backordered items.Note: If a request includes a value other than Y or N, the system processes the message and does not place it in error.Updates Auto cancel B/O? in the Customer Sold To table; see the Auto cancel backorder flag on the First Create Sold To Customer screen.

cst_commercial alpha 1 Optional. No validation.• Y = This is a commercial customer.• N = This is a non-commercial customer.Note: If a request includes a value other than Y or N, the system processes the message and does not place it in error.Updates Commercial? in the Customer Sold To table; see the Commercial flag on the First Create Sold To Customer screen.


CWSerenade 5.0


cst_cust_type alpha 3 Optional. No validation.Updates Customer type in the Customer Sold To table; see the Type field on the First Create Sold To Customer screen.

cst_discount_pct numeric 5.2 Optional. 999.99 format.Discount percent amount, including decimals. Note:

• If an Add request contains a discount greater than 5 positions with a 2-place decimal, the system defaults 0.00.

• If a Change request contains a discount greater than 5 positions with a 2-place decimal, the system retains the customer’s existing value.

Updates Discount % in the Customer Sold To table; see the Price discount % field on the Second Create Sold To Customer screen.

cst_entry_date alpha 7 Optional for an Add or Change request. MMDDYYYY format; converted to CYYMMDD format in database. Default: If an Add request does not include an entry date or it is not in MMDDYYYY format, the system defaults the current date.Updates Entry date in the Customer Sold To table; see the Entered date on the First Create Sold To Customer screen.

cst_inactive alpha 1 Optional. No validation. • Y = Customer is inactive.• N = Customer is active. Note: If a request includes a value other than Y or N, the system processes the message and does not place it in error.Updates Inactive? in the Customer Sold To table; see the Inactive flag on the First Create Sold To Customer screen.


CWSerenade 5.0


cst_bypass_reservation

alpha 1 Optional. No validation.• Y = The customer bypasses reservation. • N = The system reserves inventory in the normal way for all orders for this customer, unless the customer is assigned to a customer class flagged to bypass reservation.Note: If a request includes a value other than Y or N, the system processes the message and does not place it in error.Updates Bypass Reservation in the Customer Sold To table; see the Bypass reservation flag on the First Create Sold To Customer screen.

cst_pop_window_1

alpha 20 Optional. No validation. Updates Pop-Up Window #1-4 in the Customer Sold To table; see the Pop up window messages on the Second Create Sold To Customer screen.

cst_pop_window_2

alpha 20

cst_pop_window_3

alpha 20

cst_pop_window_4

alpha 20

cst_price_column numeric 2 Optional. No validation.Updates Price column in the Customer Sold To table; see the Price column field on the Second Create Sold To Customer screen.


CWSerenade 5.0


cst_item_hist_tracking

alpha 1 Optional. No validation.

• 1 = No Item Tracking.

• 2 = Sold To Tracking Only.

• 3 = Sold To + Ship To Tracking.

Default: If an Add request does not include an item history tracking setting, the system defaults the value from the Default Item History Tracking (B18) system control value; if this system control value is blank, the system sets item history tracking to blank.Note: If a Change request includes a value other than 1, 2, or 3, and a Default Customer for Customer API (I90) has not been defined, the system sets item history tracking to blank.Updates CST item history tracking? in the Customer Sold To table; see the Track item history field on the First Create Sold To Customer screen.

cst_vat_nbr alpha 20 Optional. No validation. Updates VAT number in the Customer Sold To table; see the VAT number field on the Second Create Sold To Customer screen.

cst_do_not_fax alpha 1 Optional. No validation.

• Y = Do not fax.

• N = Fax.

Default: If a request includes a value other than Y or N, the system sets the do not fax flag to blank.Updates Do Not Fax in the Customer Sold To table; however this field is not currently implemented. See the Do not fax flag on the First Create Sold To Customer screen.


CWSerenade 5.0


cst_deliverable alpha 1 Optional. No validation.Updates Deliverable Code in the Customer Sold To table. This field is not currently implemented or displayed on any screen.

cst_delivery_type alpha 1 Optional.Valid values:• B = Business rate table determines shipping charges.• R = Residential rate table determines shipping charges.• N = No distinction between business and residence.Default: If an Add request does not include a delivery type, the system:3. Defaults the delivery code in the

Zip/City/State table defined for the postal code in the cst_zip tag.

4. Defaults the value from the Default Delivery Code for New Order Entry Customers (D13) system control value.

Error: If a request includes an invalid delivery type, the system places the message in error in Working with Customer API (WCAI) with the error reason Del code must be B, N, or R.Updates Delivery code in the Customer Sold To table; see the Delivery code flag on the First Create Sold To Customer screen.


CWSerenade 5.0


cst_email_status alpha 2 Optional. No validation.• O1 = Email; email is the preferred method of correspondence.• O2 = Order-Only Email; use email for order-related correspondence only; generate a document for other correspondence.• O3 = No email; do not use email for any correspondence; generate a document instead.• O4 = Do Not Ask; do not ask the customer for his/her email address. The system does not generate any email correspondence to the customer, even if an email address is specified.Default: If no cst_email_status is specified here, the cst_email_status from the CustEmail element for the primary email defaults; and if no cst_email_status is specified for the primary email, the system uses the value from the Default Opt In/Opt Out Flag (G97) system control value for both Opt in/out flag settings.Error: If an Add request contains an invalid Opt in/Opt out setting, the system processes the message and does not place it in error; however, you will need to correct the error in Work with Customers (WCST).Note: If a Change request contains an invalid Opt in/Opt out setting, the system retains the customer’s existing value.Updates E-mail status in the Customer Sold To table; see the Opt in/Opt out flag on the First Create Sold To Customer screen.


CWSerenade 5.0


cst_account_nbr numeric 7 Optional.Validated against the Customer Bill To table. Error: If you define an invalid customer bill to number, the system places the message in error in Working with Customer API (WCAI) with the error reason Customer bill to not found. Updates CBT Account # in the Customer Sold To table; see the Bill to field on the Second Create Sold To Customer screen.


CWSerenade 5.0


cst_cust_class alpha 2 Optional unless the Require Customer Class in OE, WCAT, and WCST (H85) system control value is selected; then, required.Validated against the Customer Class table.Default: If an Add request does not include a customer class, the system defaults the value from the Default Customer Class in Order Entry (D63) system control value.Note: If a Change request does not include a customer class and a customer class is not defined for the Default Customer for Customer API (I90), the system sets the customer class to blank. If the Require Customer Class in OE, WCAT, and WCST (H85) system control value is selected, the system will not fail the message; however the system will require a customer class if you select to change the customer in Work with Customers (WCST).Errors:

• If an Add request does not include a customer class and the Require Customer Class in OE, WCAT, and WCST (H85) system control value is selected, the system places the message in error in Working with Customer API (WCAI) with the error reason Customer Class required.

• If the request includes an invalid customer class, the system places the message in error in Working with Customer API (WCAI) with the error reason Customer class does not exist.

Updates Customer class in the Customer Sold To table; see the Class field on the First Create Sold To Customer screen.


CWSerenade 5.0


cst_cust_company alpha 3 Optional. Validated against the Customer Company table. Error: If the message includes an invalid customer company, the system places the message in error in Working with Customer API (WCAI) with the error reason Customer Company not found.Updates Customer company in the Customer Sold To table; see the Parent company field on the First Create Sold To Customer screen.

cst_mail_code alpha 3 Optional. Default:

• If a request does not include a mail code, the system uses the value passed in the cst_mail_name attribute (either Y or N).

• If an Add request does not include a mail code or mail name, the system defaults the value from the Default Mail Name (D10) system control value.

Validated against the Mail/Call Code table, where it must have a Type of M. Note: The system does not validate the value against the Mail/Call Code table until the customer has been created or updated in Work with Customers (WCST); however if the message contains another error that you must correct in Working with Customer API (WCAI), the system will validate the mail code field in Work with Customer API (WCAI) and display the error reason Mail/Call Code not found.Updates Mail code in the Customer Sold To table; see the Mail code flag on the First Create Sold To Customer screen.


CWSerenade 5.0


cst_call_code alpha 3 Optional.Validated against the Mail/Call Code table, where it must have a Type of C.Error: If a request includes a value that does not exist in the Mail/Call Code table for a Type of C, the system places the message in error in Working with Customer API (WCAI) with the error reason Mail/Call Code not found.Updates Call code in the Customer Sold To table; see the Call code flag on the First Create Sold To Customer screen.

cst_change_user alpha 10 Ignored by an Add request. Optional for a Change request.Default: If a user ID is not defined in a Change request, CUSTOMERIN defaults, regardless if a changed by user is defined for the Default Customer for Customer API (I90).Validated against the User table unless CUSTOMERIN defaults.Error: If a Change request contains an invalid user ID, the system places the message in error in Working with Customer API (WCAI) with the error reason User does not exist.Updates Changed by user in the Customer Sold To table. This field is not displayed on the screen.

cst_create_user alpha 10 Optional for an Add request. Ignored by a Change request.Default: If a user ID is not defined in an Add request, CUSTOMERIN defaults. Validated against the User table unless CUSTOMERIN defaults.Error: If an Add request contains an invalid user ID, the system places the message in error in Working with Customer API (WCAI) with the error reason User does not exist.Updates Created by User in the Customer Sold To table. This field is not displayed on the screen.


CWSerenade 5.0


cst_currency alpha 3 Optional.Validated against the Currency table.Error: If the request contains an invalid currency code, the system places the message in error in Working with Customer API (WCAI) with the error reason Currency not found. Updates Currency code in the Customer Sold To table; see the Currency field on the First Create Sold To Customer screen.


CWSerenade 5.0


cust_po_box alpha 1 Optional. No validation.• Y = The address is a Post Office box. • N = The address is not a Post Office box.Shipping to a Post Office BoxTo ship to a Post Office Box, enter POST OFFICE BOX, POST BOX, or any variation of PO BOX (with or without spaces or non-alphabet characters, such as P.O. BOX), and the box number in the customer’s street address. During order processing, the system validates that the carrier can ship to a post office box (as defined in the Ship Via table).Example: Enter P.O. Box 9999 in the Street field to indicate delivery to a post office box instead of a home or company address.Note: If you type POST OFFICE BOX, POST BOX, or any variation of PO BOX in the customer’s street address during order entry or through the Order API, the system automatically selects the PO box field for the customer. However, if you remove this text from the customer’s street address, the system does not automatically unselect the PO box flag.Note: When you create a customer outside of order processing, you need to select the PO box field manually.Default: If an Add request does not include a PO box flag or it is invalid, N defaults.Updates PO Box? in the Customer Sold To table; see the PO box field on the First Create Sold To Customer screen.


CWSerenade 5.0


cst_warehouse numeric 3 Optional.Validated against the Warehouse table.Error: If the request contains an invalid warehouse code, the system places the message in error in Working with Customer API (WCAI) with the error reason Warehouse does not exist.Updates Warehouse in the Customer Warehouse table; see the Restock warehouse field on the Second Create Sold To Customer screen.

cst_user_field_1 alpha 10 Optional. Updates User field 1-4 in the Customer Sold To Extended table; see the User fields on the Second Create Sold To Customer screen.

cst_user_field_2 alpha 10



cst_reserve_warehouse

numeric 3 Optional. Validated against the Warehouse table. Errors:

• If the request contains an invalid warehouse code, the system places the message in error in Working with Customer API (WCAI) with the error reason Warehouse does not exist.

• If the warehouse is not an allocatable warehouse (the Allocatable flag for the warehouse is selected), the system places the message in error in Working with Customer API (WCAI) with the error reason Reserve Warehouse must be an allocatable warehouse.

Updates Reserve Warehouse in the Customer Sold To table; see the Reserve warehouse field on the Second Create Sold To Customer screen. Available in XML version: Version 2.0 in CWSerenade 2.5 or later.


CWSerenade 5.0


cst_van_route alpha 4 Optional.Validated against the Warehouse Van Route table.Errors:

• If the request contains a van route that is not valid for the Reserve warehouse, the system places the message in error in Working with Customer API (WCAI) with the error reason Invalid Van Route for Reserve Warehouse.

• If the request contains a van route and a Reserve warehouse is not specified, the system places the message in error in Working with Customer API (WCAI) with the error reason Reserve Warehouse required for Van Route.

Updates Reserve Whs Van route in the Customer Sold To table; see the Van route field on the Second Create Sold To Customer screen.Available in XML version: Version 2.0 in CWSerenade 2.5 or later.

cst_van_route_seq numeric 4 Optional.Error: If the request contains a van sequence number and a Van route is not specified, the system places the message in error in Working with Customer API (WCAI) with the error reason Van Route required for Van Route Sequence #. Updates Reserve Whs Van route seq # in the Customer Sold To table; see the Van sequence # field on the Second Create Sold To Customer screen.Available in XML version: Version 2.0 in CWSerenade 2.5 or later.


CWSerenade 5.0


cst_price_group alpha 4 Optional.Validated against the Customer Price Group table.Note:

• If an Add request contains an invalid price group code, the system does not place the message in error, and instead, leaves the Price Group field blank.

• If a Change request contains an invalid price group code, the system does not place the message in error, and instead, uses the Default Customer for Customer API to determine whether to retain the customer’s existing value.

Updates Price Group in the Customer Sold To table; see the Price group field on the Second Create Sold To Customer screen.

cst_relate_id alpha 32 Optional for an Add request.Required for a Change request if a cst_cust_nbr and cst_interface_cust_nbr are not defined. See Determining the Customer to Update.Note: If a Relate ID is not included in a Change request, the system retains the existing Relate ID, if any, defined for the customer. Updates Relate ID in the Customer Sold To table. This field is not displayed on the Customer Sold To screens.Available in XML version: Version 3.0 in CWSerenade 3.5 or later.


CWSerenade 5.0


cst_suppress_sales_rep_email

alpha 1 Optional. Defines whether Outbound Email (CWEmailOut) messages sent to this sold to customer are also sent to the email address of the salesrep assigned to the customer.

• Y = Do not send Outbound Email (CWEmailOut) messages sent to the sold to customer to the email address of the salesrep assigned to the customer.

• N = Send Outbound Email (CWEmailOut) messages sent to the sold to customer to the email address of the salesrep assigned to the customer.

Default: If this attribute is not included or is invalid, Y defaults. Note: The system does not use the default customer for this attribute. Updates Suppress Sales Rep Email Flag in the Customer Sold To table; see the Suppress Sales Rep Email field on the First Create Sold To Customer screen.Available in XML version: Version 4.0 in CWSerenade 3.5 or later.

CustEmailThe CustEmail element creates an email address for the customer. This is an optional element, and an Add or Change request can include multiple email addresses.See Working with Customer Email Addresses for more information.


CWSerenade 5.0


cst_email_seq numeric 3 Required in an Add request if the message includes more than one email address; each email address in the message must include a unique sequence number.Required in a Change request to identify the email address to update; if the sequence number does not match an existing email, the system creates a new email address for the customer.When creating a new email address, the system assigns the next available sequence number for the customer in the Customer Sold To Email table to the new email address; for example, if the customer does not currently have an email address and the message includes two email addresses with a sequence number of 10 and 20, the system creates the email addresses and assigns them a sequence of 1 and 2.Updates Sequence # in the Customer Sold To Email table.


CWSerenade 5.0


cst_email_address alpha 50 Required.The email address to add or update. Errors: If the email address:

• is missing an @ sign, the system places the message in error in Working with Customer API (WCAI) with the error reason Email address is missing the @ sign.

• is missing a period after the @ sign, the system places the message in error in Working with Customer API (WCAI) with the error reason Email address is missing a dot (.) somewhere

after the @ sign.

• is missing text before the @ sign, the system places the message in error in Working with Customer API (WCAI) with the error reason Email address is missing a non-blank character before

the @ sign.

• is missing text between the @ sign and the period, the system places the message in error in Working with Customer API (WCAI) with the error reason Email address is missing at least one character between the @ sign

and the period (.).

• is missing text after the period, the system places the message in error in Working with Customer API (WCAI) with the error reason Email address must have a non-blank character after

the ’.’.

Updates Email Address in the Customer Sold To Email Address table; see the Email address field on the Work with Customer Email Address screen. The email address flagged as primary also updates Email Address in the Customer Sold To table.


CWSerenade 5.0


cst_email_primary alpha 1 Optional.Valid values are:Y = the cst_email_address should be used as the primary email address. N = the cst_email_address should not be used as the primary email address.Note: Any other value is treated as N. Add requests:

• If one email address is included in the message, regardless of the value in the cst_email_primary attribute, the system flags this email address as the primary email.

• If more than one email address is included in the message, and no email address is flagged as primary, the system flags the first email address as the primary email.

• If more than one email address is included in the message, and only one email address is flagged as primary, the system flags this email address as the primary email.

• If more than one email address is included in the message, and more than one email address is flagged as primary, the system flags the last email address whose cst_email_primary attribute is Y as the primary email.


CWSerenade 5.0


Change requests: If the customer does not currently have a primary email address:

• If one email address is included in the message, regardless of the value in the cst_email_primary attribute, the system flags this email address as the primary email.

• If more than one email address is included in the message, and no email address is flagged as primary, the system flags the first email address as the primary email.

• If more than one email address is included in the message, and only one email address is flagged as primary, the system flags this email address as the primary email.

• If more than one email address is included in the message, and more than one email address is flagged as primary, the system flags the last email address whose cst_email_primary attribute is Y as the primary email.


CWSerenade 5.0


If the customer currently has a primary email address:

• If the message does not include an email address, the system retains the customer’s primary email address, regardless of whether there is data in the Email address field for the Default Customer for Customer API (I90).

• If the message includes one or more email addresses that are not flagged as primary, the system updates the Customer Sold To Email Address table with the new or updated email addresses, but does not update the customer’s primary email.

• If the message includes one email address flagged as primary, the system flags this email address as the primary email and updates the Primary field for the previous primary email address to N.

• If the message includes more than one email address flagged as primary, the system flags the last email address whose cst_email_primary attribute is Y as the primary email and updates the Primary field for the previous primary email address to N.

Updates Primary? in the Customer Sold To Email Address table; see the Primary field on the Work with Customer Email Address screen.


CWSerenade 5.0


cst_email_status alpha 2 Optional.Valid values: • O1 = Email; email is the preferred method of correspondence.• O2 = Order-Only Email; use email for order-related correspondence only; generate a document for other correspondence.• O3 = No email; do not use email for any correspondence; generate a document instead.• O4 = Do Not Ask; do not ask the customer for his/her email address. The system does not generate any email correspondence to the customer, even if an email address is specified.Default: If no cst_email_status is specified here, the cst_email_status from the CustSoldTo element defaults; and if no cst_email_status is specified in the CustSoldTo element, the system uses the value from the Default Opt In/Opt Out Flag (G97) system control value for both Opt in/out flag settings.Errors: If the request contains an invalid email status or a default value was not found, the system places the message in error in Working with Customer API (WCAI) with the error reason Invalid sts in email file.Updates Email Status in the Customer Sold To Email Address table; see the Opt in/out flag on the Work with Customer Email Address screen.


CWSerenade 5.0


cst_email_format alpha 1 Optional. Indicates the customer’s preference regarding email format.Valid values:

• H = HTML

• T = Text

Error: If the request contains an invalid email format, the system places the message in error in Working with Customer API (WCAI) with the error reason Invalid email format.Note: If an email format is not defined for the Default Customer for Customer API (I90) and you do not pass an email format for an email address in a Change request, the system updates the email format to blank. Updates Email Format in the Customer Sold To Email Address table; see the Format field on the Work with Customer Email Address screen.

cst_display_name alpha 50 Optional.Note: If a display name is not defined for the Default Customer for Customer API (I90) and you do not pass a display name for an email address in a Change request, the system updates the display name to blank. Updates Display Name in the Customer Sold To Email Address table; see the Display name field on the Work with Customer Email Address screen.

CustUserDefinedFieldThe CustUserDefinedField element updates a user-defined field for the customer. This is an optional element, and an Add or Change request can include multiple user-defined fields.The user-defined fields are created through Setting Up User-Defined Fields (WUDF). You can create fields for whatever type of additional information you want to define for a customer.


CWSerenade 5.0


cst_udf_seq numeric 3 Required.The sequence number from the User Defined Fields Detail table that indicates which customer user-defined field to update with this message. The sequence number identifies whether you define text, a number, or date in the user-defined field.Note:

• If the sequence number does not exist in the User Defined Field Detail table for File code CST, the system ignores the CustUserDefinedField element included in the message.

• If more than one CustUserDefinedField element contains the same sequence number:

• Add request: the system processes the user defined fields up to the duplicate sequence number; the duplicate sequence number and any other user defined fields passed in the request after the duplicate are not processed.

• Change request: the system updates the user-defined field for the customer using the value in the last CustUserDefinedField element processed for that sequence number.

Updates CSU UDD Seq # in the Cust Sold To User Field table; see the Key field on the Change User Field screen.

cst_udf_text alpha 30 Optional if the cst_udf_seq requires text; otherwise ignored.Updates Text in the Cust Sold To User Field table for the specified user-defined sequence number; see the Text field on the Change User Field screen.


CWSerenade 5.0


cst_udf_nbr numeric 16 Optional if the cst_udf_seq requires a number; otherwise ignored. Updates Number in the Cust Sold To User Field table for the specified user-defined sequence number; see the Number field on the Change User Field screen.

cst_udf_date numeric 7 Optional if the cst_udf_seq requires a date; otherwise ignored. MMDDYYYY format; converted to CYYMMDD format in database. Default: If the cst_udf_seq requires a date and you leave the cst_udf_date attribute blank or it is not in MMDDYYYY format, the system defaults the current date. Updates Date in the Cust Sold To User Field table for the specified user-defined sequence number; see the Date field on the Change User Field screen.

CustProfileThe profile data, if any, included through this element updates the customer’s demographic data. This is an optional element, and an Add or Change request can include multiple customer profiles.You can review a customer’s demographic data at the Work with Customer Profile screen. You define customer profile categories, such as age, income, or gender, and the valid values for each category through Setting Up Customer Profiles (WPFL).Available in XML version: 2.0 (release 2.5 of CWSerenade).


CWSerenade 5.0


cst_profile_code numeric 3 A profile code to identify demographic data for the customer.Required to create or update a customer profile record:

• If the profile code does not currently exist for the customer, the system creates a Customer Profile record for the customer.

• If the profile code already exists for the customer, the system updates its value.

Profile codes are defined in and validated against the Profile table; see Setting Up Customer Profiles (WPFL).Error: If the profile code in the message does not exist in the Profile table, the system does not create a Customer Profile record and instead, creates a Customer Note record for the customer indicating the profile data in error; for example: Invalid Profile Data Code: 999-A, where 999 is the profile code and A is the profile value.Updates Profile code in the Customer Profile table; see the Profile field on the Work with Customer Profile screen.


CWSerenade 5.0


cst_profile_value alpha 1 The valid value set up for the Profile code.Required to create or update a customer profile record:• If the profile code does not currently exist for the customer, the system creates a Customer Profile record for the customer.• If the profile code already exists for the customer, the system updates its value.Profile data values are defined in and validated against the Profile Data table; see Setting Up Customer Profiles (WPFL).Error: If the profile value does not exist in the Profile Data table for the specified profile code, the system does not create a Customer Profile record and instead, creates a Customer Note record for the customer indicating the profile data in error; for example: Invalid Profile Data Code: 999-A, where 999 is the profile code and A is the profile value.Updates PDA Profile data code in the Customer Profile table; see the Data field on the Work with Customer Profile screen.


CWSerenade 5.0

3/24/15 Outbound Customer Response Message (CWCustomerOut) 361

Outbound Customer Response Message (CWCustomerOut)

The CWCustomer or CWMessageIn Web Service generates this message as a response to the Inbound Customer Message (CWCustomerIn) if the cst_send_response is selected. See Adding a Customer using the Customer API and Changing a Customer using the Customer API for more information.

Special characters: Certain special characters cannot be defined for an attribute of an XML message except through the use of replacement text strings. See Translating Special Characters for a list of special characters and their corresponding replacement text string.

Sample message: See Sample Customer API XML Messages.


Message

source alpha 20 Informational.

target alpha 20 Informational.

type alpha 20 CWCustomerOut

resp_qmgr alpha 48 Informational.

resp_q alpha 48 Informational.

CustSoldTo

cst_company numeric 3 The company indicated in the Inbound Customer Message (CWCustomerIn).

CWSerenade 5.0


cst_cust_nbr numeric 9 The customer number affected by the Inbound Customer Message (CWCustomerIn). In the case of a successful Add request, this is the customer number assigned by the system to the new customer.From Customer # in the Customer Sold To table.

cst_action_type alpha 1 Defines whether the system considered the Inbound Customer Message (CWCustomerIn) to be an Add or Change request. A = Add request. C = Change request.

cst_action_result alpha 9 The result of the requested action. Possible results are:• Success = The update was completed successfully.• Failure = The request could not be completed due to errors. The response indicates the element and tag that caused the error.• Duplicate = The request could not be completed because the system found one or more duplicate customers. Used only for Add requests.


CWSerenade 5.0


The customer name and address information included in the CustSoldTo element of the response message varies, based on whether the response is to an Add or Change request, and whether the request was successful:

• Successful creation or change: This is the information sent in the Inbound Customer Message (CWCustomerIn). If the system performed any address standardization, the updated address is included.

• Duplicate: This is the customer information for the duplicate customer if the system found one or more duplicate customers for an Add request. See Adding a Customer using the Customer API for a discussion.

Note: If there are multiple duplicate customers, additional duplicates are listed in the Duplicate element.

• Change failure: The customer number identified for the Change request is included, but no additional customer information.

• Add failure: No customer information is included.

See the Sample Customer API XML Messages for examples of each.

cst_prefix alpha 3 The Prefix, if any, for the customer. From Prefix in the Customer Sold To table.

cst_fname alpha 15 The First name, if any, for the customer. From First Name in the Customer Sold To table.

cst_minitial alpha 1 The Initial, if any, for the customer. From Initial in the Customer Sold To table.

cst_lname alpha 25 The Last name, if any, for the customer. From Last Name in the Customer Sold To table.

cst_suffix alpha 3 The Suffix, if any, for the customer. From Suffix in the Customer Sold To table.

cst_company_name

alpha 30 The Company, if any, for the customer. From Company name in the Customer Sold To table.

cst_street_name alpha 32 The Street for the customer. From Street Address in the Customer Sold To table.


CWSerenade 5.0


cst_addr_line_2 alpha 32 The three additional Address lines, if any, for the customer. From Address line 2 in the Customer Sold To table and Address line 3 and Address line 4 in the Customer Sold To Extended table.



cst_apt alpha 10 The Apartment/suite, if any, for the customer. From Apartment in the Customer Sold To table.

cst_city alpha 25 The City for the customer. From City in the Customer Sold To table.

cst_state alpha 2 The State for the customer. From State in the Customer Sold To table.

cst_zip alpha 10 The Postal code for the customer. From Zip in the Customer Sold To table.

cst_country alpha 3 The Country for the customer. From Country in the Customer Sold To table.

cst_match_code alpha 15 The Match code for the customer. From Match Code in the Customer Sold To table.

cst_ghost alpha 1 Indicates whether this customer record is a ghost, or a customer record that you can retain on the system after you purge duplicates. See the discussion of the Ghost flag for more information. Valid values are:Y = The record is a ghost.N = The record is not a ghost.From Ghost? in the Customer Sold To table.

Alternate

cst_interface_cust_nbr

alpha 15 From Alternate customer # in the Customer Sold To XRef table. Each alternate customer number for the customer is included.


CWSerenade 5.0


DuplicateThis information is included only if there are multiple duplicates for an Add request. See Adding a Customer using the Customer API for a discussion.

dup_cust_nbr numeric 9 From Customer # in the Customer Sold To table.

dup_prefix alpha 3 From Prefix in the Customer Sold To table.

dup_fname alpha 15 From First Name in the Customer Sold To table.

dup_minitial alpha 1 From Initial in the Customer Sold To table.

dup_lname alpha 25 From Last Name in the Customer Sold To table.

dup_suffix alpha 3 From Suffix in the Customer Sold To table.

dup_company_name

alpha 30 From Company name in the Customer Sold To table.

dup_street_name alpha 32 From Street Address in the Customer Sold To table.

dup_addr_line_2 alpha 32 From Address line 2 in the Customer Sold To table.

dup_addr_line_3 alpha 32 From Address line 3 in the Customer Sold To Extended table.

dup_addr_line_4 alpha 32 From Address line 4 in the Customer Sold To Extended table.

dup_apt alpha 10 From Apartment in the Customer Sold To table.

dup_city alpha 25 From City in the Customer Sold To table.

dup_state alpha 2 From State in the Customer Sold To table.

dup_zip alpha 10 From Zip in the Customer Sold To table.

dup_country alpha 3 From Country in the Customer Sold To table.

dup_match_code alpha 15 From Match Code in the Customer Sold To table.


CWSerenade 5.0


dup_ghost alpha 1 Indicates whether this customer record is a ghost, or a customer record that you can retain on the system after you purge duplicates. See the discussion of the Ghost flag for more information. Valid values are:Y = The record is a ghost.N = The record is not a ghost.From Ghost? in the Customer Sold To table.


CWSerenade 5.0

3/24/15 Working with Customer API (WCAI) 367

Working with Customer API (WCAI)

Purpose: Use this menu option to review, work with, delete, or resubmit customer API requests that are in error.

The CWCustomer or CWMessageIn Web Service receives and processes the Inbound Customer Message (CWCustomerIn) and creates or updates a customer, based on the information in the inbound message. If the request is in error for any reason, the system saves the information from the request in the Customer API Work table. If the request also includes email or user-defined field information, this additional information is stored in the Customer API E-mail Work table and the Customer API UDF Work table.

Error reasons: See Error Checking for Add Requests.

For more information: See Generic Customer API, including Adding a Customer using the Customer API, Changing a Customer using the Customer API, and the Inbound Customer Message (CWCustomerIn).

In this topic:

• Work with Customer API Screen

• Change Customer API Screen

• Work with Customer API User Field Screen

• Change Customer API User Field Screen

• Work with Customer API Email Screen

• Change Customer API Email Screen

Work with Customer API Screen

How to display this screen: Enter WCAI in the Fast path field at the top of any menu, or select Work with Customer API from a menu.

Field Description

Date The date when the Customer API Work table record was created.Numeric, 6 positions (MMDDYY format); optional.

Time The time when the Customer API Work table record was created.Numeric, 6 positions (HHMMSS format); optional.

CWSerenade 5.0


Act (Action) The requested action from the cst_action_type in the Inbound Customer Message (CWCustomerIn). If the cst_action_type is D, the system places the message in error with the error reason Invalid Action Type. The system ignores any other value; see Determining Whether to Add or Change a Customer for more information on the logic the system uses to determine whether to create a new customer or change an existing one. Display-only.

Status The status of the request. E (error) = The Customer request is in error. blank = The Customer request is ready to reprocess. Alphanumeric, 1 position; display-only.

Customer# The customer number affected by the request.Note: • If an Add request is in error, the customer number displayed here does not yet exist in the Customer Sold To table.• If a Change request is in error because the customer could not be identified, the customer number displayed here is zero.Numeric, 9 positions; display-only.

Alternate# The cst_interface_cust_nbr, if any, specified in the Inbound Customer Message (CWCustomerIn). No alternate customer number is displayed if the Assign Alternate Customer # (I88) system control value is selected; in this situation, the system assigns the alternate customer number when it actually creates the customer.Alphanumeric, 15 positions; display-only.

Rsn Not currently implemented. Select Change for the customer API record to advance to the Change Customer API Screen; when you select OK on this screen, the system displays a message indicating the reason why the Customer API record is in error.Alphanumeric, 1 position; display-only.

Option Procedure

Change a customer API request record Select Change for a customer API request record to advance to the Change Customer API Screen.

Field Description

CWSerenade 5.0


Delete a customer API request record. Select Delete for a customer API request record to delete it.

Work with user-defined fields for a customer API request record

Select User defined fields for a customer API request record to advance to the Work with Customer API User Field Screen.

Work with email information for a customer API request record

Select Email for a customer API request record to advance to the Work with Customer API Email Screen.

Reprocess a customer API request record Select Reprocess for a customer API request record to submit it for processing. The system reprocesses the record only if it is error-free. See Adding a Customer using the Customer API for more information.

Reprocess all customer API requests Select Reprocess to submit all eligible request records for processing. See Adding a Customer using the Customer API for more information.

Option Procedure

CWSerenade 5.0


Change Customer API Screen

Purpose: Use this screen to work with customer API requests that are in error based on the information passed in the CustSoldTo element of the Inbound Customer Message (CWCustomerIn).

How to display this screen: Select Change for a customer API record in error.

Field Description

Date The date when the Customer API Work table record was created.Numeric, 6 positions (MMDDYY format); display-only.

Action The requested action from the cst_action_type in the Inbound Customer Message (CWCustomerIn).Possible actions are:• Add = Add a customer• Change = Change an existing customer• Delete = Delete an existing customerNote: You can only create or update a customer; the system does not allow you to delete a customer through the Generic Customer API. See Determining Whether to Add or Change a Customer or the logic the system uses to determine whether to create a new customer or change an existing one.Display-only.

Entered on The cst_entry_date from the Inbound Customer Message (CWCustomerIn).Numeric, 6 positions (MMDDYY format); optional.

Lng (Language) The cst_language from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 3 positions; optional.

Class The cst_cust_class from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 2 positions; optional (required if the Require Customer Class in OE, WCAT and WCST (H85) system control value is selected).

Time The time when the Customer API Work table record was created.Numeric, 6 positions (HHMMSS format); display-only.

CWSerenade 5.0


Status The status of the customer API request. Possible statuses are:

• Error = The Customer request is in error.

• No Error = The Customer request is ready to reprocess.

Display-only.

Created by The cst_create_user from the Inbound Customer Message (CWCustomerIn).Note: Regardless of the user you select for this field, the system defaults the user ID of the user updating the Customer API record. Alphanumeric, 10 positions; optional.

Cur (Currency) The cst_currency from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 3 positions; optional.

Comp Cd (Company code)

The cst_cust_company from the Inbound Customer Message (CWCustomerIn).Numeric, 3 positions; optional.

Customer# The cst_cust_nbr from the Inbound Customer Message (CWCustomerIn), or assigned by the system if this is an Add request.Note: • If an Add request is in error, the customer number displayed here does not yet exist in the Customer Sold To table.• If a Change request is in error because the customer could not be identified, the customer number displayed here is zero.Numeric, 9 positions; display-only.

Changed by The cst_change_user from the Inbound Customer Message (CWCustomerIn).Note: Regardless of the user you select for this field, the system defaults the user ID of the user updating the Customer API record. Alphanumeric, 10 positions; required.

Typ (Type) The cst_cust_type from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 3 positions; optional.

Mail Cd (Mail code) The cst_mail_code from the Inbound Customer Message (CWCustomerIn). Not to be confused with the Mail flag.Alphanumeric, 3 positions; optional.

Field Description

CWSerenade 5.0


Account# The cst_account_nbr from the Inbound Customer Message (CWCustomerIn).Numeric, 7 positions; optional.

Commer (Commercial)

The cst_commercial flag from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 1 position; optional.

Alt# (Alternate customer #)

The cst_interface_cust_nbrcst_interface_cust_nbr from the Inbound Customer Message (CWCustomerIn).Note: No alternate customer number is displayed if the Assign Alternate Customer # (I88) system control value is selected; in this situation, the system assigns the alternate customer number when it actually creates the customer.Alphanumeric, 15 positions; optional.

Call Cd (Call code) The cst_call_code from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 3 positions; optional.

Name The customer’s name from the Inbound Customer Message (CWCustomerIn), consisting of:• cst_prefix• cst_fname• cst_minitial• cst_lname• cst_suffixAlphanumeric, 47 positions; optional.

Restock Warehouse

The cst_warehouse from the Inbound Customer Message (CWCustomerIn).Numeric, 3 positions; optional.

Inact (Inactive) The cst_inactive flag from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 1 position; optional.

Company The cst_company_name from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 30 positions; required if no last name is specified.

Apt The cst_apt from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 7 positions; optional.

PO Box The cust_po_box flag from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 1 position; optional.

Field Description

CWSerenade 5.0


Suppr Sls Email (Suppress salesman email)

The cst_suppress_sales_rep_email from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 1 position; optional.

Street The cst_street_addr from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 32 positions; required.

Delivery code The cst_delivery_type from the Inbound Customer Message (CWCustomerIn).Valid values:• Business• Residential• No DistinctionRequired.

Mail The cst_mail_name flag from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 1 position; optional.

Address The cst_addr_line_2, cst_addr_line_3, and cst_addr_line_4 from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 32 positions each; optional.

Deliverable cde (Deliverable code)

The cst_deliverable flag from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 1 position; optional.

Rent The cst_rent_name flag from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 1 position; optional.

Orig mail type (Original mail type)

The cst_orig_mail_type from the Inbound Customer Message (CWCustomerIn).Valid values:• Buyer• Catalog Request• Recipient• Rental• Suspect/ProspectOptional.

Seed The cst_seed_name flag from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 1 position; optional.

Field Description

CWSerenade 5.0


Curr mail type (Current mail type)

The cst_curr_mail_type from the Inbound Customer Message (CWCustomerIn).Valid values:• Buyer• Catalog Request• Recipient• Rental• Suspect/ProspectOptional.

H/B/F The cst_hold_bypass_fraud flag from the Inbound Customer Message (CWCustomerIn).Valid values:• Hold• Bypass• FraudOptional.

Postal code The cst_zip from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 10 positions; required.

City The cst_city from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 25 positions; required.

State The cst_state from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 10 positions; required if specified for country.

Country The cst_country from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 3 positions; required.

Job title The cst_job_title flag from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 10 positions; optional.

Exempt status The cst_tax_exempt flag from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 1 positions optional.

Cert# (Certificate number)

The cst_exempt_certificate from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 15 positions; optional.

Field Description

CWSerenade 5.0


Day phone The cst_day_phone and cst_day_ext from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 14 positions (phone number) and 4 positions (extension); optional.

Expiry date The cst_exempt_expiry from the Inbound Customer Message (CWCustomerIn).Numeric, 8 positions; optional.

VAT The cst_vat_nbr from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 20 positions; optional.

Eve phone (Evening phone)

The cst_eve_phone and cst_eve_ext from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 14 positions (phone number) and 4 positions (extension); optional.

Orig source (Original source)

The cst_original_source from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 9 positions; optional.

Email sts (Email status)

The cst_email_status from the Inbound Customer Message (CWCustomerIn). The value specified in the Default Opt In/Opt Out Flag (G97) system control value defaults here if no status was specified in the inbound message.Note: The system displays an error message at this screen if the email status is missing or invalid for the email address specified for the Add or Change request. See Work with Customer API Email Screen.Alphanumeric, 2 positions; optional.

Assoc (Associate) The cst_associate flag from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 1 position; optional.

Fax The cst_fax_phone and cst_fax_ext from the Inbound Customer Message (CWCustomerIn).Note: The Third Phone Number Type (L53) system control value determines whether the third phone number is labeled the Fax or Mobile number here, and on reports and other screens.Alphanumeric, 14 positions (phone number) and 4 positions (extension); optional.

Curr source (Current source)

The cst_current_source from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 9 positions; optional.

Field Description

CWSerenade 5.0


Rent email The cst_rent_email flag from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 1 position; optional.

Can BO (Cancel backorder)

The cst_cancel_bo flag from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 1 position; optional.

Byp rsv (Bypass reservation)

The cst_bypass_reservation flag from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 1 position; optional.

Discount% The cst_discount_pct from the Inbound Customer Message (CWCustomerIn).Numeric, 5 positions with a 2-place decimal; optional.

Sls # (Salesrep #) The cst_salesman_nbr from the Inbound Customer Message (CWCustomerIn).Numeric, 7 positions; optional.

Do not fax The cst_do_not_fax flag from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 1 position; optional.

Col (Column) The cst_price_column from the Inbound Customer Message (CWCustomerIn).Numeric, 2 positions; optional.

Item track The cst_item_hist_tracking flag from the Inbound Customer Message (CWCustomerIn).Valid values:• No Item Tracking• Sold To Tracking Only• Sold To + Ship To TrackingOptional.

User 1-4 The cst_user_field_1, cst_user_field_2, cst_user_field_3, and cst_user_field_4 from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 10 positions each; optional.

Relate Id The cst_relate_id from the Inbound Customer Message (CWCustomerIn). Alphanumeric, 32 positions; display-only.

Pop up 1-2 The cst_pop_window_1and cst_pop_window_2 from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 20 positions each; optional.

Field Description

CWSerenade 5.0


Completing this screen: Complete or correct each required field. See Inbound Customer Message (CWCustomerIn) for more information on how each field is derived and validated.

Note:

• The system displays an error message at this screen if there is an error with the Customer API UDF Work table or the Customer API E-mail Work table. See below for more information on how to advance to the correct screens to correct these errors.

• The system displays the Display Duplicate Sold To window if the customer information in an Add request matches an existing customer. See Adding a Customer using the Customer API for more information.

Reserve Warehouse

The cst_reserve_warehouse from the Inbound Customer Message (CWCustomerIn).The warehouse must be an allocatable warehouse (the Allocatable flag for the warehouse is selected). Warehouse codes are defined in and validated against the Warehouse table. Numeric, 3 positions; optional.

Pop up 3-4 The cst_pop_window_3 and cst_pop_window_4 from the Inbound Customer Message (CWCustomerIn).Alphanumeric, 20 positions each; optional.

Van Route The cst_van_route from the Inbound Customer Message (CWCustomerIn).The van route must be a valid van route for the Reserve warehouse. You cannot enter a van route if a Reserve warehouse is not specified. Van routes are defined in and validated against the Warehouse Van Route table. Alphanumeric, 4 positions; optional.

Van Sequence # The cst_van_route_seq from the Inbound Customer Message (CWCustomerIn). You cannot enter a van sequence number if a Van route is not specified.Numeric, 4 positions; optional.

Option Procedure

Work with user-defined fields for the customer API request

Select User fields to advance to the Work with Customer API User Field Screen.

Work with email addresses for the customer API request

Select Email to advance to the Work with Customer API Email Screen.

Field Description

CWSerenade 5.0


Work with Customer API User Field Screen

Purpose: Use this screen to review or work with customer user-defined field information passed in the CustUserDefinedField element of the Inbound Customer Message (CWCustomerIn).

How to display this screen: Select User defined fields for a record at the Work with Customer API Screen, or select User fields at the Change Customer API Screen.

Field Description

Customer The cst_cust_nbr from the Inbound Customer Message (CWCustomerIn), or assigned by the system if this is an Add request. The name of the customer is displayed to the right.Number: numeric, 9 positions; display-only.Name: alphanumeric, 41 positions; display-only.

Seq The cst_udf_seq from the CustUserDefinedField element of the Inbound Customer Message (CWCustomerIn). This sequence number identifies the type of user-defined field required. See Work with User Fields Screen for more information.Numeric, 9 positions; display-only.

Text The cst_udf_text from the CustUserDefinedField element of the Inbound Customer Message (CWCustomerIn). Alphanumeric, 30 positions; display-only.

Number The cst_udf_nbr from the CustUserDefinedField element of the Inbound Customer Message (CWCustomerIn). Alphanumeric, 30 positions; display-only.

Date The cst_udf_date from the CustUserDefinedField element of the Inbound Customer Message (CWCustomerIn). Alphanumeric, 30 positions; display-only.

Option Procedure

Change user-defined field information Select Change for a user-defined field to advance to the Change Customer API User Field Screen.

Delete user-defined field information Select Delete for a user-defined field to delete it.

CWSerenade 5.0


Change Customer API User Field Screen

Purpose: Use this screen to review or change the user-defined field information in a customer API Add or Change request.

Correcting user-defined field information: The user-defined field information passed in the Inbound Customer Message (CWCustomerIn) must match the type (text, number, or date) based on the sequence number for the user-defined field detail, or the customer API Add or Change request will be in error. Each customer API user field record must include one of these types of data.

How to display this screen: Select Change for a record at the Work with Customer API User Field Screen.

Field Description


Just one of the following fields must be completed. The type of field must match the sequence number for the user-defined field detail. See Work with User Fields Screen for more information.

Text The cst_udf_text from the CustUserDefinedField element of the Inbound Customer Message (CWCustomerIn). Alphanumeric, 30 positions; optional.

Number The cst_udf_nbr from the CustUserDefinedField element of the Inbound Customer Message (CWCustomerIn). Alphanumeric, 30 positions; optional.

Date The cst_udf_date from the CustUserDefinedField element of the Inbound Customer Message (CWCustomerIn). Alphanumeric, 30 positions; optional.

CWSerenade 5.0


Work with Customer API Email Screen

Purpose: Use this screen to review the email addresses included in the CustEmail element of the Inbound Customer Message (CWCustomerIn), or to select an email address for review or update.

How to display this screen: Select Email for an Add or Change request at the Work with Customer API Screen or select Email at the Change Customer API Screen.

Field Description


Email address The cst_email_address from the CustEmail element of the Inbound Customer Message (CWCustomerIn). Alphanumeric, 50 positions; display-only.

Status The cst_email_status from the CustEmail element of the Inbound Customer Message (CWCustomerIn).Alphanumeric, 2 positions; display-only.

Fmt (Format) The cst_email_format from the CustEmail element of the Inbound Customer Message (CWCustomerIn).Alphanumeric, 1 position; display-only.

Prm (Primary) The cst_email_primary flag from the CustEmail element of the Inbound Customer Message (CWCustomerIn).Alphanumeric, 1 position; display-only.

Option Procedure

Change an email address in an Add or Change request

Select Change for an email address to advance to the Change Customer API Email Screen.

Delete an email address in an Add or Change request

Select Delete for an email address to delete the email address from the Add or Change request.

CWSerenade 5.0


Change Customer API Email Screen

Purpose: Use this screen to review or change the email address information included in a customer API Add or Change request.

How to display this screen: Select Change for an email address at the Work with Customer API Email Screen.

Field Description


Email address The cst_email_address from the CustEmail element of the Inbound Customer Message (CWCustomerIn). Alphanumeric, 50 positions; required.

Email status The cst_email_status from the CustEmail element of the Inbound Customer Message (CWCustomerIn). If no status is specified here, the cst_email_status from the CustSoldTo element defaults; and if no status is specified there, then the value from the Default Opt In/Opt Out Flag (G97) system control value defaults to both.Alphanumeric, 2 positions; required.

Email format The cst_email_format from the CustEmail element of the Inbound Customer Message (CWCustomerIn).Alphanumeric, 1 position; optional.

Display name The cst_display_name from the CustEmail element of the Inbound Customer Message (CWCustomerIn).Alphanumeric, 50 positions; optional.

Primary The cst_email_primary flag from the CustEmail element of the Inbound Customer Message (CWCustomerIn).Alphanumeric, 1 position; optional.

3/24/15 Generic Customer History API 382

Generic Customer History API

Purpose: Use the generic customer history integration to provide a customer’s order history, or detailed information about a single order, to an external system such as CWStore. The external system can request and receive information on:

• all orders for the customer, a limited number of the customer’s most recent orders, or a single order

• all orders regardless of channel, such as e-commerce orders, or excluding a particular channel

• all ship-to’s for a multi-recipient order, or a particular ship-to

• detailed information that includes all items, payment methods, and ship-to’s on the order, or summary information about the header only

What’s required? The external system must pass either the customer number or the alternate customer number in the customer or order history request.

In this topic:

• Typical Flow

• When is the Response Message Empty?

• Setup Requirements

• Customer History Request XML Message (CWCustHistIn)

• Customer History Request Message: Sample XMLs

• Customer History Response XML Message (CWCustHistOut)

• Customer History Response Message: Sample XML

• Detailed Order Inquiry Response XML Message (CWORDEROUT)

• Detailed Order Inquiry Response Message: Sample XML

• Summary Order Inquiry Response XML Message (CWORDEROUT)

• Summary Order Inquiry Response Message: Sample XML

Typical Flow

A typical customer history inquiry flow would begin when a customer in a retail store has a question about an order placed in CWSerenade.

1. The store clerk inquires on history for the customer.

CWSerenade 5.0


2. The customer history request is processed:

• CWStore sends a customer history request message to CWIntegrate. The message uses the customer number in CWStore, which is the same as the alternate customer number in CWSerenade. Typically, the request limits the number of orders in the response to no more than 15, in order to insure an acceptable response time.

• CWIntegrate translates CWStore’s request message to the Customer History Request XML Message (CWCustHistIn) and sends it to the queue specified for the CUST_HIST process running in Work with Integration Layer Processes (IJCT) in CWSerenade.

• The CUST_HIST process sends the Customer History Response XML Message (CWCustHistOut), listing the customer’s orders, to CWIntegrate.

• CWIntegrate translates the response to CWStore’s format and sends it to CWStore.

3. CWStore presents the list of orders, and summary information about each, onscreen.

4. The store clerk selects an order from the list for further inquiry.

5. The order inquiry request is processed:

• CWStore again generates the Customer History Request XML Message (CWCustHistIn); however, this request includes the specific order number or alternate order number (such as the CWStore transaction number), and the send_detail flag is set to Y.

• The CUST_HIST process in CWSerenade generates the Detailed Order Inquiry Response XML Message (CWORDEROUT), listing detailed information about the selected order, and sends it to CWIntegrate. The detailed information includes sold-to, ship-to, and bill-to addresses, payment methods, items, and shipments.

• CWIntegrate translates the order history response and sends it to CWStore.

6. CWStore displays the detailed information about the order onscreen.

CWSerenade 5.0


Alternate flow: Alternately, if the store clerk or customer know the specific order number for inquiry, they can start by sending the request message based on the order number, and use the send_detail flag to indicate whether CWSerenade should send the full Detailed Order Inquiry Response XML Message (CWORDEROUT), or just the Summary Order Inquiry Response XML Message (CWORDEROUT) as a quick confirmation.

Requests from multiple systems: You can have the CUST_HIST process respond to customer history requests from multiple external systems by setting up a process queue for each system. For example, you can set up a process queue for both a retail store and a web storefront so you can send customer history to each of them.

Are orders in error or suspended status included? Orders that are in error (E) or suspended (S) status are not included in the customer history response; however, if the order history request specifies an order in error or suspended status, the system provides information on that order in the order history response.

Are quotes included? the system includes quotes in the customer history response.

Finding the correct customer for the history request: Optionally, you can use this integration together with the customer inquiry (search) integration in order to enable an external system to first identify the customer record before requesting history for the specific customer. See Generic Customer Inquiry (Search) API in the online help for an overview of how you might use the customer inquiry (search) integration to find a customer’s customer number.

When is the Response Message Empty?

The CUST_HIST process sends an “empty” response when the request does not include sufficient valid data. The empty response indicates to the external system that CWSerenade received the request, but it was incomplete or invalid. For example, the process sends an empty response when the request includes:

• an invalid company, or no company indicated.

CWSerenade 5.0


• an invalid customer_number or alternate_sold_to_id.

• a customer_number that is not consistent with the specified alternate_sold_to_id.

• a customer that has no orders.

• a customer_number or alternate_sold_to_id that is not the sold-to customer for the specified direct_order_number or alternate_order_number.

• a last_name or postal_code without a specified direct_order_number or alternate_order_number.

• a last_name that is not the last name of the sold-to customer for the specified direct_order_number or alternate_order_number.

• a postal_code that is not the postal code of the sold-to customer for the specified direct_order_number or alternate_order_number.

• if the Require Last Name/Postal Code in Customer HIstory Request (L76) system control value is selected, a valid direct_order_number or alternate_order_number without a valid customer_number, alternate_sold_to_id, last_name, or postal_code also specified.

• an invalid direct_order_number or alternate_order_number. Note: The alternate_order_number passed in the request message must be uppercase for the system to find the order based on alternate order number.

• a direct_order_ship_to_nbr and a direct_order_number or alternate_order_number that is not consistent with the ship-to number. For example, a ship-to number of 3 is indicated, but the specified order has only 2 ship-to’s.

• a customer who does not have any orders except those in the specified exclude_order_channel.

Depending on the type of information included in the request, the empty response resembles one of the following:

If the request includes information on the customer:

If the request includes information on the order:

<Message source="RDC" target="IDC" type="CWCUSTHISTOUT"> <Headers> </Headers></Message>

<Message source="RDC" target="IDC" type="CWORDEROUT"></Message>

CWSerenade 5.0


Setup Requirements

To use the customer history API, you need to configure the CUST_HIST process in Work with Integration Layer Processes (IJCT), and send a correctly formatted Customer History Request XML Message (CWCustHistIn) to a queue specified for the job. Similarly, you must be prepared to receive the responses described in this topic. Typically, you would use CWIntegrate to generate the request message and translate the response message.

You can use CWIntegrate for a seamless integration with CWStore version 7.8 or higher, but the CUST_HIST process will process customer history requests from any source as long as the XML files are correctly formatted and contain the required information. More information on using the customer history API as part of the point of sale integration with CWStore will be provided in the CWSerenade/CWStore Integration manual.

Note: You can also use the CWMessageIn web service to avoid the necessity of starting and stopping the CUST_HIST process. See Generic Web Services in the online help for more information.


You can use the CWMessageIn web service to route Customer History messages. In this situation, the target for each inbound message must match the Inbound program name for the integration layer process queue, as specified at the Integration Layer Process Queue screen.

The CUST_HIST integration layer process can remain inactive and a queue is not required if the target is CUSTHISTIN in the XML message.




CWSerenade 5.0


Customer History Request XML Message (CWCustHistIn)

Important: Please note the following rules for numeric fields:

• Do not pass an alphanumeric value in a numeric field; doing so will cause the CUST_HIST process to go into a message wait status.

• Do not exceed the specified length of any numeric field; doing so will cause the value to be interpreted incorrectly.

• Alphanumeric fields are case-sensitive; an a is not equivalent to an A.

Important guidelines for best performance: For best response time when requesting customer history, you should limit the request to no more than 15 orders based on the number_of_orders attribute.


• Typical Flow for a discussion of when you might use this message.

• Customer History Request Message: Sample XMLs for sample messages.

• Generic Customer History API for an overview.


Message

source alpha 25 Identifies the source of the XML message. IDC indicates the XML message is from CWIntegrate.

target alpha 25 Identifies the target of the XML message. RDC indicates the XML message is sent to CWSerenade.

type alpha 25 CUSTHISTIN

resp_qmgr alpha 25 Identifies the destination queue manager (if using WebSphere MQ) or connection factory (if using HornetQ).

resp_q alpha 25 Identifies the destination queue.

CustomerHistoryRequest

CWSerenade 5.0


company numeric 3 Required. Indicates the company associated with the customer. Validated against the Company table.See When is the Response Message Empty? for information on when the CUST_HIST process sends an “empty” response based on the company number indicated.

Note: If the request includes either the customer_number or alternate_sold_to_id, the CUST_HIST process generates the Customer History Response XML Message (CWCustHistOut).

customer_number numeric 9 Indicates the customer number for the sold-to customer on the order. Validated against the Customer Sold To table. To retrieve customer history by customer, the request can specify either the customer_number or the alternate_sold_to_id, below.See When is the Response Message Empty? for information on when the CUST_HIST process sends an “empty” response based on the customer_number indicated.


alpha 15 Indicates the Alt cust (Alternate customer number) or one of the alternate customer number cross-references for the sold-to customer. Typically, the alternate customer number identifies the customer in an external system, such as CWStore. This is the Interface customer code in the Customer Sold To table. The system also checks the Alternate Customer Number Cross Reference table for matches.


CWSerenade 5.0


If there is more than one customer with a matching alternate customer number, the CUST_HIST process selects the one created last, based on customer number. For example, if both customer 101 and customer 201 have alternate customer 400, the CUST_HIST process selects customer 201.See When is the Response Message Empty? for information on when the CUST_HIST process sends an “empty” response based on the alternate_sold_to_id indicated.Note: Selecting based on alternate customer number is not implemented with ghost customers.

number_of_orders numeric 5 Indicates the maximum number of orders to include in the response message. The CUST_HIST process uses this number only if the request is based on the customer_number or alternate_sold_to_id.

Note: Although this attribute is optional, MICROS recommends that you limit a request based on customer information to no more than 15 orders to prevent a negative effect on response time. For example, if response time for a customer with 100 orders is about 30 seconds, restricting the number of orders to 15 reduces response time to five or six seconds.

If the request restricts the number of orders, the response includes only the most recent orders.

Note: If the request specifies either the direct_order_number or the alternate_order_number, the CUST_HIST process generates:• the Detailed Order Inquiry Response XML Message (CWORDEROUT) if the send_detail flag is set to Y.• the Summary Order Inquiry Response XML Message (CWORDEROUT) if the send_detail flag is set to N.


CWSerenade 5.0


direct_order_number

numeric 8 Indicates a single order to include in the response. If you pass an order number and the Require Last Name/Postal Code in Customer History Request (L76) system control value is selected, you must also pass a valid customer_number, alternate_sold_to_id, last_name, or postal_code. See When is the Response Message Empty? for information on when the CUST_HIST process sends an “empty” response based on the direct_order_number indicated.

direct_order_ship_to_nbr

numeric 3 Optional. Identifies the shipping address to include on a multiple ship-to order. In order inquiry, the ship-to number appears as a suffix to the order number, separated by a hyphen (-).See When is the Response Message Empty? for information on when the CUST_HIST process sends an “empty” response based on the direct_order_ship_to_nbr indicated.


CWSerenade 5.0


alternate_order_number

alpha 30 Indicates the order number used in an external system, such as CWStore, and stored in the E-commerce order number field in the Order Header Extended table. This field is labeled the Web order number at the Display Order Properties screen.Note: This field is case-sensitive. Since the E-commerce order number is stored in uppercase in the Order Header Extended table, the number passed in the request message must also be uppercase in order to match the order.Ignored if the request also includes a direct_order_number.If you pass an alternate order number and the Require Last Name/Postal Code in Customer History Request (L76) system control value is selected, you must also pass a valid customer_number, alternate_sold_to_id, last_name, or postal_code. See When is the Response Message Empty? for information on when the CUST_HIST process sends an “empty” response based on the alternate_order_number indicated.


CWSerenade 5.0


send_detail alpha 1 Indicates whether to send detail or summary information in the response message. Valid values are:• Y = Send the Detailed Order Inquiry Response XML Message (CWORDEROUT)• N = Send the Summary Order Inquiry Response XML Message (CWORDEROUT)This flag is not used when the request is based on the customer_number or alternate_sold_to_id; in this case, the CUST_HIST process always sends the Customer History Response XML Message (CWCustHistOut).If the send_detail setting is not included in the request, the CUST_HIST process sends the Summary Order Inquiry Response XML Message (CWORDEROUT).

exclude_order_channel

alpha 1 Optional. Indicates a specific order channel, such as retail orders, to exclude from the Customer History Response XML Message (CWCustHistOut). The CUST_HIST process checks the Internet order field in the Order Header table for the order channel. However, the CUST_HIST process does not consider this setting when the request is based on direct_order_number or alternate_order_number.


CWSerenade 5.0


Customer History Request Message: Sample XMLs

Samples of the Customer History Request XML Message (CWCustHistIn) are presented below.

Customer History Request by Customer: If the request includes either the customer_number or alternate_sold_to_id, the CUST_HIST process generates the Customer History Response XML Message (CWCustHistOut).

<Message source="IDC" target="RDC" type="CWCUSTHISTIN" resp_qmgr="IDCSRV" resp_q="STORE_CLIENT.TO.IDCSRV.CUST_HIST.V78">

<CustomerHistoryRequest company="555" alternate_sold_to_id="6" number_of_orders="15" send_detail="N" exclude_order_channel="K" />

</Message>

last_name alpha 25 The last name of the sold-to customer on the order. Validated against the Customer Sold To table. Ignored if the request also includes a customer_number or alternate_sold_to_id.See When is the Response Message Empty? for information on when the CUST_HIST process sends an “empty” response based on the last_name indicated.Available in XML version: 2.0 (version 3.5 of CWSerenade).

postal_code alpha 10 The postal code of the sold-to customer on the order; the system considers the postal code a match if the first 5 positions of the postal code match. For example, if the postal code on the order is 01468-1566, you can pass 01468-1566, 01468-1234, or 01468 to match. Validated against the Customer Sold To table. Ignored if the request also includes a customer_number or alternate_sold_to_id.See When is the Response Message Empty? for information on when the CUST_HIST process sends an “empty” response based on the postal_code indicated.Available in XML version: 2.0 (version 3.5 of CWSerenade).


CWSerenade 5.0


Customer History Request by Order (Detail): If the request specifies either the direct_order_number or the alternate_order_number, the CUST_HIST process generates the Detailed Order Inquiry Response XML Message (CWORDEROUT) if the send_detail flag is set to Y.

<Message source="IDC" target="RDC" type="CWCUSTHISTIN" resp_qmgr="IDCSRV" resp_q="OPSWEB.FROM.CWIAS400.CUST_HIST.75Q">

<CustomerHistoryRequest company="555" alternate_sold_to_id="6" number_of_orders="15" direct_order_number="7829" direct_order_ship_to_nbr="1" send_detail="Y" exclude_order_channel="K" />

</Message>

Customer History Request by Order (Summary): If the request specifies either the direct_order_number or the alternate_order_number, the CUST_HIST process generates the Summary Order Inquiry Response XML Message (CWORDEROUT) if the send_detail flag is set to N.

<Message source="IDC" target="RDC" type="CWCUSTHISTIN" resp_qmgr="IDCSRV" resp_q="OPSWEB.FROM.CWIAS400.CUST_HIST.75Q">

<CustomerHistoryRequest company="555" alternate_sold_to_id="6" number_of_orders="15" direct_order_number="7829" direct_order_ship_to_nbr="1" send_detail="N" exclude_order_channel="K" />

</Message>

CWSerenade 5.0


Customer History Response XML Message (CWCustHistOut)

When the Customer History Request XML Message (CWCustHistIn) includes customer information, the CUST_HIST process generates an XML response laid out as follows.

Note:


• Numeric fields use implied decimals; for example, a value of $12.34 is presented as 1234.


• Detailed Order Inquiry Response XML Message (CWORDEROUT) for descriptions of each attribute.


• Customer History Response Message: Sample XML for a sample message.

Message

• source

• target

• type

Header

• company_code

• order_id

• reference_order_number

• customer_number

• alternate_sold_to_id

• bill_to_number

• order_date

CWSerenade 5.0


• order_channel

• bill_me_later_ind

ShipTo

• ship_to_number

• sub_total

• discount_total

• shipping

• additional_shipping

• tax

• additional_charges

• handling

• order_total

• gst

• pst

• ship_to_status

• gift_order

• purchase_order_nbr

• discount_pct

• ship_via_code

• ship_via_description

• customer_number

• permanent_ship_to_number

Customer History Response Message: Sample XML

A sample of the Customer History Response XML Message (CWCustHistOut) is presented below. The CUST_HIST process generates this message if the Customer History Request XML Message (CWCustHistIn) includes either the customer_number or alternate_sold_to_id.

<Message source="RDC" target="IDC" type="CWCUSTHISTOUT"><Headers>

<Header company_code="555" order_id="7829" reference_order_number="104052" customer_number="6" alternate_sold_to_id="6" bill_to_number="3" order_date="01042006" order_channel="I" bill_me_later_ind="N" >

CWSerenade 5.0


<ShipTos><ShipTo ship_to_number="1" sub_total="500" shipping="50" tax="25" order_total="575" gift_order="N" ship_via_code="1" ship_via_description="UPS GROUND" ></ShipTo>

</ShipTos></Header><Header company_code="555" order_id="7828" reference_order_number="104051" customer_number="6" alternate_sold_to_id="6" bill_to_number="3" order_date="01042006" order_channel="I" bill_me_later_ind="N" >


</ShipTos></Header><Header company_code="555" order_id="7827" customer_number="6" alternate_sold_to_id="6" bill_to_number="3" order_date="10302006" bill_me_later_ind="N" >









<ShipTos>

CWSerenade 5.0


<ShipTo ship_to_number="1" sub_total="1000" shipping="100" tax="50" order_total="1150" gift_order="N" ship_via_code="1" ship_via_description="UPS GROUND" ></ShipTo>












<ShipTos>

CWSerenade 5.0


<ShipTo ship_to_number="1" sub_total="1000" shipping="100" tax="50" order_total="1150" gift_order="N" ship_via_code="1" ship_via_description="UPS GROUND" ></ShipTo>




<ShipTos><ShipTo ship_to_number="1" sub_total="1000" shipping="100" tax="50" order_total="1150" ship_to_status="X" gift_order="N" ship_via_code="1" ship_via_description="UPS GROUND" ></ShipTo>



</ShipTos></Header>

</Headers></Message>

CWSerenade 5.0


Detailed Order Inquiry Response XML Message (CWORDEROUT)

When the Customer History Request XML Message (CWCustHistIn) includes order information and the send_detail attribute is set to Y, the CUST_HIST process generates an XML response laid out as follows.


• Summary Order Inquiry Response XML Message (CWORDEROUT) for information on the response generated when the Customer History Request XML Message (CWCustHistIn) includes order information and the send_detail attribute is set to N.


• Detailed Order Inquiry Response Message: Sample XML for a sample message.

Note: The Version out setting of the ORDER_IN job, rather than the CUST_HIST job, controls the outbound version setting of the CWORDEROUT message.

.


Message

source alpha 25 Identifies the source of the XML message. RDC indicates the XML message originates from CWSerenade.

target alpha 25 Identifies the target of the XML message. IDC indicates the XML message is sent to CWIntegrate.

type alpha 25 Identifies the type of information in the XML message.

Header

CWSerenade 5.0


company_code numeric 3 Indicates the company associated with the customer.

order_id numeric 8 A unique number identifying the order. If the response includes multiple orders, it starts with the most recent order first and presents orders in descending sequence by order number.


alpha 30 The E-commerce order number in the Order Header Extended table, which is used to store an alternate order number, such as a sale transaction received from CWStore through the point of sale integration. This field is labeled the Web order number at the Display Order Properties screen.

customer_number numeric 9 A unique number identifying the sold-to customer.


alpha 15 The alternate customer number, if any, for the sold-to customer. Typically, the alternate customer number identifies the customer in an external system, such as CWStore.

bill_to_number numeric 7 The bill-to account number, if any, associated with the order.

order_date numeric 8 The Order date in the Order Header table. Displayed on the Order Inquiry Header screen. MMDDYYYY format.

order_channel alpha 2 From the Internet order field in the Order Header table. Typical settings are:• I = an internet order• P = a point of sale order• blank = an order taken in CWSerenade


CWSerenade 5.0


bill_me_later_ind alpha 1 Valid values are:• Y = The customer has an existing Bill Me Later account• N = The customer does not have an existing Bill Me Later accountThe system determines the setting of this flag based on whether there is an account number in the Customer Sold To BML table, regardless of whether the customer actually uses a Bill Me Later payment method on this order. For example, if the customer is applying for a Bill Me Later account with this order but it has not yet gone out for authorization, then this flag is set to N, because the account number has not yet been established.See Bill Me Later Processing in the online help for more information.

order_status alpha 1 The current status of the order. Valid values are:• C = Canceled• H = Held• X = Closed• E = Error• S = Suspended• Q = QuoteIncluded only if the status is not open (blank).Orders in error (E) or suspended (S) status are not included in the customer history response, although they are available through an order inquiry request and response .

order_type alpha 1 The Order type field in the Order Header table. Defined in and validated against the Order Type table.

order_type_description

alpha 30 The description from the Order Type table.


CWSerenade 5.0


b2b_order alpha 1 From the B2B order? flag in the Order Header table. Valid values are:• Y = This is a B2B order • N = This is not a B2B order This flag is set only for B2B orders and orders you receive through the Generic Order Interface (Order API).

store_restock_order

alpha 1 From the Store restock order? flag in the Order Header table. Valid values are:• Y = This is a retail store restock order.• N = This is not a retail store restock order Note: This flag is also set for orders you receive through the generic order API (e-commerce interface).

entered_date numeric 8 The Entered date in the Order Header table. MMDDYYYY format.

entered_time numeric 6 The Entered time in the Order Header table, which you can review at the Display Order Properties screen.

email_confirm_date

numeric 8 The date when the system generated an automatic email confirmation or the Outbound Email XML Message (CWEmailOut). From the Order Header table (Note: This field might be listed as Future use date 1). MMDDYYYY format. Included only if an email confirmation or outbound XML message was generated.

source_code alpha 9 The source code from the order header.

offer_id alpha 3 The offer associated with the source code on the order header.

sales_rep_number numeric 7 The salesman number assigned to the order. From the SLS Salesman # field in the Order Header table. Available in XML version: 4.0 (release 2.5 of CWSerenade).


CWSerenade 5.0


sales_rep_name alphanumeric

30 The name of the salesman assigned to the order. From the SLS Name field in the Salesman table. Available in XML version: 4.0 (release 2.5 of CWSerenade).

Note: The sold-to name and address is from the Customer Sold To table. See Creating and Updating Sold-to Customers (WCST) in the online help for a description of the sold-to information that is included in the customer history response.

sold_to_prefix alpha 3

sold_to_fname alpha 15

sold_to_initial alpha 1

sold_to_lname alpha 25

sold_to_suffix alpha 3

sold_to_company alpha 30

sold_to_busres alpha 1

sold_to_address1 alpha 32




sold_to_apartment alpha 10

sold_to_city alpha 25

sold_to_state alpha 2

sold_to_state_description


sold_to_zip alpha 10

sold_to_country alpha 3

sold_to_day_phone

alpha 14

sold_to_eve_phone

alpha 14


CWSerenade 5.0


sold_to_fax_phone

alpha 14 The third (fax or mobile) number.

allow_rent alpha 1

allow_mail alpha 1

sold_to_opt_in alpha 2

ind_number numeric 3 The number identifying the individual placer of the order, if any.

Note: The bill-to name and address is from the Customer Bill To table. See Creating and Updating Bill-to Customers (WCBT) in the online help for a description of the bill-to information.

bill_to_prefix alpha 3

bill_to_fname alpha 15

bill_to_initial alpha 1

bill_to_lname alpha 25

bill_to_suffix alpha 3

bill_to_company alpha 30

bill_to_busres alpha 1

bill_to_address1 alpha 32




bill_to_apartment alpha 10

bill_to_city alpha 25

bill_to_state alpha 2

bill_to_state_description


bill_to_zip alpha 10

bill_to_country alpha 3

bill_to_day_phone alpha 14


CWSerenade 5.0


bill_to_eve_phone alpha 14

bill_to_fax_phone alpha 14 The third (fax or mobile) number.

sales_rep_number numeric 7 The salesman number assigned to the order. From the SLS Salesman # field in the Order Header table. Available in XML version: 4.0 (release 2.5 of CWSerenade).

sales_rep_name alphanumeric

30 The name of the salesman assigned to the order. From the SLS Name field in the Salesman table. Available in XML version: 4.0 (release 2.5 of CWSerenade).

Payment Note:

payment_seq_number

numeric 2 Indicates the sequence in which the payment methods were added to the order. From the Order Payment Method table.

pay_type numeric 2 A unique code to identify a form of payment. From the Pay Type table.

pay_type_desc alpha 30 The description associated with the pay type.

credit_card_nbr alpha 20 The customer’s credit card account number used on this order. Credit card pay types only.If you use credit card tokenization, this number may be a token rather than the actual credit card number. If you use credit card encryption, the credit card number in this message is not encrypted; however, the system encrypts the credit card number in the CWSerenade database.

credit_card_exp_dt

numeric 4 The month and year when the customer’s credit card number expires. MMYY format. Credit card pay types only.


CWSerenade 5.0


credit_card_auth_dt

numeric 8 The month, day, and year that your credit card authorization service confirmed or authorized the customer's credit card for the order, or you manually authorized the credit card. Included only if the authorization has not already been used. MMDDYYYY format.

credit_card_auth_nbr

alpha 7 The number you entered when you manually authorized the credit card, or that the authorization service assigned when authorizing the credit card. Included only if the authorization has not already been used.

check_nbr numeric 9 For a check pay type, a number identifying the customer’s check number.

gift_cert_nbr numeric 7 For a gift certificate or coupon pay type, a number identifying the gift certificate or coupon.

amt_to_chg numeric 9.2 The total dollar amount to charge against the payment method. Not included for the "catch-all" payment method on an order if there is more than one payment method.

start_date numeric 4 For a stored value card or debit card pay type, the date when the card is effective. MMYY format.

card_issue_nbr alpha 2 For a debit card pay type, an incremental number assigned by the bank to indicate how many times the card has been replaced due to loss or theft.

ShipTo Note:

ship_to_number numeric 3 A number to identify the shipping address on the order. In order inquiry, the ship-to number appears as a suffix to the order number, separated by a hyphen (-).

sub_total numeric 9.2 The merchandise total for this shipping address on the order. Note:


CWSerenade 5.0


discount_total numeric 9.2 The total discount for the shipping address, displayed at the Order Inquiry Header screen.

shipping numeric 7.2 The total freight charge for this shipping address.

additional_shipping

numeric 7.2 The total additional freight charge for this shipping address.

tax numeric 7.2 The total tax, excluding any hidden tax, for this shipping address.

additional_charges

numeric 7.2 The total additional charges for this shipping address.

handling numeric 7.2 The total special handling for this shipping address.

order_total numeric 11.2 The total of all merchandise, freight, tax, and charges for the shipping address.

gst numeric 7.2 The total Canadian Goods and Service Tax, if any, that applies to the order shipping address. The GST and the PST are included in the tax total.

pst numeric 7.2 The total Canadian Provincial Services Tax, if any, that applies to the order shipping address. The GST and the PST are included in the tax total.

ship_to_status alpha 1 Indicates the status of this shipping address. This status could differ from the order header if, for example, the order has multiple shipping addresses and you canceled just one. Included only if the status is not open (blank).

gift_order alpha 1 From the Gift order flag in the Order Ship To table; this is the Gift flag on the Display Order Properties screen. Valid values are:• Y = This is a gift order• N = This is not a gift order


CWSerenade 5.0


purchase_order_nbr

alpha 15 The purchase order number, if any, in the Order Ship To table; this is the Purchase order # on the Display Order Properties screen.

discount_pct numeric 5.2 The discount percentage, if any, from the Order Ship To table.

ship_via_code numeric 2 The ship via used for this shipping address, from the VIA ship via code in the Order Ship To table; this is the Ship via on the Display Order Properties screen.

ship_via_description

alpha 30 The description of the ship via, as set up through Work with Ship Via Codes (WVIA).

shipping_override alpha 1 Indicates whether the Freight override flag is set. Set to Y if there is a freight override; otherwise, not included. The Display Order Properties screen displays the Freight override flag on the order.

customer_number numeric 9 Included only if there is an order recipient.


numeric 3 Included only if the order uses a permanent ship-to.

Note: The ship-to name and address can default from the Customer Sold To (recipient customer), Customer Ship To (permanent ship-to), or Order Ship To tables (order-level shipping address), depending on the type of shipping address.

ship_to_prefix alpha 3

ship_to_fname alpha 15

ship_to_initial alpha 1

ship_to_lname alpha 25

ship_to_suffix alpha 3

ship_to_company alpha 30

ship_to_busres alpha 1

ship_to_address1 alpha 32




CWSerenade 5.0



ship_to_apartment alpha 10

ship_to_city alpha 25

ship_to_state alpha 2

ship_to_state_description


ship_to_zip alpha 10

ship_to_country alpha 3

cancel_date numeric 7 The date when the order will be canceled if all lines have not shipped, in MMDDYY format. The system will not reserve inventory one day prior to the cancellation date, because the order would not reach the customer in time. Any items that have not shipped one day prior to the cancellation date display on the Order Cancellation List. Customer service uses this list of pending order cancellations to contact each customer and request more time. If this is not possible, Customer Service must cancel the order manually through Order Maintenance. For pre-order quotes, this is the date the quote for an order expires. From the OST Cancel date field in the Order Ship To table. Available in XML version: 4.0 (release 2.5 of CWSerenade).

Detail Note:

line_seq_number numeric 5 A sequence number to identify each detail line on the order.

short_sku_number numeric 7 A unique number, assigned by the system and stored in the SKU table, to uniquely identify each item/SKU.

retail_ref_number numeric 15 A retail reference or alternate product number to identify the item/SKU. Stored in the SKU table.


CWSerenade 5.0


status alpha 1 The status of the order line. Valid values are:• B = Express Bill• C = Canceled• E = Error• H = Held• S = Soldout• X = ClosedA status code is not included if the order line status is open (blank).

alias_item alpha 12 An alternate item code, used to track sales for different placements of the item. From the Order Detail table; included only if there was an alias used to order the item/SKU.

item_id alpha 12 A unique code to identify an item.

item_description alpha 30 The description of the item.

sku alpha 14 The item’s unique characteristics, such as its color or style. Included only if the item has SKUs.

sku_description alpha 40 The description of the SKU.

actual_price numeric 7.2 The unit price of the item from the Order Detail table. Not included for free gift or no-charge items.

offer_price numeric 7.2 The unit price of the item as defined for the Item Offer or SKU offer and saved in the Order Detail table.


numeric 7.2 The Original Retail Price from the SKU table; this is the Original retail $ at the second Create/Change/Display SKU screen in Work with Items/SKUs.

drop_ship alpha 1 Valid values are:• Y = This is a drop-ship item• N = This is not a drop-ship item. If the item is reserved on the order detail line, this flag is set to N regardless of whether the item is flagged as a drop-ship in the Item table.


CWSerenade 5.0


detail_ship_via numeric 2 The ship via, if any, entered at the Work with Order Line screen as an override to the ship via on the order header.

The three following values are related to store pickup orders.

pickup_type alphanumeric

2 Set to SP for a store pickup order.


alphanumeric

10 A code identifying the system associated with the store pickup location. From the System Name in Locate for Point of Sale (L09) system control value. Passed only for a store pickup order.

pickup_location alphanumeric

10 A code identifying the location where the customer picks up the item. Passed only for a store pickup order.

order_quantity numeric 5 The total quantity of the item ordered on the detail line. This number is negative for returns you process by entering a negative quantity in order entry.

cancel_quantity numeric 5 Included only if any quantity of the item on the order has been canceled.

sold_out_quantity numeric 5 Included only if any quantity of the item on the order has been sold out.

ship_quantity numeric 5 Included only if any quantity of the item on the order has been shipped. This number is negative for returns you process by entering a negative quantity in order entry.

return_quantity numeric 5 Included only if any quantity of the item on the order has been returned. Not included for returns you process by entering a negative quantity in order entry.


CWSerenade 5.0


expected_ship_date

numeric 8 Indicates the date when the next purchase order you can use to fulfill this order line is expected, based on purchase order layering. MMDDYYYY format. This date is included for drop ship items only if the Assign Drop Ship Expected Ship Date (I59) system control value is selected. See that system control value for more information.

last_ship_date numeric 8 Included only if there has been a shipment, or if you processed a return by entering a negative quantity in order entry. MMDDYYYY format.

reserved_warehouse

numeric 3 The warehouse where the order detail line is currently reserved. Sent only if there is a reserve_quantity.

reserve_quantity numeric 5 Included only if any quantity of the item on the order is reserved.

tax numeric 10.5 The total tax amount applied to the order detail line.

gst_tax numeric 10.5 The total GST tax, if any, applied to the order detail line.

pst_tax numeric 10.5 The total PST tax, if any, applied to the order detail line.

set_seq_number numeric 3 Indicates the sequence number that uniquely identifies a set and its components on this order. The main set item and its components have the same set sequence number. This attribute is not included for items that are not part of a set.Available in XML version: 2.0 (release 1.1 of CWSerenade).

country_of_origin alpha 3 A code representing the country where the item originated. From the SKU Country of Origin field in the SKU table. Available in XML version: 4.0 (release 2.5 of CWSerenade).


CWSerenade 5.0


harmonize_code alphanumeric

16 A code that prints on customs documents for international shipments. If you charge duty on international orders, use this field to define the item’s duty rate. From the Harmonize code field in the SKU table. Available in XML version: 4.0 (release 2.5 of CWSerenade).

broker_status alphanumeric

15 The status of an Order Broker request. Included only for store pickup, ship-to-store, retail pickup, and delivery orders fulfilled through the Order Broker integration. Not included for brokered backorders. Possible broker_status values are listed below, with the related Order Broker statuses provided in parentheses if they are different:

• Accepted

• Acknowledged

• Canceled

• Error

• Fulfilling (Picking)

• In Process

• In Transit

• New

• Partially Fulfilled (Partial Fulfill)

• Pending Cancel

• Polled

• Received by Store

• Rejected

• Shipped



CWSerenade 5.0


line_locate_eligible

alphanumeric

1 Indicates if a backordered line meets the rules for a brokered backorder:

• the Send B/O to Locate (K08) system control value is selected

• the item is flagged as Locate eligible in the Item table

• the order is not:

• a gift order if the Order Broker Include Gift Orders (K14) system control value is unselected

• flagged to ship complete if the Order Broker Include Ship Complete Orders (L12) system control value is unselected

• a retail pickup, delivery, or ship-to-store order

• to a customer flagged to bypass reservation

• the order detail line:

• is in open status• is fully backordered• is not gift wrapped• does not have special handling• is not coordinate grouped if the

Order Broker Include Coordinate Grouped Orders (K13) is unselected

• does not have a future arrival date• is not excluded based on trigger

rules for the BROKER job• is not a drop ship item• does not have an open purchase

order that is expected within the Order Broker Due Date Threshold (K11)


CWSerenade 5.0


Note: This flag is included regardless of current order status provided the item is valid. Even if this flag is set to Y, it is possible that the line cannot be fulfilled as a brokered backorder if, for example, the Order Broker cannot find a location with the item available. It is also possible that the line was already submitted to the Order Broker, and then returned to normal backorder processing if the Order Broker did not find a location to fulfill it.Available in XML version: 6.0 (release 3.5 of CWSerenade).

ShipmentIncluded only if a quantity shipped or returned exists for the order line.

invoice_nbr numeric 7 A unique number to identify an invoice. The system creates an invoice when you confirm shipment or process a return.

invoice_ship_quantity

numeric 5 The total unit quantity of the item shipped and billed on this invoice. The quantity is negative for a return.

invoice_ship_date numeric 8 The date when the shipment was confirmed, or when the return was credited. MMDDYYYY format.


CWSerenade 5.0


invoice_tracking_nbr

alpha 30 From the Manifest Upload Audit table. The system includes all tracking numbers in the Manifest Upload Audit table that are defined for the invoice detail (for example, the item shipped in more than one carton). The tracking number in this table can come from the PC Manifesting Interface, Generic Pick In API, or Manually Confirming Shipments (MCON).Brokered backorders: Since there is no Manifest Upload Audit record for a brokered backorder, the message includes a tracking number if there is an Order Transaction History record of a shipment for the same date as the invoice. The system identifies the tracking number for an order line based on Order Transaction History notes, including:

• the line number in a note such as Ln#: 5 Shipped by Broker

• the tracking number in a note beginning with ----TRK#. Anything to the right of ----TRK#. in the invoice_tracking_nbr attribute. For example, if the Order Transaction History note is ----TRK#: GHI123, the invoice_tracking_nbr is GHI123.

Note: If the system writes the Order Transaction History for the shipment of a brokered backorder on a date that differs from the invoice date, then no tracking information is included in the customer history response. This situation might occur if, for example, CWSerenade receives the status update of the shipment before midnight, but the billing async job does not create the invoice until after the job is automatically stopped and restarted, so that the next date is assigned to the invoice.

invoice_ship_via_code

numeric 2 From the Manifest Upload Audit table. Not included for brokered backorders.


CWSerenade 5.0


Detailed Order Inquiry Response Message: Sample XML

A sample of the Detailed Order Inquiry Response XML Message (CWORDEROUT) is presented below. The CUST_HIST process generates this message if the Customer History Request XML Message (CWCustHistIn) specifies either the direct_order_number or the alternate_order_number and the send_detail flag is set to Y.

<Message source="RDC" target="IDC" type="CWORDEROUT"><Header company_code="555" order_id="7829" reference_order_number="104052" customer_number="6" alternate_sold_to_id="6" bill_to_number="3" order_date="01042006" order_channel="I" bill_me_later_ind="N" order_type="X" order_type_description="E-COMMERCE ORDER TYPE" b2b_order="N" store_restock_order="N" entered_date="01042006" entered_time="130723" source_code="2006" offer_id="205" sold_to_prefix="MS." sold_to_fname="MARY" sold_to_initial="T" sold_to_lname="JOHNSON" sold_to_busres="R" sold_to_address1="109 RIVER LN" sold_to_city="TEMPLETON" sold_to_state="MA" sold_to_state_description="MASSACHUSETTES" sold_to_zip="01468" sold_to_country="USA" sold_to_day_phone=" 978 555-2000" allow_rent="Y" allow_mail="Y" sold_to_opt_in="O1"

invoice_ship_via_desc

alpha 30 From the ship via description, as set up through Work with Ship Via Codes (WVIA). Brokered backorders: From the Order Transaction History note beginning with ----VIA. See the invoice_tracking_nbr, above, for a discussion.

invoice_ship_via_type

alpha 2 The one-position or two-position code that identifies the type of ship via. Included for brokered backorders only if the shipping agent passed from the Order Broker matches a valid ship via in CWSerenade.Available in XML version: 6.0 (release 3.5 of CWSerenade).

invoice_tracking_URL

alpha 300 The URL to use when linking to shipment tracking information on the shipper’s web site. Built from the record in the TRACKVIA table with a matching ship via type: for example, if the ship via type is FX, the tracking URL should create a link to the Federal Express web site. All Parcel Post ship via types (PP, P1, P2, P3, and P4) use the TRACKVIA record whose ship via type is PP. Included only if there is a ship via type in the TRACKVIA table that matches the ship via used.Available in XML version: 6.0 (release 3.5 of CWSerenade).


CWSerenade 5.0


bill_to_fname="MARY" bill_to_initial="T" bill_to_lname="JOHNSON" bill_to_busres="R" bill_to_address1="109 RIVER LN" bill_to_city="TEMPLETON" bill_to_state="MA" bill_to_state_description="MASSACHUSETTS" bill_to_zip="01468" bill_to_country="USA" >

<Payments><Payment payment_seq_number="1" pay_type="4" pay_type_desc="CAT 2 CC, C PAYMENTECH VISA" credit_card_nbr="4111111111111111" credit_card_exp_dt="1205" start_date="1204"/>


<ShipTo ship_to_number="1" sub_total="500" shipping="50" tax="25" order_total="575" gift_order="N" ship_via_code="1" ship_via_description="UPS GROUND" ship_to_prefix="MS." ship_to_fname="MARY" ship_to_initial="T" ship_to_lname="JOHNSON" ship_to_busres="R" ship_to_address1="109 RIVER LN" ship_to_city="TEMPLETON" ship_to_state="MA" ship_to_state_description="MASSACHUSETTS" ship_to_zip="01468" ship_to_country="USA" >

<Details><Detail line_seq_number="1" short_sku_number="1782" item_id="2005ITEM1" item_description="2005ITEM1 DESCRIPTION" actual_price="500" offer_price="500" drop_ship="N" order_quantity="1" reserved_warehouse="205" reserve_quantity="1"></Detail>

</Details></ShipTo>

</ShipTos></Header>

</Message>

CWSerenade 5.0


Summary Order Inquiry Response XML Message (CWORDEROUT)

When the Customer History Request XML Message (CWCustHistIn) includes order information and the send_detail attribute is set to N, the CUST_HIST process generates an XML response laid out as follows.

See Detailed Order Inquiry Response XML Message (CWORDEROUT) for information on the response generated when the Customer History Request XML Message (CWCustHistIn) includes order information and the send_detail attribute is set to Y.

For more information: See Detailed Order Inquiry Response XML Message (CWORDEROUT) for descriptions of each attribute. Also, see Typical Flow for a discussion of when you might use this message.

Message

• source

• target

• type

Header

• company_code

• order_id

• reference_order_number

• customer_number

• alternate_sold_to_id

• bill_to_number

• order_date

• order_channel

• bill_me_later_ind

Summary Order Inquiry Response Message: Sample XML

A sample of the Summary Order Inquiry Response XML Message (CWORDEROUT) is presented below. The CUST_HIST process generates this message if the Customer

CWSerenade 5.0


History Request XML Message (CWCustHistIn) specifies either the direct_order_number or the alternate_order_number and the send_detail flag is set to N.

<Message source="RDC" target="IDC" type="CWORDEROUT"><Header company_code="555" order_id="7829" reference_order_number="104052" customer_number="6" alternate_sold_to_id="6" bill_to_number="3" order_date="01042006" order_channel="I" bill_me_later_ind="N" ></Header>

</Message>

3/24/15 Generic Inventory Inquiry API 422

Generic Inventory Inquiry API

Purpose: Use the generic inventory inquiry integration to respond to requests from external systems for current inventory information.

What does the inventory inquiry request consist of? The request specifies an item/SKU within a company, and can restrict the request to a particular warehouse where you keep the item/SKU, or exclude non-allocatable or retail outlet warehouses. The external system can identify the item/SKU using the CWSerenade item and SKU codes; or, it can use the short SKU number, retail reference number, or UPC information.

What information does the inventory inquiry response include? The response includes information about the item/SKU, the warehouse(s) where it is stored, and current inventory levels such as the quantity on-hand, available, backordered, and so on. See the Inventory Inquiry Response XML Message (CWInventoryInquiryResponse) for a complete list of information.

Note: You can also integrate CWSerenade with Locate to support visibility into inventory availability across the enterprise.

In this topic:

• Typical Flow

• When is the Response Message Empty?

• Resolving the Item and SKU

• Setup Requirements

• Inventory Inquiry Request XML Message (CWInventoryInquiry)

• Inventory Inquiry Request: Sample XML

• Inventory Inquiry Response XML Message (CWInventoryInquiryResponse)

• Inventory Inquiry Response: Sample XML

Typical Flow

A typical inventory inquiry flow might be:

1. A customer at the web storefront inquires into the availability of an item.

2. The web storefront generates an inventory inquiry request to CWSerenade.

3. The INV_INQURY process in CWSerenade receives the request, generates the Inventory Inquiry Response XML Message (CWInventoryInquiryResponse), and sends it to the web storefront, where the availability information is presented to the customer.

CWSerenade 5.0


When is the Response Message Empty?

The INV_INQURY process sends an “empty” response when the request does not include sufficient valid data. The empty response indicates to the external system that the request was not lost, but it was incomplete or invalid. For example, the process sends an empty response when the request includes:

• an invalid company code, or no company indicated

• the item cannot be resolved (see below), including:

• a SKUed item with no SKU information specified• a SKU specified for a non-SKUed item

• a retail reference number that is assigned to more than one item/SKU

Resolving the Item and SKU

The inventory inquiry request can indicate the correct item and SKU through any one of the following:

1. item_number and sku_code: The sku_code is required if the item has SKUs, but should not be included for a non-SKU’d item. Validated against the Item and SKU tables.

2. short_sku: Validated against the Short SKU field in the SKU table.3. retail_reference_nbr: Validated against the Reference # in the SKU table.4. upc_type and upc_code: Both values must be specified. Validated against the Item

UPC table. Note: Include any leading zeros. For example, if the UPC code is 06012011, pass 06012011 and not 6012011.

In searching for an item and SKU, the system checks the values in the message in the order indicated above. If any value (or set of values, such as item_number and sku_code) is blank, it checks the next value, such as short_sku.

Once the system finds one of the values listed above in the message, it checks the related tables to find a match. For example, if the request does not specify an item_number, but does specify the short_sku, the system checks the Short SKU field in the SKU table. If there is a match, the system generates the inventory inquiry response. If a short SKU is specified but there is no match, the system sends an empty message. Alternatively, if the message includes an incorrect item code and a correct short SKU, the system sends an empty response message based on the item code; it never checks the short SKU.

<Message source="CWDirect" target="CWIntegrate" type="CWInventoryInquiryResponse" date="08052006" time="15:11:57" ></Message>

CWSerenade 5.0


Setup Requirements

To use the inventory inquiry API, you need to configure the INV_INQURY process in Work with Integration Layer Processes (IJCT), and have the external system send a correctly formatted Inventory Inquiry Request XML Message (CWInventoryInquiry) to a queue specified for the job. Similarly, the external system must be prepared to receive the response described under Inventory Inquiry Response XML Message (CWInventoryInquiryResponse). Typically, you would use CWIntegrate to generate the request message and translate the response message.

You can use CWIntegrate for a seamless integration with CWStore version 7.8 or later, but the INV_INQURY process will process inventory inquiry requests from any source as long as the XML files are correctly formatted and contain the required information.


You can use the CWMessageIn web service to route Inventory Inquiry messages. In this situation, the target for each inbound message must match the Inbound program name for the integration layer process queue, as specified at the Integration Layer Process Queue screen.

Web service authentication? The Require_Auth field in the Webservice table defines whether the web service requires basic web service authentication. See Working with Web Service Authentication (WWSA) in the online help for an overview.



CWSerenade 5.0


Inventory Inquiry Request XML Message (CWInventoryInquiry)

Important: Please note the following rules for numeric fields:

• Do not pass an alphanumeric value in a numeric field; doing so will cause the INV_INQURY process to go into a message wait status.

• Do not exceed the specified length of any numeric field; doing so will cause the value to be interpreted incorrectly.

General rules for alphanumeric fields:

• case-sensitive; an a is not equivalent to A.• will be truncated if they exceed the maximum length specified below; a

transaction_code of Adjustment will be truncated to A and processed correctly



• Inventory Inquiry Request: Sample XML for a sample message.

• Generic Inventory Inquiry API for an overview.


Message

source alpha 25 Identifies the source of the XML message. IDC indicates the XML message is from CWIntegrate.

target alpha 25 Identifies the target of the XML message. RDC indicates the XML message is sent to CWSerenade.

type alpha 25 Identifies the type of information in the XML message. Should be set to CWInventoryInquiry.

InventoryInquiry

CWSerenade 5.0


company numeric

3 Indicates the company associated with the item/SKU. Validated against the Company table.See When is the Response Message Empty? for information on when the INV_INQURY process sends an “empty” response based on the company number indicated.

Note: See Resolving the Item and SKU for an overview of how the INV_INQURY process uses the item_number, sku_code, short_sku, retail_reference_nbr, upc_type and upc_code attributes.

item_number alpha 12

sku_code alpha 14

short_sku numeric

7

retail_reference_nbr

numeric

15

upc_type alpha 3

upc_code alpha 14

warehouse numeric

3 If a warehouse is specified, the Inventory Inquiry Response XML Message (CWInventoryInquiryResponse) includes information for just that warehouse; otherwise, all warehouses where you keep the item/SKU are included (depending, also, on the exclude_non_allocatable and exclude_retail_outlet attributes). Validated against the Warehouse table. If the warehouse specified is invalid, the response does not include any warehouse information; however, it still includes the information on the item/SKU. Similarly, if there is no record of the item in the warehouse specified, the response does not include any warehouse information, even if the warehouse specified is valid.


CWSerenade 5.0


Inventory Inquiry Request: Sample XML

A sample of the Inventory Inquiry Request XML Message (CWInventoryInquiry) is presented below.

<Message source="5" target="CWDIRECT" type="CWInventoryInquiry"><InventoryInquiry company="5" item_number="KABSKU1 " sku_code="BLUE" exclude_non_allocatable="N" exclude_retail_outlet="N" />

</Message>

exclude_non_allocatable

alpha 1 Indicates whether the response should exclude any warehouse whose Allocatable flag is selected. This flag indicates whether merchandise in the warehouse can be reserved to fulfill consumer orders. A request might indicate to exclude non-allocatable warehouses because the inventory would not be available to a customer.If this attribute is set to Y, non-allocatable warehouses are excluded from the response; otherwise, the INV_INQURY process does not consider the setting of the Allocatable flag for a warehouse.

exclude_retail_outlet

alpha 1 Indicates whether the response should exclude any warehouse whose Retail store flag is selected. This flag indicates whether the warehouse represents a retail store rather than a true warehouse. A request might indicate to exclude retail outlets because these warehouses might actually represent retail locations, which receive and respond to inventory inquiry requests independently of CWSerenade.If this attribute is set to Y, retail outlet warehouses are excluded from the response; otherwise, the INV_INQURY process does not consider the setting of the Retail outlet for a warehouse.


CWSerenade 5.0


Inventory Inquiry Response XML Message (CWInventoryInquiryResponse)

The INV_INQURY process generates an XML response laid out as follows.

Note:



See Inventory Inquiry Response: Sample XML for a sample message and see Generic Inventory Inquiry API for an overview.


Message

source alpha 25 Identifies the source of the XML message. RDC indicates the XML message originates from CWSerenade.


type alpha 25 Identifies the type of information in the XML message. This will be CWInventoryInquiryResponse.

date numeric 8 The date the response is generated, in MMDDYYYY format.

time numeric 6 The time the response is generated, in HH:MM:SS format.

Item

CWSerenade 5.0


company numeric 3 Indicates the company associated with the item/SKU.

company_description

alpha 30 The description from the company.

item_number alpha 12 The item code, as set up through Work with Items (MITM).


item_2nd_lang_desc

alpha 40 The information in the Second language description, if any.

item_long_sku_style

alpha 20 The item’s long SKU style, if any.

non_inventory alpha 1 Indicates whether inventory levels are maintained for the item. Valid values are:Y = This is a non-inventory item.N (default) = This is a regular item that will be tracked.Because this flag defaults to N (unselected) in Work with Items (MITM), it is typically populated and included in the response message.

membership alpha 1 Indicates that the item represents a membership program, which you can use to generate periodic orders to a customer. Valid values are:Y = This is a membership itemN (default) = This is not a membership itemEven when an item is flagged as a membership item, it is still possible to have an item warehouse record if, for example, you specified a default warehouse when creating the item.Because this flag defaults to N (unselected) in Work with Items (MITM), it is typically populated and included in the response message.


CWSerenade 5.0


drop_ship_item alpha 1 Indicates whether you ship the item from your warehouse, or have your vendor ship it to the customer directly. Valid values are:Y = When a customer orders the item, you order the item from your vendor and the vendor ships it directly to your customer. However, it is still possible to ship the item from the warehouse if it is available there.N (default) = You ship the item from your warehouse.If there is a record of an item in a warehouse, this information is still provided in the response message regardless of the setting of this flag.Because this flag defaults to N (unselected) in Work with Items (MITM), it is typically populated and included in the response message.

item_status alpha 1 The item’s status, if any. An optional code that represents an item's status, such as obsolete, discontinued, etc. This information is used for inventory reporting purposes and to select items for physical inventory.

item_status_description

alpha 30 The description of the item status, if any.

kit_type alpha 1 The kit type setting, if any, for the item. Valid values are:C = Continuity programS = SetF = Finished goodsV = Variable set

long_sku_department

numeric 4 The long SKU department, if any, assigned to the item.

long_sku_department_desc

alpha 30 The description of the long SKU department, if any, as specified through Work with Long SKU Departments (WLSD).

long_sku_division alpha 3 The long SKU division, if any, assigned to the item’s long SKU department.


CWSerenade 5.0


long_sku_division_desc

alpha 30 The description of the long SKU division, as set up through Work with Long SKU Divisions (WLDV).

long_sku_class numeric 4 The long SKU class, if any, assigned to the item.

long_sku_class_desc

alpha 30 The description of the long SKU class, as set up through Work with Long SKU Classes (WLSC).

svc_type alpha 1 Indicates the type of stored value card that the item is, if it is a stored value card. Valid values are:P = Physical cardE = Physical card/early notificationV = Virtual card

SKU This element includes attributes that apply to both SKU’ed and non-SKU’ed items, so it is always included in the response.

sku_code alpha 14 The item’s unique characteristics; included if this is a SKU’ed item.

sku_description alpha 40 The SKU’s description, if any.

sku_2nd_lang_desc

alpha 40 The SKU’s second language description, if any.

sku_long_sku_style

alpha 20 The SKU’s long SKU style, if any. Can be different from the item_long_sku_style, if any.

short_sku numeric 7 The item or SKU’s short SKU code. This is a system-assigned code to uniquely identify each item/SKU.


numeric 15 The SKU’s retail reference number, if any. Typically, this is an alternate product ID.


CWSerenade 5.0


gift_certificate alpha 1 The setting, if any, of the gift certificate flag. Valid values are:Y = The item is a gift certificateN = The item is not a gift certificateBecause this flag is optional when you create an item/SKU, it might not contain a Y or N value; if not, it is not included in the response.

subscription alpha 1 The setting, if any, of the subscription flag. Valid values are:Y = Item is a subscription.N = Item is not a subscription.Even when an item is flagged as a subscription, it is still possible to have an item warehouse record if, for example, you specified a default warehouse when creating the item.Because this flag is optional when you create an item/SKU, it might not contain a Y or N value; if not, it is not included in the response.

sku_status alpha 1 The SKU’s status code, if any. Can be different from the item’s status.

sku_status_description

alpha 30 The description of the SKU’s status, if any.

so_control alpha 2 The SKU’s soldout control setting, if any. Validated against the Soldout Control table.

so_control_description

alpha 30 The description of the soldout control code, if any, as defined through Work with Soldout Controls (WSLD).


CWSerenade 5.0


so_control_status alpha 1 The status of the soldout control, if any. Possible statuses are:• 1 = Sellout the item/SKU immediately.• 2 = Sellout the item/SKU when the quantity available is zero, not including open purchase orders.• 3 = Sellout the item/SKU when the quantity available is equal to zero, including open purchase orders. (An item must be coded to sellout immediately in order to be picked up by Process Auto Soldout Cancellations (MASO).)

UPC The UPC element is included only if the item/SKU has one or more UPC codes.

upc alpha 14 A UPC code defined for the item/SKU.

upc_type alpha 3 The type of UPC code. The UPC type determines the type of validation the system performs against the UPC code.Valid values are:E13: EAN-13E8: EAN-8UA: UPC-AUE: UPC-E

upc_vendor numeric 7 A code that identifies a supplier who sells you merchandise.Vendor codes are defined in and validated against the Vendor table.

Warehouse The warehouse name and address information, if any, are defined in the Warehouse table. The system does not require you to specify address information when you create a warehouse.


CWSerenade 5.0


warehouse numeric 3 A code identifying the item/SKU’s primary warehouse, and each additional warehouse where you keep the item/SKU. Unless the request message specified a warehouse, the response includes each warehouse where you keep the item/SKU (depending, also, on the exclude_non_allocatable and exclude_retail_outlet settings in the request).

warehouse_name alpha 30

address_line_1 alpha 32



city alpha 25

state alpha 2

postal_code alpha 10

country alpha 3

drop_point numeric 3 The drop point assigned to the warehouse, used to identify the warehouse’s geographical location and for zone skipping.

drop_point_description

alpha 30 The description for the drop point, as set up through Work with Drop Points (WDPT).

manager alpha 30 The manager, if any, specified for the warehouse.

telephone_nbr alpha 14 The telephone number, if any, specified for the warehouse.

fax_nbr alpha 14 The fax number, if any, specified for the warehouse.


CWSerenade 5.0


allocatable_flag alpha 1 This flag indicates whether merchandise in the warehouse can be reserved to fulfill consumer orders. Valid values are:Y = Merchandise in this warehouse can be reserved to fulfill orders.N = Merchandise in the warehouse will not be used to fulfill orders. Examples of non-allocatable warehouses include non-saleable and defective item warehouses. If a warehouse is not flagged as allocatable, its on-hand quantity is not included in the availability calculation for items.

receive_restock_transfers

alpha 1 This flag indicates whether the warehouse replenishment request will remain on the system after the transfer has been confirmed when using the Replenish Warehouses function. Valid values are:Y = The replenishment request remains on the system when the restock shipment is confirmed. Retaining the request allows the receiving warehouse to use the request to process inventory transactions transferring merchandise from the Auto restock location to the warehouse locations where the items are stored. The request is deleted from the system when the merchandise is moved from the Auto restock location.N = The replenishment request is deleted from the system as soon as the restock shipment is confirmed (when the merchandise has been shipped to the receiving warehouse). The receiving warehouse must use the Inventory Transactions module to transfer the merchandise from the Auto restock location to the warehouse locations where the items are stored.


CWSerenade 5.0


inventory_value_gl_nbr

numeric 8 The warehouse’s inventory value general ledger number, if any. The system uses this number to post changes to inventory valuation resulting from purchase order receipts and order shipments if there is no inventory general ledger account number defined in the Item table.

value_inv_at_retail alpha 1 Not currently implemented.

viewable_in_oe alpha 1 This flag indicates whether item availability for the warehouse can be viewed in Order Entry. When you view item availability in Order Entry, a list of all viewable warehouses and the item quantity available in each warehouse displays. Valid values are:Y = Item quantities in this warehouse can be viewed in Order Entry.N = Item quantities in this warehouse cannot be viewed in Order Entry.

auto_restock_location

alpha 7 The location in the warehouse, if any, where transferred stock is placed when it is transferred using the standard replenish warehouses process or the retail store restock process. See Replenish Warehouses for more information on working with warehouse replenishment, and see Retail Stores for more information on working with retail store restock.

retail_outlet alpha 1 Indicates whether the warehouse represents a retail store rather than a true warehouse. Valid values are:Y = The warehouse represents a retail store location.N = The warehouse does not represent a retail store location.


CWSerenade 5.0


retail_type alpha 1 A setting of S indicates that the warehouse represents a retail outlet, which is available to fulfill backorders through the Retail Fulfillment process. The Retail Fulfillment process allows you to place a backordered item on hold while you are determining whether it is available for shipment from a retail outlet. Once you are notified that the retail outlet has shipped the item, you cancel the order line.

ItemWarehouse You can review item warehouse information through Work with Item Warehouse (in WWHS) and through Using Inventory Inquiry (DINI).

allocation_freeze alpha 1 The setting of the Reservation freeze flag for the item in this warehouse. Valid values are:Y = The item warehouse is frozen for the purposes of pick slip generation, reservation, and location or warehouse replenishment.N = The item warehouse is not frozen. When you create an item location through Work with Items (MITM), this is the default setting.

economic_order_qty

numeric 7 From the economic order quantity, if any, for the item warehouse. Used for reporting purposes. Represents the recommended optimum ordering quantity for this item/SKU, based on a set of criteria such as cost.

max_qty numeric 7 From the maximum quantity, if any, for the item warehouse. Represents the maximum amount of inventory on hand for this item/SKU, and is used by the Warehouse Replenishment program to determine when inventory should be transferred from one warehouse to another. Also, the system uses the maximum quantity during retail store restock to determine the restock order quantity for this item in the retail store.


CWSerenade 5.0


min_qty numeric 7 From the minimum quantity, if any, for the item warehouse. Represents the least amount of inventory to keep on-hand for this item/ SKU. Used by Replenish Warehouses to determine when inventory should be transferred from one warehouse to another, and during retail store restock to determine if an item is eligible for restock in the retail store.

on_hand_qty numeric 7 From the on-hand quantity, if any, for the item warehouse. Represents the number of units for this item across all locations in the warehouse. Calculated by the system.

backorder_qty numeric 7 From the backorder quantity, if any, for the item warehouse. Represents the quantity of the item/SKU in this warehouse that is currently on open orders but not available in your warehouse. Calculated by the system.

protected_qty numeric 7 From the protected quantity, if any, for the item warehouse. Represents the amount of inventory that cannot be reserved (using immediate or batch reservation) for this item/ SKU across all locations in this warehouse. The system uses this inventory only in Interactive Reservation.

reorder_qty numeric 7 From the reorder quantity, if any, for the item warehouse. Represents the quantity of this item/SKU that should be ordered when the item/SKU reaches the minimum stock level. Used in Replenish Warehouses to replenish the warehouse.

reserve_qty numeric 7 From the reserved quantity, if any, for the item warehouse. Represents the quantity of this item/SKU in this warehouse that is reserved for existing orders. This total increases through immediate, batch, and interactive reservation, and decreases through confirmation or pick void/reprint. Calculated by the system.


CWSerenade 5.0


sh_reserve_qty numeric 7 From the special handling reserved quantity, if any, for the item warehouse. Represents the quantity of this item/SKU in this warehouse that is reserved and flagged for some type of special handling, such as monogramming, hemming, etc. This total increases through reservation of items/SKUs assigned a special handling code in order entry or maintenance, and decreases through confirmation or pick void/reprint. Calculated by the system.

on_order_qty numeric 7 From the on order quantity, if any, for the item warehouse. Represents the total quantity of this item in this warehouse that is due to be received through purchase orders. Calculated by the system.

reserve_transfer_qty

numeric 7 From the Reserve transfer quantity, if any, for the item warehouse. Represents the quantity of the item that is earmarked for an inventory transfer as a result of the Autostock Replenishment by Warehouse program. This quantity is unavailable to the Reservation program for new orders.

available_qty numeric 7 From the available quantity, if any, for the item warehouse. Calculated by the system as follows:

On hand - Protected - Reserved - Reserve Transfer - Backordered = Quantity available

Drop ship items: If the item is flagged for drop ship, the available quantity indicated is 9999, regardless of whether there is any quantity of the item actually on-hand in the warehouse.


CWSerenade 5.0


next_po_date numeric 8 Indicates the date when the next purchase order you can use to fulfill this order line is expected, based on purchase order layering. MMDDYYYY format. This date is included for drop ship items only if the Assign Drop Ship Expected Ship Date (I59) system control value is selected. See that system control value for more information.

next_expected_qty numeric 7 The number of units of this item ordered on a purchase order that will be available for new orders.


numeric 7.2 From the Original retail price, if any, for the item warehouse. Represents the original price of this item in the retail store. You can use this field to track the original retail price for the item if the warehouse represents a retail store. The Use Retail Store File (G15) system control value controls access to this field.

current_retail_price

numeric 7.2 From the Current retail price, if any, for the item warehouse. Represents the current price of this item in the retail store. You can use this field to track the current retail price for the item if the warehouse represents a retail store. The Use Retail Store File (G15) system control value controls access to this field.

protect_current_price

numeric 1 The setting of the Protect current price flag for the item warehouse. Valid values are:Y = The system does not update the Current retail price when you define a new retail price in Work with Warehouse Values, and instead, keeps the existing price.N = The system updates the Current retail price with the retail price from Work with Warehouse Values.The Use Retail Store File (G15) system control value controls access to this field.


CWSerenade 5.0


Inventory Inquiry Response: Sample XML

A sample of the Inventory Inquiry Response XML Message (CWInventoryInquiryResponse) is presented below.

<Message source="CWDirect" target="CWIntegrate" type="CWInventoryInquiryResponse" date="05112006" time="15:05:59" >

<Item company="5" company_description="Country Creations (Kristen QA)" item_number="KABSKU1" item_description="TWO-DRAWER FILING CABINET" non_inventory="N" membership="N" drop_ship_item="N" long_sku_department="7654" long_sku_department_desc="7654 LONG SKU DEPARTMENT" long_sku_division="765" long_sku_division_desc="765 LONG SKU DIVISION" long_sku_class="6543" long_sku_class_desc="6543 LONG SKU CLASS" >

<SKU sku_code="BLUE" sku_description="NAVY BLUE FILING CABINET" short_sku="601"><Warehouses>

<Warehouse warehouse="1" warehouse_name="BOSTON WAREHOUSE" address_line_1="10 WALNUT STREET" city="WESTBOROUGH" state="MA" postal_code="01701" country="USA" drop_point="1" drop_point_description="DROP POINT ONE" manager="TOM DUCEY" telephone_nbr="5085550101" allocatable_flag="Y" receive_restock_transfers="Y" inventory_value_gl_nbr="87777777" viewable_in_oe="Y" retail_outlet="N">

<ItemWarehouse allocation_freeze="N" on_hand_qty="20" available_qty="20"/>

</Warehouse><Warehouse warehouse="10" warehouse_name="OUTLET STORE" address_line_1="100 WALNUT AVE" city="WESTBOROUGH" state="MA" country="USA" drop_point="1" drop_point_description="DROP POINT ONE" allocatable_flag="N" receive_restock_transfers="Y" inventory_value_gl_nbr="11500" viewable_in_oe="N" retail_outlet="N">

<ItemWarehouse allocation_freeze="N"/></Warehouse>

</Warehouses></SKU>

protect_min_max numeric 1 From the Protect minimum/maximum quantities flag for the item warehouse. Valid values are: Y = The system does not update the minimum or maximum quantity for the item in this warehouse when you define a new minimum or maximum quantity in Work with Item Warehouse Values, and instead, keeps the existing quantity.N = The system updates the minimum or maximum quantity for the item in this warehouse with the minimum or maximum quantity you defined in Work with Item Warehouse Values.The Use Retail Store File (G15) system control value controls access to this field.


CWSerenade 5.0


</Item></Message>

3/24/15 Item Availability API 443

Item Availability API

Purpose: Use the Item Availability API to inquire into the availability for a particular item, item/SKU, or group of items, such as:

• the quantity available to sell of an item

• the quantity on-order from your vendor

• the next expected delivery date and quantity for an item

You have the option to review item availability information for an item for each allocatable warehouse or to sum the item availability information for an item across all allocatable warehouses.

What does the item availability request consist of? The request specifies one or more items within a company. The external system can identify the item using the CWSerenade item and SKU codes; or, it can use the short SKU number, retail reference number, or UPC information.

What information does the item availability response include? The response includes information about the item/SKU, the warehouse(s) where it is stored, and current inventory levels such as the on order quantity, available quantity, next PO date, and next expected quantity.

In this topic:

• Item Availability API Setup

• Item Availability API Process

• Item Availability API: Sample Messages

• Item Availability Request XML Message (CWItemAvailabilityWeb)

• Item Availability Response XML Message (CWItemAvailabilityResponseWeb)

CWSerenade 5.0


Item Availability API Setup

The CWServiceIn web service allows an external system to post the Item Availability Request XML Message (CWItemAvailabilityWeb) directly to CWSerenade and receive responses without the need of any queues.


Web service type? You can use the CWServiceIn web service as a SOAP-based web service or a RESTful web service.

• Setup for the CWServiceIn SOAP-Based Web Service

• Setup for the CWServiceIn RESTful Web Service

Setup for the CWServiceIn SOAP-Based Web Service

The CWServiceIn web service’s .wsdl (Web Services Definition Language) file, which is located on your application server, controls the function of the CWServiceIn web service. You send the Item Availability Request XML Message (CWItemAvailabilityWeb) to the URL, or endpoint, specified in this wsdl. The CWServiceIn web service routes the messages sent to the endpoint and dispatches them to the Item Availability Web process. When the Item Availability Web process generates an Item Availability Response XML Message (CWItemAvailabilityResponseWeb), the CWServiceIn web service routes the response.

SOAP envelope and message type: You need to embed each inbound message in the SOAP (Simple Object Access Protocol) message tags in order for the CWServiceIn web service to receive and process it correctly. Also, the type attribute in the inbound message identifies the CWSerenade process, so the CWServiceIn web service can route the message appropriately. The correct type for the Item Availability Request XML Message (CWItemAvailabilityWeb) is CWItemAvailabilityWeb.

Determine the endpoint: The endpoint is typically set to http://server:port/CWDirectCPService/services/CWServiceIn, where server:port identifies the application server where the wsdl is located and CWServiceInis the name of the web service to call.

Sample Inbound Message in SOAP Envelope

The CWServiceIn web service requires that the inbound messages be embedded in SOAP envelope tags. A sample Item Availability Request XML Message (CWItemAvailabilityWeb) embedded in a SOAP envelope is presented below.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dom="http://dom.w3c.org"> <soapenv:Header /> <soapenv:Body> <dom:performAction type="xsd:string">

CWSerenade 5.0


<![CDATA[

<Message source="web" target="serenade" type="CWItemAvailabilityWeb"><ItemAvailabilityWeb company="7" sum_availability="" >

<Items><Item item_number="ITEM" sku_code="" short_sku="" retail_reference_nbr="" upc_type="" upc_code="" />

</Items></ItemAvailabilityWeb>

</Message>

]]></dom:performAction></soapenv:Body></soapenv:Envelope>

Setup for the CWServiceIn RESTful Web Service

You POST the Item Availability Request XML Message (CWItemAvailabilityWeb) to the web service’s URL, or endpoint, of the RESTful service. The web service routes the messages sent to the endpoint and dispatches them to the Item Availability Web process. When the Item Availability Web process generates an Item Availability Response XML Message (CWItemAvailabilityResponseWeb), the CWServiceIn web service routes the response.

Message type: The type attribute in the inbound message identifies the CWSerenade process, so the CWServiceIn web service can route the message appropriately. The correct type for the Item Availability Request XML Message (CWItemAvailabilityWeb) is CWItemAvailabilityWeb.

Determine the endpoint: The individual URL for the CWServiceIn RESTful service uses the following format: http://server:port/SerenadeSeam/sxrs/SerenadeREST/CWServiceIn, where server:port identifies the application server where the RESTful service is located and CWServiceIn is the name of the web service to call.

Sample Inbound Message using RESTful Web Service

The CWServiceIn RESTful web service does not require that inbound messages be embedded in SOAP envelope tags. A sample Item Availability Request XML Message (CWItemAvailabilityWeb) when using a RESTful web service is presented below.


<Items><Item item_number="ITEM" sku_code="" short_sku="" retail_reference_nbr="" upc_type="" upc_code="" />


</Message>

CWSerenade 5.0


Item Availability API Process

A typical item availability flow might be:

Resolving the Item and SKU

The item availability request can indicate the correct item and SKU through any one of the following:

1. item_number and sku_code: If an item contains SKUs and a sku_code is not passed, the system returns item availability information for all SKUs of the item. Validated against the Item and SKU tables.

2. short_sku: Validated against the Short SKU field in the SKU table.3. upc_type and upc_code: Both values must be specified. Validated against the Item

UPC table. Note: Include any leading zeros. For example, if the UPC code is 06012011, pass 06012011 and not 6012011.

4. retail_reference_nbr: Validated against the Reference # in the SKU table.

In searching for an item and SKU, the system checks the values in the message in the order indicated above. If any value (or set of values, such as item_number and sku_code) is blank, it checks the next value, such as short_sku.

Once the system finds one of the values listed above in the message, it checks the related tables to find a match. For example, if the request does not specify an item_number, but does specify the short_sku, the system checks the Short SKU field in the SKU table. If there is a match, the system generates the Item Availability Response XML Message (CWItemAvailabilityResponseWeb). If a short SKU is specified but there is no match, the system sends an error message in the Item Availability Response message. Alternatively, if the message includes an incorrect item code and a correct short SKU, the system sends an error message based on the item code; it never checks the short SKU.

MQ Message log: The system writes the Item Availability Request XML Message (CWItemAvailabilityWeb) and Item Availability Response XML Message

1. A customer at the web storefront inquires into the availability of an item or group of items.

2. The web storefront generates an Item Availability Request XML Message (CWItemAvailabilityWeb) to CWSerenade using the CWServiceIn web service.

3. The Item Availability Web process in CWSerenade receives the request, generates the Item Availability Response XML Message (CWItemAvailabilityResponseWeb), and sends it to the web storefront, where the availability information is presented to the customer.

CWSerenade 5.0


(CWItemAvailabilityResponseWeb) to the CWSerenade MQ Message log if its logging level is set to INFO or higher.

Item Availability Web Service Errors

The Item Availability Response XML Message (CWItemAvailabilityResponseWeb) includes a pass_fail of FAILED and an errorMsg if the Item Availability Request XML Message (CWItemAvailabilityWeb) did not include sufficient valid data. Once an error is found, the system stops processing the message.

Possible error messages are:

Error Message Reason

Message is invalid The Item Availability Request XML Message (CWItemAvailabilityWeb) did not include the ItemAvailabilityWeb, Items, or Item element.

Invalid company code The company attribute in the Item Availability Request XML Message (CWItemAvailabilityWeb) did not contain a valid company code or was missing.

CWSerenade 5.0


Item Not Valid or Could Not be Resolved

Possible reasons:

• The item_number, sku_code, short_sku, retail_reference_nbr, upc_type, and upc_code were missing.

• The item_number did not contain a valid item number.

• The sku_code did not contain a valid SKU code for the specified item_number.

• A sku_code was passed without a specified item_number.

• The short_sku did not contain a valid short SKU number. Note: The system validates short_sku only if an item_number was not passed.

• The retail_reference_nbr did not contain a valid retail reference number. Note: The system validates retail_reference_nbr only if an item_number and short_sku were not passed.

• The upc_code was passed without upc_type or vice versa. Note: The system validates upc_code and upc_type only if an item_number, short_sku, and retail_reference_nbr were not passed.

• The upc_code or upc_type did not contain a valid UPC code or UPC type. Note: The system validates upc_code and upc_type only if an item_number, short_sku, and retail_reference_nbr were not passed.

Error Message Reason

CWSerenade 5.0


Item Availability API: Sample Messages

• Successful Item Availability Request

• Unsuccessful Item Availability Request

Successful Item Availability Request

Item Availability Web Request: Sample XML

A sample of the Item Availability Request XML Message (CWItemAvailabilityWeb) is presented below.

<Message source="web" target="serenade" type="CWItemAvailabilityWeb"><ItemAvailabilityWeb company="7" sum_availability="N" >

<Items><Item item_number="AVAILITEM" sku_code="" short_sku="" retail_reference_nbr="" upc_type="" upc_code="" /><Item item_number="AVAILSKU" sku_code="" short_sku="" retail_reference_nbr="" upc_type="" upc_code="" /><Item item_number="" sku_code="" short_sku="" retail_reference_nbr="" upc_type="E8" upc_code="14070905" /><Item item_number="" sku_code="" short_sku="467" retail_reference_nbr="" upc_type="" upc_code="" /><Item item_number="" sku_code="" short_sku="" retail_reference_nbr="7920143" upc_type="" upc_code="" />


</Message>

Item Availability Web Response: Sample XML

A sample of the Item Availability Response XML Message (CWItemAvailabilityResponseWeb) is presented below. In this example, the sum_availability attribute in the Item Availability Request was set to N, indicating the system provides item availability information for the item in each allocatable warehouse.

<Message source="CWSERENADE" target="WEB" type="CWItemAvailabilityResponseWeb"><ItemAvailabilityResponseWeb company="7" company_description="KAB Co 7 v4.7 Karen Bottger Co" pass_fail="PASS">

<Items><Item item_number="AVAILSKU" item_description="AVAILABILITY SKU" item_2nd_lang_desc="AVAILSKU SECOND LANGUAGE DESCRIPTION" non_inventory="N" membership="N" drop_ship_item="N" item_status="1">

<SKUs><SKU sku_code="BLUE" sku_description="BLUE AVAILSKU" sku_2nd_lang_desc="BLUE AVAILSKU SECOND LANG DESC" short_sku="465" retail_reference_nbr="7920141" gift_certificate="N" subscription="N">

<Warehouses><Warehouse warehouse="18" warehouse_name="AVAILABILITY WAREHOUSE" on_order_qty="100" available_qty="45" next_po_date="07302014" next_expected_qty="100"/>

</Warehouses></SKU>

CWSerenade 5.0


<SKU sku_code="GREY" sku_description="GREY AVAILSKU" sku_2nd_lang_desc="GREY AVAILSKU SECOND LANG DESC" short_sku="471" retail_reference_nbr="7920146" gift_certificate="N" subscription="N">


</Warehouses></SKU>

</SKUs></Item><Item item_number="AVAILITEM" item_description="AVAILABILITY ITEM" item_2nd_lang_desc="AVAILITEM SECOND LANGUAGE DESCRIPTION" non_inventory="N" membership="N" drop_ship_item="N" item_status="1">

<SKUs><SKU short_sku="464" gift_certificate="N" subscription="N">

<Warehouses><Warehouse warehouse="1" warehouse_name="WAREHOUSE 1 MAIN DISTRIBUTION" available_qty="100"/><Warehouse warehouse="18" warehouse_name="AVAILABILITY WAREHOUSE" on_order_qty="500" available_qty="90" next_po_date="07142014" next_expected_qty="500"/>

</Warehouses></SKU>

</SKUs></Item><Item item_number="AVAILDROP" item_description="AVAILABILITY DROP SHIP" item_2nd_lang_desc="AVAILDROP SECOND LANGUAGE DESCRIPTION" non_inventory="N" membership="N" drop_ship_item="Y" item_status="1">

<SKUs><SKU short_sku="467" retail_reference_nbr="7920142" gift_certificate="N" subscription="N">

<Warehouses><Warehouse warehouse="18" warehouse_name="AVAILABILITY WAREHOUSE" available_qty="1" next_po_date="08202014"/>

</Warehouses></SKU>

</SKUs></Item><Item item_number="AVAILCOMP1" item_description="AVAILABILITY COMP1" item_2nd_lang_desc="AVAILCOMP1 SECOND LANGUAGE DESCRIPTION" non_inventory="N" membership="N" drop_ship_item="N" item_status="1">

<SKUs><SKU short_sku="469" retail_reference_nbr="7920144" gift_certificate="N" subscription="N" upc_code="14070905" upc_type="E8">


</Warehouses></SKU>

</SKUs></Item><Item item_number="AVAILSET" item_description="AVAILABILITY SET" item_2nd_lang_desc="AVAILSET SECOND LANGUAGE DESCRIPTION" non_inventory="N" membership="N" drop_ship_item="N" item_status="1" kit_type="S">

<SKUs><SKU short_sku="468" retail_reference_nbr="7920143" gift_certificate="N" subscription="N">

<Warehouses>

CWSerenade 5.0


<Warehouse warehouse="18" warehouse_name="AVAILABILITY WAREHOUSE" on_order_qty="200" available_qty="50" next_po_date="09012014" next_expected_qty="200"/>

</Warehouses></SKU>

</SKUs></Item>

</Items></ItemAvailabilityResponseWeb>

</Message>

Unsuccessful Item Availability Request

Item Availability Web Request: Sample XML

A sample of the Item Availability Request XML Message (CWItemAvailabilityWeb) is presented below.


<Items><Item item_number="" sku_code="" short_sku="" retail_reference_nbr="92" upc_type="E8" upc_code="12345678" />


</Message>

Item Availability Web Response: Sample XML

A sample of the Item Availability Response XML Message (CWItemAvailabilityResponseWeb) is presented below.

<Message source="CWSERENADE" target="WEB" type="CWItemAvailabilityResponseWeb"><ItemAvailabilityResponseWeb company="7" company_description="KAB Co 7 v4.7 Karen Bottger Co" pass_fail="FAILED" errorMsg="Item Not Valid or Could Not be Resolved"/>

</Message>

CWSerenade 5.0


Item Availability Request XML Message (CWItemAvailabilityWeb)


• Item Availability API Process for a discussion of when you might use this message.

• Item Availability API: Sample Messages for a sample message.

• Item Availability API for an overview.

• Item Availability API Setup for information on the required setup.


Message

source alpha 25 Identifies the source of the XML message. Informational only.

target alpha 25 Identifies the target of the XML message. Informational only.

type alpha 25 Identifies the type of information in the XML message. Needs to be set to CWItemAvailabilityWeb.

ItemAvailabilityWeb

company numeric 3 Required. Indicates the company associated with the item/SKU. Validated against the Company table.

sum_availability alpha 1 Defines whether the Item Availability Response XML Message (CWItemAvailabilityResponseWeb) sums the item availability information for an item across all allocatable warehouses. Y = the response sums the item availability information for an item across all allocatable warehouses.N (default) = The response provides item availability information for an item for each allocatable warehouse.

CWSerenade 5.0


ItemCan include one or more items. See Resolving the Item and SKU for more information on how the system determines the item that is inquired against.

item_number alpha 12 The item number for the item you are inquiring against. See Resolving the Item and SKU for more information.Defined in and validated against the Item table.

sku_code alpha 14 The SKU code of the item you are inquiring against. See Resolving the Item and SKU for more information. Defined in and validated against the SKU table.

• If an item contains SKUs and a sku_code is not passed, the system returns item availability information for all SKUs of the item.

• If an item contains SKUs and a sku_code is passed, the system returns item availability information only for the specified SKUs of the item.

short_sku numeric 7 The short SKU number assigned by the system for the item you are inquiring against. Validated against the SKU table. The short SKU can be used to identify the correct item and SKU; see Resolving the Item and SKU for more information.


numeric 15 The retail reference number defined for the item you are inquiring against. Validated against the SKU table. The retail reference number can be used to identify the correct item and SKU; see Resolving the Item and SKU for more information. You can assign a Reference # at the Create Item (Base Information) screen or the Create SKU 2 of 2 (With Overrides) screen.


CWSerenade 5.0


upc_type alpha 3 The UPC type and UPC code defined for the item you are inquiring against. Validated against the Item UPC table. The UPC type and UPC code can be used to identify the correct item and SKU; see Resolving the Item and SKU for more information. Valid UPC types are:

• E13 = EAN-13, indicating a 13 position UPC code; however CWSerenade does not validate the UPC length.

• E8 = EAN-8, indicating an 8 position UPC code; however, CWSerenade does not validate the UPC length.

• UA = UPC-A, indicating a 12 position UPC code; however CWSerenade does not validate the UPC length.

• UE = UPC-E, indicating a 6 position UPC code; however CWSerenade does not validate the UPC length.

Note: Include any leading zeros that are part of the UPC code. For example, if the UPC code is 06012011, pass 06012011 and not 6012011. You can use the Work with UPC Codes screen to assign UPC codes to an item.

upc_code alpha 14


CWSerenade 5.0


Item Availability Response XML Message (CWItemAvailabilityResponseWeb)

The Item Availability Web process generates an XML response laid out as follows.

See Item Availability API: Sample Messages for a sample message and see Item Availability API for an overview.


Message

source alpha 25 Identifies the source of the XML message. Informational only.

target alpha 25 Identifies the target of the XML message. Informational only.

type alpha 25 Identifies the type of information in the XML message. This will be CWItemAvailabilityResponseWeb.

ItemAvailabilityResponseWeb

company numeric 3 Indicates the company associated with the item/SKU.From CMP Company in the Item Warehouse table.

company_description

alpha 30 The description from the company, as set up through Work with Companies (WCMP).From Company Description in the Company table.

CWSerenade 5.0


pass_fail alpha 6 Defines whether item availability information was retrieved successfully.

• PASS = Item availability information was retrieved successfully.

• FAILED = The Item Availability Request XML Message (CWItemAvailabilityWeb) did not include sufficient valid data. See Item Availability Web Service Errors for a list of errors.

errorMsg alpha 50 The reason why item availability information was not retrieved successfully. See Item Availability Web Service Errors for a list of errors.

ItemThe response includes item information for each item passed in the Item Availability Request XML Message (CWItemAvailabilityWeb). If you included the same item more than once in the request, for example you included the UPC type and code and the short SKU number for the same item, the response includes item information for each request of the item.

item_number alpha 12 The item code, as set up through Work with Items (MITM).From ITM Number in the Item Warehouse table.

item_description alpha 40 The description of the item.From Description in the Item table.

item_2nd_lang_desc

alpha 40 The second language description defined for the item.From Second Language Desc in the Item table.

non_inventory alpha 1 Indicates whether inventory levels are maintained for the item. Valid values are:Y = This is a non-inventory item.N = This is a regular item that will be tracked.From Non-inventory in the Item table.


CWSerenade 5.0


membership alpha 1 Indicates that the item represents a membership program, which you can use to generate periodic orders to a customer. Valid values are:Y = This is a membership itemN = This is not a membership itemEven when an item is flagged as a membership item, it is still possible to have an item warehouse record if, for example, you specified a default warehouse when creating the item.From Membership in the Item table.

drop_ship_item alpha 1 Indicates whether you ship the item from your warehouse, or have your vendor ship it to the customer directly. Valid values are:Y = When a customer orders the item, you order the item from your vendor and the vendor ships it directly to your customer. However, it is still possible to ship the item from the warehouse if it is available there.N = You ship the item from your warehouse.If there is a record of an item in a warehouse, this information is still provided in the response message regardless of the setting of this flag.From Drop ship item in the Item table.

item_status alpha 1 The item’s status, if any. An optional code that represents an item's status, such as obsolete, discontinued, etc. This information is used for inventory reporting purposes and to select items for physical inventory. From Item Status in the Item table.


CWSerenade 5.0


kit_type alpha 1 The kit type setting, if any, for the item. Valid values are:

• C = Continuity program

• S = Set

• F = Finished goods

• V = Variable set

From Kit type in the Item table.

svc_type alpha 1 Indicates the type of stored value card that the item is, if it is a stored value card. Valid values are:

• P = Physical card

• E = Physical card/early notification

• V = Virtual card

From SVC Type in the Item table.

SKUThe response includes SKU information for each item passed in the Item Availability Request XML Message (CWItemAvailabilityWeb). This element includes attributes that apply to both SKUed and non-SKUed items, so it is always included in the response.

sku_code alpha 14 The item’s unique characteristics; included if this is a SKUed item.From SKU Code in the SKU table.

sku_description alpha 40 The SKU’s description, if any.From Description in the SKU table.

sku_2nd_lang_desc

alpha 40 The SKU’s second language description, if any.From Second Language Desc in the SKU table.

short_sku numeric 7 The item or SKU’s short SKU code. This is a system-assigned code to uniquely identify each item/SKU.From Short SKU in the SKU table.


CWSerenade 5.0



numeric 15 The SKU’s reference number, if any. Typically, this is an alternate product ID.From Retail reference # in the SKU table.

gift_certificate alpha 1 The setting, if any, of the gift certificate flag. Valid values are:Y = The item is a gift certificateN = The item is not a gift certificateBecause this flag is optional when you create an item/SKU, it might not contain a Y or N value; if not, it is not included in the response.From Gift certificate in the SKU table.

subscription alpha 1 The setting, if any, of the subscription flag. Valid values are:Y = Item is a subscription.N = Item is not a subscription.Even when an item is flagged as a subscription, it is still possible to have an item warehouse record if, for example, you specified a default warehouse when creating the item.Because this flag is optional when you create an item/SKU, it might not contain a Y or N value; if not, it is not included in the response.From Subscription in the SKU table.

sku_status alpha 1 The SKU’s status code, if any. Can be different from the item’s status. From Item Status in the SKU table.

so_control alpha 2 The SKU’s soldout control setting, if any. From SLC Code in the SKU table.

upc alpha 14 A UPC code defined for the item/SKU.The UPC is included only if the item/SKU has one or more UPC codes and the UPC was passed in the request. From UPC in the Item UPC table.


CWSerenade 5.0


upc_type alpha 3 The type of UPC code. The UPC type is included only if the item/SKU has one or more UPC codes and the UPC was passed in the request. The UPC type determines the type of validation the system performs against the UPC code. Valid values are:

• E13: EAN-13

• E8: EAN-8

• UA: UPC-A

• UE: UPC-E

From UPC Type in the Item UPC table.

WarehouseThe response includes warehouse information for each item passed in the Item Availability Request XML Message (CWItemAvailabilityWeb).The response includes only allocatable warehouses assigned to the item/SKU. The response includes all allocatable item warehouses, even if there is no available quantity, on order quantity, or next expected quantity or PO date so that you can see item warehouses with no item availability. You can review item warehouse information through Work with Item Warehouses and through Display Inventory Inquiry (DINI). You can review item availability information through Display Item Availability (DIAV).

warehouse numeric 3 A code identifying an allocatable warehouse assigned to the item/SKU. From Warehouse in the Item Warehouse table. ALL displays if the sum_availability attribute was set to Y in the Item Availability Request XML Message (CWItemAvailabilityWeb).

warehouse_name alpha 30 The name of the warehouse. From Warehouse name in the Warehouse table. ALL displays if the sum_availability attribute in the Item Availability Request XML Message (CWItemAvailabilityWeb) was set to Y.


CWSerenade 5.0


on_order_qty numeric 7 The total quantity of the item that is due to be received through purchase orders.If available, the system includes an on order quantity for inventory and non-inventory items, including items that are flagged to sell out immediately, virtual stored value card items, membership items, gift certificate items, subscription items, and items on allocation freeze. Sum Availability = NIf the sum_availability attribute in the Item Availability Request XML Message (CWItemAvailabilityWeb) was set to N, this is the on order quantity, if any, for the item warehouse. Sum Availability = YIf the sum_availability attribute in the Item Availability Request XML Message (CWItemAvailabilityWeb) was set to Y, this is the on order quantity across all allocatable item warehouses.Set master items and continuity items: This is the on order quantity for the component with the lowest available quantity, even if this quantity is 0. From On order qty in the Item Warehouse table.


CWSerenade 5.0


available_qty numeric 7 The quantity available for the item. If available, the system calculates the available quantity for inventory and non-inventory items, including items that are flagged to sell out immediately, virtual stored value card items, membership items, gift certificate items, subscription items, and items on allocation freeze. Calculated by the system as follows:On hand - Protected - Reserved - Reserve Transfer - Backordered = Quantity availableSum Availability = NIf the sum_availability attribute in the Item Availability Request XML Message (CWItemAvailabilityWeb) was set to N, this is the available quantity, if any, for the item warehouse. Sum Availability = YIf the sum_availability attribute in the Item Availability Request XML Message (CWItemAvailabilityWeb) was set to Y, this is the available quantity across all allocatable item warehouses. Set master items and continuity items: This is the available quantity for the component with the lowest available quantity, divided by the quantity required for the set. For example, if the available quantity is 532, but the set requires 2 of the component item, the available quantity returned is 266 (532/2 = 266).


CWSerenade 5.0


next_po_date numeric 8 The date when the next purchase order for the item is expected, based on purchase order layering. MMDDYYYY format. If available, the system includes a next PO date for inventory and non-inventory items, including items that are flagged to sell out immediately, virtual stored value card items, membership items, gift certificate items, subscription items, and items on allocation freeze. Sum Availability = NIf the sum_availability attribute in the Item Availability Request XML Message (CWItemAvailabilityWeb) was set to N, this is the due date from the first PO Layering record for the item warehouse.See Purchase Order Layering and Backorder Notifications for more information on purchase order layering.Sum Availability = YIf the sum_availability attribute in the Item Availability Request XML Message (CWItemAvailabilityWeb) was set to Y, this is the due date from the first PO Layering record across all item warehouses. Drop ship item: This date is included for drop ship items only if the Assign Drop Ship Expected Ship Date (I59) system control value is selected. From Due date in the PO Layering table.

next_expected_qty numeric 7 The number of units of this item ordered on a purchase order that will be available for new orders. If available, the system includes a next expected quantity for inventory and non-inventory items, including items that are flagged to sell out immediately, virtual stored value card items, membership items, gift certificate items, subscription items, and items on allocation freeze. This is the open quantity associated with the next_po_date. From Open qty in the PO Layering table.


3/24/15 Generic Inventory Download API 464

Generic Inventory Download API

Purpose: Use the generic inventory download API to keep an external system updated with your inventory information in CWSerenade. Like other download API’s, the inventory download works by creating trigger records, which an integration layer process then uses to generate outbound XML messages.

Creating inventory download triggers: The system creates inventory download triggers in the IL Outbound Trigger table either through:

• a batch job, which creates triggers for all eligible item/SKUs based on the settings in the System Control table and the trigger rules you have set up; or,

• interactively, because of activities that affect the item/SKU’s availability or projected availability.

Also, the system generates a message when the setting of the Reservation freeze flag for an Item Warehouse changes.

Generating the inventory download message: The Inventory Download job in Working with Integration Layer Processes (IJCT) monitors the IL Outbound Trigger table for inventory download triggers to process, and generates the Inventory Download XML Message (CWInventoryDownload) to send to the remote system(s).

Message generation options:

• Include non-allocatable warehouses? You can specify whether to download availability information for all warehouses where you keep an item/SKU, or whether to exclude warehouses flagged as non-allocatable.

• Trigger rules: You can use trigger rules to set up more specific selection criteria for items, SKU’s, warehouses, item warehouses, or UPC codes. For example, you might choose to select specific companies, or exclude non-inventory, membership, and gift certificate items.

• Threshold quantity: You can specify a threshold quantity that indicates whether to generate inventory messages whenever an item/SKU’s available quantity is below this threshold and there is any activity for the item/SKU. You can set this threshold by item/SKU and item class, and you can also set a default threshold quantity for your company.

• Purchase order activity: You can specify whether to generate a message whenever you create or change a purchase order that includes an item whose available quantity is zero or less.

What information does the inventory download message include? The message includes information on the:

• item/SKU

CWSerenade 5.0


• any UPC codes

• warehouse

• item warehouse (including the available quantity and other inventory levels, such as on-hand quantity)

You can use the XML inclusion rules to exclude one or more elements of the outbound message if, for example, you do not need to send UPC information to the external system(s).

Integration with Locate: You would typically use Locate’s product import process as an efficient means to send inventory information from CWSerenade to Locate; however, it is also possible to use the generic inventory download API.

CWSerenade 5.0


The generic inventory download API does not check an item’s Locate eligible flag when determining whether to download inventory information on the item.

In this topic:

• Inventory Download Process

• Creating Inventory Download Triggers through a Batch Process• Creating Inventory Download Triggers Interactively Due to Changes in Availability• Creating Inventory Download Triggers through Purchase Order Creation or

Maintenance• Which Activities Generate Inventory Download Triggers?• Identifying Inventory Download Triggers• Inventory Download Processing• Inventory Download Trigger Rules• Item Warehouses Excluded from the Inventory Download• Inventory Download XML Inclusion• Inventory Download Troubleshooting

• Inventory Download Setup

• System Control Values Related to Inventory Download API• Menu Options Related to Inventory Download API

• Inventory Download XML Message (CWInventoryDownload)

• Sample Inventory Download XML Message

CWSerenade 5.0


Inventory Download Process

Purpose: The inventory download trigger creation and message generation process is described below.

Creating Inventory Download Triggers through a Batch Process

Creating all eligible triggers: Use the Generate Outbound Interface Trigger screen or the INV_DOWNLD periodic function (program name ILR0081) to create all eligible trigger records for inventory download. Creating all eligible trigger records through a batch process allows you to generate inventory information for initial download to an external system, or for periodic updates of inventory levels and newly created Item Warehouse records. The periodic update generates triggers for all eligible item/SKUs, regardless of whether there has been any activity since the last update.

Which triggers to create? The system creates a trigger for an item/SKU if:

• the Create Generic Inventory Download Triggers (I32) system control value selected, and

• there is not a conflict with the Inventory Download Trigger Rules, and

• there will be at least one Item Warehouse to include when the message is generated. For example, if the Item Warehouse has a reservation freeze and the warehouse is

CWSerenade 5.0


non-allocatable, the system does not create a trigger record. See Item Warehouses Excluded from the Inventory Download for more information.

When you generate triggers through a batch process, the system does not consider the item/SKU’s available quantity; all item/SKUs are included, subject to the trigger rules.

Creating Inventory Download Triggers Interactively Due to Changes in Availability

Creating triggers interactively enables the INV_DOWNLD job to process them throughout the day and keep an external system up to date. If the Create Generic Inventory Download Triggers (I32) system control value is selected, the system creates inventory download triggers interactively:

• based on changes to an item/SKU’s availability

• whenever the setting of the Reservation freeze flag for an Item Warehouse changes

• optionally, when you create or change a purchase order that includes an item whose available quantity is zero or less, as described under Creating Inventory Download Triggers through Purchase Order Creation or Maintenance

The criteria the system uses to generate triggers based on changes to availability are described below. See Creating Inventory Download Triggers through Purchase Order Creation or Maintenance for more information on when the system generates trigger records due to purchase order activity.

CWSerenade 5.0


Availability threshold: The system generates an inventory download trigger record whenever inventory or reservation activity affects the item/SKU’s available quantity as follows:

Note: If the item/SKU’s available quantity is currently at or above the threshold, and activity changes the available quantity so that it is still at or above the threshold, the system does not create a trigger record. For example, if the current available quantity is 25, the threshold is 20, and you process an inventory adjustment changing the available quantity to 23, the system does not create a trigger record.

When the available quantity is currently:

The system creates a trigger record if the available quantity:

Example:

at or above the threshold

falls below the threshold

The current available quantity is 20The threshold is 20You enter an order line for a quantity of 1, changing the available quantity to 19

below the threshold changes in any way The current available quantity is 10The threshold is 50You adjust the on-hand quantity -1, changing the available quantity to 9orThe current available quantity is 20The threshold is 30You receive a purchase order for 20 units, changing the available quantity to 40

CWSerenade 5.0


Availability threshold hierarchy: The system determines the correct availability threshold for an item/SKU using the following hierarchy:

• the Availability threshold specified for the item, if any; otherwise,

• the Availability threshold specified for the item’s item class, if any; otherwise,

• the Download Threshold Quantity (G36) system control value

CWSerenade 5.0


To always create a trigger record interactively based on changes to availability: If the availability threshold for an item/SKU, determined using the hierarchy described above, is 99999, the system always creates a trigger record for any change in the available quantity.

To never create a trigger record interactively based on changes to availability: If all of the thresholds in the hierarchy are blank (set to zero), the system does not create trigger records interactively based on changes to the available quantity.

How is the available quantity determined? The system uses the standard availability calculation, or On-hand - Protected - Reserved - Reserve transfer - backordered, except that:

If Include Non-Allocatable Warehouses (I34) is

Then inventory in warehouses whose Allocatable flag is selected is:

Example: • warehouse 1 (allocatable): available quantity = -10 • warehouse 2 (non-allocatable): available quantity = 20 • threshold = 50• You adjust the on-hand quantity of the item/SKU in warehouse 2

selected included in the availability calculation

Available quantity for inventory download calculation = 30.The available quantity in warehouse 2 is included in the calculation, so the system does create a trigger record.

CWSerenade 5.0


Determining the availability for set items: The system creates a trigger record for the main set if appropriate, based on the “worst case scenario” of all of the component items.

Example: Set item SET100, with an availability threshold of 20, includes component items AB100 (availability = 50) and CD200 (availability = 7). Because the availability of one of the set’s components is below the threshold, the system creates a trigger record for SET100.

To determine the availability threshold of the set item: The system follows the standard availability hierarchy for a set item, starting at the item level and then checking the item class and finally the system control value. Because each of the components can have different thresholds, generating a trigger for the set item does not mean that the system will also generate a trigger for the components, or vice versa.

Example: The availability threshold for component item CD200 in the above example is 10. In addition to creating the trigger record for the set item, the system creates a trigger record for CD200 itself based on the available quantity of 7. However, if the availability threshold for CD200 were 5, then the system would generate a trigger for just the set item and not the component item.

Determining the availability for continuity items: The system creates trigger records for continuity items in the same way as for set items, except that it might not generate a trigger record for a component if the component does not reserve immediately. The interval for a continuity component indicates whether to reserve it immediately, or at a future date.

Creating Inventory Download Triggers through Purchase Order Creation or Maintenance

If the Create Generic Inventory Download Triggers (I32) and the Include PO Updates (J93) system control values are selected, the system creates an inventory download trigger record whenever you create or maintain a purchase order if:

unselected not included in the availability calculation

Available quantity for inventory download calculation = -10.The available quantity in warehouse 2 is not included in the calculation, so the system does not create a trigger record.

If Include Non-Allocatable Warehouses (I34) is

Then inventory in warehouses whose Allocatable flag is selected is:

Example: • warehouse 1 (allocatable): available quantity = -10 • warehouse 2 (non-allocatable): available quantity = 20 • threshold = 50• You adjust the on-hand quantity of the item/SKU in warehouse 2

CWSerenade 5.0


• the available quantity of any item/SKU on the purchase order is zero or less, and

• there is at least one Item Warehouse for the item/SKU that is eligible for download, and

• the purchase order is not a drop ship purchase order, and

• the purchase order is not in cancelled status, and

• the item/SKU is not excluded from download based on any trigger rules.

Note: If the above assumptions are true, the system generates a trigger record whenever you maintain a purchase order, regardless of the nature of the change.

What if the purchase order is for a non-allocatable warehouse?

If you create or change a purchase order for a non-allocatable warehouse, the purchase order includes an item whose available quantity is zero or less, the Include Non-Allocatable Warehouses (I34) system control value is unselected, and:

CWSerenade 5.0


• this is the only warehouse where you have a record of the item, then the Inventory Download XML Message (CWInventoryDownload) does not include any Item Warehouse records.

• this is not the only warehouse where you have a record of the item, then the Inventory Download XML Message (CWInventoryDownload) does not include the Item Warehouse related to the purchase order, just the Item Warehouse records for allocatable warehouses (even though the message was not triggered by activity in these warehouses).

When you create or change a purchase order that includes a set component item: If a new or maintained purchase order includes an item that is a component of a set or continuity item and the component’s available quantity is zero or less, the system creates a trigger for the component item only, because the component will not necessarily be sold as part of any particular set. The triggers generated in this scenario differ from those generated when you enter an order for a set or continuity item that includes a component item whose available quantity is zero or less; in this situation, the system also creates triggers for the other component item(s) and the master set or continuity item.

Example: Your company stocks items COMPONENT1 and COMPONENT2. Both of these items are included in set master item SET1 and in continuity master item CONTINUE1, and the available quantity of COMPONENT1 is 0. None of these items are currently sold out.

If you enter an order for SET1: The system writes trigger records for SET1 and COMPONENT2 in addition to COMPONENT1, because in the context of the order, the available quantity of the set or continuity master is based on the available quantity of COMPONENT1. The same logic applies to the continuity item (CONTINUE1), provided that COMPONENT1 needs to reserve now for the initial shipment.

If you enter or maintain a purchase order that includes COMPONENT1, the system writes a trigger record for COMPONENT1, but not for COMPONENT2, SET1, or CONTINUE1. The reason is that the item COMPONENT1 is not associated with the other component item, the set master item, or the continuity master item in the context of the purchase order.

CWSerenade 5.0


Which Activities Generate Inventory Download Triggers?

The following are examples of activities which have the potential to create trigger records, based on trigger rules, availability thresholds, and system control values as described above:

Type of transaction Menu Option(s)

inventory transactions:

adjustments (A) Work with Inventory Transactions (WITI or WITB)

transfers from allocatable to unallocatable warehouse, or vice versa (T)

reset on-hand (O)

item-to-item transfers (G)

make up finished good (M)

warehouse replenishment Replenish Warehouses (MWRP)

purchase order receiving Purchase Order Receipts (PORC)

physical inventory Select Physical Inventory Reports (MPIR)

receive return Work with Return Authorizations (WRTA), Work with Return Authorization Receiving (WRAR), Enter/Maintain Orders (OEOM), Order Inquiry/Maintenance (OIOM)

vendor charge back Work with Vendor Charge Backs (WVCB)

express bill Enter/Maintain Orders (OEOM)

create item Work with Items/SKUs (MITM)

change Reservation freeze flag for an Item Warehouse

Work with Warehouses (WWHS)

reserving or unreserving itemsentering or maintaining orders

reserve item Enter/Maintain Orders (OEOM), Order Inquiry/Maintenance (OIOM), Interactive Reservation (MIRV)

delete an order line Enter/Maintain Orders (OEOM)

sell out a backordered item selecting Sell Out

Enter/Maintain Orders (OEOM), Order Inquiry/Maintenance (OIOM)

CWSerenade 5.0


Note: A trigger record is not created when you:

• Enter a soldout item in order entry

• Change an availability threshold

• Change the setting of the Allocatable flag for a warehouse; if you change this setting for a warehouse, you can send the update through Generating Outbound Interface Triggers (GOIT) or through the periodic process

• Create an Item Warehouse if there is no inventory

The system does not consider the setting of the Reservation freeze flag for an Item Location when determining whether to create a trigger record.

Combining multiple trigger records: The system might create multiple trigger records for the same item/SKU as your process transactions during the day; however, the INV_DOWNLD job sends just one Inventory Download XML Message (CWInventoryDownload) for each item/SKU at a time, regardless of how many trigger records are currently waiting to be processed. However, if the INV_DOWNLD job has already sent the message and put the trigger in processed status, and then the system creates a new trigger record, the INV_DOWNLD job generates a new message.

For more information: See Inventory Download Troubleshooting for more situations when the system does or does not create a trigger record.

order a backordered item Enter/Maintain Orders (OEOM), Order Inquiry/Maintenance (OIOM)

change the quantity of an order line

Enter/Maintain Orders (OEOM), Order Inquiry/Maintenance (OIOM)

unreserve, cancel item Enter/Maintain Orders (OEOM), Order Inquiry/Maintenance (OIOM), Interactive Reservation (MIRV), Process Item Substitutions (PSUB), Work with Backorders Pending Cancellation (WBPC), Work with Credit Card Cancellations (WCCC)

sell out an item Process Auto Soldout Cancellations (MASO)

purchase order creation or update (if the Include PO Updates (J93) system control value is selected

create a purchase order Enter/Maintain PO’s (MPOE); Work with PO Interface Records (WPOI); Rerun PO Interface File Edit (RPOI)

maintain an open purchase order

Enter/Maintain PO’s (MPOE); Purchase Order Inquiry (MPOI)

Type of transaction Menu Option(s)

CWSerenade 5.0


Identifying Inventory Download Triggers

Each inventory download trigger displayed at the Work with Outbound Interface Transactions screen (WOIT) has a:

• File code of ITW

• Key identifying the specific company, item, and SKU. For example, the Key 123AB10000 LRGE indicates to download inventory information for item AB10000, SKU LRGE, in company 123. If one or more trigger records exist for an item/SKU, the Inventory Download job sends a message including all existing warehouses where you keep the item. based on the rules described under Item Warehouses Excluded from the Inventory Download.

• Capture type of C (change).

Inventory Download Processing

To generate the Inventory Download XML Message (CWInventoryDownload), the INV_DOWNLD process in Working with Integration Layer Processes (IJCT):

1. Reads through the inventory download trigger records

2. Creates a single Inventory Download XML Message (CWInventoryDownload) for each item/SKU, regardless of how many ITW trigger records in R (ready) status exist for the item/SKU

3. Includes each item/warehouse for the item/SKU, based on the rules described under Item Warehouses Excluded from the Inventory Download.

Example: If an activity in warehouse 1 generated the trigger record, but there are eligible Item Warehouse records in warehouse 3, 4, and 5, all of these Item Warehouse records are included in the message.

4. Sets each trigger record’s status to X (processed)

Inventory Download Trigger Rules

The options available for the inventory download at the Select Trigger Rules File window (IJCT) are:

• Item (INITEM)

• Item Warehouse (INIWRE)

• SKU (INSKU)

• Warehouse (INWRHS)

• UPC (ITMUPC)

CWSerenade 5.0


You can make the creation of inventory download trigger rules conditional on many of the fields in any of these tables. For example, to exclude non-inventory items from the inventory download, you would set the following selection for the Item table (INITEM):

This rule excludes any item whose Non-inventory flag is set to Y.

Typical setup: A typical setup for inventory download might exclude records based on the following criteria:

• Item table:

• Drop ship items• Non-inventory items• Membership items• Specific item statuses

• SKU table:

• Gift certificates• SVC card reload• Specific item statuses

• Warehouses: retail outlets

Note:

• Trigger rules are not specific to a company, and apply to each company for which you generate trigger records.

• Not all fields in all tables are available as triggers. You can review the fields available for each table through the Additional information will be provided by MICROS at a later date.

Item Warehouses Excluded from the Inventory Download

When an item/SKU is kept in multiple warehouses, it is possible for the message to exclude a Warehouse or Item Warehouse or the available quantity, even if the item/SKU exists in that warehouse. The rules governing when the Warehouse and ItemWarehouse are excluded from the Inventory Download XML Message (CWInventoryDownload), or when no available_qty is included, are:

• Include the complete Warehouse and ItemWarehouse in the message if the Item Warehouse is not frozen (based on the setting of the Reservation freeze flag for the Item Warehouse) and:

Field Test Value

Non-inventory NE ’Y’

CWSerenade 5.0


• the warehouse is allocatable (based on the setting of the Allocatable flag), or• the Include Non-Allocatable Warehouses in Inventory Download Setting system

control value is selected; otherwise;

• Include the Warehouse and the ItemWarehouse but do not include the available_qty in the ItemWarehouse element if the Item Warehouse is frozen but the warehouse is allocatable; otherwise,

• Do not include the Warehouse or ItemWarehouse in the message. If this is the only existing Item Warehouse for the item/SKU, do not create a trigger record.

These rules are summarized in the table below.

Inventory Download XML Inclusion

As with other outbound messages generated through Working with Integration Layer Processes (IJCT), you can use the Outbound Interface XML Inclusion screen to exclude elements and their contents from the Inventory Download XML Message (CWInventoryDownload). The XML inclusion options for the inventory download are:

ItemSKU

UPCWarehouse

ItemWarehouse

If you choose to exclude an element, all of the subordinate elements and attributes of that element are also excluded. For example, if you choose to exclude the SKU element, the

Include Non-Allocatable Warehouses in Inventory Download Setting

Warehouse Allocatable Flag Setting

Item Warehouse Reservation Freeze Flag Setting

Result

Y Y N Include Warehouse, ItemWarehouse and available_qty in messageY N N

N Y N

Y Y Y Include Warehouse and ItemWarehouse but not available_qty in messageN Y Y

Y N Y No Warehouse or Item Warehouse in message (or, if this is the only Item Warehouse, do not create a trigger record)

N N Y

N N N

CWSerenade 5.0


message includes the Item element and attributes only, and does not include the SKU, UPC, Warehouse, or ItemWarehouse elements.

If you exclude the ItemWarehouse element, the message does not include any availability information.

Note: XML inclusion settings are not specific to a company. Any XML inclusion settings you create apply to all companies for which you generate trigger records.

For more information: See the Inventory Download XML Message (CWInventoryDownload) for more information on the contents of each of these elements.

Inventory Download Troubleshooting

The system might not generate the Inventory Download XML Message (CWInventoryDownload) for any of the following reasons:

• Are the trigger rules excluding companies, item/SKUs, warehouses, item warehouses, and so on? See Inventory Download Trigger Rules.

• Are the XML inclusion rules excluding essential information for the message? See Inventory Download XML Inclusion.

• Is the item warehouse flagged as having a reservation freeze? See Item Warehouses Excluded from the Inventory Download.

• Is the availability threshold for the item/SKU lower than the item/SKU’s available quantity? See Creating Inventory Download Triggers Interactively Due to Changes in Availability for more information on the threshold hierarchy.

• Is the Create Generic Inventory Download Triggers (I32) system control value selected? The system does not create any trigger records if this system control value is unselected.

• If you expected a trigger to be generated when you create or maintain a purchase order, is the Include PO Updates (J93) system control value selected and is the available quantity for the item zero or less? See Creating Inventory Download Triggers through Purchase Order Creation or Maintenance for a discussion.

• Is the item flagged with a soldout status code? The system does not create any trigger records for items that are currently sold out.

• Is the INV_DOWNLD process in Working with Integration Layer Processes (IJCT) running?

• Have you stopped and restarted the INV_DOWNLD process and the background jobs after making any changes to system control value settings?

CWSerenade 5.0


Inventory Download Setup

Setup requirements for the inventory download API are described below.

• System Control Values Related to Inventory Download API

• Menu Options Related to Inventory Download API

CWSerenade 5.0


System Control Values Related to Inventory Download API

System Control Value

Description

Create Generic Inventory Download Triggers (I32)

Must be selected in order to generate inventory download trigger records.

Include PO Updates (J93)

Indicates whether to generate trigger records when you create or change a purchase order that includes an item whose available quantity is zero or less. If you select this value, the system creates a trigger each time you create or change a purchase order that includes an item/SKU whose available quantity is zero or less (with the exception of drop ship purchase orders). If you unselect this value, the system does not create triggers as a result of purchase order creation or maintenance.

Include Non-Allocatable Warehouses (I34)

Indicates whether the system should use the setting of a warehouse’s Allocatable flag to determine whether to include inventory in that warehouse in an item/SKU’s available quantity. If you select this value, the system includes all warehouses when evaluating an item/SKU’s available quantity in order to determine whether to create a trigger. If you unselect this value, the system excludes the inventory in non-allocatable warehouses.

Quantity Available Threshold for Inventory Downloads (G36)

Indicates the default availability threshold quantity to use if there is no threshold quantity specified for the item or the item class. See Creating Inventory Download Triggers Interactively Due to Changes in Availability for more information.

Outbound Interface Trigger File Purge Days (I14)

Specify the number of days to retain processed trigger records in the IL Outbound Trigger table before the PURGIJCT periodic function, described below, can purge them. For example, if this value is 10 and a trigger record’s Last processed date is 10/12 or earlier, the trigger is eligible to be purged on 10/22. Only processed records (status = X) are purged.Note: This value controls the purge days for all trigger records in the IL Outbound Trigger table, not just inventory download triggers.

CWSerenade 5.0


Menu Options Related to Inventory Download API

Menu Option Setup Required

Working with Integration Layer Processes (IJCT)

Work with Integration Layer Process Queues screen: Create one or more process queues to specify where to send the Inventory Download XML Message (CWInventoryDownload).Select Trigger Rules File window: Optionally, set trigger rules. See Inventory Download Trigger Rules for more information on options.Outbound Interface XML Inclusion screen: Optionally, set inclusion rules to exclude one or more elements. See Inventory Download XML Inclusion for more information.

Performing Initial Item Entry (MITM)

Optionally, set the Available threshold at the item level as an override to the threshold set at the item class or with the Quantity Available Threshold for Inventory Downloads (G36) system control value.

Working with Item Classes (WICL)

Optionally, set the Available threshold at the item class as an override to the Quantity Available Threshold for Inventory Downloads (G36) system control value. The threshold set at the item level, if any, overrides the item class threshold.

Working with Periodic Functions (WPER)

Optionally, create the INV_DOWNLD periodic function, using program name ILR0081. This function creates inventory download trigger records for all eligible item/SKUs, as described under Creating Inventory Download Triggers through a Batch Process. If you have not already done so, create the PURGIJCT periodic function, using program name ILR0026. This periodic function purges all processed (status = X) trigger records older than the Outbound Interface Trigger File Purge Days (I14). You can also use the Purge option at the Work with Outbound Interface Transactions screen to purge records.Note: These functions purge all trigger records in the IL Outbound Trigger table, not just inventory download triggers.

Working with Periodic Processes (WPPR)

Assign the periodic functions described above to periodic processes.

CWSerenade 5.0


Inventory Download XML Message (CWInventoryDownload)

Note:



• The XML inclusion rules control whether one or more elements are included in the message.

For more information: See Inventory Download Process for a discussion of when you might use this message.


Message

source alpha 25 Identifies the source of the XML message. RDC indicates the XML message is from CWSerenade.


type alpha 25 Identifies the type of information in the XML message: CWInventoryDownload.

date numeric 8 The date when the message was generated. MMDDYYYY format.

time numeric 6 The time when the message was generated. HH:MM:SS format.

CWSerenade 5.0


Item

company numeric 3 Indicates the company associated with the item/SKU. From the Company table.

company_description

alpha 30 The description of the company, from the Company table.

item_number alpha 12 A code identifying the item. From the Item table.


item_2nd_lang_desc

alpha 40 The Second language description at the item level, if any.

item_long_sku_style

alpha 20 The L/S style for the item, if any. Used as part of retail integration, and required for the item if the Use Retail Integration (H26) system control value is selected.

non_inventory alpha 1 The setting of the Non/inv flag for the item. Valid values are:Y = This is a non-inventory itemN = You track inventory for this item

membership alpha 1 The setting, if any, of the Membership flag, if any, for the item. Valid values are:Y = This item represents a membership program that you sellN or blank = This is not a membership itemNote: If this flag is blank for an item, the membership attribute is not included in the message.

drop_ship_item alpha 1 The setting of the Drop ship flag for the item. Valid values are:Y = This is an item that a vendor ships directly for youN = This is an item that you ship from your warehouse

item_status alpha 1 The item’s Status code, if any. Item status codes are defined in and validated against the Item Status table.

item_status_description

alpha 30 The description of the item status code, if any.


CWSerenade 5.0


kit_type alpha 1 The item’s Kit type setting, if any. Valid values are:C = Continuity programS = SetF = Finished goodsV = Variable setNote: If the Kit type field for the item is blank, the kit_type attribute is not included in the message.

long_sku_department

numeric 4 The L/S dept, if any, assigned to the item. Used as part of retail integration, and required for the item if the Use Retail Integration (H26) or Require L/S Department (I92) system control value is selected.

long_sku_department_desc

alpha 30 The description of the long SKU department, if any, as specified through Working with Long SKU Departments (WLSD).

long_sku_division alpha 3 The L/S division, if any, assigned to the item’s long SKU department.

long_sku_division_desc

alpha 30 The description of the long SKU division, as set up through Creating and Maintaining Long SKU Divisions (WLDV).

long_sku_class numeric 4 The L/S class, if any, assigned to the item. Used as part of retail integration, and required for the item if the Use Retail Integration (H26) or Require L/S Class (I93) system control value is selected.

long_sku_class_desc

alpha 30 The description of the long SKU class, as set up through Working with Long SKU Classes (WLSC).


CWSerenade 5.0


svc_type alpha 1 The item’s SVC type setting, if any. Valid values are:P = The item is a physical stored value card.E = The item is a physical stored value card that requires an email notification.V = The item is a virtual (non-physical) stored value card.Note: If the SVC type field for the item is blank, the svc_type attribute is not included in the message.

SKU Information stored in the SKU table is included, even for non-SKU’ed items. For example, a non-SKU’ed item always has a short_sku specified, and might also include other information, such as a soldout control code. See the descriptions below for more information.

sku_code alpha 14 The code identifying the SKU’s unique characteristics, such as its color, size, or style. Provided for SKU’ed items only.

sku_description alpha 40 The description of the SKU. Provided for SKU’ed items only.

sku_2nd_lang_desc

alpha 40 The second language description for the SKU. Provided for SKU’ed items only.

sku_long_sku_style

alpha 20 The SKU-level long SKU style, if any. Provided for SKU’ed items only.

short_sku numeric 7 A unique number, assigned by the system to identify each item/SKU. Displayed as the Short SKU in item maintenance. Provided for both SKU’ed and non-SKU’ed items.


numeric 15 An alternate product number, if any, that you have assigned to the item/SKU. The Reference #, if any, is provided for both SKU’ed and non-SKU’ed items.


CWSerenade 5.0


gift_certificate alpha 1 The setting of the Gift cert flag for the item/SKU. Valid values are:Y = This item is a gift certificateN or blank = This item is not a gift certificateBecause this flag is an optional entry, the setting is provided in the message only if it was set to Y or N. Provided for both SKU’ed and non-SKU’ed items.

subscription alpha 1 The setting of the Subscription flag for the item/SKU. Valid values are:Y = This item is a subscriptionN or blank = This item is not a subscriptionBecause this flag is an optional entry, the setting is provided in the message only if it was set to Y or N. Provided for both SKU’ed and non-SKU’ed items.

sku_status alpha 1 The SKU-level status, if any. From the Status field for the SKU, which overrides the item-level status. Provided for SKU’ed items only.

sku_status_description

alpha 30 The description of the SKU-level status code, if any. Provided for SKU’ed items only.

so_control alpha 2 The S/O control value, if any, assigned to the item/SKU. Soldout control codes can indicate one of the following statuses:• 1 = Sellout the item immediately. • 2 = Sellout the item when the quantity available is zero, not including open purchase orders.• 3 = Sellout the item when the quantity available is equal to zero, including open purchase orders.The soldout control code, if any, is provided for both SKU’ed and non-SKU’ed items.

so_control_description

alpha 30 The description of the soldout control value, if any. Provided for both SKU’ed and non-SKU’ed items.


CWSerenade 5.0


so_control_status numeric 1 The status of the soldout control code, if any, as described above under so_control. Provided for both SKU’ed and non-SKU’ed items.

UPC This element is included only if the item/SKU has one or more UPC codes assigned. If the item has SKUs, you must assign UPC codes at the SKU level rather than at the item level.

upc alpha 14 A UPC code, if any, assigned to the item/SKU.

upc_type alpha 3 The UPC Type. Valid types are: E13: EAN-13E8: EAN-8UA: UPC-AUE: UPC-E

upc_vendor numeric 7 The code identifying the vendor who sells you the item and who is associated with the UPC code.

Warehouse This element includes information on the warehouse itself, and is provided in the message only if there is an Item Warehouse record for the item/SKU. See Inventory Download Process for more information.

warehouse numeric 3

warehouse_name alpha 30




city alpha 25

state alpha 2

postal_code alpha 10

country alpha 3

drop_point numeric 3


CWSerenade 5.0


drop_point_description

alpha 30

manager alpha 30

telephone_nbr numeric 14

fax_nbr numeric 14

allocatable_flag alpha 1

receive_restock_transfers

alpha 1

inventory_value_gl_nbr

numeric 8

value_inv_at_retail alpha 1

viewable_in_oe alpha 1

auto_restock_location

alpha 7

retail_outlet alpha 1

retail_type alpha 1

ItemWarehouse

allocation_freeze alpha 1

economic_order_qty

numeric 7

max_qty numeric 7

min_qty numeric 7

on_hand_qty numeric 7

backorder_qty numeric 7

protected_qty numeric 7

reorder_qty numeric 7

reserve_qty numeric 7

sh_reserve_qty numeric 7

on_order_qty numeric 7


CWSerenade 5.0


reserve_transfer_qty

numeric 7

available_qty numeric 7 Drop ship items: If the item is flagged for drop ship, the available quantity indicated is 9999, regardless of whether there is any quantity of the item actually on-hand in the warehouse.

next_po_date numeric 8

next_expected_qty numeric 7


numeric 7.2

current_retail_price

numeric 7.2

protect_current_price

alpha 1

protect_min_max alpha 1


CWSerenade 5.0


Sample Inventory Download XML Message<Message source="CWDirect" target="CWIntegrate" type="CWInventoryDownload" date="10082006" time="11:07:35" >

<Item company="123" company_description="Sarah`s Kitchen Shop" item_number="MELIOR" item_description="MELIOR-STYLE COFFEE MAKER" item_2nd_lang_desc="CAFETERA DEL TIPO MELIOR" item_long_sku_style="MEL456789" non_inventory="N" membership="N" drop_ship_item="N" item_status="A" item_status_description="ACTIVE" >

<SKU sku_code="LRGE" sku_description="ONE-QUART COFFEE MAKER" short_sku="81" so_control="02" so_control_description="INCLUDE ON ORDER QTY IN SOLD" so_control_status="2">

<UPCs><UPC upc="1234567890" upc_type="E8" upc_vendor="10002"></UPC>

</UPCs><Warehouses>

<Warehouse warehouse="10" warehouse_name="MAIN WAREHOUSE" address_line_1="10 SPEEN STREET" city="FRAMINGHAM" state="MA" postal_code="01701" country="USA" drop_point="1" drop_point_description="MASS. DROPPOINT" manager="MS. HANNAH BROWN" allocatable_flag="Y"receive_restock_transfers="N" viewable_in_oe="Y" auto_restock_location="RESTOCK" retail_outlet="N">

<ItemWarehouse allocation_freeze="N" economic_order_qty="100" max_qty="99999" min_qty="10" on_hand_qty="22" reorder_qty="20" on_order_qty="10" available_qty="22" next_po_date="10152006" next_expected_qty="15" original_retail_price="2100" current_retail_price="2600" protect_current_price="N" protect_min_max="N"/>

</Warehouse></Warehouses>

</SKU></Item>

</Message>

3/24/15 Generic Item Download API 493

Generic Item Download API

Purpose: CWSerenade allows you to capture item and SKU information to download to another system, such as a retail store or warehouse management system.

Item and SKU download information flow: This flowchart explains how item and SKU information is downloaded from CWSerenade.

Integration with Locate: You would typically use Locate’s Product Import Process as an efficient means to send item and SKU information from CWSerenade to Locate; however, it is also possible to use the generic item download API.

The generic item download API does not check an item’s Locate eligible flag when determining whether to download information on the item.

In this topic:

• Item/SKU Download Process

CWSerenade 5.0


• Identifying Item Download Triggers• When are Item Download Triggers Created?• Item/SKU Download Processing• Item Outbound Trigger Activities• Item Outbound Trigger Rules• Item Trigger Cleanup• Processing Item Delete Triggers• Item Outbound XML Inclusion

• CWSerenade Setup for the Item Download API

• System Control Value• Menu Options• Periodic Functions

• Item Download XML Message (CWItemOut)

• Item Download Message: Sample XML

CWSerenade 5.0


Item/SKU Download Process

The system creates item download triggers in the IL Outbound Trigger table when an item or SKU is created, updated, or deleted. The Item Outbound job in the Work with Integration Layer Processes (IJCT) menu option monitors the IL Outbound table for item download triggers to process and generates an Item Download XML Message (CWItemOut) to send to the remote system.

Identifying Item Download Triggers

You can view all download triggers in the IL Outbound Trigger table at the Work with Outbound Interface Transactions screen.

Each trigger in the IL Outbound Trigger table contains a:

• File code: indicating the type of information to download and which IL process job processes the trigger. For item download triggers, the File code is SKU, regardless of whether the activity was at the item level or SKU level.

• Key: indicating the specific record to download. For item download triggers, the Key identifies the specific company, item, and SKU associated with the item download trigger. The SKU code is included only if the item is a SKU’ed item. For example the Key 555AB100112 BLUE GRLS SMLL indicates the item and SKU information is located in company 555 for item number AB100112 and SKU code BLUE GRLS SMLL.

• Capture type: indicating the type of activity performed against the record:

• A = the item/SKU was created.• C = the item/SKU was maintained. Note: The system removes any duplicate

change triggers; see Item Trigger Cleanup.• D = the item/SKU was deleted. Note: The system processes delete triggers

immediately; see Processing Item Delete Triggers.

When are Item Download Triggers Created?

The Create Generic Item Download Trigger Records (I15) system control value controls whether the system creates item download triggers in the IL Outbound Trigger table.

• If this system control value is selected, certain actions in CWSerenade triggers the system to create item download triggers in the IL Outbound Trigger table with a File code of SKU. The IL Outbound Trigger table acts as a “to do” list for the item/SKU information that requires download.

• If this system control value is unselected, the system does not create item download triggers in the IL Outbound Trigger table.

CWSerenade 5.0


Generating download triggers for all items/SKUs: You can also create an item download trigger for each item/SKU in your company using the Generate Outbound Interface Triggers (GOIT) menu option. Run this process to initially send items/SKUs to the remote system.

When you generate triggers for all items/SKUs, the system generates item download triggers alphabetically by item number and SKU code in Kit type sequence. This way all items that are components of any type of kit are processed before the main kit item is processed.

1. The system generates triggers alphabetically by item number and SKU code for all items/SKUs whose Kit type is blank.

2. The system generates triggers alphabetically by item number and SKU code for all items/SKUs whose Kit type is C (continuity kit).

3. The system generates triggers alphabetically by item number and SKU code for all items/SKUs whose Kit type is F (finished good kit).

4. The system generates triggers alphabetically by item number and SKU code for all items/SKUs whose Kit type is S (set kit).

5. The system generates triggers alphabetically by item number and SKU code for all items/SKUs whose Kit type is V (variable set kit).

Note: When you create new items for which you wish to generate item download triggers, make sure you create the component items first before creating the main kit item. This way the component items are processed before the main kit item is processed.

Example: The system generates item download triggers in the following sequence, based on the item’s Kit type.

Item number Kit type Sequence

204I blank 1

204J blank 2

204K blank 3

204A C 4

204H C 5

204C F 6

204F F 7

204B S 8

204G S 9

204D V 10

CWSerenade 5.0


Item/SKU Download Processing

To generate an item download message, the system:

1. During certain activities, evaluates the trigger rules defined for the Item Outbound job to determine if the item download trigger is created. Item Outbound trigger rules define the criteria the item/SKU must meet in order for the system to create an item download trigger. See Item Outbound Trigger Rules.

2. Creates item download triggers, based on CWSerenade activities that create, update, or delete items and SKUs. See Item Outbound Trigger Activities for a list of the activities that create item download triggers.

3. When active, the trigger monitor defined for the Item Outbound job looks for unprocessed item download triggers to process at defined intervals, based on the Outbound delay time.

The Item Outbound trigger monitor:

• looks for item download triggers with the File code SKU and a status of ready (R).

• removes duplicate item download triggers. See Item Trigger Cleanup.

• sends each item download trigger to the message builder defined for the Item Outbound job.

Note: The system processes item download triggers with a delete (D) Capture type immediately, regardless of whether the Item Outbound job is active or inactive; see Processing Item Delete Triggers.

4. For each item download trigger, the Item Outbound job creates a CWMessageBuilder xml message and places the message in the outbound queue defined for the Item Outbound configuration. The CWMessageBuilder message contains the item download trigger key and CWSerenade database access information required by the Item Outbound message builder to generate an item download message.

5. The Item Outbound message builder monitors the Item Outbound configuration outbound queue for CWMessageBuilder messages to read and process.

For each CWMessageBuilder message, the Item Outbound message builder:

• looks at the User ID and Password defined for the CWMessageBuilder message to determine the CWSerenade user ID and password to access the CWSerenade

204E V 11

Item number Kit type Sequence

CWSerenade 5.0


database during XML message generation. If the User ID or Password is invalid, the message builder does not generate an item download message.

• determines which item/SKU to download, based on the item download trigger Key included in the CWMessageBuilder message. The Key field for item download triggers consists of company + item number + SKU code. The SKU code is included only if the item is a SKU’ed item. For example, the Key 555AB100112 BLUE GRLS SMLL indicates the item and SKU information is located in company 555 for item number AB100112 and SKU code BLUE GRLS SMLL.

• determines which elements to include in the item download message, based on XML inclusion rules. See Item Outbound XML Inclusion.

• sends the generated item download message to the queues defined for the Item Outbound job that are active (the Enabled field is selected).

Item Outbound Trigger Activities

This table indicates:

• which CWSerenade activities create an item download trigger.

• which table the item download trigger references.

• the type of activity performed against the item/SKU:

• A = an item or SKU was created.• C = an item or SKU was maintained.• D = an item or SKU was deleted.

For SKU’ed items, the system creates a separate item download trigger for each SKU. For example, if you update a SKU’ed item at the item level, the system generates a separate item download message for each SKU.

For non-SKU’d items, the system includes the SKU element and its attributes in the item download message without the SKU_Code attribute.

Additionally, the system creates an item download trigger if the transaction updates any of the fields associated with item/SKU information, regardless of whether the updated field is included in the item download message. However, the system creates an item download trigger when you update an item warehouse only if the transaction updates an item warehouse field that is included in the item download message.

Note: Each activity may create duplicate triggers; however, the Item Trigger Cleanup removes any duplicates before generating an Item Download XML Message (CWItemOut).

You can review the item download triggers in the IL Outbound Trigger table at the Work with Outbound Interface Transactions screen.

CWSerenade 5.0


Note: The system creates an item download trigger for the activities listed below only if the item/SKU meets the criteria from the Item Outbound trigger rules; see Item Outbound Trigger Rules.

Activity Menu Option

Referenced table Trigger Type

Create an itemNote: If you create a SKU’ed item, the system does not create a trigger until you create a SKU.

MITM Item A

Create a SKUNote: The system also creates a change trigger when you create a SKU.

MITM SKU A

Create SKUs for an item using the SKU GeneratorNote: The system creates a separate trigger for each SKU generated.

ESKG SKU A

Delete an item MITM Item D

Delete a SKU MITM SKU D

Delete SKUs for an itemNote: The system creates a separate trigger for each SKU deleted.

MDLT SKU D

Purge SKUsNote: The system creates a separate trigger for each SKU purged.

MPSK SKU D

Change an item MITM Item C

Change a SKU MITM SKU C

Create or update item information (at the item level or SKU level)Note: If you update information at the item level, the system creates a separate trigger for each SKU.

MITM Item Information C

Create or update item comments MITM SKU Comment C

Work with or change item attributes or values

MITMWIAT

Item Attribute C

CWSerenade 5.0


Create, change, or delete a special source priceNote: The system creates a separate trigger for each SKU.

MITMWSRC

Special Pricing by Source

C

Create, change, or delete an item coordinateNote: The system creates a separate trigger for each SKU.

MITM Item Coordinate C

Create or delete a keywordNote: The system creates a separate trigger for each SKU.

MITMWKEY

Keyword C

Create, change, or delete an e-commerce upsell/cross-sellNote: The system creates a separate trigger for each SKU.

MITM E-Commerce Up/Cross-Sell

C

Create or delete an item restriction by country or stateNote: The system creates a separate trigger for each SKU.

MITM Item Restr by Country/State

C

Define or delete an e-commerce item categoryNote: The system creates a separate trigger for each SKU.

MITM E-Commerce Category

C

Change or delete a SKU user field MITM SKU User Field C

Change or delete an item user fieldNote: The system creates a separate trigger for each SKU.

MITM Item User Field C

Create, change, or delete an item tax exemptionNote: The system creates a separate trigger for each SKU.

WITX Item Tax Exempt C

Create, change, or delete a freight exempt itemNote: The system creates a separate trigger for each SKU.

WFEI Freight Exemption C



CWSerenade 5.0


Update SKU ABC/velocity codesNote: The system creates a separate trigger for each SKU whose ABC/velocity code has been updated.

MABC SKU C

Resequence the SKU collating sequence numberNote: The system creates a separate trigger for each SKU that has been resequenced.

RSCS SKU C

Create, change, or delete an item warehouseNote: The system creates an item download trigger only if the transaction updates an item warehouse field that is included in the item download message.

MITMWWHS

Item Warehouse C

Create an item warehouse by copying an existing warehouseNote: The system creates a separate trigger for each item warehouse created.

MCIW Item Warehouse C

Update item warehouse valuesNote: The system creates a separate trigger for each item warehouse updated.

WIWV Item Warehouse C

Receive inventoryNote: The system creates a separate trigger for each SKU received.

PORC Item Warehouse C

Change or delete an item warehouse user field

MITM Item Warehouse C

Change or delete continuity information MITMWCNT

Continuity HeaderContinuity Detail

C

Change or delete a finished good component, make-up a finished good, or update the cost of a finished good (periodic function PHR0049)

MITMWFGD

Kit Detail C

Add, change, or delete a set or set component

MITMWSET

SetSet Detail

C



CWSerenade 5.0


Create, change, or delete a variable set group; add or delete a variable set component; create or delete a variable set

MITMWVST

Variable Set GroupVariable Set DetailVariable Set

C

Assign, change, or delete an item UPC code

MITM Item UPC C

Create, change, or delete a vendor item, vendor item price break, vendor item additional charges, vendor item notes; update the standard cost

MITMWVNI

Vendor Item C

Generate item download triggers GOIT IL Outbound Trigger C

Update a harmonize codeNote: The system creates a separate trigger for each SKU.

UPHC Item C

Process a finished good work order WWOR Work Order HeaderWork Order Detail

C

Reset SKU Open Order Quantity MRSO SKU table C

Update Standard Cost MSCC SKU table C

Create, change, or delete an item offer MITM Item Offer C

Create, change, or delete an item offer price

MITM Item Price C

Create, change, or delete an item offer page letter

MITM Page Letter Alias C

Create, change, or delete an item offer alias

MITM Page Letter Alias C

Create, change, or delete an item offer accompanying item

MITM Accompanying Item C

Create, change, or delete an item offer user defined field

MITM Item Offer User Field C

Create, change, or delete a special format detail or response associated with the custom special handling code that is assigned to an item offer.

WSHF Special Format Details

C

Create, change, or delete a SKU offer MITM SKU Offer C



CWSerenade 5.0


Item Outbound Trigger Rules

Item Outbound trigger rules define the criteria an item/SKU must meet in order for the system to create an item download trigger.

Create, change, or delete a SKU offer price

MITM SKU Price C

Create, change, or delete a SKU offer page

MITM SKU Offer Page C

Create, change, or delete a SKU offer accompanying item

MITM Accompanying Item C

Maintain an item/SKU/offer CPIM ItemSKUSKU Offer

C

Copy SKU/Offer recordsNote: The system creates a trigger for each SKU of an item, even if you are only copying an offer to one SKU.

CSKO Item OfferSKU Offer

C

Copy SKU Offer informationNote: The system creates a trigger for each item/SKU assigned to the new offer.

MCSO Item OfferSKU Offer

C

Submit deferred SKU offer updates MDSS SKU Offer C

Maintain item offers MIOF Item OfferItem

C

Create item/SKU offer MISO Item OfferSKU Offer

C

Initialize offer MOFI Item OfferSKU Offer

C

Update SKU offer prices MUSK SKU Offer C

Work with coordinates by offer WCIO Item Coordinate C

Submit an item/SKU offer upload WISU Item OfferSKU Offer

C

Submit item offer overrides by class WSOI Item Offer C



CWSerenade 5.0


• if the item/SKU meets the Item Outbound trigger rule criteria, the system creates an item download trigger.

• if the item/SKU does not meet the Item Outbound trigger rule criteria, the system does not create an item download trigger.

You can define Item Outbound trigger rules for fields in the Item table and SKU table that are included in the Item Download XML Message (CWItemOut). If you define more than one criterion, the item/SKU must meet all of the criteria defined in order to generate a trigger.

Example: You define the following trigger rules for the Item Outbound job:

You can define trigger rules for the Item Outbound job at the Outbound Interface Trigger Rules screen.

Note: When you create trigger rules, the system does not validate that your entry is a valid value for the field or is within the maximum field positions. Refer to your Field/Table Listing to review field attributes for the Item table and SKU table.

Item Trigger Cleanup

Before processing the item download triggers, the Item Outbound job looks for duplicate unprocessed item download triggers.

Duplicate item download triggers exist if more than one trigger has the same:

• File code SKU

Item Outbound Trigger Rules

Item table criteria

SKU table criteria

Results

The Company field must equal 27 or 555.

no criteria defined

The system creates an item download trigger only if the item/SKU being created, maintained, or deleted is in company 27 or 555.

The Company field must equal 27 or 555.The Allow SKUs field must equal ’Y’.

The Warehouse field must equal 20.

The system generates an item download trigger only if the item/SKU being created, updated, or deleted is in company 27 or company 555 and the item is SKU’ed and the SKU is located in warehouse 20.If the item/SKU does not meet all of the criteria defined, a trigger is not created.

no criteria defined

The Warehouse field must equal 20.

The system generates an item download trigger only if the item/SKU is located in warehouse 20.

CWSerenade 5.0


• Capture type (C (change) or A (add))

• Key (company + item number + SKU code)

If duplicate item download triggers exist, the system removes the duplicates, leaving only the most recent item download trigger for that capture type.

Example: The following change item download triggers exist in the IL Outbound table:

Note: If both an add (Capture type A) and a change (Capture type C) item download trigger exists for the same Key, the system generates an Item Download XML Message (CWItemOut) for both triggers.

Processing Item Delete Triggers

The system processes item download triggers in the IL Outbound Trigger table with a delete (D) Capture type immediately, regardless of whether the Item Outbound job is active or inactive.

When you delete the item or SKU, the system:

• generates a delete item download trigger.

• generates a CWMessageBuilder xml message containing the trigger key and database access information and places this message in the Item Outbound configuration outbound queue. The system creates the CWMessageBuilder xml message with an expiry time that is 2 times the outbound delay time defined for the Item Outbound process.

• waits 2 times the outbound delay time defined for the Item Outbound process on the interactive screen before processing the delete to give the Item Outbound message builder time to read and process the CWMessageBuilder xml message.

If the Item Outbound message builder:

• reads the CWMessageBuilder xml message within the expiry time, the job generates a delete item download message and updates the associated item download trigger Status field to X (processed). The item download message for delete transactions contains all elements since an item can be identified using fields other than Item number and SKU code.

File Type Status Key Results

SKU C R 555ABC RED GRLS SMLL The system deletes 2 of these item download triggers, leaving only one change trigger to process.

SKU C R 555ABC RED GRLS SMLL

SKU C R 555ABC RED GRLS SMLL

CWSerenade 5.0


• does not read the CWMessageBuilder xml message within the expiry time, the job removes the CWMessageBuilder job from the Item Outbound configuration outbound queue, does not generate a delete item download message, and updates the associated item download trigger Status field to E (error), indicating the delete transaction was processed and an item download message was not generated.

If one or more unprocessed item download triggers exist in the IL Outbound Trigger table for the same Key, the system:

• if one of the matching item download triggers is an add (A) Capture type: does not create the delete item download trigger and removes any other matching item download triggers (add and change). Since the point of sale system never received the add trigger, you do not want to send a delete trigger or any other triggers.

Note: However, if an Original processed date and time exist for the add item download trigger (indicating the trigger was previously downloaded and then reset to reprocess again), the system generates an item download message for the delete item download trigger and removes any other matching item download triggers (add and change). Since the point of sale system previously received the add item download trigger, you want to send a delete notification to the system.

• if the matching item download trigger is a change (C) Capture type: generates an item download message for the delete item download trigger and removes any other matching change item download triggers. Since the point of sale system is receiving a delete trigger, you do not need to send any change triggers.

Example 1: When the system processes the delete item download trigger, an unprocessed add and change item download trigger exists in the IL Outbound table:

SKU Key Type Status Results

555AB101 A R Since the item/SKU has never been downloaded, the system does not create the delete item download trigger and instead removes the add and change triggers from the IL Outbound Trigger table.

555AB101 C R

CWSerenade 5.0


Example 2: When the system processes the delete item download trigger, a change item download trigger exists that has not been processed:

You can review item download triggers at the Work with Outbound Interface Transactions screen.

Item Outbound XML Inclusion

For each item download trigger, the Item Outbound message builder determines which elements to include in the item download message, based on XML inclusion rules.

You can define Item Outbound XML inclusion rules at the Outbound Interface XML Inclusion screen.

XML inclusion defines which elements to include in the item download message.

• If the element is included, that element and its parents are included in the generated item download XML message.

• If the element is excluded, that element and its children are excluded from the generated item download message.

This table indicates which elements in the item download message are included, based on which elements you flag to include or exclude.

SKU Key Type Status Results

555AB101 C R The system immediately generates an item download message for the delete item download trigger. The system removes the change item download trigger from the IL Outbound Trigger table (don’t bother sending the change since the item/SKU has now been deleted).

Include element in XML message? Element

Selected = Include ItemUnselected = Exclude Item and all of its children; the system sends a message with only the Message element and its attributes

Item

CWSerenade 5.0


Selected = Include ItemOffer and its parent ItemUnselected = Exclude ItemOffer and its children ItemPrice, PageLetterAlias, IOFAccompanyingItem, IOFUserField, IOFSpecialHandlingDetail and IOFSpecialHandlingResponse

ItemOffer

Selected = Include ItemPrice and its parents, ItemOffer and ItemUnselected = Exclude ItemPrice

ItemPrice

Selected = Include PageLetterAlias and its parents ItemOffer and ItemUnselected = Exclude PageLetterAlias

PageLetterAlias

Selected = Include IOFAccompanyingItem and its parents ItemOffer and ItemUnselected = Exclude IOFAccompanyingItem

IOFAccompanyingItem

Selected = Include IOFUserField and its parents ItemOffer and ItemUnselected = Exclude IOFUserField

IOFUserField

Selected = Include IOFSpecialHandlingDetail and its parents ItemOffer and ItemUnselected = Exclude IOFSpecialHandlingDetail and its child IOFSpecialHandlingResponse

IOFSpecialHandlingDetail

Selected = Include IOFSpecialHandlingResponse and its parents IOFSpecialHandlingDetail, ItemOffer, and ItemUnselected = Exclude IOFSpecialHandlingResponse

IOFSpecialHandlingResponse

Selected = Include ItemInformation and its parent ItemUnselected = Exclude ItemInformation and its child ItemInformationDetail

ItemInformation


CWSerenade 5.0


Selected = Include ItemInformationDetail and its parents ItemInformation and ItemUnselected = Exclude ItemInformationDetail

ItemInformationDetail

Selected = Include ItemComment and its parent ItemUnselected = Exclude ItemComment

ItemComment

Selected = Include ItemAttribute and its parent ItemUnselected = Exclude ItemAttribute

ItemAttribute

Selected = Include SourcePrice and its parent ItemUnselected = Exclude SourcePrice

SourcePrice

Selected = Include Coordinate and its parent ItemUnselected = Exclude Coordinate

Coordinate

Selected = Include Keyword and its parent ItemUnselected = Exclude Keyword

Keyword

Selected = Include Image and its parent ItemUnselected = Exclude Image

Image

Selected = Include Upsell and its parent ItemUnselected = Exclude Upsell

Upsell

Selected = Include Restriction and its parent ItemUnselected = Exclude Restriction

Restriction

Selected = Include EcommCategory and its parent ItemUnselected = Exclude EcommCategory

EcommCategory

Selected = Include ITMUserField and its parent ItemUnselected = Exclude ITMUserField

ITMUserField


CWSerenade 5.0


Selected = Include TaxExemption and its parent ItemUnselected = Exclude TaxExemption

TaxExemption

Selected = Include FreightExemption and its parent ItemUnselected = Exclude FreightExemption

FreightExemption

Selected = Include SKU and its parent ItemUnselected = Exclude SKU and all of its children VendorItem,

SKUItemInformation, ItemWarehouse, ContinuityItems, FinishedGood, SetItem, VariableSet, SKUComment, SKUAttribute, UPC,

SKUUserField

SKU

Selected = Include VendorItem and its parents SKU and ItemUnselected = Exclude VendorItem and its children VITPriceBreak, VITAdditionalCharge, VITNote, and VITUserField

VendorItem

Selected = Include VITPriceBreak and its parents VendorItem, SKU, and ItemUnselected = Exclude VITPriceBreak

VITPriceBreak

Selected = Include VITAdditionalCharge and its parents VendorItem, SKU, and ItemUnselected = Exclude VITAdditionalCharge

VITAdditionalCharges

Selected = Include VITNote and its parents VendorItem, SKU, and ItemUnselected = Exclude VITNote

VITNote

Selected = Include VITUserField and its parents VendorItem, SKU, and ItemUnselected = Exclude VITUserField

VITUserField


CWSerenade 5.0


Selected = Include SKUOffer and its parents SKU and ItemUnselected = Exclude SKUOffer and its children SKUPrice, SKUOfferPage, SKOAccompanyingItem, SKOUserField, and SKOSpecialHandlingDetail

SKUOffer

Selected = Include SKUPrice and its parents SKUOffer, SKU and ItemUnselected = Exclude SKUOfferPage

SKUPrice

Selected = Include SKUOfferPage and its parents SKUOffer, SKU, and ItemUnselected = Exclude SKUOfferPage

SKUOfferPage

Selected = Include SKOAccompanyingItem and its parents SKUOffer, SKU, and ItemUnselected = Exclude SKOAccompanyingItem

SKOAccompanyingItem

Selected = Include SKOUserField and its parents SKUOffer, SKU, and ItemUnselected = Exclude SKOUserField

SKOUserField

Selected = Include SKOSpecialHandlingDetail and its parents SKUOffer, SKU, and ItemUnselected = Exclude SKOSpecialHandlingDetail and its child SKOSpecialHandlingResponse

SKOSpecialHandlingDetail

Selected = Include SKOSpecialHandlingResponse and its parents SKOSpecialHandlingDetail, SKUOffer, SKU, and ItemUnselected = Exclude SKOSpecialHandlingResponse

SKOSpecialHandlingResponse

Selected = Include SKUItemInformation and its parents SKU and ItemUnselected = Exclude SKUItemInformation and its child SKUItemInformationDetail

SKUItemInformation


CWSerenade 5.0


Selected = Include SKUItemInformationDetail and its parents SKUItemInformation, SKU, and ItemUnselected = Exclude SKUItemInformationDetail

SKUItemInformationDetail

Selected = Include ItemWarehouse and its parents SKU and ItemUnselected = Exclude ItemWarehouse and its child ITWUserField

ItemWarehouse

Selected = Include ITWUserField and its parents ItemWarehouse, SKU, and ItemUnselected = Exclude ITWUserField

ITWUserField

Selected = Include ContinuityItems and its parents SKU and ItemUnselected = Exclude ContinuityItems and its child ContinuityItem

ContinuityItems

Selected = Include ContinuityItem and its parents ContinuityItems, SKU, and ItemUnselected = Exclude ContinuityItem

ContinuityItem

Selected = Include FinishedGood and its parents SKU and ItemUnselected = Exclude FinishedGood

FinishedGood

Selected = Include SetItem and its parents SKU and ItemUnselected = Exclude SetItem

SetItem

Selected = Include VariableSet and its parents SKU and ItemUnselected = Exclude VariableSet and its children VariableSetGroup and VariableSetItem

VariableSet


CWSerenade 5.0


Selected = Include VariableSetGroup and its parents VariableSet, SKU, and ItemUnselected = Exclude VariableSetGroup and its child VariableSetItem

VariableSetGroup

Selected = Include VariableSetItem and its parents VariableSetGroup, VariableSet, SKU, and ItemUnselected = Exclude VariableSetItem

VariableSetItem

Selected = Include SKUComment and its parents SKU and ItemUnselected = Exclude SKUComment

SKUComment

Selected = Include SKUAttribute and its parents SKU and ItemUnselected = Exclude SKUAttribute

SKUAttribute

Selected = Include UPC and its parents SKU and ItemUnselected = Exclude UPC

UPC

Selected = Include SKUUserField and its parents SKU and ItemUnselected = Exclude SKUUserField

SKUUserField


CWSerenade 5.0

3/24/15 CWSerenade Setup for the Item Download API 514

CWSerenade Setup for the Item Download API

Before you can generate item download messages, you must perform the necessary CWSerenade setup and processing.

Information requiring setup includes:

• System Control Value

• Menu Options

• Periodic Functions

CWSerenade 5.0


System Control Value

Menu Options


Create Generic Item Download Trigger Records (I15)

Select this field to create triggers in the IL Outbound Trigger table for certain actions in CWSerenade.

Outbound Interface Trigger File Purge Days (I14)

Enter the number of days to retain records in the IL Outbound Trigger table before purging them. Run the PURGIJT periodic function (program name ILR0026) to delete any records if: Last processed date is less than the current system date by the number of purge days and Status is X. You can also use the Purge option at the Work with Outbound Interface Transactions screen to purge records.Example: Today is 2/07, and you have set this value to 1. Any record whose Last processed date is 2/06 or earlier is purged.

Item Values (I91) Use this umbrella system control value to specify whether certain fields are required when creating an item: • Require L/S Division with L/S Department (E85) • Require L/S Department (I92) • Require L/S Class (I93) • Require L/S Style (I94) • Require Item Class (F06)

Menu Option Description

Generate Outbound Interface Triggers (GOIT)

Allows you to create an IL outbound trigger record for each item/SKU in your company. Run this process to initially send item/SKUs to the point of sale system.

Work with Outbound Interface Transactions (WOIT)

Allows you to review, delete, or resend IL outbound trigger records.

CWSerenade 5.0


Periodic Functions

Work with Integration Layer Processes (IJCT)

When active, the Item Outbound job creates an Item Download XML Message (CWItemOut) for each record in the IL Outbound Trigger table. You can also define: • trigger rules; see Item Outbound Trigger Rules.• configuration options.• XML inclusion rules; see Item Outbound XML Inclusion.• the queues where the item download message are sent; see Work with Integration Layer Process Queues screen.

Periodic Function Description

Purge IJCT Download (program name ILR0026)

Run this periodic function to purge processed IL outbound triggers, based on the Outbound Interface Trigger File Purge Days (I14) system control value: Last processed date is less than the current system date by the number of purge days and Status is X

Menu Option Description

CWSerenade 5.0

3/24/15 Item Download XML Message (CWItemOut) 517

Item Download XML Message (CWItemOut)

The item download message contains item and SKU information to send from CWSerenade to another system, such as a retail store or warehouse management system. See Generic Item Download API for an overview.

Message formatting specific to item download:

• Delete transactions contain all elements (based on XML inclusion rules) since an item can be identified using fields other than Item number and SKU code.

• For non-SKU’d items, the SKU element does not include the SKU_Code attribute. The following elements are not included for non-SKU’d items:

• SKUOffer and its children, SKUPrice, SKUOfferPage, SKOAccompanyingItem, SKOUserField, SKOSpecialHandlingDetail, SKOSpecialHandlingResponse.

• SKUItemInformations and its children, SKUItemInformation, SKUItemInformationDetails, and SKUItemInformationDetail.

• SKUComments and its child, SKUComment.• SKUAttributes and its child, SKUAttribute.• SKUUserFields and its child, SKUUserField.

• If you exclude the element Item and all of its children (using the Item Outbound XML Inclusion rules), the system sends an item download message including the Message element and Items element with no attributes.

• Explicit decimal points are included in numeric fields.

CWSerenade 5.0


Item elements:

CWSerenade 5.0


SKU elements:

Item download message: See Item Download Message: Sample XML for a sample message.


Message

source alpha 25 Identifies the source of the XML message. RDC indicates the XML message is from CWSerenade.


CWSerenade 5.0


type alpha 25 Identifies the type of information in the XML message. CWITEMOUT indicates the message contains item download information.

Item Each item download message contains one Item element and one SKU element. For example, if you update a SKU’ed item, the system generates a separate item download message for each SKU. The Transaction_type attribute defines whether this message is an add, change, or delete of an item/SKU.

Transaction_type alpha 1 Indicates the type of item/SKU information being downloaded.• A (add) = new item/SKU.• C (change) = changed item/SKU.• D (delete) = deleted item/SKU.

Company numeric 3 The CWSerenade company where the item is located.From the Company field in the Item table.

Item_Number alpha 12 The item number whose information you are downloading.From the Item number field in the Item table.

Allow_SKUs alpha 1 Indicates whether the item contains SKUs.• Y = The item contains SKUs.• N = The item does not contain SKUs.From the Allow SKUs field in the Item table.

Item_average_cost numeric 11.4 The average cost of the item.From the Average cost field in the Item table.

ITM_Cubing_value numeric 7.1 The cubic volume of the item, indicating the number of units of the item that can fit into a carton.From the Cub val field in the Item table.


CWSerenade 5.0


Drop_ship_item alpha 1 Indicates whether you ship the item from your warehouse, or have your vendor ship it to the customer directly.• Y (drop ship) = When a customer orders the item, you order the item from your vendor and the vendor ships it directly to your customer.• N or blank (non-drop ship) = You ship the item from your warehouse.From the Drop ship field in the Item table.

FIFO_cost numeric 11.4 The FIFO cost of the item.From the FIFO cost field in the Item table.

Item_height numeric 3 The height measurement for the item. The Height, Length, and Width values are used to determine the cubic volume of the item.From the Height field in the Item table.

Kit_type alpha 1 Defines the type of kit or set functionality for the item.• C = Continuity program• S = Set item• F = Finished good item• V = Variable set itemFrom the Kit type field in the Item table.

Item_length numeric 3 The length measurement for the item. The Height, Length, and Width values are used to determine the cubic volume of the item.From the Length field in the Item table.

Long_SKU_style alpha 20 A user-defined field you can use to further identify the item. From the Long SKU style field in the Item table.

Long_SKU_vendor alpha 7 A user-defined field you can use to further identify the item.From the Long SKU vendor field in the Item table.


CWSerenade 5.0


Lot_Nbr_tracking alpha 1 Indicates if you track the item using a lot number.• Y = You track the item by lot number.• N or blank = You do not track the item by lot number.From the Lot # tracking field in the Item table. Note: This field is not currently implemented.

Non-inventory alpha 1 Indicates whether inventory levels are maintained for the item.• Y = The item is a non-inventory item.• N or blank = The item is a regular item whose inventory levels are maintained.From the Non-inventory field in the Item table.

Partial_units alpha 1 From the Partial units field in the Item table.

Pieces_per_case numeric 5 Determines the number of units that fit in a case.From the Pieces per case field in the Item table.

Selling_qty numeric 5 The required order quantity (or multiple of) for the item.From the Selling qty field in the Item table.

Selling_weight numeric 7.3 The selling weight of the item, used to calculate the freight charge on an item when the freight method on the order is Freight by weight or Freight by order weight.From the Selling weight field in the Item table.

Serial_Nbr_tracking

alpha 1 Determines whether each unit of the item has a specific serial number that should be tracked.• Y = The item uses serial numbers. • N or blank = The item does not use serial numbers.From the Serial # tracking field in the Item table.


CWSerenade 5.0


Ship_alone alpha 1 Indicates how to ship the item.• S = The item must ship by itself, and each unit prints on its own pick slip.• M = The item can ship with other items that also have an M in the Ship alone field. • L = The item prints on the pick slip in location class sequence along with other items belonging to the same class. • U = The item follows special shipping requirements, based on a user-defined code.From the Ship alone field in the Item table.

Ship_weight numeric 7.3 The actual shipping weight of the item. From the Ship weight field in the Item table.

Standard_cost numeric 11.4 The standard cost of the item. From the Standard cost field in the Item table.

User_field_1 alpha 10 A user-defined field for the item.From the User field 1 field in the Item table.




Width numeric 3 The width measurement for the item. The Height, Length, and Width values are used to determine the cubic volume of the item.From the Width field in the Item table.

Expiration_limit numeric 5 From the Expiration limit field in the Item table.

FIFO_Tracking alpha 1 Indicates if the item cost is tracked using FIFO costing.• Y = The item cost is tracked using FIFO costing.• N = The item cost is not tracked using FIFO costing.From the FIFO tracking field in the Item table.


CWSerenade 5.0


ITM_Allow_Pct_discount

alpha 1 Determines whether the item is eligible for a discount percent during order entry.• Y = The item is eligible for a percent discount.• N = The item is not eligible for a percent discount.From the Allow % discount? field in the Item table.

CasePiece alpha 1 From the C/P field in the Item table.

ITM_Oversize_flag alpha 1 Determines whether the item is considered an oversized item.• Y = The item is oversized.• N or blank = The item is not oversized.From the Oversize field in the Item table.

ITM_Description alpha 40 A description of the item.From the Description field in the Item table.

ITM_Required_truck_item

alpha 1 Indicates if the item is a required truck item (when the item is ordered, the system uses the truck ship via as an override on the order line).• Y = The item is a required truck item.• N or blank = The item is not a required truck item.From the Required truck item field in the Item table.

ITM_Second_Language_Desc

alpha 40 The second language description defined for the item.From the Second language desc field in the Item table.

ITM_Exclude_From_Flex_Pay

alpha 1 Determines whether the item is excluded from deferred and installment payment plans. • Y = Exclude the item from deferred and installment payment plans.• N or blank = Do not exclude the item from deferred and installment payment plans.From the Exclude from flex pay field in the Item table.


CWSerenade 5.0


ITM_Royalty alpha 1 Indicates whether sales of the item require royalty payments to an author or owner.• Y = This is a royalty item.• N = This is not a royalty item.From the Royalty field in the Item table.

ITM_Membership alpha 1 Indicates the item represents a membership program, which you can use to generate periodic orders to a customer.• Y = This is a membership item. You should set the Non-inventory field for a membership item to Y.• N or blank = This is not a membership item.From the Membership field in the Item table.

ITM_Generic_Ecommerce

alpha 20 From the Generic ecommerce field in the Item table.

ITM_Last_Ecomm_Info_Chg

numeric 7 The date the item was last changed for e-commerce.From the Last ecomm info chg field in the Item table.

ITM_Qty_Threshold

numeric 9 Indicates when to trigger an automatic download of item availability information to the e-commerce staging tables; from there, the information is available to the web storefront.From the Qty threshold field in the Item table.

ITM_Create_Date numeric 7 The date the item was created.From the Create date field in the Item table.

ITM_Retail_Style_Nbr

alpha 20 A user-defined code used to identify the item.From the Retail style # field in the Item table.

Buyer alpha 3 A code that represents a person who is authorized to make purchases for your company.From the Buyer field in the Item table.


CWSerenade 5.0


Buyer_Name alpha 30 The name of the buyer.From the Name field in the Item table.

CTN_ID_Nbr numeric 2 The type of carton in which the item must be shipped.From the CTN ID # field in the Item table.

GLA_Account_Nbr numeric 8 The general ledger account number assigned to the item.From the Account # field in the Item table.

Inventory_value_GLNbr

numeric 8 The general ledger account number to use for inventory transactions.From the Inventory value G/L# field in the Item table.

HAZ_Code numeric 2 A code used to categorize the item as a hazardous material that requires special storage and handling. From the Code field in the Item table.

HAZ_Description alpha 40 A description of the hazard code.From the Description field in the Hazard table.

HAZ_Class alpha 15 A class of hazardous materials such as flammable or radioactive.From the Class field in the Hazard table.

HAZ_Label_type alpha 15 The type of label that should be produced for the type of hazardous material. The label identifies the hazardous item as flammable or radioactive to warehouse personnel or shippers.From the Label type field in the Hazard table.

Item_class alpha 3 A code that identifies a group of items. From the Item class field in the Item table.

ICL_Description alpha 30 A description of the item class.From the Item class description field in the Item Class table.


CWSerenade 5.0


ICL_Commission_Pct

numeric 5.2 A percentage used to calculate commissions for sales representatives selling the class of items.From the Comm % field in the Item Class table.

ICL_Estimated_Frt numeric 7.2 Your “best guess” on the vendor’s freight charges for items in the item class. This unit amount is added to an item’s cost to represent the estimated freight charges.From the Estimated frt field in the Item Class table.

ICL_Estimated_Frt_Pct

numeric 5.2 Your “best guess” on the vendor’s freight charges for items in the item class. This percentage amount is added to an item’s cost to represent the estimated freight charges.From the Estimated frt % field in the Item Class table.

ICL_Desired_GM_Pct

numeric 5.2 The percentage margin % of the item’s price that should exceed the cost of the item, so that the selling price of the item results in a profitable outcome.From the Desired G/M % field in the Item Class table.

ICL_VAT_Exempt alpha 1 Indicates whether the item class is exempt from VAT.• Y = The item class is exempt from VAT.• N or blank= The item class is not exempt from VAT.From the VAT exempt? field in the Item Class table.

ICL_Hidden_Tax_Amount

numeric 11.2 The amount to include in the Hidden tax field for an item class subject to VAT. On orders subject to VAT and tax-inclusive pricing, tax does not accumulate in the Tax bucket for the order; instead, you charge a tax-inclusive price for items, and the tax is "hidden" on the order detail line.From the Hidden tax amount field in the Item Class table.


CWSerenade 5.0


ICL_Qty_Threshold numeric 5 Indicates when to trigger an automatic download of item availability information to the e-commerce staging tables for the item class; from there, the information is available to the web storefront.From the Qty threshold field in the Item Class table.

ICL_Hidden_Tax_Pct

numeric 5.2 The percent to include in the Hidden tax field for an item class subject to VAT. On orders subject to VAT and tax-inclusive pricing, tax does not accumulate in the Tax bucket for the order; instead, you charge a tax-inclusive price for items, and the tax is "hidden" on the order detail line.From the Hidden tax % field in the Item Class table.

CRV_Code numeric 3 A code used in forecasting for inventory projection and analysis reporting. The curve determines weekly projections of sales for items within the item class. From the CRV code field in the Item Class table.

ICL_GLA_Account_Nbr

numeric 8 The general ledger number for posting sales for items in this item class. From the Account # field in the Item Class table.

Discount_GLA_Account_Nbr

numeric 8 The general ledger number for posting discounts on sales for items in this item class.From the Discount GLA account # field in the Item Class table.

Return_GLA_Account_Nbr

numeric 8 The general ledger number for posting returns on items in this item class. From the Return GLA account # field in the Item Class table.

Return_Discount_GLA_Accou

numeric 8 The general ledger number for posting discounts on returns for items in this item class.From the Return discount GLA account # field in the Item Class table.


CWSerenade 5.0


ICL_Cost_Good_Sold_GL_Nbr

numeric 8 The general ledger number for posting item cost for sales.From the Cost good sold G/L # field in the Item Class table.

ICL_Cost_Good_Rtn_GL_Nbr

numeric 8 The general ledger number for posting item cost for returns.From the Cost good Rtn G/L # field in the Item Class table.

Cycle alpha 2 A code that identifies a physical inventory cycle. From the Cycle field in the Item table.

CYC_Days numeric 5 The number of days between physical counts of items assigned to this cycle code.From the Days field in the Item Cycle table.

CYC_Description alpha 30 A description of the item cycle.From the Description field in the Item Cycle table.

SKU_group numeric 3 A code that represents a group of common characteristics of a SKUed item.From the SKU group field in the Item table.

SKU_group_description

alpha 40 A description of a SKU group.From the Description field in the Item SKU Group table.

Item_status alpha 1 A code that represents an item’s status, such as discontinued or active.From the STS field in the Item table.

Item_status_description

alpha 30 A description of the item status.From the Description field in the Item Status table.

IST_Message_line_1

alpha 50 A message displayed in order entry and maintenance for items with this status code.From the IST message line 1 field in the Item Status table.

IST_Message_line_2

alpha 50 A message displayed in order entry and maintenance for items with this status code.From the IST message line 2 field in the Item Status table.


CWSerenade 5.0


IST_Return_disposition

alpha 2 A code that identifies how to handle the returned merchandise (whether the return updates inventory).From the IST return disposition field in the Item Status table.

LCL_Location_class

alpha 2 A code that represents a location type, such as caged area. From the LCL location class field in the Item table.

LCL_Description alpha 30 A description of the location class.From the Description field in the Location Class table.

LSD_Department numeric 4 A code used to group items into long SKU departments for reporting purposes.From the Department field in the Item table.

LSD_Description alpha 30 A description of the long SKU department.From the Description field in the Long SKU Department table.

LSD_Long_Sku_Division

alpha 3 The division associated with the long SKU department.From the LSD long SKU division field in the Long SKU Department table.

Long_SKU_Div_Description

alpha 30 A description of the long SKU division.From the Description field in the Long SKU Division table.

Long_SKU_class numeric 4 A code used to group items into long SKU classes for reporting purposes.From the Class field in the Item table.

LSC_Description alpha 30 A description of the long SKU class.From the Description field in the Long SKU Class table.

Unit_of_measure alpha 3 The unit of measure defined for the item, for example each or case of 12.From the UOM field in the Item table.

UOM_Description alpha 30 A description of the unit of measure.From the UOM description field in the Unit of Measure table.


CWSerenade 5.0


UOM_Units numeric 5 The number of units represented by the unit of measure, such as 12 units in a case.From the UOM units field in the Unit of Measure table.

Vendor_Nbr numeric 7 A code that identifies the vendor, or supplier, of the item.From the Vendor # field in the Item table.

VIA_Ship_via_code numeric 2 A code that represents the carrier to use when shipping the item. From the VIA ship via code field in the Item table.

VIA_Shipper_name alpha 30 The name of the carrier used to ship the item.From the VIA shipper name field in the Ship Via table.

Warehouse numeric 3 A code that represents the primary warehouse where you keep the item. From the Whs field in the Item table.

Warehouse_name alpha 30 The name of the primary warehouse.From the Name field in the Warehouse table.

Manufacturer_Vendor

numeric 7 The vendor who manufactured the item.From the Manufacturer vendor VND V field in the Item table.

ITM_ENT_Entity_Number

numeric 3 The entity, or business unit, associated with the item.From the ITM ENT entity number field in the Item table.

ENT_Description alpha 25 A description of the entity.From the ENT description field in the Entity table.

ITM_SEA_Season alpha 3 The season associated with the item, such as spring.From the ITM SEA season field in the Item table.

SEA_description alpha 30 A description of the season.From the Description field in the Season table.


CWSerenade 5.0


SEA_Start_date numeric 7 The date that indicates the beginning of the season.From the SEA start date field in the Season table.

SEA_End_date numeric 7 The date that indicates the end of the season.From the SEA end date field in the Season table.

ITM_SVC_Type alpha 1 A code that indicates the item is a stored value card, and whether the stored value card is a physical or virtual card.• blank (default) = The item is not a stored value card.• P = The item is a physical stored value card.• E = The item is a physical stored value card and, as soon as the stored value card is processed through billing, the system sends an email notification to the recipient card holder, notifying the customer that a stored value card has been purchased and is in the process of being delivered.• V = The item is a virtual (non-physical) stored value card.

ItemOffer The ItemOffer element repeats for each item offer record defined for the item in the Item Offer table.

Offer_Number alpha 3 A code that represents the offer where the item is advertised.From the Offer number field in the Item Offer table.

Cost numeric 7.2 The cost to include the item in the offer.From the Cost field in the Item Offer table.

Expected_return_pct

numeric 5.2 The percentage of returns you expect to receive for the item/offer. From the Expected return pct field in the Item Offer table.


CWSerenade 5.0


Gift_wrap_flag alpha 1 Indicates if gift wrapping is available for the item in the offer.• Y = The item can be gift wrapped.• N = The item cannot be gift wrapped in this offer.From the G/W flag field in the Item Offer table.

Gift_wrap_price numeric 7.2 The price in the offer for gift wrapping the item. From the G/W price field in the Item Offer table.

Page_Nbr numeric 5 The primary page number where the item appears in the offer.From the Page # field in the Item Offer table.

Projected_units numeric 7 The number of units of the item you expect to sell in the offer. From the Projected units field in the Item Offer table.

SH_price numeric 7.2 The price to charge the customer for special handling. From the S/H price field in the Item Offer table.

Special_handling alpha 1 Indicates if the item is eligible for special handling in the offer.• Y = The item is eligible for special handling in the offer.• N = The item is not eligible for special handling in the offer.From the S/H flag field in the Item Offer table.

Square_inches numeric 5.2 The square inches that the item occupies in the offer. From the Square inches field in the Item Offer table.

Term_payment_interval

numeric 5 The number of days between payments.From the Term payment interval field in the Item Offer table.


CWSerenade 5.0


Standard_price numeric 7.2 The standard price for the item in the offer.From the Standard price field in the Item Offer table.

Freight numeric 6.2 The freight amount to charge for the item in the offer.From the Freight field in the Item Offer table.

Hidden_freight numeric 6.2 The hidden freight amount to charge for the item in the offer.From the Hidden freight field in the Item Offer table.

IOF_Spread alpha 3 From the IOF spread field in the Item Offer table.

IOF_Volume_Discount_YN

alpha 1 Indicates if the item is eligible for a volume discount in the offer.• Y = The item is eligible for a volume discount.• N = The item is not eligible for a volume discount.From the IOF volume discount Y/N field in the Item Offer table.

IOF_Coupon_Disc_dlr

numeric 7.2 The coupon dollar amount subtracted from the price when the item is ordered from the offer.From the IOF coupon disc $ field in the Item Offer table.

IOF_Coupon_Effective_Date

numeric 7.0 The date the coupon becomes effective.From the IOF coupon effective date field in the Item Offer table.

IOF_Featureoption alpha 1 A code that indicates if the item is considered a featured or optional item in an advertisement for the offer.• F = The item is the featured item in the advertisement.• O = The item is an optional item in the advertisement.From the Feature/option field in the Item Offer table.


CWSerenade 5.0


IOF_Pickupnew alpha 1 A code that indicates if the item has been carried over from a previous offer or is new to your product offerings.• P = Item is a pickup item, previously sold in another offer.• N = Item is a new addition in the offer.From the Pickup/new field in the Item Offer table.

IOF_Sale_Book_Item_Flag

alpha 1 Indicates if the item is on sale.• Y = The item is on sale.• N = The item is not on sale.From the IOF sale book item flag field in the Item Offer table.

IOF_Qty_Break_Upsl_Thrshd

numeric 5 From the IOF qty break upsl thrshd field in the Item Offer table.

IOF_Pop_Up_Message_1

alpha 30 From the IOF pop up message 1 field in the Item Offer table.







IOF_Warranty_Item

alpha 1 Indicates if the item in the offer is a warranty item.• Y = The item is a warranty item.• N = The item is not a warranty item.From the IOF warranty item? field in the Item Offer table.

IOF_Required_Add_Reason

alpha 1 Indicates if an add reason code is required when the item in the offer is added to an order.• Y = An add reason code is required.• N = An add reason code is not required.From the IOF required add reason? field in the Item Offer table.

IOF_Included_Internet_Ofr

alpha 1 From the IOF future use Y/N 1 field in the Item Offer table.


CWSerenade 5.0


CRV_Code numeric 3 A code that represents the item’s expected selling pattern in the offer.From the CRV code field in the Item Offer table.

CRV_Description alpha 30 A description of the curve code.From the Description field in the Curve table.

CRV_Curve_type alpha 1 A user-defined code used to group projection curves.From the Curve type field in the Curve table.

ADD_Addl_chg_code

alpha 2 The additional charge code associated with the type of special handling you are offering for the item in the offer.From the ADD Add’l chg code field in the Item Offer table.

ADD_Description alpha 30 A description of the additional charge.From the ADD description field in the Additional Charge table.

SHF_Code alpha 2 A code that indicates the format of the custom special handling offered for the item in the offer.From the SHF code field in the Additional Charge table.

SHF_Description alpha 30 A description of the custom special handling.From the Description field in the Special Format table.

IOF_AOC_Add-On_Code

alpha 3 From the IOF AOC add-on code field in the Item Offer table.

ItemPrice The ItemPrice element repeats for each item price record defined for the item in the Item Price table.

Effective_date numeric 7 The date the price or quantity break discount becomes valid.From the Effective date field in the Item Price table.


CWSerenade 5.0


Qty numeric 7 The amount of the item that the customer must order to receive the discounted price.From the Qty field in the Item Price table.

Associate_price numeric 7.2 The price at which the item is sold to associate customers.From the Associate price field in the Item Price table.

Price numeric 7.2 The price at which the item is sold.From the Price field in the Item Price table.

IPR_Price_column alpha 1 A code that indicates the pricing column associated with the price.From the Price column field in the Item Price table.

IPR_Associate_tax numeric 7.2 The price at which the item is sold to associate customers on orders subject to tax-inclusive pricing and VAT.From the Tax inclusive associate price field in the Item Price table.

IPR_Tax_price numeric 7.2 The price at which the item is sold on orders subject to tax-inclusive pricing and VAT.From the Tax incl price field in the Item Price table.

IPR_No_Charge alpha 1 Indicates if the item is sold at no charge.• Y = The item is sold at no charge.• N = The item is sold for a price.From the IPR no charge? field in the Item Price table.

PageLetterAlias The PageLetterAlias element repeats for each page letter alias record defined for the item offer in the Page Letter Alias table.

Seq_Nbr numeric 3 The sequence number assigned to the page letter alias record.From the Seq # field in the Page Letter Alias table.

Page_letter alpha 6 The letter assignment for an item in the offer. From the Page letter field in the Page Letter Alias table.


CWSerenade 5.0


Page_Nbr numeric 5 The page number displaying the item in the catalog.From the Page # field in the Page Letter Alias table.

Cost numeric 11.4 The cost to include the item on the page in the offer.From the Cost field in the Page Letter Alias table.

Square_inch numeric 5.2 The number of square inches that the item occupies on the catalog page. From the Square inch field in the Page Letter Alias table.

Alias_item alpha 12 The alternate item code for the actual item.From the Alias item field in the Page Letter Alias table.

IOFAccompanyingItem The IOFAccompanyingItem element repeats for each accompanying item record defined for the item offer in the Accompanying Item table.

ACI_Qty_required numeric 5 The amount of the item that must be ordered to qualify for receiving the accompanying item.From the Qty req’d field in the Accompanying Item table.

ACI_Qty numeric 5 The number of accompanying items to add to the order.From the Qty field in the Accompanying Item table.

ACI_Free_gift alpha 1 Indicates if the accompanying item is added to the order free of charge.• Y = The accompanying item is being offered free of charge.• N = The accompanying item is not free of charge.From the Free gift? field in the Accompanying Item table.


CWSerenade 5.0


ACI_Use_Ordered_Qty

alpha 1 Indicates if the accompanying item is ordered in the same quantity as the qualifying item.• Y = The accompanying item is ordered in the same quantity as the qualifying item.• N = The accompanying item is not ordered in the same quantity as the qualifying item.From the ACI use ordered qty? field in the Accompanying Item table.

ACI_ITM_Number alpha 12 The accompanying item to add to the order if the customer orders the required quantity of the originating item.From the ACI ITM number field in the Accompanying Item table.

ACI_SKU_Code alpha 14 The SKU of the accompanying item to add to the order.From the ACI SKU code field in the Accompanying Item table.

IOFUserField The IOFUserField element repeats for each item offer user field record defined for the item offer in the Item Offer User Field table.

IOF_UDF_Sequence_Nbr

numeric 3 The sequence number assigned to the item offer user field.From the Seq# field in the Item Offer User Field table.

IOF_UDF_Text alpha 30 The text defined for the item offer user field.From the Text field in the Item Offer User Field table.

IOF_UDF_Number numeric 16 The number defined for the item offer user field.From the Number field in the Item Offer User Field table.

IOF_UDF_Date numeric 7 The date defined for the item offer user field.From the Date field in the Item Offer User Field table.


CWSerenade 5.0


IOF_UDF_Display_sequence

numeric 3 The display sequence number assigned to the item offer user field.From the Display sequence field in the Item Offer User Field table.

IOF_UDF_File_code

alpha 3 The code representing the table to which the user-defined field is linked. For item offer user fields, the file code is IOF.From the IOF UDF file code field in the Item Offer User Field table.

UDD_Field_label alpha 15 The field label that appears on a screen for the item offer user field.From the Field label field in the User Defined Field Detail table.

UDD_Field_type alpha 1 A code that identifies the type of field.• D = Date field.• N = Number field.• T = Text field.From the Field type field in the User Defined Field Detail table.

UDD_Field_usage alpha 1 A code that identifies whether you are collecting the field information for the user-defined field.• I (Input) = you can enter information in this field.• O (output) = you cannot enter information in this field.From the Field usage field in the User Defined Field Detail table.

IOFSpecialHandlingDetail The IOFSpecialHandlingDetail element repeats for each special handling detail record defined for the item offer in the Item Offer User Field table.

SFD_Seq_Nbr numeric 3 The sequence number assigned to the special handling detail. From the SFD seq # field in the Special Format Details table.

SFD_Display_Seq numeric 3 The display sequence number assigned to the special handling detail.From the SFD display seq field in the Special Format Details table.


CWSerenade 5.0


SFD_Prompt_Text alpha 15 The field label name of the special handling detail input field.From the SFD prompt text field in the Special Format Details table.

SFD_Required_field

alpha 1 Indicates if the special handling detail is required.From the SFD required field in the Special Format Details table.

SFD_Feature_options

alpha 1 Indicates if the special handling detail is a feature option. A feature option is an extra feature that can be added to the item.• Y = The special handling detail is a feature option.• N = The special handling detail is not a feature option.From the SFD feature options field in the Special Format Details table.

SFD_Default_value alpha 45 From the Default value field in the Special Format Details table.

SFD_Default_charge_dlr

numeric 7.2 The price to charge the customer for the special handling detail feature option.From the SFD default charge $ field in the Special Format Details table.

SFD_Default_charge_Pct

numeric 5.2 The percentage used to calculate the price of the special handling detail feature option.From the SFD default charge % field in the Special Format Details table.

SFD_Default_cost_dlr

numeric 11.4 The cost of the special handling detail feature option.From the SFD default cost $ field in the Special Format Details table.

SFD_Default_cost_Pct

numeric 5.2 The percentage used to calculate the cost of the special handling detail feature option.From the SFD default cost % field in the Special Format Details table.


CWSerenade 5.0


SFD_Default_text alpha 2 A code that allows you to select text from the customer record to default to the custom special handling detail.From the SFD default text field in the Special Format Details table.

SFD_Max_Nbr_characters

numeric 2 The maximum number of characters allowed for the special handling detail.From the SFD max # characters field in the Special Format Details table.

SFD_Cross_Reference

alpha 3 A code used to cross reference the special handling detail to the element’s code on the manufacturing system.From the SFD cross reference field in the Special Format Details table.

IOFSpecialHandlingResponse The IOFSpecialHandlingResponse element repeats for each item information record defined for the item’s class in the Item Class Template table.

SFD_Seq_Nbr numeric 3 The sequence number assigned to the special handling response.From the SFD seq # field in the Special Format Responses table.

SFR_Valid_response

alpha 45 A valid special handling response.From the Valid response field in the Special Format Response table.

SFR_Description alpha 45 A description of the response.From the SFR description field in the Special Format Response table.

ItemInformation The ItemInformation element repeats for each item information record defined for the item’s class in the Item Class Template table.


CWSerenade 5.0


Template alpha 2 The type of template for item information.• CS = Customer Service• PC = Product Comments• PO = Purchase Orders• QC = Quality Control• RP = Reporting (E-Commerce)From the Template field in the Item Class Template table.

Sequence_Nbr numeric 3 The sequence number assigned to the template.From the Seq # field in the Item Class Template table.

Heading alpha 20 A description of the item class template.From the Heading field in the Item Class Template table.

Lines_available numeric 3 The number of lines available in this template for the entry of information.From the Lines available field in the Item Class Template table.

ItemInformationDetail The ItemInformationDetail element repeats for each item information detail defined for the item in the Item Information table.Note: The system includes ItemInformationDetail only if the Item information field in the Item Information table contains a value.

Sequence_Nbr numeric 3 The sequence number assigned to the item information line.From the Seq # field in the Item Information table.

Item_information_Line

alpha 50 The item information defined for the item under a particular template heading.From the Item information field in the Item Information table.

ItemComment The ItemComment element repeats for each item comment defined for the item in the SKU Comments table.


CWSerenade 5.0


Seq_Nbr numeric 3 The sequence number assigned to the item comments.From the Seq # field in the SKU Comments table.

Comment_line alpha 50 The comments entered for the item.From the Comment field in the SKU Comments table.

Print_code alpha 1 Indicates where to print or display the item comments.• B = Print on the pick slip and on the invoice, if supported by your unique invoice print program.• N = Do not print.• P = Print on pick slip.• R or blank = Print on reports. This option is not currently implemented.• I = Print on the invoice, if your unique invoice print program supports it.• W = Display on pop-up window when you select an item to add to an order.From the Print code field in the SKU Comments table.

ItemAttribute The ItemAttribute element repeats for each item attribute defined for the item in the Item Attribute table.

IAT_Type alpha 6 A code that identifies an item attribute.From the Type field in the Item Attribute table.

IAT_Description alpha 30 A description of the item attribute type.From the Description field in the Item Attribute table.

IAV_Value alpha 6 A code that identifies an attribute value.From the Value field in the Item Attribute Value table.

IAV_Description alpha 30 A description of the attribute value.From the Description field in the Item Attribute Value table.


CWSerenade 5.0


IAA_Affinity_flag alpha 1 Determines how the system tracks the customer affinity preferences for the item.• U = Upsell only. Upsell the item to a customer flagged with the attribute value.• C = Capture only. When the customer orders the item, the customer’s affinity preference history is updated.• B = Both upsell and capture.• N = Neither upsell nor capture.From the Affinity flag field in the Item Attribute Assignment table.

SourcePrice The SourcePrice element repeats for each source price for the item in the Special Pricing by Source table.

SRC_Source_code alpha 9 The source code associated with special price breaks for items by source code.From the SRC source code field in the Special Pricing By Source table.

SPS_Qty numeric 5 The number of units of the item that the customer must purchase to receive the special price.From the SPS quantity field in the Special Pricing by Source table.

SPS_Price numeric 7.2 The special price for the item, quantity, and source code.From the SPS price field in the Special Pricing By Source table.

SPS_Associate_price

numeric 7.2 The special price for the item for associate customers.From the SPS associate price field in the Special Pricing By Source table.

SPS_Tax_price numeric 7.2 The special price of the item if the order is subject to VAT.From the Tax incl price field in the Special Pricing By Source table.

SPS_Associate_tax_price

numeric 7.2 The special price of the item for associate customers if the order is subject to VAT.From the Tax inclusive associate price field in the Special Pricing By Source table.


CWSerenade 5.0


Coordinate The Coordinate element repeats for each coordinate for the item in the Item Coordinate table.

ICN_Coordinate_item

alpha 12 The related item coordinated to the primary item for cross-selling purposes.From the Coordinate item field in the Item Coordinate table.

ICN_Message alpha 70 The persuasive or descriptive message to display for the coordinate item.From the Message field in the Item Coordinate table.

ICN_Sequence numeric 3 The sequence number assigned to the item coordinate type, indicating the sequence in which the Display Coordinate Items window displays coordinate items assigned to this type in order entry. From the Seq field in the Item Coordinate table.

ICN_Coordinate_type

alpha 2 A code representing a type of item coordinate, such as mandatory or optional. From the Type field in the Item Coordinate table.

Keyword The Keyword element repeats for each keyword for the item in the Keyword table.

KWD_Type alpha 1 Indicates whether the word is created as a keyword for the item.• I = Include the word as a keyword for the item.• E = Do not include the word as a keyword for the item; for example, you may want to exclude words such as “the” and “with.”From the KWD type field in the Keyword table.

KWD_KeywordExclusion

alpha 20 The word you wish to include or exclude as a keyword, based on the Type field.From the KWD keyword/exclusion field in the Keyword table.

Image


CWSerenade 5.0


ECI_Thumbfile_Picture

alpha 255 The path and filename where the thumbnail image of the item is located.From the ECI thumbfile picture field in the E-Commerce Item Image table.

ECI_Regular_Picture

alpha 255 The path and filename where the regular image of the item is located.From the ECI regular picture field in the E-Commerce Item Image table.

ECI_Large_Picture alpha 255 The path and filename where the large image of the item is located.From the ECI large picture field in the E-Commerce Item Image table.

Upsell The Upsell element repeats for each upsell and cross-sell defined for the item in the E-Commerce Up/Cross-Sell table.

EUC_Up-SellCross-Sell

alpha 1 Indicates whether the item is an e-commerce upsell or cross-sell.• C = The item is an e-commerce cross-sell.• U = The item is an e-commerce upsell.From the EUC up-sell/cross-sell field in the E-Commerce Up/Cross-Sell table.

Upsell_Item_ECI_Item_Numb

alpha 12 The item number for the item you wish to upsell or cross-sell.From the Upsell item ECI item numb field in the E-Commerce Up/Cross-Sell table.

ECX_Up-Sell_Desc alpha 50 A description of the item you wish to upsell or cross-sell.From the ECX up-sell desc field in the E-Commerce Up/Cross-Sell table.

Restriction The Restriction element repeats for each item restriction defined for the item in the Item Restriction by Country/State table.

RPR_Country alpha 3 A country to which you cannot ship the item, or to which one or more states have shipping restrictions for the item.From the RPR country field in the Item Restriction by Country/State table.


CWSerenade 5.0


NAM_State alpha 2 A state which has a shipping restriction for the item. From the NAM state field in the Item Restriction by Country/State table.

EcommCategory The EcommCategory element repeats for each e-commerce category defined for the item in the E-Comm Item Categories table.

ECA_Category alpha 4 A code representing an e-commerce item category. From the ECA category field in the E-Comm Item Categories table.

ECA_Category_Description

alpha 30 A description of the e-commerce item category.From the ECA category description field in the E-Commerce Category table.

ITMUserField The ITMUserField element repeats for each item user field defined for the item in the Item User Field table.

ITM_UDF_Sequence_Nbr

numeric 3 The sequence number assigned to the item user field.From the Seq# field in the Item User Field table.

ITM_UDF_Text alpha 30 The text defined for the item user field.From the Text field in the Item User Field table.

ITM_UDF_Number numeric 16 The number defined for the item user field.From the Number field in the Item User Field table.

ITM_UDF_Date numeric 7 The date defined for the item user field. From the Date field in the Item User Field table.

ITM_UDF_Display_sequence

numeric 3 The sequence number assigned to the item user field, controlling its placement on the screen.From the Display sequence field in the Item User Field table.


CWSerenade 5.0


ITM_UDF_File_code

alpha 3 The code representing the table to which the user-defined field is linked. For item user fields, the file code is ITM.From the ITM UDF file code field in the Item User Field table.

UDD_Field_label alpha 15 The field label that appears on a screen for the item user field.From the Field label field in the User Defined Field Detail table.



TaxExemption The TaxExemption element repeats for each tax exemption defined for the item in the Item Tax Exempt table.

ITE_State alpha 2 A code that represents the state in which an item tax exemption applies.From the ITE state field in the Item Tax Exempt table.

ITE_Seq_Nbr numeric 3 The sequence number assigned to the item tax exemption.From the Seq # field in the Item Tax Exempt table.

ITE_Tax_value numeric 9.2 The dollar value up to which the item is taxable. The portion of the item price above this value is tax exempt.From the ITE tax value field in the Item Tax Exempt table.


CWSerenade 5.0


ITE_No_tax_value numeric 9.2 The dollar value that is tax exempt. If the item price is this value or less, the item is tax exempt. If the item price is greater than this value, the item is taxable in full.From the ITE no tax value field in the Item Tax Exempt table.

ITE_Exempt alpha 1 A code indicating whether the item is tax exempt. • Y = the item is tax exempt.• N = the item is not tax exempt.From the Exempt? field in the Item Tax Exempt table.

FreightExemption The FreightExemption element repeats for each freight exemption defined for the item in the Freight Exemption table.

FEF_Sequence_Number

numeric 5 The sequence number assigned to the item freight exemption.From the FEF sequence number field in the Freight Exemption table.

Offer_Number alpha 3 The offer in which the item is exempt from freight.From the Offer number field in the Freight Exemption table.

SRC_Source_code alpha 9 The source code in which the item is exempt from freight. From the SRC source code field in the Freight Exemption table.

SKU Each item download message contains one Item element and one SKU element. For example, if you update a SKU’ed item, the system generates a separate item download message for each SKU.

SKU_Code alpha 14 The SKU code for the item, such as style, color, and/or size.From the SKU code field in the SKU table.

Collating_sequence_Nbr

numeric 5 The collating sequence number assigned to the SKU.From the Collating seq # field in the SKU table.


CWSerenade 5.0


Compatibility alpha 3 compatibility code assigned to the SKU; other SKUs that are compatible to this SKU are assigned the same compatibility code.From the Compatibility field in the SKU table.

SKU_Cubing_value_override

numeric 7.1 The cubic volume of the SKU, which overrides the cubic volume defined for the item.From the Cub val field in the SKU table.

SKU_Description alpha 40 A description of the SKU.From the Description field in the SKU table.

SKU_Subscription alpha 1 Indicates whether the SKU is a subscription item.• Y = this is a subscription item.• N = this is not a subscription item.From the Subscription field in the SKU table.

Height_override numeric 3 The height measurement for the SKU. The Height, Length, and Width values are used to determine the cubic volume of the SKU.From the Height override field in the SKU table.

Length_override numeric 3 The length measurement for the SKU. The Height, Length, and Width values are used to determine the cubic volume of the SKU.From the Length override field in the SKU table.

List_price numeric 7.2 The list price defined for the SKU.From the List price field in the SKU table.

Long_SKU_color numeric 5 A code that represents the color portion of the long SKU code.From the Long SKU color field in the SKU table.

Long_SKU_size numeric 5 A code that represents the size portion of the long SKU code.From the Long SKU size field in the SKU table.


CWSerenade 5.0


Long_SKU_width numeric 5 A code that represents the width portion of the long SKU code.From the Long SKU width field in the SKU table.

Lowest_price numeric 7.2 The lowest recommended sale price for the SKU.From the Lowest price field in the SKU table.

Max_qty_for_location

numeric 7 The SKU’s recommended maximum number of units to be stored in the primary pick location.From the Max qty for location field in the SKU table.

Max_qty_for_warehouse

numeric 7 The SKU’s recommended maximum number of units to be stored in the primary warehouse.From the Max qty for warehouse field in the SKU table.

Min_qty_for_location

numeric 7 The SKU’s recommended minimum number of units to be stored in the primary pick location.From the Min qty for location field in the SKU table.

Min_qty_for_warehouse

numeric 7 The SKU’s recommended minimum number of units to be stored in the primary warehouse. From the Min qty for warehouse field in the SKU table.

SKU_Gift_certificate

alpha 1 Determines whether the SKU qualifies as a gift certificate.• Y = this SKU is a gift certificate.• N or blank = this SKU is not a gift certificate.From the SKU gift certificate field in the SKU table.

Out_of_stock_flag alpha 1 Indicates whether the SKU is out of stock.• Y = the SKU is out of stock.• N or blank = the SKU is not out of stock.From the Out of stock flag field in the SKU table.


CWSerenade 5.0


Qty_order_direct_ship

numeric 7 From the Qty order direct ship field in the SKU table.

Receipt_date numeric 7 The last time inventory for the SKU was received.From the Receipt date field in the SKU table.

Reserve_qty_limit numeric 7 If the order quantity exceeds this amount, the system does not attempt to reserve the item and displays the backorder reason.From the Reserve qty limit field in the SKU table.

Restrict_orders alpha 1 Defines whether you can accept an order for the SKU and whether demand is captured.• Y = you cannot accept an order for the item/SKU.• N or blank = you can accept an order for the item/SKU.From the Restrict orders field in the SKU table.

Retail_reference_Nbr

numeric 15 The retail reference number assigned to the SKU.From the Retail ref # field in the SKU table.

Out_of_stock_date numeric 7 The last date the on hand level for the SKU was zero.From the Out of stock date field in the SKU table.

Selling_weight_override

numeric 7.3 The selling weight of the SKU, used to calculate the freight charge on the SKU when the freight method on the order is Freight by weight or Freight by order weight.From the Selling weight override field in the SKU table.

Short_SKU numeric 7 The short SKU number defined for the SKU, used to identify the SKU.From the Short SKU field in the SKU table.

User_field_1 alpha 10 A user-defined field for the SKU.From the User field 1 field in the SKU table.


CWSerenade 5.0




Weight_override numeric 7.3 The actual shipping weight of the SKU.From the Weight override field in the SKU table.

Width_override numeric 3 The width measurement for the SKU. The Height, Length, and Width values are used to determine the cubic volume of the SKU.From the Width override field in the SKU table.

Sale_credit_flag alpha 1 Determines whether a sale credit is generated when the SKU is returned.• Y = Generate a sale (merchandise) credit when the SKU is returned.• N or blank = Generate a refund type based on the pay type on the order.From the Sale credit flag field in the SKU table.

Harmonize_code alpha 16 A code that prints on customs documents for international shipments. If you charge duty on international orders, use this field to define the item’s duty rate.From the Harmonize code field in the SKU table.

SKU_Coordinate_group

numeric 3 A code assigned to the SKU to ensure that certain items ship together when ordered together. Items with the same coordinate group code ship together through the same shipper.From the Coord group field in the SKU table.

SKU_Open_qty numeric 7 The total number of units on orders that have not shipped.From the SKU open qty field in the SKU table.

SKU_Future_qty numeric 7 The total number of units on future orders.From the Future qty field in the SKU table.


CWSerenade 5.0


SKU_Suspense_qty

numeric 7 The total number of units received against the purchase order that are currently in suspense.From the SKU suspense qty field in the SKU table.

SKU_On_hold_qty numeric 7 The total number of units on hold.From the On hold qty field in the SKU table.

SKU_Standard_Cost

numeric 11.4 The standard cost of the SKU. The system populates this field only if the Costing Method (A25) system control value is set to STANDARD and a value exists in the SKU standard cost field in the SKU table.

SKU_Average_Cost

numeric 11.4 The average cost of the SKU. The system populates this field only if the Costing Method (A25) system control value is set to AVERAGE and a value exists in the SKU average cost field in the SKU table.

SKU_Second_Language_Desc

alpha 40 The second language description defined for the SKU.From the Second language desc field in the SKU table.

SKU_VAT_Exempt_flag

alpha 1 Indicates whether the item is exempt from VAT.• Y = The item is exempt from VAT.• N or blank = The item is subject to VAT.From the VAT exempt flag field in the SKU table.

SKU_Second_compatibility

alpha 3 The compatibility code assigned to the SKU; other SKUs that are compatible to this SKU are assigned the same compatibility code.From the Second compatibility field in the SKU table.

SKU_Hidden_tax_amount

numeric 7.2 The hidden tax amount to include in the price of an item subject to VAT.From the Hidden tax amount field in the SKU table.


CWSerenade 5.0


SKU_Hidden_tax_percent

numeric 5.2 The hidden tax percent to include in the price of an item subject to VAT.From the Hidden tax percent field in the SKU table.

SKU_Suppress_BO_Card

alpha 1 Indicates whether to produce a backorder card for the SKU. • Y = Suppress normal backorder card generation for the SKU.• N or blank = Do not suppress normal backorder card generation.From the SKU suppress B/O card field in the SKU table.

SKU_Projected_Returns

numeric 7 The number of units you expect to receive in returns for the SKU. From the SKU projected returns field in the SKU table.

SKU_User_field_4 alpha 5 A user-defined field for the SKU.From the SKU user field 4 field in the SKU table.

SKU_User_field_5 alpha 5 A user-defined field for the SKU.From the SKU user field 5 field in the SKU table.

SKU_Book_Inventory

numeric 7 The expected inventory per catalog or advertisement.From the SKU book inventory field in the SKU table.

SKU_Returnable alpha 1 Indicates whether the SKU can be returned.• Y = The SKU is returnable.• N or blank = The SKU is not returnable.From the SKU returnable field in the SKU table.

SKU_Retail_X-Ref_Nbr

numeric 10 The retail reference number assigned to the SKU.From the SKU retail x-ref # field in the SKU table.

SKU_LS_Style alpha 20 The long SKU style defined for the SKU.From the SKU L/S style field in the SKU table.


CWSerenade 5.0


SKU_LS_Vendor alpha 7 The long SKU vendor defined for the SKU.From the SKU L/S vendor field in the SKU table.

SKU_Receiving_Priority

alpha 2 A number that controls the priority of receiving the SKU.From the SKU receiving priority field in the SKU table.

SKU_Excl_Store_Restock

alpha 1 Indicates if the SKU is excluded from store restock.• Y = the SKU is excluded from store restock.• N or blank = the SKU is not excluded from store restock.From the SKU excl store restock? field in the SKU table.

SKU_Generic_Ecommerce

alpha 10 From the SKU generic ecommerce field in the SKU table.

SKU_Last_Download_Qty

numeric 5 The inventory quantity that was last downloaded through the e-commerce interface.From the SKU last download qty field in the SKU table.

SKU_Last_Extract numeric 7 The date when the inventory information for the SKU was last extracted.From the SKU last extract field in the SKU table.

SKU_Last_Ecomm_Info_Chg

numeric 7 The date when the SKU information was last downloaded through the e-commerce interface.From the SKU last ecomm info chg field in the SKU table.

SKU_SVC_Card_Reload

alpha 1 From the SKU future use Y/N 1 field in the SKU table.

SKU_Original_Retail_Price

numeric 7.2 The original retail price for the SKU.From the SKU original retail price field in the SKU table.

SKU_Create_Date numeric 7 The date the SKU was created.From the SKU create date field in the SKU table.


CWSerenade 5.0


SKU_GTIN_Nbr numeric 14 The GTIN number defined for the SKU.From the SKU GTIN # field in the SKU table.

SKU_Commodity_Code

numeric 8 The commodity code defined for the SKU.From the SKU commodity code field in the SKU table.

ABC_Code alpha 1 A code that classifies an item/SKU based on sales volume.From the ABC code field in the SKU table.

ABC_First_order numeric 5 The number of days that must pass before an ABC code is assigned to the item.From the First order field in the ABC/Velocity table.

Percentage_of_Sales

numeric 5.2 The monthly percentage of sales required for an item to earn an ABC code.From the Percentage of sales field in the ABC/Velocity table.

New_item_flag alpha 1 Indicates if the item has been marked as new (N) in the ABC code field.• Y = The item is marked as new.• N or blank = The item is not marked as new.From the New item flag field in the SKU table.

CTN_ID_Nbr numeric 2 The carton ID number assigned to the SKU, identifying a particular size box.From the CTN ID # (SKU) field in the SKU table.

Frequency_code alpha 1 A code that classifies the performance of an item.From the Freq code field in the SKU table.

Percentage_of_picks

numeric 5.2 The percentage of picks generated for the item.From the Pct of picks field in the Frequency table.

Warehouse numeric 3 The warehouse where the SKU is located.From the Whs field in the SKU table.


CWSerenade 5.0


Warehouse_name alpha 30 The name of the warehouse.From the Name field in the Warehouse table.

Location alpha 7 The primary location where the SKU is located.From the Location field in the SKU table.

SLC_Code alpha 2 The soldout control code specified for the SKU.From the SLC code field in the SKU table.

SLC_Description alpha 30 The description of the soldout control code.From the SLC description field in the Soldout Control table.

SLC_Status alpha 1 Indicates whether the system sells out the SKU immediately.• 1 = Sell out immediately, regardless of available on-hand stock.• 2 = Include on order quantity in the soldout calculation.• 3 = Exclude on order quantity in the soldout calculation.From the Status field in the Soldout Control table.

Unit_of_measure alpha 3 The unit of measure defined for the SKU.From the UOM field in the SKU table.



SKU_Element_1_Code

alpha 4 A code representing a SKU element, such as blue (color) or small (size).From the Element 1 field in the SKU table.

SKU_Element_1_Desc

alpha 10 A description of the SKU element, such as navy blue.From the Element 1 desc field in the SKU Element 1 table.


CWSerenade 5.0


SKU_Element_1_Name

alpha 10 The name of SKU element 1, such as color, size, or width. From the Split SKU Element Column Headings (A52, A53, A54) system control values.

SKU_Element_2_Code


SKU_Element_2_Desc


SKU_Element_2_Name

alpha 10 The name of SKU element 2, such as color, size, or width.From the Split SKU Element Column Headings (A52, A53, A54) system control values.

SKU_Element_3_Code


SKU_Element_3_Desc


SKU_Element_3_Name

alpha 10 The name of SKU element 3, such as color, size, or width.From the Split SKU Element Column Headings (A52, A53, A54) system control values.

SKU_IST_Item_status

alpha 1 The status of the item, such as discontinued.From the SKU IST item status field in the SKU table.

Item_status_description

alpha 30 A description of the item status.From the Description field in the Item Status table.


CWSerenade 5.0


IST_Message_line_1

alpha 50 A message to display when ordering an item with this status.From the IST message line 1 field in the Item Status table.

IST_Message_line_2

alpha 50 A message to display when ordering an item with this status.From the IST message line 2 field in the Item Status table.

IST_Return_disposition

alpha 2 A code that identifies how return merchandise with this item status is handled, in terms of whether the return updates inventory and the warehouse and location to which the merchandise is returned.From the IST return disposition field in the Item Status table.

SKU_ITC_Category

alpha 4 A code assigned to the SKU to classify and group like items for use in item relationships and compatibility.From the ITC category field in the SKU table.

Item_category_description

alpha 30 A description of the item category.From the Description field in the Item Category table.

SKU_PRP_Prep_Code

alpha 2 A code that identifies a SKU’s special handling or processing requirements within the warehouse.From the SKU PRP prep code field in the SKU table.

PRP_Description alpha 40 A description of the prep code.From the PRP description field in the Prep Code table.

SKU_Country_Of_Origin

alpha 3 A code representing the country where the SKU originated. From the SKU country of origin field in the SKU table.

Country_description

alpha 30 A description of the country of origin.From the Description field in the Country table.


CWSerenade 5.0


SKU_LSC_LS_Class

numeric 4 The long SKU class defined for the SKU.From the SKU LSC L/S class field in the SKU table.

LSC_Description alpha 30 A description of the long SKU class.From the Description field in the Long SKU Class table.

SKU_ZRC_Zone_Reservation

alpha 4 The zone reservation code assigned to the SKU, identifying the item as climate-sensitive.From the SKU ZRC zone reservation field in the SKU table.

VendorItem The VendorItem element repeats for each vendor item defined for the SKU in the Vendor Item table.

Vendor_Nbr numeric 7 The code the vendor uses to identify the SKU.From the Vendor # field in the Vendor Item table.

Item alpha 20 The item number, as defined by the vendor.From the Item field in the Vendor Item table.

Cubic_volume numeric 5 The cubic volume of the item, as defined by the vendor.From the Cubic volume field in the Vendor Item table.

Description alpha 30 A description of the vendor item.From the Description field in the Vendor Item table.

Lead_days numeric 3 The number of days it takes the vendor to deliver the item when it is ordered through a purchase order.From the Lead days field in the Vendor Item table.

Message_line_1 alpha 30 Informational message for the vendor item.From the Message line 1 field in the Vendor Item table.



CWSerenade 5.0



Minimum_qty numeric 7 The minimum unit quantity (in retailer’s unit of measure) of merchandise you are required to order from the vendor.From the Min qty field in the Vendor Item table.

Price numeric 11.4 The vendor’s list price for the item.From the Price field in the Vendor Item table.

Ship_weight numeric 7.3 The shipping weight of the item, as defined by the vendor.From the Ship weight field in the Vendor Item table.

VIT_Vend_ord_qty_multiple

numeric 5 The number of units (in retailer’s unit of measure) by which your order quantity must be divisible when you order the item from the vendor.From the VIT vend ord qty multiple field in the Vendor Item table.

VIT_Upload_frt_dlr_limit

numeric 9.2 The maximum dollar value of each detail level freight charge for the item on the PO.From the Upload frt $ limit field in the Vendor Item table.

VIT_Upload_hnd_dlr_limit

numeric 9.2 The maximum dollar value of each detail level handling charge for the item on the PO.From the Upload hnd $ limit field in the Vendor Item table.

VIT_Upload_other_dlr_limit

numeric 9.2 The maximum dollar value of each detail level miscellaneous charge for the item on the PO.From the Upload other $ limit field in the Vendor Item table.


CWSerenade 5.0


Ship_via numeric 2 A code that represents the carrier used when shipping the item on the PO to your company.From the Ship via field in the Vendor Item table.

POV_Description alpha 30 A description of the PO ship via.From the Description field in the PO Ship Via table.

POV_Lead_Days numeric 3 The number of days it takes the shipper to deliver merchandise to your company.From the POV lead days field in the PO Ship Via table.

Unit_of_measure alpha 3 The vendor’s unit of measure for the item (for example, case of 12).From the UOM field in the Vendor Item table.



VIT_Country_Of_Origin

alpha 3 A code representing the country where the vendor item originated. From the VIT country of origin field in the Vendor Item table.

Country_description

alpha 30 A description of the country of origin.From the Description field in the Country table.

VIT_Freight_upload_GLNbr

numeric 8 The general ledger number to use for detail level freight charges on A/P invoices.From the Freight upload GL# field in the Vendor Item table.

VIT_Handling_upload_GLNbr

numeric 8 The general ledger number to use for detail level handling charges on A/P invoices.From the Handling upload GL# field in the Vendor Item table.


CWSerenade 5.0


VIT_Other_upload_GLNbr

numeric 8 The general ledger number to use for miscellaneous charges on A/P invoices.From the Other upload GL# field in the Vendor Item table.

VITPriceBreak The VITPriceBreak element repeats for each vendor price break defined for the vendor item in the Vendor Item Price Break table.

Start_date numeric 7 The date when the special price promotion or quantity break price begins.From the Start date field in the Vendor Item Price Break table.

Quantity numeric 7 The quantity (in retailer’s unit of measure), that you must purchase to receive the special promotional price or quantity break price on the item from the vendor.From the Quantity field in the Vendor Item Price Break table.

Price numeric 11.4 The vendor’s special price, per vendor’s unit of measure, for the item if you order the quantity required (in retailer’s unit of measure).From the Price field in the Vendor Item Price Break table.

Stop_date numeric 7 The date when the special price promotion or quantity break price ends.From the Stop date field in the Vendor Item Price Break table.

VITAdditionalCharge The VITAdditionalCharge element repeats for each vendor additional charge associated with the vendor item in the Vendor Item Addl Charge table.

Charge_code alpha 2 A code that identifies an additional charge for the item.From the Charge code field in the Vendor Item Addl Charge table.


CWSerenade 5.0


VAC_Percent numeric 5.2 The percent to add to the PO for each unit (in retailer’s unit of measure) of the vendor item.From the Percent field in the Vendor Item Addl Charge table.

VAC_Unit_amount numeric 11.2 The dollar amount to add to the PO for each unit (in retailer’s unit of measure) of the vendor item.From the Unit amt field in the Vendor Item Addl Charge table.

VITNote The VITNote element repeats for each vendor item note associated with the vendor item in the Vendor Item Notes table.

VIN_Seq_Nbr numeric 3 The sequence number assigned to the vendor item note.From the Seq # field in the Vendor Item Notes table.

VIN_Print alpha 1 Indicates whether the vendor item note prints on the PO and/or the receiving worksheet. Valid values are:• B = Print on both PO and worksheet• P = PO only• W = Worksheet only• blank = Do not printFrom the Print? field in the Vendor Item Notes table.

VIN_Note alpha 60 The note defined for the vendor item.From the Note field in the Vendor Item Notes table.

VIN_User alpha 10 The user ID of the user who entered the vendor item note.From the User field in the Vendor Item Notes table.

VIN_Entry_date numeric 7 The date the vendor item note was entered.From the Entry date field in the Vendor Item Notes table.


CWSerenade 5.0


VITUserField The VITUserField element repeats for each vendor item user field associated with the vendor item in the Vendor Item User Field table.

VIT_UDF_Sequence_Nbr

numeric 3 The sequence number assigned to the vendor item user field.From the Seq# field in the Vendor Item User Field table.

VIT_UDF_Text alpha 30 The text defined for the vendor item user field.From the Text field in the Vendor Item User Field table.

VIT_UDF_Number numeric 16 The number defined for the vendor item user field.From the Number field in the Vendor Item User Field table.

VIT_UDF_Date numeric 7 The date defined for the vendor item user field. From the Date field in the Vendor Item User Field table.

VIT_UDF_Display_sequence

numeric 3 The sequence number assigned to the vendor item user field, controlling its placement on the screen.From the Display sequence field in the Vendor Item User Field table.

VIT_UDF_File_code

alpha 3 The code representing the table to which the user-defined field is linked. For vendor item user fields, the file code is VIT.From the VIT UDF file code field in the Vendor Item User Field table.

UDD_Field_label alpha 15 The field label that appears on a screen for the vendor item user field.From the Field label field in the User Defined Field Detail table.


CWSerenade 5.0




SKUOffer The SKUOffer element repeats for each SKU offer record defined for the SKU in the SKU Offer table.

Offer_Number alpha 3 A code that represents the offer where the SKU is advertised.From the Offer number field in the SKU Offer table.

Cost numeric 7.2 The cost to include the SKU in the offer.From the Cost field in the SKU Offer table.

Expected_return_pct

numeric 5.2 The percentage of returns you expect to receive for the SKU in the offer.From the Expected return pct field in the SKU Offer table.

Gift_wrap_flag alpha 1 Indicates if the SKU is eligible for gift wrap.• Y = The SKU is eligible for gift wrap.• N = The SKU is not eligible for gift wrap.From the G/W flag field in the SKU Offer table.

Page_Nbr numeric 5 The primary page number displaying the SKU in the offer.From the Page # field in the SKU Offer table.


CWSerenade 5.0


Projected_units numeric 7 The number of units of the SKU expected to sell in the offer.From the Projected units field in the SKU Offer table.

SH_price numeric 7.2 The price to charge the customer for special handling.From the S/H price field in the SKU Offer table.

Special_handling_flag

alpha 1 Indicates if the SKU is eligible for any type of special handling in the offer.• Y = The SKU is eligible for special handling.• N = The SKU is not eligible for special handling.From the S/H flag field in the SKU Offer table.

Square_inches numeric 5.2 The square inches that the SKU occupies on the catalog page in the offer.From the Square inches field in the SKU Offer table.

Term_payment_interval

numeric 5 The number of days between payments.From the Term payment interval field in the SKU Offer table.

Gift_wrap_price numeric 7.2 The price for gift wrapping the SKU.From the G/W price field in the SKU Offer table.

Freight numeric 6.2 The freight amount to charge for the SKU in the offer.From the Freight field in the SKU Offer table.

Hidden_freight numeric 6.2 The hidden freight amount to charge for the SKU in the offer.From the Hidden freight field in the SKU Offer table.

SKO_Coupon_discount_dlr

numeric 7.2 The coupon dollar amount that is subtracted from the price when the SKU is ordered in the offer.From the Coupon discount $ field in the SKU Offer table.


CWSerenade 5.0


SKO_Coupon_effective_date

numeric 7 The date the coupon becomes effective.From the Coupon effective field in the SKU Offer table.

SKO_Volume_discountable

alpha 1 Indicates if the SKU is eligible for a volume discount.• Y = The SKU is eligible for a volume discount.• N = The SKU is not eligible for a volume discount.From the Volume disc? field in the SKU Offer table.

SKO_Spread alpha 3 The spread of the SKU in the offer.From the SKO spread field in the SKU Offer table.

SKO_Featureoption

alpha 1 A code that indicates if the SKU is considered a featured item in a depiction in the offer.• F = The SKU is a featured item in the depiction.• O = The SKU is an optional item in the depiction.From the Feature/option field in the SKU Offer table.

SKO_Pickupnew alpha 1 A code that indicates if the SKU has been carried over from a previous offer or is new to your product offerings.• P = The SKU is a pickup item, previously sold in an offer.• N = The SKU is a new addition to your offer.From the Pickup/new field in the SKU Offer table.


CWSerenade 5.0


SKO_Sale_Book_Item_Flag

alpha 1 Indicates if the SKU is on sale in the offer.• Y = The SKU is a sale item.• N = The SKU is not a sale item.From the SKO sale book item flag field in the SKU Offer table.This flag controls whether to generate a sale credit when the customer returns the item, based also on the payment method and the setting of the Generate Sale Credit for Orders with Sale Items (I64) system control value.If the Exclude Sale Item When Prorating Discounts (I65) system control value is selected, this flag controls whether the item is included in prorated discounts or is included when determining whether an order qualifies for a promotion. See the system control value for more information.

SKO_Qty_Break_Upsl_Thrshd

numeric 7 From the SKO qty break upsl thrshd field in the SKU Offer table.

SKO_Warranty_Item

alpha 1 Indicates if the SKU is a warranty item in the offer.• Y = The SKU is a warranty item.• N = The SKU is not a warranty item.From the SKO warranty item? field in the SKU Offer table.

SKO_Required_Add_Reason

alpha 1 Indicates if an add reason code is required when the SKU in the offer is added to an order.• Y = An add reason code is required.• N = An add reason code is not required.From the SKO required add reason? field in the SKU Offer table.

SKO_Included_Internet_Ofr

alpha 1 From the SKO future use Y/N 1 field in the SKU Offer table.

CRV_Code numeric 3 A code that represents the SKU’s expected selling pattern in the offer.From the CRV code field in the SKU Offer table.


CWSerenade 5.0


CRV_Description alpha 30 A description of the curve.From the Description field in the Curve table.

CRV_Curve_type alpha 1 A user-defined code used to group projection curves.From the Curve type field in the Curve table.

ADD_Addl_chg_code

alpha 2 The additional charge code associated with the type of special handling you are offering for the SKU.From the ADD add’l chg code field in the SKU Offer table.

ADD_Description alpha 30 A description of the additional charge.From the ADD description field in the Additional Charge table.

SHF_Code alpha 2 The special handling format code assigned to the additional charge code.From the SHF code field in the Additional Charge table.

SHF_Description alpha 30 A description of the special handling format.From the Description field in the Special Format table.

SKO_AOC_Add-On_Code

alpha 3 From the SKO AOC add-on code field in the SKU Offer table.

SKUPrice The SKUPrice element repeats for each SKU price record defined for the SKU in the SKU Price table.

Effective_date numeric 7 The date the price or quantity break becomes valid.From the Effective date field in the SKU Price table.

Qty numeric 7 The amount of the SKU the customer must order to receive the discounted price.From the Qty field in the SKU Price table.


CWSerenade 5.0


Associate_price numeric 7.2 The price at which the SKU is sold in the offer to associate customers.From the Associate price field in the SKU Price table.

Price numeric 7.2 The price at which the SKU is sold in the offer.From the Price field in the SKU Price table.

SKP_Price_column numeric 2 The pricing column associated with the price.From the Price column field in the SKU Price table.

SKP_Associate_tax_price

numeric 7.2 The price at which the SKU is sold to associate customers on orders subject to tax-inclusive pricing and VAT.From the Tax inclusive associate price field in the SKU Price table.

SKP_Tax_price numeric 7.2 The price at which the SKU is sold on orders subject to tax-inclusive pricing and VAT.From the Tax incl price field in the SKU Price table.

SKP_No_Charge alpha 1 Indicates if the SKU is sold at no charge.• Y = The SKU is sold at no charge.• N = The SKU is sold for a price.From the SKP no charge? field in the SKU Price table.

SKUOfferPage The SKUOfferPage element repeats for each SKU offer page record defined for the SKU in the SKU Offer Page table.

Page_Nbr numeric 5 The page number displaying the SKU in the catalog.From the Page # field in the SKU Offer Page table.

Alias_item alpha 12 The alternate item code for the SKU.From the Alias item field in the SKU Offer Page table.


CWSerenade 5.0


SKOAccompanyingItem The SKOAccompanyingItem element repeats for each accompanying item record defined for the SKU in the Accompanying Item table.

ACI_Qty_required numeric 5 The amount of the SKU that must be ordered to receive the accompanying item.From the Qty req’d field in the Accompanying Item table.

ACI_Qty numeric 5 The number of accompanying items to add to the order.From the Qty field in the Accompanying Item table.

ACI_Free_gift alpha 1 Indicates if the accompanying item is a free gift.• Y = The accompanying item is a free gift.• N = The accompanying item is not free of charge.From the Free gift? field in the Accompanying Item table.

ACI_Use_Ordered_Qty

alpha 1 Indicates if the accompanying item is ordered in the same quantity as the qualifying item.• Y = The accompanying item is ordered in the same quantity as the qualifying item.• N = The accompanying item is not ordered in the same quantity as the qualifying item.From the ACI use ordered qty? field in the Accompanying Item table.

ACI_ITM_Number alpha 12 The accompanying item to add to the order if the customer orders the required quantity of the qualifying item.From the ACI ITM number field in the Accompanying Item table.

ACI_SKU_Code alpha 14 The SKU of the accompanying item.From the ACI SKU code field in the Accompanying Item table.


CWSerenade 5.0


SKOUserField The SKOUserField element repeats for each SKU offer user field record defined for the SKU in the SKU Offer User Field table.

SKO_UDF_Sequence_Nbr

numeric 3 The sequence number assigned to the SKU offer user field.From the Seq# field in the SKU Offer User Field table.

SKO_UDF_Text alpha 30 The text defined for the SKU offer user field.From the Text field in the SKU Offer User Field table.

SKO_UDF_Number

numeric 16 The number defined for the SKU offer user field. From the Number field in the SKU Offer User Field table.

SKO_UDF_Date numeric 7 The date defined for the SKU offer user field.From the Date field in the SKU Offer User Field table.

SKO_UDF_Display_sequence

numeric 3 The display sequence number assigned to the SKU offer user field.From the Display sequence field in the SKU Offer User Field table.

SKO_UDF_File_code

alpha 3 The code representing the table to which the user-defined field is linked. For SKU offer user fields, the file code is SKO.From the ITW UDF file code field in the Item Warehouse User Field table.

UDD_Field_label alpha 15 The field label that appears on a screen for the SKU offer user field.From the Field label field in the User Defined Field Detail table.



CWSerenade 5.0



SKOSpecialHandlingDetail The SKOSpecialHandlingDetail element repeats for each special format detail record defined for the SKU offer in the Special Format Details table.

SFD_Seq_Nbr numeric 3 The sequence number assigned to the special format detail.From the SFD seq # field in the Special Format Details table.

SFD_Display_Seq numeric 3 The display sequence number assigned to the special format detail.From the SFD display seq field in the Special Format Details table.

SFD_Prompt_Text alpha 15 The name of the input field for the special format detail.From the SFD prompt text field in the Special Format Details table.

SFD_Required_field

alpha 1 Indicates if the special format detail input field is required.• Y = The special format detail is required.• N = The special format detail is not required.From the SFD required field in the Special Format Details table.

SFD_Feature_options

alpha 1 Indicates if the special format detail input field is a feature option. A feature option is an extra feature that can be added to the item.From the SFD feature options field in the Special Format Details table.


CWSerenade 5.0


SFD_Default_value alpha 45 The special format detail default value.From the Default value field in the Special Format Details table.

SFD_Default_charge_dlr

numeric 7.2 The price to charge the customer for the special format detail.From the SFD default charge $ field in the Special Format Details table.

SFD_Default_charge_Pct

numeric 5.2 The percentage used to calculate the price to charge the customer for the special format detail.From the SFD default charge % field in the Special Format Details table.

SFD_Default_cost_dlr

numeric 11.4 The cost of the special format detail.From the SFD default cost $ field in the Special Format Details table.

SFD_Default_cost_Pct

numeric 5.2 The percentage used to calculate the cost of the special format detail.From the SFD default cost % field in the Special Format Details table.

SFD_Default_text alpha 2 A code that allows you to select text from the customer record to default onto the special format detail.From the SFD default text field in the Special Format Details table.

SFD_Max_Nbr_characters

numeric 2 The maximum number of characters allowed for the special format detail.From the SFD max # characters field in the Special Format Details table.

SFD_Cross_Reference

alpha 3 A code used to cross reference the special format detail with the element’s code on the manufacturing system.From the SFD cross reference field in the Special Format Details table.

SKOSpecialHandlingResponse The SKOSpecialHandlingResponse element repeats for each special format response record defined for the SKU offer in the Special Format Responses table.


CWSerenade 5.0


SFD_Seq_Nbr numeric 3 The sequence number assigned to the special format response.From the SFD seq # field in the Special Format Responses table.

SFR_Valid_response

alpha 45 A code for a valid special format response.From the Valid response field in the Special Format Response table.

SFR_Description alpha 45 A description of the special format response.From the SFR description field in the Special Format Response table.

SKUItemInformation The SKUItemInformation element repeats for each SKU item information record defined for the SKU in the Item Information table.

Template alpha 2 The type of template for item information.• CS = Customer Service• PC = Product Comments• PO = Purchase Orders• QC = Quality Control• RP = Reporting (E-Commerce)From the Template field in the Item Class Template table.

Sequence_Nbr numeric 3 The sequence number assigned to the item class template.From the Seq # field in the Item Class Template table.

Heading alpha 20 A description of the item class template. From the Heading field in the Item Class Template table.

Lines_available numeric 3 The number of lines available in the template for the entry of information.From the Lines available field in the Item Class Template table.


CWSerenade 5.0


SKUItemInformationDetail The SKUItemInformationDetails element repeats for each item information detail defined for the SKU in the Item Information table.Note: The system includes SKUItemInformationDetail only if the Item information field in the Item Information table contains a value.

Sequence_Nbr numeric 3 The sequence number assigned to the item information.From the Seq # field in the Item Information table.

Item_information_Line

alpha 50 A line of item information.From the Item information field in the Item Information table.

ItemWarehouse The ItemWarehouse element repeats for each item warehouse defined for the SKU in the Item Warehouse table.

Warehouse numeric 3 A code that represents a warehouse or retail store.From the Whs field in the Item Warehouse table.

Allocation_freeze alpha 1 Indicates whether the SKU in the warehouse is frozen.• Y = The SKU warehouse is frozen.• N = The SKU warehouse is not frozen.From the Allocation freeze field in the Item Warehouse table.

Economic_order_qty

numeric 7 The recommended optimum ordering quantity for the SKU.From the Economic order qty field in the Item Warehouse table.

Max_qty numeric 7 The maximum number of units to be kept on hand in the warehouse.From the Max qty field in the Item Warehouse table.


CWSerenade 5.0


Min_qty numeric 7 The minimum number of units to be kept on hand in the warehouse.From the Min qty field in the Item Warehouse table.

Protected_qty numeric 7 The unit quantity of the SKU protected from reservation.From the Protected qty field in the Item Warehouse table.

Reorder_qty numeric 7 The quantity of the SKU that should be replenished when the SKU reaches the minimum stock level for the warehouse.From the Reorder qty field in the Item Warehouse table.

ITW_Original_retail_price

numeric 7.2 The original price of the SKU in the retail store. From the ITW original retail price field in the Item Warehouse table.

ITW_Current_retail_price

numeric 7.2 The current price of the SKU in the retail store. From the ITW current retail price field in the Item Warehouse table.

ITW_Protect_current_price

alpha 1 Indicates whether the system overrides the Current retail price field when you change the retail price.• Y = The system keeps the existing current retail price defined for the item warehouse.• N = The system updates the current retail price defined for the item warehouse.From the ITW protect current price field in the Item Warehouse table.


CWSerenade 5.0


ITW_Protect_MinMax

alpha 1 Indicates whether the system overrides the minimum or maximum quantity when you change the minimum or maximum quantity in Working with Item Warehouse Values (WIWV).• Y = The system does not update the minimum or maximum quantity defined for the item warehouse.• N = The system updates the minimum or maximum quantity defined for the item warehouse.From the ITW protect min/max field in the Item Warehouse table.

ITW_User_field_1 alpha 10 A user-defined field for the item warehouse.From the ITW user field 1 field in the Item Warehouse table.

ITW_User_field_2 alpha 10 A user-defined field for the item warehouse.From the ITW user field 2 field in the Item Warehouse table.

ITWUserField The ITWUserField element repeats for each item user field associated with the SKU in the Item Warehouse User Field table.

ITW_UDF_Sequence_Nbr

numeric 3 The sequence number assigned to the item warehouse user field.From the Seq# field in the Item Warehouse User Field table.

ITW_UDF_Text alpha 30 The text defined for the item warehouse user field.From the Text field in the Item Warehouse User Field table.

ITW_UDF_Number numeric 16 The number defined for the item warehouse user field.From the Number field in the Item Warehouse User Field table.

ITW_UDF_Date numeric 7 The date defined for the item warehouse user field. From the Date field in the Item Warehouse User Field table.


CWSerenade 5.0


ITW_UDF_Display_sequence

numeric 3 The sequence number assigned to the item warehouse user field, controlling its placement on the screen.From the Display sequence field in the Item Warehouse User Field table.

ITW_UDF_File_code

alpha 3 The code representing the table to which the user-defined field is linked. For item warehouse user fields, the file code is ITW.From the ITW UDF file code field in the Item Warehouse User Field table.

UDD_Field_label alpha 15 The field label that appears on a screen for the vendor item user field.From the Field label field in the User Defined Field Detail table.



ContinuityItems The ContinuityItems element and its child, ContinuityItem, are included only if the item is defined as a continuity item (the Kit_type attribute is set to C).


CWSerenade 5.0


CNH_Charge_type alpha 1 A code that represents how the customer is charged.• 1 = First shipment only: the order line with the continuity set item on it has the price.• 2 = Each shipment: each order line has a price.From the CNH charge type field in the Continuity Header table.

CNH_Interval_type alpha 1 A code that represents the interval or time between delivery of continuity component items.• D = Days• M = MonthsFrom the CNH interval type field in the Continuity Header table.

ContinuityItem The ContinuityItem element repeats for each continuity item defined for the SKU in the Continuity Details table.

CND_Seq_Nbr numeric 3 The sequence number assigned to the continuity detail.From the Seq# field in the Continuity Details table.

CND_Interval_Nbr numeric 5 Determines when the item/SKU should be shipped; for example, the first shipment is interval 1, the second shipment is interval 2.From the CND interval # field in the Continuity Details table.

CND_Coordinate_group

numeric 3 Group number assigned to certain component items in the continuity program to ensure that they ship together.From the CND coordinate group field in the Continuity Details table.

CND_Qty numeric 5 The number of units of the item that are included in the continuity program.From the CND qty field in the Continuity Details table.


CWSerenade 5.0


CND_Detail_ITM_Number

alpha 12 The item to be included as a component of the continuity set item.From the CND detail ITM number field in the Continuity Details table.

SKU_Code alpha 14 The SKU to be included as a component of the continuity set item.From the SKU code field in the Continuity Details table.

FinishedGood The FinishedGood element is included only if the item is defined as a finished good item (the Kit_type attribute is set to F).The FinishedGood element repeats for each finished good component defined for the SKU in the Kit Details table.

SeqNbr numeric 5 The sequence number assigned to the kit detail.From the Seq# field in the Kit Detail table.

Qty numeric 5 The number of items that are used to make up the finished good.From the Qty field in the Kit Detail table.

Kit_Comp_ITM_Number

alpha 12 A component item that makes up the finished good.From the Kit comp ITM number field in the Kit Detail table.

Kit_Comp_SKU_Code

alpha 14 The SKU of the component item that makes up the finished good.From the Kit comp SKU code field in the Kit Detail table.

SetItem The SetItem element is included only if the item is defined as a set item (the Kit_type attribute is set to S).The SetItem element repeats for each set component defined for the SKU in the Set Details table.

SeqNbr numeric 3 The sequence number assigned to the set detail.From the Seq# field in the Set Details table.


CWSerenade 5.0


Coordinate_group numeric 3 Group number assigned to set component items to ensure that they ship together.From the Coordinate group field in the Set Details table.

Pct_of_cost numeric 5.2 The percentage of the set’s cost that the item comprises.From the % of cost field in the Set Details table.

Qty numeric 5 The number of units of the item to include in one set.From the Qty field in the Set Details table.

Set_Comp_ITM_Number

alpha 12 A component item of the set item.From the Set comp ITM number field in the Set Details table.

Set_Comp_SKU_Code

alpha 14 The SKU of the component item.From the Set comp SKU code field in the Set Details table.

VariableSet The VariableSet element and its children, VariableSetGroup and VariableSetItem, is included only if the SKU is defined as a variable set (the Kit_type attribute is set to V).

VSE_Create_coord_group

alpha 1 From the Create coord group? field in the Variable Set table.

VariableSetGroup The VariableSetGroup element repeats for each variable set group defined for the SKU in the Variable Set Group table.

Group numeric 3 A code that represents a group containing items offered in the variable set.From the Group field in the Variable Set Group table.

Description alpha 30 A description of the variable set group.From the Description field in the Variable Set Group table.

Nbr_of_items numeric 3 The number of units the customer must order from the group.From the # of items field in the Variable Set Group table.


CWSerenade 5.0


VariableSetItem The VariableSetItem element repeats for each variable set component defined for the SKU in the Variable Set Details table.

SeqNbr numeric 3 The sequence number assigned to the variable set detail.From the Seq# field in the Variable Set Details table.

Var_comp_ITM_Number

alpha 12 A component item of the variable set item.From the Var comp ITM number field in the Variable Set Details table.

Var_comp_SKU_Code

alpha 14 The SKU of the component item.From the Var comp SKU code field in the Variable Set Details table.

SKUComment The SKUComment element repeats for each SKU comment defined for the SKU in the SKU Comments table.

Seq_Nbr numeric 3 The sequence number assigned to the SKU comment.From the Seq # field in the SKU Comments table.

Comment_line alpha 50 A line of SKU comments.From the Comment field in the SKU Comments table.

Print_code alpha 1 Indicates where to print or display the SKU comments.• B = Both pick slip and invoice.• I = Invoice• N = Nowhere• P = Pick slip• R or blank = Catalog planning analysis reports (Not currently implemented)• W = pop-up window when you order the itemFrom the Print code field in the SKU Comments table.

SKUAttribute The SKUAttribute element repeats for each SKU attribute defined for the SKU in the Item Attribute table.


CWSerenade 5.0


IAT_Type alpha 6 A code that identifies a SKU attribute.From the Type field in the Item Attribute table.

IAT_Description alpha 30 A description of the SKU attribute type.From the Description field in the Item Attribute table.

IAV_Value alpha 6 A code that identifies an attribute value.From the Value field in the Item Attribute Value table.

IAV_Description alpha 30 A description of the attribute value.From the Description field in the Item Attribute Value table.

IAA_Affinity_flag alpha 1 Determines how the system tracks the customer affinity preferences for the SKU.• U = Upsell only. Upsell the SKU to a customer flagged with the attribute value.• C = Capture only. When the customer orders the SKU, the customer’s affinity preference history is updated.• B = Both upsell and capture.• N = Neither upsell nor capture.From the Affinity flag field in the Item Attribute Assignment table.

UPC The UPC element repeats for each UPC code defined for the SKU in the Item UPC table.

UPC_Type alpha 3 The type of UPC code. The UPC type determines the type of validation performed against the UPC code.• E13 = EAN-13; 13 position UPC code. • E8 = EAN-8; 8 position UPC code. • UA = UPC-A; 12 position UPC code. • UE = UPC-E; 6 position UPC code. From the UPC type field in the Item UPC table.

UPC alpha 14 The UPC code defined for the SKU.From the UPC field in the Item UPC table.


CWSerenade 5.0


UPC_VND_Vendor numeric 7 The supplier who sells you merchandise.From the UPC VND vendor nbr field in the Item UPC table.

SKUUserField The SKUUserField element repeats for each SKU user field defined for the SKU in the SKU User Field table.

SKU_UDF_Sequence_Nbr

numeric 3 The sequence number assigned to the SKU user field.From the Seq# field in the SKU User Field table.

SKU_UDF_Text alpha 30 The text defined for the SKU user field.From the Text field in the SKU User Field table.

SKU_UDF_Number

numeric 16 The number defined for the SKU user field.From the Number field in the SKU User Field table.

SKU_UDF_Date numeric 7 The date defined for the SKU user field.From the Date field in the SKU User Field table.

SKU_UDF_Display_sequence

numeric 3 The sequence number assigned to the SKU user field, controlling its placement on the screen.From the Display sequence field in the SKU User Field table.

SKU_UDF_File_code

alpha 3 The code representing the table to which the user-defined field is linked. For SKU user fields, the file code is SKU.From the SKU UDF file code field in the SKU User Field table.

UDD_Field_label alpha 15 The field label that appears on a screen for the SKU user field.From the Field label field in the User Defined Field Detail table.



CWSerenade 5.0


Item Download Message: Sample XML

A sample of the Item Download XML Message (CWItemOut) is presented below.

<Message source="RDC" target="IDC" type="CWITEMOUT"><Items>

<Item Allow_SKUs="Y" Buyer="HEB" Buyer_Name="HANNAH BROWN" Company="6" Drop_ship_item="N" ITM_Allow_Pct_discount="Y" ITM_Create_Date="1081014" ITM_Description="GEL PEN" ITM_Exclude_From_Flex_Pay="N" ITM_Membership="N" ITM_Oversize_flag="N" ITM_Royalty="N" Item_Number="GEL2000" Non-inventory="N" Serial_Nbr_tracking="N" Standard_cost="1.2340" Transaction_type="C" UOM_Description="EACH" UOM_Units="1" Unit_of_measure="EA" VIA_Ship_via_code="0" Vendor_Nbr="12">

<ItemOffers><ItemOffer Cost="1.12" Expected_return_pct="512" Freight="2.12" Gift_wrap_flag="Y" Gift_wrap_price="1.12" Hidden_freight="2.12" IOF_Coupon_Disc_dlr="1.12" IOF_Coupon_Effective_Date="1100101" IOF_Required_Add_Reason="N" IOF_Spread="N" IOF_Volume_Discount_YN="N" IOF_Warranty_Item="N" Offer_Number="OFR" Projected_units="5" SH_price="2.12" Special_handling="Y" Square_inches="123">

<ItemPrices><ItemPrice Associate_price="9.12" Effective_date="1081001" Price="10.12" Qty="1" />

</ItemPrices></ItemOffer>

</ItemOffers><SourcePrices>

<SourcePrice SPS_Associate_price="0.11" SPS_Price="0.12" SPS_Qty="100" SRC_Source_code="SOURCE" />

</SourcePrices><Keywords>

<Keyword KWD_KeywordExclusion="GEL" KWD_Type="I" /><Keyword KWD_KeywordExclusion="WRITER" KWD_Type="I" />

</Keywords><SKU List_price="2.23" Location="PRIM1" Lowest_price="0.12" Restrict_orders="N" SKU_Average_Cost="1.2345" SKU_Code="BLUE " SKU_Create_Date="1081014" SKU_Cubing_value_override="5.0" SKU_Description="BLUE" SKU_Element_1_Code="BLUE" SKU_Element_1_Desc="BLUE" SKU_Element_1_Name="COLR" SKU_Element_2_Code="" SKU_Element_2_Name="SIZE" SKU_Element_3_Code="" SKU_Element_3_Name="OTHR" SKU_Excl_Store_Restock="N" SKU_Gift_certificate="N" SKU_Original_Retail_Price="5.12" SKU_Returnable="N" SKU_Subscription="N" SKU_Suppress_BO_Card="N" Sale_credit_flag="N" Selling_weight_override="2.120"



CWSerenade 5.0


Short_SKU="760" Warehouse="1" Warehouse_name="MAIN WAREHOUSE LOCATION" Weight_override="1.120">

<VendorItems><VendorItem Cubic_volume="1" Description="BLUE" Item="VGEL2000" Lead_days="1" Minimum_qty="1" Price="1.2345" Ship_weight="1.230" UOM_Description="EACH" UOM_Units="1" Unit_of_measure="EA" VIT_Freight_upload_GLNbr="60300" VIT_Handling_upload_GLNbr="60600" VIT_Other_upload_GLNbr="60300" VIT_Upload_frt_dlr_limit="100.12" VIT_Upload_hnd_dlr_limit="90.12" VIT_Upload_other_dlr_limit="80.12" VIT_Vend_ord_qty_multiple="1" Vendor_Nbr="12" />

</VendorItems><SKUOffers>

<SKUOffer Cost="1.23" Expected_return_pct="5.00" Freight="3.12" Gift_wrap_flag="Y" Gift_wrap_price="4.12" Hidden_freight="2.12" Offer_Number="OFR" Page_Nbr="32" Projected_units="5" SH_price="5.12" SKO_Coupon_discount_dlr="2.12" SKO_Coupon_effective_date="1121212" SKO_Required_Add_Reason="N" SKO_Spread="N" SKO_Volume_discountable="N" SKO_Warranty_Item="N" Special_handling_flag="Y" Square_inches="112">

<SKUPrices><SKUPrice Associate_price="10.12" Effective_date="1081001" Price="11.12" Qty="1" />

</SKUPrices></SKUOffer>

</SKUOffers><ItemWarehouses>

<ItemWarehouse Allocation_freeze="N" Economic_order_qty="20" ITW_Current_retail_price="2.34" ITW_Original_retail_price="1.23" ITW_Protect_MinMax="N" ITW_Protect_current_price="N" Max_qty="100" Min_qty="5" Reorder_qty="5" Warehouse="1" />

</ItemWarehouses><UPCs>

<UPC UPC="1234567890" UPC_Type="E13" UPC_VND_Vendor="12" /></UPCs>

</SKU></Item>

</Items></Message>

3/24/15 591

E-Commerce-Related Setup in CWSerenade

This section provides an overview of setup in CWSerenade related to the e-commerce integration:

• Additional E-Commerce Setup

• Working with E-Mail Notification Templates (WEMT)

3/24/15 Additional E-Commerce Setup 592

Additional E-Commerce Setup

Purpose: In addition to the setup described under Order API Setup Requirements and Order API-Related System Control Values, you must perform basic setup in CWSerenade, on your CWSerenade server, on your web server, and on the web storefront before you can use the E-commerce interface in CWSerenade. Setup requirements include:

• system control values

• supporting tables for download to web storefront

• additional system applications

Each requirement that is related to CWSerenade is described in this topic. All other requirements are described in additional documents.

Web storefront: Additionally, you must configure the web storefront to meet your business requirements. You can modify the sample storefront or create your own, using an application such as Microsoft Site Server or WebSphere; however, configuration of the web storefront is outside the scope of this document.

In this topic:

• System Control Values Related to E-Commerce

• Table Setup for Download

• Additional Setup

• Additional Table Settings• E-Commerce Periodic Functions

CWSerenade 5.0


System Control Values Related to E-Commerce

Purpose: The system control values related to e-commerce are described briefly in the table below.

Create application area: Before you can set several e-commerce system control values, you must create the EDC application area. You can create an application area by selecting Create at the Work with System Values/Features screen in Work with System Control Values (WSYS). Additionally, you must assign the application group ALL to the EDC application area. You can assign this application group by:

• selecting Application Group for the application area at the Work with System Values/Features screen; you advance to the Work with Application Group screen

• selecting Create to advance to the Create Application Group screen. Here, you can create the ALL application group for the EDC application area.

Each of the e-commerce system control values listed below should be assigned to this application area and group.


Get Orders from E-Commerce (G35)

Must be selected before you can use the e-commerce interface to download information to your web storefront.

Quantity Available Threshold for Inventory Downloads (G36)

Defines the available quantity to trigger the automatic download of availability information of an item. The quantity you define here is a default; you can also specify a Avail thrshld (Item-level availability threshold) for an item, and/or a Availability threshold (item class-level) for an item class.

Status Message for E-Commerce Partial Reserved Lines (G52)

Defines whether to identify partially reserved, partially backordered items as RESERVED, BACKORDER, or PARTIAL on the web storefront.

Hold Reason for Failed E-Commerce Maintenance Transactions (H11)

Specifies the hold reason code to assign to orders when a customer attempts, and fails, to maintain it from the web storefront.

Order Maintenance Confirmation E-Mail Program (H12)

Specifies the program to use to create order maintenance confirmations to send to customers via email.

Pass E-Commerce Status Response Type (H68)

Defines whether an Order Status Response Message is generated, regardless if an order is found that matches the order status inquiry request.

CWSerenade 5.0


Additional system control values:

For more information: See Order API-Related System Control Values for a list of values related to creating orders you receive from the web storefront.

Generate E-Commerce Customer Merge Staging FIles (H86)

Defines whether CWSerenade populates the e-commerce customer merge staging tables when you run the customer sold to merge/purge program or customer bill to merge/purge program.

Download Prepaid Payment Types to E-Commerce (I69)

Defines whether the system includes prepaid (cash/check payment category 1) payment types in the e-commerce pay type extraction.


FTC-# of Days for Items without Expected Ship Date (C71)

Controls the Expected delivery date to pass to the web storefront for items without open (unreceived) purchase orders. The system also includes information on whether the date was derived from a purchase order, or defaulted based on this system control value. You can use either a periodic function or a message to pass item availability information to the web storefront.

Default Source Code for Batch Catalog Requests (D37)

Used when you process catalog requests through the web storefront.

SKU Element Description 1 (G37)

Define the SKU element descriptions to appear on the web storefront.




CWSerenade 5.0


Table Setup for Download

Purpose: In addition to the tables you must set up for order entry through CWSerenade, you can set up the following tables to facilitate processing orders through the web storefront.

Table Purpose To Set Up

E-Commerce Category

To group items you offer on the web storefront. E-Commerce Category is provided as a search option on the sample storefront.

Work with E-Commerce Category (WECC) (creating categories to items) and Work with Item Categories screen (E-Commerce) in MITM (assigning categories to items)

E-Commerce Holiday Arrival Date

To simplify the assignment of an arrival date to an order. If the item should ship as a gift in time for a particular holiday, the customer selects that holiday at the web storefront, and the correct arrival date is assigned to the order automatically.

Work with E-Commerce Holidays (WECH)

E-Commerce Up-Sell Item

To upsell the customer from one item to an upgrade. For example, on the sample storefront, when a customer selects a style of boot for review, another, upgrade style is suggested as an alternative.Note: You can also upsell on the web storefront using item coordinates. Item coordinates allow you to suggest a coordinating item to accompany an item selected by the customer, rather than replacing it.

Work with E-Commerce Upsell screen in MITM

CWSerenade 5.0


E-Commerce Info

To specify the description of the item that should appear on the web storefront. You enter item information using the RP template(s) that have been set up for the item class. Item class templates allows you to specify headings that appear on screen when you enter the item information in CWSerenade; however, these headings do not appear on the web storefront, and the line breaks that separate the template headings in CWSerenade are deleted on the storefront.

1. Work with Item Classes (WICL) (setting up one or more RP templates for the item class) 2. Work with E-Commerce Item Information in MITM (entering the e-commerce item information)

E-Commerce Item Image

To specify where, on the web server, to find the image file that illustrates the item on the web storefront. You can specify a regular, thumbnail, and large image file and location for each item. You can also specify a default path for all items (if you use a standard naming convention where the image name is the same as the item code) and then override at the item level as needed.

Select Default Image Paths at Work with E-Commerce Job Control (EJCT) (default path)

E-Mail Template

To define the text to appear in system-generated emails to customers, such as backorder notices and soldout notifications.

Use Working with E-Mail Notification Templates (WEMT).

Table Purpose To Set Up

CWSerenade 5.0


Additional Setup

Purpose: In addition to the setup you must perform to process orders through order entry, you might need to set up the following information specifically for e-commerce orders.

Additional Table Settings

• Items: You can set the Avail thrshold as an override to the item-class level threshold or the Quantity Available Threshold for Inventory Downloads (G36) system control value.

• Item class: You can set the Availability threshold as an override to the Quantity Available Threshold for Inventory Downloads (G36) system control value.

• Customers: Set the Opt in/Opt out flag to indicate when to communicate with the customer by email. You set this flag at the customer level, or at the customer/entity level if the Track Customer History at Entity Level (F89) system control value is selected. Also, you will need to specify the Email address to correspond with the customer by email.

• Order type: Set the Email notification flag to indicate whether to communicate with customers by email on order-related correspondence, such as backorder or soldout notifications.

E-Commerce Periodic Functions

• ECAVAIL: Extracts item availability information to staging tables for retrieval by the web storefront. This function should use the program name ECR0144. See E-Commerce Item Availability Processing for a discussion of the item availability information included.

Note: This periodic extract is different from the interactive download triggered when an item’s availability falls below the appropriate threshold, as the interactive download takes place automatically.

• ECGFTC: Extracts currently available gift certificate numbers and amounts. This function should use the program name ECR0142.

• ECGFTCH: Extracts gift certificate charges only. This function should use the program ECR0302.

• ECITMCH: Extracts changes to existing items. This function should use the program name ECX0178.

• ECSHCNF: Sends shipment and return confirmation emails; see Sending Internet Order Ship Confirmation (ESCF). This function should use the program name ECR0154.

CWSerenade 5.0


• ECOMERR: Creates the batch OM Transaction Error Listing. This function should use the program ECR0295.

• ECX0358: Extracts updated customer user fields to the EC Customer Extended (EXCSTE) staging table.

3/24/15 Working with E-Mail Notification Templates (WEMT) 599

Working with E-Mail Notification Templates (WEMT)

Purpose: Use this menu option to work with the default text to include when you send email notifications:

• first, second, and continue backorder notices

• credit card credit acknowledgments

• “Contact us” requests

• credit card decline notifications

• gift certificate notifications

• loyalty membership activations and deactivations

• Relate loyalty registration notices

• membership cancellation notifications

• order confirmations

• purchase orders

• return confirmations

• shipment confirmations

• soldout notifications

• stored value card notifications

• quote confirmations

• order cancellation confirmations

• order line cancellation confirmations

• cancellation attempt failure notices

• store pickup notifications

The system automatically creates templates for each of the above at the company level, but the templates are blank until you specify the text for each email.

Email formats: Most of the system-generated emails are in HTML format; however, the gift certificate, maintenance failure, purchase order, and loyalty activation/deactivate notices are in simple text. See HTML Format Notification Samples and Contents and Simple Format Notification Sample for examples.

CWSerenade 5.0


Outbound email API: You can specify generation of a generic outbound XML message, rather than an actual email, for all notifications except the loyalty activation/deactivation, gift certificate, order maintenance failure notifications, and purchase orders. The customer service emails use the simple text format, and the purchase order form is attached to a plain-text email.

In this topic: The XML message includes additional information that is not included in the standard email notice. You might choose to generate the XML message so that you can use the information to produce a reformatted HTML email that includes promotional content.

• Summary of Customer Correspondence

• When Does the System Generate an Email Notification?

• Order Confirmation Emails• Shipment and Return Confirmation Emails• Stored Value Card Notification Emails• Gift Certificate Notification Emails• Quote Confirmation Emails• Membership Cancellations• Purchase Order Emails• Store Pickup Notifications• Relate Loyalty Registration Notifications• Other Email Notifications• Determining the Opt-in/out Setting• Additional Information about Email Notifications

• HTML Format Notification Samples and Contents

• Order Confirmation Email Sample and Contents• Backorder Notification Email Sample and Contents• Credit Card Credit Acknowledgement Email Sample and Contents• Return Confirmation Email Sample and Contents• Shipment Confirmation Email Sample and Contents• Credit Card Credit Acknowledgement Email Sample and Contents• Soldout Notification Email Sample and Contents• Stored Value Card Notification Sample and Contents• “Contact Us” Notification Sample and Contents• Credit Card Decline Notification Sample and Contents• Quote Confirmation Email Sample and Contents• Membership Cancellation Notification Sample and Contents• Order Cancellation Confirmation Email Sample and Contents

CWSerenade 5.0


• Order Line Cancellation Confirmation Email Sample and Contents• Store Pickup Notification Sample and Contents• Relate Loyalty Registration Notification Sample and Contents

• Simple Format Notification Sample

• Work with E-Mail Template Screen

• Change E-Mail Template Screen


• Setup overview: Email Generation Setup provides an overview on setup, a listing of related system control values, and troubleshooting information.

• Which text template? Email Text Templates describes the hierarchy that controls which text template to use for notifications.

• Which “from” email address? “From” Email Address describes the hierarchy that controls how to determine the “from” email address to use for emails.

• Actual email or CWEmailOut? HTML Email or Outbound Email XML Message? describes the hierarchy that controls whether to generate an actual email or the Outbound Email XML Message (CWEmailOut).

• Controlling individual notification types by order type: Generate Notifications? describes how to control the generation of different types of notifications for an order type.

CWSerenade 5.0


Summary of Customer Correspondence

The table below provides a summary of the customer correspondence generated by the system. See Work with E-Mail Template Screen for a listing of the information included in each type of generated email notice.

Generated Output

Generated Through: Subject Line Contents

Backorder 1st, 2nd, or Continue Notice

email (HTML format), XML, or printed

Generate Backorder Cards (GBOC)

Backorder - order#:99999999

See Backorder Notification Email Sample and Contents.

“Contact us” notice

email (HTML format) or XML

Selecting the Send Contact Us Email option at the Display More Options screen in order entry, inquiry, or maintenance. This option is available only if:• there is an email address for the customer, and• the customer’s opt-in/opt-out setting is O1 (email is preferred communication) or O2 (send order-related email only), and• the Contact Us Email Program (K54) system control value specifies an email program.Note: You can generate this email regardless of the setting of the Email notification flag for the order type.

Contact Us - Order#:99999999

See “Contact Us” Notification Sample and Contents.

CWSerenade 5.0


Credit Card Credit Acknowledgement

email (HTML format) XML, or printed

Generate C/C Credits (MREF), Processing A/R Refunds (MARC), and Processing Refunds by Order Number (MRFO)

Credit Ack. - Order #99999999

See Credit Card Credit Acknowledgement Email Sample and Contents.

Credit Card Decline Notice


Streamlined Pick Slip Generation (WSPS)

Credit Card Decline - Order #99999999

See Credit Card Decline Notification Sample and Contents.

Gift Certificate

Generated Output


CWSerenade 5.0


email or printed

Process Gift Certificates (MPGC)

A Gift Certificate for You

• gift certificate number• gift certificate amount• gift certificate date• name of the customer sold-to who purchased the gift certificateNote: If you define base program ECR0383 in the Gift Certificate E-Mail Program (H07) system control value, the system does not include the standard text, and instead, includes the following fields using name/value pairs:• sold to first name, last name, address, and email address• ship to first name, last name, address, and email address• order number• item and description• SKU and description• order messages 1, 2, and 3• gift certificate number• gift certificate amount

Loyalty Activate Notice and Loyalty Deactivate Notice

Generated Output


CWSerenade 5.0


email only BILL_ASYNC and ORDR_ASYNC processes in Background Job Control (MBJC)

Loyalty Activation or Loyalty DeactivationNote: The word “Loyalty” is replaced with the value in the Alternate Customer Number Label Description (H95) system control value, if any.

• sold-to customer name• sold-to customer number• loyalty program description• loyalty program membership ID

Relate Loyalty Registration Notification


Relate Loyalty Registration Process

Loyalty Registration Notification

See Relate Loyalty Registration Notification Sample and Contents.

Maintenance Failure

email only ECOMM_CANC process in Working with E-Commerce Job Control (EJCT)

Order Update - Order #99999999

• order number

• result, indicating that order cannot be changed at this time

• sold to customer name

• ship to customer name

Membership Cancellation


cancelling a customer membership through the Working with Customer Memberships (WWCM) menu option

Membership Cancellation

See Membership Cancellation Notification Sample and Contents.

Quote Confirmation

Generated Output


CWSerenade 5.0



Select the Email Quote option on the Print/Email Quote window

Quote Confirmation - Quote # 99999999

See Quote Confirmation Email Sample and Contents.

Order Cancellation Confirmation


ORDR_ASYNC process in Background Job Control (MBJC)

Order Cancellation - Order# 99999999

See Order Cancellation Confirmation Email Sample and Contents.

Order Confirmation


• accepting an order in interactive Order Entry.• processing an order through the order API, including orders in error if the Suppress Order Confirmations for Orders in Error (K09) system control value is unselected. • accepting and processing a corrected order batch, if an order confirmation has not previously been generated for the order ship to. • the ORDR_ASYNC job if an order confirmation has not previously been generated for the order ship to.

Order Confirmation - Order# 99999999

See Order Confirmation Email Sample and Contents.

Order Line Cancellation Confirmation


ORDR_ASYNC process in Background Job Control (MBJC)

Order Line Cancellation - Order# 99999999

See Order Line Cancellation Confirmation Email Sample and Contents.

Generated Output


CWSerenade 5.0


Return Confirmation


• billing if the Send Shipment Confirmation from Billing (L98) system control value is selected• Sending Internet Order Ship Confirmation (ESCF)• ECSHCNF periodic function

Return Conf. - Order #99999999

See Return Confirmation Email Sample and Contents.

Shipment Confirmation


• billing if the Send Shipment Confirmation from Billing (L98) system control value is selected• Sending Internet Order Ship Confirmation (ESCF)• ECSHCNF periodic function

Ship Conf. - Order #99999999

See Shipment Confirmation Email Sample and Contents.

Soldout Notification

email (HTML format) XML, or printed

Print Soldout Notifications (MSON)

Soldout - Order #99999999

See Soldout Notification Email Sample and Contents.

Store Pickup Notification

Note: Locate’s Store Connect module does not use this notification email; instead, you can use Locate to generate a notification to the customer.


Email Request Message (CWEmailRequest)

Order Ready for Pickup - Order# 99999999

See Store Pickup Notification Sample and Contents.

Stored Value Card Notification

Generated Output


CWSerenade 5.0



SVC_OUT process in Integration Layer Job Control (IJCT)

Stored Value Card Notification

See Stored Value Card Notification Sample and Contents.

Gift Acknowledgement

printed only

Pick slip generation or billing, depending on the setting of the Automatic Generation of Gift Acknowledgement (B92) system control value

N/A See the online help or the reports guide.

A/R Statement

printed only

Print Statements (PSTS)


Pick Slips

printed only

Streamlined Pick Slip Generation (WSPS)


Drop Ship Pick Slips

printed only

Select Vendors for Drop Ship Picks (MDSP)


Customer Invoice

printed only

Print Invoices (PINV) or standard Order Inquiry


Refund Checks

printed only

Process Refunds (MREF)


Merchandise Credits, Bonus Credits, and Sale Credits

printed only


N/A

Generated Output


CWSerenade 5.0


When Does the System Generate an Email Notification?

• Order Confirmation Emails

• Shipment and Return Confirmation Emails

• Stored Value Card Notification Emails

• Gift Certificate Notification Emails

• Quote Confirmation Emails

• Purchase Order Emails

• Relate Loyalty Registration Notifications

• Other Email Notifications

Order Confirmation Emails

An order is eligible for an order confirmation email or Outbound Email XML Message (CWEmailOut) if:

• the order is not a quote, and

• the Email notification flag for the order type is selected, and,

• the Send email flag for the Order Confirmation is selected for the order type at the Order Type Email Selection screen (WOTY), and

• the customer’s Opt-in/out setting (see Determining the Opt-in/out Setting) is O1 or O2, and

• the customer has an Email address; and,

• the order includes one or more order lines with a positive quantity, and

• the order includes lines other than a soldout item, or the Exclude S/O on order confirmation is unselected, and

• the E-Mail Order Confirmations for All Orders (H51) is selected, or• the order type matches the E-Commerce Order Type (G42).

Note:

• If you delete the email address and the Suppress Email Address Search (J09) system control value is selected, the system does not generate order-related emails for the order. See that system control value for more information.

• The system does not confirm that the customer’s email address is a valid, existing address.

CWSerenade 5.0


• The XML only? flag for the Order Confirmation template used (at either the entity or company level) controls whether you generate an actual email notification or the Outbound Email XML Message (CWEmailOut).

• To generate an actual email (rather than the Outbound Email XML Message (CWEmailOut)), you need to have the Order Acknowledgement Program (G50) system control value set to OrdConf or to the name of your unique HTML-based email program. To generate the Outbound Email XML Message (CWEmailOut), you have to set the system control value to any value, but it cannot be blank.

• If the Suppress Order Confirmations for Orders in Error (K09) system control value is unselected and there are any errors on the order, the generated email might not be formatted correctly. For example, if there is not sufficient valid information for the shipping address on the order, this name and address are omitted from the generated email.

• If the order includes multiple shipping addresses, the system generates a separate confirmation for each ship-to.

CWSerenade 5.0


Generated when? The order confirmation email or Outbound Email XML Message (CWEmailOut) is generated automatically when the order is created, either through interactive order entry or the order API (order API orders); however, if an order created through the order API is in error and the Suppress Order Confirmations for Orders in Error (K09) system control value is selected, the order confirmation is not generated until you correct any errors and accept and process the corrected order batch.

If you enter the order through interactive order entry, the confirmation is not generated while the order is still suspended in a batch. Once you accept the order, the system generates the confirmation.

For more information: See the Order Confirmation Email Sample and Contents.

CWSerenade 5.0


Shipment and Return Confirmation Emails

The system generates a shipment or return confirmation email or Outbound Email XML Message (CWEmailOut) only if:

• the Email notification flag for the order type is selected, and,

• the Send email flag for the notification type is selected at the Order Type Email Selection screen, and

• the customer’s Opt-in/out setting (see Determining the Opt-in/out Setting) is O1 or O2, and,

• the customer has an Email address, and,

• the E-Mail Shipment Confirmations for All Orders (H52) system control value is selected, or,

• the order type matches the E-Commerce Order Type (G42), or• the Internet order field in the Order Header table is set to I

• for return confirmations, the return disposition code for the return does not match the return disposition code defined in the Return Disposition Code to Exclude in Relate Sales Feed (M22) system control value and the Suppress refund field in the Order Payment Method table is N or blank.

Note:

• If you delete the email address and the Suppress Email Address Search (J09) system control value is selected, the system does not generate order-related emails for the order. See that system control value for more information.


• The XML only? flag for the Shipment or Return Confirmation template used (at either the entity or company level) controls whether you generate an actual email notification or the Outbound Email XML Message (CWEmailOut).

• To generate an actual shipment confirmation email (rather than the Outbound Email XML Message (CWEmailOut)), you need to have the Shipment Confirmation Program (G51) system control value set to ShpConf or to the name of your unique HTML-based email program.

• Similarly, to generate an actual return confirmation email, you need to set the Return Confirmation E-Mail Program (H53) system control value to RtnConf or to the name of your unique HTML-based email program.

• To generate the Outbound Email XML Message (CWEmailOut), you have to set the system control value to any value, but it cannot be blank.

CWSerenade 5.0


• There is a separate shipment confirmation email for each shipment (invoice) for the order billed on a given date.

You can generate shipment and return confirmation emails or the Outbound Email XML Message (CWEmailOut) through:

• billing if the Send Shipment Confirmation from Billing (L98) system control value is selected

• Send Internet Shipment Confirmations (ESCF)

• the ECSHCNF periodic function

If you do not consolidate invoices, the system keeps track of the shipment and return confirmation emails that it has generated by invoice number and date so that you can stop and restart email generation for a single date without risk of generating a duplicate email to a customer.

For more information: See the Shipment Confirmation Email Sample and Contents and Return Confirmation Email Sample and Contents.

CWSerenade 5.0


Stored Value Card Notification Emails

The system generates a stored value card notification or outbound XML message when the SVC_OUT job processes an approved stored value card activation request if:

• The SVC type field for the stored value card item is E or V.

• An email address is defined for the stored value card recipient.

• The Stored Value Card Email Notification Program (I30) system control value specifies a program name. The base program is SVCNOTF.

The system does not look at the Email notification setting for the order type to determine whether to generate an email.

Note:

• The system generates this email notification regardless of the setting of the Suppress Email Address Search (J09) system control value.

• The XML only flag for the Stored Value Card notification template used (at either the entity or company level) controls whether you generate an actual email notification or the Outbound Email XML Message (CWEmailOut).

• To generate an actual stored value card confirmation email (rather than the Outbound Email XML Message (CWEmailOut)), you need to have the Stored Value Card Email Notification Program (I30) system control value set to SVCNOTF or to the name of your unique HTML-based email program. To generate the Outbound Email XML Message (CWEmailOut), you have to set the system control value to any value, but it cannot be blank.

Important: The outbound XML version specified for the EMAIL_OUT process in Integration Layer Job Control (IJCT) must be set to at least 4.0 in order to generate email or XML stored value card notifications.

Gift Certificate Notification Emails

The system generates an email gift certificate notification, rather than including it in a document, only when:

• the customer is purchasing a gift certificate on an order

• the E-mail gift certificate field is selected at the Work with Order Ship to Properties screen for the order in which the customer buys the gift certificate

• an email address is specified for the gift certificate recipient, which might be a customer sold-to, a permanent ship-to customer, or a temporary (order) shipping address. Additionally, if you define a vendor in the Vendor for E-Mail Gift Certificate (I04) system control value, the system uses the email address defined for the vendor instead of the email address defined for the gift certificate recipient.

CWSerenade 5.0


• the correct program to generate the email notice is specified in the Gift Certificate E-Mail Program (H07) system control value

Note: The system generates this email notification regardless of the setting of the Suppress Email Address Search (J09) system control value.

The system does not look at the Email notification setting for the order type to determine whether to generate an email.

Quote Confirmation Emails

A pre-order quote is eligible for a quote confirmation email or Outbound Email XML Message (CWEmailOut) if:

• the Status of the order is Quote.

• the customer or order has an Email address; and,

• the Quote Confirmation Email Program (K74) system control value contains a valid email program. The base email program for quote confirmations is QUOCONF.

In addition, for quotes entered through the order API:

• the quote passes web order validation, and

• the Quote field and Email notification field for the order type are selected, and,

• the customer’s Opt-in/out setting (see Determining the Opt-in/out Setting) is O1 or O2

For quotes entered through interactive order entry, the system does not look at the Email notification setting for the order type or at the customer’s Opt in/out setting to determine whether to generate the Quote confirmation.

Note:


• The XML only? flag for the Quote Confirmation template used (at either the entity or company level) controls whether you generate an actual email notification or the Outbound Email XML Message (CWEmailOut).

• To generate an actual email (rather than the Outbound Email XML Message (CWEmailOut)), you need to have the Quote Confirmation Email Program (K74) system control value set to QUOCONF or to the name of your unique HTML-based email program. To generate the Outbound Email XML Message (CWEmailOut), you have to set the system control value to any value, but it cannot be blank.

Generated when? The quote confirmation email or Outbound Email XML Message (CWEmailOut) is generated when you select the Email Quote option on the Print/Email Quote window.

CWSerenade 5.0


The system does not look at the Email notification setting for the order type to determine whether to generate a quote confirmation.

For more information: See the Quote Confirmation Email Sample and Contents.

Membership Cancellations

Generated when? If the Membership Cancellation Email Program (K77) system control value specifies a valid program name, the system generates membership cancellation emails when you cancel a customer membership through Work with Customer Memberships (WWCM). These emails are not generated when you cancel the membership item through order maintenance.

Which entity? The membership’s Default source indicates the entity associated with the customer membership for the purposes of determining the email template text.

Loyalty memberships: Email confirmations are also generated for loyalty memberships if you cancel them rather than deactivating them or having the system deactivate them automatically due to order cancellations or returns. Since loyalty memberships are not associated with a specific order or source code, they cannot use an entity-level template, and instead they always use the template set up through the Work with E-Mail Template Screen. Also, since loyalty memberships do not actually generate orders, both the sold-to and ship-to customer indicated in the email identify the customer possessing the loyalty membership.

Customer note: The system writes a customer note, such as Memship Cancel Conf to [email protected], when it generates the membership cancellation email or XML message. The user ID associated with the customer note indicates the person who canceled the membership. The note is written even if the email might not actually be deliverable to the customer (for example, if there is a problem with the customer’s email address). Also, the note is written for the sold-to customer, even if the notification email was sent to a recipient.

Determining the email address: The email is sent to the email address of the customer ultimately receiving the membership orders, such as the recipient customer or a permanent ship-to address, provided there is a valid email address for that address and the opt-in/out setting is O1 or O2. If there is no alternate shipping address, the email is sent to the customer purchasing the membership. If the customer’s opt-in/out setting is O1 or O2 but there is no email address specified, the system writes a message to the APP.log, indicating that the email address is unresolved. The system does look at the Email notification setting for the order type originating the membership, or assigned to generated orders, to determine whether to generate an email.

For more information: See the Membership Cancellation Notification Sample and Contents.

CWSerenade 5.0


Purchase Order Emails

Generated when? Emailing the purchase order instead of printing it is available when:

• the Email Purchase Order (K80) system control value is selected, and

• the vendor’s Email P/O flag is selected, and

• the vendor has a valid Email address.

Which menu options support emailing the purchase order? If the above conditions are true, you can email purchase orders through the Print PO Selection screen in Print Purchase Orders (MPRP), and through the Print P/O window in purchase order entry, maintenance, and inquiry.

Note: You cannot email purchase orders through Print PO and Receiving Worksheets (PPWS) or through Selecting Vendors for Drop Ship Processing (MDSP).

Separate emails: The system always generates a separate email for each purchase order, even if you select a range of date or purchase orders through Print Purchase Orders (MPRP).

Which print program is used? In most cases, the .PDF attached to the email is generated with the PO Print Program (C64); however, if you are using Print Purchase Orders (MPRP) and print by purchase order number sequence, the PO Print Program for PO Print in PO Sequence (C76) is used.

Email template: The text in the email is derived from the Purchase Order template set up through the Change E-Mail Template Screen in Working with E-Mail Notification Templates (WEMT). Things to note about the Purchase Order template:

• Unlike other email templates, this template is not available at the entity level, since the purchase order is not related to a specific entity.

• The generated email is plain text, with the purchase included as a .PDF attachment. The XML only flag is not available for this template, and you cannot generate the Outbound Email XML Message (CWEmailOut).

• Because the Purchase Order email does not include any details, you would not normally enter the Text to print below items. If you do so, this text appears several lines below the Text to print above items in the generated email.

1. The “from” email address is derived from the company (see Setting Up Companies (WCMP). If no email address specified for the company, the “from” email address is from the from.email specified through setting up the email properties file.

2. The subject of the email is Purchase Order - PO # 1234567, where 1234567 is the purchase order number.

CWSerenade 5.0


Store Pickup Notifications

The store pickup notification email indicates that a customer’s order is ready for pickup at the selected store. The system generates the store pickup notification when it receives the CWEmailRequest message for an external system, where the order has been assigned, provided that:

• the Email notification field for the order type is selected, and

• the Opt-in/out setting (see Determining the Opt-in/out Setting) for the email address on the order is O1 or O2, and

• there is a valid email generation program specified for the Store Pickup Confirmation Email Program (L48) system control value.

For more information: See the Store Pickup Notification Sample and Contents.


Relate Loyalty Registration Notifications

The Relate loyalty registration notification email indicates that a customer has successfully registered in the Relate Loyalty program. The system generates the Relate loyalty registration notification when a loyalty card is assigned to a customer while registering a customer in the Relate loyalty program, provided that:

• the Opt-in/out setting (see Determining the Opt-in/out Setting) for the email address is O1 or O2, and

• the Relate Card Inquiry Response returned from Relate contains a loyalty card number, and

• there is a valid email generation program specified for the Relate Loyalty Registration Notification Email Program (M10) system control value.

For more information: See the Relate Loyalty Registration Notification Sample and Contents.

Other Email Notifications

Backorder, soldout, cancellations, loyalty membership activation or deactivation, credit card credit notifications, “contact us” emails, credit card decline emails, maintenance failure, and order or order line cancellation confirmation emails: The system generates an email, rather than including the notice in a document (if applicable), only when:

• the Email notification field for the order type is selected, and

CWSerenade 5.0


• if the notification type is listed at the Order Type Email Selection screen, the Send email flag is selected, and

• the Opt-in/out setting (see Determining the Opt-in/out Setting) for the email address on the order is O1 or O2, and

• there is a valid email generation program specified for the related system control value.

Generation of other notification emails: The rules on generating other emails besides the types called out separately above are illustrated below.

Affected by settings at the order type? The settings at the order type include the Email notification flag and the Send email flag available for selected notifications for that order type. Order type settings control the generation of backorder notices, credit card credit acknowledgements, order or order line cancellation confirmations, and loyalty activation and deactivation notices. Also, the settings control the generation of quote confirmations for orders received through the order API as well as order confirmations and shipment and return confirmations, as described above.

Not affected by settings at the order type: The settings at the order type do not control the generation of membership cancellations, stored value card notifications, gift certificate

CWSerenade 5.0


notifications, “contact us” emails, maintenance failure notifications, or credit card decline notifications.

Note:

• If you delete the email address and the Suppress Email Address Search (J09) system control value is selected, the system does not generate order-related emails for the order.

• The system does not confirm that the customer’s email address is valid.

• The customer API does not generate notification emails when it activates or deactivates a loyalty membership; these emails are generated only as a result of order activity.

• The XML only? flag for the template used controls whether you generate an actual email notification or the Outbound Email XML Message (CWEmailOut).

• This Email notification flag for the order type does not control email generation for “contact us” emails, loyalty activation or deactivation notices, maintenance failure notices, or credit card decline notices.

• Quotes are not subject to most of the notification types described above; however, the system does generate the soldout notification for a quote if you use Process Auto Soldouts to sell out the item and the quote is otherwise eligible for emails based on the criteria that apply to other order types.

Backorder, soldout, “contact us,” credit card credit, and credit card decline notifications:

• To generate an actual notification email (rather than the Outbound Email XML Message (CWEmailOut)), you need to have set the related system control values correctly:

• the Backorder Notification Program (G95) system control value set to BONOTF or to the name of your unique HTML-based email program.

• the Soldout Notification E-Mail Program (G96) must be set to SONOTF or to the name of your unique HTML-based email program.

• the Credit Card Credit Acknowledgement E-Mail Program (H08) must be set to CCCNOTF or to the name of your unique HTML-based email program.

• the Credit Card Decline Email Program (K53) must be set to CDECLNOTF or to the name of your unique HTML-based email program.

• the Contact Us Email Program (K54) must be set to CTUSNOTF or to the name of your unique HTML-based email program. This email is generated on demand, and not produced automatically by the system. See Summary of Customer Correspondence for more information on when the option to generate the “Contact Us” email is available.

• the Order Cancellation Email Program (K78) must be set to ORDCANNOTF or to the name of your unique HTML-based email program.

CWSerenade 5.0


• the Order Line Cancellation Email Program (K79) must be set to ORDLCANOFTF or to the name of your unique HTML-based email program.

• for both the order and order line cancellation emails, the cancel reason code used must not match the Cancel Reason Code to Suppress Email (L08).

• To generate the Outbound Email XML Message (CWEmailOut), you have to set the related system control value to any value, but it cannot be blank.

Determining the Opt-in/out Setting

The system uses the following hierarchy to determine the opt-in/out setting to use when generating emails:

1. Check the Customer Sold To Email Address table for an email address that matches the email address on the order. If there is a match, use that Opt in/Opt out setting; otherwise,

2. If there is an individual placer on the order, use that individual’s OptIn setting; otherwise,

3. Use the customer’s Opt in/Opt out setting.

Additional Information about Email Notifications

Order history message: The system writes an Order Transaction History message when it generates an email or the Outbound Email Message (CWEmailOut). You can review these messages at the Display Order History screen in standard order inquiry.

Save in email repository? The Write Outbound Email to Email Repository (H99) system control value controls whether header information on email notifications or the Outbound Email Message (CWEmailOut) are stored in correspondence history. If the system control value is selected, the system records the correspondence history regardless of whether you generate an actual email or the Outbound Email Message (CWEmailOut). See this system control value for more information on identifying and reviewing outbound emails for a customer.

Note: The system does not retain the body of outbound emails in correspondence history, only the header information, such as the date, subject, and “to” email address.

CWSerenade 5.0


HTML Format Notification Samples and Contents

The system generates HTML format emails for the notification types described below if the XML only? flag for the template is unselected. If the flag is selected, the system generates the Outbound Email Message (CWEmailOut) instead.

The contents of each of the HTML emails are derived from the Outbound Email Message (CWEmailOut). The EMAIL_OUT process must be set to generate the most recent version of the outbound message in order to generate all of these email notifications correctly; see

All other email notification types besides these notification types use the simple format described below under Simple Format Notification Sample.

Sample HTML messages:

• Order Confirmation Email Sample and Contents

• Shipment Confirmation Email Sample and Contents

• Return Confirmation Email Sample and Contents

• Backorder Notification Email Sample and Contents

• Credit Card Credit Acknowledgement Email Sample and Contents

• Soldout Notification Email Sample and Contents

• Stored Value Card Notification Sample and Contents

• “Contact Us” Notification Sample and Contents

• Credit Card Decline Notification Sample and Contents

• Quote Confirmation Email Sample and Contents

• Order Cancellation Confirmation Email Sample and Contents

• Order Line Cancellation Confirmation Email Sample and Contents

• Relate Loyalty Registration Notification Sample and Contents

CWSerenade 5.0


Order Confirmation Email Sample and Contents

See Order Confirmation Emails for a discussion on how to generate this email.

CWSerenade 5.0


Contents: The contents of the order confirmation email are derived from the Outbound Email XML Message (CWEmailOut) as follows:

Preliminary Information:

• greeting: The word Dear followed by the:

• sold_to_fname, if any; otherwise, • sold_to_company, if any; otherwise,• Valued customer

Note: Each of the above is in lower case, with just the first letter of the first word capitalized.

• text: before_line_msg. The email includes a line break (<br>) between each line entered at the Change E-Mail Template Screen.

Order Summary:

• Order #: order_nbr and order_ship_to, separated by a hyphen

• Order Date: order_date

• for each item/SKU ordered:

• Item/SKU: odt_item and odt_SKU, if any, separated by a slash; however, this is the odt_alias_item if the customer ordered by alias, regardless of the setting of the Display Item Alias (D56) system control value

• Quantity: odt_qty• Price: odt_price• Extended Price: odt_extended_price• Status: odt_availability_msg; indicates whether the item is: In stock;

Backordered (including order lines that are not reserved because they have future arrival dates); a brokered backorder being fulfilled through the Order Broker integration (Store Ship); a drop ship (includes an Exp Date); flagged for pickup at a designated store location through the Order Broker integration (Store Pickup); or sold out (No longer available). The Status Message for E-Commerce Partial Reserved Lines (G52) system control value controls whether to list partially reserved lines as Backordered or Reserved, or to include details (for example, 7 reserved, 3 B/O).

Note: If the background jobs are not running and the order ships before the order confirmation email is generated, the status of the shipped order lines is indicated as In stock.

• Expected Date: odt_expected_ship_date; included only if the item is backordered or drop ship

• item description: odt_item_desc

CWSerenade 5.0


• SKU description: odt_SKU_desc, if any (included only if the item has SKU’s)• custom special handling: osf_label and osf_input, if any (included only if item is

assigned custom special handling) All custom special handling is included, even handling whose Suppress S/H window flag is set to Suppress. The system includes the osf_label even when the osf_input is blank. Note: The order confirmation does not include line level special handling charges since these charges are included at the order level.

• totals:

• Merchandise: ost_merch• Shipping and Handling: ost_freight, ost_addl_freight, ost_hand, and

ost_addl_charge• Tax: ost_tax• Total: ost_total_amt

Purchasing Information:

• Ship To: ship_to_company, ship_to_fname, ship_to_minitial, ship_to_lname, ship_to_addr1, ship_to_addr2, ship_to_addr3, ship_to_addr4, ship_to_apt, ship_to_city, ship_to_state, ship_to_postal, ship_to_country

• Sold To: sold_to_company, sold_to_fname, sold_to_minitial, sold_to_lname, sold_to_addr1, sold_to_addr2, sold_to_addr3, sold_to_addr4, sold_to_apt, sold_to_city, sold_to_state, sold_to_postal, sold_to_country

• Customer #: sold_to_nbr

Closing: after_line_msg. The email includes a line break (<br>) between each line entered at the Change E-Mail Template Screen.

Note: If the Suppress Order Confirmations for Orders in Error (K09) system control value is unselected and there are any errors on the order, the generated email might not be formatted correctly. For example, if there is not sufficient valid information for the shipping address on the order, this name and address are omitted from the generated email.

CWSerenade 5.0


Shipment Confirmation Email Sample and Contents

See Shipment and Return Confirmation Emails for information on how to generate this email.

CWSerenade 5.0


Contents: The contents of the shipment confirmation email are derived from the Outbound Email XML Message (CWEmailOut) as follows:






Shipment Summary:



• Date Shipped: ist_ship_date

• Amount Charged: ist_ship_total_amt

• Items included in this shipment:

• Item/SKU: idt_item and idt_SKU, if any, separated by a slash; however, this is the idt_alias_item if the customer ordered by alias, regardless of the setting of the Display Item Alias (D56) system control value

• Quantity: idt_ship_qty• item description: idt_item_desc• SKU description: idt_SKU_desc, if any (included only if the item has SKU’s)

• Here are your tracking numbers for the items that shipped:

• Carrier: tracking_ship_via_desc. • Tracking Number: tracking_nbr, made into a live link to the shipper’s web site

using the tracking_URL. Brokered backorder? If the item was a brokered backorder shipped through integration with Locate, then the ship via description is listed only if the Order Broker passed a valid ship via code set up in CWSerenade; otherwise, the message lists the shipping agent passed from the Order Broker. In this case, the tracking number is not a live link. Also, if a brokered backorder ships on the same day as a warehouse shipment, the shipment confirmation email includes both the tracking numbers. This occurs regardless of whether you consolidate invoices. Note: If the order includes two invoices on the same date, one for a brokered backorder with a tracking number, and another shipment without a tracking number,

CWSerenade 5.0


the tracking number from the brokered backorder is indicated for both shipments. A shipment might not have a tracking number if, for example, you confirm a drop shipment or use manual confirmation.


• Sold To: sold_to_company, sold_to_fname, sold_to_minitial, sold_to_lname, sold_to_addr1, sold_to_addr2, sold_to_addr3, sold_to_add4, sold_to_apt, sold_to_city, sold_to_state, sold_to_postal, sold_to_country


Return Confirmation Email Sample and Contents

See Shipment and Return Confirmation Emails for more information on how to generate this email.

CWSerenade 5.0


Contents: The contents of the return confirmation email are derived from the Outbound Email XML Message (CWEmailOut) as follows:






Return Summary:



• Date Returned: ist_ship_date

• Amount Credited: ist_ship_total_amt

• Items included in this return:

• Item/SKU: idt_item and idt_SKU, if any, separated by a slash; however, this is the idt_alias_item if the customer ordered by alias, regardless of the setting of the Display Item Alias (D56) system control value

• Quantity: idt_ship_qty• item description: idt_item_desc• SKU description: idt_SKU_desc, if any (included only if the item has SKU’s)

Note: If no items were returned: If the order was credited through the application of a negative additional charge rather than processing a return, no item/SKUs are listed. Instead, a message indicates: There were no items associated with this return. A miscellaneous credit was processed on your order. However, the Item/SKU and Quantity headings are still included in the email.

Closing: after_line_message. The email includes a line break (<br>) between each line entered at the Change E-Mail Template Screen.

Backorder Notification Email Sample and Contents

You can generate first, second, and continue backorder notifications through the Generate Backorder Cards (GBOC) and Work with Backorders Pending Cancellation

CWSerenade 5.0


(WBPC) menu options. See Other Email Notifications for more information on how to generate these emails.

Contents: The contents of the first, second, or continue backorder notification email are derived from the Outbound Email XML Message (CWEmailOut) as follows:




CWSerenade 5.0




Notice type:

• Backorder Summary - First Notification

• Backorder Summary - Second Notification

• Backorder Summary - Subsequent Notification




• for each backordered item:

• Item/SKU: bo_item and bo_SKU, if any, separated by a slashNote: This email does not specify the item alias even if the customer ordered by alias.

• Backorder quantity: bo_qty• Expected date: bo_expected_date• item description: bo_item_desc and SKU description: bo_SKU_desc, if any

(included only if the item has SKU’s)





CWSerenade 5.0


Credit Card Credit Acknowledgement Email Sample and Contents

You generate this email through the Processing Refunds (MREF), Processing A/R Refunds (MARC), or Processing Refunds by Order Number (MRFO) menu options. See Other Email Notifications for more information on how to generate this email.

Contents: The contents of the credit card credit acknowledgement email are derived from the Outbound Email XML Message (CWEmailOut) as follows:


CWSerenade 5.0



• sold_to_fname, if any; otherwise, • sold_to_company, if any; otherwise,• Valued Customer



Refund Summary:

• Refund Order #: order_nbr and order_ship_to, separated by a hyphen

• Refund Date: ccc_refund_date

• Refund Total: ccc_refund_amt

• Items included in the order:

• Item/SKU: ccc_item and ccc_SKU if any, separated by a slash• item description: ccc_item_desc• SKU description: ccc_SKU_desc if any (included only if the item has SKU’s)

Note: If the credit was generated through a negative additional charge, there are no items listed; however, the headings are still included in the email.


• Sold To: sold_to_company, sold_to_lname, sold_to_fname, sold_to_minitial, sold_to_addr1, sold_to_addr2, sold_to_addr3, sold_to_add4, sold_to_apt, sold_to_city, sold_to_state, sold_to_postal, sold_to_country


• Customer #:, sold_to_nbr


CWSerenade 5.0


Soldout Notification Email Sample and Contents

You use the Generating Soldout Notifications (MSON) option to generate these soldout notifications. See Other Email Notifications for more information on how to generate these emails.

Contents: The contents of the soldout notification email are derived from the Outbound Email XML Message (CWEmailOut) as follows:



CWSerenade 5.0





Notice type: Soldout Summary



• for each soldout item:

• Item/SKU: so_item and so_SKU, if any, separated by a slashNote: This email does not specify the item alias even if the customer ordered by alias.

• Soldout quantity: so_qty• item description: so_item_desc and SKU description: so_SKU_desc, if any

(included only if the item has SKU’s)






Stored Value Card Notification Sample and Contents

See Stored Value Card Notification Emails for information on when the system generates these emails.

CWSerenade 5.0


Note: Each activated stored value card generates a separate email notification.

CWSerenade 5.0


Contents: The contents of the stored value card notification email are derived from the Outbound Email XML Message (CWEmailOut) as follows:



• ship_to_fname, if any; otherwise, • ship_to_company, if any; otherwise,• Valued customer



Notice type: Stored Value Card Summary



• Date Activated: svc_activation_date

• for the stored value card item:

• Item/SKU: svc_item and svc_SKU, if any, separated by a slashNote: This email does not specify the item alias even if the customer ordered by alias.

• Quantity: svc_qtyNote: The quantity is always 1. A separate notification is generated for each value card number activated.

• item description: svc_item_desc and SKU description: svc_SKU_desc, if any (included only if the item has SKU’s)

Shipment message:

• For a virtual card: You will not be receiving a physical card on the item above.

• For a physical card, early notification: You will be receiving a physical card on the item above.

Here is your Stored Value Card number for the item that shipped:

• Stored Value Card Number: svc_card_nbr

• Value: svc_issue_amount

• ID Number: svc_id_nbr (if your Stored Value Card Email Notification Program (I30) supports it)

CWSerenade 5.0


• Up to four lines of order message lines flagged to print as gift messages: svc_message1, svc_message2, svc_message3, svc_message4

Purchasing Information

• Gift Card Recipient: ship_to_company, ship_to_fname, ship_to_minitial, ship_to_lname, ship_to_addr1, ship_to_addr2, ship_to_addr3, ship_to_addr4, ship_to_apt, ship_to_city, ship_to_state, ship_to_postal, ship_to_country




CWSerenade 5.0


“Contact Us” Notification Sample and Contents

You can generate this email by selecting Send Contact Us Email at the Display More Options screen in order entry, maintenance, and inquiry. See Summary of Customer Correspondence for information on how to generate these emails.

Contents: The contents of the “contact us” email are derived from the Outbound Email XML Message (CWEmailOut) as follows:



• sold_to_fname, if any; otherwise,

CWSerenade 5.0


• sold_to_company, if any; otherwise,• Valued customer










CWSerenade 5.0


Credit Card Decline Notification Sample and Contents

The pick slip generation program generates these emails to customers when their orders have been placed on hold due to a declined authorization. See Summary of Customer Correspondence for more information on how to generate these emails.

Contents: The contents of the credit card decline email are derived from the Outbound Email XML Message (CWEmailOut) as follows:




CWSerenade 5.0










CWSerenade 5.0


Quote Confirmation Email Sample and Contents

See Quote Confirmation Emails for a discussion on how to generate this email.

CWSerenade 5.0


Contents: The contents of the quote confirmation email are derived from the Outbound Email XML Message (CWEmailOut) as follows:






Quote Summary:

• Quote #: order_nbr and order_ship_to, separated by a hyphen

• Quote Date: order_date

• Quote Expire Date: cancel_date

• Sale Rep: sales_rep_name

• for each item/SKU ordered:


• Quantity: odt_qty• Price: odt_price• Extended Price: odt_extended_price• Country of Orig.: sku_country_of_origin• Harmonize Code: harmonize_code

• Item description: odt_item_desc• SKU description: odt_SKU_desc, if any (included only if the item has SKU’s)

Soldout items: Soldout items are not included on the Quote Confirmation if the Exclude S/O on order confirmation field for the order type on the quote is selected.

• totals:


ost_addl_charge• Tax: ost_tax

CWSerenade 5.0


• Total: ost_total_amt

Gift quotes: If you enter a gift quote (the Gift flag on the Work with Order screen is selected), the system still prints pricing information on the Quote Form and Quote Confirmation.






CWSerenade 5.0


Membership Cancellation Notification Sample and Contents

See Membership Cancellations for information on how to generate this email.

Contents: The contents of the membership cancellation confirmation email are derived from the Outbound Email XML Message (CWEmailOut) as follows:



• sold_to_fname, if the email is sent to the sold-to customer and there is a sold-to name; otherwise,

• ship_to_fname, if the email is sent to the ship-to customer and there is a ship-to name; otherwise,

• Valued customer

CWSerenade 5.0




Membership Summary:

• Membership ID: membership_id

• Membership description: membership_desc

• Cancel reason: mbr_cancel_rsn and mbr_cancel_rsn_desc, separated by a space and hyphen






Order Cancellation Confirmation Email Sample and Contents

See the Order Cancellation Email Program (K78) system control value for information on how to generate this email.

CWSerenade 5.0


Contents: The contents of the order cancellation confirmation email are derived from the Outbound Email XML Message (CWEmailOut) as follows:



• sold_to_fname, if there is a sold-to name; otherwise, • Valued customer



CWSerenade 5.0


Order Cancellation Summary:



For each open or held order line from the order when you canceled it:• Item/SKU: odt_item and odt_SKU, if any, separated by a slash; however, this is

the odt_alias_item if the customer ordered by alias, regardless of the setting of the Display Item Alias (D56) system control value

• Quantity: odt_qty_cancelled. If there have been previous cancellations against the order line, this is the quantity canceled during the session that canceled the order.

• item description: odt_item_desc• SKU description: odt_SKU_desc, if any (included only if the item has SKU’s)

Note: Order lines that were previously canceled or sold out are not listed; also, any order lines canceled using the Cancel Reason Code to Suppress Email (L08) are omitted.






CWSerenade 5.0


Order Line Cancellation Confirmation Email Sample and Contents

See the Order Line Cancellation Email Program (K79) system control value for information on how to generate this email.

Contents: The contents of the order line cancellation confirmation email are derived from the Outbound Email XML Message (CWEmailOut) as follows:



CWSerenade 5.0





Order Line Cancellation Summary:



• For each order line canceled during the order maintenance session or other activity, such as Working with Backorders Pending Cancellation (WPBC):


• Quantity: odt_qty_cancelled, the total quantity canceled at this time, even if multiple cancel reason codes were used in order maintenance. Does not include any previous quantity canceled.


Note: Order lines that were previously canceled or sold out are not listed; also, any order lines canceled using the Cancel Reason Code to Suppress Email (L08) are omitted.

• Remaining Unshipped or Open Items:

• For each remaining open or held order line:


• Quantity: odt_qty, the open or held quantity remaining on the order line• Status: odt_availability_msg; indicates whether the item is In stock; Backordered

(including order lines that are not reserved because they have future arrival dates); being fulfilled through the Order Broker integration (Store Ship); drop ship (includes an Exp Date); or sold out (No longer available). The Status Message for E-Commerce Partial Reserved Lines (G52) system control value controls whether to list partially reserved lines as Backordered or Reserved, or to include details (for example, 7 reserved, 3 B/O).

• Expected Date: odt_expected_ship_date; included only if the item is backordered or drop ship

CWSerenade 5.0








Store Pickup Notification Sample and Contents

See the Store Pickup Confirmation Email Program (L48) in the online help for information on how to generate this email.


CWSerenade 5.0


Contents: The contents of the store pickup notification email are derived from the Outbound Email XML Message (CWEmailOut) as follows:





CWSerenade 5.0



Order Summary:



• For each item on the order:


• Quantity: odt_qty• Price: odt_price• Extended Price: odt_extended_price• Item description: odt_item_desc• SKU description: odt_SKU_desc, if any (included only if the item has SKU’s)

• totals:


ost_addl_charge• Tax: ost_tax• Total: ost_total_amt

Pickup Information:

• Pickup Store: ship_to_company, ship_to_fname, ship_to_minitial, ship_to_lname, ship_to_addr1, ship_to_addr2, ship_to_addr3, ship_to_addr4, ship_to_apt, ship_to_city, ship_to_state, ship_to_postal, ship_to_country

Note: This information defaults from the Store Cross Reference record.x




CWSerenade 5.0


Relate Loyalty Registration Notification Sample and Contents

See the Relate Loyalty Registration Notification Email Program (M10) in the online help for information on how to generate this email.

Contents: The contents of the Relate loyalty registration notification email are derived from the Outbound Email XML Message (CWEmailOut) as follows:



• sold_to_fname, if there is a sold-to name; otherwise, • sold_to_company



• Here is your Loyalty Card number: the loyalty card number generated and singed to the customer from Relate.

CWSerenade 5.0





CWSerenade 5.0


Simple Format Notification Sample

The loyalty activation/deactivation, gift certificate, maintenance failure notices, and purchase order use a simple email format such as the following.

Kaplan, EliseFrom: [email protected]: Friday, February 2, 2009 4:22 p.m.To: [email protected]: PREFERRED Activation

We are pleased to tell you that your recent order qualifies you for membership in our Preferred Members Club. Club members receive a 5% discount on all orders and free ground shipping.

GUESTVIP12 000000038

Sold To: WENDELL, MICKEY Customer #: 13082

PREFERRED MEMBERS CLUB PREFERRED

Welcome to the club! We appreciate your business.

CWSerenade 5.0


Work with E-Mail Template Screen

Purpose: Use this screen to enter boilerplate company-wide text to include in email notifications.

Overrides? You can also enter override text templates at the entity level, or overrides for certain notification types at the order type level and the entity/order type level. See Email Text Templates for more information.

How to display this screen: Enter WEMT in the Fast path field at the top of any menu, or select Work with E-Mail Templates from a menu.

Field Description

Notice type Indicates the type of email notification. Available templates are:• Backorder 1st notice (template type B1)• Backorder 2nd notice (template type B2)• Backorder continue notice (template type B3)• C/C credit acknowledgment (template type C1)• Contact us (template type CU)• Credit Card Decline (template type (CX)• Gift certificate (template type GC)• Loyalty Activate Notice (template LA)• Loyalty Deactivate Notice (template LD)• Relate Loyalty Registration Notice (template LR)• Maintenance Failure (template type ME) Note: The system generates maintenance failure notices in response to unsuccessful cancellation requests from the web storefront.• Membership Cancel Confirmation (template type MF)• Order Cancellation (template type OB)• Order Confirmation (template type OC)• Order Line Cancellation Confirmation (template type OL)• Purchase Order (template type PO)• Quote Confirmation (template type QC)• Return Confirmation (template type RC)• Soldout notification (template type S1)• Shipment Confirmation (template type SC)• Store Pickup Confirmation (template type SP)• Stored Value Card notification (template type SV)Alphanumeric, 25 positions; display-only.

CWSerenade 5.0



Enter or change the contents of an email notification template

Select Change for a template to advance to the Change E-Mail Template Screen.

Display the contents of an email notification template

Select Display for a template to advance to the Display E-Mail Template Screen. You cannot change any information at this screen. See the Change E-Mail Template Screen for field descriptions.

CWSerenade 5.0


Change E-Mail Template Screen

Purpose: Use this screen to specify the standard text to include in one of the types of email notifications available in CWSerenade at the company level.

Overrides? You can also enter override text templates at the entity level, and override certain notification types at the order type level and the entity/order type level. See Email Text Templates for more information.

How to display this screen: Select Change for a notice type at the Work with E-Mail Template Screen.

Field Description

XML only Indicates whether to generate the Outbound EMail XML Message (CWEmailOut) rather than an actual email notification. This XML message includes additional information that is not included in the standard email notice. You might choose to generate the XML message so that you can use the information to produce a reformatted HTML email that includes promotional material. See Outbound EMail XML Message (CWEmailOut) for an overview.Valid values are:Selected = Generate the Outbound EMail XML Message (CWEmailOut) rather than an actual emailUnselected = Generate the email notification. See HTML Format Notification Samples and Contents for more information.Note:

• This option is not available for the loyalty activation/deactivation, cancellation failure, gift certificate notification, or purchase order templates.

• This setting applies if the system uses the associated text template. See HTML Email or Outbound Email XML Message? for more information.

Text to print above items

The standard text to include in each email above the information specific to the order, if the email is order-related. See the HTML Format Notification Samples and Contents and the Simple Format Notification Sample.Alphanumeric, ten 60-position lines; at least one line required.

CWSerenade 5.0


Completing this screen: Enter the text to appear in the email notification or to include in the Outbound EMail XML Message (CWEmailOut). You can type over existing text to change it, or delete it to clear a line. The text you enter will be included the next time you generate this type of email notification. Any lines that you leave blank will be omitted from the email.

Text to print below items

The standard text to include in each email below the information specific to the order, if the email is order-related. See the HTML Format Notification Samples and Contents and the Simple Format Notification Sample.Note: Not typically included for the purchase order email, since the email does not include any details.Alphanumeric, three 60-position lines; optional.

Field Description

CWSerenade 5.0

3/24/15 Testing Email Generation (UEML) 662

Testing Email Generation (UEML)

Purpose: Use this option to generate a test email in order to confirm that CWSerenade is correctly configured to generate emails.

This option does not support testing individual message notification types.

Send Email Message Screen

How to display this screen: Enter UEML in the Fast path field at the top of any menu or select Test Email from a menu.

Completing this screen: Complete the three fields and click OK to generate a test email.

Field Description

To The email address to receive the test email.Note: The system does not confirm that you enter a valid email address.Alphanumeric, 50 positions; required.

Subject The text to use as the subject line for the test email.Alphanumeric, 44 positions; required.

Message Up to four lines of text to include in the body of the email.Alphanumeric, 64 positions each; at least one line required.

3/24/15 663

E-Commerce-Related Jobs in CWSerenade

This section describes the jobs that run within CWSerenade to support the e-commerce integration:

• Working with E-Commerce Job Control (EJCT)

• Downloading E-Commerce Static Tables (ESTF)

• Downloading E-Commerce Offer Tables (EOFR)

• Sending Internet Order Ship Confirmation (ESCF)

• Removing Offers and Items from Download (ERMV)

3/24/15 Working with E-Commerce Job Control (EJCT) 664

Working with E-Commerce Job Control (EJCT)

Purpose: Use the E-Commerce Job Control menu option to work with the ASYNC jobs that process catalog request updates, inquiry, and other information for the e-commerce interface.

Creating orders: You use the Generic Order Interface (Order API) to create orders from the web storefront.

Default image paths: You can also use this menu option to set up default image paths and a default image type to indicate where to find item illustrations for display on the pages of the web storefront.

Process overview: As the customer enters information at the web storefront, the system sends messages to the e-commerce background jobs for processing. For example, when a customer on the web storefront enters a catalog request, a message is sent to the CATALOG REQUESTS process. If this process (background job) is active, it creates the catalog request immediately. If the process is not active when the message arrives, the catalog request will be created once you start the process. All messages are processed in the sequence in which they arrive at the message queue.

Which job queue? Most of the e-commerce background jobs run automatically in the QSYSNOMAX job queue in order to avoid slowing down any other jobs that might be running in other job queues on the system; the ECOMM_CANC job, however, runs in the ECOMMERCE job queue.

Note: The e-commerce processes are not restricted by company; when you work with or change a process, it affects all companies.

Generic web service: As an alternative to sending messages directly to the inbound queue specified for each e-commerce job, you can use the generic web service. In this situation, you send messages to the endpoint for the generic web service, which routes each message to the correct e-commerce job and then routes the generated response.

In this topic:

• Work with E-Commerce Job Control Screen

• E-Commerce Processes

• Changing the Number of Sessions

• Change E-Commerce Job Control Pop-up Window

• Changing Process Status

• Change Status Pop-up Window

CWSerenade 5.0


• Work with E-Commerce Queues Screen

• Change Image Paths Screen (Working with Default Image Paths)

• E-Commerce Order Cleanup Log

Work with E-Commerce Job Control Screen

Purpose: Use the Work with E-commerce Job Control screen to work with the queues that process XML messages for the CWSerenade e-commerce interface.

How to display this screen: Enter EJCT in the Fast path field at the top of any menu, or select E-Commerce Job Control from a menu.

Field Description

Process The job that performs e-commerce interface updates between CWSerenade and the web storefront. See E-Commerce Processes for a description of each.Alphanumeric, 20 positions; display-only.

Current status The status of the process. Possible statuses are:• Active• Inactive• Starting• EndingSee Changing Process Status.Alphanumeric, 9 positions; display-only.

# of sessions The number of separate jobs to allocate to processing orders from the web storefront. Just as you can set up the billing async job to run multiple instances, you can also set the number of each individual e-commerce process you would like to run.See Changing the Number of Sessions.Numeric, 5 positions; display-only.


Change the number of sessions for a process

Select Change for a process to advance to the Change E-Commerce Job Control Pop-up Window.

Change the status of a process Select Change Status to advance to the Change Status Pop-up Window.

CWSerenade 5.0


Hide an unused process in order to simplify the information displayed at the screen

Select Hide Process; see Hiding an E-Commerce Process.

Start a process Select Start for a process to start it.

End a process Select End for a process to end it. See Changing Process Status.

Define the input queue manager (if using WebSphere MQ) or connection factory (if using HornetQ)

Select Work with Queues for a process to advance to the Work with E-Commerce Queues Screen.

Start all processes Select Start All.

End all processes Select End All.

Work with default image paths Select Img Paths to advance to the Change Image Paths Screen (Working with Default Image Paths).

Work with background jobs Select Background Jobs to advance to the Work with Background Jobs Screen.

Work with Drop Ship background jobs Select Drop Ship Jobs to advance to the Work with Drop Ship Background Jobs Screen.

Work with integration layer jobs Select Integration Layer to advance to the Work with Integration Layer Process Screen.


CWSerenade 5.0


E-Commerce Processes

Purpose: This table describes:

• the e-commerce processes

• their functions

• the jobs they initiate

• the messages they handle

Note: The default input queues (for processing messages from the web storefront to CWSerenade) and, in certain cases, remote queues (to enable sending information from CWSerenade to the web storefront) vary, depending on the configuration of your web storefront.

Process Function Submitted Job(s)

Messages

Catalog requests

Creates a catalog request when the customer enters a request on the web storefront. See E-Commerce Catalog Requests for more information on processing.Additionally, you can update or create a sold to customer and individual using this message; see Customer Creation/Update Logic in E-Commerce Catalog Requests.

EC_CAT_REQ

E-Commerce Catalog Request Message (CWCatRequest) (To CWSerenade)

E-Commerce Catalog Request Response Message (CWCatreqResponse) (From CWSerenade)

CWSerenade 5.0


Order cleanup Rejects any orders that have been “abandoned” on the web storefront if, for example, the customer closes the browser window. This process uses the Time Limit for Suspended E-Commerce Orders (G43) system control value to determine the number of minutes to wait before rejecting an order. Only orders of the type specified in the E-Commerce Order Type (G42) system control value are eligible for cleanup, and the cleanup takes place only if the Get Orders from E-Commerce (G35) system control value is selected. The system generates the E-Commerce Order Cleanup Log each time it deletes a suspended order.Note: Each time the job rejects an order, it writes a record in the Deleted Order table.

EC_CLEANUP

N/A

Cancels Following an order status request and response (see EC_STS_INQ), this process handles cancellation requests from the web storefront. The cancellation request can specify the entire order ship-to, or specific items on the order. The response message merely indicates that the request was received; a subsequent email confirmation indicates whether the cancellation request was successful. See Working with Batch Order Maintenance Transactions (WBOM) for an overview.

EC_CANCELS

E-Commerce Cancel Request Message (CWCancel) (To CWSerenade)


Messages

CWSerenade 5.0


Returns Creates a return authorization for an item on an order, using the return reason code supplied by the customer on the storefront. Also, writes an order history message that the return authorization was created. You must review the return authorization and complete it or delete it using the Work with Returns for Orders menu option. If your web storefront supports it, you can also enable the customer to print a return label using the return address for the entity associated with the source code on the order header, or the return address for the company. See Creating Return Authorizations from the Web Storefront for more processing information.Note: If the SECRISK periodic function deactivated the payment method for an order, the return authorization returns a blank response.

EC_RETURNS

E-Commerce Return Request Message (CWReturn) (To CWSerenade)

E-Commerce Return Response Message (CWReturnResponse) (From CWSerenade)


Messages

CWSerenade 5.0


Note: Prior to release 3.5, there was an order reject e-commerce process. The Order Reject Request Message (CWORDERREJECT) became available in release 3.5 to interactively reject abandoned orders without waiting for the EC_CLEANUP process. See Rejecting the Order (Order API) for background.

Order status/inquiry

Receives an order inquiry from the web storefront, based on company, sold-to customer, order number, and, optionally, individual and/or bill-to customer. Returns the order summary information to the web storefront, indicating if the customer can perform maintenance against the order, such as returning an order line. See E-Commerce Order Status Processing for more processing information. Note: You can also inquire about a customer’s order history or detailed information about a single order, using the Generic Customer History API.

EC_STS_INQ E-Commerce Order Status Message (CWOrderStatus) (To CWSerenade)

E-Commerce Order Status Response Message (CWStatusResponse) (From CWSerenade)


Messages

CWSerenade 5.0


Changing the Number of Sessions

Purpose: Use this pop-up window to change the number of sessions, or queues, available to an e-commerce process. You might increase the number of sessions to improve response time on the web storefront.

Change E-Commerce Job Control Pop-up Window

How to display this window: Select Change for a process at the Work with E-Commerce Job Control Screen.

Number of sessions: Enter the number of sessions you would like to run.

Note: You cannot change the number of sessions for the ORDER CLEAN UP process.

CWSerenade 5.0


Changing Process Status

Overview: Use this window to start or stop a process individually. When you start one or more processes, their status changes from Inactive to Starting to Active. When you end one or more processes, their status changes from Active to Ending to Inactive.

The Start All option starts all processes. The End All option ends all processes.

To verify that a process is running successfully: Use the Display Active Batch Jobs screen to verify that the e-commerce job is running successfully.

Change Status Pop-up Window

Change status: You can change the status of a process if it does not start or stop normally in a reasonable amount of time. Select Change Status for a process to display the Change Status window. At this window, select the desired status, Inactive or Active.

Important: Only security administrators (the Security administrator flag for the user is selected in Work with Users) can change the status of an e-commerce process.

CWSerenade 5.0


Hiding an E-Commerce Process

Purpose: You can hide an unused e-commerce process in order to simplify the information displayed at the Work with E-Commerce Job Control Screen.

Which processes are eligible to be hidden? You can hide a process only if:

• its current status is Inactive

• it does not have any process queues set up through the Work with E-Commerce Queues Screen

Before you hide a process: You should confirm that it is not a process that you are currently using or will need to use in the near future. For example, if you hide:

• Outbound processes: Messages will not generated.

• Inbound processes: Messages will not be received and processed.

Also, if you use the Start E-Commerce Async Jobs and Stop E-Commerce Async Jobs periodic functions, the function may start and stop the process, even though it is hidden.

How to hide a process: At the Work with E-Commerce Job Control Screen, select Hide Process.

How to show a hidden process: Once a process is hidden, you cannot show it again through an option at a screen in CWSerenade. Instead, you need to query the EC Job Control table and change the EJC Status field from H to I.

CWSerenade 5.0


Work with E-Commerce Queues Screen

Purpose: Use this screen to review or change the queue manager (if using WebSphere MQ) or connection factory (if using HornetQ) and queue for e-commerce messages.

Types of queues: The types of queues displayed at this screen varies depending on the requirements of the process. For example, a process that receives messages but never needs to send a response would not include fields related to response queues. See the E-Commerce Processes for more information on the types of messages received and generated by each process.

How to display this screen: Select Work with Queues for a process at the Work with E-Commerce Queues Screen.

Field Description

Enter queue definitions for

The name of the process whose queues you are reviewing. Alphanumeric, 20 positions; display-only.

Queue Manager The queue manager (if using WebSphere MQ) or connection factory (if using HornetQ) on your local JMS server associated with both the input and remote queue, if the job uses both types of queues. Note: The name can be upper and lower case.Alphanumeric, 48 positions; required.

Local Input Queue The queue where this process receives messages originating from the web storefront. Enter the name of the correct queue to change it. Note: Included only if the process receives inbound messages.Alphanumeric, 48 positions; required.

Output Queue The queue that sends the responses to the remote system.Note: Included only if the process sends outbound messages.

CWSerenade 5.0


Change Image Paths Screen (Working with Default Image Paths)

Purpose: Use this screen to define:

• the default image type (that is, JPG or GIF) you use on your web storefront

• default paths for each of the image sizes you will use on the web storefront. You can define up to three: regular, thumbnail, and large.

This default setup will simplify data entry if you normally store each type of image file in the same folder and use the item name as the filename.

How to display this screen: Select Dflt Image Paths at the Work with E-Commerce Job Control Screen.

Field Description

Image type The three-character filename extension that indicates the default image format for the web storefront. Typically, web images are either GIF or JPG.Alphanumeric, 3 positions; optional.

Thumbnail path The path where thumbnail item images are located. You would typically use a thumbnail, or smaller, image on a web page where the customer can browse multiple items. If the path extends beyond one line and into the next, type continuously without inserting any spaces. The system does not insert a blank space between lines when you download information to the storefront, but treats the four lines as one 240-position field.Alphanumeric, four 60-position fields; optional.

Regular path The path where regular-sized item images are located. You would typically use a regular image on a web page where the customer can review detailed information on a particular item. If the path extends beyond one line and into the next, type continuously without inserting any spaces. The system does not insert a blank space between lines when you download information to the storefront, but treats the four lines as one 240-position field.Alphanumeric, four 60-position fields and one 15-position field; optional.

CWSerenade 5.0


Large path The path where large item images are located. You would typically use a large image on a web page if you want the customer to be able to view the item in greater detail. If the path extends beyond one line and into the next, type continuously without inserting any spaces. The system does not insert a blank space between lines when you download information to the storefront, but treats the four lines as one 240-position field.Alphanumeric, four 60-position fields and one 15-position field; optional.

Field Description

3/24/15 E-Commerce Item Availability Processing 677

E-Commerce Item Availability Processing

Purpose: Your options in sending item availability information to the web storefront include:

• a periodic function to update an extract table in the CWSerenade database

• a stored procedure to directly update the table in the web storefront’s database

• an XML message; see the Generic Inventory Download API

Selecting an item availability processing method: The available options and some considerations for each are described below.

Option Considerations More Information

periodic function to update the EC Item Availability Table

• enables you to use the scheduling options in CWSerenade to run extracts of item availability according to your business requirements

• supports sending updates as needed when the available quantity for an item falls below a specified threshold

• includes rules for calculating the available quantity and expected purchase order dates to report for special types of items, such as sets and drop ships

• limits the item selection to those already downloaded to the web

• requires a mechanism to transfer the data from the EC Item Availability table in the CWSerenade database to the web storefront

• requires you to use Downloading E-Commerce Offer Tables (EOFR)

Extracting Item Availability Information to the EC Item Availability Table

CWSerenade 5.0


In this topic:

• Extracting Item Availability Information to the EC Item Availability Table

• Item Availability Periodic Function• Item Availability Web Threshold• What Item Availability Data is Included?

• Extracting Item Availability Information with Stored Procedures

• What Item Availability Data is Included?

stored procedure to extract availability information

• runs quickly and can be run as often as needed

• can extract updated information for a specific item and SKU, or for all items

• does not include the ability to trigger updates based on availability threshold, or to restrict groups of items based on business rules

• requires the web site to call a database stored procedure

Extracting Item Availability Information with Stored Procedures

generic inventory download API

• generates an XML message based on triggers created through a batch process using business rules, or interactively based on activity that affects current or projected availability

• provides extensive options in setting up trigger rules based on information about the items

• includes rules for excluding non-allocatable or frozen item warehouses

• includes more extensive data elements in addition to availability information

• requires a mechanism on the web storefront to process the XML message in order to update inventory information

• requires processing time to generate and transmit XML messages

Generic Inventory Download API

Option Considerations More Information

CWSerenade 5.0


Extracting Item Availability Information to the EC Item Availability Table

The process that extracts information to the EC Item Availability table (EXAVAI) for retrieval by the web storefront is described below.

• Item Availability Periodic Function

• Item Availability Web Threshold

• What Item Availability Data is Included?

For more information: See E-Commerce Item Availability Processing for a summary of the other options available for extracting item availability information for the web storefront.

Item Availability Periodic Function

When is item availability data extracted? The information is extracted both dynamically (see below) and through a periodic function. The ECAVAIL periodic function (program name ECR0144) creates a record in the EC Item Availability table for every item and SKU for which you have downloaded information to your web storefront. Only items that have been already selected through the Downloading E-Commerce Offer Tables (EOFR) menu option and added to the EC Item table (EXITEM) are eligible for selection.

Important: You need to clear the EC Item Availability table before running the periodic function to correctly update the Default delivery date field.

Item Availability Web Threshold

For dynamic updates to the EC Item Availability table, the system determines the web threshold used to evaluate an item’s availability by checking the:

1. Avail thrshld (Item-level availability threshold) assigned to the item.2. If there is no item threshold, the Availability threshold (item class-level) for the item

class assigned to the item.3. If there is no item or item class threshold, the Quantity Available Threshold for

Inventory Downloads (G36) system control value setting. 4. If all of these thresholds are blank, the system does not automatically download item

availability information to the web storefront. Example: An items’s threshold is 20; its item class threshold is 15; and the system

control value is set to 25. The interactive availability download takes place based on the item-level threshold of 20.

Interactive updates: The system updates the item’s or SKU’s available quantity in the EC Item Availability table:

CWSerenade 5.0


• if an item or SKU’s available quantity is greater than or equal to this threshold, and then it falls below the threshold.

Example: Available quantity for item AB100 is 21, and the web threshold is 20. You enter an order line for a quantity of 2, reducing the available quantity to 19.

• once an item or SKU’s available quantity is below the threshold, each time the available quantity is reduced until it is zero.

Example: After entering the order line in the above example, you enter another line on a different order for a quantity of 4, reducing the available quantity from 19 to 15.

• if an item or SKU’s available quantity is below this threshold, and then it increases to the threshold quantity or more.

Example: After entering the order line in the above example, you cancel an order for 5 units, bringing the available quantity for the item from 15 to 20.

What Item Availability Data is Included?

The information in the EC Item Availability table consists of:

• company, base item code, and short SKU number

• quantity available (if the available quantity is less than zero, the EC Item Availability table indicates an available quantity of zero)

• the next date when a purchase order receipt is expected

• default delivery date: a flag to indicate whether the date expected was based on an actual purchase order, or was defaulted based on the FTC -- # of Days for Items without Expected Ship Date (C71) system control value:

• 0 = actual purchase order date from the PO Layering table (POLAYR)• 1 = date was defaulted based on the system control value

Examples: Item AB100 has available quantity of 100 and an open purchase order that is due on May 15, 2013.Result:Quantity available = 100Date expected = 051522013Default delivery date = 0

CWSerenade 5.0


You can present this information about each item’s projected availability to your web customers if your storefront supports it. For example, if there was no expected delivery date for item AB100, and the delivery date downloaded through the periodic function was calculated based on this system control value, you might display a message on the web storefront indicating that no purchase order receipts are expected in the near future.

What if the item is sold out? If the item is assigned a soldout control code, the information downloaded varies depending on the soldout control code’s status. The soldout statuses and the resulting availability information included in the download are summarized in the table below:

Item CB200 has no available quantity, and there are no open purchase orders. The current date is May 1, 2013, and the FTC - # Of Days for Items without Expected Ship Date system control value is set to 30 days.Result:Quantity available = 0Date expected = 05312013Default delivery date = 1

Soldout control code Availability download

1 = sell out immediately Quantity available = 0Date expected = blankRegardless of the actual quantity of the item you have available, or whether there are any open purchase orders, you will not be selling any more units. In this case, the setting of the Default delivery date is irrelevant.

2 = include on-order quantity in the soldout calculation

Open purchase order?

• If there is an open purchase order, the information is the same as an item without a soldout control code, as described above.

• If there is not an open purchase order, the Date expected is blank and does not default from the FTC - # Of Days for Items without Expected Ship Date system control value.

CWSerenade 5.0


3 = exclude on-order quantity in the soldout calculation

Available quantity greater than zero?

• If the current available quantity is greater than zero, that available quantity is indicated in the table, and:

• if there is an open purchase order, the Date expected is from the purchase order, and the Default delivery date is 1

• if there is not an open purchase order, the Date expected is blank, and the Default delivery date is 0

• If the current available quantity is not greater than zero, the available quantity indicated in the table is zero, and the Date expected is blank, regardless of whether there is an open purchase order. In this case, the setting of the Default delivery date is irrelevant.

Soldout control code Availability download

CWSerenade 5.0


Set items: The availability of a set item is based on the availability of its components; in this case, the information in the availability download is consistent with the “worst case scenario” for the set based on its components, as described in the following table:

How to sell out the set, regardless of the availability of its components: To have the set item itself appear to be sold out, regardless of the availability of its components, assign the set item a soldout control status of sellout immediately.

Note: In order entry, the set item sells out if it is assigned any soldout control code; however, in the item availability download for e-commerce, only a soldout control status of sellout immediately will make the set item appear to be sold out.

Non-inventory items: Availability information is irrelevant for the following types of items, which will have the Quantity available set to 9999999:

• non-inventory items (based on the Non/inv (Non-inventory) flag for the item)

• membership items (based on the Membership flag)

• gift certificates (based on the Gift cert (Gift certificate) flag)

• subscriptions (based on the Subscription flag)

• drop ship items

Calculating expected ship date for drop ship items: The Assign Drop Ship Expected Ship Date (I59) controls how to calculate the expected ship date for drop ship items. If this system control value is:

• unselected: the expected ship date is calculated using FTC -- # of Days for Items without Expected Ship Date (C71)

• selected:

• CWCollaborate drop ship items (the item’s default vendor has the Drop ship output field set to Collaborative Shipping): the expected ship date = the current date + CDC Drop Ship Lead Days (H36) + the Lead days for the vendor item

Set includes: Availability download indicates:

six components; five components have several hundred available each, but one component has only five available

Quantity available = 5Date expected = from the latest expected delivery date

five components: four are available, but one is backordered

Quantity available = 0Date expected = from the backordered item (actual or default)

seven components: six are available, but one has a soldout control of 1 (sell out immediately)

Quantity available = 0Date expected = blank

CWSerenade 5.0


• other drop ship items: the expected ship date = the current date + FTC -- # of Days to Add for Drop Ships (C68) + the Lead days for the vendor item

CWSerenade 5.0


Extracting Item Availability Information with Stored Procedures

Purpose: You can use stored procedures to request current inventory information from CWSerenade to update the web storefront. The request can specify a certain item and SKU, or include all items and SKU’s that have Item Warehouse records.

Set items: The availability of a standard set item is based on the availability of its components; in this case, the information in the availability download is consistent with the “worst case scenario” for the set based on its components, as described in the following table:

How to sell out the set, regardless of the availability of its components: To have the set item itself appear to be sold out, regardless of the availability of its components, assign the set item a soldout control status of sellout immediately.

For more information: See E-Commerce Item Availability Processing for a summary of the other options available for extracting item availability information for the web storefront.

What Item Availability Data is Included?

The sp_web_available stored procedure (for a specific item and SKU in a company) and the sp_web_inventory stored procedure (for all items and SKU’s in a company, provided they have Item Warehouse records) both return the same information:

Set includes: Availability download indicates:

six components; five components have several hundred available each, but one component has only five available

Quantity available = 5Date expected = from the latest expected delivery date

five components: four are available, but one is backordered

Quantity available = 0Date expected = from the backordered item (actual or default)

seven components: six are available, but one has a soldout control of 1 (sell out immediately)

Quantity available = 0Date expected = blank

Field Description

Company Code The code identifying the company.Numeric, 3 positions.

CWSerenade 5.0


Product The code identifying the item.Alphanumeric, 12 positions.

SKU The item’s additional characteristics, such as its color and style. Included only if the item has SKU’s. Alphanumeric, 14 positions (three codes of 4 positions, each separated by a space.

Available Quantity The total quantity available across all allocatable warehouses, calculated as:On hand - Protected - Reserved - Reserve Transfer - BackorderedDifferent types of items:

• drop ship, non-inventory, membership, gift certificate, or subscription: the available quantity is 9999; however, if there are any units of a drop ship item in a warehouse, the system uses the standard availability calculation based on the on-hand quantity.

• sets:

• standard sets: see Extracting Item Availability Information with Stored Procedures, above, for a discussion.

• continuity items and variable sets: the available quantity for the set master item is 0. The component items indicate the actual availability.

• finished goods: the system uses the standard availability calculation.

• gift cards:

• virtual cards: the available quantity is 0.• physical cards: the system uses the standard availability

calculation.

Next PO Quantity The total quantity expected on all purchase orders in all allocatable warehouses, less the quantity already accounted for by backorders. Numeric, 7 positions.

Next PO Date The next date, after accounting for existing backorders, when you expect to receive a purchase order that would be able to fulfill a new order. Datetime format.

Field Description

CWSerenade 5.0


SKU Short The short SKU number from the SKU table. Assigned by the system. Numeric, 7 positions.

Soldout Control Code

The soldout control status associated with the soldout control code, if any, assigned to the item or SKU:1 = sell out immediately2 = include on-order quantity in the soldout calculation 3 = exclude on-order quantity in the soldout calculationNumeric, 1 position.

Field Description

3/24/15 Downloading E-Commerce Static Tables (ESTF) 688

Downloading E-Commerce Static Tables (ESTF)

Purpose: Use the Download E-Commerce Static Tables option to download information that does not change frequently to the web storefront. The information is actually extracted to staging tables on your system; from there, it is available for download to the storefront.

The static information download includes:

• company

• SKU heading descriptions

• countries

• states

• pay types

• special handling format, details and responses

• shipping methods

• SCF/ship via combinations

• e-commerce holiday arrival date

• return reasons

• cancel reasons

• SCF/state combinations

• promotions

• coupon promotions

• coupon restrictions, including coupon and item restriction types)

• coupon requirements, including item, source, and offer requirements

You can download all static information at once, or selected types as needed.

Note:

• The Get Orders from E-Commerce (G35) system control value must be selected in order for you to run the download.

• You can also use the Download B2B E-Commerce Static Tables (BBED) menu option to download additional information required specifically to support B2B offerings on your web storefront.

CWSerenade 5.0


• MICROS recommends that you clear the records from each target table before running the extract to make sure that you capture the most up-to-date information from CWSerenade, as the extract process does not always write updated information in the extract table if there is already an existing record.

In this topic:

• E-Commerce Download Overview

• Process E-Commerce Downloads Screen

• Static Table Download Summary

CWSerenade 5.0


E-Commerce Download Overview

Types of Downloads

To improve response time on the web storefront, you can download key information from CWSerenade so that it is available to internet customers. As a result, only information related specifically to the customer's order, catalog request, or inquiry needs to be communicated interactively between CWSerenade and the web storefront. The information requiring download falls into three main groups:

• Static: information such as company, payment or shipping methods, or states, rarely requiring update. You use the Download E-Commerce Static Tables option, described in this topic.

• B2B static: information such as price tables, source codes, individual positions or departments, and customer user-defined fields; this information supports B2B storefront offerings. You use Download B2B E-Commerce Static Tables (BBED).

• Offer: information related to offers, source codes, and items, requiring update on a periodic or seasonal basis. You use Download B2B E-Commerce Static Tables (BBED).

• Frequent: information, such as item availability levels, that may require update. See the periodic functions described below.

Periodic Functions Related to E-Commerce

The following periodic functions download information as part of the e-commerce interface. You can also use a periodic function as part of the B2B customer extract process. Item availability: ECAVAIL (program name ECR0144). See E-Commerce Item Availability Processing for an overview. Note:

• The system downloads availability information for items only if you have used the Downloading E-Commerce Offer Tables (EOFR) menu option to extract these items to the EC Item table (EXITEM). When you use the Downloading E-Commerce Offer Tables (EOFR) menu option, the system writes a record for all related offers, items, and SKUs in the E-Comm Item Extract table (ECITEX) and the E-Comm SKU Extract table (ECSKEX). Then, when you run the ECAVAIL periodic function, it checks these tables to determine whether to include an item or SKU in the availability download.

• You can also use the item availability messages to pass availability information for a specific item to the web storefront on demand, if your storefront supports it. See E-Commerce Processes.

Gift certificates and coupons: ECGFTC (program name ECR0142). This extracts information on open, unredeemed coupons and gift certificates from the Coupon Redemption table (CSCPNR) to the EC Gift Certificate table (EXGFTC).)

CWSerenade 5.0


Item long SKU style number: ECOMINV (program name ECR0389) and ECOMNEW (program name ECR0390). ECOMINV extracts all items that contain a long SKU style number to the EC SKU Retail Xref table and EComm SKU Extract table. ECOMNEW extracts new items that contain a long SKU style number to the EC SKU Retail Xref table and EComm SKU Extract table.

Item and SKU changes: ECITMCH (program name ECX0178). Extracts item and SKU changes for items and SKUs that have previously been downloaded using the Downloading E-Commerce Offer Tables (EOFR) menu option. This menu option also creates records in the extract trigger tables:

• E-Comm Item Extract (ECITEX): includes information on items in offers that have been selected for download through Downloading E-Commerce Offer Tables (EOFR), and tracks whether the item or its SKUs have been changed

• E-Comm SKU Extract (ECSKEX): includes information on all SKUs of items that are in the E-Comm Item Extract table

Whenever you make certain changes for items and SKUs within these tables, the system flags the related records in the E-Comm Item Extract table by updating the Last change date and Last change time. Then, when you run the ECAVAIL periodic function, the system compares the Last change date and Last change time against the Extract date and Extract time to determine which items and SKUs to include in the download. Items

CWSerenade 5.0


that have been updated since the last extract are included when updating the EC Item and EC SKU tables.

ECITMCH trigger flagged when: Updated E-Commerce Table:

You change one or more of these fields in the Item table:

• Generic e-commerce

• Long SKU class

• LSD Department

• Height

• Length

• Width

• Selling quantity

• Ship weight

• Hazard code

• UOM type (SKU)

• Vendor number

• Item description

• Second language description

• User fields 1-4Note: The system extracts all SKUs of an item to the EC SKU table even if you change information for only the base item.

EC Item (EXITEM)EC SKU (EXSKU) if the item has SKUs

You create or change a record in the Item Ship Via Override table for the item.

EC ItemEC Item Ship Via Override

CWSerenade 5.0


Download Process

For each of the e-commerce-related downloads, the system adjusts the records for null values (a formatting requirement for the web database).

Typically, the services on the web storefront that import information clear the records out of the extract tables.

Deleting information: There is no way to have information that you delete in CWSerenade be automatically deleted on the web storefront as well. You must delete any unneeded information separately in CWSerenade and on the web storefront once it has been downloaded. However, you can remove offers, items, and SKUs from the two e-commerce trigger tables to prevent future updates from being downloaded automatically. See Removing Offers and Items from Download (ERMV) for more information.

Process E-Commerce Downloads Screen

How to display this screen: Enter ESTF in the Fast path field at the top of any menu, or select Download E-Commerce Static Tables from a menu.

Note: All records in each related table for your company will be selected for download, unless noted otherwise in the field descriptions below.

You change one or more of these fields in the SKU table:

• SKU description

• SKU gift certificate

• SEO code

• SET code

• SEW code

• SKU restrict orders

• SKU user fields 1-5Note: The system extracts all SKUs of an item to the EC SKU table even if you change information for only 1 SKU.

EC Item (EXITEM)EC SKU (EXSKU) if the item has SKUs

ECITMCH trigger flagged when: Updated E-Commerce Table:

CWSerenade 5.0


Field Description

Country Select this field to extract information from the Country table to the staging table; otherwise, unselect this field.

State Select this field to extract information from the State table to the staging table; otherwise, unselect this field.

Payment type Select this field to extract credit card payment types (payment category 2), A/R payment types (payment category 3), and coupon/credit payment types (payment category 5) to the EC Payment Type table; otherwise, unselect this field. You can use this information on the web storefront to enable customers to select a valid payment method.If the Download Prepaid Payment Types to E-Commerce (I69) system control value is selected, the system also extracts prepaid payment types (payment category 1 cash/check) to the EC Payment Type table.You can also download open, unredeemed coupons and gift certificates from the Coupon Redemption table to the EC Gift Certificate table when you run the ECGFTC (program name ECR0142) periodic function.

Personalization Select this field to extract custom special handling information to the staging table; otherwise, unselect this field. The information that is downloaded includes special handling formats (both active and inactive), and their related details and valid responses, so that customer can specify special handling options on the web storefront.

SCF/ship via Select this field to extract information from the SCF/Ship Via table to the staging table; otherwise, unselect this field. This information is used to validate that the shipper selected for an order entered on the web storefront is valid for the destination address.SCF/ship via combinations for express-bill ship vias are not included in the download.Only SCF/ship via combinations for valid e-commerce ship vias will be included in the download. A ship via is a valid e-commerce shipper only if the Download to E-Commerce field at the Create Ship Via (1 of 2) screen (WVIA) or the Change Ship Via (1 of 2) screen is set to selected.

CWSerenade 5.0


Shipping method Select this field to extract information from the Ship Via table to the staging table; otherwise, unselect this field. You can use this list of shippers to enable customers to select a shipment method at the web storefront.Express-bill ship vias (the Billing code field is set to Express Bill) are excluded from the download.To exclude certain ship vias from the download, you can unselect the Download to E-Commerce field at the Create Ship Via (1 of 2) screen (WVIA) or the Change Ship Via (1 of 2) screen is set to selected.

Holiday dates Select this field to extract information from the E-Commerce Holiday table to the staging table; otherwise, unselect this field. You can use these dates to enable customers to specify when to ship orders that they enter on the web storefront.

Return reasons Select this field to extract information from the Return Reason table to the staging table; otherwise, unselect this field. This information is used if you enable customers to create return authorizations at the web storefront.

Cancel reasons Select this field to extract information from the Cancel Reason table to the staging table; otherwise, unselect this field. This information is used if you enable customers to cancel orders at the web storefront.Note: Only cancel reason codes whose Reduce demand fields are unselected are selected for download.

SCF/State Select this field to extract information from the SCF table and SCF Extended table to the staging table; otherwise, unselect this field. This information is used to validate that the state selected for a customer’s address entered on the web storefront is valid for the destination address.

Promotions Select this field to extract information from the Promotions table to the staging table; otherwise, unselect this field. This information is available to validate a promotion code entered on the web storefront, typically if entry of a promotion code is required based on the Allow Manual Entry of Promotion Code (I63) system control value. If the system control value is unselected, the system applies eligible promotions automatically to the order.

Field Description

CWSerenade 5.0


Instructions:

1. Unselect any field not required for download.2. Select OK. The system submits the job ECOMM_LOAD, which downloads the

selected information to the extract tables. See Static Table Download Summary for a detailed list of download information.

Coupon promotions

Select this field to extract information from the Coupon Promotion table to the staging table; otherwise, unselect this field. This information is available to validate each coupon promotion that you use to offer percentage or dollar discounts to customers on the web storefront.

Coupon restrictions: coupon

Select this field to extract information from the Coupon Restrictions table to the staging table; otherwise, unselect this field. This information is available to prevent customers on the web storefront from using two coupons whose use on the same order is restricted.

Coupon restrictions: item

Select this field to extract information from the Coupon Item Restriction table to the staging table; otherwise, unselect this field. This information is available to prevent customers on the web storefront from applying a percentage coupon discounts against restricted items.

Coupon requirements: item

Select this field to extract information from the Coupon Item table to the staging table; otherwise, unselect this field. This information is available to validate that customers on the web storefront include any required item(s) on an order when they use coupons with an item requirement.

Coupon requirements: source

Select this field to extract information from the Coupon Source Requirement table to the staging table; otherwise, unselect this field. This information is available to validate that customers on the web storefront are using the correct source code on an order when they use coupons with a source requirement.

Coupon requirements: offer

Select this field to extract information from the Coupon Offer Requirement table to the staging table; otherwise, unselect this field. This information is available to validate that customers on the web storefront are using the correct offer on an order when they use coupons with an offer requirement.

Field Description

CWSerenade 5.0


Static Table Download Summary

Purpose: This table provides a summary of the tables and fields included in the static table download, and how they map to the e-commerce staging tables.

CWSerenade Table

Select at Process E-Commerce Download Screen

Staging Table Additional Information

Company (MSCOMP)

Any selection EC Company (EXCOMP)

Also triggers download of split SKU information from the System Control table as follows:Split SKU Element Column Headings (A52, A53, A54)SKU Element Description 1, 2, and 3 (G37, G38, G39)

Country (MSCNTY)

Country EC Country (EXCNTY)

State (MSSTAT)

State EC State (EXSTAT)

Pay Type (OEPAYT)

Payment type EC Pay Type (EXPAYT)

The system only includes pay types defined as payment category 2 (credit card), 3 (A/R), and 5 (coupon/credit) for download. If the Download Prepaid Payment Types to E-Commerce (I69) system control value is selected, the system also includes prepaid pay types defined as payment category 1 (cash/check) for download.

Promotions (OEPROM)

Promotions EC Promotions Extract (ECPROX)

Typically used only if the Promotion Code Entry Required for Discount (I63) system control value is selected.

Special Format (MSSHFD)

Personalization

EC Personalization (EXPERS)

Both active and inactive formats are selected for download.

CWSerenade 5.0


Special Format Details (MSSFDT)

Personalization

EC Personalization Details (EXPRSD)

Special Format Responses (MSSFVR)

Personalization

EC Personalization Values (EXPRSV)

SCF Ship Via (SCFVIA)

SCF/Ship Via EC SCF/Ship Via (EXSCFS)

Ship Via (MSSHPV)

Shipping method

EC Shipping Method (EXSHIP)

E-Comm Holiday Arrival Date (ECHOLI)

Holiday dates EC Holiday Arrival Date (EXHOLI)

Return Reason (OERTRS)

Return reasons

EC Return Reason (EXRTRS)

Cancel Reason (CSCANR)

Cancel reasons

EC Cancel Reason (EXCNRS)

SCF (MSSCF), SCF Extended (MSSCFE)

SCF/State EC SCF State (EXSCST)

Coupon Promotions (OECPCP)

Coupon Promotions

EC Coupon Promotions (EXCPCP)

Coupon Restrictions (OECPCR)

Coupon Restrictions: Coupon

EC Coupon Restrictions (EXCPCR)

CWSerenade Table



CWSerenade 5.0


Coupon Item Restrictions (OECPIR)

Coupon Restrictions: Item

EC Coupon Item Restrictions (EXCPIR)

Coupon Item (OECPIT)

Coupon Requirements: Item

EC Coupon Item (EXCPIT)

Coupon Source Code Requirement (OECPSR)

Coupon Requirements: Source

EC Coupon Source Requirement (EXCPSR)

Coupon Offer Requirement (OECPOR)

Coupon Requirements: Offer

EC Coupon Offer Requirement (EXCPOR)

CWSerenade Table



3/24/15 Downloading E-Commerce Offer Tables (EOFR) 700

Downloading E-Commerce Offer Tables (EOFR)

Purpose: Use the Download E-Commerce Offer Tables menu option to select offer, source, and item-related information for download to the web storefront. Typically, this type of information changes periodically.

You can download all three types of information at once, or selected types as needed.

Note: This menu option adds new information to the staging tables if the tables have not been cleared since the last download; it does not update records once they are extracted to the staging tables. However, once the records are downloaded to the web storefront and cleared from the staging tables, changes to existing records are eligible to be extracted to the staging tables and passed to the storefront.

Additional downloads: Other downloads available for the e-commerce interface are:

• static tables

• item availability, gift certificates, and item changes

• B2B-related information, including selected source codes, price tables, and customer and individual information

Removing items and offers: Use the Removing Offers and Items from Download (ERMV) menu option to specify offers, items, or SKUs that are no longer active on the web storefront, so that you do not continue sending periodic updates.

All SKUs included? SKU-level information is included in the extract only if there is a SKU Offer and SKU Price record. For example, you can use the Create Item/SKU Offers (MISO) menu option to create SKU Offers and SKU Prices for an item when you add it to a new offer. SKU-level offer and price information is included in the extract if you select the All SKU offers option when generating the extract; otherwise, SKU Offers are included only when they differ from the item-level information, such as a special handling or price that differs from the Item Offer or Item Price setting.

Future prices? The Future prices field on the Process E-Commerce Downloads screen controls whether to download the most current prices whose Effective dates are not in the future, or the latest prices whose Effective dates are later than the current date. If you would like to download both current and future prices, you can run the download job twice, resetting this field as needed.

Example: AB100 BLUE LRGE has the following prices set up for the selected offer(s):

Date Quantity Price

CWSerenade 5.0


1/1 1 10.00

1/1 5 9.00

1/10 1 10.50

2/1 1 8.50

2/1 5 7.50

3/1 1 7.00

3/1 5 6.99

1. The current date is 1/15. If you run the extract job with the Future prices field unselected, the job selects the following prices:

1/1 5 9.00 (most recent price for this quantity not greater than current date)

1/10 1 10.50 (most recent price for this quantity not greater than the current date)

2. The current date is 1/15. If you run the extract job with the Future prices field selected, the job selects the following prices:

3/1 1 7.00 (latest future price for this quantity)

3/1 5 6.99 (latest future price for this quantity)

Note: • Item or SKU prices are included in the following extract tables (see Offer-Related Table Extract Summary for more information):

• EC Item Breakpoint (EXIPRC): includes single-unit and multi-unit prices at the item level

• EC Offer Item Link (EXIOFL): includes single-unit prices at the item level

• EC Offer SKU Link (EXSOFL): includes single-unit prices at the SKU level

• EC SKU Breakpoint (EXSPRC): includes single-unit and multi-unit prices at the SKU level

• If you run the extract job with the Future prices field selected, but there is no future price for the item or SKU, the job extracts the most recent price instead. • If you run the extract job with the Future prices field unselected, but there is no current price for an item or SKU and just a future price, the extract omits the item or SKU prices from the extract, with the exception of the EC Offer Item Link table; this table includes a record for the item with a price of 0.

CWSerenade 5.0


Note: MICROS recommends that you clear the records from each target table before running the extract to make sure that you capture the most up-to-date information from CWSerenade, as the extract process does not always write updated information in the extract table if there is already an existing record.


• Downloading E-Commerce Static Tables (ESTF) for an overview of the download process related to the e-commerce interface, including the additional downloads

• the CWSerenade E-Commerce Integration Manual for information on the storefront database schema

In this topic:

• Process E-Commerce Downloads Screen

• Offer-Related Table Extract Summary

Process E-Commerce Downloads Screen

How to display this screen: Enter EOFR in the Fast path field at the top of any menu, or select Download E-Commerce Offer Tables from a menu.

Note: All records in each related table for your company will be selected for download, unless noted otherwise in the field descriptions.

Field Description

Offers Indicates whether to extract the selected offer information to the EC Offer table, and from there to the web storefront. Only the offer(s) you enter at this screen will be extracted.Valid values are:Selected (default) = download the selected offer(s)Unselected = do not extract the offer(s)

Sources Indicates whether to extract source codes associated with the selected offer to the EC Source table, and from there to the web storefront. Only source codes associated with the offer you enter at the From offer field will be extracted.Valid values are:Selected (default) = extract source codes associated with the selected offerUnselected = do not extract source codesNote: You can also use the Download B2B E-Commerce Static Tables (BBED) menu option to extract source code information to another staging table.

CWSerenade 5.0


All items Indicates whether to extract all items, SKUs, and all other related e-commerce staging tables, and from there to the web storefront. All items related to the offer(s) you enter at this screen will be extracted.Valid values are:Selected (default) = extract item-related information for all items associated with the selected offer(s)Unselected = do not extract item-related information for all itemsSelect either this field or the New items field, but not both. If you select both fields, the following message displays: Either All Items or New Items can be processed but not both.

New items Indicates whether to extract only new items, SKUs, and other related information to the e-commerce staging tables for subsequent download to the web storefront. Only items related to the offer(s) you enter at this screen and which have not previously been extracted will be selected.Valid values are:Selected = extract item-related information for only new items associated with the selected offer(s) (items which have not been previously extracted)Unselected (default) = do restrict extract of item-related information to only new itemsSelect either this field or the All items field, but not both. If you select both fields, the following message displays: Either All Items or New Items can be processed but not both.

Future prices Indicates whether to extract the latest future price for an item or SKU in the selected offer(s), or the most current price that is not in the future. Valid values are:Selected = extract the latest future prices for items and SKUs in the selected offer(s). Future prices are those whose Effective dates are later than the current date. If there are no future prices for an item or SKU, the job extracts the latest current price (the most current price whose Effective date is not in the future).Unselected (default) = extract the most current price for items and SKUs in the selected offer(s), as long as the prices’ Effective dates are not later than the current date. If there are no prices for an item or SKU except for future prices, the job does not include the item or SKU in the extract.See above under Downloading E-Commerce Offer Tables (EOFR) for a discussion and examples.

Field Description

CWSerenade 5.0


Instructions:

All SKU offers Indicates whether to include all SKU Offers and SKU Prices, regardless of whether they are different from the Item offer and Item Price. Valid values are:Selected = extract all existing SKU Offer and SKU Price information, even if it is identical to the corresponding Item Offer and Item Price information.Unselected (default) = extract SKU Offer and SKU Price information only if it differs from the Item Offer and Item Price information:• The EC SKU Breakpoint table (EXSPRC) is updated with the SKU Price information only if the SKU Price differs from the Item Price.Note: The SKU Price is included only if the regular price differs from the Item Price. If the Associate price alone differs, then the SKU Price record is not selected for extract. • The EC Offer SKU Link table (EXSOFL) is updated with the SKU Offer information only if the special handling or gift wrap information for the SKU Offer is different from the Item Offer.

Offer Enter one or more offers to download to the web storefront. As you enter each offer, its description, start date, and end date are displayed below. You must specify at least one offer.Only the offer(s) you enter and tables associated with the selected offer(s) will be included in the extract.Offer codes are defined in and validated against the Offer table. Alphanumeric, 3 positions; required.

Description The description of an offer you have specified for download to the web storefront. Alphanumeric, 30 positions; display-only.

Start date The first date when the selected offer is effective for processing orders. From the Offer date range specified for the offer.Numeric, 6 positions (MM/DD/YY format); display-only.

End date The last date when the selected offer is effective for processing orders. From the Offer date range specified for the offer.Numeric, 6 positions (MM/DD/YY format); display-only.

1. Optionally reset any of the fields to exclude related information from selection.

Note: Select either the All items field or the New items field. You cannot select both fields.

Field Description

CWSerenade 5.0


Also, the system submits the job ECOMM_OFR, which extracts the selected information to the related e-commerce staging tables. See Offer-Related Table Extract Summary for a listing of the information included in the extract.

2. Use the Offer field to specify at least one offer to include in the extract. The system validates each entry, and displays the offer’s description and effective dates below after each.

3. Select OK. The system validates your entries and highlights any fields you need to correct. Correct any fields and select OK again.

4. Select Submit to submit the extract. The system displays the following message: E-Commerce download submitted to batch.

CWSerenade 5.0


Offer-Related Table Extract Summary

Purpose: This table provides a summary of the tables and fields included in the offer table extract, and how they map to the e-commerce staging tables.

Selection for download: All item-related information (such as hazard codes and e-commerce categories) are selected for download only if they are assigned to items that are selected for download.

CWSerenade Table

Staging Table

Fields Additional Information

If you select the Offer field at the Process E-Commerce Downloads screen:

Offer (MSOFFR)

EC Offer (EXOFFR)

Company codeOffer codeDescriptionStart dateEnd date

Only the offer(s) you indicate at the screen is/are selected.

If you select the Sources field at the Process E-Commerce Downloads screen:

Source (MSSRC)

EC Source (EXSRCE)

Company codeSource codeSource code descriptionDiscount percentageOffer

If you select the Items or New Items field at the Process E-Commerce Downloads screen:

E-Commerce Category (IXECAT)

EC Category (EXECAT)

Company codeE-Commerce category codeDescription

Item E-Commerce Category (ECICAT)

EC Item Category (EXITCT)

Company codeItem codeE-Commerce category code

CWSerenade 5.0


Long SKU Class (INLSKC) OR Retail Class (INRTCP)

EC Class (EXCLAS)

Company codeLong SKU department codeLong SKU class codeLong SKU class description

A long SKU class is selected for download only if it is assigned to an item selected for download, and the item is also assigned a long SKU department. The same long SKU class can be downloaded multiple times, if it is paired with different long SKU departments.Note: If you select the Use Retail Integration (H26) system control value, the interface uses the Retail Class table to populate the EC Class table.

Item Coordinate (INITCO)

EC Cross-Sell (EXCSEL)

Company codeItem codeCross-sell item codeCross-sell descriptionCoordinate sequenceCoordinate type

An item coordinate is selected for download only if the primary item (Note: not necessarily the coordinate item) is selected for download. Also, only the first 50 positions of the item coordinate description (a 70-position field) is included in the Cross-sell description.

Long SKU Department (INLSKD)

EC Department (EXDEPT)

Company codeLong SKU department codeLong SKU department description

Shipper/Item (OESHIM)

EC Extra Shipping (EXSCIT)

Company codeShip via codeItem codeExtra shipping charge

Hazard (INHZRD)

EC Hazard (EXHAZA)

Company codeHazard codeHazard description

CWSerenade Table

Staging Table


CWSerenade 5.0


Item (INITEM) EC Item (EXITEM)

Company codeItem codeItem descriptionHeightLengthWidthSelling quantityShipping weightUnit of measure codeVendor numberSecond language descriptionSKU? (0=N, 1=Y)Active on web? (0=N, 1=Y)Long SKU departmentLong SKU classLong SKU categoryHazard codeUser fields 1 through 4Status

Each non-SKU’d item associated with a selected offer(s) (that is, there is an item/offer assignment) is selected for download. SKU’d items are also included in the selection if they have item/offer assignments. Note: The Active on web? flag is not currently used.

Item Offer (INIOFR)

EC Item (EXITEM)

Allow gift wrap? (0=N, 1=Y)

Item Information (INIINF)

EC Item (EXITEM)

E-commerce item information (RP template) = ECI description long

.

SKU (INSKU) EC Item (EXITEM)

List price The Original price in the EC Item table is from the highest List price for all SKUs.

Item Price (INIPRC)

EC Item Breakpoint (EXIPRC)

Company codeOffer codeItem codeBreakpoint quantityPrice

• You set up a price breakpoint for a quantity of 1 when you create an item/offer assignment and specify a price. You can also specify additional price breakpoints for larger quantities. The extract includes the latest current or future price (based on the Future prices field), for each item-level quantity breakpoint.

CWSerenade Table

Staging Table


CWSerenade 5.0


E-Comm Item Image (ECIIMG) or E-Commerce Image Path (ECIMGP)

EC Item Image (EXIMAG)

Company codeItem codeThumbnail image pathRegular-size image pathLarge image path

If you specify item image paths and filenames at the item level, this information is selected for the download; otherwise, the system builds the item image path and filename using the defaults set up in E-Commerce Job Control.See Working with E-Commerce Job Control (EJCT) for information on setting up defaults.

Item Offer (INIOFR)

EC Offer Item Link (EXIOFL)

Company codeOffer codeItem codePrice (single unit)Special handling priceItem aliasGift wrap priceCustom special handling format code

• The extract includes the latest current or future price (based on the Future prices field), for each single-unit item-level price.

SKU Offer (INSKOF)

EC Offer SKU Link (EXSOFL)

Company codeOffer codeItem codeShort SKU Price (single-unit)Special handling priceGift wrap priceCustom special handling format code

Note: A SKU/offer is selected for download only if the special handling or gift wrap information differs from the item/offer, or if you select the All SKU offers option when generating the extract. The extract includes the latest current or future price (based on the Future prices field), for each single-unit SKU-level price.

CWSerenade Table

Staging Table


CWSerenade 5.0


SKU (INSKU) EC SKU (EXSKU)

Company codeItem codeShort SKU (assigned by the system at SKU creation)SKU codeSKU descriptionSKU element 1 through 3SKU element 1 through 3 descriptionGift certificate? (0=N, 1=Y)Restrict orders? (0=N, 1=Y)User fields 1 through 5Soldout control codeStatusUPC codes (first two)

A SKU is selected for download only if it has a SKU/offer selected for download (because it differs from the item/offer, as described above). Non-SKU’d items are also selected for download in this table.Note: The Short SKU is stored in the SKU table and is a 7-position number used to identify SKUs and items. You can view the short SKU on display screens in Work with Items (MITM) and Inventory Inquiry (DINI).

SKU Price (INSPRC)

EC SKU Breakpoint (EXSPRC)

Company codeOffer codeItem codeShort SKU (assigned by the system at SKU creation)Breakpoint quantityPrice

• A SKU price is selected for download only if the SKU-level offer price differs from the Item Offer price, or if you select the All SKU offers option when generating the extract). The extract includes the latest current or future price (based on the Future prices field), for each SKU-level quantity breakpoint.

E-Comm Up/Cross-Sell (ECSELL)

EC Up-Sell (EXUSEL)

Company codeItem codeUpsell item codeUpsell description

Only records with a type of U (upsell) are currently created in the E-Comm Up/Cross-Sell table and selected for download.

Keyword (INKWDP)

EC Keyword (EXKEYW)

Company codeItem codeKeyword

Page Letter Alias (INPLAL)

EC Alias Item (EXITMA)

Company codeItem codeOfferAlias item

CWSerenade includes all item aliases for an item for the offer selected in the e-commerce download.

CWSerenade Table

Staging Table


CWSerenade 5.0


Item Ship Via Override (INISVO)

EC Item Ship Via Override (EXISVO)

Company codeItem numberShipping code

CWSerenade only populates this table if records exist in the Item Ship Via Override table for an item.

CWSerenade Table

Staging Table


3/24/15 Removing Offers and Items from Download (ERMV) 712

Removing Offers and Items from Download (ERMV)

Purpose: Use this menu option to discontinue generating periodic updates to the web storefront for selected items, SKUs, or offers.

E-commerce extract tables: When you run periodic updates to the web storefront about items and their availability, the system checks two extract tables to determine whether this is an item/SKU and offer featured on the web storefront. The extract tables are:

• E-Comm Item Extract (ECITEX): includes information on items in offers that have been selected for download through Downloading E-Commerce Offer Tables (EOFR), and tracks whether the item or its SKUs have been changed

• E-Comm SKU Extract (ECSKEX): includes information on all SKUs of items that are in the E-Comm Item Extract table

If the system finds a record in either of these tables, this indicates that you sell the item/SKU on your web storefront, so the e-commerce-related periodic functions should include them when extracting updates.

The periodic functions that use the extract tables are the item availability function (ECAVAI, or program ECR0144) and the item change function (ECITMCH, or program name (ECX0178). These periodic functions are described under Periodic Functions Related to E-Commerce.

Remove Offers and Items from Download Screen

Use this screen to indicate the offer, item, or item/SKU to remove from the e-commerce extract tables in order to prevent related information from being included in future updates.

How to display this screen: Select Remove Offers and Items from Download from a menu, or enter (ERMV) in the Fast path field at the top of any menu.

CWSerenade 5.0


Completing this screen:

• Enter the Offer to remove from the extract tables in order to discontinue sending updates; or,

Field Description

Offer The offer to remove from the extract tables in order to discontinue sending updates to the web storefront. Your entry is validated against the Offer table.Updates: The submitted job removes each entry for this offer from the E-Comm Item Extract table (ECITEX). If there are no additional entries in the E-Comm Item Extract table for other offers, and if this is a SKU’d item, the submitted job also removes each SKU from the E-Comm SKU Extract table (ECSKEX). See the examples below for more information.Note: You cannot enter both offer and item information.Alphanumeric, 3 positions; optional.

Item The item to remove from the extract tables in order to discontinue sending updates to the web storefront. Your entry is validated against the Item table. You can specify to remove all SKUs for an item by completing this field and leaving the SKU field blank, or you can identify a specific SKU to remove. Updates: The submitted job removes each entry for this item from the E-Comm Item Extract table (ECITEX). If you also enter a SKU for this item, then the submitted job removes just this SKU from the E-Comm SKU Extract table (ECSKEX); otherwise, if the SKU field is blank, the submitted job removes all SKUs for the item from the E-Comm SKU Extract table.Note: You cannot enter both offer and item information.Alphanumeric, 12 positions; optional.

SKU The particular SKU to remove from the extract tables in order to discontinue sending updates to the web storefront. Your entry is validated against the SKU table. You can enter the Item and leave this field blank in order to remove all SKUs.Updates: The submitted job removes the SKU from the E-Comm SKU Extract table (ECSKEX). If there are no additional SKUs for the item left in this table, the submitted job also removes each entry for the item from the E-Comm Item Extract table (ECITEX). Alphanumeric, three 4-position fields; optional.

CWSerenade 5.0


• Enter the Item to remove from the extract tables in order to discontinue sending updates. Optionally, you can also specify a SKU if you enter an Item to delete just a particular SKU.

• Click OK. The system display the Confirm Delete window.

If you click OK at this window, the system submits the ECOM_RMV job. This job deletes the specified records from the E-Comm Item Extract table (ECITEX) and the E-Comm SKU Extract table (ECSKEX).

Examples:

Scenario Result

Specify an offer to delete. A SKU’d item is assigned to this offer and no other offers in the E-Comm Item Extract table.Example: Offer S05 is no longer effective, so you no longer want to send updates on item/SKUs for that offer.

E-Comm Item Extract table update: Removes Item/Offer record E-Comm SKU Extract table update: Removes all SKUs Resulting periodic updates:ECITMCH: No update for the item/SKUECAVAIL: No update for the item/SKU

Specify an offer to delete. A SKU’d item is assigned to this offer and another offer in the E-Comm Item Extract table.Example: Offer S05 is no longer effective, but you are continuing to sell some of the same items, including AB1234 in offer F05.

E-Comm Item Extract table update: Removes Item/Offer record for S05, but leaves Item/Offer record for F05E-Comm SKU Extract table update: No changes to SKUs for AB1234.Resulting periodic updates:ECITMCH: If change to item or SKU, updates EC Item table (EXITEM) with item and EC SKU table (EXSKU) with all SKUsECAVAIL: Updates EC Item Availability (EXAVAI) with all SKUs

Specify the base item of a SKU’d item to delete. The SKU’d item is assigned to two offers in the E-Comm Item Extract table.Example: You are no longer selling item CD2345 this year in any offer.

E-Comm Item Extract table update: Removes all records for CD2345E-Comm SKU Extract table update: Removes all SKUsResulting periodic updates:ECITMCH: No update for the item/SKUECAVAIL: No update for the item/SKU

CWSerenade 5.0


Specify a single SKU to delete. There are additional SKUs remaining in this offer in the E-Comm Item Extract table.Example: You are no longer selling item DE4567 in orange, although other colors are still available for sale in the same offer.

E-Comm Item Extract table update: No changeE-Comm SKU Extract table update: Deletes this particular SKUResulting periodic updates:ECITMCH: If change to item or SKU, updates EC Item table (EXITEM) with item and EC SKU table (EXSKU) with all SKUs (including deleted SKU)ECAVAIL: Updates EC Item Availability (EXAVAI) with all SKUs (including deleted SKU)

Specify a single SKU to delete. Although this is the only SKU for the item assigned to a particular offer, other SKUs for the same item are assigned to a different offer in the E-Comm Item Extract table.Example: Item EF4567 in green is no longer available in your clearance offer, but other colors of the item are still available in your regular offer.

E-Comm Item Extract table update: No change (Item/SKU offer remains)E-Comm SKU Extract table update: Deletes SKUResulting periodic updates: ECITMCH: If change to item or SKU, updates EC Item table (EXITEM) with item, but does not include deleted SKU when updating the EC SKU table (EXSKU)ECAVAIL updates: Does not include deleted SKU when updating EC Item Availability table (EXAVAI)

Specify a single SKU to delete. This is the last remaining SKU for an item in the E-Comm Item Extract table.Example: You included item FG5678 in purple in your clearance offer, but this item is no longer available in any color in any remaining offers.

E-Comm Item Extract table update: Deletes the Item/Offer recordE-Comm SKU Extract table update: Deletes the SKUResulting periodic updates: ECITMCH: No update for this item or SKU in EC Item table (EXITEM) or EC SKU table (EXSKU)ECAVAIL: No update for the SKU in EC Item Availability table (EXAVAI)

Scenario Result

3/24/15 Sending Internet Order Ship Confirmation (ESCF) 716

Sending Internet Order Ship Confirmation (ESCF)

Purpose: Use the Send Internet Order Ship Confirmation menu option to generate email notifications or the Outbound EMail XML Message (CWEmailOut) to customers when an order shipment or return takes place. The confirmation is sent to the order-level email address on the order.

Confirmations for all orders? See Shipment and Return Confirmation Emails for a discussion of which orders are eligible to generate these email confirmations based on the settings in your company and the customer’s email information.

Generate shipment confirmation during billing? If the Send Shipment Confirmation from Billing (L98) system control value is selected, the system generates shipment and return confirmations during billing. You can still use this menu option to generate an additional shipment or return confirmation. See this system control value for more information.

Periodic function: You can also use the periodic function ECSHCNF (program name = ECR0154) to generate shipment and return confirmation emails or messages. See Additional E-Commerce Setup.

For sample emails and more information: See Shipment Confirmation Email Sample and Contents and Return Confirmation Email Sample and Contents.

Interrupting or completing email generation: If you generate emails for a single day, the system keeps track of the last email generated so that you do not send the same email more than once; however, this option is not supported if you consolidate invoices. See Stopping and Restarting Shipment and Return Confirmation Emails for more information.

Save in email repository? The Write Outbound Email to Email Repository (H99) system control value controls whether the email notification or the Outbound EMail XML Message (CWEmailOut) is stored in correspondence history. See this system control value for more information on identifying and reviewing outbound emails for a customer.

Order history message: When a shipment or return confirmation email or Outbound EMail XML Message (CWEmailOut) is sent, CWSerenade creates an order history message such as Retrn Conf to [email protected]. You can review order history messages at the Display Order History screen in order inquiry.

No emails generated? If the Shipment Confirmation Program (G51) system control value is blank, or if you are generating an actual email (rather than the Outbound EMail XML Message (CWEmailOut)) and the system control value is not set to ShpConf, no shipment confirmation emails are generated. Similarly, if the Return Confirmation E-Mail Program (H53) system control value is blank, or if you are generating an actual email

CWSerenade 5.0


(rather than the Outbound EMail XML Message (CWEmailOut) and the system control value is not set to RetConf, no return confirmation emails are generated.

Send Internet Shipment Confirmations Screen

How to display this screen: Enter ESCF in the Fast path field at the top of any menu, or select Send Internet Order Ship Confirmation from a menu.

Instructions: To generate shipment confirmation emails and return confirmation emails or the Outbound EMail XML Message (CWEmailOut), override the From and To dates if necessary. Select Accept to generate the confirmation emails for the selected date(s).

Stopping and Restarting Shipment and Return Confirmation Emails

Overview: When you generate shipment and return confirmation emails through the Send Internet Shipment Confirmations Screen or through the ECSHCNF periodic function, the system can keep track of the last email generated based on invoice number, enabling you to:

• generate confirmation emails throughout the day for new shipments

• continue email generation if you need to interrupt the process for any reason

Supported when? Stopping and restarting shipment and return confirmations is supported only if:

• the Consolidated Invoice (B49) system control value is not selected

Field Description

From... The first shipment date to include when generating shipment confirmations. All eligible orders with shipments on or after this date, and not later than the To date, are included for shipment confirmation. The current date defaults.Numeric, 6 positions (MM/DD/YY format); required.

To... The last shipment date to include when generating shipment confirmations. All eligible orders with shipments on or before this date, and not before the From date, are included for shipment confirmation. The current date defaults.Numeric, 6 positions (MM/DD/YY format); required.

CWSerenade 5.0


• you do not enter a range of dates at the Send Internet Shipment Confirmations Screen. To be able to restart generation where you left off, you must make sure that the To...and From...dates are the same.

Otherwise, you do not have the option to restart the email generation process without generating duplicate emails.

How to stop email generation: To interrupt the generation of shipment and return confirmation emails, use the Purge Active Procedures Across Users option (MACX) option to delete the active procedure with a Type of SC and a Program of ECR0154. After you delete the active procedure, the generation process might generate approximately 25 more confirmations before it stops.

Restarting email generation: To restart email generation where it left off for the date, simply run the periodic function or use the Send Internet Shipment Confirmations Screen to generate confirmations for the same date. Using the periodic function generates email confirmations for the current date, while the Send Internet Shipment Confirmations Screen enables you to specify a single date for email generation.

How does the system keep track? When you generate shipment and return email confirmations, the system writes a record in the Report Generic table noting the date and the last invoice number with a confirmation email generated. If you generate email confirmations again for that same date, the process starts with the next invoice number. Similar to the Active Procedure record, the Report Generic record has a Report type of SC. If for any reason you ever need to regenerate a group of confirmation emails again, you can use SQL to reset the last invoice number in that table before you restart the email generation process.

3/24/15 719

E-Commerce TablesPurpose: You extract data from regular CWSerenade tables into the tables listed below, which are available for subsequent transmission to your web storefront database.

In this topic:

• E-Commerce Static Tables on page 720

• E-Commerce Offer Tables on page 724

• E-Commerce B2B Static Tables on page 731

• Additional Downloads on page 734

CWSerenade 5.0 E-Commerce Tables

3/24/15 720

E-Commerce Static Tables

Purpose: The Download E-Commerce Static Files menu option (ESTF) extracts data to the following tables.

Company

Table: EC Company (EXCOMP)

Contents:

• Company code

• CMP description

• SKU label 1

• SKU label desc 1

• SKU label 2


• SKU label 3


Country

Table: EC Country (EXCNTY)

Contents:

• RPR country

• Required state

• CNT description

StateTable: EC State (EXSTAT)

Contents:

• RPR country

• State code

• STE description


3/24/15 721

Payment typeTable: EC Payment Type (EXPAYT)

Contents:

• Company code

• Pay type

• PAY description

• PAY category

• PAY modulus check

• PAY limit for checks

• Valid leading digits

• Valid length

PersonalizationTable: EC Personalization (EXPERS)

Contents:

• Company code

• SHF code

Personalization detailTable: EC Personalization Dtl (EXPRSD)

Contents:

• Company code

• SHF code

• Pers sequence

• SFD prompt text

• Max character

• Required?

• Allow detail value?

Personalization valuesTable: EC Personalization Values (EXPRSV)


3/24/15 722

Contents:

• Company code

• SHF code

• Pers sequence

• Value ID

• Valid value

SCF/Ship viaTable: EC SCF/Ship Via (EXSCFS)

Contents:

• Company code

• Shipping code

• SCF

Shipping methodTable: EC Shipping Method (EXSHIP)

Contents:

• Company code

• Shipping code

• VIA shipper name

• Add’l charges

• Ship to PO

Holiday arrival dateTable: EC Holiday Arrival Date (EXHOLI)

Contents:

• Company code

• Holiday code

• Holiday date

• Holiday description


3/24/15 723

Return reasonTable: EC Return Reason (EXRTRS)

Contents:

• Company code

• Return reason

• Rtn reas description

Cancel reasonTable: EC Cancel Reason (EXCNRS)

Contents:

• Company code

• Cancel reason

• Cancel reason desc

SCF stateTable: EC SCF State (EXSCST)

Contents:

• Company code

• RPR country

• SCF

• State code


3/24/15 724

E-Commerce Offer Tables

The Download E-Commerce Offer Files menu option (EOFR) extracts data to the following tables.

OfferTable: EC Offer (EXOFFR)

Contents:

• Company code

• Offer

• OFR description

• Start date

• Stop date

SourceTable: EC Source (EXSRCE)

Contents:

• Company code

• Source code

• Src description

• Disc %

• Offer

Category:Table: EC Category (EXECAT)

Contents:

• Company code

• Category

• Category description

Item categoryTable: EC Item Category (EXITCT)


3/24/15 725

Contents:

• Company code

• Item number

• Category

Class

Table: EC Class (EXCLAS)

Contents:

• Company code

• Department

• Class

• Class description

Cross-Sell

Table: EC Cross-Sell (EXCSEL)

Contents:

• Company code

• Item number

• Cross sell item

• Cross-Sell Desc

• Coordinate sequence

• Coordinate type

Department

Table: EC Department (EXDEPT)

Contents:

• Company code

• Department

• Dept description


3/24/15 726

Extra shippingTable: EC Extra Shipping (EXSCIT)

Contents:

• Company code

• Shipping code

• Item number

• Extra shipping

HazardTable: EC Hazard (EXHAZA)

Contents:

• Company code

• Hazard code

• Hazard description

ItemTable: EC Item (EXITEM)

Contents:

• Company code

• Item number

• Desc short

• Height

• Length

• Width

• Selling qty

• Ship weight

• Unit of measure

• Vendor number

• Desc second language

• Allow SKU?


3/24/15 727

• Desc long

• Allow gift wrap

• Active on web

• Department

• Class

• Category

• Hazard code

• Original price

• User field 1

• User field 2

• User field 3

• User field 4

• Item status

Item break pointTable: EC Item Breakpoint (EXIPRC)

Contents:

• Company code

• Offer

• Item number

• Breakpoint qty

• Price

Item imageTable: EC Item Image (EXIMAG)

Contents:

• Company code

• Item number

• Thumbfile picture

• Regular picture


3/24/15 728

• Large picture

Offer item linkTable: EC Offer Item Link (EXIOFL)

Contents:

• Company code

• Offer

• Item number

• Base price

• Personalize cost

• Item alias

• Gift wrap cost

• SHF code

Offer SKU linkTable: EC Offer SKU Link (EXSOFL)

Contents:

• Company code

• Offer

• Item number

• Short SKU

• SKU price

• Personalize cost

• Gift wrap cost

• SHF code

SKUTable: EC SKU (EXSKU)

Contents:

• Company code

• Item number


3/24/15 729

• Short SKU

• SKU code

• SKU description

• SKU element 1

• SKU element 1 desc

• SKU element 2


• SKU element 3


• Gift cert?

• Restrict orders?

• Retail reference

• SKU status

• Sold out

• User field 1

• User field 2

• User field 3

• User field 4

• User field 5

• UPC code 1

• UPC code 2

SKU break pointTable: EC SKU Breakpoint (EXSPRC)

Contents:

• Company code

• Offer

• Item number

• Short SKU

• SKU breakpoint qty


3/24/15 730

• SKU price

UpsellTable: EC Up-Sell (EXUSEL)

Contents:

• Company code

• Item number

• Upsell item ECI item numb

• Up-sell desc

Keyword: Table: EC Keyword (EXKEYW)

Contents:

• Company code

• Item number

• Keyword

Alias itemTable: EC Alias Item (EXITMA)

Contents:

• Company code

• Item number

• Offer

• Alias item

Item ship via override

Table: EC Item Ship Via Override (EXISVO)

Contents:

• Company code

• Item number

• Shipping code


3/24/15 731

E-Commerce B2B Static Tables

The Download B2B E-Commerce Static Files menu option (BBED) extracts data to the following tables.

Individual departmentTable: EC Individual Department (EXINDD)

Contents:

• Company code

• Department

• Dept description

Individual positionTable: EC Individual Position (EXINDP)

Contents:

• Company code

• Position

• Position description

• Dept required

Price table itemTable: EC Price Table Item (EXPTIT)

Contents:

• Company code

• Price table

• Item number

• SKU code

• Maximum price level

• Premium qty required

• Premium qty to add

• Premium multiple


3/24/15 732

• Premium as free gift

• Premium price

• Premium dollars req

• Premium ITM number

• Premium SKU code

• Qty level 01

• Price level 01

• Qty level 02

• Price level 02

• Qty level 03

• Price level 03

• Qty level 04

• Price level 04

• Qty level 05

• Price level 05

• Qty level 06

• Price level 06

• Qty level 07

• Price level 07

• Qty level 08

• Price level 08

• Qty level 09

• Price level 09

• Qty level 10

• Price level 10

Source code/price tableTable: EC Source Code/PTB (EXSRCP)

Contents:

• Company code


3/24/15 733

• Source code

• Src description

• Src discount

• Source user field 1






• Last change date

• Price table

• Offer

Customer extensionTable: EC CST Ext (EXCSTE)

Contents:

• Company code

• CST customer #

• User defined field 1





3/24/15 734

Additional Downloads

Purpose: You populate the following tables through periodic functions or interactive process.

Item availability

Table: EC Item Availability (EXAVAI)

Populated through: The ECAVAIL periodic function (ECR0144) or the EVAVAIL process.

Contents:

• Company code

• Item number

• Short SKU

• Qty avail

• Date expected

• Default delivery date

Gift certificate

Table: EC Gift Certificate (EXGFTC)

Populated through: The EXGFTC periodic function (ECR0142).

Contents:

• Company code

• Gift cert #

• Gift cert value

Ship exclusion

Table: EC Ship Exclusion (EXITEX)

Populated through: The ECITMCH periodic function (ECR0389).

Contents:

• Identifier

• RPR country


3/24/15 735

• State code

• Company code

• Item number

• Description

3/24/15 736

Document Type Definitions (DTDs)Purpose: Document Type Definitions (DTDs) for each of the messages used as part of the CWSerenade e-commerce integration are presented in this chapter.

DTD For More Information:

CWORDERIN on page 738 Inbound Order XML Message (CWORDERIN) on page 80

CWORDEROUT on page 744 Detailed Order XML Response (CWORDEROUT) on page 175 and Order Acknowledgement XML Message (CWORDEROUT) on page 207

CWCatRequest on page 748 E-Commerce Catalog Request Message (CWCatRequest) on page 229

CWCatResponse on page 749 E-Commerce Catalog Request Response Message (CWCatreqResponse) on page 238

CWOrderStatus on page 750 E-Commerce Order Status Message (CWOrderStatus) on page 242

CWStatusResponse on page 751 E-Commerce Order Status Response Message (CWStatusResponse) on page 245

CWReturn on page 752 E-Commerce Return Request Message (CWReturn) on page 256

CWReturnResponse on page 753 E-Commerce Return Response Message (CWReturnResponse) on page 259

CWCancel on page 754 E-Commerce Cancel Request Message: Sample XML on page 280

CWSerenade 5.0 Document Type Definitions (DTDs)

3/24/15 737

CWInventoryDownload on page 755 Inventory Download XML Message (CWInventoryDownload) on page 484

DTD For More Information:


3/24/15 738

CWORDERIN<?xml version="1.0" encoding="UTF-8"?><!ELEMENT Message (Header)><!ATTLIST Message

source CDATA #IMPLIEDtarget CDATA #IMPLIEDtype CDATA "CWORDERIN"resp_qmgr CDATA #IMPLIEDresp_q CDATA #IMPLIED

><!ELEMENT Header (CustOwnerships?, CustUserFields?, UserFields?, Payments?, ShipTos?, Profiles?, Coupons?)><!ATTLIST Header

company_code CDATA #IMPLIEDorder_number CDATA #IMPLIEDoffer_id CDATA #IMPLIEDpayment_only CDATA #IMPLIEDsource_code CDATA #IMPLIEDresponse_type CDATA #IMPLIEDorder_date CDATA #IMPLIEDorder_channel CDATA #IMPLIEDcustomer_number CDATA #IMPLIEDalternate_sold_to_id CDATA #IMPLIEDprospect_id CDATA #IMPLIEDsold_to_prefix CDATA #IMPLIEDsold_to_fname CDATA #IMPLIEDsold_to_initial CDATA #IMPLIEDsold_to_lname CDATA #IMPLIEDsold_to_suffix CDATA #IMPLIEDsold_to_company CDATA #IMPLIEDsold_to_busres CDATA #IMPLIEDsold_to_address1 CDATA #IMPLIEDsold_to_address2 CDATA #IMPLIEDsold_to_address3 CDATA #IMPLIEDsold_to_address4 CDATA #IMPLIEDsold_to_apartment CDATA #IMPLIEDsold_to_city CDATA #IMPLIEDsold_to_state CDATA #IMPLIEDsold_to_zip CDATA #IMPLIEDsold_to_country CDATA #IMPLIEDsold_to_email CDATA #IMPLIEDsold_to_email_update CDATA #IMPLIEDsold_to_day_phone CDATA #IMPLIEDsold_to_eve_phone CDATA #IMPLIEDsold_to_fax_phone CDATA #IMPLIEDsold_to_opt_in CDATA #IMPLIEDsold_to_address_update CDATA #IMPLIEDallow_rent CDATA #IMPLIEDallow_email CDATA #IMPLIEDallow_mail CDATA #IMPLIEDnbr_ship_tos CDATA #IMPLIEDpay_incl CDATA #IMPLIEDind_number CDATA #IMPLIEDind_dept CDATA #IMPLIEDind_position CDATA #IMPLIEDind_prefix CDATA #IMPLIEDind_fname CDATA #IMPLIEDind_initial CDATA #IMPLIEDind_lname CDATA #IMPLIED


3/24/15 739

ind_suffix CDATA #IMPLIEDind_day_phone CDATA #IMPLIEDind_eve_phone CDATA #IMPLIEDind_fax_phone CDATA #IMPLIEDind_email_address CDATA #IMPLIEDind_opt_in CDATA #IMPLIEDind_mail_flag CDATA #IMPLIEDind_rent_flag CDATA #IMPLIEDbill_to_number CDATA #IMPLIEDalternate_bill_to_id CDATA #IMPLIEDbill_to_prefix CDATA #IMPLIEDbill_to_fname CDATA #IMPLIEDbill_to_initial CDATA #IMPLIEDbill_to_lname CDATA #IMPLIEDbill_to_suffix CDATA #IMPLIEDbill_to_company_name CDATA #IMPLIEDbill_to_address1 CDATA #IMPLIEDbill_to_address2 CDATA #IMPLIEDbill_to_address3 CDATA #IMPLIEDbill_to_address4 CDATA #IMPLIEDbill_to_apt CDATA #IMPLIEDbill_to_city CDATA #IMPLIEDbill_to_state CDATA #IMPLIEDbill_to_zip CDATA #IMPLIEDbill_to_country CDATA #IMPLIEDbill_to_email CDATA #IMPLIEDbill_to_day_phone CDATA #IMPLIEDbill_to_eve_phone CDATA #IMPLIEDbill_to_fax_phone CDATA #IMPLIEDbill_to_print_statement CDATA #IMPLIEDuser_hold_reason CDATA #IMPLIEDbatch_number CDATA #IMPLIEDbatch_date CDATA #IMPLIEDbatch_beg_end_flag CDATA #IMPLIEDapprove_batch CDATA #IMPLIEDbatch_order_count CDATA #IMPLIEDbatch_qty_count CDATA #IMPLIEDbatch_prepaid_total CDATA #IMPLIEDorder_type CDATA #IMPLIEDsales_rep_number CDATA #IMPLIEDsales_rep_name CDATA #IMPLIEDentered_by_user CDATA #IMPLIEDcustomer_class CDATA #IMPLIEDorder_email CDATA #IMPLIEDbill_to_opt_in CDATA #IMPLIEDrdc_order_nbr CDATA #IMPLIEDenter_date CDATA #IMPLIEDenter_time CDATA #IMPLIEDip_addr CDATA #IMPLIEDsold_to_price_group CDATA #IMPLIEDsales_rep_store CDATA #IMPLIED

><!ELEMENT CustOwnerships (CustOwnership)+><!ELEMENT CustOwnership EMPTY><!ATTLIST CustOwnership

cust_own_ID CDATA #IMPLIEDcust_own_desc CDATA #IMPLIEDcust_own_active CDATA #IMPLIEDcust_own_entry_date CDATA #IMPLIEDcust_own_confirm_date CDATA #IMPLIED

>


3/24/15 740

<!ELEMENT CustUserFields (CustUserField+)><!ELEMENT CustUserField EMPTY><!ATTLIST CustUserField

cust_usr_fld_dtl_seq_nbr CDATA #IMPLIEDcust_usr_fld_label CDATA #IMPLIEDcust_usr_fld_data CDATA #IMPLIED

><!ELEMENT UserFields (UserField+)><!ELEMENT UserField EMPTY><!ATTLIST UserField

usr_fld_dtl_seq_number CDATA #IMPLIEDusr_fld_label CDATA #IMPLIEDusr_fld_data CDATA #IMPLIED

><!ELEMENT Payments (Payment+)><!ELEMENT Payment EMPTY><!ATTLIST Payment

payment_type CDATA #IMPLIEDcharge_sequence CDATA #IMPLIEDsuppress_deposit_flag CDATA #IMPLIEDsuppress_refund_flag CDATA #IMPLIEDcc_name CDATA #IMPLIEDcc_type CDATA #IMPLIEDcc_number CDATA #IMPLIEDcc_exp_month CDATA #IMPLIEDcc_exp_year CDATA #IMPLIEDcc_sec_value CDATA #IMPLIEDcc_sec_presence CDATA #IMPLIEDcc_iss_bank CDATA #IMPLIEDdefer_bill CDATA #IMPLIEDflexible_payment_code CDATA #IMPLIEDamt_to_charge CDATA #IMPLIEDauth_number CDATA #IMPLIEDauth_date CDATA #IMPLIEDauth_amount CDATA #IMPLIEDgc_type CDATA #IMPLIEDgift_certificate_number CDATA #IMPLIEDgift_certificate_amount CDATA #IMPLIEDexpiration_date CDATA #IMPLIEDhold_id CDATA #IMPLIEDar_type CDATA #IMPLIEDpo_number CDATA #IMPLIEDcheck_number CDATA #IMPLIEDcheck_amount CDATA #IMPLIEDchecking_account CDATA #IMPLIEDrouting_number CDATA #IMPLIEDsvc_id CDATA #IMPLIEDcash_control_number CDATA #IMPLIEDstart_date CDATA #IMPLIEDcard_issue_nbr CDATA #IMPLIEDsoc_sec_nbr CDATA #IMPLIEDbml_version CDATA #IMPLIEDbirthdate CDATA #IMPLIEDauthentication_value CDATA #IMPLIEDecommerce_indicator CDATA #IMPLIEDcc_last_four CDATA #IMPLIEDalready_tokenized CDATA #IMPLIEDcc_bin_nbr CDATA #IMPLIEDtransaction_id CDATA #IMPLIEDvendor_response CDATA #IMPLIEDavs_response CDATA #IMPLIED


3/24/15 741

cid_response CDATA #IMPLIED><!ELEMENT ShipTos (ShipTo+)><!ELEMENT ShipTo (AdditionalCharges?, Ord_Msgs?, Promotions?, Certificates?, Items?)><!ATTLIST ShipTo

arrival_date CDATA #IMPLIEDcancel_bo CDATA #IMPLIEDcancel_bo_date CDATA #IMPLIEDcontact_name CDATA #IMPLIEDfedex_number CDATA #IMPLIEDfreight CDATA #IMPLIEDshipping_method CDATA #IMPLIEDgift CDATA #IMPLIEDresale_exempt_id CDATA #IMPLIEDship_complete CDATA #IMPLIEDpriority CDATA #IMPLIEDcalc_frt CDATA #IMPLIEDdiscount_pct CDATA #IMPLIEDcustomer_ship_to_number CDATA #IMPLIEDalternate_ship_to_id CDATA #IMPLIEDship_to_type CDATA #IMPLIEDship_to_prefix CDATA #IMPLIEDship_to_fname CDATA #IMPLIEDship_to_initial CDATA #IMPLIEDship_to_lname CDATA #IMPLIEDship_to_suffix CDATA #IMPLIEDship_to_company CDATA #IMPLIEDship_to_address1 CDATA #IMPLIEDship_to_address2 CDATA #IMPLIEDship_to_address3 CDATA #IMPLIEDship_to_address4 CDATA #IMPLIEDship_to_apartment CDATA #IMPLIEDship_to_city CDATA #IMPLIEDship_to_state CDATA #IMPLIEDship_to_zip CDATA #IMPLIEDship_to_country CDATA #IMPLIEDship_to_email CDATA #IMPLIEDship_to_busres CDATA #IMPLIEDship_to_day_phone CDATA #IMPLIEDship_to_evening_phone CDATA #IMPLIEDship_to_fax_phone CDATA #IMPLIEDemail_gc CDATA #IMPLIEDpermanent_ship_to_number CDATA #IMPLIEDship_to_warehouse CDATA #IMPLIEDship_to_po_number CDATA #IMPLIEDgift_message CDATA #IMPLIEDadd_chg_count CDATA #IMPLIEDpromotion CDATA #IMPLIEDstore_code CDATA #IMPLIEDdelivery_type CDATA #IMPLIEDtax_exempt CDATA #IMPLIEDfreight_tax_amount CDATA #IMPLIEDfreight_tax_override CDATA #IMPLIED

><!ELEMENT AdditionalCharges (AdditionalCharge+)><!ELEMENT AdditionalCharge EMPTY><!ATTLIST AdditionalCharge

additional_charge_seq_nbr CDATA #IMPLIEDadditional_charge_code CDATA #IMPLIEDadditional_charge_amount CDATA #IMPLIED

>


3/24/15 742

<!ELEMENT Ord_Msgs (Ord_Msg+)><!ELEMENT Ord_Msg EMPTY><!ATTLIST Ord_Msg

ord_msg_text CDATA #IMPLIEDord_msg_code CDATA #IMPLIED

><!ELEMENT Promotions (Promotion+)><!ELEMENT Promotion EMPTY><!ATTLIST Promotion

promotion_code CDATA #IMPLIED><!ELEMENT Certificates (Certificate?)*><!ELEMENT Certificate EMPTY><!ATTLIST Certificate

certificate_number CDATA #IMPLIEDcertificate_amount CDATA #IMPLIEDtransaction_id CDATA #IMPLIED

><!ELEMENT Items (Item+)><!ELEMENT Item (Lin_Msgs?, personalization_lines?, CouponDetails?)><!ATTLIST Item

drop_ship CDATA #IMPLIEDno_charge CDATA #IMPLIEDaffect_inventory CDATA #IMPLIEDline_arrival_date CDATA #IMPLIEDline_cancel_date CDATA #IMPLIEDcord_group CDATA #IMPLIEDactual_price CDATA #IMPLIEDprc_ovr_rsn CDATA #IMPLIEDquantity CDATA #IMPLIEDbypass_reserve CDATA #IMPLIEDtax_override CDATA #IMPLIEDtax_amount CDATA #IMPLIEDgst_amount CDATA #IMPLIEDpst_amount CDATA #IMPLIEDgift_wrap CDATA #IMPLIEDcost_override_amount CDATA #IMPLIEDline_priority CDATA #IMPLIEDline_freight_override CDATA #IMPLIEDline_freight_override_amt CDATA #IMPLIEDline_coupon_flag CDATA #IMPLIEDline_coupon_amount CDATA #IMPLIEDpersonalization_id CDATA #IMPLIEDpersonalization_cost CDATA #IMPLIEDgc_number CDATA #IMPLIEDalias_item CDATA #IMPLIEDitem_id CDATA #IMPLIEDsku CDATA #IMPLIEDshort_sku_number CDATA #IMPLIEDretail_ref_number CDATA #IMPLIEDupc_type CDATA #IMPLIEDupc_code CDATA #IMPLIEDline_offer CDATA #IMPLIEDline_source_code CDATA #IMPLIEDline_shipping_method CDATA #IMPLIEDline_warehouse CDATA #IMPLIEDlocation CDATA #IMPLIEDreturn_reason CDATA #IMPLIEDreturn_disposition CDATA #IMPLIEDprice_override CDATA #IMPLIEDpickup_type CDATA #IMPLIED


3/24/15 743

pickup_system_location CDATA #IMPLIEDpickup_location CDATA #IMPLIEDline_entered_date CDATA #IMPLIEDline_entered_time CDATA #IMPLIEDline_hyperlink CDATA #IMPLIED

><!ELEMENT Lin_Msgs (Lin_Msg+)><!ELEMENT Lin_Msg EMPTY><!ATTLIST Lin_Msg

lin_msg_code CDATA #IMPLIEDlin_msg_text CDATA #IMPLIED

><!ELEMENT personalization_lines (personalization_line+)><!ELEMENT personalization_line EMPTY><!ATTLIST personalization_line

personalization_type CDATA #IMPLIEDpersonalization_text CDATA #IMPLIEDstandard_text CDATA #IMPLIED

><!ELEMENT CouponDetails (CouponDetail?)*><!ELEMENT CouponDetail EMPTY><!ATTLIST CouponDetail

coupon_detail_code CDATA #IMPLIED><!ELEMENT Profiles (Profile?)*><!ELEMENT Profile EMPTY><!ATTLIST Profile

profile_code CDATA #IMPLIEDprofile_value CDATA #IMPLIED

><!ELEMENT Coupons (Coupon?)*><!ELEMENT Coupon EMPTY><!ATTLIST Coupon

coupon_code CDATA #IMPLIED>


3/24/15 744

CWORDEROUT<?xml version="1.0" encoding="UTF-8"?><!ELEMENT Message (Header?)><!ATTLIST Message

source CDATA #REQUIREDtarget CDATA #REQUIREDtype (CWORDEROUT) #REQUIRED

><!ELEMENT Header (Payments?, ShipTos?)><!ATTLIST Header

company_code CDATA #REQUIREDorder_id CDATA #IMPLIEDreference_order_number CDATA #IMPLIEDcustomer_number CDATA #IMPLIEDalternate_sold_to_id CDATA #IMPLIEDbill_to_number CDATA #IMPLIEDorder_date CDATA #IMPLIEDorder_channel CDATA #IMPLIEDbill_me_later_ind CDATA #IMPLIEDorder_status CDATA #IMPLIEDorder_type CDATA #IMPLIEDorder_type_description CDATA #IMPLIEDb2b_order CDATA #IMPLIEDstore_restock_order CDATA #IMPLIEDentered_date CDATA #IMPLIEDentered_time CDATA #IMPLIEDemail_confirm_date CDATA #IMPLIEDsource_code CDATA #IMPLIEDoffer_id CDATA #IMPLIEDsold_to_prefix CDATA #IMPLIEDsold_to_fname CDATA #IMPLIEDsold_to_initial CDATA #IMPLIEDsold_to_lname CDATA #IMPLIEDsold_to_suffix CDATA #IMPLIEDsold_to_company CDATA #IMPLIEDsold_to_busres CDATA #IMPLIEDsold_to_address1 CDATA #IMPLIEDsold_to_address2 CDATA #IMPLIEDsold_to_address3 CDATA #IMPLIEDsold_to_address4 CDATA #IMPLIEDsold_to_apartment CDATA #IMPLIEDsold_to_city CDATA #IMPLIEDsold_to_state CDATA #IMPLIEDsold_to_state_description CDATA #IMPLIEDsold_to_zip CDATA #IMPLIEDsold_to_country CDATA #IMPLIEDsold_to_day_phone CDATA #IMPLIEDsold_to_eve_phone CDATA #IMPLIEDsold_to_fax_phone CDATA #IMPLIEDallow_rent CDATA #IMPLIEDallow_mail CDATA #IMPLIEDsold_to_opt_in CDATA #IMPLIEDind_number CDATA #IMPLIEDbill_to_prefix CDATA #IMPLIEDbill_to_fname CDATA #IMPLIEDbill_to_initial CDATA #IMPLIEDbill_to_lname CDATA #IMPLIEDbill_to_suffix CDATA #IMPLIEDbill_to_company CDATA #IMPLIED


3/24/15 745

bill_to_busres CDATA #IMPLIEDbill_to_address1 CDATA #IMPLIEDbill_to_address2 CDATA #IMPLIEDbill_to_address3 CDATA #IMPLIEDbill_to_address4 CDATA #IMPLIEDbill_to_apartment CDATA #IMPLIEDbill_to_city CDATA #IMPLIEDbill_to_state CDATA #IMPLIEDbill_to_state_description CDATA #IMPLIEDbill_to_zip CDATA #IMPLIEDbill_to_country CDATA #IMPLIEDbill_to_day_phone CDATA #IMPLIEDbill_to_eve_phone CDATA #IMPLIEDbill_to_fax_phone CDATA #IMPLIEDsales_rep_number CDATA #IMPLIEDsales_rep_name CDATA #IMPLIEDsales_rep_store CDATA #IMPLIED

><!ELEMENT Payments (Payment*)><!ELEMENT Payment EMPTY><!ATTLIST Payment

payment_seq_number CDATA #IMPLIEDpay_type CDATA #IMPLIEDpay_type_desc CDATA #IMPLIEDcredit_card_nbr CDATA #IMPLIEDcredit_card_exp_dt CDATA #IMPLIEDcredit_card_auth_dt CDATA #IMPLIEDcredit_card_auth_nbr CDATA #IMPLIEDcheck_nbr CDATA #IMPLIEDgift_cert_nbr CDATA #IMPLIEDamt_to_chg CDATA #IMPLIEDstart_date CDATA #IMPLIEDcard_issue_nbr CDATA #IMPLIED

><!ELEMENT ShipTos (ShipTo+)><!ELEMENT ShipTo (Details, Errors?, Ord_Msgs?, Promotions?)><!ATTLIST ShipTo

ship_to_number CDATA #IMPLIEDsub_total CDATA #IMPLIEDdiscount_total CDATA #IMPLIEDshipping CDATA #IMPLIEDshipping_override CDATA #IMPLIEDadditional_shipping CDATA #IMPLIEDtax CDATA #IMPLIEDadditional_charges CDATA #IMPLIEDhandling CDATA #IMPLIEDorder_total CDATA #IMPLIEDgst CDATA #IMPLIEDpst CDATA #IMPLIEDship_to_status CDATA #IMPLIEDgift_order CDATA #IMPLIEDpurchase_order_nbr CDATA #IMPLIEDdiscount_pct CDATA #IMPLIEDship_via_code CDATA #IMPLIEDship_via_description CDATA #IMPLIEDcustomer_number CDATA #IMPLIEDpermanent_ship_to_number CDATA #IMPLIEDship_to_prefix CDATA #IMPLIEDship_to_fname CDATA #IMPLIEDship_to_initial CDATA #IMPLIEDship_to_lname CDATA #IMPLIED


3/24/15 746

ship_to_suffix CDATA #IMPLIEDship_to_company CDATA #IMPLIEDship_to_busres CDATA #IMPLIEDship_to_address1 CDATA #IMPLIEDship_to_address2 CDATA #IMPLIEDship_to_address3 CDATA #IMPLIEDship_to_address4 CDATA #IMPLIEDship_to_apartment CDATA #IMPLIEDship_to_city CDATA #IMPLIEDship_to_state CDATA #IMPLIEDship_to_state_description CDATA #IMPLIEDship_to_zip CDATA #IMPLIEDship_to_country CDATA #IMPLIEDcancel_date CDATA #IMPLIEDdelivery_type CDATA #IMPLIED

><!ELEMENT Details (Detail+)><!ELEMENT Detail (Shipments?, SpecialHandlingFormats?)><!ATTLIST Detail

line_seq_number CDATA #IMPLIEDshort_sku_number CDATA #IMPLIEDretail_ref_number CDATA #IMPLIEDstatus CDATA #IMPLIEDalias_item CDATA #IMPLIEDitem_id CDATA #IMPLIEDitem_description CDATA #IMPLIEDsku CDATA #IMPLIEDsku_description CDATA #IMPLIEDactual_price CDATA #IMPLIEDoffer_price CDATA #IMPLIEDoriginal_retail_price CDATA #IMPLIEDdrop_ship CDATA #IMPLIEDdetail_ship_via CDATA #IMPLIEDpickup_type CDATA #IMPLIEDpickup_system_location CDATA #IMPLIEDpickup_location CDATA #IMPLIEDorder_quantity CDATA #IMPLIEDcancel_quantity CDATA #IMPLIEDsold_out_quantity CDATA #IMPLIEDship_quantity CDATA #IMPLIEDreturn_quantity CDATA #IMPLIEDexpected_ship_date CDATA #IMPLIEDlast_ship_date CDATA #IMPLIEDreserved_warehouse CDATA #IMPLIEDreserve_quantity CDATA #IMPLIEDtax CDATA #IMPLIEDpst_tax CDATA #IMPLIEDgst_tax CDATA #IMPLIEDset_main_item CDATA #IMPLIEDset_component_item CDATA #IMPLIEDset_seq_number CDATA #IMPLIEDcountry_of_origin CDATA #IMPLIEDharmonize_code CDATA #IMPLIEDbroker_status CDATA #IMPLIEDline_locate_eligible CDATA #IMPLIEDgift_wrap CDATA #IMPLIED

><!ELEMENT Shipments (Shipment+)><!ELEMENT Shipment EMPTY><!ATTLIST Shipment

invoice_nbr CDATA #IMPLIED


3/24/15 747

invoice_ship_quantity CDATA #IMPLIEDinvoice_ship_date CDATA #IMPLIEDinvoice_tracking_nbr CDATA #IMPLIEDinvoice_ship_via_code CDATA #IMPLIEDinvoice_ship_via_desc CDATA #IMPLIEDinvoice_ship_via_type CDATA #IMPLIEDinvoice_tracking_URL CDATA #IMPLIED

><!ELEMENT SpecialHandlingFormats (SpecialHandlingFormat+)><!ELEMENT SpecialHandlingFormat EMPTY><!ATTLIST SpecialHandlingFormat

special_format_seq_number CDATA #IMPLIEDspecial_handling_code CDATA #IMPLIEDspecial_handling_format_seq_number CDATA #IMPLIEDspecial_format_label CDATA #IMPLIEDspecial_format_text CDATA #IMPLIEDspecial_format_charge CDATA #IMPLIEDspecial_handling_seq_number CDATA #IMPLIEDspecial_handling_information CDATA #IMPLIED

><!ELEMENT Errors (Error?)*><!ELEMENT Error EMPTY><!ATTLIST Error

error_type CDATA #IMPLIEDerror_code CDATA #IMPLIEDerror_ship_to CDATA #IMPLIEDerror_odt_seq CDATA #IMPLIEDerror_text CDATA #IMPLIED

><!ELEMENT Ord_Msgs (Ord_Msg*)*><!ELEMENT Ord_Msg EMPTY><!ATTLIST Ord_Msg

ord_msg_text CDATA #IMPLIEDord_msg_code CDATA #IMPLIED

><!ELEMENT Promotions (Promotion+)><!ELEMENT Promotion EMPTY><!ATTLIST Promotion

promotion_type_code CDATA #IMPLIEDpromotion_type_code_desc CDATA #IMPLIEDpromotion_original_freight_amt CDATA #IMPLIEDpromotion_freight_amt CDATA #IMPLIEDpromotion_addl_charge_code CDATA #IMPLIEDpromotion_addl_charge_code_desc CDATA #IMPLIEDpromotion_addl_charge_amt CDATA #IMPLIEDpromotion_original_shipping_method CDATA #IMPLIEDpromotion_original_shipping_method_desc CDATA #IMPLIEDpromotion_shipping_method CDATA #IMPLIEDpromotion_shipping_method_desc CDATA #IMPLIEDpromotion_item_id CDATA #IMPLIEDpromotion_item_desc CDATA #IMPLIEDpromotion_sku CDATA #IMPLIEDpromotion_sku_desc CDATA #IMPLIEDpromotion_offer_price CDATA #IMPLIEDpromotion_price CDATA #IMPLIEDpromotion_line_seq_nbr CDATA #IMPLIED

>


3/24/15 748

CWCatRequest<?xml version="1.0" encoding="UTF-8"?><!ELEMENT Message (CatRequest)><!ATTLIST Message

source CDATA #REQUIREDtarget CDATA #REQUIREDtype NMTOKEN #REQUIRED

><!ELEMENT CatRequest (CustOwnerships?)?><!ATTLIST CatRequest

company_code CDATA #REQUIREDresponse_required CDATA #IMPLIEDoffer_id CDATA #IMPLIEDsource_code CDATA #IMPLIEDbill_to_prefix CDATA #IMPLIEDbill_to_fname CDATA #IMPLIEDbill_to_initial CDATA #IMPLIEDbill_to_lname CDATA #IMPLIEDbill_to_suffix CDATA #IMPLIEDbill_to_company CDATA #IMPLIEDbill_to_busres CDATA #IMPLIEDbill_to_address1 CDATA #IMPLIEDbill_to_address2 CDATA #IMPLIEDbill_to_address3 CDATA #IMPLIEDbill_to_address4 CDATA #IMPLIEDbill_to_apartment CDATA #IMPLIEDbill_to_city CDATA #IMPLIEDbill_to_state CDATA #IMPLIEDbill_to_country CDATA #IMPLIEDbill_to_zip CDATA #IMPLIEDbill_to_email CDATA #IMPLIEDallow_rent CDATA #IMPLIEDallow_email CDATA #IMPLIEDallow_mail CDATA #IMPLIEDbill_to_day_phone CDATA #IMPLIEDbill_to_evening_phone CDATA #IMPLIEDbill_to_fax_phone CDATA #IMPLIEDbill_to_opt_in CDATA #IMPLIEDindiv_prefix CDATA #IMPLIEDindiv_fname CDATA #IMPLIEDindiv_lname CDATA #IMPLIEDindiv_initial CDATA #IMPLIEDindiv_suffix CDATA #IMPLIEDindiv_day_phone CDATA #IMPLIEDindiv_eve_phone CDATA #IMPLIEDindiv_fax_phone CDATA #IMPLIEDindiv_email CDATA #IMPLIEDindiv_mailstop CDATA #IMPLIEDindiv_position CDATA #IMPLIEDindiv_department CDATA #IMPLIEDindiv_opt_in CDATA #IMPLIED

><!ELEMENT CustOwnerships (CustOwnership)+><!ELEMENT CustOwnership EMPTY><!ATTLIST CustOwnership

cust_own_ID CDATA #IMPLIEDcust_own_desc CDATA #IMPLIEDcust_own_active CDATA #IMPLIEDcust_own_entry_date CDATA #IMPLIEDcust_own_confirm_date CDATA #IMPLIED

>


3/24/15 749

CWCatResponse<?xml version="1.0" encoding="UTF-8"?><!ELEMENT Message (CWCatreqResponse)><!ATTLIST Message


><!ELEMENT CWCatreqResponse EMPTY><!ATTLIST CWCatreqResponse

company_code CDATA #REQUIREDcustomer_number CDATA #IMPLIEDindividual_number CDATA #IMPLIED

>


3/24/15 750

CWOrderStatus<?xml version="1.0" encoding="UTF-8"?><!ELEMENT Message (OrderStatus)><!ATTLIST Message

source CDATA #REQUIREDtarget CDATA #REQUIREDtype NMTOKEN #REQUIREDresp_qmgr CDATA #IMPLIEDresp_q CDATA #IMPLIED

><!ELEMENT OrderStatus EMPTY><!ATTLIST OrderStatus

company_code CDATA #REQUIREDorder_id CDATA #REQUIREDbill_to_lname CDATA #IMPLIEDind_lname CDATA #IMPLIEDcompany_name CDATA #IMPLIEDship_to_details CDATA #IMPLIED

>


3/24/15 751

CWStatusResponse<?xml version="1.0" encoding="UTF-8"?><!ELEMENT Message (Header, ShipTos*)><!ATTLIST Message


><!ELEMENT Header EMPTY><!ATTLIST Header

company_code CDATA #REQUIREDoffer_id CDATA #IMPLIEDorder_id CDATA #REQUIREDresponse_type CDATA #IMPLIEDdate_placed CDATA #IMPLIED

><!ELEMENT ShipTos (ShipTo+)><!ELEMENT ShipTo (Invoices*, Items+)><!ATTLIST ShipTo

ship_to_number CDATA #REQUIREDship_to_fname CDATA #IMPLIEDship_to_lname CDATA #IMPLIEDallow_maint CDATA #IMPLIED

><!ELEMENT Invoices (Invoice+)><!ELEMENT Items (Item+)><!ELEMENT Invoice EMPTY><!ATTLIST Invoice

date_shipped CDATA #REQUIREDtracking_id CDATA #IMPLIEDship_via CDATA #REQUIRED

><!ELEMENT Item EMPTY><!ATTLIST Item

sku CDATA #REQUIREDitem_id CDATA #REQUIREDline_nbr CDATA #REQUIREDdescription CDATA #IMPLIEDsku_description1 CDATA #IMPLIEDsku_description2 CDATA #IMPLIEDsku_description3 CDATA #IMPLIEDquantity CDATA #IMPLIEDlist_price CDATA #IMPLIEDstatus CDATA #IMPLIEDrtn_qty CDATA #IMPLIEDcancel_qty CDATA #IMPLIED

>


3/24/15 752

CWReturn<?xml version="1.0" encoding="UTF-8"?><!ELEMENT Message (Return, Lines)><!ATTLIST Message

source CDATA #REQUIREDtarget CDATA #REQUIREDtype NMTOKEN #REQUIREDresp_qmgr CDATA #IMPLIEDresp_q CDATA #IMPLIED

><!ELEMENT Return EMPTY><!ATTLIST Return

company_code CDATA #REQUIREDorder_id CDATA #REQUIREDship_to CDATA #REQUIRED

><!ELEMENT Lines (Line+)><!ELEMENT Line EMPTY><!ATTLIST Line

line_number CDATA #REQUIREDqty CDATA #REQUIREDreason CDATA #REQUIRED

>


3/24/15 753

CWReturnResponse<?xml version="1.0" encoding="UTF-8"?><!ELEMENT Message (ReturnResponse)><!ATTLIST Message


><!ELEMENT ReturnResponse EMPTY><!ATTLIST ReturnResponse

company_code CDATA #REQUIREDorder_id CDATA #REQUIREDship_to CDATA #REQUIREDra_number CDATA #REQUIREDtotal_weight CDATA #IMPLIEDdate_entered CDATA #IMPLIEDname CDATA #IMPLIEDaddress CDATA #IMPLIEDaddress2 CDATA #IMPLIEDcity CDATA #IMPLIEDstate CDATA #IMPLIEDzip CDATA #IMPLIEDcountry CDATA #IMPLIEDphone_number CDATA #IMPLIED

>


3/24/15 754

CWCancel<?xml version="1.0" encoding="UTF-8"?><!ELEMENT Message (Cancel, Lines?)><!ATTLIST Message


><!ELEMENT Cancel EMPTY><!ATTLIST Cancel

company_code CDATA #REQUIREDorder_id CDATA #REQUIREDship_to CDATA #REQUIREDcancel_type NMTOKEN #REQUIREDorder_reason CDATA #IMPLIED

><!ELEMENT Lines (Line+)><!ELEMENT Line EMPTY><!ATTLIST Line

line_number CDATA #REQUIREDqty CDATA #REQUIREDreason CDATA #REQUIRED

>


3/24/15 755

CWInventoryDownload<?xml version="1.0" encoding="UTF-8"?><!ELEMENT Message (Item?)><!ATTLIST Message

source CDATA #REQUIREDtarget CDATA #REQUIREDtype NMTOKEN #REQUIREDdate CDATA #REQUIREDtime CDATA #REQUIRED

><!ELEMENT Item (SKU?)><!ATTLIST Item

company CDATA #REQUIREDcompany_description CDATA #IMPLIEDitem_number CDATA #REQUIREDitem_description CDATA #REQUIREDitem_2nd_lang_desc CDATA #IMPLIEDitem_long_sku_style CDATA #IMPLIEDnon_inventory CDATA #IMPLIEDmembership CDATA #IMPLIEDdrop_ship_item CDATA #IMPLIEDitem_status CDATA #IMPLIEDitem_status_description CDATA #IMPLIEDkit_type CDATA #IMPLIEDsvc_type CDATA #IMPLIEDlong_sku_department CDATA #IMPLIEDlong_sku_department_desc CDATA #IMPLIEDlong_sku_division CDATA #IMPLIEDlong_sku_division_desc CDATA #IMPLIEDlong_sku_class CDATA #IMPLIEDlong_sku_class_desc CDATA #IMPLIED

><!ELEMENT SKU (UPCs?, Warehouses?)><!ATTLIST SKU

sku_code CDATA #IMPLIEDsku_description CDATA #IMPLIEDsku_2nd_lang_desc CDATA #IMPLIEDsku_long_sku_style CDATA #IMPLIEDshort_sku CDATA #IMPLIEDretail_reference_nbr CDATA #IMPLIEDgift_certificate CDATA #IMPLIEDsubscription CDATA #IMPLIEDsku_status CDATA #IMPLIEDsku_status_description CDATA #IMPLIEDso_control CDATA #IMPLIEDso_control_description CDATA #IMPLIEDso_control_status CDATA #IMPLIED

><!ELEMENT UPCs (UPC+)><!ELEMENT Warehouses (Warehouse+)><!ELEMENT UPC EMPTY><!ATTLIST UPC

upc CDATA #REQUIREDupc_type CDATA #REQUIREDupc_vendor CDATA #IMPLIED

><!ELEMENT Warehouse (ItemWarehouse?)><!ATTLIST Warehouse

warehouse CDATA #REQUIRED


3/24/15 756

warehouse_name CDATA #REQUIREDaddress_line_1 CDATA #IMPLIEDaddress_line_2 CDATA #IMPLIEDaddress_line_3 CDATA #IMPLIEDcity CDATA #IMPLIEDstate CDATA #IMPLIEDpostal_code CDATA #IMPLIEDcountry CDATA #IMPLIEDdrop_point CDATA #REQUIREDdrop_point_description CDATA #IMPLIEDmanager CDATA #IMPLIEDtelephone_nbr CDATA #IMPLIEDfax_nbr CDATA #IMPLIEDallocatable_flag CDATA #REQUIREDreceive_restock_transfers CDATA #REQUIREDinventory_value_gl_nbr CDATA #IMPLIEDvalue_inv_at_retail CDATA #IMPLIEDviewable_in_oe CDATA #REQUIREDauto_restock_location CDATA #IMPLIEDretail_outlet CDATA #IMPLIEDretail_type CDATA #IMPLIED

><!ELEMENT ItemWarehouse EMPTY><!ATTLIST ItemWarehouse

allocation_freeze CDATA #REQUIREDeconomic_order_qty CDATA #IMPLIEDmax_qty CDATA #IMPLIEDmin_qty CDATA #IMPLIEDon_hand_qty CDATA #IMPLIEDbackorder_qty CDATA #IMPLIEDprotected_qty CDATA #IMPLIEDreorder_qty CDATA #IMPLIEDreserve_qty CDATA #IMPLIEDsh_reserve_qty CDATA #IMPLIEDon_order_qty CDATA #IMPLIEDreserve_transfer_qty CDATA #IMPLIEDavailable_qty CDATA #IMPLIEDnext_po_date CDATA #IMPLIEDnext_expected_qty CDATA #IMPLIEDoriginal_retail_price CDATA #IMPLIEDcurrent_retail_price CDATA #IMPLIEDprotect_current_price CDATA #IMPLIEDprotect_min_max CDATA #IMPLIED

>

Oracle Retail Order Management System (CWSerenade) E ... · Oracle® Retail Order Management System...

Documents

Transcript of Oracle Retail Order Management System (CWSerenade) E ... · Oracle® Retail Order Management System...