order management system cloud service e-commerce guide 17€¦ · e-commerce overview ... working...

Oracle® Retail Order Management System Cloud ServiceE-Commerce Guide

Release 17.1

October 2018

ii

Oracle® Retail Order Management System Cloud Service E-Commerce Guide, Release 17.1

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

Primary Author: Karen Bottger

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

iii

use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

Oracle Retail VAR Applications

The following restrictions and provisions only apply to the programs referred to in this section and licensed to you. You acknowledge that the programs may contain third party software (VAR applications) licensed to Oracle. Depending upon your product and its version number, the VAR applications may include:

(i) the MicroStrategy Components developed and licensed by MicroStrategy Services Corporation (MicroStrategy) of McLean, Virginia to Oracle and imbedded in the MicroStrategy for Oracle Retail Data Warehouse and MicroStrategy for Oracle Retail Planning & Optimization applications.

(ii) the Wavelink component developed and licensed by Wavelink Corporation (Wavelink) of Kirkland, Washington, to Oracle and imbedded in Oracle Retail Mobile Store Inventory Management.

(iii) the software component known as Access Via™ licensed by Access Via of Seattle, Washington, and imbedded in Oracle Retail Signs and Oracle Retail Labels and Tags.

(iv) the software component known as Adobe Flex™ licensed by Adobe Systems Incorporated of San Jose, California, and imbedded in Oracle Retail Promotion Planning & Optimization application.

You acknowledge and confirm that Oracle grants you use of only the object code of the VAR Applications. Oracle will not deliver source code to the VAR Applications to you. Notwithstanding any other term or condition of the agreement and this ordering document, you shall not cause or permit alteration of any VAR Applications. For purposes of this section, "alteration" refers to all alterations, translations, upgrades, enhancements, customizations or modifications of all or any portion of the VAR Applications including all reconfigurations, reassembly or reverse assembly, re-engineering or reverse engineering and recompilations or reverse compilations of the VAR Applications or any derivatives of the VAR Applications. You acknowledge that it shall be a breach of the agreement to utilize the relationship, and/or confidential information of the VAR Applications for purposes of competitive discovery.

The VAR Applications contain trade secrets of Oracle and Oracle's licensors and Customer shall not attempt, cause, or permit the alteration, decompilation, reverse engineering, disassembly or other reduction of the VAR Applications to a human perceivable form. Oracle reserves the right to replace, with functional equivalent software, any of the VAR Applications in future releases of the applicable program.

iv

1Contents

Send Us Your Comments .............................................................................................xii

Preface ..........................................................................................................................xiiiAudience .................................................................................................................................... xiiiDocumentation Accessibility .................................................................................................. xiiiRelated Documents .................................................................................................................. xiiiCustomer Support .................................................................................................................... xiiiImproved Process for Oracle Retail Documentation Corrections ..................................... xivOracle Retail Documentation on the Oracle Technology Network .................................. xivConventions ............................................................................................................................... xiv

E-Commerce Overview ........................................................... 1Types of E-Commerce Transactions.............................................................................2

Order Transaction ................................................................................................................................. 2Order Reject Transaction ..................................................................................................................... 3Catalog Request Transaction ............................................................................................................... 4Return Transaction ............................................................................................................................... 4Cancel Transaction ................................................................................................................................ 6Customer Transaction .......................................................................................................................... 6E-Commerce Customer Merge Web Download ............................................................................... 7Order Status Transaction ..................................................................................................................... 7Customer History Transaction ............................................................................................................ 8Inventory Inquiry Transaction ............................................................................................................ 9Item Availability Transaction .............................................................................................................. 9E-Commerce Item Availability Web Transaction .......................................................................... 10Inventory Download Transaction .................................................................................................... 11Item Download Transaction .............................................................................................................. 11E-Commerce Product Web Download ............................................................................................ 11

E-Commerce Messages........................................................ 12Generic Order Interface (Order API) ............................................................................13

Order API Processing Overview ...................................................................................................... 14Suppressing Deposits and Refunds ......................................................................................... 18Creating a Quote through the Order API ............................................................................... 19Processing a Return .................................................................................................................... 20Performing Credit Card Tokenization on Web Orders ........................................................ 21Performing Online Credit Card Authorization on Web Orders .......................................... 21Creating Authorization History for Orders Authorized on the Web ................................. 22

Typical Order Interface Scenarios .................................................................................................... 24Sending a Separate Payment Message .................................................................................... 25

Order API Setup Requirements ........................................................................................................ 26Order API-Related System Control Values ..................................................................................... 29

v

Customer Creation, Matching and Update Logic in the Order API ........................................... 31Customer Sold To Selection, Creation and Update ............................................................... 31Creating or Selecting Shipping Addresses or Customers ..................................................... 35Customer Bill To Selection and Creation ................................................................................ 38

Resolving the Item and SKU in the Order API ............................................................................... 39User-Defined Fields in the CWOrderIn Message ........................................................................... 40Selecting the Sales Rep ....................................................................................................................... 41Discounted and Added Items in the CWOrderOut Response Message ..................................... 42

Discounting and Added Items in the CWOrderOut Response Summary ......................... 44Rejecting the Order (Order API) ....................................................................................................... 48

Order Interface XML Message Formats.......................................................................50Inbound Order XML Message (CWORDERIN) ............................................................................. 51

Inbound Order Message: Sample XMLs .............................................................................. 129Detailed Order XML Response (CWORDEROUT) ...................................................................... 132

Detailed Order Response Message: Sample XML ............................................................... 158Order Acknowledgement XML Message (CWORDEROUT) ..................................................... 159

Order Acknowledgement Message: Sample XML .............................................................. 160Order Reject Request Message (CWORDERREJECT) ................................................................. 160

Order Reject Request Message: Sample ................................................................................ 161Order Reject Response Message: Samples ............................................................................ 162

Order Creation Errors .................................................................................................163

Translating Special Characters..................................................................................172

E-Commerce Catalog Requests.................................................................................173E-Commerce Catalog Request Setup ............................................................................................. 174

Setup for the CWServiceIn SOAP-Based Web Service ........................................................ 174Setup for the CWServiceIn RESTful Web Service ................................................................ 175

Customer Creation/Update Logic in E-Commerce Catalog Requests ...................................... 176Creating/Updating Sold To Customers in E-Commerce Catalog Requests ..................... 176

E-Commerce Catalog Request Response ....................................................................................... 177E-Commerce Catalog Request Message (CWCatRequest) ......................................................... 178

E-Commerce Catalog Request Message: Sample XML ....................................................... 183E-Commerce Catalog Request Response Message (CWCatreqResponse) ............................... 184

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

Inbound Return API.....................................................................................................186Process Overview .............................................................................................................................. 187

Identifying the Order ............................................................................................................... 187Identifying the Order Line ...................................................................................................... 188Returning Against an Existing Return Authorization ........................................................ 189Determining the Return Warehouse and Location .............................................................. 190Suppressing Refunds ............................................................................................................... 190Tax Overrides and Return Processing ................................................................................... 191Return API Errors ..................................................................................................................... 193

Return API Setup .............................................................................................................................. 195System Control Values ............................................................................................................. 196Menu Options ........................................................................................................................... 197Secured Features ....................................................................................................................... 197CWMessageIn Web Service .................................................................................................... 197

Return Request Message (CWReturnIn) ....................................................................................... 198Return Request Message: Sample XML ................................................................................ 206

Return Response Message (CWReturnOut) .................................................................................. 206

vi

Return Response Message: Sample XML .............................................................................. 208

Working with Batch Order Maintenance Transactions (WBOM).............................209E-Commerce Cancel Setup .............................................................................................................. 210

Setup for the CWServiceIn SOAP-Based Web Service ........................................................ 210Setup for the CWServiceIn RESTful Web Service ................................................................ 211

E-Commerce Cancel Process ........................................................................................................... 212When is an Order Eligible for Cancellation through the E-Commerce Interface? .......... 212Order Inquiry/Maintenance Message Flow .......................................................................... 213Processing the Request ............................................................................................................ 213E-Commerce Cancellation Transactions ............................................................................... 214Emails for E-Commerce Cancels ............................................................................................ 214Order History Messages .......................................................................................................... 215

Work with Batch OM Transactions Screen ................................................................................... 215Display Batch OM Transactions Screen (Header) ........................................................................ 217Display Batch OM Transactions Screen (Detail) .......................................................................... 218Display Batch OM Detail Screen ..................................................................................................... 220Display Batch OM Errors Screen .................................................................................................... 221Batch Order Cancel Errors ............................................................................................................... 222E-Commerce Cancel Request Message (CWCancel) ................................................................... 225

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

Generic Customer API ................................................................................................228Customer API Setup ......................................................................................................................... 229

System Control Values used by the Customer API ............................................................. 230Default Customer for Customer API ..................................................................................... 231Message Log used by the Customer API .............................................................................. 232CWCustomer or CWMessageIn Web Service ...................................................................... 232

Determining Whether to Add or Change a Customer ................................................................ 235Adding a Customer using the Customer API ............................................................................... 236

Required Attributes for Add Requests .................................................................................. 236Duplicate Checking for Add Requests .................................................................................. 237Error Checking for Add Requests .......................................................................................... 242Send Response for Add Request? .......................................................................................... 242Fixing Errors and Reprocessing an Add Request ................................................................ 242

Changing a Customer using the Customer API ........................................................................... 243Required Attributes for Change Requests ............................................................................ 243Determining the Customer to Update ................................................................................... 244Using a Default Customer as a Guideline for Change Requests ....................................... 248Error Checking for Change Requests .................................................................................... 249Send Response for Change Request? ..................................................................................... 250Fixing Errors and Reprocessing a Change Request ............................................................. 250

Sample Customer API XML Messages .......................................................................................... 250Customer Message: Successful Add Request ....................................................................... 250Customer Message: Duplicate Add Request ........................................................................ 251Customer Message: Failure Add Request ............................................................................. 252Customer Message: Successful Change Request ................................................................. 253Customer Message: Failure Change Request ....................................................................... 254Customer Message: Failure Delete Request ......................................................................... 255

Inbound Customer Message (CWCustomerIn) ............................................................................ 256Outbound Customer Response Message (CWCustomerOut) .................................................... 302

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

Change Customer API Screen ......................................................................................................... 309

vii

Work with Customer API User Field Screen ................................................................................ 317Change Customer API User Field Screen ...................................................................................... 318Work with Customer API Email Screen ........................................................................................ 319Change Customer API Email Screen .............................................................................................. 320

Working with Merge/Purge Sold-to Names (MMCS) ................................................322Merge/Purge Customer Sold To Screen ................................................................................ 323

Submit Generation Window (Generating a List) ......................................................................... 325Ghost Customers ...................................................................................................................... 325Maximum Number of Source Customers ............................................................................. 325

Confirm Delete Window (Deleting a List) .................................................................................... 326Work with Source Customers Screen ............................................................................................. 326Create Target Customer Screen ...................................................................................................... 327Creating a Source Customer ............................................................................................................ 327Performing a Merge .......................................................................................................................... 328Display Customer Screen ................................................................................................................. 328Merge/Purge Logic ........................................................................................................................... 328

How are the Customer Tables Updated? ............................................................................. 331E-Commerce Customer Merge Web XML File (CustomerMergeWeb) .................................... 333

Sample E-Commerce Customer Merge Web XML Message (CustomerMergeWeb) ..... 334

Clearing Customer Sold To Status (MCST) ..............................................................336Confirm Clear of Customer Status Window ........................................................................ 336

Generic Customer History API...................................................................................337Typical Flow .............................................................................................................................. 337When is the Response Message Empty? ............................................................................... 339Setup Requirements ................................................................................................................. 340

Customer History Request XML Message (CWCustHistIn) ...................................................... 340Customer History Request Message: Sample XMLs ........................................................... 346

Customer History Response XML Message (CWCustHistOut) ................................................ 347Customer History Response Message: Sample XML .......................................................... 348

Detailed Order Inquiry Response XML Message (CWORDEROUT) ....................................... 351Detailed Order Inquiry Response Message: Sample XML ................................................. 369

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

Generic Inventory Inquiry API....................................................................................372Typical Flow .............................................................................................................................. 372When is the Response Message Empty? ............................................................................... 373Resolving the Item and SKU ................................................................................................... 373Setup Requirements ................................................................................................................. 374

Inventory Inquiry Request XML Message (CWInventoryInquiry) ........................................... 374Inventory Inquiry Request: Sample XML ............................................................................. 376

Inventory Inquiry Response XML Message (CWInventoryInquiryResponse) ........................ 377Inventory Inquiry Response: Sample XML .......................................................................... 387

Item Availability API ....................................................................................................389Item Availability API Setup ............................................................................................................ 389Item Availability API Process ......................................................................................................... 391

Resolving the Item and SKU ................................................................................................... 391Item Availability Web Service Errors .................................................................................... 392

Item Availability API: Sample Messages ...................................................................................... 393Successful Item Availability Request ..................................................................................... 393Unsuccessful Item Availability Request ................................................................................ 395

viii

Item Availability Request XML Message (CWItemAvailabilityWeb) ...................................... 396Item Availability Response XML Message (CWItemAvailabilityResponseWeb) ................... 400

E-Commerce Item Availability Processing ...............................................................410E-Commerce Availability Web API ............................................................................................... 412

E-Commerce Availability Web API Setup ............................................................................ 412E-Commerce Availability Web API Process ................................................................................. 413

E-Commerce Availability Web Service Errors ..................................................................... 414E-Commerce Item Availability Web API: Sample Messages ..................................................... 414

Successful E-Commerce Item Availability Web Request ................................................... 414Unsuccessful E-Commerce Item Availability Web Request .............................................. 416

E-Commerce Availability Web Request XML Message (AvailabilityWebRequest) ............... 416E-Commerce Availability Web Response XML Message (AvailabilityWebResponse) .......... 417E-Commerce Availability Web XML File (AvailabilityWeb) ..................................................... 418

Generic Inventory Download API...............................................................................426Inventory Download Process .......................................................................................................... 427

Creating Inventory Download Triggers through a Batch Process .................................... 428Creating Inventory Download Triggers Interactively Due to Changes in Availability . 428Creating Inventory Download Triggers through Purchase Order Creation or Maintenance .............................................................................................................................. 432Which Activities Generate Inventory Download Triggers? ............................................... 433Identifying Inventory Download Triggers ........................................................................... 435Inventory Download Processing ............................................................................................ 435Inventory Download Trigger Rules ....................................................................................... 436Item Warehouses Excluded from the Inventory Download .............................................. 437Inventory Download XML Inclusion ..................................................................................... 437Inventory Download Troubleshooting .................................................................................. 438

Inventory Download Setup ............................................................................................................. 439System Control Values Related to Inventory Download API ............................................ 440Menu Options Related to Inventory Download API .......................................................... 441

Inventory Download XML Message (CWInventoryDownload) ............................................... 441Sample Inventory Download XML Message ........................................................................ 448

Generic Item Download API .......................................................................................450Item/SKU Download Process .......................................................................................................... 450

Identifying Item Download Triggers ..................................................................................... 451When are Item Download Triggers Created? ....................................................................... 451Item/SKU Download Processing ............................................................................................ 452Item Outbound Trigger Activities .......................................................................................... 453Item Outbound Trigger Rules ................................................................................................. 458Item Trigger Cleanup ............................................................................................................... 458Processing Item Delete Triggers ............................................................................................. 459Item Outbound XML Inclusion .............................................................................................. 460

Order Management System Setup for the Item Download API ................................................ 465System Control Value .............................................................................................................. 466Menu Options ........................................................................................................................... 466Periodic Functions .................................................................................................................... 467

Item Download XML Message (CWItemOut) .............................................................................. 467Item Download Message: Sample XML ................................................................................ 528

E-Commerce-Related Setup in Oracle Retail Order Management System Cloud Service ................................. 531

ix

E-Commerce Setup ....................................................................................................532System Control Values Related to E-Commerce .......................................................................... 532Table Setup for Download ............................................................................................................... 534Additional Setup ............................................................................................................................... 534

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

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

Order Confirmation Emails .................................................................................................... 543Shipment and Return Confirmation Emails ......................................................................... 545Stored Value Card Notification Emails ................................................................................. 547Quote Confirmation Emails .................................................................................................... 548Membership Cancellations ...................................................................................................... 549Purchase Order Emails ............................................................................................................ 550Store Pickup Notifications ....................................................................................................... 550Oracle Retail Customer Engagement Loyalty Registration Notifications ........................ 551Other Email Notifications ........................................................................................................ 551Determining the Opt-in/out Setting ....................................................................................... 553Additional Information about Email Notifications ............................................................. 554

HTML Format Notification Samples and Contents ..................................................................... 554Order Confirmation Email Sample and Contents ............................................................... 555Shipment Confirmation Email Sample and Contents ......................................................... 558Return Confirmation Email Sample and Contents .............................................................. 560Backorder Notification Email Sample and Contents ........................................................... 561Credit Card Credit Acknowledgement Email Sample and Contents ............................... 564Soldout Notification Email Sample and Contents ............................................................... 566Stored Value Card Notification Sample and Contents ....................................................... 567“Contact Us” Notification Sample and Contents ................................................................. 570Credit Card Decline Notification Sample and Contents ..................................................... 571Quote Confirmation Email Sample and Contents ............................................................... 573Membership Cancellation Notification Sample and Contents .......................................... 575Cancellation Request Failure Email Sample and Contents ................................................ 576Order Cancellation Confirmation Email Sample and Contents ........................................ 577Order Line Cancellation Confirmation Email Sample and Contents ............................... 580Store Pickup Notification Sample and Contents .................................................................. 582Oracle Retail Customer Engagement Loyalty Registration Notification Sample and Contents 584Simple Format Notification Sample ....................................................................................... 585

Work with E-Mail Template Screen ............................................................................................... 585Change E-Mail Template Screen ..................................................................................................... 587

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

E-Commerce-Related Jobs in Order Management System590Downloading E-Commerce Static Tables (ESTF).....................................................591

E-Commerce Download Overview ................................................................................................ 592Types of Downloads ................................................................................................................ 592Periodic Functions Related to E-Commerce ......................................................................... 592Download Process .................................................................................................................... 592

x

Process E-Commerce Downloads Screen .............................................................................. 592Static Table Download Summary ................................................................................................... 595

Downloading E-Commerce Offer Files (EOFR) ........................................................598Process E-Commerce Downloads Screen .............................................................................. 598

Offer-Related Table Extract Summary ........................................................................................... 602E-Commerce Product Web XML File (ProductWeb) ................................................................... 609

Sample E-Commerce Product Web XML Message (ProductWeb) .................................... 623

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

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

E-Commerce Tables............................................................ 634E-Commerce Static Tables ............................................................................................................... 634

Company .................................................................................................................................... 634Country ...................................................................................................................................... 634State ........................................................................................................................................ 635Payment type ............................................................................................................................. 635Personalization .......................................................................................................................... 635Personalization detail ............................................................................................................... 635Personalization values ............................................................................................................. 636SCF/Ship via .............................................................................................................................. 636Shipping method ...................................................................................................................... 636Holiday arrival date ................................................................................................................. 636Return reason ............................................................................................................................ 636Cancel reason ............................................................................................................................ 637SCF state ..................................................................................................................................... 637

E-Commerce Offer Tables ................................................................................................................ 637Offer ........................................................................................................................................ 637Source ........................................................................................................................................ 637Class ........................................................................................................................................ 638Cross-Sell ................................................................................................................................... 638Department ................................................................................................................................ 638Extra shipping ........................................................................................................................... 638Hazard ........................................................................................................................................ 638Item ........................................................................................................................................ 639Item break point ........................................................................................................................ 639Item image ................................................................................................................................. 640Offer item link ........................................................................................................................... 640Offer SKU link ........................................................................................................................... 640SKU ........................................................................................................................................ 640SKU break point ........................................................................................................................ 641Keyword: ................................................................................................................................... 641Alias item ................................................................................................................................... 642Item ship via override .............................................................................................................. 642

Additional Downloads ..................................................................................................................... 642Gift certificate ............................................................................................................................ 642Ship exclusion ........................................................................................................................... 642

xi

Document Type Definitions (DTDs)................................... 644CWORDERIN .................................................................................................................................... 645CWORDEROUT ................................................................................................................................ 650CWCatRequest .................................................................................................................................. 654CWCatResponse ................................................................................................................................ 655CWReturnIn ....................................................................................................................................... 655CWReturnOut ................................................................................................................................... 656CWCancel ........................................................................................................................................... 656CWCustomerIn ................................................................................................................................. 657CWCustomerOut .............................................................................................................................. 658CWCustHistIn ................................................................................................................................... 659CWCustHistOut ................................................................................................................................ 660CWInventoryInquiry ........................................................................................................................ 660CWInventoryInquiryResponse ....................................................................................................... 661Item Availability Web Request ....................................................................................................... 662Item Availability Web Response .................................................................................................... 663Availability Web Request ................................................................................................................ 664Availability Web Request Response .............................................................................................. 664CWInventoryDownload .................................................................................................................. 664Item Download .................................................................................................................................. 666

xii

Send Us Your Comments

Order Management System E-Commerce Guide, Release 17.0.

Oracle welcomes customers' comments and suggestions on the quality and usefulness of this document.

Your feedback is important, and helps us to best meet your needs as a user of our products. For example:

• Are the implementation steps correct and complete?

• Did you understand the context of the procedures?

• Did you find any errors in the information?

• Does the structure of the information help you with your tasks?

• Do you need different information or graphics? If so, where, and in what format?

• Are the examples correct? Do you need more examples?

If you find any errors or have any other suggestions for improvement, then please tell us your name, the name of the company who has licensed our products, the title and part number of the documentation and the chapter, section, and page number (if available).

Note: Before sending us your comments, you might like to check that you have the latest version of the document and if any concerns are already addressed. To do this, access the Online Documentation available on the Oracle Technology Network Web site. It contains the most current Documentation Library plus all documents revised or released recently.

Send your comments to us using the electronic mail address: [email protected]

Please give your name, address, electronic mail address, and telephone number (optional).

If you need assistance with Oracle software, then please contact your support representative or Oracle Support Services.

If you require training or instruction in using Oracle software, then please contact your Oracle local office and inquire about our Oracle University offerings. A list of Oracle offices is available on our Web site at http://www.oracle.com.

xiii

Preface

The Order Management System E-Commerce Guide describes the process an administrator follows to set up essential data for the e-commerce integration.

AudienceThis E-Commerce Guide is intended for administrators who are responsible for web configuration.

Documentation AccessibilityFor information about Oracle’s commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/us/corporate/accessibility/index.html.

Access to Oracle SupportCustomers that have purchased support have access to electronic support at My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit

http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

Related DocumentsFor more information, see the following documents in the Order Management System documentation set:

• Release Notes

• Administration Guide

• Implementation Guide

• Online Help

• Reports Guide

See the Order Management System documentation library at the following URL:

http://www.oracle.com/technetwork/documentation/oracle-retail-100266.html

Customer SupportTo contact Oracle Customer Support, access My Oracle Support at the following URL:

https://support.oracle.com

http://www.oracle.com/us/corporate/accessibility/index.html

http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info

http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info

http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs


xiv

When contacting Customer Support, please provide the following:

• Product version and program/module name

• Functional and technical description of the problem (include business impact)

• Detailed step-by-step instructions to re-create

• Exact error message received

• Screen shots of each step you take

Improved Process for Oracle Retail Documentation CorrectionsTo more quickly address critical corrections to Oracle Retail documentation content, Oracle Retail documentation may be republished whenever a critical correction is needed. For critical corrections, the republication of an Oracle Retail document may at times not be attached to a numbered software release; instead, the Oracle Retail document will simply be replaced on the Oracle Technology Network Web site.

This process will prevent delays in making critical corrections available to customers. For the customer, it means that you must verify that you have the most recent version of the Oracle Retail documentation set. Oracle Retail documentation is available on the Oracle Technology Network at the following URL:


An updated version of the applicable Oracle Retail document is indicated by Oracle part number, as well as print date (month and year). An updated version uses the same part number, with a higher-numbered suffix. For example, part number E123456-02 is an updated version of a document with part number E123456-01.

If a more recent version of a document is available, that version supersedes all previous versions.

Oracle Retail Documentation on the Oracle Technology NetworkOracle Retail product documentation is also available on the following web site:


ConventionsThe following text conventions are used in this document:

Convention Meaning

boldface Boldface type indicates graphical user interface elements associated with an action, emphasis, screen names, or terms defined in text or the glossary.

italic Italic type indicates book titles, field labels, or placeholder variables for which you supply particular values.

monospace Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.



1

1E-Commerce Overview

The E-Commerce integration allows you to send data between Order Management System 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 processbetween Order Management System and your web storefront.

• E-Commerce Messages: The layout and description of each of the messagestransmitted between Order Management System and your web storefront.

• E-Commerce-Related Setup in Oracle Retail Order Management System CloudService: The setup in Order Management System related to the e-commerceintegration.

• E-Commerce-Related Jobs in Order Management System: The jobs that run withinOrder Management System to support the e-commerce integration.

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

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

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

Order Transaction

Types of E-Commerce Transactions 2

2Types of E-Commerce Transactions

The E-Commerce integration supports the following transactions.

• Order Transaction

• Order Reject Transaction

• Catalog Request Transaction

• Return Transaction

• Cancel Transaction

• Customer Transaction

• E-Commerce Customer Merge Web Download

• Order Status Transaction

• Customer History Transaction

• Inventory Inquiry Transaction

• Item Availability Transaction

• E-Commerce Item Availability Web Transaction

• Inventory Download Transaction

• Item Download Transaction

• E-Commerce Product Web Download

Order TransactionThe order transaction allows the web storefront to send order information to Order Management System. Order Management System 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 Order Management System 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.

• 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.

Order Reject Transaction


• 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? Order Management System 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, Order Management System 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, 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.

Order Reject TransactionThe order reject transaction allows the web storefront to send an order reject request to Order Management System.

Catalog Request Transaction


Process used: You can use the generic order interface (Order API) to send order reject transactions into Order Management System 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? Order Management System 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.

Catalog Request TransactionThe catalog request transaction allows a customer on the web storefront to send a catalog request to Order Management System.

Process used: You can use the CWServiceIn web service to receive and process a catalog request from the web storefront. The correct type for the E-Commerce Catalog Request Message (CWCatRequest) is CWCatRequest.

The e-commerce catalog request process:

• 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.

Return TransactionThe return transaction allows a customer to create a return on the web storefront for specific item(s) on a shipped order.

Return Transaction


Process used: You can use the RETURN_IN job, started through Work with Integration Layer Jobs (IJCT), 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 send_response field in the Return Request Message (CWReturnIn) is selected, the RETURN_IN job sends a Return Response Message (CWReturnOut) back to the external system, indicating if the return processed successfully or if an error occurred.

Errors: If there is an error, the RETURN_IN job creates a record in the Return Error table. You can review return errors in the Work with Return Interface Errors (WRIE) menu option.

Return authorization?

• When the RETURN_IN job processes an Return Request Message (CWReturnIn) that includes a return authorization to return against, the system will receive and credit the existing return authorization.

• If you are not returning against an existing return authorization, 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 OROB Drop Shipping (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.

Performing an exchange: In order to perform an exchange, you need to create the return using the Return Request Message (CWReturnIn) and then add the exchange item to a new order using the Generic Order Interface (Order API).

Creating a return that is not associated with an existing order: You can use the Generic Order Interface (Order API) to create a return that is not associated with an existing order. See Processing a Return for instructions.

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:

• Return Request Message (CWReturnIn)

• Return Response Message (CWReturnOut)

For more information: See Inbound Return API for processing details.

Cancel Transaction


Cancel TransactionThe 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 CWServiceIn web service to receive and process a cancel request from the web storefront. The correct type for the E-Commerce Cancel Request Message (CWCancel) is CWCancel.

The e-commerce cancellation process:

• determines if the cancel request contains any errors.

• if no errors are found, processes the cancellation.

Response returned? Order Management System 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 for processing details.

• Batch Order Cancel Errors for a list of errors.

Customer TransactionThe customer transaction allows the web storefront to send new or changed customer information to Order Management System.

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? Order Management System 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, Order Management 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

E-Commerce Customer Merge Web Download


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 Merge Web DownloadThe e-commerce customer merge web download allows Order Management System to send merged customer sold to information to the web storefront.

Process used: You can use Working with Merge/Purge Sold-to Names (MMCS) to perform the customer sold to merge/purge. If the Generate E-Commerce Customer Merge Staging Files (H86) system control value is selected, the system generates an E-Commerce Customer Merge Web XML File (CustomerMergeWeb) to send to the web storefront.

Errors: Any errors when generating the CustomerMergeWeb file are written to the Application log.

Message used: E-Commerce Customer Merge Web XML File (CustomerMergeWeb)

For more information: See Working with Merge/Purge Sold-to Names (MMCS).

Order Status TransactionThe order status transaction allows the web storefront to request order summary information from Order Management System. 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 CUST_HIST process, started through Work with Integration Layer Processes (IJCT), or the CWMessageIn web service, to process an order status transaction from the web storefront.

• Response returned? If the order status request includes a customer number and not a specific order number, Order Management System 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, Order Management System sends an order inquiry response to the web storefront. If the

Customer History Transaction


send_detail flag in the customer history request is Y, Order Management System sends a detailed order inquiry response to the web storefront; if the send_detail flag is N, Order Management System 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 Order Management System 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.

Customer History TransactionThe 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, Order Management System 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, Order Management System sends an order inquiry response to the web storefront. If the send_detail flag in the customer history request is Y, Order Management System sends a detailed order inquiry response to the web storefront; if the send_detail flag

Inventory Inquiry Transaction


is N, Order Management System 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 Order Management System received the request, but it was incomplete or invalid.

Messages used:







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

Inventory Inquiry TransactionThe 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.

Item Availability TransactionThe item availability transaction allows you 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 Order

E-Commerce Item Availability Web Transaction


Management System item and SKU codes; or, it can use the short SKU number, retail reference number, or UPC information.

Process used: The CWServiceIn web service allows an external system to post the Item Availability Request XML Message (CWItemAvailabilityWeb) directly to Order Management System and receive responses without the need of any queues.

Response returned? 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.

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.

Messages used:

• Item Availability Request XML Message (CWItemAvailabilityWeb)

• Item Availability Response XML Message (CWItemAvailabilityResponseWeb)

For more information: See Item Availability API.

E-Commerce Item Availability Web TransactionThe e-commerce availability web transaction allows you to inquire into the availability of items in a specific company, and optionally, offer.

You have the option to review item availability for each allocatable warehouse or to sum the item availability for an item across all allocatable warehouses.

Process used: The CWServiceIn Web Service allows an external system to post the E-Commerce Availability Web Request XML Message (AvailabilityWebRequest) directly to Order Management System and receive a response without the need of any queues.

Response returned? The Item Availability Web process in Order Management System receives the request, generates the E-Commerce Availability Web Response XML Message (AvailabilityWebResponse), and sends it to the web storefront. This message indicates to the web storefront whether the request processed successfully.

The Item Availability Web process includes the details of the item availability web request in an E-Commerce Availability Web XML File (AvailabilityWeb) located on the application server.

Errors: If the request fails, the response returns with an error message. See E-Commerce Availability Web Service Errors for a list of errors that may occur.

Messages used:

• E-Commerce Availability Web Request XML Message (AvailabilityWebRequest)

• E-Commerce Availability Web Response XML Message (AvailabilityWebResponse)

• E-Commerce Availability Web XML File (AvailabilityWeb)

For more information: See E-Commerce Item Availability Processing.

Inventory Download Transaction


Inventory Download TransactionThe inventory download transaction allows you to send inventory information from Order Management System to the web storefront. When certain inventory conditions are met, Order Management System 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 Order Management System when it receives an inventory download.

Message used: Inventory Download XML Message (CWInventoryDownload)

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

Item Download TransactionThe item download transaction allows you to capture item and SKU information to download to the web storefront.

Process used: If the Create Generic Item Download Trigger Records (I15) system control value is selected, 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 web storefront.

Response returned? The web storefront does not send a response to Order Management System when it receives an item download.

Message used: Item Download XML Message (CWItemOut)

For more information: See Generic Item Download API.

E-Commerce Product Web DownloadThe e-commerce product web download allows Order Management System to send product offer information to the web storefront.

Process used: You can use Downloading E-Commerce Offer Files (EOFR) to perform the product offer download. If the Generate E-Commerce Offer Tables (M29) system control value is unselected, the system generates an E-Commerce Product Web XML File (ProductWeb) to send to the web storefront.

Errors: Any errors when generating the ProductWeb download file are written to the Application log.

Message used: E-Commerce Product Web XML File (ProductWeb).

For more information: See Downloading E-Commerce Offer Files (EOFR).

- 12

11E-Commerce Messages

This section describes the XML messages between Oracle Retail Order Management System Cloud Service and the web storefront that support the e-commerce integration:

• Generic Order Interface (Order API); see Generic Order Interface (Order API) on page 2-13

• Rejecting the Order (Order API); see Rejecting the Order (Order API) on page 2-48

• E-Commerce Catalog Requests; see E-Commerce Catalog Requests on page 6-173

• Inbound Return API; see Inbound Return API on page 8-186

• E-Commerce Cancel Process; see E-Commerce Cancel Process on page 9-212

• Generic Customer API; see Generic Customer API on page 12-228

• Generic Customer History API; see Generic Customer History API on page 14-337

• Generic Inventory Inquiry API; see Generic Inventory Inquiry API on page 15-372

• Item Availability API; see Item Availability API on page 16-389

• E-Commerce Item Availability Processing; see E-Commerce Item Availability Processing on page 17-410

• Generic Inventory Download API; see Generic Inventory Download API on page 18-426

• Generic Item Download API; see Generic Item Download API on page 19-450

Generic Order Interface (Order API) 13

21Generic Order Interface (Order API)

Purpose: Use the generic order interface to send orders into Order Management System via an integration layer process (IJCT) 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.

• 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, or permanent ship-to customer.

In this chapter:

• Order API Processing Overview

- Suppressing Deposits and Refunds

- 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

- Customer Sold To Selection, Creation and Update

- Creating or Selecting Shipping Addresses or Customers

Order API Processing Overview


- Customer Bill To Selection and Creation

• 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

Order API Processing OverviewTypical 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

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 Order Management System 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 ORDER_CLN job also uses the order cross reference when it deletes abandoned orders.

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

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: If the message includes any payment information, 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



• 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, 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.

9. If payment is not sent on an order: If the message does not include payment information, 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.

Orders in error remain in a suspended/error 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.

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 ORDER_CLN 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 ORDER_CLN job does not include quotes. You will need to manually delete quotes that are incomplete in batch order entry.



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

• 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.

Set items: To include a set (other than a variable set) on an order created through the generic order API, the inbound order message should include the master set item only, and none of its components. The set 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 Order Management System online help for a complete discussion.

Suppressing Deposits and RefundsYou 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.

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.



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 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.

Creating a Quote through the Order APIThe 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.



- 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 Order Management System.

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

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 OrdersCredit card tokenization allows you to replace the credit card number with a token provided by the service bureau.

Order Management System 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.

For more information: See the Data Security and Encryption Guide for processing details.

Performing Online Credit Card Authorization on Web OrdersOnline 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 Order Management System 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 WebOrder Management System 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:

• 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.

• 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.

Typical Order Interface Scenarios


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.

Typical Order Interface ScenariosSome 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 Order Management System; 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

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

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

• Order Management System item information has been sent 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

Typical Order Interface Scenarios


• 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 MessageYou 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

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 Order Management System 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 Order Management System identifies the order.

• payment_only: set to Y

• response_type:

- set to D to generate the Detailed Order XML Response (CWORDEROUT);

Order API Setup Requirements


- 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 Order Management System cannot identify the order? To identify the order when it receives the payment-only message, the order API uses the following rules:

• Match on Order Management System order number?

- If the message includes both the rdc_order_nbr (Order Management System 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 Order Management System 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?

- 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>

Order API Setup RequirementsOverview: 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 ServiceThe CWOrderIn web service allows an external system to post the Inbound Order XML Message (CWOrderIn) directly to Order Management System and receive responses without the need of any queues.

Web service authentication? Use theWork with Web Service Authentication (WWSA) menu option to define a valid user for basic web service authentication. If you use Oracle Identity Cloud Service for password authentication, in addition to creating the web service authentication user in Work with Web Service Authentication (WWSA), you must also create a corresponding user profile in Oracle Identity Cloud Service and



assign the user to the corresponding web service role defined for the Order Management application.

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" >

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

</Items> </ShipTo>

</ShipTos> </Header>

</Message>

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

CWMessageIn Web ServiceYou 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.



Web service authentication? Use theWork with Web Service Authentication (WWSA) menu option to define a valid user for basic web service authentication. If you use Oracle Identity Cloud Service for password authentication, in addition to creating the web service authentication user in Work with Web Service Authentication (WWSA), you must also create a corresponding user profile in Oracle Identity Cloud Service and assign the user to the corresponding web service role defined for the Order Management application.

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 QueuesIf 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.

Default User for ORDER_INYour 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).

Order API-Related System Control Values


- 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).

Order API-Related System Control ValuesOverview: 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.

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.

Remote Order 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 ORDER_CLN job purges “abandoned” (partially created) e-commerce orders after the Time Limit for Suspended E-Commerce Orders (G43) has elapsed.

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.

Order API-Related System Control Values


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.

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.

E-Mail Order Confirmations for All Orders (H51)

Defines whether Order Management System 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 Order Management System 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, the system places the order in this order batch if it has errors. You can correct the errors in batch order entry.


Customer Creation, Matching and Update Logic in the Order API



Customer Sold To Selection, Creation and UpdateThe system uses the following basic logic in selecting a sold-to customer for the order (see below for exceptions and examples):

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.

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 Remote Order Values (F70) system control value), use the matching customer with the lowest customer number (customer created first); otherwise,

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 Remote Order Values (F70) system control value), use the matching customer with the lowest customer number (customer created first); otherwise,

5. Name and address match: If none of the above matches work, use the matching rules specified through the Remote Order 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,

6. 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.



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 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.

• 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.

Oracle Retail Customer Engagement customer integration: When you use the Oracle Retail Customer Engagement customer integration, if you create or update a customer through the order API, Order Management System sends the information about the customer to Oracle Retail Customer Engagement so that the customer records in the two systems are synchronized.



Creating or Selecting Shipping Addresses or CustomersIn 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



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 Remote Order Values (F70), the system uses the existing customer for the order.




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 Remote Order Values (F70).

- 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 Remote Order 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:• ship_to_type or Default Recipient Type for E-

Commerce Orders (H33) = 3

• 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:• ship_to_type or Default Recipient Type for E-

Commerce Orders (H33) = 3

• 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.




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 Remote Order 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 Remote Order Values (F70), the system uses the name and address information to create a new permanent ship-to for the order.

Customer Bill To Selection and CreationThe system uses the following logic in selecting a bill-to customer for an order:

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

Resolving the Item and SKU in the Order API


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.

Resolving the Item and SKU in the Order APIFor 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 sku

2. short_sku_number

3. retail_ref_number

4. upc_type and upc_code

5. 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.

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 Remote Order Values (F70), use that bill-to; or,

• If that information matches more than one existing bill-to customer based on the Remote Order 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,

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.

User-Defined Fields in the CWOrderIn Message


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.

User-Defined Fields in the CWOrderIn MessageOverview: 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

Selecting the Sales Rep


if it 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.

Selecting the Sales RepOverview: 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.

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 = 9

user_field_Label = SOURCE

yes, based on label

user_field_det_seq_number = blank

user_field_Label = SOURCE

yes, based on label


user_field_Label = SRC

yes, based on sequence number


user_field_Label = SRC

no (neither sequence number or label match)

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.

Discounted and Added Items in the CWOrderOut Response Message


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.

Discounted and Added Items in the CWOrderOut Response MessageWhen 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:

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.

sales_rep_number

sales_rep_name Result



• 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 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 Order Management System, 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 SummaryThe 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

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.

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.

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)





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.



Rejecting the Order (Order API)


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.

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

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 ORCE 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.

promotional pricing no no



Rejecting the Order (Order API)


• Order number

• Job: ORDREJTAPI

• User ID: your default user

• 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 ORDER_CLN job deletes abandoned orders if no reject message is received.

Order Interface XML Message Formats 50

31Order Interface XML Message Formats

In this chapter:

• 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 Order Management System Online Help for a complete discussion of the order API.

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.

• 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 Order Management System 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 Order Management System MQ Log for details.

Message Attribute

Type Length Comments

Message

One Message element is required.

source alpha IDC

target alpha RDC

type alpha CWORDERIN

resp_qmgr alpha 44 Not currently implemented.

resp_q alpha 44 Not currently implemented.

Header

One 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.

order_number alpha 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 Alternate order 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




offer_id alpha 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 Order Management System 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 alpha 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-only

If 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




source_code alpha 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




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




response_type alpha 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: A setting of E is valid in version 2.0, available in release 1.1 of Order Management System.

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.

See:

• 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

Message Attribute




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.

order_channel alpha 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, 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

alpha 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 alpha 8 Not implemented.

Message Attribute




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.

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 alpha 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 alpha 15 Maps to the First name field in the Customer Sold To table.

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

sold_to_lname alpha 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 alpha 3 Maps to the Suffix field in the Customer Sold To table.

Message Attribute




sold_to_company

alpha 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 alpha 1 Maps to the Delivery code field in the Customer Sold To table.

Valid values are:

• B = business

• R = residence

If 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




sold_to_address1

alpha 32 Maps to the Street address field in the Customer Sold To table.

Shipping to a Post Office Box

To 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

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

sold_to_address3

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

sold_to_address4

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

sold_to_apartment

alpha 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.

sold_to_city alpha 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.

Message Attribute




sold_to_state alpha 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 alpha 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.

sold_to_country alpha 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).

Message Attribute




sold_to_email alpha 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

alpha 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.

sold_to_day_

phone

alpha 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

alpha 14

Message Attribute




sold_to_fax_phone

alpha 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).

sold_to_opt_in alpha 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




sold_to_

address_ update

alpha 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.

allow_rent alpha 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 rent

N = do not allow rent

allow_email Not currently implemented.

Message Attribute




allow_mail alpha 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 mail

N = do not allow mail

nbr_ship_tos Not currently implemented.

Message Attribute




pay_incl alpha 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.

ind_number numeric 3 Not implemented.

Message Attribute




ind_dept alpha 3 Not implemented.

ind_position alpha 3 Not implemented.

ind_prefix alpha 3 Not implemented.

ind_fname alpha 15 Not implemented.

ind_initial alpha 1 Not implemented.

ind_lname alpha 25 Not implemented.

ind_suffix alpha 3 Not implemented.

ind_day_phone alpha 14 Not implemented.

ind_eve_phone alpha 14

ind_fax_phone alpha 14

ind_email_

address

alpha 50 Not implemented.

ind_opt_in alpha 2 Not implemented.

ind_mail_flag alpha 1 Not implemented.

ind_rent_flag alpha 1 Not implemented.

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.

Message Attribute




Note:

• If bill-to name and address information is specified in the following attributes, it is used to create a new bill-to customer 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.However, the order API sets certain required fields to their default settings automatically to prevent the order from being in error if all other bill-to information is valid, since these fields are not included in the CWOrderIn message. The fields and their default settings are:

- 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 alpha 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 alpha 15

bill_to_initial alpha 1

bill_to_lname alpha 25

bill_to_suffix alpha 3

bill_to_company_name

alpha 30

bill_to_address1

alpha 32

bill_to_address2

alpha 32

Message Attribute




bill_to_address3

alpha 32

bill_to_address4

alpha 32

bill_to_apt alpha 10

bill_to_city alpha 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 alpha 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 alpha 10 Required only if the Require postal code? flag is selected for the country.

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

bill_to_email alpha 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].

bill_to_day_phone

alpha 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

alpha

bill_to_fax_phone

alpha

bill_to_print_statement


bill_to_opt_in alpha 2 Not currently implemented.

Message Attribute




user_hold_reason

alpha 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.

batch_number numeric 12 Not implemented.

batch_date alpha 8 Not implemented.

batch_beg_end_flag


approve_batch alpha 1 Not implemented.

batch_order_

count

numeric 5 Not implemented.

batch_qty_

count


batch_prepaid_total

numeric 9.2 Not implemented.

order_type alpha 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




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 alpha 30 See Selecting the Sales Rep.

entered_by_

user

alpha 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 or if the user ID is invalid, your default user ID defaults.

Message Attribute




customer_class alpha 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 alpha 50 Updates the order-level email address. If no order_email is provided, the system uses the sold_to_email or existing primary email address for the sold-to customer.

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

ip_addr alpha 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

Message Attribute




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.

sold_to_price_group

alpha 4 The customer price group to assign to the sold-to customer.

Available in: 4.0 (release 2.5 of Order Management System).

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.

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




sales_rep_

store

alpha 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-for-pickup, 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.


ecommerce_id alpha 32 The customer number identifying the customer in the e-commerce site. Used as part of the Oracle Retail Customer Engagement customer integration to help synchronize customer information between Order Management System and Oracle Retail Customer Engagement.


Message Attribute




relate_cust_ sync_success

alpha 1 Indicates whether the e-commerce site has successfully synchronized information about the customer with Oracle Retail Customer Engagement. Used as part of the Oracle Retail Customer Engagement customer integration to help synchronize customer information between Order Management System and Oracle Retail Customer Engagement.


CustOwnership

If 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 alpha 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 alpha 40 A description of the product.

Updates the Description field in the Customer Ownership table.

Message Attribute




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.

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.

CustUserField

Use 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.

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.

Message Attribute




cust_usr_fld_label

alpha 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

alpha 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.

UserField

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

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.

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

usr_fld_data alpha 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.

Payment

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

Message Attribute




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

alpha 1 Updates the Suppress deposit field in the Order Payment Method table. Valid values are:

Y = Suppress deposit

N or blank = Do not suppress deposit

You can review the setting of this flag at the Display Order Pay Type screen (1 of 2).

suppress_

refund_flag

alpha 1 Updates the Suppress refund field in the Order Payment Method table.

Valid values are:

Y = Suppress refund

N or blank = Do not suppress refund

You can review the setting of this flag at the Display Order Pay Type screen (1 of 2).

cc_name Not currently implemented.

cc_type Not currently implemented.

Message Attribute




cc_number alpha 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).

Order Management System retains the case of the value passed in this field.

Required for credit card payment methods 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 Order Management System, the system encrypts the value in this field in the Order Management System database to provide additional security of credit card data. See the Data Security and Encryption Guide.

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.

Message Attribute




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 Not currently implemented.

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

defer_bill alpha 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

alpha 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




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 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 alpha 16 Used for credit card payment methods.

Oracle Retail Customer Engagement stored value card integration: If you are using the Oracle Retail Customer Engagement stored value card integration and the web order contains an approved Oracle Retail Customer Engagement stored value card pay type, the auth_number attribute should contain the transaction ID received from Oracle Retail Customer Engagement and not the authorization code received from Oracle Retail Customer Engagement.

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.

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.

Message Attribute




gc_type Not currently implemented.

gift_certificate_number

numeric 7 Not currently implemented.

gift_certificate_amount


expiration_date Not currently implemented.

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.

check_amount Not currently implemented.

checking_account

alpha 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. Order Management System 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.


Message Attribute




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.

card_issue_nbr alpha 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 Not currently implemented.

bml_version numeric 5 Not currently implemented.

birthdate numeric 8 Not currently implemented.

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




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: 4.0 (release 2.5 of Order Management System).

Message Attribute




already_

tokenized

alpha 1 Indicates whether the number in the cc_number tag is a token. See the Data Security and Encryption Guide.

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 Order Management System receives the web order; see the Security Guide for processing details.

Updates the Tokenized field in the Order Payment Method table.


cc_bin_nbr alpha 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.


Message Attribute




transaction_id alpha 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 Order Management System; 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.


Message Attribute




vendor_

response

alpha 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 Order Management System; 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




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.

Note: Order Management System 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.


Message Attribute




avs_response alpha 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 Order Management System; 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








Updates AUH AVS response in the Authorization History table.


Message Attribute




cid_response alpha 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 Order Management System; 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









ShipTo

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

Message Attribute




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 Reservation

The 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




cancel_bo alpha 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 alpha 30 Updates the Contact name field in the Order Ship To table.

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

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.

Message Attribute




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.


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.


Message Attribute




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.

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 alpha 1 Updates the Gift order flag in the Order Ship To table. Defaults to N if this value is not set to Y.

Message Attribute




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




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




resale_exempt_id

alpha 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 alpha 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.

calc_frt alpha 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)

Message Attribute




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.

ship_to_type alpha 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 order

If 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.

Message Attribute




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 customer

See 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 alpha 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 alpha 15

ship_to_initial alpha 1

ship_to_lname alpha 25

ship_to_suffix alpha 3

ship_to_company

alpha 30

Message Attribute




ship_to_address1

alpha 32 Shipping to a Post Office Box




ship_to_address2

alpha 32

ship_to_address3

alpha 32

ship_to_address4

alpha 32

ship_to_apartment

alpha 10

ship_to_city alpha 25

ship_to_state alpha 2 Required only if the Require state? flag is selected for the country.

ship_to_zip alpha 10 Required only if the Require postal code? flag is selected for the country.

ship_to_country alpha 3 Required if a ship-to address is provided.

Message Attribute




ship_to_email alpha 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 alpha 1 Valid values are:

• B = business

• R = residence

ship_to_day_phone

alpha 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

alpha

ship_to_fax_phone

alpha

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.

Message Attribute




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-To

1. 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.

ship_to_po_

number

alphanumeric

15 Updates the Purchase order # field in the Order Ship To table.

gift_message N/A N/A Not currently implemented.

Message Attribute




promotion alpha 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 alpha 12 The store code where the customer wants to pick up a ship-for-pickup 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.


Message Attribute




delivery_type alpha 1 A setting of P identifies a store pickup order, and a setting of S identifies a ship-for-pickup 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-for-pickup 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 for Pickup.


Validation of the store_code and delivery_type:

• If the delivery_type is S (ship-for-pickup) or P (store pickup) and the store_code is a valid store, creates a ship-for-pickup 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-for-pickup order, or do a store pickup search for a store pickup order.)

alternate_ship_to_id


add_chg_count Not currently implemented.

Message Attribute




already_eval_by_promote

alpha 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.


promote_maint alpha 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.


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 ORCE Loyalty (M06) and Prorate Dollar Discounts and Coupons (D90) system control values are selected.


Message Attribute




AdditionalCharge

The AdditionalCharges element, if provided, can include one or more AdditionalCharge elements.

additional_charge_seq_nbr

numeric 3 Not currently implemented.

additional_charge_code

alpha 2 Updates the Add’l chg code in the Order Additional Charge table. 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_Msg

The 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 alpha 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 alpha 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




Promotion

If 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

alpha 7 The promotion code to apply to the order. See the description of the Promotion element, above, for more information.

Certificate

Not implemented.

certificate_number


certificate_amount

numeric 7.2 Not implemented.

transaction_id alpha 40 Not implemented.

Item

The Items element can include one or more Item elements. At least item is required.

Note: To create an order that includes a set item, the message should include the master set item only. The set will be "exploded" once the order is created, and all of the component items will be added to the order.

Message Attribute




drop_ship alpha 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 Oracle Retail Order Broker.

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 alpha 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

alpha 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




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 Reservation

The 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.

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.

Message Attribute




prc_ovr_rsn alpha 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.

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.

Message Attribute




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 alpha 1 Updates the Bypass reservation field in the Order Detail table, and prevents the line from being reserved when set to Y.

tax_override alpha 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 an external tax system 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.

Message Attribute




tax_amount numeric 10.5 Updates the Tax field in the Order Detail table if the tax_override flag is set to Y.

The system uses the tax amount to calculate the tax rate for the tax override using the following calculation:

(tax amount / extended amount) x 100 = tax override rate

The system stores the tax rate for the tax override in the ODT Tax Override Rate field in the Order Detail table; the system uses the tax rate during Order Maintenence if you use the Discount Price window to apply a discount to a shipped item. Billing also uses this tax rate to create the credit invoice and calculate the tax credit amount using the new tax amount.

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 logic

Note: 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.

The system uses the GST amount to calculate the GST tax rate for the tax override using the following calculation:

(GST amount / extended amount) x 100 = GST override rate

The system stores the GST tax rate for the GST tax override in the ODT GST Tax Override Rate field in the Order Detail table; the system uses the GST tax rate during Order Maintenence if you use the Discount Price window to apply a discount to a shipped item. Billing also uses this GST tax rate to create the credit invoice and calculate the tax credit amount using the new tax amount.

Message Attribute




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 logic

Note: 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.

The system uses the PST amount to calculate the PST tax rate for the tax override using the following calculation:

(PST amount / extended amount) x 100 = PST override rate

The system stores the PST tax rate for the PST tax override in the ODT PST Tax Override Rate field in the Order Detail table; the system uses the PST tax rate during Order Maintenence if you use the Discount Price window to apply a discount to a shipped item. Billing also uses this PST tax rate to create the credit invoice and calculate the tax credit amount using the new tax amount.

gift_wrap alpha 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.

Message Attribute




line_freight_override

alpha 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.

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

alpha 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




personalization_id

alpha 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




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.

alias_item alpha 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.

Message Attribute




item_id alpha 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 Order Management System. See Resolving the Item and SKU in the Order API.

Note:

• To create an order that includes a set item, the message should include the master set item only. The set 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.

sku alpha 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 alpha 3

upc_code alpha 14

Message Attribute




line_offer alpha 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

alpha 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.

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




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.

Message Attribute




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 alpha 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




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

alpha 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 alpha 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 alpha 2 Not currently implemented.

pickup_system_location

alpha 10 Not currently implemented.

pickup_location alpha 10 Not currently implemented.

line_entered_date


line_entered_time


Message Attribute




line_hyperlink alpha 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: Version 4.0 (release 2.5 of Order Management System).

Lin_Msg

The Lin_Msgs element, if provided, can include one or more Lin_Msg elements.

lin_msg_code alpha 1 Updates the Print? field in the Order Line Message table.

lin_msg_text alpha 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




personalization_line

The 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.

See the sample message formats under Inbound Order Message: Sample XMLs.

personalization_type

alpha 1 Indicates the type of special handling.

Valid values are:

• C = Custom

• S = Standard

Note: 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




personalization_text

alpha 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 alpha 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.

CouponDetail


Message Attribute




coupon_detail_code

alpha 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.

Profile

The 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).


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.


• 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




Inbound Order Message: Sample XMLsSamples 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" >

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


<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>

profile_value alpha 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.


• 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.

Coupon


coupon_code alpha 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




</ShipTo> </ShipTos>

</Header> </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> <Payment payment_type="45" cc_number="************1111" start_date="0108" card_issue_nbr="2" />

</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" 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>

</ShipTos>



</Header> </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="************1111" 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>

</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="************1111" 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>

Detailed Order XML Response (CWORDEROUT)


</Items></ShipTo>

</ShipTos></Header>

</Message>


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 Type Length Comments

Message

source alpha Identifies the source of the XML message. RDC indicates the XML message originates from Order Management System.

target alpha Identifies the target of the XML message.

type alpha 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

alpha 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.


alpha 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.

bill_me_later_ind


order_status alpha 1 The current status of the order.

Valid values are:

• H = Held

• S = Suspended

• E = In error

Included only if the status is not open (blank).

Note: If the Delay Order API Edit (I56) system control value is selected, the status returned will always be E because the system sends the response message before the order edit completes.

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.

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 alpha 9 The source_code assigned to the order.

offer_id alpha 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 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_address2

alpha 32

sold_to_address3

alpha 32

sold_to_address4

alpha 32

sold_to_apartment

alpha 10

sold_to_city alpha 25

sold_to_state alpha 2

sold_to_state_description

alpha 25 As set up through Working with Countries (WCTY).

sold_to_zip alpha 10

sold_to_country alpha 3

sold_to_day_phone

alpha 14




sold_to_eve_phone

alpha 14

sold_to_fax_phone

alpha 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 alpha 1

allow_mail alpha 1

sold_to_opt_in alpha 2

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.

bill_to_prefix alpha 3





bill_to_company

alpha 30

bill_to_busres alpha 1

bill_to_address1

alpha 32

bill_to_address2

alpha 32

bill_to_address3

alpha 32

bill_to_address4

alpha 32

bill_to_apartment

alpha 10

bill_to_city alpha 25

bill_to_state alpha 2

bill_to_state_description

alpha 25 As set up through Work with Countries (WCTY).

bill_to_zip alpha 10

bill_to_country alpha 3




bill_to_day_phone

alpha 14

bill_to_eve_phone

alpha 14

bill_to_fax_phone

alpha 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.


sales_rep_name alpha 30 The name of the salesman assigned to the order.

From the SLS Name field in the Salesman table.


sales_rep_store alpha 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.


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.




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. See the Data Security and Encryption Guide for an overview.

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.

cc_last_four numeric 4 The last four digits of the credit card number on the order.

From the IPM CC Last 4 field in the Order Payment Method table.


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.

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.




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 alpha 3





ship_to_

company

alpha 30

ship_to_busres alpha 1

ship_to_address1

alpha 32

ship_to_address2

alpha 32

ship_to_address3

alpha 32

ship_to_address4

alpha 32

ship_to_apartment

alpha 10





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.





delivery_type alpha 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 available

Ship for Pickup = the order is shipped to a store location, where the customer picks it up after arrival

The ship-to address indicates the selected store for either a store pickup or a ship-for-pickup 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 alpha 1 C = the item is cancelled.

P = the item is a store pickup item; see .

S = the item is sold out.

X = the item is closed.

item_id alpha 12 Always passed.

item_description

alpha 40 The description of the item.

sku alpha 14 Passed 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.

original_retail_price

numeric 7.2 The original retail price from the SKU table.

drop_ship alpha 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 alpha 2 Set to SP for a store pickup order.


alpha 10 A code identifying the system associated with the store pickup location. From the Name in OROB for Point of Sale (L09) system control value. Passed only for a store pickup order.

pickup_location alpha 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.

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.

set_main_item alpha 1 Indicates whether the item is the main item of a set:

Y = a main set item

N = not a main set item


set_component_item

alpha 1 Indicates whether the item was added to the order as a component of a set:

Y = a set component

N = not a set component





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.


sku_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.


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.


broker_status alpha 15 A status of Acknowledged indicates that a store pickup order has been submitted to Oracle Retail Order Broker, where it was created successfully. Otherwise, not used as part of the generic order interface (order API).





line_locate_eligible

alpha 1 Indicates if a backordered line meets the rules for a brokered backorder:

• the Send B/O to OROB (K08) system control value is selected

• the item is flagged as OROB 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 (K12) 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)




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.


gift_wrap alpha 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.


Shipment

The 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.




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, Order Management System 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.




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 Order Management System.Available in: 6.0 (release 3.5 of Order Management System).

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: 6.0 (release 3.5 of Order Management System).

SpecialHandlingFormat

The 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.

See personalization_id for more information on adding special handling to an item using the Inbound Order XML Message (CWORDERIN).


custom special handling:

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: 8.0 (release 4.7 of Order Management System).




special_handling_code

alpha 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: 8.0 (release 4.7 of Order Management System).

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: 8.0 (release 4.7 of Order Management System).

special_format_label

alpha 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: 8.0 (release 4.7 of Order Management System).

special_format_text

alpha 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: 8.0 (release 4.7 of Order Management System).

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: 8.0 (release 4.7 of Order Management System).

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: 8.0 (release 4.7 of Order Management System).

special_handling_information

alpha 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: 8.0 (release 4.7 of Order Management System).

Promotion

The 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.





promotion_

type_code

alpha 2 A code used to identify the type of promotion applied to the order. Valid values:

AA = additional charge on additional freight

promotion

AV = ship via override on additional freight promotion

FA = additional charge on freight promotion

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

FF = free freight

FO = freight override

FV = ship via override on freight promotion

OA = additional charge on order promotion

OV = ship via override on order promotion

PI = package insert

PT = premium

RA = additional charge on offer promotion

RG = free gift on offer promotion

SA = additional charge on source

promotion

SG = free gift on source promotion

TA = additional charge on tiered promotion

TG = free gift on tiered promotion

See 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.




promotion_type_code_desc

alpha 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.




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

alpha 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.




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.


• 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.


• 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

alpha 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.




promotion_shipping_method

numeric 2 The ship via for the order ship to after the promotion has been applied to the order.


• 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

alpha 30 The description of the ship via that was assigned to the order as a result of the

promotion.

From the Shipper name field in the Ship Via table.

promotion_item_id

alpha 12 A code for the item that was added to the order as a result of a free gift, premium, or package insert.


• 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

alpha 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.




promotion_sku alpha 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.




• PT (premium)




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

alpha 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.




• PT (premium)




From the Offer price field in the Order Detail table.




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.



• PT (premium)




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_Msg

The 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).


ord_msg_text alpha 60 The text for an order message whose Print flag is G Gift Message.

From the Message field in the Order Message table.


ord_msg_code alpha 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.





Detailed Order Response Message: Sample XMLA 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" 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"/>


Error

The response message includes any errors on the order if the response_type sent in the CWOrderIn message is E.


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 method

DTLS = 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 80 The description of the error. See Order Creation Errors for a listing and more information.


Order Acknowledgement XML Message (CWORDEROUT)


<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>

</ShipTos> </Header>

</Message>

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

source alpha Identifies the source of the XML message. RDC indicates the XML message originates from Order Management System.


Order Reject Request Message (CWORDERREJECT)


Order Acknowledgement Message: Sample XMLA 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>

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.

type alpha 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

alpha 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.


alpha 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





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.

Order Reject Request Message: SampleThe 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

source alpha Identifies the source of the XML message.


type alpha 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.

order_number alpha 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 Order Management System.



</Message>

Order Reject Response Message: SamplesThe 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.

Order Creation Errors 163

41Order Creation Errors

Purpose: The following table describes errors that can occur when you create orders through the order API. These errors might be 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 Order Management System, 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.

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.

BZ Invalid Additional Charge

The additional_charge_code is not a valid additional charge code in the Additional Charge table.

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.

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 Order Management System, 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 Order Management System, or if there is no entered_by_user specified in the message, the system checks the secured feature authority of your default user

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-for-pickup 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.

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.

I3 Bill Me Later 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.

SA Non-CC on Ship for Pickup

The Payment at POS for Ship to Store (L60) system control value is selected, this is a ship-for-pickup 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.

S1 Store Fulfillment Loc Msg

No store_code was passed for a store pickup order.

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-for-pickup or store pickup order is not a valid code as set up through Work with Store Cross Reference (WSCR).

S8 Invalid Delivery Type

The delivery_type was not set to P (store pickup) or S (ship-for-pickup).

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 OROB eligible.

• items on the order that have gift wrap or special handling instructions.

• mutliple ship to addresses exist on the order with pickup information.

• 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.

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 Not currently implemented.

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 #


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


Z1 No Detail lines No items were specified for the order.

Z2 No Paytypes for Order

No payment methods have been provided.



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.

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; see the Data Security and Encryption Guide.

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 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.


Translating Special Characters 172

51Translating 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, Order Management System 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, Order Management System 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 &

E-Commerce Catalog Requests 173

61E-Commerce Catalog Requests

Purpose: The CWServiceIn web service allows an external system to post the E-Commerce Catalog Request Message (CWCatRequest) directly to Order Management System and receive responses without the need of any queues.

The main purposes of the e-commerce catalog request job:

• receive and process catalog requests for sold to customers.

• create the sold to customer if the customer does not exist.

• update the sold to customer if the customer information is updated.

Additionally, if the response_required field is Y, 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 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.

Oracle Retail Customer Engagement customer integration: When you use the Oracle Retail Customer Engagement customer integration, if you create a customer through a catalog request, Order Management System sends the customer information to Oracle Retail Customer Engagement so that the customer records in the two systems are synchronized.

In this chapter:

• E-Commerce Catalog Request Setup

• Customer Creation/Update Logic in E-Commerce Catalog Requests

- Creating/Updating Sold To Customers in E-Commerce Catalog Requests

- E-Commerce Catalog Request Response

• E-Commerce Catalog Request Message (CWCatRequest)

E-Commerce Catalog Request Setup


• E-Commerce Catalog Request Response Message (CWCatreqResponse)

E-Commerce Catalog Request SetupThe CWServiceIn web service allows an external system to post the E-Commerce Catalog Request Message (CWCatRequest) directly to Order Management System and receive responses without the need of any queues.

Web service authentication? Use the Working with Web Service Authentication (WWSA) menu option to define a valid user for basic web service authentication. If you use Oracle Identity Cloud Service for password authentication, in addition to creating the web service authentication user in Work with Web Service Authentication (WWSA), you must also create a corresponding user profile in Oracle Identity Cloud Service and assign the user to the corresponding web service role defined for the Order Management application.

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 ServiceThe 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 E-Commerce Catalog Request Message (CWCatRequest) to the URL, or endpoint, specified in the wsdl. The CWServiceIn web service routes the messages sent to the endpoint and dispatches them to the E-Commerce Cancel process. When the E-Commerce Cancel process generates a response, 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 Order Management System process, so the CWServiceIn web service can route the message appropriately. The correct type for the E-Commerce Catalog Request Message (CWCatRequest) is CWCatRequest.

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 CWServiceIn is the name of the web service to call.

Sample Inbound Message in SOAP EnvelopeThe CWServiceIn web service requires that the inbound messages be embedded in SOAP envelope tags. A sample E-Commerce Catalog Request Message (CWCatRequest) 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[

E-Commerce Catalog Request Setup


<Message type="CWCatRequest" target="string" source="string"><CatRequest sold_to_opt_in="O1" sold_to_fax_phone="5085550100" sold_to_evening_phone="5085550101" sold_to_day_phone="5085550102" allow_mail="N" allow_email="N" allow_rent="N" sold_to_email="[email protected]" sold_to_zip="01581" sold_to_country="US" sold_to_state="MA" sold_to_city="Westborough" sold_to_apartment="1A" sold_to_address4="Address line 4" sold_to_address3="Address line 3" sold_to_address2="Address line 2" sold_to_address1="1234 Sample St" sold_to_busres="B" sold_to_company="Catalog Request" sold_to_suffix="" sold_to_lname="Brown" sold_to_initial="R" sold_to_fname="Thomas" sold_to_prefix="Mr" source_code="SOURCE" offer_id="001" response_required="Y" company_code="7">

<CustOwnerships><CustOwnership cust_own_confirm_date="07212015" cust_own_entry_date="07212014" cust_own_active="Y" cust_own_desc="2014 Subaru Outback" cust_own_ID="CAR"/><CustOwnership cust_own_confirm_date="01011986" cust_own_entry_date="12191985" cust_own_active="Y" cust_own_desc="1967 RAISED RANCH" cust_own_ID="HOUSE"/><CustOwnership cust_own_confirm_date="07212015" cust_own_entry_date="07212014" cust_own_active="Y" cust_own_desc="2011 SEA RAY" cust_own_ID="BOAT"/>

</CustOwnerships></CatRequest>

</Message>


Setup for the CWServiceIn RESTful Web ServiceYou POST the E-Commerce Catalog Request Message (CWCatRequest) 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 E-Commerce Cancel process. When the E-Commerce Cancel process generates a response, the CWServiceIn web service routes the response.

Message type: The type attribute in the inbound message identifies the Order Management System process, so the CWServiceIn web service can route the message appropriately. The correct type for the E-Commerce Catalog Request Message (CWCatRequest) is CWCatRequest.

Determine the endpoint: The individual URL for the CWServiceIn RESTful service uses the following format: http://server:port/SerenadeSeam/sxrs/application/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 ServiceThe CWServiceIn RESTful web service does not require that inbound messages be embedded in SOAP envelope tags. A sample E-Commerce Catalog Request Message (CWCatRequest) when using a RESTful web service is presented below.

<Message type="CWCatRequest" target="string" source="string"><CatRequest sold_to_opt_in="O1" sold_to_fax_phone="5085550100" sold_to_evening_phone="5085550101" sold_to_day_phone="5085550102" allow_mail="N" allow_email="N" allow_rent="N" sold_to_email="[email protected]" sold_to_zip="01581" sold_to_country="US" sold_to_state="MA" sold_to_city="Westborough" sold_to_apartment="1A" sold_to_address4="Address line 4" sold_to_address3="Address line 3"

Customer Creation/Update Logic in E-Commerce Catalog Requests


sold_to_address2="Address line 2" sold_to_address1="1234 Sample St" sold_to_busres="B" sold_to_company="Catalog Request" sold_to_suffix="" sold_to_lname="Brown" sold_to_initial="R" sold_to_fname="Thomas" sold_to_prefix="Mr" source_code="SOURCE" offer_id="001" response_required="Y" company_code="7">



</Message>

Customer Creation/Update Logic in E-Commerce Catalog RequestsIn addition to creating a catalog request, the E-Commerce Catalog Request Message (CWCatRequest) allows you to create or update a sold to customer.

Creating/Updating Sold To Customers in E-Commerce Catalog RequestsCreation 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.

E-Commerce Catalog Request Response


• 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.

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.

E-Commerce Catalog Request ResponseThe 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 and customer 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.

E-Commerce Catalog Request Message (CWCatRequest)

178


The E-Commerce Catalog Requests job 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 customers.

• create the sold to customer if the customer does not exist.

• update the sold to 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 using this message; see Customer Creation/Update Logic in E-Commerce Catalog Requests.

Attribute Name Type Length Comments

Message


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 Order Management System.

type alpha Identifies the type of information in the XML message. CWCatRequest indicates the message contains a catalog request.

CatRequest

One 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.


179

response_required

alpha 1 Y 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.

If both a source code and offer code have not been defined for the catalog request, Order Management System defaults the source code defined in the Default Source Code for Batch Catalog Requests (D37) system control value to the catalog request.

Maps to the SRC Source code field in the Catalog Request table.

The sold_to fields represent the sold to customer. If the sold to customer does not exist in Order Management System, 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 sold_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.

sold_to_prefix alpha 3 The prefix of the sold to customer.

Maps to the NAM Prefix field in the Customer Sold To table.

sold_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.

sold_to_initial alpha 1 The middle initial of the sold to customer.

Maps to the NAM Initial field in the Customer Sold To table.

sold_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.



180

sold_to_suffix alpha 3 The suffix of the sold to customer.

Maps to the NAM Suffix field in the Customer Sold To table.

sold_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.

sold_to_busres alpha 1 A code that identifies the address as a business or residence.

B = Business

R = Residence

Maps to the NAM Delivery code field in the Customer Sold To table.

sold_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.

sold_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.

sold_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.

sold_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.

sold_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.

sold_to_city alpha 25 The city of the sold to customer address.

Maps to the NAM City field in the Customer Sold To table.



181

sold_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.

sold_to_country alpha 3 The country code of the sold to customer address.

If a country code is missing from the catalog request, Order Management System defaults the country code defined in the Default Country for Customer Address (B17) system control value to the catalog request.

Maps to the RPR Country field in the Customer Sold To table.

sold_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.

sold_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_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.



182

sold_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.

sold_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.

sold_to_third_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.

sold_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.

If the catalog request does not contain a value in the sold_to_opt_in flag, the system defaults the value defined in the Default Opt In/Opt Out Flag (G97) system control value.

Maps to the CST E-mail status field in the Customer Sold To table.

CustOwnership

The 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.



183

E-Commerce Catalog Request Message: Sample XMLA sample of the E-Commerce Catalog Request Message (CWCatRequest) in XML format is presented below.

<Message type="CWCatRequest" target="string" source="string"><CatRequest sold_to_opt_in="O1" sold_to_fax_phone="5085550100" sold_to_evening_phone="5085550101" sold_to_day_phone="5085550102" allow_mail="N" allow_email="N" allow_rent="N" sold_to_email="[email protected]" sold_to_zip="01581" sold_to_country="US" sold_to_state="MA" sold_to_city="Westborough" sold_to_apartment="1A" sold_to_address4="Address line 4" sold_to_address3="Address line 3" sold_to_address2="Address line 2" sold_to_address1="1234 Sample St" sold_to_busres="B" sold_to_company="Catalog Request" sold_to_suffix=""

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.


E-Commerce Catalog Request Response Message (CWCatreqResponse)

184

sold_to_lname="Brown" sold_to_initial="R" sold_to_fname="Thomas" sold_to_prefix="Mr" source_code="SOURCE" offer_id="001" response_required="Y" company_code="7">



</Message>


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.


Message


source alpha Identifies the source of the XML message. RDC indicates the XML message is from Order Management System.

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.


185

E-Commerce Catalog Request Response Message: Sample XMLA 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" />

</Message>

CWCatreqResponse

One CWCatreqResponse element is required.

company_code numeric 3 A code for the company associated with the catalog request.

From the CMP Company field in the Catalog Request table.

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.


Inbound Return API 186

81Inbound Return API

Purpose: Use the inbound return API to create and process a return against an order detail line, based on XML messages from an external system. The RETURN_IN job in Work with Integration Layer Processes (IJCT) processes return API requests.

Retail pickup or delivery orders: Unless the Suppress Returns for Retail Pickup/Delivery (L88) system control value is selected, you can process a return against a retail pickup or delivery order; however, shipping the order deactivates the Order Broker Payment Type (K98) applied to these orders, so you would first need to enter a new payment method in order to process the related refund.

Note: You cannot process an exchange against a retail pickup or delivery order.

The system does not send a status update to the Order Broker when you process a return against a retail pickup or delivery order.

Ship-for-pickup orders: Unless the Payment at POS for Ship to Store (L60) system control value is selected, you can process a return for a ship-for-pickup order.

Store pickup orders: You cannot process a return against a store pickup order.

In this chapter:

• Process Overview

- Identifying the Order

- Identifying the Order Line

- Returning Against an Existing Return Authorization

- Determining the Return Warehouse and Location

- Suppressing Refunds

- Tax Overrides and Return Processing

- Return API Errors

• Return API Setup

- System Control Values

- Menu Options

- Secured Features

- CWMessageIn Web Service

Process Overview


• Return Request Message (CWReturnIn)

- Return Request Message: Sample XML

• Return Response Message (CWReturnOut)

- Return Response Message: Sample XML

Process OverviewPurpose: You can use the generic return API to create, receive, and credit a return for a specified ship to order line.

The steps are:

Performing an exchange: In order to perform an exchange, you need to create the return using the Return Request Message (CWReturnIn) and then add the exchange item to a new order using the Generic Order Interface (Order API).

Creating a return that is not associated with an existing order: You can use the Generic Order Interface (Order API) to create a return that is not associated with an existing order. See Processing a Return for instructions.

Identifying the OrderIn order to create a return using the Return Request Message (CWReturnIn), you must identify the Order Management System order associated with the return. You can identify the order by passing a value in one of the following fields:

• ecom_order_nbr, to specify the alternate order number from an outside system that is associated with the order. Orders from the web storefront and CWStore update this field. The e-commerce order number is stored in the E-Commerce order number field in the Order Header Extended table.

1. An external system sends a Return Request Message (CWReturnIn) to Order Management System, using a queue specified for the RETURN_IN job.

2. The RETURN_IN job in Work with Integration Layer Processes (IJCT) processes the return.

• If there is an error, the RETURN_IN job creates a record in the Return Error table. You can review return errors in the Work with Return Interface Errors (WRIE) menu option.

Note: If the SECRISK periodic function deactivated the payment methods on the order, the Return Response Message (CWReturnOut) returns the message No active paytypes. You cannot process the return unless you enter a different pay type for the order.

• If there are no errors, the RETURN_IN job creates and receives and sends the return to the Billing Async to create the credit invoice. You can view the return in Work with Return Authorizations (WRTA).

3. If the send_response field in the Return Request Message (CWReturnIn) is selected, the RETURN_IN job sends an Return Response Message (CWReturnOut) back to the external system, indicating if the return processed successfully or if an error occurred.

Process Overview


• ohd_order_nbr, to specify the Order Management System order number.

In addition, you must define which ship to is associated with the return by passing a value in the ship_to_nbr field.

Identifying the order and ship to number is required in order to process an inbound return.

Identifying the Order LineYou must create the return against an existing Order Management System order detail line. You can identify the order line to return against using the following fields:

• odt_seq_nbr: The order detail line sequence number defined in the Order Detail table.

• ra_nbr and ra_line_nbr: The return authorization number and return authorization line number defined in the RA Detail table. See Returning Against an Existing Return Authorization for additional information.

• item and sku: The item number, defined in the Item table. If the item is a SKUed item, you must also specify the SKU code, defined in the SKU table.

• short_sku: The short SKU for the item, defined in the SKU table.

• retail_ref_nbr: The retail reference number for the item, defined in the SKU table.

• upc_type and upc_code: The UPC type and UPC code for the item, defined in the Item UPC table. Note: Include any leading zeros. For example, if the UPC code is 06012011, pass 06012011 and not 6012011.

• alias: The alias code for the item, defined in the Page Letter Alias table. If the item is a SKUed item, you must pass sku along with alias in order to find the correct item and SKU code.

Note: If you pass information in a combination of the above fields, all of the information must be valid for a specific order detail line on the specified ship to order; otherwise, the return request will error: Invalid Order Detail Line.

What if the item exists on more than 1 order line? If the item exists on more than 1 order line, the system returns the item against the first order detail line, in order line sequence, that has enough quantity available to return to meet the return request.

Example: The RETURN_IN job receives an Return Request Message (CWReturnIn) against a ship to order for item AB101 for a quantity of 2. The order includes the following order lines.

Order line Item Shipped qty Results

1 AB101 1 The system creates and processes a return against order line 3 for a quantity of 2. 2 BC202 2

3 AB101 5

4 AB101 2

Process Overview


Using the example above, you will receive an error if you try to return item AB101 for a quantity of 6 since none of the order lines for item AB101 has a shipped quantity of 6 that is available to return. The system will not return against multiple order detail lines.

Returning Against an Existing Return AuthorizationWhen the RETURN_IN job processes an Return Request Message (CWReturnIn) that includes a return authorization to return against, the system will receive and credit the existing return authorization.

In order to process a return against an existing return authorization, you must identify the following in the Return Request Message (CWReturnIn):

• the order number to return against (ecom_order_nbr or ohd_order_nbr)

• ship to number (ship_to_nbr)

• RA number and RA line number (ra_nbr and ra_line_nbr)

If you are using standard return authorization processing (the Use Streamlined Return Authorizations (F44) system control value is unselected and:

• the return is created, but not yet received, the system will receive and credit the return.

• the return is received, but not yet credited, the system will credit the return.

If the existing RA has already been completely processed or you are using streamlined return authorization processing (the Use Streamlined Return Authorizations (F44) system control value is selected), the Return Response Message (CWReturnOut) will indicate that the return failed with the error_message: Return Already Processed.

Note: When you return against an existing return authorization, the system processes the return using the settings defined for the existing RA, ignoring any value passed in the following fields:

• refund_frt

• refund_hand

• refund_chg

• refund_duty

• reason

• disposition

• whs

• location

If you are not returning against an existing return authorization: If you are not returning against an existing return authorization, 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 OROB Drop Shipping (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

Process Overview


Transaction table for an order ship to is 2, the system creates a new return authorization for the order ship to using RA # 3.

Determining the Return Warehouse and LocationThe RETURN_IN job uses the following hierarchy to determine the warehouse and location where the item will be returned.

If the item does not exist in the warehouse, the system will automatically create an item warehouse record. If the item has not been previously placed in this location, the system will automatically create an item location record.

Suppressing RefundsYou can use the suppress_refund field in the Return Request Message (CWReturnIn) to indicate if you do not want to create a refund for the return. For example, it might not be appropriate to generate a refund for a POS order, when the transactions have already taken place at the store.

If a value is passed in the suppress_refund field, the system updates the Suppress refund field in the Order Payment Method table for each payment method on the order. You can review the setting of the Suppress refund field at the Display Order Pay Type Screen (1 of 2).

• If the suppress_refund field in the Return Request Message (CWReturnIn) is N or is blank, the system updates the Suppress refund field for the payment methods on the order to N or leaves it blank, allowing the system to generate a refund for the order.

• If the suppress_refund field in the Return Request Message (CWReturnIn) is selected, the system updates the Suppress refund field for the payment methods on the order to Y, preventing 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 Process Refunds (MREF), the refund status changes to C (cancelled). You cannot

1. Return the item to the whs and location specified in the Return Request Message (CWReturnIn).

2. If the whs and location are blank, return the item, based on the settings defined for the disposition specified in the Return Request Message (CWReturnIn).

• If the disposition’s Affect inventory field is N, the item will not be returned to a warehouse or location.

• If the disposition’s Affect inventory field is Y and the Use primary location field is Y, the item will be returned to its primary primary warehouse and location.

• If the disposition’s Affect inventory field is Y and a Warehouse and Location are defined, the item will be returned to the specified warehouse and location.

3. If the whs, location, and disposition are blank, return the item, based on the settings defined for the return disposition code defined in the Default Return Disposition Code for Inbound Returns (H65) system control value. If this system control value is unselected, the return will be placed in an error status: Invalid Rtn Disposition.

Process Overview


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; you will need to process any cancel-pending refund for the payment method before you can deactivate the payment method on the order.

The system writes an order transaction history message each time the Suppress refund flag is changed for a pay type: Suppress refund updated to Y on p/t 4.

What if the suppress_refund flag setting is different on returns for the same order? If you process multiple returns for an order, the system will update the Suppress refund field for each payment method on the order based on the setting defined for the last return processed.

If an unprocessed refund already exists for the order and a Return Request Message (CWReturnIn) is received for the order, the system will not update the status of the existing refund.

Example: The Suppress refund flag for the payment method on an order is blank.

The RETURN_IN job receives a CWReturnIn message for the order with the suppress_refund flag selected. The system updates the Suppress refund flag for the payment method to selected.

Because the Suppress refund flag for the payment method on the order is selected, the system creates the refund in an N (cancel pending) status.

The RETURN_IN job receives another CWReturnIn message for the order with the suppress_refund flag unselected. The system updates the Suppress refund flag for the payment method to unselected.

Because the Suppress refund flag for the payment method on the order is unselected, the system creates the refund in an O (open) status. The refund previously created for the order remains in a cancel pending status.

The RETURN_IN job receives another CWReturnIn message for the order with the suppress_refund flag set to blank.

The system does not update the Suppress refund setting for the payment method on the order. Because the Suppress refund flag for the payment method on the order is unselected, the system creates the refund in an O (open) status. The system does not update the status of the refunds previously created for the order.

If the Billing Async is inactive: If the Billing Async is inactive when the RETURN_IN job receives inbound return messages, the system will not process the returns until the Billing Async is started. However, the system will update the Suppress refund flag for the payment methods on the order as each inbound return is received.

Once the Billing Async is active, the system will process the returns. In addition, the status of all of the refunds created for the order will be based on the suppress_refund setting of the last return processed. Using the example above, the setting of the suppress_refund flag for the last return processed was blank, leaving the Suppress refund flag for the payment methods on the order as unselected; in this example, the system would create each refund in an open status.

Tax Overrides and Return ProcessingOrder Management System updates the Tax override field for an order line to selected if the order was received from an external system and a tax, GST, or PST amount was

Process Overview


defined, indicating the tax amount from the external system should be retained on the order line.

If the Tax override field for the order line you are returning is selected, the system does not call the regular tax routine to recalculate the amount of tax remaining on the order line and how much tax to include on the credit invoice. Likewise, if you use an external tax system to calculate tax, the system does not call the tax system to recalculate the tax amount.

Instead, 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.

Determining the new tax override amount: The system uses the following calculations to determine the new tax override amount assigned to the order line. This is the tax amount that displays in the Tax field on the Display Order Detail screen.

Original order quantity - Total order line return quantity = Net order quantity

Net order quantity / Original order quantity = Return ratio

Return ratio x Original tax override amount = New tax override amount

Determining the tax amount to return: The system uses the following calculations to determine the tax amount to include on the credit invoice created for the return. This is the tax amount that displays in the Tax field on the Second Display Invoice Detail screen.

Current return quantity / Original order quantity = Return ratio

Return ratio x Original tax override amount = Returned tax amount

Example: An order line includes 5 units of an item. The tax override amount for the order line is 5.00. You return 1 unit of the item against the order line. 2 units of the item have previously been returned against the order line.

In this example:

• The original order quantity is 5.

• The total order line return quantity is 3.

• The current return quantity is 1.

The system determines the new tax override amount:

5 - 3 = 2

2 / 5 = .4

.4 x 5.00 = 2.00

2.00 displays in the Tax field for the order line on the Display Order Detail screen.

The system determines the tax amount to return:

1 / 5 = .2

.2 x 5.00 = 1.00

1.00 displays in the Tax field for the credit invoice on the Display Invoice Detail screen.

Process Overview


Return API ErrorsA list of errors that may occur when processing a return from an external system is presented below. You can review inbound returns that did not process due to an error in the Work with Return Interface Errors (WRIE) menu option.

Error description Reason

Invalid Company The company field does not contain a valid Order Management System company code.

Invalid item/SKU for Order Detail Line

The item information specified in the Return Request Message (CWReturnIn) is not located on the order line associated with the odt_seq_nbr.

Invalid Loc for Return The location passed or the location associated with the Default Return Disposition Code for Inbound Returns (H65) is not a valid location for the warehouse specified.

Invalid Order Detail Line The system:

• Could not locate an order line to return against, based on the item information passed in the Return Request Message (CWReturnIn).

• Could not return against the order line because there wasn’t an available quantity to return, for example, the item had not shipped yet.

See Identifying the Order Line for more information on the different ways you can identify the order line to return against.

Invalid Order Header The system could not locate an order to return against based on the value passed in the ecom_order_nbr or ohd_order_nbr field.

See Identifying the Order for more information on the different ways you can identify the order to return against.

Invalid Order Ship To The system could not locate the ship to order to return against, based on the value passed in the ship_to_nbr field.

Invalid RA Detail The ra_line_nbr passed does not match the Line # field in the RA Detail table for the specified Order Management System order number, ship to number, and item.

The specified order number, ship to number, and item is not associated with an existing return authorization.

Process Overview


Invalid RA Header The ra_nbr passed does not match the RA # field in the RA Detail table for the specified Order Management System order number, ship to number, and item.

The specified order number, ship to number, and item is not associated with an existing return authorization.

Invalid Return Quantity The qty passed does not match the quantity available to return for an order line.

For example, if an item was ordered on 2 order lines, you must create a separate return for each order line or you will receive this error message.

If you are returning against an RA, the quantity passed must match the quantity to return that was created on the RA.

Invalid Return Reason The reason passed in not a valid return reason code.

Return reason codes are defined in and validated against the Return Reason table.

Invalid Rtn Disposition The disposition is blank and a disposition code is not defined in the Default Return Disposition Code for Inbound Returns (H65) system control value.

Invalid Whs for Return The whs passed or the warehouse associated with the Default Return Disposition Code for Inbound Returns (H65) is not a valid warehouse.

Missing Company The company field is blank.

Missing Default Charge Code (H64) for misc credit

An amount was passed in the credit_amt field and an additional charge code was not defined in the Default Additional Charge Code for Inbound Returns (H64) system control value to assign to the charge.

Missing Order Detail Ln# The system could not locate an order line to return against, based on the item information passed in the Return Request Message (CWReturnIn).

See Identifying the Order Line for more information on the different ways you can identify the order line to return against.


Return API Setup


Return API SetupPurpose: Before you can process an Return Request Message (CWReturnIn) through the RETURN_IN job, you must perform the necessary Order Management System setup.

• System Control Values

• Menu Options

• Secured Features

• CWMessageIn Web Service

Missing Return Reason The reason is blank and a return reason code is not defined in the Default Return Reason Code for Inbound Returns (H63) system control value.

No Active Paytypes Typically, this message indicates that the pay type on the order was deactivated by the SECRISK periodic function, though it could indicate that the payment method was deactivated for another reason, such as that it is a retail pickup or delivery order.

Order Detail line already returned

The item passed has already been returned for the available quantity.

Return Already Processed The quantity available to return against the order line has already been returned and processed.

Return not allowed on Retail Pickup/Delivery Orders.

The order specified is a retail pickup or delivery order, and the Suppress Returns for Retail Pickup/Delivery (L88) system control value is selected. See that system control value for background.

Return not allowed for Ship for Pickup Orders.

The order specified is a ship-for-pickup order, and the Payment at POS for Ship to Store (L60) system control value is selected. See that system control value for background.


Return API Setup


System Control Values

System Control Value Description

Refund Freight Default for Inbound Returns (H59)

If a refund_frt value is not passed in the Return Request Message (CWReturnIn), the system uses the setting in this system control value to determine whether the system refunds freight charges for a return initiated from an outside system.

If this system control value is unselected, the Refund freight field for the return defaults to unselected.

Refund Additional Charge Default for Inbound Returns (H60)

If a refund_chg value is not passed in the Return Request Message (CWReturnIn), the system uses the setting in this system control value to determine whether the system refunds additional charges for a return initiated from an outside system.

If this system control value is unselected, the Refund additional charges field for the return defaults to unselected.

Refund Handling Default for Inbound Returns (H61)

If a refund_hand value is not passed in the Return Request Message (CWReturnIn), the system uses the setting in this system control value to determine whether the system refunds handling charges for a return initiated from an outside system.

If this system control value is unselected, the Refund handling field for the return defaults to unselected.

Refund Duty Default for Inbound Returns (H62)

If a refund_duty value is not passed in the Return Request Message (CWReturnIn), the system uses the setting in this system control value to determine whether the system refunds duty charges for a return initiated from an outside system.

If this system control value is unselected, the Refund duty field for the return defaults to unselected.

Default Return Reason Code for Inbound Returns (H63)

If a reason value is not passed in the Return Request Message (CWReturnIn), the system defaults the return reason in this system control value to a return initiated from an outside system.

Default Additional Charge Code for Inbound Returns (H64)

If a credit_amt value is passed in the Return Request Message (CWReturnIn), the system defaults the additional charge code in this system control value to a return initiated from an outside system.

Default Return Disposition Code for Inbound Returns (H65)

If a disposition value is not passed in the Return Request Message (CWReturnIn), the system defaults the disposition code in this system control value to a return initiated from an outside system.

Return API Setup


Menu Options

Secured Features

CWMessageIn Web ServiceYou can use the CWMessageIn web service to route CWReturnIn 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.

Menu Option Description

Work with Integration Layer Processes (IJCT)

The RETURN_IN job:

• Validates the data in the Return Request Message (CWReturnIn). If an error exists, you can display the error in the Work with Return Interface Errors (WRIE) menu option.

• Creates a return based on an Return Request Message (CWReturnIn) received from an external system.

• Optionally, sends an Return Response Message (CWReturnOut) to the external system.

In addition, you must set up an inbound queue to receive an Return Request Message (CWReturnIn) from an external system and an outbound queue to send an Return Response Message (CWReturnOut) to the external system.

Note: If the SECRISK periodic function deactivated the payment methods on the order, the Return Response Message (CWReturnOut) returns the error No active paytypes. You cannot complete the return through Work with Return Interface Errors (WRIE), but can use the Return Request Message (CWReturnIn) as an alternative.

Secured Feature Description

Enter Return Authorization (A28)

Note: The system does not require authority to these secured features in order to create, receive, and credit a return processed through the RETURN_IN job. The system creates the return without errors; however, if you do not have authority to these secured features, you cannot review the return in WRTA.

Receive Return Authorization (A29)

Credit Return Authorization (A34)

Return Disposition Authority (A83)

Note: The system does not require authority to this secured feature in order to assign a certain return disposition code to a return processed through the RETURN_IN job.

Return Request Message (CWReturnIn)


The RETURN_IN integration layer process can remain inactive and a queue is not required if the target is CWRETURNIN in the XML message.





The RETURN_IN job in Work with Integration Layer Processes (IJCT) receives and processes this message to create a return against an order line. See Inbound Return API for more information.

See Return Request Message: Sample XML for a sample message.


Message

source alpha 25 Identifies the source of the XML message.

target alpha 25 Identifies the target of the XML message.

type alpha 25 Identifies the type of information in the XML message. CWReturnIn indicates the message includes a return request.

resp_qmgr alpha 50 Informational only.

Return



company numeric 3 The Order Management System company where the order associated with the return is located. Required.Updates the Company field in the RA Detail table.

Identifying the order: In order to create a return, you must identify the Order Management System order and ship to number associated with the return. See Identifying the Order for more information.

ecom_order_nbr

alpha 30 The alternate order number from an outside system that is associated with the return, as defined in the E-Commerce order number field in the Order Header Extended table. Orders from the web storefront and CWStore update this field. Required if ohd_order_nbr is blank. Used to locate the order associated with the return.

ohd_order_nbr numeric 8 The Order Management System order number associated with the return, as defined in the Order # field in the Order Header table. Required if ecom_order_nbr is blank. Used to locate the order associated with the return. Updates the Order # field in the RA Detail table.

ship_to_nbr numeric 3 The order ship to number associated with the return, as defined in the Ship to # field in the Order Ship To table. Required.Updates the Ship to # field in the RA Detail table.

Identifying the order line: You must create the return against an existing Order Management System order detail line. See Identifying the Order Line for more information on the different ways you can identify which order line you wish to return against.

odt_seq_nbr numeric 5 The order detail line sequence number associated with the return, as defined in the Seq # field in the Order Detail table. Required if ra_nbr, ra_line_nbr, item, sku, retail_ref_nbr, short_sku, upc_type, upc_code, and alias are blank. Used to locate the order line to return against.




ra_nbr numeric 3 The return authorization number to return against, as defined in the RA # field in the RA Detail table. Required if odt_seq_nbr, item, sku, retail_ref_nbr, short_sku, upc_type, upc_code, and alias are blank. Used to locate the order line to return against.Note: In order to return against an RA #, you must have the Use Streamlined Return Authorizations (F44) system control value unselected and have an existing return created, but not yet processed. The system will use the order number, ship to number, RA number, and RA line number passed to locate the existing return authorization to return against. See Returning Against an Existing Return Authorization.

ra_line_nbr numeric 3 The return authorization line number to return against, as defined in the Line # field in the RA Detail table. Required if odt_seq_nbr, item, sku, retail_ref_nbr, short_sku, upc_type, upc_code, and alias are blank. Used to locate the order line to return against.Note: In order to return against an RA #, you must have the Use Streamlined Return Authorizations (F44) system control value unselected and have an existing return created, but not yet processed. The system will use the order number, ship to number, RA number and RA line number passed to locate the existing return authorization to return against. See Returning Against an Existing Return Authorization.

qty numeric 5 The number of units of the item to return.The return errors if the return quantity is greater than the quantity available to return on the order line. Required. Updates the Qty returned field in the RA Detail table.

Determining the return warehouse and location: See Determining the Return Warehouse and Location for the hierarchy the RETURN_IN job uses to determine the warehouse and location where the item will be returned.




whs numeric 3 The warehouse where the item is being returned. Required if a return disposition code is not defined in the disposition field or Default Return Disposition Code for Inbound Returns (H65) system control value. Updates the Whs field in the RA Detail table.

location numeric 7 The warehouse location where the item is being returned. Required if a return disposition code is not defined in the disposition field or Default Return Disposition Code for Inbound Returns (H65) system control value. Updates the Location field in the RA Detail table.

disposition alpha 3 A code that identifies how a returned item will be handled by Order Management System, in terms of whether the return updates inventory and the warehouse and location to which the item will be returned. If the return affects inventory, meaning the item will be returned into active inventory and update the on hand quantity in the specified location, and a whs and location are not defined, the system returns the inventory to the warehouse and location defined for the return disposition code. If a disposition is not passed or is invalid, the system uses the disposition code defined in the Default Return Disposition Code for Inbound Returns (H65) system control value. If the system control value is unselected, the return is placed in an error status: Invalid Rtn Disposition.

reason numeric 3 Indicates the reason the customer is returning the item. If a reason is not passed, the system uses the return reason code defined in the Default Return Reason Code for Inbound Returns (H63) system control value. If this system control value is unselected, the return is placed in an error status: Missing Return Reason.




item alpha 12 The item to return, as defined in the ITM number field in the Order Detail table. If the item is a SKUed item, you must also specify the SKU code in the sku field. Required if odt_seq_nbr, ra_nbr, ra_line_nbr, retail_ref_nbr, short_sku, upc_type, upc_code, and alias are blank. Used to locate the order line to return against.

sku alpha 14 The SKU code of the item to return, as defined in the SKU table. Required if item or alias is passed and the item is a SKUed item. Used to locate the order line to return against.

short_sku numeric 7 The short SKU code for the item, as defined in the SKU table. Required if odt_seq_nbr, ra_nbr, ra_line_nbr, retail_ref_nbr, item, sku, upc_type, upc_code, and alias are blank. Used to locate the order line to return against.

retail_ref_nbr numeric 15 The retail reference number for the item, as defined in the SKU table. Required if odt_seq_nbr, ra_nbr, ra_line_nbr, short_sku, item, sku, upc_type, upc_code, and alias are blank. Used to locate the order line to return against.

upc_type alpha 3 The type of UPC code, as defined in the Item UPC table. The associated UPC code is defined in the upc_code field. Required if odt_seq_nbr, ra_nbr, ra_line_nbr, short_sku, item, sku, retail_ref_nbr, and alias are blank. Used to locate the order line to return against.

upc_code alpha 14 The UPC code assigned to an item, as defined in the Item UPC table. The associated UPC type is defined in the upc_type field. Note: Include any leading zeros. For example, if the UPC code is 06012011, pass 06012011 and not 6012011. Required if odt_seq_nbr, ra_nbr, ra_line_nbr, short_sku, item, sku, retail_ref_nbr, and alias are blank. Used to locate the order line to return against.




alias alpha 12 An alternate name assigned to the item, as defined in the Page Letter Alias table. Note: If the item is a SKUed item, you must pass sku along with alias in order to find the correct item and SKU code.

Required if odt_seq_nbr, ra_nbr, ra_line_nbr, short_sku, item, sku, retail_ref_nbr, upc_type and upc_code are blank. Used to locate the order line to return against.

refund_frt alpha 1 Indicates whether to refund the freight charge for the returned item. • Y = Refund freight.

• N = Do not refund freight.

If you enter Y and the source code uses a header level freight method, the system refunds a proportionate amount of freight for the item being returned. If you enter Y and the source code uses a line level or flat freight method, the system refunds the freight charge for the returned item on the order. Note: This setting also controls whether the system refunds any service charges by ship via on the order.

If a refund_frt value is not passed, the system uses the setting defined in the Refund Freight Default for Inbound Returns (H59) system control value.

Updates the Refund freight field in the RA Detail table.

If you are returning against an existing RA, the system uses the Refund freight setting defined for the existing RA detail line, ignoring this value.




refund_hand alpha 1 Indicates whether the system will credit the handling charge for the returned item. • Y = The system will include the

charge for special handling in the customer’s refund.

• N = Any charges for special handling, such as monogramming, will not be refunded to the customer.

If a refund_hand value is not passed, the system uses the setting defined in the Refund Handling Default for Inbound Returns (H61) system control value. Updates the Refund handling field in the RA Detail table. If you are returning against an existing RA, the system uses the Refund handling setting defined for the existing RA detail line, ignoring this value.

refund_chg alpha 1 Indicates whether the system will refund the additional charges for the returned item. • Y = Refund additional charges.

• N = Do not refund additional charges.

If a refund_chg value is not passed, the system uses the setting defined in the Refund Additional Charge Default for Inbound Returns (H60) system control value. Updates the Refund add’l chgs field in the RA Detail table.If you are returning against an existing RA, the system uses the Refund add’l chgs setting defined for the existing RA detail line, ignoring this value.




refund_duty alpha 1 Indicates whether the system will refund duty charges for the returned item. • Y = Refund duty charges for the

returned item.

• N = Do not refund duty.

If a refund_duty value is not passed, the system uses the setting defined in the Refund Duty Default for Inbound Returns (H62) system control value. Updates the Refund duty field in the RA Detail table. If you are returning against an existing RA, the system uses the Refund duty setting defined for the existing RA detail line, ignoring this value.

credit_amt numeric 9.2 The credit amount to refund the customer for the return. For example, you may wish to refund return postage. The credit amount must be a positive amount.If you define a credit amount, the system will assign the code defined in the Default Additional Charge Code for Inbound Returns (H64) system control value to the credit. If this system control value is unselected and a credit amount is passed, the return is placed in an error status: Missing Default Charge Code (H64) for misc credit.Updates the Add’l charges field in the Order Additional Charge table.

send_response alpha 1 Indicates whether an Return Response Message (CWReturnOut) is sent back to the external system, indicating if the return was processed successfully or if any error occurred. • Y = Send an Return Response

Message (CWReturnOut).

• N = Do not send an Return Response Message (CWReturnOut).


Return Response Message (CWReturnOut)


Return Request Message: Sample XMLA sample of the Return Request Message (CWReturnIn) is presented below.

<Message source="cwi" target="OMS" type="CWReturnIn" resp_qmgr="CWIAS400"> <Return company="555" ecom_order_nbr="1122005" ohd_order_nbr="7885" ship_to_nbr="1" odt_seq_nbr="1" ra_nbr="1" ra_line_nbr="1" qty="1" whs="205" location="2050101" disposition="KM" reason="2" item="2005SKU1" sku="RED WMNS SMLL" short_sku="1781" retail_ref_nbr="12005" upc_type="E13" upc_code="200511" alias="SKU12005" refund_frt="Y" refund_hand="Y" refund_chg="Y" refund_duty="Y" credit_amt="150" send_response="Y" suppress_refund="N" />

</Message>


The RETURN_IN job in Work with Integration Layer Processes (IJCT) sends this message to an external system, indicating if the Return Request Message (CWReturnIn) was processed successfully or if any error occurred. See Inbound Return API for more information.

See Return Response Message: Sample XML for a sample message.

suppress_refund

alpha 1 Indicates whether you wish to suppress a refund for the return. For example, if the return is from a retail store, you may have already refunded the customer. • Y = Do not create a refund for the

return. The system changes the Suppress refund field for each payment method of the order to selected.

• N = Create a refund for the return. The system changes the Suppress refund field for each payment method of the order to unselected.

Note: If you process multiple returns for an order, the system will update the Suppress refund field for each payment method on the order based on the setting defined for the last return processed. See Suppressing Refunds.


Message






type alpha 25 Identifies the type of information in the XML message. CWReturnOut indicates the message is a return response.

date_created numeric 8 The date the outbound return message was created, in YYYY-MM-DD format.

time_created numeric 8 The time the outbound return message was created, in HH:MM:SS format.

Return

company numeric 3 The Order Management System company where the return was created. From the Company field in the RA Detail table.

ecom_order_nbr

alpha 30 The alternate order number associated with the order that was returned against. From the E-Commerce order number field in the Order Header Extended table.

order_nbr numeric 8 The Order Management System order number that was returned against. From the Order # field in the RA Detail table.

ship_to_nbr numeric 3 The ship to order number that was returned against. From the Ship to # in the RA Detail table.

odt_seq_nbr numeric 5 The order detail sequence number associated with the order line that was returned against. From the Seq # field in the Order Detail table.

ra_nbr numeric 3 The return authorization number associated with the return. From the RA # field in the RA Detail table.

ra_line_nbr numeric 3 The return authorization line number associated with the return. From the Line # field in the RA Detail table.

item alpha 12 A code for the item that was returned. From the ITM number field in the RA Detail table.




Return Response Message: Sample XMLA sample of the Return Response Message (CWReturnOut) is presented below.

<Message source="OMS" target="cwi" type="CWReturnOut" date_created="2006-01-12" time_created="14:35:48">

<Return company="555" ecom_order_nbr="1122005" ohd_order_nbr="7885" ship_to_nbr="1" odt_seq_nbr="1" ra_nbr="1" ra_line_nbr="1" item="2005SKU1" sku="RED WMNS SMLL" whs="205" location="2050101" qty="1" action_result="Success" />

</Message>

sku alpha 14 A code for the SKU of the item that was returned. From the SKU code field in the RA Detail table.

whs numeric 3 A code for the warehouse where the item was returned.From the Whs field in the RA Detail table.

location alpha 7 A code for the warehouse location where the item was returned. From the Location field in the RA Detail table.

qty numeric 5 The quantity of the item returned. From the Qty returned field in the RA Detail table.

action_result alpha 7 Indicates if the return was processed successfully or if an error occurred. • Success = The return was processed

successfully.

• Failure = An error occurred and the return was not processed. The error_message attribute indicates the description of the error, and the error can be viewed in the Work with Return Interface Errors (WRIE) menu option.

error_message alpha 70 A description of the first error encountered while processing the Return Request Message (CWReturnIn). See Return API Errors for a list of possible errors and how to correct them.


Working with Batch Order Maintenance Transactions (WBOM) 209

91Working 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 Order Management System 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.

Typically, you would first check the status of the order using the Generic Customer History API to determine the details of the order you wish to cancel.

Cancel request: The request specifies the order ship-to or order lines you wish to cancel.

Cancel response: The response message merely indicates that the request was received; a subsequent email confirmation indicates whether the cancellation request was successful.

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.

E-Commerce Cancel Setup


What if the order is a store pickup order? You cannot cancel a store pickup order through the CWCancel message.

In this chapter:

• E-Commerce Cancel Setup

• E-Commerce Cancel Process

- 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

- 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)

E-Commerce Cancel SetupThe CWServiceIn web service allows an external system to post the E-Commerce Cancel Request Message (CWCancel) directly to Order Management System and receive responses without the need of any queues.





Setup for the CWServiceIn SOAP-Based Web ServiceThe 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 sent the E-Commerce Cancel Request Message (CWCancel) to the URL, or

E-Commerce Cancel Setup


endpoint, specified in the wsdl. The CWServiceIn web service routes the messages sent to the endpoint and dispatches them to the E-Commerce Cancel process. When the E-Commerce Cancel process generates a response, 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 Order Management System process, so the CWServiceIn web service can route the message appropriately. The correct type for the E-Commerce Cancel Request Message (CWCancel) is CWCancel.


Sample Inbound Message in SOAP EnvelopeThe CWServiceIn web service requires that the inbound messages be embedded in SOAP envelope tags. A sample E-Commerce Cancel Request Message (CWCancel) embedded in a SOAP envelope is presented below.


<Message xsi:noNamespaceSchemaLocation="file:///c:/SVN/Serenade%205.5/XML/SampleXML/CWCancel/1.0/CWCancel.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" type="CWCancel" target="OROMS" source="WEB">

<Cancel order_reason="5" cancel_type="O" ship_to="1" order_id="855" company_code="1"/><Lines>

<Line reason="0" qty="1" line_number="1"/></Lines>

</Message>


Setup for the CWServiceIn RESTful Web ServiceYou POST the E-Commerce Cancel Request Message (CWCancel) 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 E-Commerce Cancel process. When the E-Commerce Cancel process generates a response, the CWServiceIn web service routes the response.

Message type: The type attribute in the inbound message identifies the Order Management System process, so the CWServiceIn web service can route the message appropriately. The correct type for the E-Commerce Cancel Request Message (CWCancel) is CWCancel.

Determine the endpoint: The individual URL for the CWServiceIn RESTful service uses the following format:

E-Commerce Cancel Process


http://server:port/SerenadeSeam/sxrs/application/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 ServiceThe CWServiceIn RESTful web service does not require that inbound messages be embedded in SOAP envelope tags. A sample E-Commerce Cancel Request Message (CWCancel) when using a RESTful web service is presented below.

<Message xsi:noNamespaceSchemaLocation="file:///c:/SVN/Serenade%205.5/XML/SampleXML/CWCancel/1.0/CWCancel.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" type="CWCancel" target="OROMS" source="WEB">

<Cancel order_reason="5" cancel_type="O" ship_to="1" order_id="855" company_code="1"/><Lines>

<Line reason="0" qty="1" line_number="1"/></Lines>

</Message>


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 FlowOrder inquiry and maintenance through the e-commerce interface use the following messages:

Processing the RequestIn 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 system checks whether there are any errors for the request.

• If there are no errors, the system:

- processes the requested update(s) to the order.

- deletes the batch order maintenance error records.

- unlocks the order.

• If there are errors, the system:

- updates the batch order maintenance error record with one or more error codes. See Display Batch OM Errors Screen.

Message Direction Purpose

To check status:

Customer History Request XML Message (CWCustHistIn)

web storefront to Order Management System

Inquires on the status of the order.

Detailed Order Inquiry Response XML Message (CWORDEROUT)

Order Management System to web storefront

Provides information on the order header and detail.

To cancel:

E-Commerce Cancel Request Message (CWCancel)

web storefront to Order Management System

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.



- depending on customer preference, sends the customer an email indicating that the cancellation attempt was not successful. See Emails for E-Commerce Cancels.

- 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 TransactionsRequired 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 (default) = 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

Emails for E-Commerce CancelsCancellation email: The ORDR_ASYNC job generates an order or order line cancellation email to the customer if:

Work with Batch OM Transactions Screen


• 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 if:

• you have specified a Order Maintenance Confirmation Email Program (H12), and

• the customer is eligible to receive email notifications; see When Does the System Generate an Email Notification?

See the Cancellation Request Failure Email Sample and Contents for more information.

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 MessagesThe 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 one of the the following:

Ord Can Conf to [email protected].

or

Ord Can Fail to [email protected]

You can review order history messages at the Display Order History screen in order inquiry. The system assigns the default user ID, DEFAULTUSR, to the order history messages.

Work with Batch OM Transactions ScreenPurpose: 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.

Work with Batch OM Transactions Screen


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.

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.


Activity The type of transaction that the customer attempted to perform. Valid values are:

• Cancel Order

• Line Cancel

This 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.

Display Batch OM Transactions Screen (Header)


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.

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.

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.


Display Batch OM Transactions Screen (Detail)


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).

Activity The type of transaction that the customer attempted to perform. Valid values are:

• Cancel Order

• Line Cancel

This 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.

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.

Field Description

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 address is separated from the order number by a hyphen.



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 entirely

Display-only.

Line number The order detail line number to be cancelled.


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.



Qty The quantity of the item that the customer has attempted to cancel.


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.

Display Batch OM Detail Screen


Display Batch OM Detail ScreenPurpose: 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).


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

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 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 entirely

Display-only.

Display Batch OM Errors Screen


Display Batch OM Errors ScreenPurpose: 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).

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.


Quantity The quantity of the item that the customer has attempted to cancel.


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.



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.



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.


Error description The description of the error that prevented the cancel request from being processed. See Batch Order Cancel Errors.


Field Description

Batch Order Cancel Errors



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.

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.

Invalid Transactions The cancel type is missing or invalid.

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.

Field Description



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).

Invalid Order Ship To • The order ID in the cancellation request is missing or invalid.

• The order ship to in the cancellation request is missing or invalid for the order.

Error Message Occurs When:

224

E-Commerce Order Maintenance Errors ReportHow to print: Select 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


225


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 Setup for required setup.

• E-Commerce Cancel Process for additional processing information.

• E-Commerce Cancel Request Message: Sample XML for a sample message.


Message


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 Order Management System.

type alpha Identifies the type of information in the XML message. Must be set to CWCancel to indicate the message contains a cancellation request.

Required.

Cancel

One 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.

company_code numeric 3 The company where the order is located.

Maps to the CMP Company field in the Order Ship To table.

Required.


226

order_id numeric 8 The Order Management System 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.

If not defined, O Order cancel defaults.

order_reason numeric 2 A code that represents the reason for canceling the order. Must be a valid cancel reason code.

Maps to the CNR Cancel reason code field in the Order Detail table.

Line

The 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. Required to cancel an order line.

Maps to the Seq # field in the Order Detail table.

qty numeric 5 The quantity on the order line to cancel. Required to cancel an order line.

Maps to the ODT Qty cancelled field in the Order Detail table.



227

E-Commerce Cancel Request Message: Sample XMLA 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>

reason numeric 2 A code that represents the reason for canceling the order line. Must be a valid cancel reason code. If a cancel reason code is not passed, the system uses the cancel reason code defined in the Auto Soldout Cancel Reason (C20) system control value.

Maps to the CNR Cancel reason code field in the Order Detail table.


Generic Customer API 228

121Generic 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.

Oracle Retail Customer Engagement customer integration: If you use the Oracle Retail Customer Engagement customer integration, when you create or change a customer through the generic customer API, the new or changed customer information is also sent to Oracle Retail Customer Engagement so that the name, address, email address, phone numbers, and contact permissions in the two systems are synchronized.

In this chapter:

• 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

Customer API Setup


• 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

• 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.

Customer API SetupBefore 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

Customer API Setup


System Control Values used by the Customer API


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 EDQ 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.

Customer API Setup


Default Customer for Customer APIUse 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.

For each field that is not provided in the Inbound Customer Message (CWCustomerIn), the Customer API checks the corresponding field for the default customer.

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.


Customer API Setup


• 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, 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 APIOrder Management System writes the Inbound Customer Message (CWCustomerIn) to the Order Management System Application Log if its Logging Level is set to INFO or lower.

CWCustomer or CWMessageIn Web ServiceYou 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.

Web service authentication? Use theWork with Web Service Authentication (WWSA) menu option to define a valid user for basic web service authentication. If you use Oracle Identity Cloud Service for password authentication, in addition to creating the web service authentication user in Work with Web Service Authentication (WWSA), you must also create a corresponding user profile in Oracle Identity Cloud Service and assign the user to the corresponding web service role defined for the Order Management application.

• CWCustomer Web Service

• CWMessageIn Web Service

Customer API Setup


CWCustomer Web ServiceThe CWCustomer web service allows an external system to post the CWCustomerIn XML message directly to Order Management System 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/SerenadeREST/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/CWCustomer, where server:port identifies the application server where the wsdl is located and CWCustomer 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="external" target="CUST35" type="CWCustomerIn" resp_qmgr="QM_cwi_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"/><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>

Customer API Setup


</CustSoldTo></Message>

]]></dom:performAction>

</soapenv:Body></soapenv:Envelope>

CWMessageIn Web ServiceYou 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[

<Message source="cwi" target="CUST35" type="CWCustomerIn" resp_qmgr="QM_cwi_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="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" 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>

Determining Whether to Add or Change a Customer


<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>

Determining Whether to Add or Change a CustomerThe 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 Order Management System 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 (Oracle Retail Customer Engagement ID).

• the message includes a cst_relate_id (Oracle Retail Customer Engagement 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 (Oracle Retail Customer Engagement 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.

Adding a Customer using the Customer API


Adding a Customer using the Customer APIWhen Order Management System 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 RequestsTo 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

• cst_email_status unless a default is defined in the Default Opt In/Opt Out Flag (G97) system control value

EDQ address interface: The system first submits a customer address to EDQ for address standardization if the Perform Address Standardization in Customer API (I99) system control value is selected and you use the Experian Data Quality (EDQ) Address Validate API. The address standardization is applied before any duplicate checking or other edits, and takes place only if there is a single matching address (the Address Validate Response Match Level is Verified).



Duplicate Checking for Add RequestsBefore 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

Duplicate Check S: If Single Match Found, Update CustomerThe 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,

• Remote Order values: If there are existing customers with the same match code as the customer information in the Add request, the system uses the Remote Order 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 Remote Orders (F73) and Exact Match Required on Address Line 2 for Remote Orders (F75) 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.



Duplicate Check S Example: The Inbound Customer Message (CWCustomerIn) contains the following customer information:

Julie Roberts 1234 Sample StreetWestborough, MA 01581Email [email protected]

Order Management System finds a single customer with the same match code and an exact match based on the Remote Order Values (F70).

Customer 13962:

Juliette Roberts1234 Sample 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 Remote Order 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.




Duplicate Check S Flowchart:

Duplicate Check A: If Multiple Matches Found, Update Best Match CustomerThe system performs the following logic when the cst_duplicate flag is set to A.



• Remote Order values: If there are existing customers with the same match code as the customer information in the Add request, the system uses the Remote Order 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.

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.






Duplicate Check A Example: The Inbound Customer Message (CWCustomerIn) contains the following customer information:

Robert Smith1234 Sample StreetWestborough, MA 01581Email [email protected]

Order Management System finds multiple customers with the same match code and exact match based on the Remote Order Values (F70). The first customer match (the customer with the highest customer number) is customer 14551:

Bob Smith1234 Sample 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).

Duplicate Check A Flowchart:

3. Multiple matches found? If the system finds multiple duplicate existing customers based on the match code and Remote Order 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.






Duplicate Check Y: If Any Match Found, Do Not Update CustomerThe system performs the following logic when the cst_duplicate flag is set to Y.

Duplicate Check Y Flowchart:

Duplicate Check N: Do Not Perform Duplicate CheckingIf the cst_duplicate flag is N or any other value, the system does not perform any duplicate checking based on name and address.



• Remote Order values: If there are existing customers with the same match code as the customer information in the Add request, the system uses the Remote Order 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.

2. Duplicates found? If the system finds one or more duplicate existing customers based on the match code and Remote Order 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.




Error Checking for Add RequestsAfter 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.

• 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 RequestYou 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.

Changing a Customer using the Customer API


Changing a Customer using the Customer APIWhen Order Management System 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 RequestsTo 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

- 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



Experian Data Quality (EDQ) address interface: The system first submits a customer address to EDQ for address standardization if the Perform Address Standardization in Customer API (I99) system control value is selected and you use the Experian Data Quality (EDQ) Address Validate API. The address standardization is applied before any duplicate checking or other edits, and takes place only if there is a single matching address (the Address Validate Response Match Level is Verified).

Determining the Customer to UpdateThe 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, Order Management System selects this customer for update.

• No match: If the cst_cust_nbr does not match an existing customer, Order Management System 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, Order Management System 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, Order Management System 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 Relate ID: If the message includes a cst_cust_nbr and cst_relate_id, the system uses the following logic.

Does matching Order Management System customer have Relate ID?

Do other Order Management System 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...

Order Management System 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...

Order Management System 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).



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...

Order Management System 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...

Order Management System 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...

Order Management System 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).





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, Order Management System 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, Order Management System 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, Order Management System 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, Order Management System 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, Order Management System 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, Order Management System places the request in E 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).

If the cst_cust_nbr does not match an existing customer...

regardless of whether other customers are associated with the specified cst_relate_id...

Order Management System 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).





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 RequestsThe 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



For more information: See the Default Customer for Customer API (I90) for a discussion.

Error Checking for Change RequestsAfter 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:

Sample Customer API XML Messages


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 RequestYou 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.

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 RequestA 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.

<Message source="cwi" target="CUST35" type="CWCustomerIn" resp_qmgr="QM_cwi_QA4">



<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="" />

</CustUserDefinedFields> <CustProfiles>

<CustProfile cst_profile_code="" cst_profile_value="" /> </CustProfiles>

</CustSoldTo> </Message>

CWCustomerOut: See Outbound Customer Response Message (CWCustomerOut) for message details.

<Message source="OMS" 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 RequestA 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" />


<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 RequestA 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.




<Message source="cwi" target="CUST35" type="CWCustomerIn" resp_qmgr="QM_cwi_QA4"> <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" 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 RequestA 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" 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 RequestA 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.


<Message source="cwi" target="CUST35" type="CWCustomerIn" resp_qmgr="QM_cwi_QA4"> <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="" 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 RequestA 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.


Inbound Customer Message (CWCustomerIn)


<Message source="cwi" target="CUST35" type="CWCustomerIn" resp_qmgr="QM_cwi_QA4"> <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" 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>




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.


Message


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.

CustSoldTo

One CustSoldTo element is required.

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.

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.

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.

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.

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.




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 Box




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.




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.




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.




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.




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




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.




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.




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.




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 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.




cst_orig_mail_type alpha 1 Optional. Valid values are:• B = Buyer; a customer who

places an order (the “sold-to” customer).

• C (default for new customer) = 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.




cst_curr_mail_type alpha 1 Optional. Valid values are:• B = Buyer; a customer who

places an order (the “sold-to” customer).

• C (default for new customer) = 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.




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.




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.




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

original source code is XSTORE.

• defaults the value from the Default Associate Code (D09) system control value if the original source code is not 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.


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.


Updates Commercial? in the Customer Sold To table; see the Commercial flag on the First Create Sold To Customer screen.

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.


Updates Inactive? in the Customer Sold To table; see the Inactive flag on the First Create Sold To Customer screen.

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.


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_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.

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.

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:1. Defaults the delivery code in the Zip/City/State table defined for the postal code in the cst_zip tag.

2. 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.




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.




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.




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.




cst_cust_company alpha 3 Optional. 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.

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.




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.




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.




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 Box




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.




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: Version 2.0 in Order Management System 2.5 or later.




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.


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.





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 The Oracle Retail Customer Engagement ID. 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: Version 3.0 in Order Management System 3.5 or later.




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.


CustEmail

The 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.




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.




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.




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.




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.




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.




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.




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.

CustUserDefinedField

The 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.




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.




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.

CustProfile

The 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 define customer profile categories, such as age, income, or gender, and the valid values for each category through Setting Up Customer Profiles (WPFL).





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.


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

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.




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).

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.



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.

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.

Duplicate

This 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.

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.



Working with Customer API (WCAI) 307

2Working 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 chapter:

• 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 ScreenHow 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 (in user date format); optional.

Time The time when the Customer API Work table record was created.

Numeric, 6 positions (HHMMSS format); optional.



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.


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.


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.


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

Change Customer API Screen


Change Customer API ScreenPurpose: 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.

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.

Field Description

Date The date when the Customer API Work table record was created.

Numeric, 6 positions (in user date 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 customer

Note: 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.

Option Procedure



Entered on The cst_entry_date from the Inbound Customer Message (CWCustomerIn).

Numeric, 6 positions (in user date 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.

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.


Cur (Currency) The cst_currency from the Inbound Customer Message (CWCustomerIn).


Comp Cd (Company code)

The cst_cust_company from the Inbound Customer Message (CWCustomerIn).


Field Description



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.


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).


Mail Cd (Mail code) The cst_mail_code from the Inbound Customer Message (CWCustomerIn). Not to be confused with the Mail flag.


Account# The cst_account_nbr from the Inbound Customer Message (CWCustomerIn).


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.


Call Cd (Call code) The cst_call_code from the Inbound Customer Message (CWCustomerIn).


Field Description



Name The customer’s name from the Inbound Customer Message (CWCustomerIn), consisting of:

• cst_prefix

• cst_fname

• cst_minitial

• cst_lname

• cst_suffix


Inact (Inactive) The cst_inactive flag from the Inbound Customer Message (CWCustomerIn).


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).


PO Box The cust_po_box flag from the Inbound Customer Message (CWCustomerIn).


Suppr Sls Email (Suppress salesman email)

The cst_suppress_sales_rep_email from the Inbound Customer Message (CWCustomerIn).


Street The cst_street_addr from the Inbound Customer Message (CWCustomerIn).


Delivery code The cst_delivery_type from the Inbound Customer Message (CWCustomerIn).

Valid values:

• Business

• Residential

• No Distinction

Required.

Mail The cst_mail_name flag from the Inbound Customer Message (CWCustomerIn).


Field Description



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).


Rent The cst_rent_name flag from the Inbound Customer Message (CWCustomerIn).


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/Prospect

Optional.

Seed The cst_seed_name flag from the Inbound Customer Message (CWCustomerIn).


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/Prospect

Optional.

Field Description



H/B/F The cst_hold_bypass_fraud flag from the Inbound Customer Message (CWCustomerIn).

Valid values:

• Hold

• Bypass

• Fraud

Optional.

Postal code The cst_zip from the Inbound Customer Message (CWCustomerIn).


City The cst_city from the Inbound Customer Message (CWCustomerIn).


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).


Job title The cst_job_title flag from the Inbound Customer Message (CWCustomerIn).


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).


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).


Field Description



VAT The cst_vat_nbr from the Inbound Customer Message (CWCustomerIn).


Eve phone (Evening phone)

The cst_eve_phone and cst_eve_ext from the Inbound Customer Message (CWCustomerIn).


Orig source (Original source)

The cst_original_source from the Inbound Customer Message (CWCustomerIn).


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.


Assoc (Associate) The cst_associate flag from the Inbound Customer Message (CWCustomerIn).


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.


Curr source (Current source)

The cst_current_source from the Inbound Customer Message (CWCustomerIn).


Rent email The cst_rent_email flag from the Inbound Customer Message (CWCustomerIn).


Can BO (Cancel backorder)

The cst_cancel_bo flag from the Inbound Customer Message (CWCustomerIn).


Field Description



Byp rsv (Bypass reservation)

The cst_bypass_reservation flag from the Inbound Customer Message (CWCustomerIn).


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).


Do not fax The cst_do_not_fax flag from the Inbound Customer Message (CWCustomerIn).


Col (Column) The cst_price_column from the Inbound Customer Message (CWCustomerIn).


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 Tracking

Optional.

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).


Relate Id The cst_relate_id from the Inbound Customer Message (CWCustomerIn).


Pop up 1-2 The cst_pop_window_1and cst_pop_window_2 from the Inbound Customer Message (CWCustomerIn).


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.


Field Description

Work with Customer API User Field Screen


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.

Work with Customer API User Field ScreenPurpose: 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.

Pop up 3-4 The cst_pop_window_3 and cst_pop_window_4 from the Inbound Customer Message (CWCustomerIn).


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.


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.


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

Change Customer API User Field Screen


Change Customer API User Field ScreenPurpose: 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

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.


Text The cst_udf_text from the CustUserDefinedField element of the Inbound Customer Message (CWCustomerIn).


Number The cst_udf_nbr from the CustUserDefinedField element of the Inbound Customer Message (CWCustomerIn).


Date The cst_udf_date from the CustUserDefinedField element of the Inbound Customer Message (CWCustomerIn).


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.

Work with Customer API Email Screen


Work with Customer API Email ScreenPurpose: 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




Just one of the following fields must be completed. The type of field must match the sequence number for the user-defined field detail.

Text The cst_udf_text from the CustUserDefinedField element of the Inbound Customer Message (CWCustomerIn).


Number The cst_udf_nbr from the CustUserDefinedField element of the Inbound Customer Message (CWCustomerIn).


Date The cst_udf_date from the CustUserDefinedField element of the Inbound Customer Message (CWCustomerIn).


Field Description




Email address The cst_email_address from the CustEmail element of the Inbound Customer Message (CWCustomerIn).


Status The cst_email_status from the CustEmail element of the Inbound Customer Message (CWCustomerIn).


Change Customer API Email Screen


Change Customer API Email ScreenPurpose: 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.

Fmt (Format) The cst_email_format from the CustEmail element of the Inbound Customer Message (CWCustomerIn).


Prm (Primary) The cst_email_primary flag from the CustEmail element of the Inbound Customer Message (CWCustomerIn).


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.

Field Description




Email address The cst_email_address from the CustEmail element of the Inbound Customer Message (CWCustomerIn).


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.


Field Description

Change Customer API Email Screen


Email format The cst_email_format from the CustEmail element of the Inbound Customer Message (CWCustomerIn).


Display name The cst_display_name from the CustEmail element of the Inbound Customer Message (CWCustomerIn).


Primary The cst_email_primary flag from the CustEmail element of the Inbound Customer Message (CWCustomerIn).


Field Description

Working with Merge/Purge Sold-to Names (MMCS) 322

131Working with Merge/Purge Sold-to Names

(MMCS)

Purpose: Merging and purging customer sold-to names allows you to streamline your customer database by consolidating order and sales information from customers that have duplicate match codes (source customers) into a target customer record. Several source customer numbers can point to the same target customer number if they all share a match code. The system selects the oldest customer record as the target customer. This is the customer number that remains on the system when you run the merge/purge.

When you process the merge/purge, the system consolidates information from each source customer with the target customer. In each case, the system attempts to preserve the most current and complete information. The logic that the system uses in performing the merge/purge is discussed later in this topic.

Note: It is recommended that you process the merge/purge for your bill-to customers before your sold-to customer, to avoid unnecessary duplicate bill-to errors.

Where do duplicates come from? Duplicate codes can result when two customers have demographic information close enough to produce identical match codes. For example, Gerald Smith and Geraldine Smith live at the same address, and use the same nickname, Jerry. A duplicate can also occur during Order Entry if a customer uses a variation of his first name on different orders. For example, Jonathan Jones places orders on two occasions and gives Jon as his first name on one order, Jonathan as his first name on another order.

Omitting customers from merge/purge: You can use the delete option at the Work with Source Customers Screen to omit a customer from the merge. Using this option flags the customer’s Status as M, which indicates to omit the customer from future merge/purge lists. To reset all customers flagged with the M status and make them eligible for merge/purge selection again, use the Clearing Customer Sold To Status (MCST) menu option.

Adding records to the merge/purge: This function also allows you to create target and source customers in order to merge customer records that the system would not ordinarily select because the match codes are entirely different.

For example, if customer, Ann Delaney, resumes using her maiden name, Williams, and places an order under that name, you would want to merge Ann Delaney's customer and order history with her new customer record, Ann Williams. In order to


do this, you would want to create Ann Williams as the target customer and Ann Delaney as the source customer.

If you have not generated a list of duplicate records to work with, this should be the first option that you perform. Then you can review and change customer sold-to records, if necessary, in preparation for the merge/purge.

E-Commerce: If the Generate E-Commerce Customer Merge Staging Files (H86) system control value is selected, the system generates an E-Commerce Customer Merge Web XML File (CustomerMergeWeb). The web storefront can use this file to review customers that have been merged in Oracle Retail Order Management System and update the customer sold to records for the web.

In this chapter:

• Merge/Purge Customer Sold To Screen

• Submit Generation Window (Generating a List)

- Ghost Customers

- Maximum Number of Source Customers

• Confirm Delete Window (Deleting a List)

• Work with Source Customers Screen

• Create Target Customer Screen

• Creating a Source Customer

• Performing a Merge

• Display Customer Screen

• Merge/Purge Logic

- How are the Customer Tables Updated?

• E-Commerce Customer Merge Web XML File (CustomerMergeWeb)

For more information: See Clearing Customer Sold To Status (MCST).

Merge/Purge Customer Sold To ScreenHow to display this screen: Enter MMCS in the Fast Path field at the top of any menu or select the Merge/Purge Customer Sold To option from a menu.

About this screen: This screen will contain no data if you have not generated a listing of customers with duplicate match codes by selecting Generate List. See Submit Generation Window (Generating a List).

If you have already generated a listing, this screen will show the names of target customer records, along with the customer numbers that have duplicate match codes. The duplicate match code customer numbers appear in bold below the target customer name.

Field Description

Customer # The number assigned to the target customer; the system appends relevant information from the source customer onto the target customer record.



Name The name or company name of the customer. Customer names display last name first.

Company name: alphanumeric, 30 positions; display-only.

Customer name: alphanumeric, 25 positions (last name) and 15 positions (first name); display-only.)

Duplicate The customer number of the duplicate (source) customer record. If there is more than one source customer, the additional customer numbers will display.


Status The status of a customer record. Valid values are:

B = Bill to Duplicate

O = Open

Enter a valid status code to display records of that status.

Optional.


Create target customer Select Create to advance to the Create Target Customer Screen.

Delete a customer sold-to merge/purge record

Select Delete for a customer to delete a customer sold-to record from the merge.

Work with existing duplicates (source customers) or add duplicates

Select Duplicates for a customer to advance to the Work with Source Customers Screen in Change mode. See Creating a Source Customer for information on working with this screen in Add mode.

Change customer sold-to Select Change cust sold to for a customer to advance to the Display Customer Screen.

Display customer sold-to Select Display cust sold to for a customer to advance to the Display Customer Screen.

Generate a list of duplicate customer names

Select Generate List to submit this job for processing. See Submit Generation Window (Generating a List).

Note: This option displays only if you have authority to the Allow Generate List in Merge/Purge (J06) secured feature.

Delete list of target and source customers

Select Delete list to delete the list. See Confirm Delete Window (Deleting a List).

Field Description

Submit Generation Window (Generating a List)


Submit Generation Window (Generating a List)Purpose: To generate a list of duplicate names eligible for merge/purge, select Generate List at the Merge/Purge Customer Sold To Screen.

Note: The Allow Generate List in Merge/Purge (J06) secured feature controls access to the Generate List option on the Merge/Purge Customer Sold To Screen.

Ghost CustomersUse the Save source as ghost field on this window to indicate whether you want to delete or save source customer records with duplicate match codes once the order and customer history is merged with the target record. The Ghost? field defaults to unselected, but you can change it to Selected.

Records retained: If you select this field, the system will retain the source customer record in the Customer Sold To table, but the record will be flagged as a Ghost customer. All other records, such as alternate customer numbers, phone numbers, email, order history, billing history, mail history and entity history will not exist for the ghost customer, since all other records are merged into the target customer’s records; see Merge/Purge Logic.

Ghost Customer window: When you enter a Ghost customer number in order entry, or when entering a catalog request or customer membership, a pop-up window will inform you that the customer number you entered belongs to a Ghost customer, and will indicate the target customer you can enter instead.

Ghost customer restrictions: Ghost customers continue to be available for review; however, if you enter a ghost customer number in any maintenance function, the system does not display any history, such as orders or catalog requests, because all history has been merged to the target customer. Additionally, you cannot include a ghost customer as a target customer or source customer in a future merge/purge.

Maximum Number of Source CustomersYou can also define the maximum number of source customers you wish to process for a target customer. If you enter a maximum number, the system will complete the merge/purge process once the maximum number has been reached and the update for the target customer the system is currently working on has completed.

When you complete this screen and press Enter, the system submits the batch job M_PGENERAT, and returns you to the Merge/Purge Customer Sold To screen; exit and re-enter to review the generated list.

Merge and purge customers Select Perform Merge to submit the merge/purge job for processing. See Performing a Merge.


Confirm Delete Window (Deleting a List)


Confirm Delete Window (Deleting a List)Purpose: To delete the existing list of target and source customers and clear the Customer Merge/Purge tables, select Delete list at the Merge/Purge Customer Sold To Screen.

Work with Source Customers ScreenPurpose: Once you have generated the list of target and source customers, you can work with the duplicate, or source customers; optionally, you can retain the records of the source customers by flagging them as Ghost?. Use this screen in Add mode to select a source customer for a target customer you added to the merge/purge list using the Create option at the Merge/Purge Customer Sold To Screen; see Creating a Source Customer.

When you delete a customer at this screen, it sets the customer’s Status to M, which indicates not to select the customer for subsequent merge/purge lists. To clear a status of M from any flagged record in the Customer Sold To file, use the Clearing Customer Sold To Status (MCST) menu option. Once you use this menu option to clear all M statuses, the customers are eligible for selection the next time you generate a merge/purge list.

How to display this screen: Select Duplicates for a target customer at the Merge/Purge Customer Sold To Screen.

About this screen: This screen includes each source customer for the target customer, including both matches found by the system and source customers you selected.

Field Description

Customer # The number assigned to the source customer; the system appends relevant information from the source customer onto the target customer record.


Name The name or company name of the customer. Customer names display last name first.

Company name: alphanumeric, 30 positions; display-only.

Customer name: alphanumeric, 25 positions (last name) and 15 positions (first name); display-only.)

Ghost? A ghost customer is a source customer whose records have been merged into a target customer’s records.

Select this field to retain the customer records in the Customer Sold To table for the source customer after you have completed the Merge/Purge. If you retain ghost customer records, the system will flag the records as Ghost customers. When you enter a Ghost customer number in order entry, or when entering a catalog request or customer membership, a pop-up window will inform you that the customer number you entered belongs to a Ghost customer, and will indicate the target customer you can enter instead. Alphanumeric, 1 position; required.

Create Target Customer Screen


Create Target Customer ScreenPurpose: You can create a target customer in order to merge customer records that the system would not normally select because the match codes are entirely different.

How to display this screen: Select Create on the Merge/Purge Customer Sold To Screen.

Instructions:

1. Complete the Target customer field.

2. You receive a system message informing you that a Customer Merge/Purge Target (Comp #/Cust #) has been created. When you return to the Merge/Purge Customer Sold To Screen, the target customer you just created now appears.

3. To select a source customer and link it to the target customer so the records will be consolidated when you process the merge/purge, see Creating a Source Customer.

Creating a Source CustomerPurpose: Use this option to select a source customer to merge with a target customer that you created manually (through the Create option at the Merge/Purge Customer Sold To Screen). You can also use this option to change source customers for merge/purge records created by the system; see Work with Source Customers Screen.


Add a source customer to the merge/purge

Select Create to advance to Add mode.

Delete a source customer from the merge/purge

Select Delete for a customer to delete the customer record from the record from the merge/purge and subsequent merge/purges.

Change customer sold-to Select Change cust sold to for a customer to advance to the First Create Sold To Customer screen.

Display customer sold-to Select Display cust sold to for a customer to advance to the Display Customer screen.

Field Description

Target customer The customer number for the sold-to customer that you wish to add to the merge/purge as a target customer.

If you select any source records for this customer (see Creating a Source Customer), the system will consolidate the customer records when you perform the merge/purge.

Numeric, 9 positions; required.

Performing a Merge


How to display this screen: Select Duplicates for a target customer record on the Merge/Purge Customer Sold To Screen, then select Create at the Work with Source Customers Screen to advance to Add mode.

About this screen: Each field on this screen is described under Work with Source Customers Screen.

Instructions:

1. Enter the Customer # for each customer record you would like to add as a source customer.

2. Optionally, select Ghost? field for each customer to add.

3. When you return to the Merge/Purge Customer Sold To Screen, the customer number you created as a source customer appears in the Duplicate field below the target customer.

Performing a MergePurpose: Use this option to merge the customer and order history of a target customer with a source customer(s) and purge source customer records from the system.

To perform a merge/purge: To merge the order and customer history of the source with the target customer, select Perform Merge at the Merge/Purge Customer Sold To Screen. A message displays announcing that MERGE_PURG job has been submitted.

See Merge/Purge Logic for a discussion of which tables are affected by the merge/purge, and how the system determines which information to keep from the target or source customers.

Display Customer ScreenTo display: Select Display cust sold to for a target customer at the Merge/Purge Customer Sold To Screen to advance to the first Display Customer screen. You cannot change anything on this screen.

Merge/Purge LogicWhen you process a merge/purge through Working with Merge/Purge Sold-to Names (MMCS), the system attempts to keep the best, most recent and most complete information for the target and source customers consolidated into one customer record.

Affected Table Comments

Alternate Customer # Cross Reference

Adds source records to target.

Catalog Requests Adds source requests to target.

Correspondence History Adds source emails to target.

Customer Action Adds the source information to the target.

Customer Address Change Adds source address changes to target. See How are the Customer Tables Updated?

Merge/Purge Logic


Customer Contract Pricing Adds the source information to the target.

Customer Fraud Adds the source information to the target.

Customer Note Adds the source notes to the target.

Customer Ownership Adds the source information to the target.

Customer Pay Type Exclusion Adds the source information to the target.

Customer Profile For any of these fields, if the source has information and the target does not, uses the source information.

Customer Ship To Merges matching ship-to customers based on match code; adds additional source ship-to customers to target.

Customer Ship To Extended See How are the Customer Tables Updated?

Customer Ship To Mail History Adds the source information to the target.

Customer Ship To Order History Adds the source history to the target history.

Customer Ship-To Phone Number Uses most recent phone numbers based on change date. See How are the Customer Tables Updated?

Customer Sold To See How are the Customer Tables Updated?

Customer Sold To Email Adds source records to target; target’s primary email address does not change.

Customer Sold To Extended See How are the Customer Tables Updated?

Customer Sold To Item Class Adds the source information to the target.

Customer Sold To Mail History Adds the source information to the target.

Customer Sold To Order History Adds the source history to the target history. See How are the Customer Tables Updated? for more information.

Customer Sold To Phone Number Uses most recent phone numbers based on change date.

Customer Sold To Promotion Adds the source information to the target.

Customer Sold To User Fields If any user field is blank for the target customer but not the source customer, uses the source information.

Customer Subscription Adds the source information to the target.

Customer Tax Adds the source information to the target.


Merge/Purge Logic


Customer Warehouse Order Management System uses the following logic:

• if the source has a customer warehouse and the target does not, use the source customer warehouse.

• if the target has a customer warehouse and the source does not, use the target customer warehouse and delete the source customer warehouse.

Customer Warranty Adds the source records to the target customer.

Order Billing History (both sold-to and ship-to customers)

Adds all target and source dollar and quantity figures together; see below for additional information.

Order Header Adds the source records to the target.

Order Ship To Adds the source records to the target.

Pick Control Header Adds the source records to the target.

Pick Gen Select Customer Adds the source records to the target.

Pick Gen Select PO Adds the source records to the target.

PO Header Adds the source records to the target.

Promotion Customer Adds the source records to the target.

Store Pickup Header Adds the source records to the target. Not currently implemented.

Tickler Adds the source records to the target.

Tickler History Adds the source records to the target.


Merge/Purge Logic


How are the Customer Tables Updated?

Field How Updated?

Address information:

Prefix

First name

Middle initial

Last Name

Suffix

Company name

Street Address

Apartment

Address line 2

Address line 3

Address line 4

City

State

Zip

Delivery code

PO Box?

Phone numbers

Match code

User fields 1-4

The system decides which information to keep based on the Change date from the most recent record in the Customer Address Change table and the Last order date in the Customer Order History table.

• If the Last Change date for the source customer is more recent than the last Change date for the target customer, the system uses the source address information and creates a customer address change record for the target.

• If there is no last Change date for either the target or the source, the system compares the target and source Last order date. If the Last order date for the source customer is more recent than the target customer, the system uses the source address information and creates a customer address change record for the target, as above.

Prefix: The system does not validate the target prefix against the Prefix table, regardless of the setting of the Validate Prefix (I27) system control value.

Phone numbers: If the system uses the source address information and one or more of the phone numbers for the source is blank, the system will retain the target phone number instead of removing it. Example: If the source has a day number, but not an evening number, the system will use the source day number, but retain the target evening number.

Primary email address

Uses the target’s primary email address; however, the source’s email addresses are added to the target’s list.

Additional fields:

Entry date Compares target and source Entry date and uses earlier date.

Original mail type If the target's original mail type is not B (buyer), uses the source's original mail type.

Current mail type If the target has no order history (the Last order date field is blank), uses the source's current mail type.

Original source code If the target is newer than the source based on the Entry date, uses the source information. However, if the source has the older Entry date but no original source code, then the target’s original source code is retained.

Merge/Purge Logic


Customer class If the target is newer than the source based on the Active since date, uses the source information. (The Active since date is filled when the customer first places an order; if the customer has never placed an order, the Active since date is set to 99/99/99).

Mail

Rent

Seed

If any of these flags are selected for either the target or the source, sets the flag to selected.

Hold/bypass/fraud

Customer type

Discount percent

Price column

Pop-up windows

Alternate customer number

Salesman number

Country

Mail code

Call code

Pop-up windows

VAT number

Currency code

Language code

Price Group

Reserve warehouse

Van Route

Van Sequence #

For any of these fields, if the source has information in the field and the target does not, uses the source information; otherwise, use the target information.

Tax exempt status

Exemption certificate number

If the source has a certificate number and the target does not, uses the certificate number and tax exempt status.

Track item history

Item history tracking level

If the Track item history field is set to Sold to tracking or Sold to/ship to tracking for the source but not the target, uses the Item history tracking setting from the source.

Current source code Uses the last source code used by either the source or the target from the Customer Sold To Order History table.

Field How Updated?

E-Commerce Customer Merge Web XML File (CustomerMergeWeb)


E-Commerce Customer Merge Web XML File (CustomerMergeWeb)Purpose: The E-Commerce Customer Merge Web XML file (CustomerMergeWeb) contains customer sold to merge information as a result of Performing a Merge in Working with Merge/Purge Sold-to Names (MMCS). The system generates this file if the Generate E-Commerce Customer Merge Staging Files (H86) system control value is selected, based on records in the EC Cust Sold To Merge table. Once the system generates the CustomerMergeWeb file, the system clears the records in the EC Cust Sold To Merge table.

Location of file: The ECOMMERCE_DIRECTORY_PATH in Work with Admin Properties (CPRP) defines the location on the application server where the system

External sales amount

External sales update date

Uses the target customer’s External sales amount and External sales update date unless the source customer’s External sales update date is more recent, or the target customer has no external sales information; in either of these cases, the target customer record is updated with the source customer’s external sales information.

Inactive flag

Commercial flag

Bypass reservation flag

Auto cancel backorder flag

Associate flag

Bill-to customer number

Uses the target information.

Life to date warranty dollars

If the source customer has a dollar amount defined and the target customer does not, the system uses the dollar amount defined for the source customer. If a value has been defined in the Life to date warranty dollars field in the Customer Sold To Order History table for both the source customer and the target customer, the system adds the two values together.

Relate Id If:

• the target customer has a Relate Id, do not change it, regardless of whether a source customer also has a Relate Id.

• the source customer has a Relate Id and the target does not, the system uses the source customer’s Relate Id.

• multiple source customers have Relate Ids and the target does not, the system uses the Relate Id for the first customer who has one.

Synchronize with remote

If any of the source customers have this flag set to Y, the system sets this flag to Y for the target customer.

Field How Updated?



downloads the E-Commerce Customer Merge Web XML file. An example of the directory is /domain/conf/OMSFiles/WebData/, where domain is the WebLogic domain directory for Order Management System. Note: If the ECOMMERCE_DIRECTORY_PATH is not valid or is blank, or the specified folder does not exist, the system does not generate the CustomerMergeWeb file and writes an error message to the Application log.

Name of file: The name of the file is CustomerMergeWeb_999_YYMMDDHHMMSS.xml, where 999 is the company code where you processed the customer merge and YYMMDD is the date and time when the file was created.

Application log: The system writes any messages related to the customer merge download to the Application log.

Sample message: See Sample E-Commerce Customer Merge Web XML Message (CustomerMergeWeb) for a sample message.

Sample E-Commerce Customer Merge Web XML Message (CustomerMergeWeb)A sample of the E-Commerce Customer Merge Web XML message (CustomerMergeWeb) is presented below.

<CustomerMerges CompanyCode="30">


CustomerMerges

CompanyCode numeric 3 A code for the company where the customer sold to merge was processed.

From ECO Company Code in the EC Cust Sold To Merge table.

CustomerMerge

A separate row exists for each duplicate (source) customer that is merged with a target customer.

SourceCustSoldTo numeric 9 The customer number of the duplicate (source) customer record.

From ESM Source Cust Sold To in the EC Cust Sold To Merge table.

TargetCustSoldTo numeric 9 The number assigned to the target customer; the system appends relevant information from the source customer onto the target customer record. See Merge/Purge Logic for more information on how the system consolidates the customer information into the target customer.

From ESM Target Cust Sold To in the EC Cust Sold To Merge table.


Clearing Customer Sold To Status (MCST) 336

2Clearing Customer Sold To Status (MCST)

Purpose: When you delete a customer from a merge/purge at the Work with Source Customers Screen, the system flags the customer with a Status of M. Once flagged with this status, a customer is not included the next time you generate a merge/purge list. Use the Clear Customer Sold To Status menu option to clear a Status of M for all records in the Customer file, so they will be eligible for subsequent merge/purge list generation.

Note:

• The Status field is not displayed on a screen.

• This menu option does not clear other values in the Status field.

For more information: See Working with Merge/Purge Sold-to Names (MMCS) for background.

Confirm Clear of Customer Status WindowHow to display this window: Enter MCST in the Fast path field at the top of any menu, or select Clear Customer Sold To Status from a menu.

Completing this window: Click OK to clear each setting of M in the Status field of the Customer Sold To file for your company. The system resets the Status field from M to blank, and the customer is eligible to be selected the next time you generate a merge/purge list as described under Submit Generation Window (Generating a List).

Generic Customer History API 337

141Generic 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 chapter:

• Typical Flow

• When is the Response Message Empty?

• Setup Requirements


- Customer History Request Message: Sample XMLs


- Customer History Response Message: Sample XML


- Detailed Order Inquiry Response Message: Sample XML


- Summary Order Inquiry Response Message: Sample XML

Typical FlowA typical customer history inquiry flow would begin when a customer in a retail store has a question about an order placed in Order Management System.

1. The store clerk inquires on history for the customer.


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 Order Management System 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

2. The customer history request is processed:

• The store system sends a Customer History Request XML Message (CWCustHistIn) to the queue specified for the CUST_HIST process running in Work with Integration Layer Processes (IJCT) in Order Management System. The message uses the customer number in the store, which is the same as the alternate customer number in Order Management System. Typically, the request limits the number of orders in the response to no more than 15, in order to insure an acceptable response time.

• The CUST_HIST process sends the Customer History Response XML Message (CWCustHistOut), listing the customer’s orders to the store system.

3. The store 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:

• The store again generates the Customer History Request XML Message (CWCustHistIn); however, this request includes the specific order number or alternate order number (such as the store transaction number), and the send_detail flag is set to Y.

• The CUST_HIST process in Order Management System generates the Detailed Order Inquiry Response XML Message (CWORDEROUT), listing detailed information about the selected order, and sends it to the store. The detailed information includes sold-to, ship-to, and bill-to addresses, payment methods, items, and shipments.

6. The store displays the detailed information about the order onscreen.


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 Order Management System 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.

• 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:

<Message source="RDC" target="IDC" type="CWCUSTHISTOUT"> <Headers> </Headers>

</Message>

If the request includes information on the order:

<Message source="RDC" target="IDC" type="CWORDEROUT"></Message>



Setup RequirementsTo 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.

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.

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.

CWMessageIn Web ServiceYou 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.

Web service authentication? Use theWork with Web Service Authentication (WWSA) menu option to define a valid user for basic web service authentication.If you use Oracle Identity Cloud Service for password authentication, in addition to creating the web service authentication user in Work with Web Service Authentication (WWSA), you must also create a corresponding user profile in Oracle Identity Cloud Service and assign the user to the corresponding web service role defined for the Order Management application.






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.



Message


target alpha 25 Identifies the target of the XML message. RDC indicates the XML message is sent to Order Management System.

type alpha 25 CUSTHISTIN

resp_qmgr alpha 25 Informational only.

resp_q alpha 25 Informational only.

CustomerHistoryRequest

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.

alternate_sold_to_id alpha 15 Indicates the 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.

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, 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.

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.

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 Alternate order 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.




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.

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: 2.0 (version 3.5 of Order Management System).




Customer History Request Message: Sample XMLsSamples 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>

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" />

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: 2.0 (version 3.5 of Order Management System).


Customer History Response XML Message (CWCustHistOut)


</Message>

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

• 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 XMLA 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" >

<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>



<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></Header>

</Headers></Message>

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 Order Management System.


type alpha 25 Identifies the type of information in the XML message.



Header

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.

reference_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 Alternate order at the Display Order Properties screen.

customer_number numeric 9 A unique number identifying the sold-to customer.

alternate_sold_to_id 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:

• blank = an order taken in Order Management System

• I = an internet order

• P = a point of sale order

• C = an order from Oracle Retail Order Broker

bill_me_later_ind alpha 1 Not currently implemented.




order_status alpha 1 The current status of the order. Valid values are:

• C = Canceled

• H = Held

• X = Closed

• E = Error

• S = Suspended

• Q = Quote

Included 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.

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.


sales_rep_name alphanumeric

30 The name of the salesman assigned to the order.

From the SLS Name field in the Salesman table.


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




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 Not implemented.

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_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

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.





sales_rep_name alphanumeric

30 The name of the salesman assigned to the order. From the SLS Name field in the Salesman table.


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.


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 Order Management System 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.




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.

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.

cc_last_four numeric 4 The last four digits of the credit card number on the order.

From the IPM CC Last 4 field in the Order Payment Method table.


ShipTo

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.

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




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_company alpha 30

ship_to_busres alpha 1

ship_to_address1 alpha 32




ship_to_apartment alpha 10





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.





delivery_type alpha 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 available

Ship for Pickup = the order is shipped to a store location, where the customer picks it up after arrival

The ship-to address indicates the selected store for either a store pickup or a ship-for-pickup 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 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.

status alpha 1 The status of the order line. Valid values are:

• B = Express Bill

• C = Canceled

• E = Error

• H = Held

• S = Soldout

• X = Closed

A 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.

original_retail_price 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.

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 Name in OROB 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.

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.


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_main_item alpha 1 Indicates whether the item is the main item of a set:

Y = a main set item

N = not a main set item


set_component_item alpha 1 Indicates whether the item was added to the order as a component of a set:

Y = a set component

N = not a set component


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.


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.


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.





broker_status alpha 15 The status of an Order Broker request. Included only for store pickup, ship-for-pickup, 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





line_locate_eligible alpha 1 Indicates if a backordered line meets the rules for a brokered backorder:

• the Send B/O to OROB (K08) system control value is selected

• the item is flagged as OROB 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)




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.


gift_wrap alpha 1 Indicates whether the item is gift wrapped.

Y = The item is gift wrapped.

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.


Shipment

Included 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.




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, Order Management System 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.




Detailed Order Inquiry Response Message: Sample XMLA 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"

invoice_ship_via_code

numeric 2 From the Manifest Upload Audit table.

Not included for brokered backorders.

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 Order Management System.Available in: 6.0 (release 3.5 of Order Management System).

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: 6.0 (release 3.5 of Order Management System).


Summary Order Inquiry Response XML Message (CWORDEROUT)


order_date="01042006" order_channel="I" bill_me_later_ind="N" order_type="X" order_type_description="E-COMMERCE ORDER TYPE" 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" 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 OMS 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>


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 without details.

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 XMLA sample of the Summary 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 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>

Generic Inventory Inquiry API 372

151Generic 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 Order Management System 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 Order Management System with Oracle Retail Order Broker to support visibility into inventory availability across the enterprise.

In this chapter:

• 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 FlowA typical inventory inquiry flow might be:

1. A customer at the web storefront inquires into the availability of an item.


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

<Message source="OROMS" target="cwi" type="CWInventoryInquiryResponse" date="08052006" time="15:11:57" ></Message>

Resolving the Item and SKUThe 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.

2. The web storefront generates an inventory inquiry request to Order Management System.

3. The INV_INQURY process in Order Management System 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.

Inventory Inquiry Request XML Message (CWInventoryInquiry)


Setup RequirementsTo 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).

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.

CWMessageIn Web ServiceYou 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.





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


target alpha 25 Identifies the target of the XML message. RDC indicates the XML message is sent to Order Management System.

type alpha 25 Identifies the type of information in the XML message. Should be set to CWInventoryInquiry.

InventoryInquiry

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



Inventory Inquiry Request: Sample XMLA sample of the Inventory Inquiry Request XML Message (CWInventoryInquiry) is presented below.

<Message source="5" target="OROMS" type="CWInventoryInquiry"><InventoryInquiry company="5" item_number="KABSKU1 " sku_code="BLUE" exclude_non_allocatable="N" exclude_retail_outlet="N" />

</Message>

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.

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.


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 Order Management System.


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

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 item

N (default) = This is not a membership item

Even 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.





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.


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.

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:

S = Set

F = Finished goods

V = 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.




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 card

E = Physical card/early notification

V = 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.

retail_reference_nbr numeric 15 The SKU’s retail reference number, if any. Typically, this is an alternate product ID.




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).

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-13

E8: EAN-8

UA: UPC-A

UE: 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.

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 setting 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.

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


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





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.

retail_type alpha 1 A setting of S indicates that the warehouse represents a retail outlet.

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 and reservation.

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.

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.

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.

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.

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. 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 availableDrop 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 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.


next_expected_qty numeric 7 The number of units of this item ordered on a purchase order that will be available for new orders.

original_retail_price 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.




Inventory Inquiry Response: Sample XMLA sample of the Inventory Inquiry Response XML Message (CWInventoryInquiryResponse) is presented below.

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.

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.


Item Availability API 389

161Item 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 Order Management System 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 chapter:

• 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)

Item Availability API SetupThe CWServiceIn web service allows an external system to post the Item Availability Request XML Message (CWItemAvailabilityWeb) directly to Order Management System and receive responses without the need of any queues.

Web service authentication? Use theWork with Web Service Authentication (WWSA) menu option to define a valid user for basic web service authentication.If you use Oracle Identity Cloud Service for password authentication, in addition to creating the web service authentication user in Work with Web Service Authentication (WWSA), you must also create a corresponding user profile in Oracle Identity Cloud Service and

Item Availability API Setup


assign the user to the corresponding web service role defined for the Order Management application.




Setup for the CWServiceIn SOAP-Based Web ServiceThe 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 Order Management System 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 EnvelopeThe 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"> <![CDATA[

<Message source="web" target="OROMS" 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>


Item Availability API Process


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 Order Management System process, so the CWServiceIn web service can route the message appropriately. The correct type for the Item Availability Request XML Message (CWItemAvailabilityWeb) is CWItemAvailabilityWeb.


Sample Inbound Message using RESTful Web ServiceThe 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>

Item Availability API ProcessA typical item availability flow might be:

Resolving the Item and SKUThe 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.

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 Order Management System using the CWServiceIn web service.

3. The Item Availability Web process in Order Management System 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.

Item Availability API Process


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 (CWItemAvailabilityResponseWeb) to the Order Management System MQ Message log if its logging level is set to INFO or higher.

Item Availability Web Service ErrorsThe 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.

Item Availability API: Sample Messages


Item Availability API: Sample Messages• Successful Item Availability Request

• Unsuccessful Item Availability Request

Successful Item Availability Request

Item Availability Web Request: Sample XMLA sample of the Item Availability Request XML Message (CWItemAvailabilityWeb) is presented below.

<Message source="web" target="OROMS" 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 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.




<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 XMLA 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="OMS" target="WEB" type="CWItemAvailabilityResponseWeb"><ItemAvailabilityResponseWeb company="7" company_description="KAB Co 7 v4.7 Karen Brown 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><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></SKU>

</SKUs></Item>

</Items></ItemAvailabilityResponseWeb>

</Message>

Unsuccessful Item Availability Request

Item Availability Web Request: Sample XMLA 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 Request XML Message (CWItemAvailabilityWeb)


Item Availability Web Response: Sample XMLA sample of the Item Availability Response XML Message (CWItemAvailabilityResponseWeb) is presented below.

<Message source="OMS" target="WEB" type="CWItemAvailabilityResponseWeb"><ItemAvailabilityResponseWeb company="7" company_description="KAB Co 7 v4.7 Karen Brown Co" pass_fail="FAILED" errorMsg="Item Not Valid or Could Not be Resolved"/>

</Message>



• 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.

Item

Can 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.




retail_reference_

nbr

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.




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 Order Management System does not validate the UPC length.

• E8 = EAN-8, indicating an 8 position UPC code; however, Order Management System does not validate the UPC length.

• UA = UPC-A, indicating a 12 position UPC code; however Order Management System does not validate the UPC length.

• UE = UPC-E, indicating a 6 position UPC code; however Order Management System 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


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



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.



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.

Item

The 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.


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.




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 item

N = This is not a membership item

Even 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.

From Item Status in the Item table.

kit_type alpha 1 The kit type setting, if any, for the item. Valid values are:

• 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.

SKU

The 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.

retail_reference_nbr numeric 15 The SKU’s reference number, if any. Typically, this is an alternate product ID.

From Retail reference # 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.

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.




Warehouse

The 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.




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, subscription items, and items on allocation freeze.

Sum Availability = N

If 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 = Y

If 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: 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.




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, subscription items, and items on allocation freeze.

Calculated by the system as follows:

On hand - Protected - Reserved - Reserve Transfer - Backordered = Quantity available


If 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.


If 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: 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).




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, subscription items, and items on allocation freeze.


If 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.


If 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, 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.


E-Commerce Item Availability Processing 410

171E-Commerce Item Availability Processing

Purpose: Your options in sending item availability information to the web storefront include:

• the E-Commerce Availability Web API.

• the Item Availability API.

• the Generic Inventory Download API.

Selecting an item availability processing method: The available options and some considerations for each are described below.

Option ConsiderationsMore Information

Item Availability API • requests a full download of inventory availability for a specific company, item, or group of items.

• generates the Item Availability Response XML Message (CWItemAvailabilityResponseWeb) and sends it to the web storefront, where the availability information is presented to the customer.

• requires a mechanism on the web storefront to process the XML message in order to update inventory information.

Item Availability API


In this chapter:

• E-Commerce Availability Web API

- E-Commerce Availability Web API Process

- E-Commerce Item Availability Web API: Sample Messages

- E-Commerce Availability Web Request XML Message (AvailabilityWebRequest)

- E-Commerce Availability Web Response XML Message (AvailabilityWebResponse)

E-Commerce Item Availability Web API

• requests a full download of inventory availability for a specific company, and optionally, offer.

• generates the E-Commerce Availability Web Response and stores the contents of the response in an output file on the application server.


E-Commerce Availability Web API

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 processing time to generate and transmit XML messages.

Generic Inventory Download API

Option ConsiderationsMore Information

E-Commerce Availability Web API


- E-Commerce Availability Web XML File (AvailabilityWeb)

E-Commerce Availability Web APIPurpose: Use the E-Commerce Availability Web API to inquire into the availability of items in a specific company, and optionally, offer.

You have the option to review item availability for each allocatable warehouse or to sum the item availability for an item across all allocatable warehouses.

E-Commerce Availability Web API SetupThe CWServiceIn Web Service allows an external system to post the E-Commerce Availability Web Request XML Message (AvailabilityWebRequest) directly to Order Management System and receive a response without the need of any queues.



Setup for the CWServiceIn SOAP-Based Web ServiceThe CWServiceIn web service’s .wsdl (Web Service Definition Language) file, which is located on your application server, controls the function of the CWServiceIn web service. You send the E-Commerce Availability Web Request XML Message (AvailabilityWebRequest) 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 E-Commerce Availability Web Response XML Message (AvailabilityWebResponse), 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 Order Management System process so the CWServiceIn web service can route the message appropriately. The correct type for the E-Commerce Availability Web Request XML Message (AvailabilityWebRequest) is AvailabilityWebRequest.


Sample Inbound Message in SOAP EnvelopeThe CWServiceIn web service requires that the inbound messages be embedded in SOAP envelope tags. A sample E-Commerce Availability Web Request XML Message (AvailabilityWebRequest) embedded in a SOAP envelope is presented below.

E-Commerce Availability Web API Process



<Message source="web" target="OMSCS" type="AvailabilityWebRequest"><AvailabilityWeb company="7" sum_availability="Y" offer="WEB"> </AvailabilityWeb>

</Message>


Setup for the CWServiceIn RESTful Web ServiceYou POST the E-Commerce Availability Web Request XML Message (AvailabilityWebRequest) 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 E-Commerce Availability Web Response XML Message (AvailabilityWebResponse), the CWServiceIn web service routes the response.

Message type: The type attribute in the inbound message identifies the Order Management System process, so the CWServiceIn web service can route the message appropriately. The correct type for the E-Commerce Availability Web Request XML Message (AvailabilityWebRequest) is AvailabilityWebRequest.


Sample Inbound Message using RESTful Web ServiceThe CWServiceIn RESTful web service does not require that inbound messages be embedded in SOAP envelope tags. A sample E-Commerce Availability Web Request XML Message (AvailabilityWebRequest) when using a RESTful web service is presented below.

<Message source="web" target="OMSCS" type="AvailabilityWebRequest"><AvailabilityWeb company="7" sum_availability="Y" offer="WEB"> </AvailabilityWeb>

</Message>

E-Commerce Availability Web API ProcessA typical e-commerce item availability flow might be:

1. The web storefront inquires into the availability of the items in a particular company and offer by generating an E-Commerce Availability Web Request XML Message (AvailabilityWebRequest) to Order Management System using the CWServiceIn Web Service.

2. The Item Availability Web process in Order Management System receives the request, generates the E-Commerce Availability Web Response XML Message

E-Commerce Item Availability Web API: Sample Messages


(AvailabilityWebResponse), and sends it to the web storefront. This message indicates to the web storefront whether the request processed successfully.

- If the request is successful, the response returns with a message of Successful.

- If the request fails, the response returns with an error message. See E-Commerce Availability Web Service Errors for a list of errors that may occur.

3. The Item Availability Web process includes the details of the item availability web request in an E-Commerce Availability Web XML File (AvailabilityWeb) located on the application server.

Application log: The system writes any messages related to the e-commerce item availability request to the application log.

E-Commerce Availability Web Service ErrorsIf the E-Commerce Availability Web Request XML Message (AvailabilityWebRequest) fails, the response returns with an error message. Possible errors are:

E-Commerce Item Availability Web API: Sample Messages• Successful E-Commerce Item Availability Web Request

• Unsuccessful E-Commerce Item Availability Web Request

Successful E-Commerce Item Availability Web Request

E-Commerce Item Availability Web Request: Sample XML A sample of the E-Commerce Item Availability Web Request is presented below.

<Message source="web" target="OMSCS" type="AvailabilityWebRequest"><AvailabilityWeb company="7" sum_availability="N" offer="OFR"> </AvailabilityWeb>

</Message>

E-Commerce Item Availability Web Response: Sample XML A sample of the E-Commerce Item Availability Web Response is presented below.

<Message source="WEB" target="OMSCS" type="AvailabilityWebRequestResponse"><AvailabilityWebRequestResponse company="7" company_description="KAB Company" message="Successful"></AvailabilityWebRequestResponse>

</Message>


Invalid company code The company code is missing or invalid.

Invalid offer The offer is invalid.

Provided path under ECOMMERCE_DIRECTORY_PATH property is not valid

The ECOMMERCE_DIRECTORY_PATH is missing or invalid.

Message is invalid The AvailabilityWeb element is missing.

E-Commerce Item Availability Web API: Sample Messages


E-Commerce AvailabilityWeb XML File A sample of the E-Commerce AvailabilityWeb XML file is presented below.

<Header Offer="OFR" CompanyCode="7"><Items>

<Item Set="N" DropShip="N" SVCType="" ItemStatus="1" NonInventory="N" Description="ITEM DESCRIPTION" ItemNumber="ITEM">

<SKUs><SKU SKUStatus="" SoldOutCode="" SKUDescription="" SKUCode="" ShortSKU="115">

<Warehouses><Warehouse NextExpectedQty="100" NextPODate="12072015" AvailableQty="994" OnOrderQty="100" WarehouseName="MAIN WAREHOUSE" Warehouse="1"/>

</Warehouses></SKU>

</SKUs></Item><Item Set="Y" DropShip="N" SVCType="" ItemStatus="" NonInventory="N" Description="SET ITEM" ItemNumber="SET">

<SKUs><SKU SKUStatus="" SoldOutCode="" SKUDescription="" SKUCode="" ShortSKU="7">


</Warehouses></SKU>

</SKUs></Item><Item Set="N" DropShip="N" SVCType="" ItemStatus="1" NonInventory="N" Description="SKU ITEM DESCRIPTION" ItemNumber="SKU">

<SKUs><SKU SKUStatus="" SoldOutCode="" SKUDescription="RED SKU" SKUCode="RED" ShortSKU="5">

<Warehouses><Warehouse NextExpectedQty="123" NextPODate="12072015" AvailableQty="-2" OnOrderQty="125" WarehouseName="MAIN WAREHOUSE" Warehouse="1"/>

</Warehouses></SKU><SKU SKUStatus="" SoldOutCode="" SKUDescription="BLUE SML WMNS SKU DESCRIPTION" SKUCode="BLUE SML WMNS" ShortSKU="118">


</Warehouses></SKU><SKU SKUStatus="" SoldOutCode="" SKUDescription="GRN SML WMSN SKU DESCRIPTION" SKUCode="GRN SML WMNS" ShortSKU="119">


</Warehouses></SKU><SKU SKUStatus="" SoldOutCode="" SKUDescription="RED SML WMNS SKU DESCRIPTION" SKUCode="RED SML WMNS" ShortSKU="117">

<Warehouses><Warehouse NextExpectedQty="0" NextPODate="" AvailableQty="998" OnOrderQty="0" WarehouseName="MAIN WAREHOUSE" Warehouse="1"/>

</Warehouses></SKU>

E-Commerce Availability Web Request XML Message (AvailabilityWebRequest)


<SKU SKUStatus="" SoldOutCode="" SKUDescription="YELW SML WMNS SKU DESCRIPTION" SKUCode="YELW SML WMNS" ShortSKU="120">


</Warehouses></SKU>

</SKUs></Item>

</Items></Header>

Unsuccessful E-Commerce Item Availability Web Request

E-Commerce Item Availability Web Request: Sample XML A sample of the E-Commerce Item Availability Web Request is presented below.

<Message source="web" target="OMSCS" type="AvailabilityWebRequest"><AvailabilityWeb company="7" sum_availability="N" offer="WEB"> </AvailabilityWeb>

</Message>

E-Commerce Item Availability Web Response: Sample XML A sample of the E-Commerce Item Availability Web Response is presented below.

<Message source="WEB" target="OMSCS" type="AvailabilityWebRequestResponse"><AvailabilityWebRequestResponse company="7" company_description="KAB Company" message="Invalid offer"></AvailabilityWebRequestResponse>

</Message>

E-Commerce Availability Web Request XML Message (AvailabilityWebRequest)


• E-Commerce Availability Web API for an overview.

• E-Commerce Availability Web API Setup for information on the required setup.

• E-Commerce Availability Web API Process for processing details.

• E-Commerce Item Availability Web API: Sample Messages for a sample message.


Message



E-Commerce Availability Web Response XML Message (AvailabilityWebResponse)


E-Commerce Availability Web Response XML Message (AvailabilityWebResponse)

The Item Availability Web process generates an XML response to the E-Commerce Availability Web Request XML Message (AvailabilityWebRequest).

type alpha 25 Identifies the type of information in the XML message. Must be set to AvailabilityWebRequest.

AvailabilityWeb

company numeric 3 Required. Indicates the company associated with the item/SKU. Validated against the Company table; see Setting Up Companies (WCMP).

sum_availability alpha 1 Defines whether the AvailabilityWeb XML file 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.

offer alpha 3 A code for the offer whose item availability information you wish to include in the AvailabilityWeb XML file. Leave this field blank to include item availability regardless of offer. Offer codes are defined in and validated against the Offer table.


Message




E-Commerce Availability Web XML File (AvailabilityWeb)


E-Commerce Availability Web XML File (AvailabilityWeb)The Item Availability Web process generates an AvailabilityWeb XML file if the E-Commerce Availability Web Request XML Message (AvailabilityWebRequest) processes successfully.

Location of file: The ECOMMERCE_DIRECTORY_PATH in Working with Admin Properties (CPRP) defines the location on the application server where the system creates the AvailabilityWeb XML file. An example of the directory is /domain/conf/OMSFiles/WebData/, where domain is the WebLogic domain directory for Order Management System. Note: If an ECOMMERCE_DIRECTORY_PATH is not valid or is blank, or the specified folder does not exist, the system returns the E-Commerce Availability Web Response XML Message (AvailabilityWebResponse) with an error message and writes the error message to the Application log.

Name of file: The name of the file is AvailabilityWeb_999_YYMMDDHHMMSS.xml, where 999 is the company code associated with the item availability information and YYMMDDHHMMSS is the date and time when the file was created.

XML version: The ECOMMERCE_AVAILABILITY_XML_VERSION in Working with Customer Properties (PROP) defines the XML version of the AvailabilityWebRequest XML message.

type alpha 25 Identifies the type of information in the XML message. Set to AvailabilityWebRequestResponse.

AvailabilityWebRequestResponse

company numeric 3 The company defined in the E-Commerce Availability Web Request XML Message (AvailabilityWebRequest).

company_description

alpha 40 A description of the company.

message alpha 50 Indicates whether the e-commerce item availability web request processed successfully. • If the request is successful, the

response returns with a message of Successful.

• If the request fails, the response returns with an error message. See E-Commerce Availability Web Service Errors for a list of errors that may occur.




Note: The system includes all tags in the message, even if the tag is blank.


Header

CompanyCode numeric 3 The company code from the E-Commerce Availability Web Request XML Message (AvailabilityWebRequest).

Offer alpha 3 The offer code from the E-Commerce Availability Web Request XML Message (AvailabilityWebRequest).

Item

One or more items is included in the message. If an offer was included in the request, this message includes only items/SKUs assigned to the offer.

ItemNumber alpha 12 The item code, as set up through Performing Initial Item Entry (MITM).From ITM Number in the Item Warehouse table.

Description alpha 40 The description of the item.From Description in the Item table.

NonInventory 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.

ItemStatus alpha 1 The item’s Status, if any. An optional code that represents an item's status, such as obsolete, discontinued, etc. Item statuses are defined in Work with Item Status (WIST).From Item Status in the Item table.

SVCType alpha 1 Indicates the type of stored value card that the item is, if it is a stored value card. Valid values are:blank = Not a stored value card. P = Physical cardE = Physical card/early notificationV = Virtual cardFrom SVC Type in the Item table.



DropShip 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.

Set alpha 1 Indicates whether the item is a set item. Y = the item is a set item (the Kit type for the item is Set). N = the item is not a set item. From Kit type in the Item table.

SKU

The message includes all SKUs defined for an item, regardless of whether the SKU is assigned to the offer.

ShortSKU 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.

SKUCode alpha 14 The item’s unique characteristics; included if this is a SKUed item. The system separates each SKU code with a single space, for example: RED SML WMNS. From SKU Code in the SKU table.

SKUDescription alpha 40 The SKU’s description, if any.From Description in the SKU table.

SoldOutCode alpha 2 The SKU’s soldout control setting, if any. Soldout codes are defined in Work with Soldout Controls (WSLD).From SLC Code in the SKU table.




SKUStatus alpha 1 The SKU’s status code, if any. Can be different from the item’s status. SKU status codes are defined in Work with Item Status (WIST).From Item Status in the SKU table.

Warehouse

The message includes: • all SKUs for an item, regardless of whether they are assigned to the offer.

• only allocatable warehouses assigned to the item/SKU, even if there is no available quantity, on order quantity, or next expected quantity or PO date so that the web storefront can see item warehouses with no item availability.

You can review item warehouse information through Work with Warehouses (WWHS) and through 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 E-Commerce Availability Web Request XML Message (AvailabilityWebRequest).

WarehouseName alpha 30 The name of the warehouse.From Warehouse name in the Warehouse table.ALL displays if the sum_availability attribute in the E-Commerce Availability Web Request XML Message (AvailabilityWebRequest) was set to Y.




OnOrderQty 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, subscription items, and items on allocation freeze.Sum Availability = N

If the sum_availability attribute in the E-Commerce Availability Web Request XML Message (AvailabilityWebRequest) was set to N, this is the on order quantity, if any, for the item warehouse.Sum Availability = Y

If the sum_availability attribute in the E-Commerce Availability Web Request XML Message (AvailabilityWebRequest) 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.




AvailableQty 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, subscription items, and items on allocation freeze.Calculated by the system as follows:On hand - Protected - Reserved - Reserve Transfer - Backordered = Quantity available


If the sum_availability attribute in the E-Commerce Availability Web Request XML Message (AvailabilityWebRequest) was set to N, this is the available quantity, if any, for the item warehouse.Sum Availability = Y

If the sum_availability attribute in the E-Commerce Availability Web Request XML Message (AvailabilityWebRequest) 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). 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.




NextPODate 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, subscription items, and items on allocation freeze.Sum Availability = N

If the sum_availability attribute in the E-Commerce Availability Web Request XML Message (AvailabilityWebRequest) 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 = Y

If the sum_availability attribute in the E-Commerce Availability Web Request XML Message (AvailabilityWebRequest) was set to Y, this is the due date from the first PO Layering record across all allocatable 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.




NextExpectedQty 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, 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.


Generic Inventory Download API 426

181Generic Inventory Download API

Purpose: Use the generic inventory download API to keep an external system updated with your inventory information in Order Management System. 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 or membership 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:

Inventory Download Process


• item/SKU

• 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 Oracle Retail Order Broker: You would typically use Oracle Retail Order Broker’s product import process as an efficient means to send inventory information from Order Management System to Oracle Retail Order Broker; however, it is also possible to use the generic inventory download API.

The generic inventory download API does not check an item’s OROB eligible flag when determining whether to download inventory information on the item.

In this chapter:

• 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

Inventory Download ProcessPurpose: The inventory download trigger creation and message generation process is described below.



Creating Inventory Download Triggers through a Batch ProcessCreating 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 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 AvailabilityCreating 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.

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



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



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:

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.

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.

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.



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:

• 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:

- 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 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 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 item.

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:

Example: Your company stocks items COMPONENT1 and COMPONENT2. Both of these items are included in set master item SET1 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 master is based on the available quantity of COMPONENT1.

If you enter or maintain a purchase order that includes COMPONENT1, the system writes a trigger record for COMPONENT1, but not for COMPONENT2 or SET1. The reason is that the item COMPONENT1 is not associated with the other component item or the set master item in the context of the purchase order.

Type of transaction Menu Option(s)

inventory transactions:



adjustments (A) Work with Inventory Transactions (WITI)

transfers from allocatable to unallocatable warehouse, or vice versa (T)

reset on-hand (O)

item-to-item transfers (G)

make up finished good (M)

purchase order receiving Purchase Order Receipts (PORC)

receive return Work with Return Authorizations (WRTA), Work with Return Authorization Receiving (WRAR), Enter/Maintain Orders (OEOM), Order Inquiry/Maintenance (OIOM)

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 items

entering 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)

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




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.

Identifying Inventory Download TriggersEach 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 ProcessingTo 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

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)




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 RulesThe 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)

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:

- 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.

Field Test Value

Non-inventory NE ’Y’



• Not all fields in all tables are available as triggers. You can review the fields available for each table through the

Item Warehouses Excluded from the Inventory DownloadWhen 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:

- 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 InclusionAs 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:

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 message

Y N N

N Y N

Y Y Y Include Warehouse and ItemWarehouse but not available_qty in message

N 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



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 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 TroubleshootingThe 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?

Inventory Download Setup


Inventory Download SetupSetup requirements for the inventory download API are described below.

• System Control Values Related to Inventory Download API

• Menu Options Related to Inventory Download API

Inventory Download Setup


System Control Values Related to Inventory Download API


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.

Inventory Download XML Message (CWInventoryDownload)


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.



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 Order Management System.


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.

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 item

N = 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 sell

N or blank = This is not a membership item

Note: 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 you

N = 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.




kit_type alpha 1 The item’s Kit type setting, if any. Valid values are:

S = Set

F = Finished goods

V = Variable set

Note: 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).




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.

retail_reference_nbr 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.




subscription alpha 1 The setting of the Subscription flag for the item/SKU. Valid values are:

Y = This item is a subscription

N or blank = This item is not a subscription

Because 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.

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-13

E8: EAN-8

UA: UPC-A

UE: 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

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





Sample Inventory Download XML Message<Message source="OMS" target="cwi" type="CWInventoryDownload" date="10082006" time="11:07:35" >

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

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

original_retail_price numeric 7.2

current_retail_price numeric 7.2

protect_current_price

alpha 1

protect_min_max alpha 1


Generic Item Download API 450

191Generic Item Download API

Purpose: Order Management System allows you to capture item and SKU information to download to another system, such as a retail store or warehouse management system.

Integration with Oracle Retail Order Broker: You would typically use the Oracle Retail Order Broker Product Import Process as an efficient means to send item and SKU information from Order Management System to Oracle Retail Order Broker; however, it is also possible to use the generic item download API.

The generic item download API does not check an item’s OROB eligible flag when determining whether to download information on the item.

In this chapter:

• Item/SKU Download Process

- 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

• Order Management System Setup for the Item Download API

- System Control Value

- Menu Options

- Periodic Functions

• Item Download XML Message (CWItemOut)

- Item Download Message: Sample XML

Item/SKU Download ProcessThe 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/SKU Download Process


item download triggers to process and generates an Item Download XML Message (CWItemOut) to send to the remote system.

Identifying Item Download TriggersYou 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 Order Management System 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.

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 F (finished good kit).



3. The system generates triggers alphabetically by item number and SKU code for all items/SKUs whose Kit type is S (set kit).

4. 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/SKU Download ProcessingTo 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 Order Management System 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.

Item number Kit type Sequence

204I blank 1

204J blank 2

204K blank 3

204C F 4

204F F 5

204B S 6

204G S 7

204D V 8

204E V 9



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 Order Management System 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 Order Management System user ID and password to access the Order Management System 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 ActivitiesThis table indicates:

• which Order Management System 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.

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.

ActivityMenu 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 comments MITM SKU Comment C



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 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

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

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


Trigger Type



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 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

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


Trigger Type



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

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

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


Trigger Type



Item Outbound Trigger RulesItem Outbound trigger rules define the criteria an item/SKU must meet in order for the system to create an item download trigger.

• 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 CleanupBefore 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

• Capture type (C (change) or A (add))

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.



• 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 TriggersThe 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.

• 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:

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



• 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:

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 InclusionFor 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.

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

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).



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.

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

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 Item

Unselected = 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 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 Item

Unselected = Exclude Coordinate

Coordinate

Selected = Include Keyword and its parent Item

Unselected = Exclude Keyword

Keyword

Selected = Include Image and its parent Item

Unselected = Exclude Image

Image

Selected = Include Restriction and its parent ItemUnselected = Exclude Restriction

Restriction

Selected = Include ITMUserField and its parent ItemUnselected = Exclude ITMUserField

ITMUserField

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, 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

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

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 FinishedGood and its parents SKU and ItemUnselected = Exclude FinishedGood

FinishedGood

Selected = Include SetItem and its parents SKU and ItemUnselected = Exclude SetItem

SetItem


Order Management System Setup for the Item Download API


Order Management System Setup for the Item Download APIBefore you can generate item download messages, you must perform the necessary Order Management System setup and processing.

Information requiring setup includes:

• System Control Value

• Menu Options

• Periodic Functions

Selected = Include VariableSet and its parents SKU and ItemUnselected = Exclude VariableSet and its children VariableSetGroup and VariableSetItem

VariableSet

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


Order Management System Setup for the Item Download API


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 Order Management System.

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)


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.

Item Download XML Message (CWItemOut)


Periodic Functions

Item Download XML Message (CWItemOut)The item download message contains item and SKU information to send from Order Management System 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.

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




• Explicit decimal points are included in numeric fields.

Item elements:



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 Order Management System.


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 Order Management System 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.

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.• S = Set item

• F = Finished good item

• V = Variable set item

From 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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Term_payment_interval

numeric 5 The number of days between payments.From the Term payment interval field in the Item Offer table.

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_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.

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.

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.

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.

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.




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.

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.

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.

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.

ItemComment The ItemComment element repeats for each item comment defined for the item in the SKU Comments table.

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.

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.

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

ECI_Thumbfile_Picture


ECI_Regular_Picture alpha 255 Not implemented.

ECI_Large_Picture alpha 255 Not implemented.

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.

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.

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.

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.






• T = Text field.






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.

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.

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.

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.

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.

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.



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.

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.

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.

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.

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_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.

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.

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.

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.




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.

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.

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.






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.

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.

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.

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. Valid values are:• B or P = Print on PO

• blank = Do not print

From 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.

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.



• T = Text field.






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.

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.

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.

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.

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_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.

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.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.

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.




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.

Alias_item alpha 12 The alternate item code for the SKU.From the Alias item field in the SKU Offer Page table.

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.

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.



• T = Text field.









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.

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.

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.

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.

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.

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.

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.



• T = Text field.









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.




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.




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 item

From the Print code field in the SKU Comments table.

SKUAttribute Not implemented.

IAT_Type alpha 6 Not implemented.

IAT_Description alpha 30 Not implemented.




IAV_Value alpha 6 Not implemented.

IAV_Description alpha 30 Not implemented.

IAA_Affinity_flag alpha 1 Not implemented.

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.

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.




Item Download Message: Sample XMLA 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">

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.



• T = Text field.









</Item></Items>

</Message>

- 531

191E-Commerce-Related Setup in Oracle

Retail Order Management System CloudService

This section provides an overview of setup in Oracle Retail Order Management System Cloud Service related to the e-commerce integration:

• E-Commerce Setup

• Working with E-Mail Notification Templates (WEMT)

E-Commerce Setup 532

201 E-Commerce Setup

Purpose: You must perform basic setup in Order Management System, on your Order Management System server, on your web server, and on the web storefront before you can use the E-commerce interface in Order Management System. Setup requirements include:

• system control values

• supporting tables for download to web storefront

• additional system applications

Each requirement that is related to Order Management System is described in this topic. All other requirements are described for the Types of E-Commerce Transactions.

Web storefront: Additionally, you must configure the web storefront to meet your business requirements. You can modify the sample storefront or create your own; however, configuration of the web storefront is outside the scope of this document.

In this chapter:

• System Control Values Related to E-Commerce

• Table Setup for Download

• Additional Setup

- Additional Table Settings

- E-Commerce Periodic Functions

System Control Values Related to E-CommercePurpose: 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.

System Control Values Related to E-Commerce


Each of the e-commerce system control values listed below should be assigned to this application area and group.

Additional system control values:


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.

Generate E-Commerce Customer Merge Staging FIles (H86)

Defines whether Order Management System generates the E-Commerce Customer Merge Web XML File (CustomerMergeWeb) when you run the customer sold 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.

Table Setup for Download


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.

Table Setup for DownloadPurpose: In addition to the tables you must set up for order entry through Order Management System, you can set up the following table to facilitate processing orders through the web storefront.

Additional SetupPurpose: 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. 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• ECSHCNF: Sends shipment and return confirmation emails; see Sending Internet

Order Ship Confirmation (ESCF). This function should use the program name ECR0154.

SKU Element Description 1 (G37)

Define the SKU element descriptions to appear on the web storefront.



Table Purpose To Set Up

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).


Additional Setup


• 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

Working with E-Mail Notification Templates (WEMT) 536

211Working 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

• loyalty membership activations and deactivations

• Oracle Retail Customer Engagement 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 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.

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 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 chapter: 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

- Quote Confirmation Emails

- Membership Cancellations

- Purchase Order Emails

- Store Pickup Notifications

- Oracle Retail Customer Engagement 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

- Cancellation Request Failure Email Sample and Contents

- Order Cancellation Confirmation Email Sample and Contents

- Order Line Cancellation Confirmation Email Sample and Contents

- Store Pickup Notification Sample and Contents

- Oracle Retail Customer Engagement Loyalty Registration Notification Sample and Contents

Summary of Customer Correspondence


• Simple Format Notification Sample

• Work with E-Mail Template Screen

• Change E-Mail Template Screen


• Setup overview: Email Generation Setup in the online help provides an overview on setup, a listing of related system control values, and troubleshooting information.

• Which text template? Email Text Templates in the online help describes the hierarchy that controls which text template to use for notifications.

• Which “from” email address? "From" Email Address in the online help 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? in the online help 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? in the online help describes how to control the generation of different types of notifications for an order type.

Summary of Customer CorrespondenceThe 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.

Credit Card Credit Acknowledgement

email (HTML format) XML, or printed

Generate C/C Credits (MREF) 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.

Loyalty Activate Notice and Loyalty Deactivate Notice




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

Oracle Retail Customer Engagement Loyalty Registration Notification


Oracle Retail Customer Engagement Loyalty Registration Process

Loyalty Registration Notification

See Oracle Retail Customer Engagement Loyalty Registration Notification Sample and Contents.

Maintenance Failure



Cancellation Request Failure - Order #999999

See Cancellation Request Failure Email Sample and Contents.

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


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.

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




• 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: Oracle Retail Order Broker’s Store Connect module does not use this notification email; instead, you can use Oracle Retail Order Broker 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


When Does the System Generate an Email Notification?


When Does the System Generate an Email Notification?• Order Confirmation Emails

• Shipment and Return Confirmation Emails

• Stored Value Card Notification Emails

• Quote Confirmation Emails

• Purchase Order Emails

• Oracle Retail Customer Engagement Loyalty Registration Notifications

• Other Email Notifications

Order Confirmation EmailsAn 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


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.

Pick Slips

printed only Streamlined Pick Slip Generation (WSPS)


Drop Ship Pick Slips

printed only Select Vendors for Drop Ship Picks (MDSP)


Refund Checks

printed only Process Refunds (MREF)





• 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.

• 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.



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.

Shipment and Return Confirmation EmailsThe 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 ORCE 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.

• 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:


• 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.

Stored Value Card Notification EmailsThe 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.

Quote Confirmation EmailsA 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.

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 CancellationsGenerated 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.



Purchase Order EmailsGenerated 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 maintenance and inquiry.

Note: You cannot email purchase orders 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.

• 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.

• The subject of the email is Purchase Order - PO # 1234567, where 1234567 is the purchase order number.

Store Pickup NotificationsThe 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.


Oracle Retail Customer Engagement Loyalty Registration Notifications The Oracle Retail Customer Engagement loyalty registration notification email indicates that a customer has successfully registered in the Oracle Retail Customer Engagement Loyalty program. The system generates the Oracle Retail Customer Engagement loyalty registration notification when a loyalty card is assigned to a customer while registering a customer in the Oracle Retail Customer Engagement 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 Oracle Retail Customer Engagement Card Inquiry Response returned from Oracle Retail Customer Engagement contains a loyalty card number, and

• there is a valid email generation program specified for the ORCE Loyalty Registration Notification Email Program (M10) system control value.

For more information: See the Oracle Retail Customer Engagement Loyalty Registration Notification Sample and Contents.

Other Email NotificationsBackorder, 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

• 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, “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.

- 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 SettingThe 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. Use the customer’s Opt in/Opt out setting.

HTML Format Notification Samples and Contents


Additional Information about Email NotificationsOrder 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.

HTML Format Notification Samples and ContentsThe 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.

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

• Cancellation Request Failure Email Sample and Contents

• Order Cancellation Confirmation Email Sample and Contents

• Order Line Cancellation Confirmation Email Sample and Contents



• Oracle Retail Customer Engagement Loyalty Registration Notification Sample and Contents

Order Confirmation Email Sample and ContentsSee Order Confirmation Emails for a discussion on how to generate this email.

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

- 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.



Shipment Confirmation Email Sample and ContentsSee Shipment and Return Confirmation Emails for information on how to generate this email.

Contents: The contents of the shipment confirmation email are derived from the Outbound Email XML Message (CWEmailOut) as follows:





- Valued customer



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 Oracle Retail Order Broker, then the ship via description is listed only if the Order Broker passed a valid ship via code set up in Order Management System; 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, 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 ContentsSee Shipment and Return Confirmation Emails for more information on how to generate this email.

Contents: The contents of the return confirmation email are derived from the Outbound Email XML Message (CWEmailOut) as follows:





- Valued customer



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 ContentsYou can generate first, second, and continue backorder notifications through the Generate Backorder Cards (GBOC) and Work with Backorders Pending Cancellation (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:





- Valued customer



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 slash

Note: 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)







Credit Card Credit Acknowledgement Email Sample and ContentsYou generate this email through the Processing Refunds (MREF) 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:





- 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




Soldout Notification Email Sample and ContentsYou 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:





- Valued customer



Notice type: Soldout Summary





• for each soldout item:

- Item/SKU: so_item and so_SKU, if any, separated by a slash


- 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 ContentsSee Stored Value Card Notification Emails for information on when the system generates these emails.



Note: Each activated stored value card generates a separate email notification.

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 slash


- Quantity: svc_qty

Note: 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)

• 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






“Contact Us” Notification Sample and ContentsYou 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:





- Valued customer












Credit Card Decline Notification Sample and ContentsThe 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:





- Valued customer






Quote Confirmation Email Sample and ContentsSee Quote Confirmation Emails for a discussion on how to generate this email.

Contents: The contents of the quote confirmation email are derived from the Outbound Email XML Message (CWEmailOut) as follows:







- Valued customer



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


- Country of Orig.: sku_country_of_origin

- Harmonize Code: harmonize_code

- Item description: odt_item_desc


Soldout items: Soldout items are included on the Quote Confirmation regardless of the Exclude S/O on order confirmation setting for the order type on the quote.

• totals:



- Tax: ost_tax


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.








Membership Cancellation Notification Sample and ContentsSee 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





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






Cancellation Request Failure Email Sample and ContentsSee the Order Maintenance Confirmation Email Program (H12) system control value on how to generate this email.



Contents: The contents of the cancellation request failure 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



Order Information Summary:



Sold To Information:




Order Cancellation Confirmation Email Sample and ContentsSee the Order Cancellation Email Program (K78) system control value for information on how to generate this email.



Contents: The contents of the order cancellation confirmation email are derived from the Outbound Email XML Message (CWEmailOut) as follows:




- Valued customer



Order Cancellation Summary:



For each open or held order line from the order when you canceled it:




- 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.



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.








Order Line Cancellation Confirmation Email Sample and ContentsSee 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:




- Valued customer





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










Store Pickup Notification Sample and ContentsSee the Store Pickup Confirmation Email Program (L48) in the online help for information on how to generate this email.


Contents: The contents of the store pickup notification email are derived from the Outbound Email XML Message (CWEmailOut) as follows:






- Valued customer



Order Summary:



• For each item on the order:


- Quantity: odt_qty

- Price: odt_price


- Item description: odt_item_desc


• totals:



- Tax: ost_tax


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






Oracle Retail Customer Engagement Loyalty Registration Notification Sample and Contents

See the Oracle Retail Customer Engagement Loyalty Registration Notification Email Program (M10) in the online help for information on how to generate this email.

Contents: The contents of the Oracle Retail Customer Engagement loyalty registration notification email are derived from the Outbound Email XML Message (CWEmailOut) as follows:




- sold_to_company



• Here is your Loyalty Card number: the loyalty card number generated and signed to the customer from Oracle Retail Customer Engagement.




Work with E-Mail Template Screen


Simple Format Notification SampleThe loyalty activation/deactivation and purchase order use a simple email format such as the following.

Work with E-Mail Template ScreenPurpose: 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.

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.

Brown, Elizabeth

From: [email protected]

Sent: Friday, February 2, 2009 4:22 p.m.

To: [email protected]

Subject: 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: JONES, MICHAEL Customer #: 13082

PREFERRED MEMBERS CLUB PREFERRED

Welcome to the club! We appreciate your business.

Work with E-Mail Template Screen


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)

• Loyalty Activate Notice (template LA)

• Loyalty Deactivate Notice (template LD)

• Oracle Retail Customer Engagement 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)



Enter or change the contents of an email notification template

Select Change for a template to advance to the Change E-Mail Template Screen.

Change E-Mail Template Screen


Change E-Mail Template ScreenPurpose: Use this screen to specify the standard text to include in one of the types of email notifications available in Order Management System 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.

How to display this screen: Select Change for a notice type at the Work with 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.

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 email

Unselected = 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 or purchase order templates.

• This setting applies if the system uses the associated text template.

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.




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


Testing Email Generation (UEML) 589

2Testing Email Generation (UEML)

Purpose: Use this option to generate a test email in order to confirm that Order Management System is correctly configured to generate emails.

This option does not support testing individual message notification types.

Send Email Message ScreenHow 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.


Subject The text to use as the subject line for the test email.


Message Up to four lines of text to include in the body of the email.

Alphanumeric, 64 positions each; at least one line required.

590

221E-Commerce-Related Jobs in Order

Management System

The following menu options provide the jobs that run within Order Management System to support the e-commerce integration:

• Downloading E-Commerce Static Tables (ESTF)

• Downloading E-Commerce Offer Files (EOFR)


• Removing Offers and Items from Download (ERMV)

Downloading E-Commerce Static Tables (ESTF) 591

231Downloading 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

• 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 e-commerce static tables download.

• Clear the records from each target table before running the extract to make sure that you capture the most up-to-date information from Order Management System, as the extract process does not always write updated information in the extract table if there is already an existing record.

E-Commerce Download Overview


In this chapter:

• E-Commerce Download Overview

• Process E-Commerce Downloads Screen

• Static Table Download Summary


Types of DownloadsTo improve response time on the web storefront, you can download key information from Order Management System 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 Order Management System 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.

• Frequent: information, such as item availability levels, that may require update. See the periodic functions described below.

Periodic Functions Related to E-CommerceItem 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.

Download ProcessFor 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 Order Management System be automatically deleted on the web storefront as well. You must delete any unneeded information separately in Order Management System 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 ScreenHow 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.

All records in each related table for your company will be selected for download, unless noted otherwise in the field descriptions below.



Note: The Get Orders from E-Commerce (G35) system control value must be selected in order for you to run the e-commerce static tables download.

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) 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.

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.



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 Leave this field unselected.

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.

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.

Field Description

Static Table Download Summary


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.

Static Table Download SummaryPurpose: 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.

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.

Order Management System 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)

Field Description



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) 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.

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)

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)



Downloading E-Commerce Offer Files (EOFR) 598

241Downloading E-Commerce Offer Files

(EOFR)

Purpose: Use the Download E-Commerce Offer Files 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.

Type of download: The setting of the Generate E-Commerce Offer Tables (M29) system control value defines the output of the e-commerce offer download.

• If this system control value is selected, the e-commerce offer download (EOFR) populates the E-Commerce Offer Staging tables; see Offer-Related Table Extract Summary.

• If this system control value is unselected, the e-commerce offer download (EOFR) generates the E-Commerce Product Web XML File (ProductWeb).

Additional downloads: Other downloads available for the e-commerce interface are:

• static tables

• item availability and item changes


• Downloading E-Commerce Static Tables (ESTF) for an overview of the download process related to the e-commerce interface, including the additional downloads.

• the E-Commerce Integration Manual for information on the storefront database schema.

In this chapter:

• Process E-Commerce Downloads Screen

• Offer-Related Table Extract Summary

• E-Commerce Product Web XML File (ProductWeb)

Process E-Commerce Downloads ScreenHow 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 include the selected offer information in the e-commerce offer download for subsequent transfer to the web storefront. Only the offer(s) you enter at this screen will be included.

Valid values are:

Selected (default) = download the selected offer(s).

Unselected = do not download the offer(s).

Sources Indicates whether to include source codes associated with the selected offer in the e-commerce offer download for subsequent transfer to the web storefront. Only source codes associated with the offer you enter at the From offer field will be included.

Valid values are:

Selected (default) = include source codes associated with the selected offer.

Unselected = do not include source codes.

All items Indicates whether to include all items, SKUs, and all other related offer information in the e-commerce offer download for subsequent transfer to the web storefront. All items related to the offer(s) you enter at this screen will be included.

Valid values are:

Selected (default) = include item-related information for all items associated with the selected offer(s).

Unselected = do not include item-related information for all items.

Select 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 include only new items in the e-commerce offer download for subsequent transfer 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 = The e-commerce offer download includes item-related information for only new items associated with the selected offer(s); only items which have not been previously extracted are included in the download. When you submit the download, the system updates the Ecommerce Extract Date field in the Item Offer table with the date of the extract; the system uses this field to determine whether the item has previously been included in an e-commerce offer download.

Unselected (default) = do restrict extract of item-related information to only new items.

Select 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 include 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 = include 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 includes the latest current price (the most current price whose Effective date is not in the future).

Unselected (default) = include 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.

Field Description


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 = include all existing SKU Offer and SKU Price information, even if it is identical to the corresponding Item Offer and Item Price information.

Unselected (default) = include SKU Offer and SKU Price information only if it differs from the Item Offer and Item Price information:

• SKU Price information is updated 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.

• SKU Offer information is updated only if the special handling or gift wrap information for the SKU Offer is different from the Item Offer.

• This field displays only if the Generate E-Commerce Offer Tables (M29) system control value is selected.

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.


Description The description of an offer you have specified for download to the web storefront.


Start date The first date when the selected offer is effective for processing orders. From the Offer date range specified for the offer.


End date The last date when the selected offer is effective for processing orders. From the Offer date range specified for the offer.


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

Offer-Related Table Extract Summary


Offer-Related Table Extract SummaryPurpose: 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. The system populates these tables when you submit the e-commerce offer download and the Generate E-Commerce Offer Tables (M29) system control value is selected.

Information included: The e-commerce offer download 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.

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

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.

Also, the system submits the job ECOMM_OFR, which extracts the selected information for download.

5. The setting of the Generate E-Commerce Offer Tables (M29) system control value defines the output of the e-commerce offer download.

• If this system control value is selected, the e-commerce offer download (EOFR) populates the E-Commerce Offer Staging tables; see Offer-Related Table Extract Summary for a listing of the information included in the extract.

• If this system control value is unselected, the e-commerce offer download (EOFR) generates the E-Commerce Product Web XML File (ProductWeb). Note: If an active procedure exists, the system does not generate the ProductWeb file and instead writes an error message to the application log.



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):

Note: Clear the records from each target table before running the extract to make sure that you capture the

Date Quantity Price

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.



most up-to-date information from Order Management System, as the extract process does not always write updated information in the extract table if there is already an existing record.

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.

OROMS 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 code

Offer code

Description

Start date

End 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 code

Source code

Source code description

Discount percentage

Offer

If you select the Items or New Items field at the Process E-Commerce Downloads screen:

Long SKU Class (INLSKC)

OR

Retail Class (INRTCP)

EC Class (EXCLAS)

Company code

Long SKU department code

Long SKU class code

Long 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 code

Item code

Cross-sell item code

Cross-sell description

Coordinate sequence

Coordinate 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 code

Long SKU department code

Long SKU department description

Shipper/Item (OESHIM)

EC Extra Shipping (EXSCIT)

Company code

Ship via code

Item code

Extra shipping charge

Hazard (INHZRD)

EC Hazard (EXHAZA)

Company code

Hazard code

Hazard description




Item (INITEM) EC Item (EXITEM)

Company code

Item code

Item description

Height

Length

Width

Selling quantity

Shipping weight

Unit of measure code

Vendor number

Second language description

SKU? (0=N, 1=Y)

Active on web? (0=N, 1=Y)

Long SKU department

Long SKU class

Long SKU category

Hazard code

User fields 1 through 4

Status

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)

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 code

Offer code

Item code

Breakpoint quantity

Price

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.

Item Offer (INIOFR)

EC Offer Item Link (EXIOFL)

Company code

Offer code

Item code

Price (single unit)

Special handling price

Item alias

Gift wrap price

Custom 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 code

Offer code

Item code

Short SKU

Price (single-unit)

Special handling price

Gift wrap price

Custom 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.




SKU (INSKU) EC SKU (EXSKU)

Company code

Item code

Short SKU (assigned by the system at SKU creation)

SKU code

SKU description

SKU element 1 through 3

SKU element 1 through 3 description

Restrict orders? (0=N, 1=Y)

User fields 1 through 5

Soldout control code

Status

UPC 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 code

Offer code

Item code

Short SKU (assigned by the system at SKU creation)

Breakpoint quantity

Price

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.

Keyword (INKWDP)

EC Keyword (EXKEYW)

Company code

Item code

Keyword

Page Letter Alias (INPLAL)

EC Alias Item (EXITMA)

Company code

Item code

Offer

Alias item

Order Management System includes all item aliases for an item for the offer selected in the e-commerce download.


E-Commerce Product Web XML File (ProductWeb)


E-Commerce Product Web XML File (ProductWeb)Purpose: The E-Commerce Product Web XML file (ProductWeb) contains item offer information for the offers selected to download on the Process E-Commerce Downloads Screen. The system generates this file when Downloading E-Commerce Offer Files (EOFR) if the Generate E-Commerce Offer Tables (M29) system control value is unselected.

Location of file: The ECOMMERCE_DIRECTORY_PATH in Working with Admin Properties (CPRP) defines the location on the application server where the system downloads the E-Commerce Product Web XML file. An example of the directory is /domain/conf/OMSFiles/WebData/, where domain is the WebLogic domain directory for Order Management System. Note: If an ECOMMERCE_DIRECTORY_PATH is not valid or is blank, or the specified folder does not exist, the system does not generate the ProductWeb file and writes an error message to the Application log.

Name of file: The name of the file is ProductWeb_999_YYMMDDHHMMSS.xml, where 999 is the company code where you submitted the e-commerce offer download and YYMMDDHHMMSS is the date and time when the download occurred.

XML version: The ECOMMERCE_PRODUCT_XML_VERSION in Working with Customer Properties (PROP) defines the XML version of the ProductWeb XML file.

ECommerce extract date: For each item offer included in the ProductWeb XML file, the system updates the ECommerce Extract Date field in the Item Offer table with the date when the e-commerce offer download was submitted. The system uses this date if you select to include only new items in the e-commerce offer download to determine which items are new and which items have previously been downloaded.

Application log: The system writes any messages related to the e-commerce offer download to the application log.

Active procedure: The system creates an active procedure while the ProductWeb file is generated; once the e-commerce offer download process completes, the system clears the active procedure.

Sample message: See Sample E-Commerce Product Web XML Message (ProductWeb) for a sample message.

Note: The system includes all tags in the file, even if the tag is blank.

Item Ship Via Override (INISVO)

EC Item Ship Via Override (EXISVO)

Company code

Item number

Shipping code

Order Management System only populates this table if records exist in the Item Ship Via Override table for an item.


Header




CompanyCode numeric 3 The code for the company where the e-commerce download was submitted.

Offer

The offers selected to download on the Process E-Commerce Downloads Screen.

Offer alpha 3 A code for the offer included in the e-commerce download. From Offer Number in the Offer table.

OfferDescription alpha 30 A description of the offer. From Offer Description in the Offer table.

Currency alpha 3 The currency for orders you process for this offer when using alternate currency pricing.From Ofr Currency Code in the Offer table.

StartDate numeric 8 The start date, in MMDDYYYY format, for the prices you define for this offer. Orders entered prior to the start date and after the end date will not use these prices. From Start Date in the Offer table.

EndDate numeric 8 The end date, in MMDDYYYY format, for the prices you define for this offer. Orders entered prior to the start date and after the end date will not use these prices. From Offer Stop Date in the Offer table.

SourceCode

The source codes selected to download on the Process E-Commerce Downloads Screen.

SourceCode alpha 9 The source code associated with the offer. From Src Source Code in the Source table.

SrcDescription alpha 30 A description of the source code. From Src Description in the Source table.




DisPercentage numeric 5.2 A discount for orders assigned to this source code. This discount does not apply to orders with a Use Item Cost, No Charge, or No Charge/No Cost pricing method, or to order lines with a price override reason code applied. This discount is applied in addition to any discounts resulting from other pricing methods. The discount is calculated during Order Entry or Order Maintenance.This discount applies only to items with a Y in the Discountable field in the Item or SKU table.From Src Discount in the Source table.

Offer alpha 3 A code for the offer associated with the source code. From Offer Number in the Source table.

Item

The items defined for the offer.• If All items was selected on the Process E-Commerce Downloads Screen, the

system includes all items assigned to at least one of the selected offers.

• If New items was selected on the Process E-Commerce Downloads Screen, the system includes only items assigned to at least one of the selected offers and whose Ecommerce Extract Date field in the Item Offer table is blank.

ItemNumber alpha 12 A code for an item defined in the offer. From Itm Number in the Item table.

Description alpha 40 A description of the item. From Description in the Item table.

AllowSKUs alpha 1 Indicates whether the item is available in various styles, such as color, size, etc.Valid values are:Y = This item has SKUs associated with it.

N = There are no SKUs associated with this item.

From Allow SKUs in the Item table.

Height numeric 3 The height measurement for an item. The Height, Length, and Width values determine the cubic volume of an item.From Item Height in the Item table.




Length numeric 3 The length measurement for an item. The Height, Length, and Width values determine the cubic volume of an item.From Item Length in the Item table.

Width numeric 3 The width measurement for an item. The Height, Length, and Width values determine the cubic volume of an item.From Width in the Item table.

SellQty numeric 5 The selling quantity defines the required order quantity (or multiple of) for this item. For example, an item may be stocked in single units, but must be sold in quantities of 6 (or 12, or 18, etc.).From Selling Qty in the Item table.

ShipWeight numeric 7.3 The actual shipping weight of the item.From Ship Weight in the Item table.

UnitOfMeasure alpha 3 A standard by which an item is sold. Typical units of measure include:• EA = each

• IN = inches

• C12 = case of 12

From Unit Of Measure in the Item table.

VendorNumber numeric 7 A user-defined code that represents the vendor or supplier of an item.From Vendor # in the Item table.

DescSecondLanguage

alpha 40 From Itm Second Language Desc in the Item table.

Department numeric 4 A code used to group items into departments for reporting purposes.From LSD Department in the Item table.

DepartmentDesc alpha 30 A description of the long SKU department. From Description in the Long SKU Department table.

Class numeric 4 A code you can use to group items into classes for reporting purposes. From Item Class in the Item table.




ClassDesc alpha 30 A description of the item class. From Item Class Description in the Item Class table.

HazardCode numeric 2 A code used to categorize the item as a hazardous material that requires special storage and handling.From Haz Code in the Item table.

HazardDesc alpha 40 A description of the hazard code.From Description in the Hazard table.

ItemStatus alpha 1 A code that represents an item’s status, such as discontinued or active.From Item Status in the Item table.

Discountable 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 Itm Allow P Discount field in the Item table.

NonInventory 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.




SVCType 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 = 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.

From Itm SVC Type in the Item table.

DropShip 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 (non-drop ship) = You ship the item from your warehouse.

From Drop Ship Item in the Item table.

Oversize alpha 1 Determines whether the item is considered an oversized item.Y = The item is oversized.

N = The item is not oversized.

From Itm Oversize Flag in the Item table.

ShipAlone alpha 1 Indicates how to ship the item.S = The item must ship by itself, and each unit prints on its own pick slip.

blank = The item can ship with other items.

From Ship Alone in the Item table.




Set alpha 1 Indicates whether the item is a set item. Y = the item is a set item (the Kit type for the item is Set). N = the item is not a set item. From Kit type in the Item table.

OROBEligible alpha 1 Y = Include this item when you send item and inventory information to Oracle Retail Order Broker; also, the item is eligible to be sent to the Order Broker on brokered backorders, store pickup, or ship-for-pickup orders.N = Do not include this item when you send item and inventory information to Oracle Retail Order Broker; also, the item is not eligible to be sent to the Order Broker on brokered backorders, store pickup, or ship-for-pickup orders.

UserField1 alpha 10 A user-defined field for the item.From User Field 1 in the Item table.




ItemOffer

One or more offers is included for each item.

ItemOffer alpha 3 A code that represents the offer where the item is advertised.From Offer Number in the Item Offer table.

ItemPrice numeric 7.2 The standard price for the item in the offer.From Standard Price in the Item Offer table.

EffectiveDate numeric 7 The date the price becomes valid for the item offer, in MMDDYYYY format. From Effective Date in the Item Price table.




GiftWrap 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 Gift Wrap Flag in the Item Offer table.

GiftWrapPrice numeric 7.2 The price in the offer for gift wrapping the item.From Gift Wrap Price in the Item Offer table.

PersonalizationPrice numeric 7.2 The price to charge the customer for special handling.From S H Price in the Item Offer table.

PersonalizationCode 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 Special Handling in the Item Offer table.

FreightExempt alpha 1 Indicates whether the item is exempt from freight in this offer. Y = The item is exempt from freight; a record exists in the Freight Exempt file for this item and offer. N = The item is not exempt from freight in this offer.




ItemPrice

If Future prices is selected on the Process E-Commerce Downloads Screen, the system includes the most current item price for each quantity (price with an effective date equal to or earlier than the current date) and all future prices (prices with an effective date greater than the current date). If Future prices is unselected on the Process E-Commerce Downloads Screen, the system includes the most current price for each quantity (price with an effective date equal to or earlier than the current date).Example: An item contains the following prices:

qty 1, 12/01/15, 90.00 (past price)qty 1, 12/08/15, 80.00 (most current price for a quantity of 1)qty 1, 12/10/15, 75.00 (future price)qty 2, 12/01/15, 80.00 (past price)qty 2, 12/08/15, 70.00 (mist current price for a quantity of 2)qty 2, 12/10/15, 65.00 (future price)

If Future prices is selected, the system includes the following prices:

qty 1, 12/08/15, 80.00 (most current price for a quantity of 1)qty 1, 12/10/15, 75.00 (future price)qty 2, 12/08/15, 70.00 (mist current price for a quantity of 2)qty 2, 12/10/15, 65.00 (future price)

If Future prices is unselected, the system includes the following prices:

qty 1, 12/08/15, 80.00 (most current price for a quantity of 1)qty 2, 12/08/15, 70.00 (mist current price for a quantity of 2)

Qty numeric 7 The quantity of the item that the customer must order to receive the price.From Qty in the Item Price table.

Price numeric 7.2 The price at which the item is sold.From Price in the Item Price table.

EffectiveDate numeric 8 The date, in MMDDYYYY format, the price or quantity break discount becomes valid.From Effective Date in the Item Price table.

ItemAlias

AliasNumber alpha 12 The alternate item code for the actual item.From ECA Alias Item in the EC Alias Item table.

SKU

At least one SKU element is included for each item since information is included at the SKU level even for non-SKUed items.




ShortSKU numeric 7 The short SKU number defined for the SKU, used to identify the SKU.From Short SKU in the SKU table.

SKUCode alpha 14 The SKU code for the item, such as style, color, and/or size. The system separates each SKU code with a single space, for example: RED SML WMNS. From SKU Code in the SKU table.

SKUDescription alpha 40 A description of the SKU.From Description in the SKU table.

SKUElement1Code alpha 4 A code representing a SKU element, such as blue (color) or small (size).From SEO Code in the SKU table.

SKUElement1Desc alpha 10 A description of the SKU element, such as navy blue.From Element 1 Desc in the SKU Element 1 table.

SKUElement2Code alpha 4 A code representing a SKU element, such as blue (color) or small (size).From SEW Code in the SKU table.


SKUElement3Code alpha 4 A code representing a SKU element, such as blue (color) or small (size).From Set Code in the SKU table.


ItemSKU alpha 27 The item number and SKU codes using the full field lengths, separated by a space. The system does not include any extra space at the end; for example, if the SKU code for item REGULAR is RED, the ItemSKU is REGULAR RED. Item number is 12 positions. SKU code is 14 positions.




RestrictOrders 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 Restrict Orders in the SKU table.

RetailReference numeric 15 The retail reference number assigned to the SKU.From Retail Reference # in the SKU table.

Category alpha 4 A code assigned to the SKU to classify and group like items for use in item relationships and compatibility.From SKU ITC Category in the SKU table.

SKUStatus alpha 1 The status of the item, such as discontinued.From SKU IST Item Status in the SKU table.

SoldOutCode alpha 2 The soldout control code specified for the SKU.From SLC Code in the SKU table.

SoldOutType 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 Status in the Soldout Control table.

SKUCost numeric 11.4 The cost of the SKU, based on the costing method defined in the Costing Method (A25) system control value. If set to STANDARD, from the SKU Standard Cost in the SKU table.

If set to AVERAGE, from the SKU Average Cost in the SKU table.

If set to FIFO, from the SKU FIFO Cost in the SKU table.




SKUOriginalPrice numeric 7.2 The original price for the SKU.From List Price in the SKU table.

UserField1 alpha 10 A user-defined field for the SKU.From User Field 1 in the SKU table.





SKUOffer

All SKU offers defined for the offers selected for e-commerce download are included, regardless of whether the information differs from the item offer or not.

SKUOffer alpha 3 A code that represents the offer where the SKU is advertised.From Offer Number in the SKU Offer table.

SKUPrice numeric 7.2 The price at which the SKU is sold in the offer.From Price in the SKU Price table.

EffectiveDate numeric 7 The date the price becomes valid, in MMDDYYYY format.From Effective Date in the SKU Price table.

GiftWrap 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 Gift Wrap Flag in the SKU Offer table.

GiftWrapCost numeric 7.2 The price for gift wrapping the SKU.From Gift Wrap Price in the SKU Offer table.

PersonalizationPrice numeric 7.2 The price to charge the customer for special handling.From S H Price in the SKU Offer table.




PersonalizationCode 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 Special Handling Flag in the SKU Offer table.

SKUPrice

One or more SKU prices are included for each SKU offer.

Qty numeric 7 The quantity of the SKU the customer must order to receive the discounted price.From Qty in the SKU Price table.

Price numeric 7.2 The price at which the SKU is sold in the offer.From Price in the SKU Price table.

EffectiveDate numeric 7 The date the price or quantity break becomes valid, in MMDDYYYY format.From Effective Date in the SKU Price table.

UPCCode

UPCCode alpha 14 The UPC code defined for the SKU.From UPC in the Item UPC table.

SetComponent

Included only if ECI SET is Y for the item.

SKUCode alpha 14 The SKU associated with the set component. From SKU Code in the Set Detail table.

SetQty numeric 5 The number of units of the item to include in one set.From Qty in the Set Details table.

SetCompItemNumber

alpha 12 A component item of the set item.From Set Comp Item Number in the Set Details table.

SetCompSKUCode alpha 14 The SKU of the component item.From Set Comp SKU Code in the Set Details table.

CrossSellCoordinate

Included only if a record exists in the Cross-Sell table for the item.




CrossSellItem alpha 12 The related item coordinated to the primary item for cross-selling purposes.From ICN Coordinate Item in the Item Coordinate table.

CrossSellDesc alpha 70 The persuasive or descriptive message to display for the coordinate item.From ICN Message in the Item Coordinate table.

CoordinateSequence 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 ICN Sequence in the Item Coordinate table.

CoordinateType alpha 2 A code representing a type of item coordinate, such as mandatory or optional.From ICN Coordinate Type in the Item Coordinate table.

Keyword

Included only if a record exists in the Keyword table for the item.

Keyword alpha 20 The word you wish to include or exclude as a keyword, based on the keyword type.From KWD Keyword Exclusion in the Keyword table.

ShipViaOverride

Included only if a record exists in the Item Ship Via Override table for the item.

ShippingCode numeric 2 The code for a shipper you can select as a ship via override for the item.Ship via codes are defined in and validated against the Ship Via table.From Via Ship Via Code in the Item Ship Via Override table.

ExtraShipping

Included only if a record exists in the Shipper Item table for the item.

ExtraShippingCode alpha 12 The code for the item associated with the extra shipping cost. From Via Ship Via Code in the Shipper Item table.




Sample E-Commerce Product Web XML Message (ProductWeb)A sample of the E-Commerce Product Web XML message (ProductWeb) is presented below.

<?xml version="1.0" encoding="UTF-8"?><Header CompanyCode="7">

<Offers><Offer EndDate="07312019" StartDate="07012015" Currency="" OfferDescription="MAIN OFFER" Offer="OFR"/>

</Offers><SourceCodes>

<SourceCode Offer="OFR" DiscPercentage="5.00" SrcDescription="MAIN SOURCE" SourceCode="SOURCE"/>

</SourceCodes><Items>

<Item UserField4="USERFIELD4" UserField3="USERFIELD3" UserField2="USERFIELD2" UserField1="USERFIELD1" OROBEligible="Y" Set="N" ShipAlone="" NonInventory="N" Oversize="N" DropShip="N" SVCType="" Discountable="Y" ItemStatus="1" HazardDesc="1 HAZARD CODE" HazardCode="1" ClassDesc="1 ITEM CLASS" Class="1" DepartmentDesc="7777 LONG SKU DEPARTMENT" Department="7777" DescSecondLanguage="ITEM SECOND LANGUAGE DESCRIPTION" VendorNumber="7" UnitOfMeasure="EA" ShipWeight="5.000" SellQty="3" Width="6" Length="24" Height="12" AllowSKUs="N" Description="ITEM DESCRIPTION" ItemNumber="ITEM">

<ItemOffers><ItemOffer FreightExempt="N" PersonalizationCode="MO" PersonalizationPrice="5.00" GiftWrapPrice="5.00" GiftWrap="Y" EffectiveDate="12012015" ItemPrice="90.00" ItemOffer="OFR">

<ItemPrices><ItemPrice EffectiveDate="12012015" Price="90.00" Qty="1"/><ItemPrice EffectiveDate="12012015" Price="75.00" Qty="2"/><ItemPrice EffectiveDate="12102015" Price="80.00" Qty="1"/>

</ItemPrices><ItemAliases>

<ItemAlias AliasNumber="AITEM"/></ItemAliases>

</ItemOffer></ItemOffers><SKUs>

<SKU UserField4="USER4" UserField3="USERFIELD3" UserField2="USERFIELD2" UserField1="USERFIELD1" UserField5="USER5" SkuOriginalPrice="100.00" SkuCost="40.00" SoldOutType="" SoldOutCode="" SkuStatus="" RetailReference="12012015" RestrictOrders="N" ItemSku="ITEM" SkuElement3Desc="" SkuElement3Code="" SkuElement2Desc="" SkuElement2Code="" SkuElement1Desc="" SkuElement1Code="" SkuDescription="" Category="ICAT" SkuCode="" ShortSku="115">

<SKUOffers/><UPCCodes>

<UPCCode code="12011510"/></UPCCodes>

</SKU></SKUs><CrossSellCoordinates>

ExtraShippingCost numeric 5.2 The extra charge that is added to orders for this item.From SIT Extra Charge in the Shipper Item table.




<CrossSellCoordinate CoordinateType="" CoordinateSequence="0" CrossSellDesc="Item Coordinate Message for primary item ITEM and coordinate item SKU" CrossSellItem="SKU"/>

</CrossSellCoordinates><Keywords>

<Keyword Keyword="DESCRIPTION"/><Keyword Keyword="ITEM"/>

</Keywords><ShipViaOverrides>

<ShipViaOverride ShippingCode="1"/></ShipViaOverrides><ExtraShippings>

<ExtraShipping ExtraShippingCost="5.00" ExtraShippingCode="1"/></ExtraShippings>

</Item><Item UserField4="" UserField3="" UserField2="" UserField1="" OROBEligible="Y" Set="Y" ShipAlone="" NonInventory="N" Oversize="N" DropShip="N" SVCType="" Discountable="Y" ItemStatus="" HazardDesc="" HazardCode="0" ClassDesc="" Class="" DepartmentDesc="" Department="0" DescSecondLanguage="SET SECOND LANGUAGE DESCRIPTION" VendorNumber="0" UnitOfMeasure="EA" ShipWeight="0.000" SellQty="0" Width="0" Length="0" Height="0" AllowSKUs="N" Description="SET ITEM" ItemNumber="SET">

<ItemOffers><ItemOffer FreightExempt="N" PersonalizationCode="" PersonalizationPrice="0.00" GiftWrapPrice="0.00" GiftWrap="N" EffectiveDate="11242015" ItemPrice="100.00" ItemOffer="OFR">

<ItemPrices><ItemPrice EffectiveDate="11242015" Price="100.00" Qty="1"/>

</ItemPrices><ItemAliases/>


<SKU UserField4="" UserField3="" UserField2="" UserField1="" UserField5="" SkuOriginalPrice="0.00" SkuCost="0.00" SoldOutType="" SoldOutCode="" SkuStatus="" RetailReference="0" RestrictOrders="N" ItemSku="SET" SkuElement3Desc="" SkuElement3Code="" SkuElement2Desc="" SkuElement2Code="" SkuElement1Desc="" SkuElement1Code="" SkuDescription="" Category="" SkuCode="" ShortSku="7"><SKUOffers/></SKU>

</SKUs><SetComponents>

<SetComponent SkuCode="" SetCompSkuCode="" SetCompItemNumber="SETCOMP1" SetQty="1"/><SetComponent SkuCode="" SetCompSkuCode="RED" SetCompItemNumber="SETCOMP2SKU" SetQty="1"/>

</SetComponents><CrossSellCoordinates/><Keywords>

<Keyword Keyword="ITEM"/><Keyword Keyword="SET"/>

</Keywords><ShipViaOverrides/><ExtraShippings/>

</Item><Item UserField4="USERFIELD4" UserField3="USERFIELD3" UserField2="USERFIELD2" UserField1="USERFIELD1" OROBEligible="Y" Set="N" ShipAlone="" NonInventory="N" Oversize="N" DropShip="N" SVCType="" Discountable="Y" ItemStatus="1" HazardDesc="" HazardCode="0" ClassDesc="1 ITEM CLASS" Class="1" DepartmentDesc="7777 LONG SKU DEPARTMENT" Department="7777" DescSecondLanguage="" VendorNumber="7" UnitOfMeasure="EA" ShipWeight="5.000" SellQty="1" Width="12" Length="12"



Height="12" AllowSKUs="Y" Description="SKU ITEM DESCRIPTION" ItemNumber="SKU">

<ItemOffers><ItemOffer FreightExempt="N" PersonalizationCode="" PersonalizationPrice="0.00" GiftWrapPrice="0.00" GiftWrap="N" EffectiveDate="10202015" ItemPrice="50.00" ItemOffer="OFR">

<ItemPrices><ItemPrice EffectiveDate="10202015" Price="50.00" Qty="1"/>

</ItemPrices><ItemAliases/>


<SKU UserField4="USER4" UserField3="USERFIELD3" UserField2="USERFIELD2" UserField1="USERFIELD1" UserField5="USER5" SkuOriginalPrice="150.00" SkuCost="45.00" SoldOutType="" SoldOutCode="" SkuStatus="" RetailReference="0" RestrictOrders="N" ItemSku="SKU RED" SkuElement3Desc="" SkuElement3Code="" SkuElement2Desc="" SkuElement2Code="" SkuElement1Desc="BERRY RED" SkuElement1Code="RED" SkuDescription="RED SKU" Category="ICAT" SkuCode="RED" ShortSku="5">

<SKUOffers><SKUOffer PersonalizationCode="MO" PersonalizationPrice="5.00" GiftWrap="Y" EffectiveDate="12012015" GiftWrapCost="5.00" SkuPrice="100.00" SkuOffer="OFR">

<SKUPrices><SKUPrice EffectiveDate="12012015" Price="100.00" Qty="1"/><SKUPrice EffectiveDate="12052015" Price="70.00" Qty="2"/><SKUPrice EffectiveDate="12102015" Price="70.00" Qty="1"/>

</SKUPrices></SKUOffer>

</SKUOffers><UPCCodes>

<UPCCode code="12011511"/></UPCCodes>

</SKU><SKU UserField4="" UserField3="" UserField2="" UserField1="" UserField5="" SkuOriginalPrice="0.00" SkuCost="0.00" SoldOutType="" SoldOutCode="" SkuStatus="" RetailReference="0" RestrictOrders="N" ItemSku="SKU BLUE SML WMNS" SkuElement3Desc="WOMENS" SkuElement3Code="WMNS" SkuElement2Desc="SMALL" SkuElement2Code="SML" SkuElement1Desc="DENIM BLUE" SkuElement1Code="BLUE" SkuDescription="BLUE SML WMNS SKU DESCRIPTION" Category="" SkuCode="BLUE SML WMNS" ShortSku="118">

<SKUOffers/></SKU><SKU UserField4="" UserField3="" UserField2="" UserField1="" UserField5="" SkuOriginalPrice="0.00" SkuCost="0.00" SoldOutType="" SoldOutCode="" SkuStatus="" RetailReference="0" RestrictOrders="N" ItemSku="SKU GRN SML WMNS" SkuElement3Desc="WOMENS" SkuElement3Code="WMNS" SkuElement2Desc="SMALL" SkuElement2Code="SML" SkuElement1Desc="JADE GREEN" SkuElement1Code="GRN" SkuDescription="GRN SML WMSN SKU DESCRIPTION" Category="" SkuCode="GRN SML WMNS" ShortSku="119">

<SKUOffers/></SKU><SKU UserField4="" UserField3="" UserField2="" UserField1="" UserField5="" SkuOriginalPrice="0.00" SkuCost="0.00" SoldOutType="" SoldOutCode="" SkuStatus="" RetailReference="0" RestrictOrders="N" ItemSku="SKU RED SML WMNS"



SkuElement3Desc="WOMENS" SkuElement3Code="WMNS" SkuElement2Desc="SMALL" SkuElement2Code="SML" SkuElement1Desc="BERRY RED" SkuElement1Code="RED" SkuDescription="RED SML WMNS SKU DESCRIPTION" Category="" SkuCode="RED SML WMNS" ShortSku="117">

<SKUOffers/></SKU><SKU UserField4="" UserField3="" UserField2="" UserField1="" UserField5="" SkuOriginalPrice="0.00" SkuCost="0.00" SoldOutType="" SoldOutCode="" SkuStatus="" RetailReference="0" RestrictOrders="N" ItemSku="SKU YELW SML WMNS" SkuElement3Desc="WOMENS" SkuElement3Code="WMNS" SkuElement2Desc="SMALL" SkuElement2Code="SML" SkuElement1Desc="SUN YELLOW" SkuElement1Code="YELW" SkuDescription="YELW SML WMNS SKU DESCRIPTION" Category="" SkuCode="YELW SML WMNS" ShortSku="120">

<SKUOffers/></SKU>

</SKUs><CrossSellCoordinates/><Keywords>

<Keyword Keyword="DESCRIPTION"/><Keyword Keyword="ITEM"/><Keyword Keyword="SKU"/>

</Keywords><ShipViaOverrides/><ExtraShippings>

<ExtraShipping ExtraShippingCost="5.00" ExtraShippingCode="1"/></ExtraShippings>

</Item></Items>

</Header>

Removing Offers and Items from Download (ERMV) 627

251Removing 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 when the Generate E-Commerce Offer Tables (M29) system control value is selected.

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 Files (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 system should include them when extracting updates.

Remove Offers and Items from Download ScreenUse 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.

Note: The Get Orders from E-Commerce (G35) system control value must be selected in order for you to remove offer, item, or item/SKU information from the e-commerce extract tables.

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.


Completing this screen:

• Enter the Offer to remove from the extract tables in order to discontinue sending updates; or,

• 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.

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.


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.


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.


• Click OK. The system displays 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 SKUed 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

Specify an offer to delete. A SKUed 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.

Specify the base item of a SKUed item to delete. The SKUed 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 SKUs

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 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 SKU

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 SKU

Scenario Result

Sending Internet Order Ship Confirmation (ESCF) 631

261Sending 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 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, Order Management System 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 (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 EmailsOverview: 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

• 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.

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 (in user date 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 (in user date format); required.


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.

634

271E-Commerce Tables

Purpose: You extract data from regular Order Management System tables into the tables listed below, which are available for subsequent transmission to your web storefront database.

In this chapter:

• E-Commerce Static Tables on page 27-634

• E-Commerce Offer Tables on page 27-637

• Additional Downloads on page 27-642

E-Commerce Static TablesPurpose: The Download E-Commerce Static Files menu option (ESTF) extracts data to the following tables.

CompanyTable: 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

E-Commerce Static Tables

635

• CNT description

StateTable: EC State (EXSTAT)

Contents:

• RPR country

• State code

• STE description

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?

E-Commerce Static Tables

636

Personalization valuesTable: EC Personalization Values (EXPRSV)

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

Return reasonTable: EC Return Reason (EXRTRS)

Contents:

• Company code

• Return reason

E-Commerce Offer Tables

637

• 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

E-Commerce Offer TablesThe 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


638

ClassTable: EC Class (EXCLAS)

Contents:

• Company code

• Department

• Class

• Class description

Cross-SellTable: EC Cross-Sell (EXCSEL)

Contents:

• Company code

• Item number

• Cross sell item

• Cross-Sell Desc

• Coordinate sequence

• Coordinate type

DepartmentTable: EC Department (EXDEPT)

Contents:

• Company code

• Department

• Dept description

Extra shippingTable: EC Extra Shipping (EXSCIT)

Contents:

• Company code

• Shipping code

• Item number

• Extra shipping

HazardTable: EC Hazard (EXHAZA)

Contents:

• Company code

• Hazard code


639

• 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?

• 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


640

• Breakpoint qty

• Price

Item imageTable: EC Item Image (EXIMAG)

Contents:

• Company code

• Item number

• Thumbfile picture

• Regular picture

• 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)


641

Contents:

• Company code

• Item number

• 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

• SKU price

Keyword: Table: EC Keyword (EXKEYW)

Additional Downloads

642

Contents:

• Company code

• Item number

• Keyword

Alias itemTable: EC Alias Item (EXITMA)

Contents:

• Company code

• Item number

• Offer

• Alias item

Item ship via overrideTable: EC Item Ship Via Override (EXISVO)

Contents:

• Company code

• Item number

• Shipping code

Additional DownloadsPurpose: You populate the following tables through periodic functions or interactive process.

Gift certificateTable: EC Gift Certificate (EXGFTC)

Populated through: The EXGFTC periodic function (ECR0142).

Contents:

• Company code

• Gift cert #

• Gift cert value

Ship exclusionTable: EC Ship Exclusion (EXITEX)

Contents:

• Identifier

• RPR country

• State code

Additional Downloads

643

• Company code

• Item number

• Description

644

281Document Type Definitions (DTDs)

Purpose: Document Type Definitions (DTDs) for each of the messages used as part of the Order Management System e-commerce integration are presented in this chapter.

DTD For More Information:

CWORDERIN on page 28-645 Inbound Order XML Message (CWORDERIN) on page 3-51

CWORDEROUT on page 28-650 Detailed Order XML Response (CWORDEROUT) on page 3-132 and Order Acknowledgement XML Message (CWORDEROUT) on page 3-159

CWCatRequest on page 28-654 E-Commerce Catalog Request Message (CWCatRequest) on page 7-178

CWCatResponse on page 28-655 E-Commerce Catalog Request Response Message (CWCatreqResponse) on page 7-184

CWReturnIn on page 28-655 Return Request Message (CWReturnIn) on page 8-198

CWReturnOut on page 28-656 Return Response Message (CWReturnOut) on page 8-206

CWCancel on page 28-656 E-Commerce Cancel Request Message: Sample XML on page 11-227

CWCustomerIn on page 28-657 Inbound Customer Message (CWCustomerIn) on page 12-256

CWCustomerOut on page 28-658 Outbound Customer Response Message (CWCustomerOut) on page 12-302

CWCustHistIn on page 28-659 Customer History Request XML Message (CWCustHistIn) on page 14-340

CWCustHistOut on page 28-660 Customer History Response XML Message (CWCustHistOut) on page 14-347

CWInventoryInquiry on page 28-660 Inventory Inquiry Request XML Message (CWInventoryInquiry) on page 15-374

CWORDERIN

645

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 #IMPLIED

CWInventoryInquiryResponse on page 28-661

Inventory Inquiry Response XML Message (CWInventoryInquiryResponse) on page 15-377

Item Availability Web Request on page 28-662

Item Availability Request XML Message (CWItemAvailabilityWeb) on page 16-396

Item Availability Web Response on page 28-663

Item Availability Response XML Message (CWItemAvailabilityResponseWeb) on page 16-400

Availability Web Request on page 28-664

E-Commerce Availability Web Request XML Message (AvailabilityWebRequest) on page 17-416

Availability Web Request Response on page 28-664

E-Commerce Availability Web Response XML Message (AvailabilityWebResponse) on page 17-417

CWInventoryDownload on page 28-664 Inventory Download XML Message (CWInventoryDownload) on page 18-441

Item Download on page 28-666 Item Download XML Message (CWItemOut) on page 19-467

DTD For More Information:

CWORDERIN

646

sold_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 #IMPLIEDind_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 #IMPLIED

CWORDERIN

647

entered_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

><!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 #IMPLIED

CWORDERIN

648

svc_id 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 #IMPLIEDcid_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 #IMPLIED

CWORDERIN

649

freight_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

><!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 #IMPLIED

CWORDEROUT

650

location CDATA #IMPLIEDreturn_reason CDATA #IMPLIEDreturn_disposition CDATA #IMPLIEDprice_override CDATA #IMPLIEDpickup_type CDATA #IMPLIEDpickup_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>

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 #IMPLIED

CWORDEROUT

651

store_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 #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_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 #IMPLIED

CWORDEROUT

652

amt_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 #IMPLIEDship_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 #IMPLIED

CWORDEROUT

653

pickup_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 #IMPLIEDinvoice_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 #IMPLIED

CWCatRequest

654

promotion_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

>

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 #IMPLIED

CWCatResponse

655

indiv_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

>

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

>

CWReturnIn<?xml version="1.0" encoding="UTF-8"?><!ELEMENT Message (Return?)?><!ATTLIST Message

source CDATA #IMPLIEDtarget CDATA #IMPLIEDtype CDATA #IMPLIEDresp_qmgr CDATA #IMPLIED

><!ELEMENT Return EMPTY><!ATTLIST Return

company CDATA #IMPLIEDecom_order_nbr CDATA #IMPLIEDohd_order_nbr CDATA #IMPLIEDship_to_nbr CDATA #IMPLIEDodt_seq_nbr CDATA #IMPLIEDra_nbr CDATA #IMPLIEDra_line_nbr CDATA #IMPLIEDqty CDATA #IMPLIEDwhs CDATA #IMPLIEDlocation CDATA #IMPLIEDdisposition CDATA #IMPLIEDreason CDATA #IMPLIEDitem CDATA #IMPLIEDsku CDATA #IMPLIEDshort_sku CDATA #IMPLIEDretail_ref_nbr CDATA #IMPLIEDupc_type CDATA #IMPLIEDupc_code CDATA #IMPLIEDalias CDATA #IMPLIEDrefund_frt CDATA #IMPLIEDrefund_hand CDATA #IMPLIEDrefund_chg CDATA #IMPLIED

CWReturnOut

656

refund_duty CDATA #IMPLIEDcredit_amt CDATA #IMPLIEDsend_response CDATA #IMPLIEDsuppress_refund CDATA #IMPLIED

>

CWReturnOut<?xml version="1.0" encoding="UTF-8"?><!ELEMENT Message (Return?)?><!ATTLIST Message

source CDATA #REQUIREDtarget CDATA #REQUIREDtype CDATA #REQUIREDdate_created CDATA #REQUIREDtime_created CDATA #REQUIRED

><!ELEMENT Return EMPTY><!ATTLIST Return

company CDATA #IMPLIEDecom_order_nbr CDATA #IMPLIEDohd_order_nbr CDATA #IMPLIEDship_to_nbr CDATA #IMPLIEDodt_seq_nbr CDATA #IMPLIEDra_nbr CDATA #IMPLIEDra_line_nbr CDATA #IMPLIEDitem CDATA #IMPLIEDsku CDATA #IMPLIEDwhs CDATA #IMPLIEDlocation CDATA #IMPLIEDqty CDATA #IMPLIEDaction_result CDATA #IMPLIEDerror_message CDATA #IMPLIED

>

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

>

CWCustomerIn

657

CWCustomerIn<?xml version="1.0" encoding="UTF-8"?><!ELEMENT Message (CustSoldTo?)?><!ATTLIST Message

source CDATA #IMPLIEDtarget CDATA #IMPLIEDtype CDATA #IMPLIEDresp_qmgr CDATA #IMPLIEDresp_q CDATA #IMPLIED

><!ELEMENT CustSoldTo (CustEmails?, CustUserDefinedFields?, CustProfiles?)?><!ATTLIST CustSoldTo

cst_company CDATA #IMPLIEDcst_action_type CDATA #IMPLIEDcst_send_response CDATA #IMPLIEDcst_duplicate CDATA #IMPLIEDcst_salesman_nbr CDATA #IMPLIEDcst_interface_cust_nbr CDATA #IMPLIEDcst_cust_nbr CDATA #IMPLIEDcst_language CDATA #IMPLIEDcst_job_title CDATA #IMPLIEDcst_prefix CDATA #IMPLIEDcst_fname CDATA #IMPLIEDcst_minitial CDATA #IMPLIEDcst_lname CDATA #IMPLIEDcst_suffix CDATA #IMPLIEDcst_company_name CDATA #IMPLIEDcst_street_addr CDATA #IMPLIEDcst_addr_line_2 CDATA #IMPLIEDcst_addr_line_3 CDATA #IMPLIEDcst_addr_line_4 CDATA #IMPLIEDcst_apt CDATA #IMPLIEDcst_city CDATA #IMPLIEDcst_state CDATA #IMPLIEDcst_zip CDATA #IMPLIEDcst_country CDATA #IMPLIEDcst_day_phone CDATA #IMPLIEDcst_day_ext CDATA #IMPLIEDcst_eve_phone CDATA #IMPLIEDcst_eve_ext CDATA #IMPLIEDcst_fax_phone CDATA #IMPLIEDcst_fax_ext CDATA #IMPLIEDcst_mail_name CDATA #IMPLIEDcst_rent_name CDATA #IMPLIEDcst_seed_name CDATA #IMPLIEDcst_rent_email CDATA #IMPLIEDcst_original_source CDATA #IMPLIEDcst_current_source CDATA #IMPLIEDcst_hold_bypass_fraud CDATA #IMPLIEDcst_orig_mail_type CDATA #IMPLIEDcst_curr_mail_type CDATA #IMPLIEDcst_tax_exempt CDATA #IMPLIEDcst_exempt_certificate CDATA #IMPLIEDcst_exempt_expiry CDATA #IMPLIEDcst_associate CDATA #IMPLIEDcst_cancel_bo CDATA #IMPLIEDcst_commercial CDATA #IMPLIEDcst_cust_type CDATA #IMPLIEDcst_discount_pct CDATA #IMPLIEDcst_entry_date CDATA #IMPLIEDcst_inactive CDATA #IMPLIEDcst_bypass_reservation CDATA #IMPLIEDcst_pop_window_1 CDATA #IMPLIEDcst_pop_window_2 CDATA #IMPLIEDcst_pop_window_3 CDATA #IMPLIED

CWCustomerOut

658

cst_pop_window_4 CDATA #IMPLIEDcst_price_column CDATA #IMPLIEDcst_item_hist_tracking CDATA #IMPLIEDcst_vat_nbr CDATA #IMPLIEDcst_do_not_fax CDATA #IMPLIEDcst_deliverable CDATA #IMPLIEDcst_delivery_type CDATA #IMPLIEDcst_email_status CDATA #IMPLIEDcst_account_nbr CDATA #IMPLIEDcst_cust_class CDATA #IMPLIEDcst_cust_company CDATA #IMPLIEDcst_mail_code CDATA #IMPLIEDcst_call_code CDATA #IMPLIEDcst_change_user CDATA #IMPLIEDcst_create_user CDATA #IMPLIEDcst_currency CDATA #IMPLIEDcst_po_box CDATA #IMPLIEDcst_warehouse CDATA #IMPLIEDcst_user_field_1 CDATA #IMPLIEDcst_user_field_2 CDATA #IMPLIEDcst_user_field_3 CDATA #IMPLIEDcst_user_field_4 CDATA #IMPLIEDcst_reserve_warehouse CDATA #IMPLIEDcst_van_route CDATA #IMPLIEDcst_van_route_seq CDATA #IMPLIEDcst_price_group CDATA #IMPLIEDcst_relate_id CDATA #IMPLIEDcst_suppress_sales_rep_email CDATA #IMPLIED

><!ELEMENT CustEmails (CustEmail?)*><!ELEMENT CustEmail EMPTY><!ATTLIST CustEmail

cst_email_seq CDATA #IMPLIEDcst_email_address CDATA #IMPLIEDcst_email_primary CDATA #IMPLIEDcst_email_status CDATA #IMPLIEDcst_email_format CDATA #IMPLIEDcst_display_name CDATA #IMPLIED

><!ELEMENT CustUserDefinedFields (CustUserDefinedField?)*><!ELEMENT CustUserDefinedField EMPTY><!ATTLIST CustUserDefinedField

cst_udf_seq CDATA #IMPLIEDcst_udf_text CDATA #IMPLIEDcst_udf_nbr CDATA #IMPLIEDcst_udf_date CDATA #IMPLIED

><!ELEMENT CustProfiles (CustProfile?)*><!ELEMENT CustProfile EMPTY><!ATTLIST CustProfile

cst_profile_code CDATA #IMPLIEDcst_profile_value CDATA #IMPLIED

>

CWCustomerOut<?xml version="1.0" encoding="UTF-8"?><!ELEMENT Message (CustSoldTo?)><!ATTLIST Message

source CDATA #REQUIREDtarget CDATA #REQUIREDtype CDATA #REQUIREDdate_created CDATA #REQUIREDtime_created CDATA #REQUIRED

>

CWCustHistIn

659

<!ELEMENT CustSoldTo (Alternates?, Duplicates?)><!ATTLIST CustSoldTo

cst_company CDATA #IMPLIEDcst_cust_nbr CDATA #IMPLIEDcst_action_type CDATA #IMPLIEDcst_action_result CDATA #IMPLIEDcst_prefix CDATA #IMPLIEDcst_fname CDATA #IMPLIEDcst_minitial CDATA #IMPLIEDcst_lname CDATA #IMPLIEDcst_suffix CDATA #IMPLIEDcst_company_name CDATA #IMPLIEDcst_street_name CDATA #IMPLIEDcst_addr_line_2 CDATA #IMPLIEDcst_addr_line_3 CDATA #IMPLIEDcst_addr_line_4 CDATA #IMPLIEDcst_apt CDATA #IMPLIEDcst_city CDATA #IMPLIEDcst_state CDATA #IMPLIEDcst_zip CDATA #IMPLIEDcst_country CDATA #IMPLIEDcst_match_code CDATA #IMPLIEDcst_ghost CDATA #IMPLIED

><!ELEMENT Alternates (Alternate?)+><!ELEMENT Alternate EMPTY><!ATTLIST Alternate

cst_interface_cust_nbr CDATA #IMPLIED><!ELEMENT Duplicates (Duplicate?)+><!ELEMENT Duplicate EMPTY><!ATTLIST Duplicate

dup_cust_nbr CDATA #IMPLIEDdup_prefix CDATA #IMPLIEDdup_fname CDATA #IMPLIEDdup_minitial CDATA #IMPLIEDdup_lname CDATA #IMPLIEDdup_suffix CDATA #IMPLIEDdup_company_name CDATA #IMPLIEDdup_street_name CDATA #IMPLIEDdup_addr_line_2 CDATA #IMPLIEDdup_addr_line_3 CDATA #IMPLIEDdup_addr_line_4 CDATA #IMPLIEDdup_apt CDATA #IMPLIEDdup_city CDATA #IMPLIEDdup_state CDATA #IMPLIEDdup_zip CDATA #IMPLIEDdup_country CDATA #IMPLIEDdup_match_code CDATA #IMPLIEDdup_ghost CDATA #IMPLIED

>

CWCustHistIn<?xml version="1.0" encoding="UTF-8"?><!ELEMENT Message (CustomerHistoryRequest)><!ATTLIST Message

source CDATA #IMPLIEDtarget CDATA #IMPLIEDtype (CWCUSTHISTIN) #REQUIREDresp_qmgr CDATA #IMPLIEDresp_q CDATA #IMPLIED

><!ELEMENT CustomerHistoryRequest EMPTY>

CWCustHistOut

660

<!ATTLIST CustomerHistoryRequestcompany CDATA #IMPLIEDcustomer_number CDATA #IMPLIEDalternate_sold_to_id CDATA #IMPLIEDnumber_of_orders CDATA #IMPLIEDdirect_order_number CDATA #IMPLIEDdirect_order_ship_to_nbr CDATA #IMPLIEDalternate_order_number CDATA #IMPLIEDsend_detail CDATA #IMPLIEDexclude_order_channel CDATA #IMPLIEDlast_name CDATA #IMPLIEDpostal_code CDATA #IMPLIED

>

CWCustHistOut<?xml version="1.0" encoding="UTF-8"?><!ELEMENT Message (Headers?)><!ATTLIST Message


><!ELEMENT Headers (Header*)><!ELEMENT Header (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 #IMPLIED

><!ELEMENT ShipTos (ShipTo+)><!ELEMENT ShipTo EMPTY><!ATTLIST ShipTo

ship_to_number CDATA #REQUIREDsub_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 #IMPLIED

>

CWInventoryInquiry<?xml version="1.0" encoding="UTF-8"?>

CWInventoryInquiryResponse

661

<!ELEMENT Message (InventoryInquiry)><!ATTLIST Message


><!ELEMENT InventoryInquiry EMPTY><!ATTLIST InventoryInquiry

company CDATA #REQUIREDitem_number CDATA #IMPLIEDsku_code CDATA #IMPLIEDshort_sku CDATA #IMPLIEDretail_reference_nbr CDATA #IMPLIEDupc_type CDATA #IMPLIEDupc_code CDATA #IMPLIEDwarehouse CDATA #IMPLIEDexclude_non_allocatable CDATA #IMPLIEDexclude_retail_outlet CDATA #IMPLIED

>

CWInventoryInquiryResponse<?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 #IMPLIED

Item Availability Web Request

662

so_control CDATA #IMPLIEDso_control_description CDATA #IMPLIEDso_control_status CDATA #IMPLIED

><!ELEMENT UPCs (UPC+)><!ELEMENT UPC EMPTY><!ATTLIST UPC

upc CDATA #REQUIREDupc_type CDATA #REQUIREDupc_vendor CDATA #IMPLIED

><!ELEMENT Warehouses (Warehouse+)><!ELEMENT Warehouse (ItemWarehouse?)><!ATTLIST Warehouse

warehouse CDATA #REQUIREDwarehouse_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 #REQUIREDvalue_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

>

Item Availability Web Request<?xml version="1.0" encoding="UTF-8"?><!ELEMENT Message (ItemAvailabilityWeb?)><!ATTLIST Message

source CDATA #REQUIRED

Item Availability Web Response

663

target CDATA #REQUIREDtype (CWItemAvailabilityWeb) #REQUIRED

><!ELEMENT ItemAvailabilityWeb (Items?)><!ATTLIST ItemAvailabilityWeb

company CDATA #REQUIREDsum_availability CDATA #IMPLIED

><!ELEMENT Items (Item+)?><!ELEMENT Item EMPTY><!ATTLIST Item

item_number CDATA #IMPLIEDsku_code CDATA #IMPLIEDshort_sku CDATA #IMPLIEDretail_reference_nbr CDATA #IMPLIEDupc_type CDATA #IMPLIEDupc_code CDATA #IMPLIED

>

Item Availability Web Response<?xml version="1.0" encoding="UTF-8"?><!ELEMENT Message (ItemAvailabilityResponseWeb?)><!ATTLIST Message

source CDATA #REQUIREDtarget CDATA #REQUIREDtype (CWItemAvailabilityResponseWeb) #REQUIRED

><!ELEMENT ItemAvailabilityResponseWeb (Items?)><!ATTLIST ItemAvailabilityResponseWeb

company CDATA #REQUIREDcompany_description CDATA #IMPLIEDpass_fail CDATA #IMPLIEDerrorMsg CDATA #IMPLIED

><!ELEMENT Items (Item+)><!ELEMENT Item (SKUs?)><!ATTLIST Item

item_number CDATA #REQUIREDitem_description CDATA #REQUIREDitem_2nd_lang_desc CDATA #IMPLIEDnon_inventory CDATA #IMPLIEDmembership CDATA #IMPLIEDdrop_ship_item CDATA #IMPLIEDitem_status CDATA #IMPLIEDkit_type CDATA #IMPLIEDsvc_type CDATA #IMPLIED

><!ELEMENT SKUs (SKU+)><!ELEMENT SKU (Warehouses?)><!ATTLIST SKU

sku_code CDATA #IMPLIEDsku_description CDATA #IMPLIEDsku_2nd_lang_desc CDATA #IMPLIEDshort_sku CDATA #IMPLIEDretail_reference_nbr CDATA #IMPLIEDgift_certificate CDATA #IMPLIEDsubscription CDATA #IMPLIEDsku_status CDATA #IMPLIEDso_control CDATA #IMPLIEDupc_code CDATA #IMPLIEDupc_type CDATA #IMPLIED

><!ELEMENT Warehouses (Warehouse+)><!ELEMENT Warehouse EMPTY>

Availability Web Request

664

<!ATTLIST Warehousewarehouse CDATA #REQUIREDwarehouse_name CDATA #REQUIREDon_order_qty CDATA #IMPLIEDavailable_qty CDATA #IMPLIEDnext_po_date CDATA #IMPLIEDnext_expected_qty CDATA #IMPLIED

>

Availability Web Request<!DOCTYPE Message [

<!ELEMENT Message (AvailabilityWeb)*> <!ATTLIST Message

source CDATA #REQUIRED target CDATA #REQUIRED type CDATA #REQUIRED>

<!ELEMENT AvailabilityWeb (#PCDATA)> <!ATTLIST AvailabilityWeb

company CDATA #REQUIRED sum_availability CDATA #REQUIRED offer CDATA #REQUIRED>

]>

Availability Web Request Response<!DOCTYPE Message [

<!ELEMENT Message (AvailabilityWebRequestResponse)*> <!ATTLIST Message

source CDATA #REQUIRED target CDATA #REQUIRED type CDATA #REQUIRED>

<!ELEMENT AvailabilityWebRequestResponse (#PCDATA)> <!ATTLIST AvailabilityWebRequestResponse

company CDATA #REQUIRED company_description CDATA #REQUIRED message CDATA #REQUIRED>

]>

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 #IMPLIED

CWInventoryDownload

665

kit_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 #REQUIREDwarehouse_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 #IMPLIED

Item Download

666

protected_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

>

Item Download<?xml version="1.0" encoding="UTF-8"?><!ELEMENT Message (Items?)><!ATTLIST Message


><!ELEMENT Items (Item?)><!ELEMENT Item (ItemOffers?, ItemInformations?, ItemComments?, ItemAttributes?, SourcePrices?, Coordinates?, Keywords?, Image?, Upsells?, Restrictions?, EcommCategories?, ITMUserFields?, TaxExemptions?, FreightExemptions?, SKU?)><!ATTLIST Item

Transaction_type CDATA #IMPLIEDCompany CDATA #IMPLIEDItem_Number CDATA #IMPLIEDAllow_SKUs CDATA #IMPLIEDItem_average_cost CDATA #IMPLIEDITM_Cubing_value CDATA #IMPLIEDDrop_ship_item CDATA #IMPLIEDFIFO_cost CDATA #IMPLIEDItem_height CDATA #IMPLIEDKit_type CDATA #IMPLIEDItem_length CDATA #IMPLIEDLong_SKU_style CDATA #IMPLIEDLong_SKU_vendor CDATA #IMPLIEDLot_Nbr_tracking CDATA #IMPLIEDNon-inventory CDATA #IMPLIEDPartial_units CDATA #IMPLIEDPieces_per_case CDATA #IMPLIEDSelling_qty CDATA #IMPLIEDSelling_weight CDATA #IMPLIEDSerial_Nbr_tracking CDATA #IMPLIEDShip_alone CDATA #IMPLIEDShip_weight CDATA #IMPLIEDStandard_cost CDATA #IMPLIEDUser_field_1 CDATA #IMPLIEDUser_field_2 CDATA #IMPLIEDUser_field_3 CDATA #IMPLIEDUser_field_4 CDATA #IMPLIEDWidth CDATA #IMPLIEDExpiration_limit CDATA #IMPLIEDFIFO_Tracking CDATA #IMPLIEDITM_Allow_Pct_discount CDATA #IMPLIEDCasePiece CDATA #IMPLIEDITM_Oversize_flag CDATA #IMPLIEDITM_Description CDATA #IMPLIEDITM_Required_truck_item CDATA #IMPLIEDITM_Second_Language_Desc CDATA #IMPLIED

Item Download

667

ITM_Exclude_From_Flex_Pay CDATA #IMPLIEDITM_Royalty CDATA #IMPLIEDITM_Membership CDATA #IMPLIEDITM_Generic_Ecommerce CDATA #IMPLIEDITM_Last_Ecomm_Info_Chg CDATA #IMPLIEDITM_Qty_Threshold CDATA #IMPLIEDITM_Create_Date CDATA #IMPLIEDITM_Retail_Style_Nbr CDATA #IMPLIEDBuyer CDATA #IMPLIEDBuyer_Name CDATA #IMPLIEDCTN_ID_Nbr CDATA #IMPLIEDGLA_Account_Nbr CDATA #IMPLIEDInventory_value_GLNbr CDATA #IMPLIEDHAZ_Code CDATA #IMPLIEDHAZ_Description CDATA #IMPLIEDHAZ_Class CDATA #IMPLIEDHAZ_Label_type CDATA #IMPLIEDItem_class CDATA #IMPLIEDICL_Description CDATA #IMPLIEDICL_Commission_Pct CDATA #IMPLIEDICL_Estimated_Frt CDATA #IMPLIEDICL_Estimated_Frt_Pct CDATA #IMPLIEDICL_Desired_GM_Pct CDATA #IMPLIEDICL_VAT_Exempt CDATA #IMPLIEDICL_Hidden_Tax_Amount CDATA #IMPLIEDICL_Qty_Threshold CDATA #IMPLIEDICL_Hidden_Tax_Pct CDATA #IMPLIEDCRV_Code CDATA #IMPLIEDICL_GLA_Account_Nbr CDATA #IMPLIEDDiscount_GLA_Account_Nbr CDATA #IMPLIEDReturn_GLA_Account_Nbr CDATA #IMPLIEDReturn_Discount_GLA_Accou CDATA #IMPLIEDICL_Cost_Good_Sold_GL_Nbr CDATA #IMPLIEDICL_Cost_Good_Rtn_GL_Nbr CDATA #IMPLIEDCycle CDATA #IMPLIEDCYC_Days CDATA #IMPLIEDCYC_Description CDATA #IMPLIEDSKU_group CDATA #IMPLIEDSKU_group_description CDATA #IMPLIEDItem_status CDATA #IMPLIEDItem_status_description CDATA #IMPLIEDIST_Message_line_1 CDATA #IMPLIEDIST_Message_line_2 CDATA #IMPLIEDIST_Return_disposition CDATA #IMPLIEDLCL_Location_class CDATA #IMPLIEDLCL_Description CDATA #IMPLIEDLong_SKU_class CDATA #IMPLIEDLSC_Description CDATA #IMPLIEDLSD_Department CDATA #IMPLIEDLSD_Description CDATA #IMPLIEDLSD_Long_Sku_Division CDATA #IMPLIEDLong_SKU_Div_Description CDATA #IMPLIEDUnit_of_measure CDATA #IMPLIEDUOM_Description CDATA #IMPLIEDUOM_Units CDATA #IMPLIEDVendor_Nbr CDATA #IMPLIEDVIA_Ship_via_code CDATA #IMPLIEDVIA_Shipper_name CDATA #IMPLIEDWarehouse CDATA #IMPLIEDWarehouse_name CDATA #IMPLIEDManufacturer_Vendor CDATA #IMPLIEDITM_ENT_Entity_Number CDATA #IMPLIEDENT_Description CDATA #IMPLIEDITM_SEA_Season CDATA #IMPLIEDSEA_description CDATA #IMPLIEDSEA_Start_date CDATA #IMPLIED

Item Download

668

SEA_End_date CDATA #IMPLIEDITM_SVC_Type CDATA #IMPLIED

><!ELEMENT ItemOffers (ItemOffer?)*><!ELEMENT ItemInformations (ItemInformation)*><!ELEMENT ItemComments (ItemComment)*><!ELEMENT ItemAttributes (ItemAttribute)*><!ELEMENT SourcePrices (SourcePrice)*><!ELEMENT Coordinates (Coordinate)*><!ELEMENT Keywords (Keyword)*><!ELEMENT Image EMPTY><!ATTLIST Image

ECI_Thumbfile_Picture CDATA #IMPLIEDECI_Regular_Picture CDATA #IMPLIEDECI_Large_Picture CDATA #IMPLIED

><!ELEMENT Upsells (Upsell)*><!ELEMENT Restrictions (Restriction)*><!ELEMENT EcommCategories (EcommCategory)*><!ELEMENT ITMUserFields (ITMUserField)*><!ELEMENT TaxExemptions (TaxExemption)*><!ELEMENT FreightExemptions (FreightExemption)*><!ELEMENT SKU (VendorItems?, SKUOffers?, SKUItemInformations?, ItemWarehouses?, ContinuityItems?, FinishedGoods?, Sets?, VariableSet?, SKUComments?, SKUAttributes?, UPCs?, SKUUserFields?)><!ATTLIST SKU

SKU_Code CDATA #IMPLIEDCollating_sequence_Nbr CDATA #IMPLIEDCompatibility CDATA #IMPLIEDSKU_Cubing_value_override CDATA #IMPLIEDSKU_Description CDATA #IMPLIEDSKU_Subscription CDATA #IMPLIEDHeight_override CDATA #IMPLIEDLength_override CDATA #IMPLIEDList_price CDATA #IMPLIEDLong_SKU_color CDATA #IMPLIEDLong_SKU_size CDATA #IMPLIEDLong_SKU_width CDATA #IMPLIEDLowest_price CDATA #IMPLIEDMax_qty_for_location CDATA #IMPLIEDMax_qty_for_warehouse CDATA #IMPLIEDMin_qty_for_location CDATA #IMPLIEDMin_qty_for_warehouse CDATA #IMPLIEDSKU_Gift_certificate CDATA #IMPLIEDOut_of_stock_flag CDATA #IMPLIEDQty_order_direct_ship CDATA #IMPLIEDReceipt_date CDATA #IMPLIEDReserve_qty_limit CDATA #IMPLIEDRestrict_orders CDATA #IMPLIEDRetail_reference_Nbr CDATA #IMPLIEDOut_of_stock_date CDATA #IMPLIEDSelling_weight_override CDATA #IMPLIEDShort_SKU CDATA #IMPLIEDUser_field_1 CDATA #IMPLIEDUser_field_2 CDATA #IMPLIEDUser_field_3 CDATA #IMPLIEDWeight_override CDATA #IMPLIEDWidth_override CDATA #IMPLIEDSale_credit_flag CDATA #IMPLIEDHarmonize_code CDATA #IMPLIEDSKU_Coordinate_group CDATA #IMPLIEDSKU_Open_qty CDATA #IMPLIEDSKU_Future_qty CDATA #IMPLIEDSKU_Suspense_qty CDATA #IMPLIEDSKU_On_hold_qty CDATA #IMPLIEDSKU_Standard_Cost CDATA #IMPLIED

Item Download

669

SKU_Average_Cost CDATA #IMPLIEDSKU_Second_Language_Desc CDATA #IMPLIEDSKU_VAT_Exempt_flag CDATA #IMPLIEDSKU_Second_compatibility CDATA #IMPLIEDSKU_Hidden_tax_amount CDATA #IMPLIEDSKU_Hidden_tax_percent CDATA #IMPLIEDSKU_Suppress_BO_Card CDATA #IMPLIEDSKU_Projected_Returns CDATA #IMPLIEDSKU_User_field_4 CDATA #IMPLIEDSKU_User_field_5 CDATA #IMPLIEDSKU_Book_Inventory CDATA #IMPLIEDSKU_Returnable CDATA #IMPLIEDSKU_Retail_X-Ref_Nbr CDATA #IMPLIEDSKU_LS_Style CDATA #IMPLIEDSKU_LS_Vendor CDATA #IMPLIEDSKU_Receiving_Priority CDATA #IMPLIEDSKU_Excl_Store_Restock CDATA #IMPLIEDSKU_Generic_Ecommerce CDATA #IMPLIEDSKU_Last_Download_Qty CDATA #IMPLIEDSKU_Last_Extract CDATA #IMPLIEDSKU_Last_Ecomm_Info_Chg CDATA #IMPLIEDSKU_SVC_Card_Reload CDATA #IMPLIEDSKU_Original_Retail_Price CDATA #IMPLIEDSKU_Create_Date CDATA #IMPLIEDSKU_GTIN_Nbr CDATA #IMPLIEDSKU_Commodity_Code CDATA #IMPLIEDABC_Code CDATA #IMPLIEDABC_First_order CDATA #IMPLIEDPercentage_of_Sales CDATA #IMPLIEDNew_item_flag CDATA #IMPLIEDCTN_ID_Nbr CDATA #IMPLIEDFrequency_code CDATA #IMPLIEDPercentage_of_picks CDATA #IMPLIEDWarehouse CDATA #IMPLIEDWarehouse_name CDATA #IMPLIEDLocation CDATA #IMPLIEDSLC_Code CDATA #IMPLIEDSLC_Description CDATA #IMPLIEDSLC_Status CDATA #IMPLIEDUnit_of_measure CDATA #IMPLIEDUOM_Description CDATA #IMPLIEDUOM_Units CDATA #IMPLIEDSKU_Element_1_Code CDATA #IMPLIEDSKU_Element_1_Desc CDATA #IMPLIEDSKU_Element_1_Name CDATA #IMPLIEDSKU_Element_2_Code CDATA #IMPLIEDSKU_Element_2_Desc CDATA #IMPLIEDSKU_Element_2_Name CDATA #IMPLIEDSKU_Element_3_Code CDATA #IMPLIEDSKU_Element_3_Desc CDATA #IMPLIEDSKU_Element_3_Name CDATA #IMPLIEDSKU_IST_Item_status CDATA #IMPLIEDItem_status_description CDATA #IMPLIEDIST_Message_line_1 CDATA #IMPLIEDIST_Message_line_2 CDATA #IMPLIEDIST_Return_disposition CDATA #IMPLIEDSKU_ITC_Category CDATA #IMPLIEDItem_category_description CDATA #IMPLIEDSKU_PRP_Prep_Code CDATA #IMPLIEDPRP_Description CDATA #IMPLIEDSKU_Country_Of_Origin CDATA #IMPLIEDCountry_description CDATA #IMPLIEDSKU_LSC_LS_Class CDATA #IMPLIEDLSC_Description CDATA #IMPLIEDSKU_ZRC_Zone_Reservation CDATA #IMPLIED

>

Item Download

670

<!ELEMENT ItemOffer (ItemPrices?, PageLetterAliases?, IOFAccompanyingItems?, IOFUserFields?, IOFSpecialHandlingDetails?)><!ATTLIST ItemOffer

Offer_Number CDATA #IMPLIEDCost CDATA #IMPLIEDExpected_return_pct CDATA #IMPLIEDGift_wrap_flag CDATA #IMPLIEDGift_wrap_price CDATA #IMPLIEDPage_Nbr CDATA #IMPLIEDProjected_units CDATA #IMPLIEDSH_price CDATA #IMPLIEDSpecial_handling CDATA #IMPLIEDSquare_inches CDATA #IMPLIEDTerm_payment_interval CDATA #IMPLIEDStandard_price CDATA #IMPLIEDFreight CDATA #IMPLIEDHidden_freight CDATA #IMPLIEDIOF_Spread CDATA #IMPLIEDIOF_Volume_Discount_YN CDATA #IMPLIEDIOF_Coupon_Disc_dlr CDATA #IMPLIEDIOF_Coupon_Effective_Date CDATA #IMPLIEDIOF_Featureoption CDATA #IMPLIEDIOF_Pickupnew CDATA #IMPLIEDIOF_Sale_Book_Item_Flag CDATA #IMPLIEDIOF_Qty_Break_Upsl_Thrshd CDATA #IMPLIEDIOF_Pop_Up_Message_1 CDATA #IMPLIEDIOF_Pop_Up_Message_2 CDATA #IMPLIEDIOF_Pop_Up_Message_3 CDATA #IMPLIEDIOF_Pop_Up_Message_4 CDATA #IMPLIEDIOF_Warranty_Item CDATA #IMPLIEDIOF_Required_Add_Reason CDATA #IMPLIEDIOF_Included_Internet_Ofr CDATA #IMPLIEDCRV_Code CDATA #IMPLIEDCRV_Description CDATA #IMPLIEDCRV_Curve_type CDATA #IMPLIEDADD_Addl_chg_code CDATA #IMPLIEDADD_Description CDATA #IMPLIEDSHF_Code CDATA #IMPLIEDSHF_Description CDATA #IMPLIEDIOF_AOC_Add-On_Code CDATA #IMPLIED

><!ELEMENT ItemInformation (ItemInformationDetails?)><!ATTLIST ItemInformation

Template CDATA #IMPLIEDSequence_Nbr CDATA #IMPLIEDHeading CDATA #IMPLIEDLines_available CDATA #IMPLIED

><!ELEMENT ItemComment EMPTY><!ATTLIST ItemComment

Seq_Nbr CDATA #IMPLIEDComment_line CDATA #IMPLIEDPrint_code CDATA #IMPLIED

><!ELEMENT ItemAttribute EMPTY><!ATTLIST ItemAttribute

IAT_Type CDATA #IMPLIEDIAT_Description CDATA #IMPLIEDIAV_Value CDATA #IMPLIEDIAV_Description CDATA #IMPLIEDIAA_Affinity_flag CDATA #IMPLIED

><!ELEMENT SourcePrice EMPTY><!ATTLIST SourcePrice

SRC_Source_code CDATA #IMPLIEDSPS_Qty CDATA #IMPLIED

Item Download

671

SPS_Price CDATA #IMPLIEDSPS_Associate_price CDATA #IMPLIEDSPS_Tax_price CDATA #IMPLIEDSPS_Associate_tax_price CDATA #IMPLIED

><!ELEMENT Coordinate EMPTY><!ATTLIST Coordinate

ICN_Coordinate_item CDATA #IMPLIEDICN_Message CDATA #IMPLIEDICN_Sequence CDATA #IMPLIEDICN_Coordinate_type CDATA #IMPLIED

><!ELEMENT Keyword EMPTY><!ATTLIST Keyword

KWD_Type CDATA #IMPLIEDKWD_KeywordExclusion CDATA #IMPLIED

><!ELEMENT Upsell EMPTY><!ATTLIST Upsell

EUC_Up-SellCross-Sell CDATA #IMPLIEDUpsell_Item_ECI_Item_Numb CDATA #IMPLIEDECX_Up-Sell_Desc CDATA #IMPLIED

><!ELEMENT Restriction EMPTY><!ATTLIST Restriction

RPR_Country CDATA #IMPLIEDNAM_State CDATA #IMPLIED

><!ELEMENT EcommCategory EMPTY><!ATTLIST EcommCategory

ECA_Category CDATA #IMPLIEDECA_Category_Description CDATA #IMPLIED

><!ELEMENT ITMUserField EMPTY><!ATTLIST ITMUserField

ITM_UDF_Sequence_Nbr CDATA #IMPLIEDITM_UDF_Text CDATA #IMPLIEDITM_UDF_Number CDATA #IMPLIEDITM_UDF_Date CDATA #IMPLIEDITM_UDF_Display_sequence CDATA #IMPLIEDITM_UDF_File_code CDATA #IMPLIEDUDD_Field_label CDATA #IMPLIEDUDD_Field_type CDATA #IMPLIEDUDD_Field_usage CDATA #IMPLIED

><!ELEMENT TaxExemption EMPTY><!ATTLIST TaxExemption

ITE_State CDATA #IMPLIEDITE_Seq_Nbr CDATA #IMPLIEDITE_Tax_value CDATA #IMPLIEDITE_No_tax_value CDATA #IMPLIEDITE_Exempt CDATA #IMPLIED

><!ELEMENT FreightExemption EMPTY><!ATTLIST FreightExemption

FEF_Sequence_Number CDATA #IMPLIEDOffer_Number CDATA #IMPLIEDSRC_Source_code CDATA #IMPLIED

><!ELEMENT VendorItems (VendorItem)*><!ELEMENT SKUOffers (SKUOffer?)*><!ELEMENT SKUItemInformations (SKUItemInformation)*><!ELEMENT ItemWarehouses (ItemWarehouse)*><!ELEMENT ContinuityItems (ContinuityItem)*><!ATTLIST ContinuityItems

CNH_Charge_type CDATA #IMPLIED

Item Download

672

CNH_Interval_type CDATA #IMPLIED><!ELEMENT FinishedGoods (FinishedGood)*><!ELEMENT Sets (SetItem)*><!ELEMENT VariableSet (VariableSetGroups?)><!ATTLIST VariableSet

VSE_Create_coord_group CDATA #IMPLIED><!ELEMENT SKUComments (SKUComment)*><!ELEMENT SKUAttributes (SKUAttribute)*><!ELEMENT UPCs (UPC)*><!ELEMENT SKUUserFields (SKUUserField)*><!ELEMENT ItemPrices (ItemPrice?)*><!ELEMENT PageLetterAliases (PageLetterAlias?)*><!ELEMENT IOFAccompanyingItems (IOFAccompanyingItem?)*><!ELEMENT IOFUserFields (IOFUserField?)*><!ELEMENT IOFSpecialHandlingDetails (IOFSpecialHandlingDetail?)*><!ELEMENT ItemInformationDetails (ItemInformationDetail)*><!ELEMENT VendorItem (VITPriceBreaks*, VITAdditionalCharges*, VITNotes*, VITUserFields*)><!ATTLIST VendorItem

Vendor_Nbr CDATA #IMPLIEDItem CDATA #IMPLIEDCubic_volume CDATA #IMPLIEDDescription CDATA #IMPLIEDLead_days CDATA #IMPLIEDMessage_line_1 CDATA #IMPLIEDMessage_line_2 CDATA #IMPLIEDMessage_line_3 CDATA #IMPLIEDMinimum_qty CDATA #IMPLIEDPrice CDATA #IMPLIEDShip_weight CDATA #IMPLIEDVIT_Vend_ord_qty_multiple CDATA #IMPLIEDVIT_Upload_frt_dlr_limit CDATA #IMPLIEDVIT_Upload_hnd_dlr_limit CDATA #IMPLIEDVIT_Upload_other_dlr_limit CDATA #IMPLIEDShip_via CDATA #IMPLIEDPOV_Description CDATA #IMPLIEDPOV_Lead_Days CDATA #IMPLIEDUnit_of_measure CDATA #IMPLIEDUOM_Description CDATA #IMPLIEDUOM_Units CDATA #IMPLIEDVIT_Country_Of_Origin CDATA #IMPLIEDCountry_description CDATA #IMPLIEDVIT_Freight_upload_GLNbr CDATA #IMPLIEDVIT_Handling_upload_GLNbr CDATA #IMPLIEDVIT_Other_upload_GLNbr CDATA #IMPLIED

><!ELEMENT SKUOffer (SKUPrices?, SKUOfferPages?, SKOAccompanyingItems?, SKOUserFields?, SKOSpecialHandlingDetails?)><!ATTLIST SKUOffer

Offer_Number CDATA #IMPLIEDCost CDATA #IMPLIEDExpected_return_pct CDATA #IMPLIEDGift_wrap_flag CDATA #IMPLIEDPage_Nbr CDATA #IMPLIEDProjected_units CDATA #IMPLIEDSH_price CDATA #IMPLIEDSpecial_handling_flag CDATA #IMPLIEDSquare_inches CDATA #IMPLIEDTerm_payment_interval CDATA #IMPLIEDGift_wrap_price CDATA #IMPLIEDFreight CDATA #IMPLIEDHidden_freight CDATA #IMPLIEDSKO_Coupon_discount_dlr CDATA #IMPLIEDSKO_Coupon_effective_date CDATA #IMPLIED

Item Download

673

SKO_Volume_discountable CDATA #IMPLIEDSKO_Spread CDATA #IMPLIEDSKO_Featureoption CDATA #IMPLIEDSKO_Pickupnew CDATA #IMPLIEDSKO_Sale_Book_Item_Flag CDATA #IMPLIEDSKO_Qty_Break_Upsl_Thrshd CDATA #IMPLIEDSKO_Warranty_Item CDATA #IMPLIEDSKO_Required_Add_Reason CDATA #IMPLIEDSKO_Included_Internet_Ofr CDATA #IMPLIEDCRV_Code CDATA #IMPLIEDCRV_Description CDATA #IMPLIEDCRV_Curve_type CDATA #IMPLIEDADD_Addl_chg_code CDATA #IMPLIEDADD_Description CDATA #IMPLIEDSHF_Code CDATA #IMPLIEDSHF_Description CDATA #IMPLIEDSKO_AOC_Add-On_Code CDATA #IMPLIED

><!ELEMENT SKUItemInformation (SKUItemInformationDetails?)><!ATTLIST SKUItemInformation

Template CDATA #IMPLIEDSequence_Nbr CDATA #IMPLIEDHeading CDATA #IMPLIEDLines_available CDATA #IMPLIED

><!ELEMENT ItemWarehouse (ITWUserFields?)><!ATTLIST ItemWarehouse

Warehouse CDATA #IMPLIEDAllocation_freeze CDATA #IMPLIEDEconomic_order_qty CDATA #IMPLIEDMax_qty CDATA #IMPLIEDMin_qty CDATA #IMPLIEDProtected_qty CDATA #IMPLIEDReorder_qty CDATA #IMPLIEDITW_Original_retail_price CDATA #IMPLIEDITW_Current_retail_price CDATA #IMPLIEDITW_Protect_current_price CDATA #IMPLIEDITW_Protect_MinMax CDATA #IMPLIEDITW_User_field_1 CDATA #IMPLIEDITW_User_field_2 CDATA #IMPLIED

><!ELEMENT ContinuityItem EMPTY><!ATTLIST ContinuityItem

CND_Seq_Nbr CDATA #IMPLIEDCND_Interval_Nbr CDATA #IMPLIEDCND_Coordinate_group CDATA #IMPLIEDCND_Qty CDATA #IMPLIEDCND_Detail_ITM_Number CDATA #IMPLIEDSKU_Code CDATA #IMPLIED

><!ELEMENT FinishedGood EMPTY><!ATTLIST FinishedGood

SeqNbr CDATA #IMPLIEDQty CDATA #IMPLIEDKit_Comp_ITM_Number CDATA #IMPLIEDKit_Comp_SKU_Code CDATA #IMPLIED

><!ELEMENT SetItem EMPTY><!ATTLIST SetItem

SeqNbr CDATA #IMPLIEDCoordinate_group CDATA #IMPLIEDPct_of_cost CDATA #IMPLIEDQty CDATA #IMPLIEDSet_Comp_ITM_Number CDATA #IMPLIEDSet_Comp_SKU_Code CDATA #IMPLIED

>

Item Download

674

<!ELEMENT VariableSetGroups (VariableSetGroup)*><!ELEMENT SKUComment EMPTY><!ATTLIST SKUComment

Seq_Nbr CDATA #IMPLIEDComment_line CDATA #IMPLIEDPrint_code CDATA #IMPLIED

><!ELEMENT SKUAttribute EMPTY><!ATTLIST SKUAttribute

IAT_Type CDATA #IMPLIEDIAT_Description CDATA #IMPLIEDIAV_Value CDATA #IMPLIEDIAV_Description CDATA #IMPLIEDIAA_Affinity_flag CDATA #IMPLIED

><!ELEMENT UPC EMPTY><!ATTLIST UPC

UPC_Type CDATA #IMPLIEDUPC CDATA #IMPLIEDUPC_VND_Vendor CDATA #IMPLIED

><!ELEMENT SKUUserField EMPTY><!ATTLIST SKUUserField

SKU_UDF_Sequence_Nbr CDATA #IMPLIEDSKU_UDF_Text CDATA #IMPLIEDSKU_UDF_Number CDATA #IMPLIEDSKU_UDF_Date CDATA #IMPLIEDSKU_UDF_Display_sequence CDATA #IMPLIEDSKU_UDF_File_code CDATA #IMPLIEDUDD_Field_label CDATA #IMPLIEDUDD_Field_type CDATA #IMPLIEDUDD_Field_usage CDATA #IMPLIED

><!ELEMENT ItemPrice EMPTY><!ATTLIST ItemPrice

Effective_date CDATA #IMPLIEDQty CDATA #IMPLIEDAssociate_price CDATA #IMPLIEDPrice CDATA #IMPLIEDIPR_Price_column CDATA #IMPLIEDIPR_Associate_tax CDATA #IMPLIEDIPR_Tax_price CDATA #IMPLIEDIPR_No_Charge CDATA #IMPLIED

><!ELEMENT PageLetterAlias EMPTY><!ATTLIST PageLetterAlias

Seq_Nbr CDATA #IMPLIEDPage_letter CDATA #IMPLIEDPage_Nbr CDATA #IMPLIEDCost CDATA #IMPLIEDSquare_inch CDATA #IMPLIEDAlias_item CDATA #IMPLIED

><!ELEMENT IOFAccompanyingItem EMPTY><!ATTLIST IOFAccompanyingItem

ACI_Qty_required CDATA #IMPLIEDACI_Qty CDATA #IMPLIEDACI_Free_gift CDATA #IMPLIEDACI_Use_Ordered_Qty CDATA #IMPLIEDACI_ITM_Number CDATA #IMPLIEDACI_SKU_Code CDATA #IMPLIED

><!ELEMENT IOFUserField EMPTY><!ATTLIST IOFUserField

IOF_UDF_Sequence_Nbr CDATA #IMPLIEDIOF_UDF_Text CDATA #IMPLIED

Item Download

675

IOF_UDF_Number CDATA #IMPLIEDIOF_UDF_Date CDATA #IMPLIEDIOF_UDF_Display_sequence CDATA #IMPLIEDIOF_UDF_File_code CDATA #IMPLIEDUDD_Field_label CDATA #IMPLIEDUDD_Field_type CDATA #IMPLIEDUDD_Field_usage CDATA #IMPLIED

><!ELEMENT IOFSpecialHandlingDetail (IOFSpecialHandlingResponses*)*><!ATTLIST IOFSpecialHandlingDetail

SFD_Seq_Nbr CDATA #IMPLIEDSFD_Display_Seq CDATA #IMPLIEDSFD_Prompt_Text CDATA #IMPLIEDSFD_Required_field CDATA #IMPLIEDSFD_Feature_options CDATA #IMPLIEDSFD_Default_value CDATA #IMPLIEDSFD_Default_charge_dlr CDATA #IMPLIEDSFD_Default_charge_Pct CDATA #IMPLIEDSFD_Default_cost_dlr CDATA #IMPLIEDSFD_Default_cost_Pct CDATA #IMPLIEDSFD_Default_text CDATA #IMPLIEDSFD_Max_Nbr_characters CDATA #IMPLIEDSFD_Cross_Reference CDATA #IMPLIED

><!ELEMENT ItemInformationDetail EMPTY><!ATTLIST ItemInformationDetail

Sequence_Nbr CDATA #IMPLIEDItem_information_Line CDATA #IMPLIED

><!ELEMENT VITPriceBreaks (VITPriceBreak)*><!ELEMENT VITAdditionalCharges (VITAdditionalCharge)*><!ELEMENT VITNotes (VITNote)*><!ELEMENT VITUserFields (VITUserField)*><!ELEMENT SKUPrices (SKUPrice?)*><!ELEMENT SKUOfferPages (SKUOfferPage?)*><!ELEMENT SKOAccompanyingItems (SKOAccompanyingItem?)*><!ELEMENT SKOUserFields (SKOUserField?)*><!ELEMENT SKOSpecialHandlingDetails (SKOSpecialHandlingDetail?)*><!ELEMENT SKUItemInformationDetails (SKUItemInformationDetail)*><!ELEMENT ITWUserFields (ITWUserField)*><!ELEMENT VariableSetGroup (VariableSetItems?)><!ATTLIST VariableSetGroup

Group CDATA #IMPLIEDDescription CDATA #IMPLIEDNbr_of_items CDATA #IMPLIED

><!ELEMENT IOFSpecialHandlingResponses (IOFSpecialHandlingResponse*)*><!ELEMENT VITPriceBreak EMPTY><!ATTLIST VITPriceBreak

Start_date CDATA #IMPLIEDQuantity CDATA #IMPLIEDPrice CDATA #IMPLIEDStop_date CDATA #IMPLIED

><!ELEMENT VITAdditionalCharge EMPTY><!ATTLIST VITAdditionalCharge

Charge_code CDATA #IMPLIEDVAC_Percent CDATA #IMPLIEDVAC_Unit_amount CDATA #IMPLIED

><!ELEMENT VITNote EMPTY><!ATTLIST VITNote

VIN_Seq_Nbr CDATA #IMPLIEDVIN_Print CDATA #IMPLIEDVIN_Note CDATA #IMPLIEDVIN_User CDATA #IMPLIED

Item Download

676

VIN_Entry_date CDATA #IMPLIED><!ELEMENT VITUserField EMPTY><!ATTLIST VITUserField

VIT_UDF_Sequence_Nbr CDATA #IMPLIEDVIT_UDF_Text CDATA #IMPLIEDVIT_UDF_Number CDATA #IMPLIEDVIT_UDF_Date CDATA #IMPLIEDVIT_UDF_Display_sequence CDATA #IMPLIEDVIT_UDF_File_code CDATA #IMPLIEDUDD_Field_label CDATA #IMPLIEDUDD_Field_type CDATA #IMPLIEDUDD_Field_usage CDATA #IMPLIED

><!ELEMENT SKUPrice EMPTY><!ATTLIST SKUPrice

Effective_date CDATA #IMPLIEDQty CDATA #IMPLIEDAssociate_price CDATA #IMPLIEDPrice CDATA #IMPLIEDSKP_Price_column CDATA #IMPLIEDSKP_Associate_tax_price CDATA #IMPLIEDSKP_Tax_price CDATA #IMPLIEDSKP_No_charge CDATA #IMPLIED

><!ELEMENT SKUOfferPage EMPTY><!ATTLIST SKUOfferPage

Page_Nbr CDATA #IMPLIEDAlias_item CDATA #IMPLIED

><!ELEMENT SKOAccompanyingItem EMPTY><!ATTLIST SKOAccompanyingItem

ACI_Qty_required CDATA #IMPLIEDACI_Qty CDATA #IMPLIEDACI_Free_gift CDATA #IMPLIEDACI_Use_Ordered_Qty CDATA #IMPLIEDACI_ITM_Number CDATA #IMPLIEDACI_SKU_Code CDATA #IMPLIED

><!ELEMENT SKOUserField EMPTY><!ATTLIST SKOUserField

SKO_UDF_Sequence_Nbr CDATA #IMPLIEDSKO_UDF_Text CDATA #IMPLIEDSKO_UDF_Number CDATA #IMPLIEDSKO_UDF_Date CDATA #IMPLIEDSKO_UDF_Display_sequence CDATA #IMPLIEDSKO_UDF_File_code CDATA #IMPLIEDUDD_Field_label CDATA #IMPLIEDUDD_Field_type CDATA #IMPLIEDUDD_Field_usage CDATA #IMPLIED

><!ELEMENT SKOSpecialHandlingDetail (SKOSpecialHandlingResponses)*><!ATTLIST SKOSpecialHandlingDetail

SFD_Seq_Nbr CDATA #IMPLIEDSFD_Display_Seq CDATA #IMPLIEDSFD_Prompt_Text CDATA #IMPLIEDSFD_Required_field CDATA #IMPLIEDSFD_Feature_options CDATA #IMPLIEDSFD_Default_value CDATA #IMPLIEDSFD_Default_charge_dlr CDATA #IMPLIEDSFD_Default_charge_Pct CDATA #IMPLIEDSFD_Default_cost_dlr CDATA #IMPLIEDSFD_Default_cost_Pct CDATA #IMPLIEDSFD_Default_text CDATA #IMPLIEDSFD_Max_Nbr_characters CDATA #IMPLIEDSFD_Cross_Reference CDATA #IMPLIED

Item Download

677

><!ELEMENT SKUItemInformationDetail EMPTY><!ATTLIST SKUItemInformationDetail

Sequence_Nbr CDATA #IMPLIEDItem_information_Line CDATA #IMPLIED

><!ELEMENT ITWUserField EMPTY><!ATTLIST ITWUserField

ITW_UDF_Sequence_Nbr CDATA #IMPLIEDITW_UDF_Text CDATA #IMPLIEDITW_UDF_Number CDATA #IMPLIEDITW_UDF_Date CDATA #IMPLIEDITW_UDF_Display_sequence CDATA #IMPLIEDITW_UDF_File_code CDATA #IMPLIEDUDD_Field_label CDATA #IMPLIEDUDD_Field_type CDATA #IMPLIEDUDD_Field_usage CDATA #IMPLIED

><!ELEMENT VariableSetItems (VariableSetItem)*><!ELEMENT IOFSpecialHandlingResponse EMPTY><!ATTLIST IOFSpecialHandlingResponse

SFD_Seq_Nbr CDATA #IMPLIEDSFR_Valid_response CDATA #IMPLIEDSFR_Description CDATA #IMPLIED

><!ELEMENT SKOSpecialHandlingResponses (SKOSpecialHandlingResponse?)*><!ELEMENT VariableSetItem EMPTY><!ATTLIST VariableSetItem

SeqNbr CDATA #IMPLIEDVar_comp_ITM_Number CDATA #IMPLIEDVar_comp_SKU_Code CDATA #IMPLIED

><!ELEMENT SKOSpecialHandlingResponse EMPTY><!ATTLIST SKOSpecialHandlingResponse

SFD_Seq_Nbr CDATA #IMPLIEDSFR_Valid_response CDATA #IMPLIEDSFR_Description CDATA #IMPLIED

>