Outbound Email API

Purpose: You can generate a generic outbound XML message, rather than an actual email, for any email notification type besides purchase orders or the loyalty activation/deactivation.

This XML message includes additional information that is not included in the standard email notice. Generating the XML message enables you to produce an HTML email reformatted to your specifications, such as one that includes additional promotional information.

Important: You must select the latest available Outbound version for the EMAIL_OUT process in Working with Integration Layer Processes (IJCT) in order for the email generation to work for any notification formats that use information added in versions since the initial release of Order Management System (backorder, soldout, stored value card, credit card credit, “contact us,” credit card decline, quote, order or order line cancellations, or membership cancellation notifications).

In this chapter:

Process Overview

Outbound Email API Setup

- System Control Values

- Other Setup

Sample Outbound Email XML Messages

- Sample Order Confirmation XML Message

- Sample Shipment Notification XML Message

- Sample Return Notification XML Message

- Sample Return Notification XML Message: No Items

- Sample Credit Card Credit Acknowledgement XML Message

- Sample Backorder Notification XML Message

- Sample Soldout Notification XML Message

- Sample Stored Value Card Notification XML Message

- Sample “Contact Us” XML Message

- Sample Credit Card Decline XML Message

- Sample Quote Confirmation XML Message

- Sample Membership Cancellation Confirmation XML Message

- Sample Maintenance Failure XML Message

- Sample Order Cancellation Confirmation XML Message

- Sample Order Line Cancellation Confirmation XML Message

- Sample Store Pickup Notification Email

- Sample Customer Engagement Loyalty Registration Notification Email

Outbound Email XML Message (CWEmailOut)

Process Overview

Generated when? If the XML only? flag is selected for an email template, the system produces the Outbound Email XML Message (CWEmailOut) during the same processes that would generate an actual email notification:

Notification Type

Generated By:

order confirmations

• for interactive orders, when you accept a new order.

• for web orders, when the order is processed by the order API, including orders in error if the Suppress Order Confirmations for Orders in Error (K09) system control value is unselected; otherwise,

• accepting and processing a corrected order batch.

• the ORDR_ASYNC job for any orders that have not previously generated confirmations.

shipment and return confirmations

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

• the Send Internet Order Ship Confirmations menu option; see Sending Internet Order Ship Confirmation (ESCF).

• executing the ECSHCNF periodic function; see Working with Periodic Functions (WPER).

credit card credit acknowledgements

Processing Refunds (MREF) or Processing Refunds by Order Number (MRFO)

backorder notices

Generate Backorder Notices (GBOC) and Working with Backorders Pending Cancellation (WBPC)

soldout notifications

Generating Soldout Notifications (MSON)

stored value card notifications

the SVC_OUT process in Working with Integration Layer Processes (IJCT)

“contact us” emails

generated on demand when you select the Send Contact Us Email option at the Display More Options Screen in order entry, inquiry, or maintenance

credit card decline notices

the pick slip generation program generates these notices when it puts an order in hold status due to a credit card decline. The hold reason to use is specified in the response codes set up for the vendor response code through Defining Authorization Services (WASV)

quote confirmations

generated on demand when you select the Email Quote option on the Print/Email Quote Window in quote entry, maintenance, or inquiry

membership cancellation confirmations

through Working with Customer Memberships (WWCM) when you cancel a customer membership

maintenance failure

the E-Commerce Cancel Process when a cancellation attempt is not successful

order or order line cancellations

through canceling an order or any individual order lines through order maintenance or any other function, such as Working with Backorders Pending Cancellation (WBPC)

Oracle Retail Customer Engagement loyalty registration notification

Registering a Customer in the Customer Engagement Loyalty Program when a customer is successfully registered into the loyalty program in Oracle Retail Customer Engagement

EMAIL_OUT process: The functions listed above pass the required information to the EMAIL_OUT process in Working with Integration Layer Processes (IJCT) if the XML only flag for the template is selected. This process then provides the name of the queue required to generate the Outbound Email XML Message (CWEmailOut).

Guidelines: The same rules that govern whether to generate actual email confirmations, such as order type settings and the presence of an email address, apply to the generation of the Outbound Email XML Message (CWEmailOut). See When Does the System Generate an Email Notification? for details.

“From” email address not used: The “from” email address is not included in the Outbound Email XML Message (CWEmailOut). See Additional Information about Email Notifications for a discussion of the “from” email address.

Correspondence history: The Write Outbound Email to Email Repository (H99) controls whether to save a record of each outbound email notification or Outbound Email XML Message (CWEmailOut) in the Correspondence History table. The record consists of “header” information, but does not include the contents of the message. See Email Repository Overview for a discussion.

Order Transaction History message: When the email is related to a specific order, the system writes the same type of order transaction history message when it generates an Outbound Email XML Message (CWEmailOut) as when it generates an actual email, such as: Ord Conf to eroosevelt@example.com.See the Display Order History Screen for information on how to review these messages.

Note: Emails that are not related to specific orders, such as the membership cancellation confirmation, do not produce order transaction history messages; however, the system does write a customer note when it generates the membership cancellation confirmation. See the discussion under Membership Cancellations for more information.

Outbound Email API Setup

The setup related to the outbound email API is described below.

System Control Values

Entering the base email program for any of the following system control values in order to generate the Outbound Email XML Message (CWEmailOut):

Order Acknowledgement Program (G50)

Shipment Confirmation Program (G51)

Return Confirmation E-Mail Program (H53)

Credit Card Credit Acknowledgement E-Mail Program (H08)

Order Maintenance Confirmation E-Mail Program (H12)

Backorder Notification E-Mail Program (G95)

Soldout Notification E-Mail Program (G96)

Stored Value Card Email Notification Program (I30)

Credit Card Decline Email Program (K53)

Contact Us Email Program (K54)

Quote Confirmation Email Program (K74)

Membership Cancellation Email Program (K77)

ORCE Loyalty Registration Notification Email Program (M10)

Additionally, the following system control values apply to both the Outbound Email XML Message (CWEmailOut) and to actual email generation:

E-Mail Order Confirmations for All Orders (H51)

E-Mail Shipment Confirmations for All Orders (H52)

Send Shipment Confirmation from Billing (L98)

Write Outbound Email to Email Repository (H99)

Suppress Email Address Search (J09)

Suppress Order Confirmations for Orders in Error (K09)

For more information: See the description of each system control value.

Other Setup

Integration layer process: Use Working with Integration Layer Processes (IJCT) to set up the EMAIL_OUT process, including Creating a Process Queue (required to specify the queue).

Important: You must select the latest available Outbound version for the EMAIL_OUT process in Working with Integration Layer Processes (IJCT) in order for the email generation to work for any notification formats that use information added in versions since the initial release of Order Management System.

Email template setup: The system uses the hierarchy described under HTML Email or Outbound Email XML Message? to determine whether to generate an actual email or the Outbound Email XML Message (CWEmailOut). See Email Setup within Order Management System a review of email setup.

Suppress salesrep email flag: The setting of the Suppress Sales Rep Email field for a sold to customer defines whether the Outbound Email XML Message (CWEmailOut) sent to the sold to customer is also sent to the email address of the salesrep assigned to the customer.

Selected = Do not send Outbound Email (CWEmailOut) messages sent to the sold to customer to the email address of the salesrep assigned to the customer. The system sets the sold_to_suppress_sales_rep_email attribute in the CWEmailOut message to Y, indicating a copy of the message was not sent to the salesrep.

Unselected = Send Outbound Email (CWEmailOut) messages sent to the sold to customer to the email address of the salesrep assigned to the customer. The system sets the sold_to_suppress_sales_rep_email attribute in the CWEmailOut message to N, indicating a copy of the message was sent to the salesrep.

The system sends a CWEmailOut message to the email address of the salesrep assigned to the customer for the following notification_types:

- order confirmations (notification_type OC).

- shipment and return confirmations (notification_type SC and RC).

- backorder notices (notification_type B1, B2, B3).

- soldout notifications (notification_type S1).

Sample Outbound Email XML Messages

A sample of each type of Outbound Email XML Message (CWEmailOut) is presented below:

Sample Order Confirmation XML Message

Sample Shipment Notification XML Message

Sample Return Notification XML Message

Sample Credit Card Credit Acknowledgement XML Message

Sample Backorder Notification XML Message

Sample Soldout Notification XML Message

Sample Stored Value Card Notification XML Message

Sample “Contact Us” XML Message

Sample Credit Card Decline XML Message

Sample Quote Confirmation XML Message

Sample Membership Cancellation Confirmation XML Message

Sample Maintenance Failure XML Message

Sample Order Cancellation Confirmation XML Message

Sample Order Line Cancellation Confirmation XML Message

Sample Store Pickup Notification Email

Sample Customer Engagement Loyalty Registration Notification Email

Logged where? Based on your logging levels, the CWEmailOut message is logged in the APP.log file rather than the MQ.log. See Logs for more information on logging.

Sample Order Confirmation XML Message

<Message source="CWSerenade" target="cwi" type="CWEmailOut" date_created="2012-03-30" time_created="07:21:01">

<Email notification_type="OC" notification_type_desc="Order Confirmation" email_addr="kbrown@example.com" company="7" company_desc="Example Company" entity="207" entity_desc="ENTITY 207">

<CustomerSoldTo sold_to_nbr="55" sold_to_fname="THOMAS" sold_to_minitial="B" sold_to_lname="RUSSELL" sold_to_addr1="1800 EXAMPLE STREET" sold_to_addr2="ADDRESS LINE 2" sold_to_addr3="ADDRESS LINE 3" sold_to_addr4="ADDRESS LINE 4" sold_to_apt="STE 250" sold_to_city="WESTBOROUGH" sold_to_state="MA" sold_to_state_name="MASSACHUSETTS" sold_to_postal="01581-3960" sold_to_country="USA" sold_to_country_name="UNITED STATES OF AMERICA" sold_to_cust_class="4" sold_to_cust_class_desc="4 CUSTOMER CLASS" sold_to_day_phone="5085550100" sold_to_eve_phone="5085550101" sold_to_fax_phone="4135550102" sold_to_suppress_sales_rep_email="N">

<custSoldToHist sold_to_LTD_nbr_orders="118" sold_to_LTD_order_dollars="7329.64" sold_to_LTD_nbr_sales="38" sold_to_LTD_sales_dollars="1798.72" sold_to_first_buyer="N" sold_to_last_src="7" sold_to_last_src_desc="7 DEFAULT SOUCE CODE" />

</CustomerSoldTo>

<CustomerShipTo ship_to_fname="MARY" ship_to_minitial="B" ship_to_lname="JOHNSON" ship_to_addr1="19 RIVER LANE" ship_to_addr2="ADDRESS LINE 2" ship_to_addr3="ADDRESS LINE 3" ship_to_addr4="ADDRESS LINE 4" ship_to_apt="FRONT" ship_to_city="TEMPLETON" ship_to_state="MA" ship_to_state_name="MASSACHUSETTS" ship_to_postal="02053-1715" ship_to_country="USA" ship_to_country_name="UNITED STATES OF AMERICA" />

<Order order_nbr="4323" order_date="2012-03-30" order_source="7" order_source_desc="7 DEFAULT SOUCE CODE" order_offer="7" order_offer_desc="7 DEFAULT OFFER" order_process_date="2012-03-30" order_ship_to="1" ost_discount="48.33" ost_merch="54.67" ost_freight="5.00" ost_hand="1.00" ost_addl_charge="1.50" ost_total_amt="62.17" sales_rep_number="1" sales_rep_name="HELEN SMITH" order_type="O" ost_ship_via_code="1" ost_ship_via_desc="PARCEL POST - USPS" ost_gift="N" ost_total_nbr_recipients="1">

<OrderDetails>

<OrderDetail odt_item="ITEM" odt_item_desc="ITEM DESCRIPTION KAB" odt_item_class="1" odt_item_class_desc="ITEM CLASS 1" odt_set_master="N" odt_free_gift="N" odt_offer="7" odt_offer_desc="7 DEFAULT OFFER" odt_source="7" odt_source_desc="7 DEFAULT SOUCE CODE" odt_price="14.85" odt_qty="1" odt_extended_price="14.85" odt_availability_msg="In stock" odt_seq_nbr="1" odt_line_nbr="1" odt_ship_via_code="PARCEL POST - USPS" odt_original_price="22.00" odt_gift_wrap="N" odt_item_second_language_desc="ITEM SECOND LANGUAGE DESCRIPTION">

<OrderSpecialFormats>

<OrderSpecialFormat osf_seq_nbr="1" osf_shf_code="CS" osf_sfd_seq_nbr="10" osf_label="NAME" osf_input="Thomas B. Russell" />

<OrderSpecialFormat osf_seq_nbr="1" osf_shf_code="CS" osf_sfd_seq_nbr="20" osf_label="MESSAGE" osf_input="Tom" osf_charge="1.00" />

<OrderSpecialFormat osf_seq_nbr="1" osf_shf_code="CS" osf_sfd_seq_nbr="30" osf_label="THREAD COLOR" osf_input="black" />

<OrderSpecialFormat osf_seq_nbr="1" osf_shf_code="CS" osf_sfd_seq_nbr="40" osf_label="123456789012345" osf_input="Grace Jane" />

</OrderSpecialFormats>

</OrderDetail>

<OrderDetail odt_item="SKU" odt_item_desc="SKU ITEM DESCRIPTION" odt_SKU="CPGO" odt_SKU_desc="ORIGINAL RETAIL $ PRICE < LIST PRICE" odt_item_class="1" odt_item_class_desc="ITEM CLASS 1" odt_set_master="N" odt_free_gift="N" odt_offer="WEB" odt_offer_desc="WEB E-COMMERCE OFFER" odt_source="7" odt_source_desc="7 DEFAULT SOUCE CODE" odt_price="16.87" odt_qty="1" odt_extended_price="16.87" odt_availability_msg="In stock" odt_seq_nbr="2" odt_line_nbr="2" odt_ship_via_code="PARCEL POST - USPS" odt_original_price="25.00" odt_gift_wrap="N" odt_item_second_language_desc="SKU SECOND LANG DESC" odt_sku_second_language_desc="SKU SECOND LANG DESC" odt_sku_element_3_desc="ORIGINAL" />

<OrderDetail odt_item="IMAGESKU" odt_item_desc="IMAGESKU ITEM DESCRIPTION" odt_SKU="WHTE" odt_SKU_desc="WHITE IMAGESKU SKU DESCRIPTION" odt_item_class="1" odt_item_class_desc="ITEM CLASS 1" odt_set_master="N" odt_free_gift="N" odt_offer="7" odt_offer_desc="7 DEFAULT OFFER" odt_source="7" odt_source_desc="7 DEFAULT SOUCE CODE" odt_price="16.20" odt_qty="1" odt_extended_price="16.20" odt_availability_msg="In stock" odt_seq_nbr="3" odt_line_nbr="3" odt_image_url="http://example.com/is/image/ExampleCompany/118Q_WHITE?$thumbnail$" odt_information_url="http://www.example.com/IWCatProductPage.process?Merchant_Id=1&Section_Id=203&pcount=&Product_Id=992991&Parent_Id=1032&default_color=WHITE" odt_ship_via_code="PARCEL POST - USPS" odt_original_price="24.00" odt_gift_wrap="N" odt_item_second_language_desc="IMAGESKU SECOND LANGUAGE DESCRIPTION" odt_sku_second_language_desc="WHTE IMAGESKU SECOND LANGUAGE DESCRIPTIO" odt_sku_element_1_desc="WHITE" />

<OrderDetail odt_item="SKU" odt_item_desc="SKU ITEM DESCRIPTION" odt_SKU="RED XSML WMNS" odt_SKU_desc="MAROON EX SMALL WOMEN'S" odt_item_class="1" odt_item_class_desc="ITEM CLASS 1" odt_set_master="N" odt_free_gift="N" odt_offer="WEB" odt_offer_desc="WEB E-COMMERCE OFFER" odt_source="7" odt_source_desc="7 DEFAULT SOUCE CODE" odt_price="6.75" odt_qty="1" odt_extended_price="6.75" odt_availability_msg="Backordered" odt_expected_ship_date="2012-03-31" odt_seq_nbr="4" odt_line_nbr="4" odt_ship_via_code="PARCEL POST - USPS" odt_original_price="10.00" odt_gift_wrap="N" odt_item_second_language_desc="SKU SECOND LANG DESC" odt_sku_second_language_desc="RED XSML WMSN SKU SECOND LANG DESC" odt_sku_element_1_desc="MAROON" odt_sku_element_2_desc="EX SMALL" odt_sku_element_3_desc="WOMEN'S" />

<OrderDetail odt_item="ITEM" odt_item_desc="ITEM DESCRIPTION KAB" odt_item_class="1" odt_item_class_desc="ITEM CLASS 1" odt_set_master="N" odt_free_gift="N" odt_offer="7" odt_offer_desc="7 DEFAULT OFFER" odt_source="7" odt_source_desc="7 DEFAULT SOUCE CODE" odt_qty="1" odt_availability_msg="In stock" odt_seq_nbr="5" odt_line_nbr="5" odt_ship_via_code="PARCEL POST - USPS" odt_original_price="22.00" odt_gift_wrap="N" odt_item_second_language_desc="ITEM SECOND LANGUAGE DESCRIPTION" />

</OrderDetails>

<OrderPayments>

<OrderPayment opm_payment_type="74" opm_payment_type_desc="CYBERSOURCE VISA" opm_credit_card="************6139" opm_credit_card_exp_date="12/12" />

</OrderPayments>

<OriginatingStore sales_rep_store="7ACTIVE" sales_rep_email="SJONES@EXAMPLE.COM" sales_rep_name="SARA JONES" sales_rep_phone="5085550100" store_phone="5550101" store_addr1="7 EXAMPLE STREET" store_addr2="7 ACTIVE STORE ADDRESS LINE 2" store_addr3="7 ACTIVE STORE ADDRESS LINE 3" store_addr4="7 ACTIVE STORE ADDRESS LINE 4" store_city="WESTBOROUGH" store_state="MA" store_state_name="MASSACHUSETTS" store_postal="01581" store_country="USA" store_country_name="UNITED STATES OF AMERICA" originating_store_name="7 ACTIVE STORE" />

</Order>

<EmailTemplateText>

<BeforeBodyTextLines>

<BeforeBodyTextLine before_line_msg="This message is to confirm that your order has processed" />

<BeforeBodyTextLine before_line_msg="successfully." />

<BeforeBodyTextLine before_line_msg="Please contact us at www.gardenpets.com or call our toll" />

<BeforeBodyTextLine before_line_msg="free number 1-888-555-1212." />

<BeforeBodyTextLine before_line_msg="You will receive a separate email when we have shipped your" />

<BeforeBodyTextLine before_line_msg="order." />

</BeforeBodyTextLines>

<AfterBodyTextLines>

<AfterBodyTextLine after_line_msg="Regards," />

<AfterBodyTextLine after_line_msg="Your friends at GardenPets." />

<AfterBodyTextLine after_line_msg="Visit us at example.com!" />

</AfterBodyTextLines>

</EmailTemplateText>

</Email>

</Message>

Sample Shipment Notification XML Message

<Message date_created="2007-07-02" source="OROMS" target="cwi" time_created="17:05:35" type="CWEmailOut">

<Email company="6" company_desc="Example Company" email_addr="eroosevelt@example.com" entity="300" entity_desc="HOME AND OFFICE" notification_type="SC" notification_type_desc="Shipment Confirmation">

<CustomerSoldTo sold_to_addr1="24 EXAMPLE STREET" sold_to_alternate_id="000000073" sold_to_city="WESTBOROUGH" sold_to_country="USA" sold_to_country_name="UNITED STATES OF AMERICA" sold_to_fname="MARY" sold_to_lname="JOHNSON" sold_to_nbr="13126" sold_to_postal="01581" sold_to_state="MA" sold_to_state_name="MASSACHUSETTS">

<CustomerSoldToHistory sold_to_LTD_nbr_orders="7" sold_to_LTD_nbr_sales="8" sold_to_LTD_order_dollars="563.20" sold_to_LTD_sales_dollars="598.15" sold_to_first_buyer="N" sold_to_last_src="TSTOFR" sold_to_last_src_desc="FOR TEST OFFER" />

</CustomerSoldTo>

<CustomerShipTo ship_to_addr1="24 EXAMPLE STREET" ship_to_city="WESTBOROUGH" ship_to_country="USA" ship_to_country_name="UNITED STATES OF AMERICA" ship_to_fname="MARY" ship_to_lname="JOHNSON" ship_to_postal="01581" ship_to_state="MA" ship_to_state_name="MASSACHUSETTS" />

<Order order_date="2007-07-02" order_nbr="3490" order_offer="TST" order_offer_desc="PRE-SCHOOL SPECIAL" order_type="P" order_ship_to="1" order_source="TSTOFR" order_source_desc="WEB CUSTOMERS 2012">

<OrderPayments order_payment_count="1">

<OrderPayment opm_credit_card="CHANGEDBYLOGGER" opm_credit_card_exp_date="12/15" opm_payment_type="5" opm_payment_type_desc="MASTERCARD" />

</OrderPayments>

<Invoice invoice_nbr="1533" invoice_ship_to="1" ist_ship_date="2007-07-02">

<InvoiceDetails>

<InvoiceDetail idt_extended_price="30.00" idt_item="UTENSILS" idt_item_desc="WRITING UTENSILS SET" idt_line_nbr="4" idt_order_dtl_seq_nbr="1" idt_price="30.00" idt_ship_qty="1" />

<InvoiceDetail idt_item="PENCIL" idt_item_class="HM" idt_item_class_desc="HOME OFFICE" idt_item_desc="PENCIL" idt_line_nbr="3" idt_order_dtl_seq_nbr="2" idt_ship_qty="1" />

<InvoiceDetail idt_SKU="BLUE" idt_SKU_desc="BLUE PEN" idt_item="PEN" idt_item_class="HM" idt_item_class_desc="HOME OFFICE" idt_item_desc="GEL WRITER" idt_line_nbr="2" idt_order_dtl_seq_nbr="3" idt_ship_qty="1" />

<InvoiceDetail idt_item="ME123" idt_item_class="HM" idt_item_class_desc="HOME OFFICE" idt_item_desc="MECHANICAL PENCIL" idt_line_nbr="1" idt_order_dtl_seq_nbr="5" idt_ship_qty="1" />

<InvoiceDetail idt_extended_price="100.00" idt_item="PENCIL" idt_item_class="HM" idt_item_class_desc="HOME OFFICE" idt_item_desc="PENCIL" idt_line_nbr="5" idt_order_dtl_seq_nbr="6" idt_price="1.00" idt_ship_qty="100" />

</InvoiceDetails>

<TrackingNumbers>

<TrackingNumber tracking_URL="HTTP://trkcnfrm1.example.com/InternetWeb/InterLabelInquiry.do?origTrackNum=9101010521297776021492" tracking_nbr="9101010521297776021492" tracking_ship_via="2" tracking_ship_via_desc="PARCEL POST (USPS)" tracking_ship_via_type="PP" tracking_ship_via_type_desc="Parcel Post" />

</TrackingNumbers>

</Invoice>

<OriginatingStore sales_rep_store="7ACTIVE" sales_rep_email="JJONESE@EXAMPLE.COM" sales_rep_name="JACK JONES" sales_rep_phone="5085550100" store_phone="5550102" store_addr1="99 EXAMPLE STREET" store_addr2="7 ACTIVE STORE ADDRESS LINE 2" store_addr3="7 ACTIVE STORE ADDRESS LINE 3" store_addr4="7 ACTIVE STORE ADDRESS LINE 4" store_city="TEMPLETON" store_state="MA" store_state_name="MASSACHUSETTS" store_postal="01581" store_country="USA" store_country_name="UNITED STATES OF AMERICA" originating_store_name="7 ACTIVE STORE" />

</Order>

<EmailTemplateText>

<BeforeBodyTextLines>

<BeforeBodyTextLine before_line_msg="The following portion of your order has shipped." />

</BeforeBodyTextLines>

<AfterBodyTextLines>

<AfterBodyTextLine after_line_msg="Thank you for your business" />

</AfterBodyTextLines>

</EmailTemplateText>

</Email>

</Message>

Sample Return Notification XML Message

<Message date_created="2012-03-30" source="OROMS" target="cwi" time_created="07:55:34" type="CWEmailOut">

<Email company="7" company_desc="Sample Company" email_addr="kbrown@example.com" entity="207" entity_desc="ENTITY 207" notification_type="RC" notification_type_desc="Return Confirmation">

<CustomerSoldTo sold_to_addr1="1800 EXAMPLE STREET" sold_to_addr2="ADDRESS LINE 2" sold_to_addr3="ADDRESS LINE 3" sold_to_addr4="ADDRESS LINE 4" sold_to_apt="STE 250" sold_to_city="WESTBOROUGH" sold_to_country="USA" sold_to_country_name="UNITED STATES OF AMERICA" sold_to_cust_class="4" sold_to_cust_class_desc="4 CUSTOMER CLASS" sold_to_day_phone="5085550100" sold_to_eve_phone="5085550101" sold_to_fax_phone="4135550102" sold_to_fname="THOMAS" sold_to_lname="RUSSELL" sold_to_minitial="B" sold_to_nbr="55" sold_to_postal="01581-3960" sold_to_state="MA" sold_to_state_name="MASSACHUSETTS" sold_to_suppress_sales_rep_email="N">

<CustomerSoldToHistory sold_to_LTD_nbr_orders="118" sold_to_LTD_nbr_sales="39" sold_to_LTD_order_dollars="7329.64" sold_to_LTD_sales_dollars="1846.64" sold_to_first_buyer="N" sold_to_last_src="7" sold_to_last_src_desc="7 DEFAULT SOUCE CODE" />

</CustomerSoldTo>

<CustomerShipTo ship_to_addr1="19 RIVER ROAD" ship_to_addr2="ADDRESS LINE 2" ship_to_addr3="ADDRESS LINE 3" ship_to_addr4="ADDRESS LINE 4" ship_to_apt="FRONT" ship_to_city="TEMPLETON" ship_to_country="USA" ship_to_country_name="UNITED STATES OF AMERICA" ship_to_day_phone="" ship_to_eve_phone="" ship_to_fax_phone="" ship_to_fname="HELEN" ship_to_lname="SMITH" ship_to_minitial="B" ship_to_postal="02053-1715" ship_to_state="MA" ship_to_state_name="MASSACHUSETTS" />

<Order order_date="2012-03-30" order_nbr="4323" order_offer="7" order_offer_desc="7 DEFAULT OFFER" order_ship_to="1" order_source="7" order_source_desc="7 DEFAULT SOUCE CODE" order_type="O" ost_gift="N" order_type="P" ost_ship_via="1" ost_ship_via_desc="PARCEL POST - USPS" ost_total_nbr_recipients="1">

<OrderPayments order_payment_count="1">

<OrderPayment opm_credit_card="************6139" opm_credit_card_exp_date="12/12" opm_payment_type="74" opm_payment_type_desc="CYBERSOURCE VISA" />

</OrderPayments>

<Invoice invoice_nbr="775" invoice_ship_to="1" ist_ship_date="2012-03-30" ist_ship_discount="-45.08" ist_ship_merch="-47.92" ist_ship_status="" ist_ship_total_amt="-47.92">

<InvoiceDetails>

<InvoiceDetail idt_extended_price="-14.85" idt_image_url="" idt_information_url="" idt_item="ITEM" idt_item_class="1" idt_item_class_desc="ITEM CLASS 1" idt_item_desc="ITEM DESCRIPTION KAB" idt_item_second_language_desc="ITEM SECOND LANGUAGE DESCRIPTION" idt_line_nbr="1" idt_odt_qty="1" idt_order_dtl_seq_nbr="1" idt_price="14.85" idt_ship_qty="-1" idt_sku_second_language_desc="">

<InvoiceSpecialFormats>

<InvoiceSpecialFormat idt_osf_charge="" idt_osf_input="Thomas B. Russell" idt_osf_label="NAME" idt_osf_seq_nbr="1" idt_osf_sfd_seq_nbr="10" idt_osf_shf_code="CS" />

<InvoiceSpecialFormat idt_osf_charge="1.00" idt_osf_input="Tom" idt_osf_label="MESSAGE" idt_osf_seq_nbr="1" idt_osf_sfd_seq_nbr="20" idt_osf_shf_code="CS" />

<InvoiceSpecialFormat idt_osf_charge="" idt_osf_input="black" idt_osf_label="THREAD COLOR" idt_osf_seq_nbr="1" idt_osf_sfd_seq_nbr="30" idt_osf_shf_code="CS" />

<InvoiceSpecialFormat idt_osf_charge="" idt_osf_input="Grace Jane" idt_osf_label="123456789012345" idt_osf_seq_nbr="1" idt_osf_sfd_seq_nbr="40" idt_osf_shf_code="CS" />

</InvoiceSpecialFormats>

</InvoiceDetail>

<InvoiceDetail idt_SKU="CPGO" idt_SKU_desc="ORIGINAL RETAIL $ PRICE < LIST PRICE" idt_extended_price="-16.87" idt_image_url="" idt_information_url="" idt_item="SKU" idt_item_class="1" idt_item_class_desc="ITEM CLASS 1" idt_item_desc="SKU ITEM DESCRIPTION" idt_item_second_language_desc="SKU SECOND LANG DESC" idt_line_nbr="2" idt_odt_qty="1" idt_order_dtl_seq_nbr="2" idt_price="16.87" idt_ship_qty="-1" idt_sku_second_language_desc="SKU SECOND LANG DESC">

<InvoiceSpecialFormats />

</InvoiceDetail>

<InvoiceDetail idt_SKU="WHTE" idt_SKU_desc="WHITE IMAGESKU SKU DESCRIPTION" idt_extended_price="-16.20" idt_image_url="http://example.com/is/image/ExampleCompany/118Q_WHITE?$thumbnail$" idt_information_url="http://www.example.com/IWCatProductPage.process?Merchant_Id=1&Section_Id=203&pcount=&Product_Id=992991&Parent_Id=1032&default_color=WHITE" idt_item="IMAGESKU" idt_item_class="1" idt_item_class_desc="ITEM CLASS 1" idt_item_desc="IMAGESKU ITEM DESCRIPTION" idt_item_second_language_desc="IMAGESKU SECOND LANGUAGE DESCRIPTION" idt_line_nbr="3" idt_odt_qty="1" idt_order_dtl_seq_nbr="3" idt_price="16.20" idt_ship_qty="-1" idt_sku_second_language_desc="WHTE IMAGESKU SECOND LANGUAGE DESCRIPTIO">

<InvoiceSpecialFormats />

</InvoiceDetail>

<InvoiceDetail idt_image_url="" idt_information_url="" idt_item="ITEM" idt_item_class="1" idt_item_class_desc="ITEM CLASS 1" idt_item_desc="ITEM DESCRIPTION KAB" idt_item_second_language_desc="ITEM SECOND LANGUAGE DESCRIPTION" idt_line_nbr="4" idt_odt_qty="1" idt_order_dtl_seq_nbr="5" idt_ship_qty="-1" idt_sku_second_language_desc="">

<InvoiceSpecialFormats />

</InvoiceDetail>

</InvoiceDetails>

</Invoice>

<OriginatingStore originating_store_name="7 ACTIVE STORE" sales_rep_email="SJONES@EXAMPLE.COM" sales_rep_name="SARA JONES" sales_rep_phone="5085550100" sales_rep_store="7ACTIVE" store_addr1="7123 EXAMPLE STREET" store_addr2="7 ACTIVE STORE ADDRESS LINE 2" store_addr3="7 ACTIVE STORE ADDRESS LINE 3" store_addr4="7 ACTIVE STORE ADDRESS LINE 4" store_city="WESTBOROUGH" store_country="USA" store_country_name="" store_phone="5555309" store_postal="01581" store_state="MA" store_state_name="" />

</Order>

<EmailTemplateText>

<BeforeBodyTextLines>

<BeforeBodyTextLine before_line_msg="Your return has successfully been processed. You will" />

<BeforeBodyTextLine before_line_msg="receive a credit for the amount of the return shortly." />

<BeforeBodyTextLine before_line_msg="If you have any questions, you can call our toll free" />

<BeforeBodyTextLine before_line_msg="number 1-888-555-0109." />

</BeforeBodyTextLines>

<AfterBodyTextLines>

<AfterBodyTextLine after_line_msg="Regards," />

<AfterBodyTextLine after_line_msg="Your friends at GardenPets." />

<AfterBodyTextLine after_line_msg="Visit us at example.com!" />

</AfterBodyTextLines>

</EmailTemplateText>

</Email>

</Message>

Sample Return Notification XML Message: No Items

The system generates an XML message such as the following when you credit the order by applying a negative additional charge rather than by processing a return.

<Message date_created="2010-09-09" source="OROMS" target="cwi" time_created="17:16:11" type="CWEmailOut">

<Email company="6" company_desc="Example Company" email_addr="eroosevelt@example.com" entity="100" entity_desc="STATIONARY COMPANY" notification_type="RC" notification_type_desc="Return Confirmation">

<CustomerSoldTo sold_to_addr1="10 APPLE STREET" sold_to_alternate_id="000000082" sold_to_city="WORCESTER" sold_to_company="EXAMPLE COMPANY" sold_to_country="USA" sold_to_country_name="UNITED STATES OF AMERICA" sold_to_fname="MICHAEL" sold_to_lname="WILLIAMS" sold_to_minitial="Q" sold_to_nbr="6" sold_to_postal="01622" sold_to_state="MA" sold_to_state_name="MASSACHUSETTS">

<CustomerSoldToHistory sold_to_LTD_nbr_orders="117" sold_to_LTD_nbr_sales="44" sold_to_LTD_order_dollars="5362.52" sold_to_LTD_sales_dollars="1001.86" sold_to_first_buyer="N" sold_to_last_src="SOURCE" sold_to_last_src_desc="SOURCE CODE" />

</CustomerSoldTo>

<CustomerShipTo ship_to_addr1="10 EXAMPLE STREET" ship_to_city="WORCESTER" ship_to_company="EXAMPLE COMPANY" ship_to_country="USA" ship_to_country_name="UNITED STATES OF AMERICA" ship_to_fname="MICHAEL" ship_to_lname="WILLIAMS" ship_to_minitial="Q" ship_to_postal="01622" ship_to_state="MA" ship_to_state_name="MASSACHUSETTS" />

<Order order_date="2010-07-27" order_nbr="9144" order_offer="OFR" order_offer_desc="SEE WHAT'S NEW" order_type="P" order_ship_to="1" order_source="SOURCE" order_source_desc="SOURCE CODE">

<OrderPayments order_payment_count="1">

<OrderPayment opm_payment_type="9" opm_payment_type_desc="CREDIT CARD" />

</OrderPayments>

<Invoice invoice_nbr="1237494" invoice_ship_to="1" ist_ship_addl_charge="-10.00" ist_ship_date="2010-09-09" ist_ship_total_amt="-10.00">

<InvoiceDetails />

</Invoice>

</Order>

<EmailTemplateText>

<BeforeBodyTextLines>

<BeforeBodyTextLine before_line_msg="This is to notify you that we have processed return of the" />

<BeforeBodyTextLine before_line_msg="item(s) listed below to our stationary group." />

</BeforeBodyTextLines>

<AfterBodyTextLines>

<AfterBodyTextLine after_line_msg="We're sorry the order didn't work out and hope to serve you" />

<AfterBodyTextLine after_line_msg="again in the future." />

</AfterBodyTextLines>

</EmailTemplateText>

</Email>

</Message>

Sample Credit Card Credit Acknowledgement XML Message

 

<Message source="CWSerenade" target="cwi" type="CWEmailOut" date_created="2009-07- 20" time_created="11:59:23">

<Email notification_type="C1" notification_type_desc="Credit Card Credit Ack"

email_addr="bexample@example.com" company="12" company_desc="Example Company

Company 12" entity="100" entity_desc="GIFT GIVING">

<CustomerSoldTo sold_to_nbr="14754" sold_to_fname="JACK" sold_to_minitial="M"

sold_to_lname="JONES" sold_to_addr1="1 EXAMPLE STREET" sold_to_city="WESTBOROUGH" sold_to_state="MA" sold_to_state_name="MASSACHUSETTS" sold_to_postal="01581" sold_to_country="USA" sold_to_country_name="UNITED STATES">

<custSoldToHist sold_to_LTD_nbr_orders="79" sold_to_LTD_order_dollars="12544.25" sold_to_LTD_nbr_sales="78" sold_to_LTD_sales_dollars="10813.00" sold_to_first_buyer="N" sold_to_last_src="LAV3" sold_to_last_src_desc="LAV THIRD SOURCE CODE" />

</CustomerSoldTo>

<CustomerShipTo ship_to_company="SMITH CONSULTING"

ship_to_fname="HELEN" ship_to_minitial="L" ship_to_lname="SMITH" ship_to_addr1="100 APPLE ST" ship_to_addr2="APPLE PLACE" ship_to_apt="SUITE 50" ship_to_city="WORCESTER" ship_to_state="MA" ship_to_state_name="MASSACHUSETTS" ship_to_postal="01633" ship_to_country="USA" ship_to_country_name="UNITED STATES" />

<Order order_nbr="114" order_date="2009-07-20" order_source="LAV3" order_source_desc="LAV THIRD SOURCE CODE" order_offer="LA" order_offer_desc="LAV OFFER" order_process_date="2009-07-20" order_type="O" order_ship_to="1" ost_freight="5.00" ost_total_amt="5.00">

<CreditCardCredit ccc_refund_amt="115.00" ccc_refund_date="2009-07-20">

<CreditCardCreditLines>

<CreditCardCreditLine ccc_item="CAPRIS" ccc_item_desc="SHORT SLACKS" ccc_SKU_desc="BLACK SHORTS" ccc_SKU="BLK" />

<CreditCardCreditLine ccc_item="SHORTS" ccc_item_desc="COTTON SHORTS" ccc_SKU_desc="WHITE SIZE SIX" ccc_SKU="WHIT 6" />

<CreditCardCreditLine ccc_item="SW11" ccc_item_desc="SWEATER" ccc_SKU_desc="YELLOW SMALL" ccc_SKU="YELL SML" />

<CreditCardCreditLine ccc_item="POLO" ccc_item_desc="NAUTICA POLO SHIRT" ccc_SKU="BLU 10" />

<CreditCardCreditLine ccc_item="SKIRT" ccc_item_desc="SUMMER OUTFIT" />

</CreditCardCreditLines>

</CreditCardCredit>

 

<OriginatingStore sales_rep_store="7ACTIVE" sales_rep_email="SJONESE@EXAMPLE.COM" sales_rep_name="SARA JONES" sales_rep_phone="5085550100" store_phone="5550101" store_addr1="7 ACTIVE STORE ADDRESS LINE 1" store_addr2="7 ACTIVE STORE ADDRESS LINE 2" store_addr3="7 ACTIVE STORE ADDRESS LINE 3" store_addr4="7 ACTIVE STORE ADDRESS LINE 4" store_city="WESTBORO" store_state="MA" store_state_name="MASSACHUSETTS" store_postal="01581" store_country="USA" store_country_name="UNITED STATES OF AMERICA" originating_store_name="7 ACTIVE STORE" />

</Order>

<EmailTemplateText>

<BeforeBodyTextLines>

<BeforeBodyTextLine before_line_msg="We have credited your credit card account for the items" />

<BeforeBodyTextLine before_line_msg="returned." />

</BeforeBodyTextLines>

<AfterBodyTextLines>

<AfterBodyTextLine after_line_msg="We regret that your purchase was not acceptable." />

<AfterBodyTextLine after_line_msg="Customer Service" />

<AfterBodyTextLine after_line_msg="Do not reply to this email." />

</AfterBodyTextLines>

</EmailTemplateText>

</Email>

</Message>

Sample Backorder Notification XML Message

<Message source="CWSerenade" target="cwi" type="CWEmailOut" date_created="2008-12-30" time_created="17:22:06">

<Email notification_type="B1" notification_type_desc="Backorder 1st Notice" email_addr="eroosevelt@example.com" company="6" company_desc="Example Company" entity="100" entity_desc="STATIONARY COMPANY">

<CustomerSoldTo sold_to_nbr="13356" sold_to_company="BROWN CONSULTING" sold_to_fname="DEBBIE" sold_to_minitial="G" sold_to_lname="BROWN" sold_to_addr1="257 APPLE STREET" sold_to_addr2="FIRST FLOOR REAR" sold_to_addr3="THIRD ADDRESS LINE" sold_to_addr4="FOURTH ADDRESS LINE" sold_to_apt="APT 12345" sold_to_city="WORCESTER" sold_to_state="MA" sold_to_state_name="MASSACHUSETTS" sold_to_postal="01602" sold_to_country="USA" sold_to_country_name="UNITED STATES OF AMERICA" sold_to_alternate_id="000000267">

<custSoldToHist sold_to_LTD_nbr_orders="18" sold_to_LTD_order_dollars="413.26" sold_to_first_buyer="N" sold_to_last_src="SOURCE" sold_to_last_src_desc="SOURCE CODE"/>

</CustomerSoldTo>

<CustomerShipTo ship_to_company="BROWN CONSULTING" ship_to_fname="DEBBIE" ship_to_minitial="G" ship_to_lname="BROWN" ship_to_addr1="257 APPLE STREET" ship_to_addr2="FIRST FLOOR REAR" ship_to_addr3="THIRD ADDRESS LINE" ship_to_addr4="FOURTH ADDRESS LINE" ship_to_apt="APT 12345" ship_to_city="WORCESTER" ship_to_state="MA" ship_to_state_name="MASSACHUSETTS" ship_to_postal="01602" ship_to_country="USA" ship_to_country_name="UNITED STATES OF AMERICA"/>

<Order order_nbr="5800" order_date="2008-12-30" order_source="SOURCE" order_source_desc="SOURCE CODE" order_offer="OFR" order_offer_desc="SEE WHAT&apos;S NEW" order_process_date="2008-12-30" order_type="O" order_ship_to="1" ost_tax="3.36" ost_merch="50.00" ost_freight="6.00" ost_addl_charge="6.99" ost_total_amt="66.35">

<BOCardLines>

<BOCardLine bo_qty="1" bo_expected_date="2008-12-31" bo_item="CWS_SET" bo_item_desc="BUDGIE SNACK PACK"/>

<BOCardLine bo_qty="1" bo_expected_date="2008-12-31" bo_item="CWS_MILLET" bo_item_desc="ONE POUND GOLDEN MILLET"/>

<BOCardLine bo_qty="1" bo_expected_date="2008-12-31" bo_item="CWS_SNACK" bo_item_desc="SNACK TREAT STICKS FOR PET BIRDS" bo_SKU_desc="BUDGIE SIZE 12 OZ PACKAGE" bo_SKU="BUDG MEDM"/>

</BOCardLines>

</Order>

<EmailTemplateText>

<BeforeBodyTextLines>

<BeforeBodyTextLine before_line_msg="Unfortunately, the item(s) indicated below are backordered."/>

<BeforeBodyTextLine before_line_msg="Please contact us at 508 555 0100 with any questions."/>

</BeforeBodyTextLines>

<AfterBodyTextLines>

<AfterBodyTextLine after_line_msg="We will notify you when we are able to ship the item(s)"/>

<AfterBodyTextLine after_line_msg="listed above. Thank you for your business."/>

</AfterBodyTextLines>

</EmailTemplateText>

</Email>

</Message>

Sample Soldout Notification XML Message

<Message source="CWSerenade" target="cwi" type="CWEmailOut" date_created="2009-03-12" time_created="16:34:45">

<Email notification_type="S1" notification_type_desc="Soldout Notification" email_addr="eroosevelt@example.com" company="6" company_desc="Example Company" entity="100" entity_desc="STATIONARY COMPANY">

<CustomerSoldTo sold_to_nbr="13164" sold_to_company="WILLIAMS CONSULTING" sold_to_fname="SARA" sold_to_minitial="A" sold_to_lname="WILLIAMS" sold_to_addr1="257 APPLE STREET" sold_to_addr2="SECOND FLOOR" sold_to_city="WORCESTER" sold_to_state="MA" sold_to_state_name="MASSACHUSETTS" sold_to_postal="01602" sold_to_country="USA" sold_to_country_name="UNITED STATES OF AMERICA" sold_to_alternate_id="000000105" sold_to_cust_class="01" sold_to_cust_class_desc="MINORS">

<custSoldToHist sold_to_LTD_nbr_orders="293" sold_to_LTD_order_dollars="9270.15" sold_to_LTD_nbr_sales="62" sold_to_LTD_sales_dollars="1350.65" sold_to_first_buyer="N" sold_to_last_src="SOURCE" sold_to_last_src_desc="SOURCE CODE"/>

</CustomerSoldTo>

<CustomerShipTo ship_to_fname="JAMES" ship_to_lname="JONES" ship_to_addr1="500 APPLE LANE" ship_to_city="WORCESTER" ship_to_state="MA" ship_to_state_name="MASSACHUSETTS" ship_to_postal="01602" ship_to_country="USA" ship_to_country_name="UNITED STATES OF AMERICA"/>

<Order order_nbr="5797" order_date="2009-03-12" order_source="SOURCE" order_source_desc="SOURCE CODE" order_offer="OFR" order_offer_desc="SEE WHAT&apos;S NEW" order_process_date="2009-03-12" order_type="P" order_ship_to="1" ost_addl_charge="0.99" ost_total_amt="0.99">

<SoldoutLines>

<SoldoutLine so_qty="1" so_item="BLENDER" so_item_desc="DELUXE RETRO BLENDER"/>

<SoldoutLine so_qty="5" so_item="GELS" so_item_desc="BRILLIANT GEL WRITERS" so_SKU_desc="GREY" so_SKU="GRAY"/>

</SoldoutLines>

</Order>

<EmailTemplateText>

<BeforeBodyTextLines>

<BeforeBodyTextLine before_line_msg="We regret to tell you that the item(s) below are no longer"/>

<BeforeBodyTextLine before_line_msg="available."/>

</BeforeBodyTextLines>

<AfterBodyTextLines>

<AfterBodyTextLine after_line_msg="Please think of us the next time you need gifts or"/>

<AfterBodyTextLine after_line_msg="stationery supplies. Thank you for your business."/>

</AfterBodyTextLines>

</EmailTemplateText>

</Email>

</Message>

Sample Stored Value Card Notification XML Message

<Message source="CWSerenade" target="cwi" type="CWEmailOut" date_created="2009-03-30" time_created="15:00:18">

<Email notification_type="SV" notification_type_desc="Stored Value Card" email_addr="eroosevelt@example.com" company="45" company_desc="Bluegrass Tack and Supply" entity="100" entity_desc="WIDGETS GALORE">

<CustomerSoldTo sold_to_nbr="14276" sold_to_company="WILLIAMS CONSULTING" sold_to_fname="MICHAEL" sold_to_minitial="Z" sold_to_lname="WILLIAMS" sold_to_addr1="10 EXAMPLE ST" sold_to_addr2="SECOND ADDRESS LINE" sold_to_apt="APT 101" sold_to_city="WESTBOROUGH" sold_to_state="MA" sold_to_state_name="MASSACHUSETTS" sold_to_postal="01581-3960" sold_to_country="USA" sold_to_country_name="UNITED STATES OF AMERICA" sold_to_cust_class="10" sold_to_cust_class_desc="3 - 6 MONTH BUYER">

<custSoldToHist sold_to_LTD_nbr_orders="4" sold_to_LTD_order_dollars="260.00" sold_to_LTD_nbr_sales="3" sold_to_LTD_sales_dollars="260.00" sold_to_first_buyer="N" sold_to_last_src="A123" sold_to_last_src_desc="SPRING 2009 BUYERS"/>

</CustomerSoldTo>

<CustomerShipTo ship_to_ship_to_fname="STEPHEN" ship_to_minitial="S" ship_to_lname="WILLIAMS" ship_to_addr1="10 APPLE STREET" ship_to_addr2="2ND ADDRESS LINE" ship_to_addr3="3RD ADDRESS LINE" ship_to_addr4="4TH ADDRESS LINE" ship_to_apt="APT 202" ship_to_city="WORCESTER" ship_to_state="MA" ship_to_state_name="MASSACHUSETTS" ship_to_postal="01602" ship_to_country="USA" ship_to_country_name="UNITED STATES OF AMERICA"/>

<Order order_nbr="3743" order_date="2009-03-30" order_source="A123" order_source_desc="SPRING 2009 BUYERS" order_offer="001" order_offer_desc="SPRING 2009" order_process_date="2009-03-30" order_type="P" order_ship_to="1" ost_merch="60.00" ost_total_amt="60.00">

<StoredValueCard svc_order_detail_seq_nbr="1" svc_qty="1" svc_seq_nbr="2" svc_issue_amount="30.00" svc_activation_date="2009-03-30" svc_activation_time="15:00:18" svc_type="E" svc_card_nbr="************1111" svc_item="GIFTCARDSKU" svc_item_desc="GIFT CARD SKU&apos;D" svc_SKU="30.0" svc_SKU_desc="30.00 CARD" svc_message1="Dear Stephen," svc_message2="Please enjoy this gift card and have a wonderful" svc_message3="birthday. All our love," svc_message4="Mom and Dad"/>

</Order>

<EmailTemplateText>

<BeforeBodyTextLines>

<BeforeBodyTextLine before_line_msg="This is to notify you of the purchase of a stored value"/>

<BeforeBodyTextLine before_line_msg="card. PLEASE DO NOT DELETE THIS EMAIL."/>

</BeforeBodyTextLines>

<AfterBodyTextLines>

<AfterBodyTextLine after_line_msg="Thank you for visiting!"/>

</AfterBodyTextLines>

</EmailTemplateText>

</Email>

</Message>

Sample “Contact Us” XML Message

<Message source="CWSerenade" target="cwi" type="CWEmailOut" date_created="2009-07-29" time_created="13:40:02">

<Email notification_type="CU" notification_type_desc="Contact Us" email_addr="eroosevelt@example.com" company="6" company_desc="Sample Company" entity="100" entity_desc="STATIONARY COMPANY">

<CustomerSoldTo sold_to_nbr="13046" sold_to_company="BROWN CONSULTING" sold_to_fname="DEBBIE" sold_to_minitial="E" sold_to_lname="BROWN" sold_to_addr1="24 EXAMPLE STREET" sold_to_addr2="SECOND FLOOR" sold_to_addr3="THIRD ADDRESS LINE" sold_to_addr4="FOURTH ADDRESS LINE" sold_to_apt="SUITE 1234" sold_to_city="WESTBOROUGH" sold_to_state="MA" sold_to_state_name="MASSACHUSETTS" sold_to_postal="01581" sold_to_country="USA" sold_to_country_name="UNITED STATES OF AMERICA" sold_to_alternate_id="000000007" sold_to_cust_class="LY" sold_to_cust_class_desc="LOYALTY CUSTOMER">

<custSoldToHist sold_to_LTD_nbr_orders="156" sold_to_LTD_order_dollars="6189.72" sold_to_LTD_nbr_sales="93" sold_to_LTD_sales_dollars="2645.46" sold_to_first_buyer="N" sold_to_last_src="SOURCE" sold_to_last_src_desc="SOURCE CODE"/>

</CustomerSoldTo>

<CustomerShipTo ship_to_fname="MICHAEL" ship_to_lname="WILLIAMS" ship_to_addr1="257 APPLE STREET" ship_to_city="WORCESTER" ship_to_state="MA" ship_to_state_name="MASSACHUSETTS" ship_to_postal="01602" ship_to_country="USA" ship_to_country_name="UNITED STATES OF AMERICA"/>

<Order order_nbr="6829" order_date="2009-07-29" order_source="SOURCE" order_source_desc="SOURCE CODE" order_offer="OFR" order_offer_desc="SEE WHAT&apos;S NEW" order_process_date="2009-07-29" order_ship_to="1" ost_tax="0.05" ost_merch="1.00" ost_freight="0.10" ost_total_amt="1.15"/>

<EmailTemplateText>

<BeforeBodyTextLines>

<BeforeBodyTextLine before_line_msg="Please contact us to help us resolve a question on this"/>

<BeforeBodyTextLine before_line_msg="order. You can call us at 508 555 0100 or email us at"/>

<BeforeBodyTextLine before_line_msg="support@example.com."/>

</BeforeBodyTextLines>

<AfterBodyTextLines>

<AfterBodyTextLine after_line_msg="Thank you for your attention."/>

</AfterBodyTextLines>

</EmailTemplateText>

</Email>

</Message>

Sample Credit Card Decline XML Message

<Message source="CWSerenade" target="cwi" type="CWEmailOut" date_created="2009-08-05" time_created="11:19:24">

<Email notification_type="CX" notification_type_desc="Credit Card Decline" email_addr="eroosevelt@example.com" company="6" company_desc="Example Company" entity="100" entity_desc="STATIONARY COMPANY">

<CustomerSoldTo sold_to_nbr="13356" sold_to_fname="MICHAEL" sold_to_lname="WILLIAMS" sold_to_addr1="257 EXAMPLE STREET" sold_to_city="WESTBOROUGH" sold_to_state="MA" sold_to_state_name="MASSACHUSETTS" sold_to_postal="01581" sold_to_country="USA" sold_to_country_name="UNITED STATES OF AMERICA" sold_to_alternate_id="000000267" sold_to_cust_class="LY" sold_to_cust_class_desc="LOYALTY CUSTOMER">

<custSoldToHist sold_to_LTD_nbr_orders="13" sold_to_LTD_order_dollars="167.54" sold_to_LTD_nbr_sales="7" sold_to_LTD_sales_dollars="34.02" sold_to_first_buyer="N" sold_to_last_src="SOURCE" sold_to_last_src_desc="SOURCE CODE"/>

</CustomerSoldTo>

<CustomerShipTo ship_to_fname="MICHAEL" ship_to_lname="WILLIAMS" ship_to_addr1="257 EXAMPLE STREET" ship_to_city="WESTBOROUGH" ship_to_state="MA" ship_to_state_name="MASSACHUSETTS" ship_to_postal="01581" ship_to_country="USA" ship_to_country_name="UNITED STATES OF AMERICA"/>

<Order order_nbr="6917" order_date="2009-08-03" order_source="SOURCE" order_source_desc="SOURCE CODE" order_offer="OFR" order_offer_desc="SEE WHAT&apos;S NEW" order_process_date="2009-08-03" order_type="O" order_ship_to="1" ost_tax="1.05" ost_merch="21.00" ost_freight="2.10" ost_addl_freight="12.50" ost_total_amt="36.65"/>

<EmailTemplateText>

<BeforeBodyTextLines>

<BeforeBodyTextLine before_line_msg="Please contact us to resolve a question"/>

<BeforeBodyTextLine before_line_msg="about this order so that we can fulfill it"/>

<BeforeBodyTextLine before_line_msg="as soon as possible."/>

</BeforeBodyTextLines>

<AfterBodyTextLines>

<AfterBodyTextLine after_line_msg="Thank you for your business."/>

</AfterBodyTextLines>

</EmailTemplateText>

</Email>

</Message>

Sample Quote Confirmation XML Message

<Message source="CWSerenade" target="cwi" type="CWEmailOut" date_created="2009-10-28" time_created="16:27:32">

<Email notification_type="QC" notification_type_desc="Quote Confirmation" email_addr="kbrown@example.com" company="7" company_desc="EXAMPLE COMPANY" entity="207" entity_desc="ENTITY 207">

<CustomerSoldTo sold_to_nbr="28" sold_to_fname="JACK" sold_to_minitial="T" sold_to_lname="COOPER" sold_to_addr1="1212 EXAMPLE WAY" sold_to_city="WESTBOROUGH" sold_to_state="MA" sold_to_state_name="MASSACHUSETTS" sold_to_postal="01581" sold_to_country="USA" sold_to_country_name="United States of America" sold_to_cust_class="CL" sold_to_cust_class_desc="CUSTOMER CLASS">

<custSoldToHist sold_to_LTD_nbr_orders="5" sold_to_LTD_order_dollars="423.84" sold_to_LTD_nbr_sales="1" sold_to_LTD_sales_dollars="367.84" sold_to_first_buyer="N" sold_to_last_src="SOURCE7" sold_to_last_src_desc="SOURCE CODE 7" />

</CustomerSoldTo>

<CustomerShipTo ship_to_fname="MARY" ship_to_minitial="T" ship_to_lname="JONES" ship_to_addr1="99 RIVER LN" ship_to_addr3="KAT'S FARM STAND" ship_to_apt="LOT 3" ship_to_city="TEMPLETON" ship_to_state="MA" ship_to_state_name="MASSACHUSETTS" ship_to_postal="01468-1591" ship_to_country="USA" ship_to_country_name="UNITED STATES OF AMERICA" />

<Order order_nbr="2324" order_date="2009-10-28" order_source="SOURCE7" order_source_desc="SOURCE CODE 7" order_offer="7" order_offer_desc="7 DEFAULT OFFER" order_process_date="2009-10-28" order_ship_to="1" ost_discount="63.80" ost_tax="12.76" ost_merch="255.19" ost_freight="10.00" ost_total_amt="277.95" cancel_date="2009-11-27" sales_rep_number="1" sales_rep_name="SARA JONES">

<OrderDetails>

<OrderDetail odt_item="RF1234567890" odt_item_desc="NESTING 8 PIECE STAINLESS STEEL COOKWARE" odt_set_master="N" odt_free_gift="N" odt_offer="7" odt_offer_desc="7 DEFAULT OFFER" odt_source="SOURCE7" odt_source_desc="SOURCE CODE 7" odt_price="159.99" odt_qty="1" odt_extended_price="159.99" odt_availability_msg="Backordered" odt_expected_ship_date="2009-10-29" odt_seq_nbr="1" odt_line_nbr="1" sku_country_of_origin="USA" harmonize_code="8474646464444432" />

<OrderDetail odt_item="RF123SKU4567" odt_item_desc="WOMEN'S ALL WEATHER PACKABLE RAIN JACKET" odt_SKU="ROSE XSML WMNS" odt_SKU_desc="WOMEN'S X-SMALL ROSE POCKET RAIN JACKET" odt_set_master="N" odt_free_gift="N" odt_offer="7" odt_offer_desc="7 DEFAULT OFFER" odt_source="SOURCE7" odt_source_desc="SOURCE CODE 7" odt_price="95.20" odt_qty="1" odt_extended_price="95.20" odt_availability_msg="Backordered" odt_expected_ship_date="2009-10-29" odt_seq_nbr="2" odt_line_nbr="2" sku_country_of_origin="USA" harmonize_code="HARMONIZE" />

</OrderDetails>

<OrderPayments />

</Order>

<EmailTemplateText>

<BeforeBodyTextLines>

<BeforeBodyTextLine before_line_msg="Thank you for requesting a quote from GardenPets. The quote summary" />

<BeforeBodyTextLine before_line_msg="below provides you with an estimate for the item you have requested" />

<BeforeBodyTextLine before_line_msg="To place an order for the quote below, call us at 1-800-345-4487 and" />

<BeforeBodyTextLine before_line_msg="provide our sales representative with your quote number." />

</BeforeBodyTextLines>

<AfterBodyTextLines>

<AfterBodyTextLine after_line_msg="Thank you for choosing GardenPets for all of your" />

<AfterBodyTextLine after_line_msg="Garden and Home needs." />

<AfterBodyTextLine after_line_msg="Visit us at Example.com!" />

</AfterBodyTextLines>

</EmailTemplateText>

</Email>

</Message>

Sample Membership Cancellation Confirmation XML Message

<Message source="CWSerenade" target="cwi" type="CWEmailOut" date_created="2010-01-20" time_created="11:46:16">

<Email notification_type="MF" notification_type_desc="Membership Cancellation" email_addr="eroosevelt@example.com" company="6" company_desc="Example Company" entity="100" entity_desc="STATIONARY COMPANY">

<CustomerSoldTo sold_to_nbr="13060" sold_to_fname="HELEN" sold_to_lname="SMITH" sold_to_addr1="78 APPLE STREET" sold_to_city="WORCESTER" sold_to_state="MA" sold_to_state_name="MASSACHUSETTS" sold_to_postal="01602" sold_to_country="USA" sold_to_country_name="UNITED STATES OF AMERICA" sold_to_alternate_id="000000020" sold_to_cust_class="LY" sold_to_cust_class_desc="LOYALTY CUSTOMER">

<custSoldToHist sold_to_LTD_nbr_orders="28" sold_to_LTD_order_dollars="865.20" sold_to_LTD_nbr_sales="17" sold_to_LTD_sales_dollars="613.30" sold_to_first_buyer="N" sold_to_last_src="SOURCE" sold_to_last_src_desc="SOURCE CODE"/>

<memberShip membership_id="COFFEECLUB" membership_desc="COFFEE OF THE MONTH" mbr_cancel_rsn="06" mbr_cancel_rsn_desc="MEMB CANCELED AT CUST REQUEST" mbr_send_to_soldto="Y"/>

</CustomerSoldTo>

<CustomerShipTo ship_to_fname="HELEN" ship_to_lname="SMITH" ship_to_addr1="78 APPLE STREET" ship_to_city="WORCESTER" ship_to_state="MA" ship_to_state_name="MASSACHUSETTS" ship_to_postal="01602" ship_to_country="USA" ship_to_country_name="UNITED STATES OF AMERICA"/>

<EmailTemplateText>

<BeforeBodyTextLines>

<BeforeBodyTextLine before_line_msg="We have canceled your membership at your request."/>

<BeforeBodyTextLine before_line_msg="Looking forward to serving you in the future."/>

</BeforeBodyTextLines>

<AfterBodyTextLines>

<AfterBodyTextLine after_line_msg="Do not respond to this email."/>

</AfterBodyTextLines>

</EmailTemplateText>

</Email>

</Message>

Sample Maintenance Failure XML Message

 

<Message time_created="11:04:41" date_created="2015-09-04" type="CWEmailOut" target="cwi" source="CWSerenade">

<Email entity_desc="ENTITY 100" entity="100" company_desc="KAB Co 7" company="7" email_addr="tbrown@example.com" notification_type="ME">

<CustomerSoldTo sold_to_suppress_sales_rep_email="N" sold_to_eve_phone="(508)555-0100" sold_to_day_phone="(508)555-0101" sold_to_country_name="UNITED STATES" sold_to_country="US" sold_to_postal="01581" sold_to_state_name="MASSACHUSETTS" sold_to_state="MA" sold_to_city="WESTBOROUGH" sold_to_addr1="1234 SAMPLE ST" sold_to_lname="BROWN" sold_to_minitial="R" sold_to_fname="THOMAS" sold_to_nbr="101">

<CustomerSoldToHistory sold_to_last_src_desc="BROKER SOURCE" sold_to_last_src="BROKER" sold_to_first_buyer="N" sold_to_LTD_sales_dollars="1314.99" sold_to_LTD_nbr_sales="12" sold_to_LTD_order_dollars="33355.13" sold_to_LTD_nbr_orders="107"/></CustomerSoldTo><CustomerShipTo ship_to_eve_phone="(508)339-0116" ship_to_day_phone="(508)652-9429" ship_to_country_name="UNITED STATES" ship_to_country="US" ship_to_postal="01581" ship_to_state_name="MASSACHUSETTS" ship_to_state="MA" ship_to_city="WESTBOROUGH" ship_to_addr1="1234 SAMPLE ST" ship_to_lname="BROWN" ship_to_minitial="R" ship_to_fname="THOMAS"/>

<Order alternate_order_nbr="0904201507" ost_total_nbr_recipients="1" ost_gift="N" ost_ship_via_desc="UPS GROUND" ost_ship_via_code="1" order_type="W" sales_rep_number="0" ost_total_amt="407.99" ost_freight="7.99" ost_merch="400.00" order_ship_to="1" order_process_date="2015-09-04" order_offer_desc="SUMMER 2015" order_offer="S15" order_source_desc="BROKER SOURCE" order_source="BROKER" order_date="2015-09-04" order_nbr="337">

<OriginatingStore/>

</Order>

<EmailTemplateText>

<BeforeBodyTextLines>

<BeforeBodyTextLine before_line_msg="Company 7 Maintenance Failure above line one"/>

<BeforeBodyTextLine before_line_msg="Company 7 Maintenance Failure above line two"/>

<BeforeBodyTextLine before_line_msg="Company 7 Maintenance Failure above line three"/>

<BeforeBodyTextLine before_line_msg="Company 7 Maintenance Failure above line four"/>

<BeforeBodyTextLine before_line_msg="Company 7 Maintenance Failure above line five"/>

<BeforeBodyTextLine before_line_msg="Company 7 Maintenance Failure above line six"/>

<BeforeBodyTextLine before_line_msg="Company 7 Maintenance Failure above line seven"/>

<BeforeBodyTextLine before_line_msg="Company 7 Maintenance Failure above line eight"/>

<BeforeBodyTextLine before_line_msg="Company 7 Maintenance Failure above line nine"/>

<BeforeBodyTextLine before_line_msg="Company 7 Maintenance Failure above line ten"/>

</BeforeBodyTextLines>

<AfterBodyTextLines>

<AfterBodyTextLine after_line_msg="Company 7 Maintenance Failure below line one"/>

<AfterBodyTextLine after_line_msg="Company 7 Maintenance Failure below line two"/>

<AfterBodyTextLine after_line_msg="Company 7 Maintenance Failure below line three"/>

</AfterBodyTextLines>

</EmailTemplateText>

</Email>

</Message>

Sample Order Cancellation Confirmation XML Message

<Message source="CWSerenade" target="cwi" type="CWEmailOut" date_created="2010-05-04" time_created="11:08:24">

<Email notification_type="OB" notification_type_desc="Order Cancellation" email_addr="rfleming@example.com" company="12" company_desc="Example Company" entity_desc="SYSTEM TESTING">

<CustomerSoldTo sold_to_nbr="14754" sold_to_fname="HELEN" sold_to_minitial="M" sold_to_lname="SMITH" sold_to_addr1="1 EXAMPLE ST" sold_to_city="WESTBOROUGH" sold_to_state="MA" sold_to_state_name="MASSACHUSETTS" sold_to_postal="01581-2505" sold_to_country="USA" sold_to_country_name="UNITED STATES" sold_to_alternate_id="39910900004">

<custSoldToHist sold_to_LTD_nbr_orders="162" sold_to_LTD_order_dollars="22376.93" sold_to_LTD_nbr_sales="134" sold_to_LTD_sales_dollars="16668.85" sold_to_first_buyer="N" sold_to_last_src="LAV" sold_to_last_src_desc="LAV SYSTEM TESTING SOURCE CODE"/>

</CustomerSoldTo>

<CustomerShipTo ship_to_fname="HELEN" ship_to_minitial="M" ship_to_lname="SMITH" ship_to_addr1="1 EXAMPLE ST" ship_to_city="WESTBOROUGH" ship_to_state="MA" ship_to_state_name="MASSACHUSETTS" ship_to_postal="01581-2505" ship_to_country="USA" ship_to_country_name="UNITED STATES"/>

<Order order_nbr="345" order_date="2010-05-04" order_source="LAV" order_source_desc="LAV SYSTEM TESTING SOURCE CODE" order_offer="LA" order_offer_desc="LAV OFFER" order_process_date="2010-05-04" order_type="P" order_ship_to="1" sales_rep_number="0" ost_cancel_rsn="3" ost_cancel_rsn_desc="CUSTOMER CHANGED MIND">

<OrderDetails>

<OrderDetail odt_item="JACKET" odt_item_desc="PATRIOTS JACKET" odt_SKU="BLU MED" odt_item_class="21" odt_item_class_desc="CLOTHING" odt_set_master="N" odt_free_gift="N" odt_offer="S00" odt_offer_desc="SPRING 2010" odt_source="LAV" odt_source_desc="SPRING PREVIEW 2010" odt_price="67.50" odt_qty="0" odt_extended_price="67.50" odt_availability_msg="In stock" odt_seq_nbr="1" odt_line_nbr="1" odt_cancel_rsn="3" odt_cancel_rsn_desc="CUSTOMER CHANGED MIND" odt_qty_cancelled="1"/>

<OrderDetail odt_item="SKIRT" odt_item_desc="SUMMER OUTFIT" odt_item_class="11" odt_item_class_desc="CLOTHING" odt_set_master="N" odt_free_gift="Y" odt_offer="W18" odt_offer_desc="WINTER GIVING CATALOG" odt_source="LA2" odt_source_desc="WINTER SAVINGS" odt_qty="0" odt_availability_msg="In stock" odt_seq_nbr="2" odt_line_nbr="2" odt_cancel_rsn="3" odt_cancel_rsn_desc="CUSTOMER CHANGED MIND" odt_qty_cancelled="1"/>

</OrderDetails>

<OrderPayments>

<OrderPayment opm_payment_type="1" opm_payment_type_desc="CASH, CHECKS"/>

</OrderPayments>

</Order>

<EmailTemplateText>

<BeforeBodyTextLines>

<BeforeBodyTextLine before_line_msg="Dear Rhonda,"/>

<BeforeBodyTextLine before_line_msg="Your order has been cancelled at your request."/>

</BeforeBodyTextLines>

<AfterBodyTextLines>

<AfterBodyTextLine after_line_msg="If you have any questions, please feel free to contact"/>

<AfterBodyTextLine after_line_msg="Customer Service at 1-800-555-1212."/>

<AfterBodyTextLine after_line_msg="Please do not reply to this message."/>

</AfterBodyTextLines>

</EmailTemplateText>

</Email>

</Message>

Sample Order Line Cancellation Confirmation XML Message

<Message source="CWSerenade" target="cwi" type="CWEmailOut" date_created="2010-05-04" time_created="13:10:26">

<Email notification_type="OL" notification_type_desc="Order Line Cancellation" email_addr="rfleming@example.com" company="12" company_desc="Example Company" entity_desc="SYSTEM TESTING">

<CustomerSoldTo sold_to_nbr="14754" sold_to_fname="MARY" sold_to_minitial="M" sold_to_lname="JOHNSON" sold_to_addr1="1 EXAMPLE ST" sold_to_city="WESTBOROUGH" sold_to_state="MA" sold_to_state_name="MASSACHUSETTS" sold_to_postal="01581-2505" sold_to_country="USA" sold_to_country_name="UNITED STATES" sold_to_alternate_id="39910900004">

<custSoldToHist sold_to_LTD_nbr_orders="163" sold_to_LTD_order_dollars="22638.18" sold_to_LTD_nbr_sales="134" sold_to_LTD_sales_dollars="16668.85" sold_to_first_buyer="N" sold_to_last_src="LAV" sold_to_last_src_desc="LAV SYSTEM TESTING SOURCE CODE"/>

</CustomerSoldTo>

<CustomerShipTo ship_to_fname="MARY" ship_to_minitial="M" ship_to_lname="JOHNSON" ship_to_addr1="1 EXAMPLE ST" ship_to_city="WESTBOROUGH" ship_to_state="MA" ship_to_state_name="MASSACHUSETTS" ship_to_postal="01581-2505" ship_to_country="USA" ship_to_country_name="UNITED STATES"/>

<Order order_nbr="346" order_date="2010-05-04" order_source="LAV" order_source_desc="LAV SYSTEM TESTING SOURCE CODE" order_offer="LA" order_offer_desc="LAV OFFER" order_process_date="2010-05-04" order_type="P" order_ship_to="1" ost_discount="1.25" ost_merch="11.25" ost_total_amt="11.25" sales_rep_number="0">

<OrderDetails>

<OrderDetail odt_item="CP11" odt_item_desc="COFFEE POT" odt_item_class="08" odt_item_class_desc="HOUSEHOLD GOODS" odt_set_master="N" odt_free_gift="N" odt_offer="S00" odt_offer_desc="SPRING 2010" odt_source="LAV" odt_source_desc="SPRING PREVIEW 2010" odt_price="11.25" odt_qty="1" odt_extended_price="11.25" odt_availability_msg="In stock" odt_seq_nbr="1" odt_line_nbr="1" odt_qty_cancelled="0"/>

<OrderDetail odt_item="COOKWARE" odt_item_desc="STAINLESS STEEL PRESSURE COOKER" odt_item_class="08" odt_item_class_desc="HOUSEHOLD GOODS" odt_set_master="N" odt_free_gift="N" odt_offer="S00" odt_offer_desc="SPRING 2010" odt_source="LAV" odt_source_desc="SPRING PREVIEW 2010"odt_price="250.00" odt_qty="0" odt_extended_price="250.00" odt_availability_msg="In stock" odt_seq_nbr="2" odt_line_nbr="2" odt_cancel_rsn="3" odt_cancel_rsn_desc="CUSTOMER CHANGED MIND" odt_qty_cancelled="1"/>

<OrderDetail odt_item="SKIRT" odt_item_desc="SUMMER OUTFIT" odt_item_class="11" odt_item_class_desc="CLOTHING" odt_set_master="N" odt_free_gift="Y" odt_offer="S00" odt_offer_desc="SPRING 2010" odt_source="LAV" odt_source_desc="SPRING PREVIEW 2010" odt_qty="0" odt_availability_msg="In stock" odt_seq_nbr="3" odt_line_nbr="3" odt_cancel_rsn="3" odt_cancel_rsn_desc="CUSTOMER CHANGED MIND" odt_qty_cancelled="1"/>

</OrderDetails>

<OrderPayments>

<OrderPayment opm_payment_type="1" opm_payment_type_desc="CASH, CHECKS"/>

</OrderPayments>

</Order>

<EmailTemplateText>

<BeforeBodyTextLines>

<BeforeBodyTextLine before_line_msg="Dear Rhonda,"/>

<BeforeBodyTextLine before_line_msg="The following item(s) have been cancelled at your request."/>

</BeforeBodyTextLines>

<AfterBodyTextLines>

<AfterBodyTextLine after_line_msg="If you have any questions, please feel free to contact"/>

<AfterBodyTextLine after_line_msg="Customer Service at 1-800-555-1212."/>

<AfterBodyTextLine after_line_msg="Please do not reply to this message."/>

</AfterBodyTextLines>

</EmailTemplateText>

</Email>

</Message>

Sample Store Pickup Notification Email

Note: Order Broker’s Store Connect module does not use this notification email; instead, you can use Order Broker to generate a notification to the customer.

<Message source="CWSerenade" target="cwi" type="CWEmailOut" date_created="2012-11-29" time_created="09:14:23">

<Email notification_type="SP" notification_type_desc="Store Pickup Confirmation" email_addr="aviolin@funmail.com" company="6" company_desc="Example Company" entity="100" entity_desc="STATIONARY COMPANY">

<CustomerSoldTo sold_to_nbr="305" sold_to_fname="JACK" sold_to_lname="JONES" sold_to_addr1="10 APPLE STREET" sold_to_city="WORCESTER" sold_to_state="MA" sold_to_state_name="MASSACHUSETTS" sold_to_postal="01602" sold_to_country="USA" sold_to_country_name="UNITED STATES OF AMERICA" sold_to_alternate_id="000000586">

<custSoldToHist sold_to_LTD_nbr_orders="9" sold_to_LTD_order_dollars="88.00" sold_to_LTD_nbr_sales="4" sold_to_LTD_sales_dollars="6.00" sold_to_first_buyer="N" sold_to_last_src="SOURCE" sold_to_last_src_desc="SOURCE CODE" />

</CustomerSoldTo>

<CustomerShipTo ship_to_company="Example Company" ship_to_addr1="WEBSTER MALL" ship_to_addr2="10 CEDAR STREET" ship_to_addr3="SUITE 12345" ship_to_addr4="ADDRESS LINE 4" ship_to_city="WEBSTER" ship_to_state="MA" ship_to_state_name="MASSACHUSETTS" ship_to_postal="01570" ship_to_country="USA" ship_to_country_name="UNITED STATES OF AMERICA" />

<Order order_nbr="12039" order_date="2012-11-20" order_source="SOURCE" order_source_desc="SOURCE CODE" order_offer="OFR" order_offer_desc="SEE WHAT'S NEW" order_process_date="2012-11-20" order_ship_to="1" ost_tax="1.38" ost_merch="20.00" ost_freight="2.00" ost_total_amt="23.38" sales_rep_number="0" delivery_type="Store Pickup" order_type="U" ost_ship_via_code="4" ost_ship_via_desc="BEST WAY" ost_gift="N" ost_total_nbr_recipients="1" alternate_order_nbr="112012HA" purchase_order_nbr="112012HA">

<OrderDetails>

<OrderDetail odt_item="KABNOSKU" odt_item_desc="TEST FOR ORDER BROKER 10/14/09" odt_set_master="N" odt_free_gift="N" odt_offer="OFR" odt_offer_desc="SEE WHAT'S NEW" odt_source="SOURCE" odt_source_desc="SOURCE CODE" odt_price="10.00" odt_qty="2" odt_extended_price="20.00" odt_availability_msg="Store Pickup" odt_expected_ship_date="2012-11-24" odt_seq_nbr="1" odt_line_nbr="1" odt_original_price="10.00" odt_gift_wrap="N" />

</OrderDetails>

<OrderPayments>

<OrderPayment opm_payment_type="5" opm_payment_type_desc="MASTERCARD" opm_credit_card="CHANGEDBYLOGGER" opm_credit_card_exp_date="12/12" />

</OrderPayments>

<OriginatingStore store_phone="5085550100" store_addr1="WEBSTER MALL" store_addr2="10 CEDAR STREET" store_addr3="SUITE 12345" store_addr4="ADDRESS LINE 4" store_city="WEBSTER" store_state="MA" store_state_name="MASSACHUSETTS" store_postal="01570" store_country="USA" store_country_name="UNITED STATES OF AMERICA" originating_store_name="Example Store" broker_fulfill_store="317" />

</Order>

<EmailTemplateText>

<BeforeBodyTextLines>

<BeforeBodyTextLine before_line_msg="Your order is ready for pickup at the store listed below." />

</BeforeBodyTextLines>

<AfterBodyTextLines>

<AfterBodyTextLine after_line_msg="Thank you for your business!" />

</AfterBodyTextLines>

</EmailTemplateText>

</Email>

</Message>

Sample Customer Engagement Loyalty Registration Notification Email

<Message source="CWSerenade" target="cwi" type="CWEmailOut" date_created="2014-02-25" time_created="15:12:21">

<Email notification_type="LR" notification_type_desc="Loyalty Registration Notification" email_addr="kbrown@example.com" company="7" company_desc="Example Company">

<CustomerSoldTo sold_to_nbr="49" sold_to_fname="SARA" sold_to_minitial="E" sold_to_lname="JONES" sold_to_addr1="5 RIVER ST" sold_to_city="TEMPLETON" sold_to_state="MA" sold_to_state_name="MASSACHUSETTS" sold_to_postal="01468-1425" sold_to_country="USA" sold_to_country_name="UNITED STATES OF AMERICA" sold_to_cust_class="4" sold_to_cust_class_desc="4 CUSTOMER CLASS" sold_to_day_phone="5085550100" sold_to_eve_phone="5085550101" sold_to_fax_phone="5085550102" sold_to_suppress_sales_rep_email="N">

<CustomerSoldToHistory sold_to_LTD_nbr_orders="2" sold_to_LTD_order_dollars="100.00" sold_to_LTD_nbr_sales="2" sold_to_LTD_sales_dollars="100.00" sold_to_first_buyer="N" sold_to_last_src="SOURCE7" sold_to_last_src_desc="SOURCE CODE 7"/>

</CustomerSoldTo>

<EmailTemplateText>

<BeforeBodyTextLines>

<BeforeBodyTextLine before_line_msg="Thank you for signing up for Loyalty."/>

<BeforeBodyTextLine before_line_msg="You can earn points and redeem awards on every purchase!"/>

<BeforeBodyTextLine before_line_msg="Included in this email is your loyalty card number."/>

<BeforeBodyTextLine before_line_msg="Please save this email for future reference."/>

</BeforeBodyTextLines>

<AfterBodyTextLines>

<AfterBodyTextLine after_line_msg="Thank you for visiting GardenPets!"/>

<AfterBodyTextLine after_line_msg="We appreciate your business."/>

<AfterBodyTextLine after_line_msg="Do not respond to this email."/>

</AfterBodyTextLines>

</EmailTemplateText>

<LoyaltyCard loyalty_card_nbr="0094807583443147"/>

</Email>

</Message>

Outbound Email XML Message (CWEmailOut)

 

The system generates this message, rather than an actual email, when the XML only? flag is selected for an email template. See Process Overview and Outbound Email API Setup for more information, and see Sample Outbound Email XML Messages for samples of each email notification message that you can generate through the Outbound Email API.

Note:

• Certain special characters are substituted in text fields. See Translating Special Characters for more information.

• Numeric fields include an explicit decimal. For example, a dollar value of $20.50 is presented as 20.50.

Attribute Name

Type

Length

Comments

Message

Included for all notification types.

source

alpha

20

target

alpha

20

type

alpha

20

CWEmailOut

date_created

numeric

8

YYYY-MM-DD format.

time_created

numeric

6

HH:MM:SS format.

Email

Included for all notification types.

notification_type

alpha

2

Possible values are:

B1 = first backorder notice

B2 = second backorder notice

B3 = continue backorder notice

C1 = credit acknowledgment

CU = “contact us”

CX = credit card decline

LR = Customer Engagement loyalty registration notice

ME = Maintenance failure

MF = membership cancellation

OB = order cancellation

OC = order confirmation

OL = order line cancellation

QC = quote confirmation

RC = return confirmation

SC = shipment confirmation

S1 = soldout notification

SP = store pickup confirmation

SV = stored value card

notification_type_desc

alpha

25

The description of the notification type:

• Backorder 1st Notice

• Backorder 2nd Notice

• Backorder Continue Notice

• Contact Us

• Credit Card Credit Ack

• Credit Card Decline

• Loyalty Registration Notification

• Membership Cancellation

• Order Cancellation

• Order Confirmation

• Order Line Cancellation

• Quote Confirmation

• Return Confirmation

• Shipment Confirmation

• Soldout Notification

• Store Pickup Confirmation

• Stored Value Card

email_addr

alpha

50

The email address to receive the notification related to the order. See Working with an Order-Level Email Address for more information on how the system determines the email address to assign to an order, and see Membership Cancellations for information on how the system determines the email address to use for a membership cancellation notification.

company

numeric

3

The code identifying the company where the order activity has taken place.

company_desc

alpha

30

The description of the company from the Company table.

entity

numeric

3

The code identifying the entity which is associated with the division assigned to the source code on the order header. See Working with Entities (WENT) for more information on entities, and see Working with Source Codes (WSRC) for information on how you assign a division to a source code.

Membership cancellations: The system uses the Default source for a customer membership to determine the related entity. The entity and its description are not included for membership cancellation emails related to loyalty memberships, since they are not associated with a specific entity.

entity_desc

alpha

25

The description of the entity from the Entity table.

CustomerSoldTo

Included for all notification types. See Creating and Updating Sold-to Customers (WCST) for a discussion on the following attributes.

sold_to_nbr

numeric

9

The number identifying the customer who placed the order.

From Cust # in the Order Header table.

sold_to_company

alpha

30

The company, if any, that is part of the customer’s address.

From NAM company name in the Customer Sold To table.

sold_to_fname

alpha

15

The customer’s first name.

From NAM first name in the Customer Sold To table.

sold_to_minitial

alpha

1

The customer’s middle initial.

From NAM initial in the Customer Sold To table.

sold_to_lname

alpha

25

The customer’s last name.

From NAM last name in the Customer Sold To table.

sold_to_addr1

alpha

32

The first line of the customer’s address.

From NAM street address in the Customer Sold To table.

sold_to_addr2

alpha

32

The second line, if any, of the customer’s address.

From NAM address line 2 in the Customer Sold To table.

sold_to_addr3

alpha

32

The third line, if any, of the customer’s address.

From Address line 3 in the Customer Sold To Extended table.

sold_to_addr4

alpha

32

The fourth line, if any, of the customer’s address.

From Address line 4 in the Customer Sold To Extended table.

sold_to_apt

alpha

10

The apartment or suite.

From NAM apartment in the Customer Sold To table.

sold_to_city

alpha

25

The city where the customer lives.

From NAM city in the Customer Sold To table.

sold_to_state

alpha

2

The two-letter code for the customer’s state or province. This tag is not included if the Require state? flag is unselected for the customer’s country in Setting Up the Country Table (WCTY), and no state is specified for the customer’s address.

From NAM state in the Customer Sold To table.

sold_to_state_name

alpha

25

The description of the state, as set up through Setting Up the Country Table (WCTY).

From Description in the State table.

sold_to_postal

alpha

10

The customer’s postal or zip code. This tag is not included if the Require postal code? flag is unselected for the customer’s country in Setting Up the Country Table (WCTY), and no postal code is specified for the customer’s address.

From NAM zip in the Customer Sold To table.

sold_to_country

alpha

3

The three-letter code for the customer’s country.

From RPR country in the Customer Sold To table.

sold_to_country_

name

alpha

30

The description of the country, as specified through Setting Up the Country Table (WCTY).

From Description in the Country table.

sold_to_alternate_id

alpha

15

The alternate customer number, if any, specified in the Customer Sold To table; see Alternate customer number for a discussion.

From Interface cust code in the Customer Sold To table.

sold_to_cust_class

alpha

2

The Class assigned to the customer.

From CCL Customer class in the Customer Sold To table.

sold_to_cust_class_desc

alpha

30

The description of the customer class, as specified through Setting Up the Customer Class Table (WCCL).

From CCL Description in the Customer Class table.

sold_to_day_phone

alpha

14

The sold to customer’s day phone number.

From CS# Phone in the Customer Sold To Phone # table for CS# Phone # type D.

Available in: 8.0 (release 3.5 of Order Management System).

sold_to_eve_phone

alpha

14

The sold to customer’s evening phone number.

From CS# Phone in the Customer Sold To Phone # table for CS# Phone # type E.

Available in: 8.0 (release 3.5 of Order Management System).

sold_to_fax_phone

alpha

14

The sold to customer’s third (fax or mobile) number.

From CS# Phone in the Customer Sold To Phone # table for CS# Phone # type F.

Available in: 8.0 (release 3.5 of Order Management System).

sold_to_suppress_sales_rep_email

alpha

1

Defines whether the Outbound Email (CWEmailOut) message sent to this sold to customer is 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. The system sends a CWEmailOut message to the email address of the salesrep assigned to the customer for the following notification_types:

- order confirmations (notification_type OC).

- shipment and return confirmations (notification_type SC and RC).

- backorder notices (notification_type B1, B2, B3).

- soldout notifications (notification_type S1).

From Suppress Sales Rep Email Flag in the Customer Sold To table.

Available in: 8.0 (release 3.5 of Order Management System).

CustomerSoldToHistory

Included for all notification types.

The customer history information is updated by the ORDR_ASYNC background job. When the order API generates the CWEMailOut message, it does so before the order is processed by the ORDR_ASYNC job, so information on the current order is not included in the message. In the case of a new customer created on an order through the order API, no customer history has been created before the CWEmailOut message is generated.

sold_to_LTD_nbr_

orders

numeric

5

The Life-to-date Orders quantity from the Display Customer Order History Screen. Includes the current order.

sold_to_LTD_order_dollars

numeric

13.2

The life-to-date Orders amount from the Display Customer Order History Screen. Consists of merchandise dollar value only. Includes the current order.

sold_to_LTD_nbr_

sales

numeric

5

The life-to-date Sales quantity from the Display Customer Order History Screen.

sold_to_LTD_sales_dollars

numeric

13.2

The life-to-date Sales amount from the Display Customer Order History Screen, which includes merchandise dollar value only.

sold_to_first_buyer

alpha

1

Valid values are:

Y = This is the customer’s first order

N = This is not the customer’s first order

sold_to_last_src

alpha

9

In the case of an order confirmation, this is the source code used on the header of the order that generated the confirmation. For a shipment or return confirmation, this is the source code used on the last order placed by the customer.

sold_to_last_src_

desc

alpha

30

The description of the source code, as set up through Working with Source Codes (WSRC).

Membership

Included only for membership cancellation notification emails. See Membership Cancellations for a discussion.

Available in: 5.0 in release 2.5 of Order Management System.

membership_id

alpha

12

The code identifying the membership program, as set up through Working with Membership Programs (WWMP).

membership_desc

alpha

30

The description of the membership program.

mbr_cancel_rsn

numeric

2

The cancel reason code used to cancel the customer membership, as set up through Establishing Cancel Reason Codes (WCNR).

mbr_cancel_rsn_desc

alpha

30

The description of the cancel reason.

mbr_send_to_soldto

alpha

1

Indicates whether the email is being sent to the customer who originally ordered the customer membership, or to a recipient or alternate shipping address. Possible settings are:

Y = the email is being sent to the customer sold-to

N = the email is being sent to the email address associated with a recipient or alternate shipping address

See Membership Cancellations for a discussion.

CustomerShipTo

Included for all notification types except Oracle Retail Customer Engagement Loyalty Registration Notifications. The information in this element is different from the CustomerSoldTo if the customer specified an alternate shipping address on the order or for the customer membership:

• order ship-to: see Assigning an Order Shipping Address

• permanent ship-to: see Using a Permanent Shipping Address in Order Entry

• recipient customer: Adding a Recipient Order in Order Entry

• customer memberships: Membership Cancellations

• store pickup notifications: the ship-to address is the store where the customer has chosen to pick up the order, and the name and address defaults from the store cross reference record set up through Work with Store Cross Reference (WSCR). See Store Pickup Orders for background.

Note: Order Broker’s Store Connect module does not use this notification email; instead, you can use Order Broker to generate a notification to the customer.

Each separate ship-to generates a separate message.

Note: If there is not sufficient valid information on the shipping address, the generated message includes an empty CustomerShipTo element, for example: <CustomerShipTo />

ship_to_company

alpha

30

The ship to customer’s company.

From:

• Permanent ship to: NAM company name in the Customer Ship To table.

• Recipient sold to: NAM company name in the Customer Sold To table.

ship_to_fname

alpha

15

The ship to customer’s first name.

From:

• Permanent ship to: NAM first name in the Customer Ship To table.

• Recipient sold to: NAM first name in the Customer Sold To table.

ship_to_minitial

alpha

1

The ship to customer’s middle initial.

From:

• Permanent ship to: NAM initial in the Customer Ship To table.

• Recipient sold to: NAM initial in the Customer Sold To table.

ship_to_lname

alpha

25

The ship to customer’s last name.

From:

• Permanent ship to: NAM last name in the Customer Ship To table.

• Recipient sold to: NAM last name in the Customer Sold To table.

ship_to_addr1

alpha

32

The ship to customer’s street address.

From:

• Permanent ship to: NAM street address in the Customer Ship To table.

• Recipient sold to: NAM street address in the Customer Sold To table.

ship_to_addr2

alpha

32

The second address line on the ship to customer’s address.

From:

• Permanent ship to: NAM address line 2 in the Customer Ship To table.

• Recipient sold to: NAM address line 2 in the Customer Sold To table.

ship_to_addr3

alpha

32

The third address line on the ship to customer’s address.

From:

• Permanent ship to: Address line 3 in the Customer Ship To Extended table.

• Recipient sold to: Address line 3 in the Customer Sold To Extended table.

ship_to_addr4

alpha

32

The fourth address line on the ship to customer’s address.

From:

• Permanent ship to: Address line 4 in the Customer Ship To Extended table.

• Recipient sold to: Address line 4 in the Customer Sold To Extended table.

ship_to_apt

alpha

10

The ship to customer’s apartment or suite number.

From:

• Permanent ship to: NAM apartment in the Customer Ship To table.

• Recipient sold to: NAM apartment in the Customer Sold To table.

ship_to_city

alpha

25

The city on the ship to customer’s address.

From:

• Permanent ship to: NAM city in the Customer Ship To table.

• Recipient sold to: NAM city in the Customer Sold To table.

ship_to_state

alpha

2

The state on the ship to customer’s address. This tag is not included if the Require state? flag is unselected for the customer’s country in Setting Up the Country Table (WCTY), and no state is specified for the ship-to address.

From:

• Permanent ship to: NAM state in the Customer Ship To table.

• Recipient sold to: NAM state in the Customer Sold To table.

ship_to_state_name

alpha

25

The name of the state.

From Description in the State table.

ship_to_postal

alpha

10

The postal code on the ship to customer’s address. This tag is not included if the Require postal code? flag is unselected for the customer’s country in Setting Up the Country Table (WCTY), and no postal code is specified for the customer’s address.

From:

• Permanent ship to: NAM zip in the Customer Ship To table.

• Recipient sold to: NAM zip in the Customer Sold To table.

ship_to_country

alpha

3

The country on the ship to customer’s address.

From:

• Permanent ship to: RPR country in the Customer Ship To table.

• Recipient sold to: RPR country in the Customer Sold To table.

ship_to_country_name

alpha

30

The name of the country.

From Description in the Country table.

ship_to_day_phone

alpha

14

The ship to customer’s day phone number. From:

• Order ship to: Ship To Phone in the Order Ship To Address table. If this field is blank, the system uses the ship to day phone number and if blank, uses the sold to day phone number.

• Permanent ship to: CT# Phone in the Customer Ship To Phone # table for Phone # type D, or

• Recipient sold to: CS# Phone in the Customer Sold To Phone # table for Phone # type D.

Available in: 8.0 (release 3.5 of Order Management System).

ship_to_eve_phone

alpha

14

The ship to customer’s evening phone number. From:

• Permanent ship to: CT# Phone in the Customer Ship To Phone # table for Phone # type E, or

• Recipient sold to: CS# Phone in the Customer Sold To Phone # table for Phone # type D.

Available in: 8.0 (release 3.5 of Order Management System).

ship_to_fax_phone

alpha

14

The ship to customer’s third (fax or mobile) phone number. From:

• Permanent ship to: CT# Phone in the Customer Ship To Phone # table for Phone # type F, or

• Recipient sold to: CS# Phone in the Customer Sold To Phone # table for Phone # type D.

Available in: 8.0 (release 3.5 of Order Management System).

Order

Included for all notification types except the membership cancellation notification and Oracle Retail Customer Engagement loyalty registration notification.

delivery_type

alpha

13

Indicates the order was created or fulfilled through integration with the Order Broker. Valid values are:

• Delivery

• Retail Pickup

• Ship for Pickup

• Store Pickup

Based on the OBR delivery type in the Order Ship To table, where:

• D = delivery

• R = retail pickup

• S = ship for pickup

• P = store pickup

No delivery type is included for brokered backorders. See the Order Broker Integration for more information.

Note: In version 8.0 of the message, available in release 3.5.3 of Order Management System, the OriginatingStore element specifies the store code, description, and address for a delivery, retail pickup, ship-for-pickup, or store pickup order.

Available in: 7.0 (release 3.0 of Order Management System).

order_nbr

numeric

8

The unique number identifying the order or quote in your company.

From Order # in the Order Header table.

order_date

numeric

8

The processing date for the order. The current system date defaults when you create an order, but you can override it. YYYY-MM-DD format.

From OHD Order date in the Order Header table.

order_source

alpha

9

The source code used on the order header, indicating how the order originated and controlling shipping charges and other order settings. Defined in and validated against the Source Code table; see Working with Source Codes (WSRC) for more information.

From OHD SRC source code in the Order Header table.

order_source_desc

alpha

30

The description of the source code from the Source Code table.

From SRC description in the Source table.

order_offer

alpha

3

The offer associated with the order_source, as defined in the Source Code table. The offer controls item pricing information for the order.

From Offer Number in the Source table.

order_offer_desc

alpha

30

The description of the offer from the Offer table; see Working with Offers (WOFR).

From Offer Description in the Offer table.

order_process_date

numeric

8

The date when the customer wants to receive the order. This is the Arrival date, which defaults to the current system date at order entry. YYYY-MM-DD format.

Included only for order confirmations and stored value card notifications.

From OST Arrival date in the Order Ship To table.

order_ship_to

numeric

3

Identifies the individual shipping address on the order. Set to 1 for an order that has a single shipping address.

From Ship to # in the Order Ship To table.

ost_discount

numeric

5.2

The total discount amount applied to merchandise on the order ship-to. See Order Inquiry Header Screen for a description of how this field is calculated.

Included only for order and stored value card confirmations.

ost_tax

numeric

7.2

The total sales tax for the order, based on the value of the merchandise and, optionally, freight and special handling charges. If the order is subject to VAT, tax will generally be included in the item prices rather than in the Tax field.

Included only for order and stored value card confirmations.

From OST tax in the Order Ship To table.

ost_merch

numeric

9.2

The total value of the items on the order, excluding freight, additional charges, service charges, tax (but including hidden tax), handling, and duty. The merchandise total does not include items that are canceled, soldout, or returned.

Included only for order and stored value card confirmations.

From OST Merch in the Order Ship To table.

ost_freight

numeric

7.2

The total charge for shipping the order, not including additional freight charges. You can define additional freight charges for a carrier to include standard freight; in this case, this field is blank.

This field also includes service charges by ship via, if any, and order weight charges based on the ship via defined for each ship to customer on the order.

The system calculates freight charges based on the freight method defined for the source code.

Included only for order and stored value card confirmations.

From OST Freight in the Order Ship To table.

ost_addl_freight

numeric

7.2

The total dollar amount for freight charges, in addition to the base freight charge for the order. Additional freight charges are set for the carrier, as defined in the Ship Via table. If the additional freight charges include the standard freight charges, there is no ost_freight.

Examples of additional freight charges are overnight shipping, second day delivery, etc.

The Add'l freight field in Order Inquiry corresponds to the Frt+ field in Order Entry.

Included only for order and stored value card confirmations.

From OST Add’l freight in the Order Ship To table.

ost_hand

numeric

7.2

The cost of any special handling on the order, such as personalizing, monogramming, or engraving, and any gift wrapping charges.

If there are any duty charges on the order, they are also included in the Handling total.

Included only for order and stored value card confirmations.

From OST Handling in the Order Ship To table.

ost_addl_charge

numeric

7.2

This field can include charges or credits. Additional charges might include:

• Additional source code charge

• Credits

• Additional shipper/item charge

• Dollar discounts

See Order Inquiry Header Screen for a discussion.

Included only for order and stored value card confirmations.

From OST Add’l charges in the Order Ship To table.

ost_total_amt

numeric

9.2

The total amount the customer owes for the order, including:

• Merchandise

• Freight

• Additional freight charges

• Taxes

• Handling

• Duty

• Additional charges

The total does not include charges for canceled, returned or sold out items.

Included only for order and stored value card confirmations.

cancel_date

numeric

7

The date:

• The quote will be canceled if it has not yet been converted into an order. See Assigning an Expiration Date to a Quote.

• The order will be canceled if all lines have not shipped. The system will not reserve inventory one day prior to the order cancellation date, because the order would not reach the customer in time.

From OST Cancel Date in the Order Ship To table.

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

sales_rep_number

numeric

7

The code for the sales representative on the order or quote.

From SLS Salesman # in the Order Header table.

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

sales_rep_name

alpha

30

The name of the sales representative.

From SLS Name in the Salesman table.

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

ost_cancel_rsn

numeric

2

The cancel reason code used to cancel the entire order, or the last remaining item on the order if there have not been any shipments. If you use multiple cancel reasons the individual order lines, this is the cancel reason code used on the last order line added (highest order line number). Included only for the order cancellation email. Cancellation codes are defined in and validated against the Cancel Reason Code table; see Establishing Cancel Reason Codes (WCNR).

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

ost_cancel_rsn_desc

alpha

30

The description of the cancel reason code used to cancel the order. Included only for the order cancellation email.

From CNR Description in the Cancel Reason table.

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

order_type

alpha

1

A code that indicates how the order was received.

Order types are defined in and validated against the Order Type table. Common order types include phone, web, and retail. You use order type to group orders on the system, monitor employee performance and accuracy, and control several functions. See Establishing Order Types (WOTY).

From the OTY Order Type in the Order Header table.

Available in: 8.0 (release 3.5 of Order Management System).

ost_ship_via_code

numeric

2

A code for the shipper to deliver this order to the customer. Included only if the ship via in the Order Ship To table is valid.

Ship via codes are defined in and validated against the Ship Via table; see Working with Ship Via Codes (WVIA). Additionally, ship via codes are validated against the SCF/Ship Via table, which ties together shippers and geographic locations; see Working with SCF/Ship Via Values (WSHV).

From Ship Via in the Order Ship To table.

Available in: 8.0 (release 3.5 of Order Management System).

ost_ship_via_desc

alpha

30

The name of the shipper. Included only if the ship via in the Order Ship To table is valid.

From Shipper Name in the Ship Via table.

Available in: 8.0 (release 3.5 of Order Management System).

ost_gift

alpha

1

Indicates whether the order is a gift order.

Y = The order is a gift order.

N = The order is not a gift order.

From OST Gift order in the Order Ship To table.

Available in: 8.0 (release 3.5 of Order Management System).

ost_total_nbr_recipients

numeric

3

The total number of ship to customers on the order.

From OHD # of Recipients in the Order Header table.

Available in: 8.0 (release 3.5 of Order Management System).

alternate_order_nbr

alpha

35

The number identifying the order in an external system, such as the e-commerce site or a POS system.

From the E-comm order number in the Order Header Extended table.

Available in: 8.0 (release 3.5.3 of Order Management System).

Note: This attribute is available beginning in the version 8.0 message introduced with release 3.5.3 of Order Management System, not the version 8.0 message introduced in release 3.5.

purchase_order_nbr

alpha

15

The purchase order number under which the order was placed.

From the Purchase order # in the Order Ship To table.

Order Broker? Originates from the ref_transaction_no if the order is a retail pickup or delivery order received from the Order Broker. See Building the Retail Pickup (including Ship-for-Pickup) or Delivery Order for more information.

Available in: 8.0 (release 3.5.3 of Order Management System).

Note: This attribute is available beginning in the version 8.0 message introduced with release 3.5.3 of Order Management System, not the version 8.0 message introduced in release 3.5.

OrderDetail

Included for the order confirmation, quote confirmation, order cancellation, order line cancellation, and store pickup messages.

odt_item

alpha

12

The code identifying the item that the customer ordered. See Performing Initial Item Entry (MITM) for a discussion of the following fields.

From ITM number in the Order Detail table.

odt_item_desc

alpha

40

The description of the item from the Item table.

From Description in the Item table.

odt_SKU

alpha

14

The item’s identifying characteristics, such as its color and size.

From SKU code in the Order Detail table.

odt_SKU_desc

alpha

40

The description of the SKU. if any, from the SKU table.

From Description in the SKU table.

odt_alias_item

alpha

12

An alternate item code you use to sell the item within a particular offer. See the Work with Alias Screen for a discussion. Included only if the customer ordered by this alias.

From Alias in the Order Detail table.

odt_item_class

alpha

3

The item class, if any, assigned to the item. Defined in and validated against the Item Class table, as set up through Working with Item Classes (WICL). See Performing Initial Item Entry (MITM) for a discussion of setting up items.

From Item class in the Item table.

odt_item_class_desc

alpha

30

The description of the item class, if any.

From ICL Description in the Item Class table.

odt_set_master

alpha

1

Indicates if the item is a set master.

Valid values are:

Y = This is a master item for a set (the Kit type is S)

N = This is not a set master item

See Working with Sets for more information.

From Set main item in the Order Detail table.

odt_set_component_seq

numeric

3

A sequence number that identifies a set master and its related component items. For example, the first set master and its component items have an odt_set_component_seq of 1; if there is an additional set on the order, the master and components have an odt_set_component_seq of 2.

From Set seq # in the Order Detail table.

odt_free_gift

alpha

1

Indicates if the system added the item to the order as a free gift, such as through a price table or source code.

Valid values are:

Y = The system added the item to the order as a free gift

N = The item was manually entered as a “no-charge” item

This flag is not included for priced items.

From ODT No charge in the Order Detail table.

odt_offer

alpha

3

The offer on the order detail line. See the Ofr at the Display Order Detail Screen (Reviewing Order Line Detail).

From Offer Number in the Order Detail table.

odt_offer_desc

alpha

30

The description of the offer on the order detail line.

From Offer Description in the Offer table.

odt_source

alpha

9

The source code assigned to the order line. A source code appears here only if:

• the Order Entry operator entered a source code at the line level, or

• the Use Source Code from Order Header When Creating Order Lines (D73) system control value is selected, or

• the Load Source from Mailing History (D20) system control value is selected and the offer entered on the detail line is not associated with the source code on the order header, and the system found an associated source code in the customer's mail history.

The source code at the line level controls demand and sales information/posting for that item, whereas the source code on the order controls how items are priced and freight is calculated.

From ODT SRC source code in the Order Detail table.

odt_source_desc

alpha

30

The description of the source code on the order detail line, if any.

From SRC Description in the Source table.

odt_price

numeric

7.2

The per-unit selling price of this item, after applying all discounts and repricing. This price reflects any coupon discount amount or dollar discount by offer or source if the Prorate Dollar Discounts and Coupons (D90) system control value is selected.

From ODT price in the Order Detail table.

odt_qty

numeric

5

The quantity ordered.

From ODT qty ordered in the Order Detail table.

odt_extended_price

numeric

11.2

The actual selling price * the order quantity.

odt_availability_msg

alpha

80

Indicates the item’s availability status. Possible messages are:

Exp date = This is a drop ship item. In this situation, an expected ship date (odt_expected_ship_date) is also indicated. Included only if the Assign Drop Ship Expected Ship Date (I59) system control value is selected.

Backordered = There is currently no on-hand inventory, or the order line is not reserved because it has a future arrival date. In this situation, an expected ship date (odt_expected_ship_date) is also indicated.

No longer available. = The item is sold out. Note: Soldout items are not included in the message if the Exclude S/O on order confirmation flag for the order type is selected.

In stock = For items you stock in inventory, this message indicates that there is an available quantity on-hand. This is also the status indicated for a set master, non-inventory item, or membership item. 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.

Store Pickup = The customer is picking up the order at a store location where the inventory is in stock.

Store Ship = The order line was backordered and has been assigned to the Order Broker for fulfillment (brokered backorder).

See the Order Broker Integration for more information of store pickup orders and brokered backorders.

 

 

 

The Status Message for E-Commerce Partial Reserved Lines (G52) system control value indicates whether to list partially reserved order lines as backordered or reserved, or to indicate the quantity backordered, reserved, or sold out. For example, the customer order 7 units, of which 4 are reserved and 3 are backordered. If the system control value is set to:

RESERVED: the availability message is In stock

BACKORDERED: the availability message is Backordered

PARTIAL: the availability message is 4 reserved, 3 B/O

See the Status Message for E-Commerce Partial Reserved Lines (G52) for more information.

odt_expected_ship_date

numeric

8

The next date when you expect to receive the item on a purchase order and have it available to fulfill orders. Included only for drop ship, brokered, and backordered items. See FTC -- # of Days for Items without Expected Ship Date (C71) and FTC -- # of Days to Add for Drop Ships (C68) for more information on how this date is calculated in different situations. YYYY-MM-DD format.

From ODT Expected ship date in the Order Detail table.

odt_seq_nbr

numeric

5

A unique number to identify the order line in the Order Detail table. Typically the same as the odt_line_nbr unless you delete an order line; in this case, the system assigns a new order line number to subsequent order lines, but retains the sequence number.

From Seq # in the Order Detail table.

odt_line_nbr

numeric

3

A unique number to identify the order line on the screen.

From Line # in the Order Detail table.

sku_country_of_origin

alpha

3

A code representing the country where the SKU originated.

From SKU Country of Origin in the SKU table.

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

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 Harmonize code in the SKU table.

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

odt_cancel_rsn

numeric

2

The cancel reason code used to cancel the order line. Included only for the order cancellation email or the order line cancellation email. If you cancel multiple units of the same order line during the same maintenance session but using different cancel reasons, this is the last cancel reason used.

Cancellation codes are defined in and validated against the Cancel Reason Code table; see Establishing Cancel Reason Codes (WCNR).

From CNR Cancel reason code in the Order Detail table.

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

odt_cancel_rsn_desc

alpha

30

The description of the cancel reason code used to cancel the order line. Included only for the order cancellation email or the order line cancellation email. Cancellation codes are defined in and validated against the Cancel Reason Code table; see Establishing Cancel Reason Codes (WCNR).

From CNR Description in the Cancel Reason table.

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

odt_qty_cancelled

numeric

5

The total quantity canceled during the current order maintenance session or other option, such as Working with Credit Card Cancellations (WCCC), that processed the cancellation; that is, not necessarily the total quantity canceled to date for the order line.

From ODT qty cancelled in the Order Detail table.

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

odt_image_url

alpha

256

The URL to the remote image defined for the item on the order.

From SKU Image Link in the SKU table; if a SKU Image Link is not defined, from ITM Image Link in the Item table.

Available in: 8.0 (release 3.5 of Order Management System).

odt_information_url

alpha

256

The URL to the remote item information defined for the item on the order.

From SKU Info Link in the SKU table; if a SKU Info Link is not defined, from ITM Info Link in the Item table.

Available in: 8.0 (release 3.5 of Order Management System).

odt_ship_via_code

numeric

2

A code for the shipper assigned to the order line.

From ODT VIA ship via code in the Order Detail table.

Available in: 8.0 (release 3.5 of Order Management System).

odt_ship_via_desc

alpha

30

The name of the shipper.

From VIA Shipper name in the Ship Via table.

Available in: 8.0 (release 3.5 of Order Management System).

odt_original_price

numeric

7.2

The original price on the order line.

From ODT Original price in the Order Detail table.

Available in: 8.0 (release 3.5 of Order Management System).

odt_gift_wrap

alpha

1

Indicates whether the item is gift wrapped.

Y = Gift wrap the item.

N = Do not gift wrap the item.

From Gift wrap in the Order Detail table.

Available in: 8.0 (release 3.5 of Order Management System).

odt_item_second_language_desc

alpha

40

The second language description defined for the item on the order line.

From ITM Second Language Desc in the Item table.

Available in: 8.0 (release 3.5 of Order Management System).

odt_sku_second_language_desc

alpha

40

The second language description defined for the SKU on the order line.

From SKU Second Language Desc in the SKU table.

Available in: 8.0 (release 3.5 of Order Management System).

odt_sku_element_1_desc

alpha

10

A description of the first SKU element for the SKU on the order line.

From SEO Desc in the SKU Element 1 table.

Available in: 8.0 (release 3.5 of Order Management System).

odt_sku_element_2_desc

alpha

10

A description of the second SKU element for the SKU on the order line.

From SEW Desc in the SKU Element 2 table.

Available in: 8.0 (release 3.5 of Order Management System).

odt_sku_element_3_desc

alpha

10

A description of the third SKU element for the SKU on the order line.

From SET Desc in the SKU Element 3 table.

Available in: 8.0 (release 3.5 of Order Management System).

odt_retail_reference_nbr

numeric

15

The retail reference or alternate SKU number.

From the Retail Ref # in the SKU table.

Available in: 10.0 (release 18.2 of Order Management System).

OrderSpecialFormat

The custom special handling defined for the order line and displayed on the Display Custom Special Handling Screen. For more information, see:

Special Handling Overview

Establishing Custom Special Handling Formats (WSHF) on how to set up special format detail

Working with Items on the Order on how to enter custom special handling information on an order

Included for the order confirmation, quote confirmation, order cancellation, order line cancellation, and store pickup messages.

Available in: 8.0 (release 3.5 of Order Management System).

osf_seq_nbr

numeric

5

The sequence number assigned to the order line associated with custom special handling.

From Seq # in the Order Special Format table.

Available in: 8.0 (release 3.5 of Order Management System).

osf_shf_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. See Special Handling Overview for more information.

From OSF SHF Code in the Order Special Format table.

Available in: 8.0 (release 3.5 of Order Management System).

osf_sfd_seq_nbr

numeric

3

The special handling format sequence number assigned to the order special format.

From OSF Seq # in the Order Special Format table.

Available in: 8.0 (release 3.5 of Order Management System).

osf_label

alpha

15

The special handling option defined for the custom special handling format; for example: thread color.

From the OSF Label in the Order Special Format table.

Available in: 8.0 (release 3.5 of Order Management System).

osf_input

alpha

45

The response selected for the special handling option in the custom special handling format; for example: black.

From the OSF Input in the Order Special Format table.

Available in: 8.0 (release 3.5 of Order Management System).

osf_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 in the Order Special Format table.

Available in: 8.0 (release 3.5 of Order Management System).

OrderPayments

Included only for order, shipment, and return confirmations.

order_payment_

count

numeric

2

The number of payment methods on the order.

Only active payment methods are included in the message. As a result, if you deactivate an order payment method (even if you have already charged it for a shipment) it is omitted from the message and not included in the order_payment_count.

OrderPayment

Included only for order, shipment, return, order cancellation, order line cancellation, and store pickup confirmations.

opm_payment_type

numeric

2

The numeric code identifying the pay type used on the order. Defined in and validated against the Pay Type table; see Working with Pay Types (WPAY).

From PAY Pay type in the Order Payment Method table.

opm_payment_type_desc

alpha

30

The description of the pay type, as set up through Working with Pay Types (WPAY).

From PAY Description in the Pay Type table.

opm_pay_plan

alpha

5

The code identifying the flexible payment method (deferred or installment billing) used on the order, if any. Set up through Working with Flexible Payment Options (WFPO); see Deferred/Installment Billing Overview for a discussion.

From OPM FPO Payment Code in the Order Payment Method table.

opm_pay_plan_desc

alpha

40

The description of the flexible payment method, as set up through Working with Flexible Payment Options (WFPO).

From FPO Description in the Flexible Payment Option table.

opm_deferral_days

numeric

3

The number of days to defer billing, if this is a deferred payment option that specifies a # of days for deferral rather than a Fixed deferral date.

From OPM # Days for Deferral in the Order Payment Method table.

opm_deferral_date

numeric

8

The date when billing will occur, if this is a deferred payment option that specifies a Fixed deferral date rather than a # of days for deferral. YYYY-MM-DD format.

From OPM Fix Date for Deferral in the Order Payment Method table.

opm_nbr_

installments

numeric

3

The total number of installments specified for the installment payment option.

From OPM # Of Installments in the Order Payment Method table.

opm_installment_

interval

numeric

3

The Interval, which identifies the number of days to wait between installments, specified for the installment payment option.

From OPM Installment Interval in the Order Payment Method table.

opm_credit_card

alpha

20

The credit card number used.

If you use credit card encryption, the system decrypts the credit card number before sending it to the external system. See Logging Credit Card Data Access in the Data Security and Encryption Guide for an overview.

All but the last four positions are replaced with asterisks (*). If the complete credit card number does not exceed four positions, none of it is replaced with asterisks. It is possible for the credit card number to be four positions or fewer if, for example, it is a “dummy” credit card, such as one you might use for orders you receive through the Amazon.com integration.

From OPM Credit card number in the Order Payment Method table.

opm_credit_card_

exp_date

numeric

4

The expiration date, if any, specified for the credit card. MM/YY format.

From OPM Expiration date in the Order Payment Method table.

Invoice

Included only for shipment and return confirmations. There is a separate confirmation message for each invoice number and ship-to on an order. As a result, there is a single Invoice element in each message.

The Consolidated Invoice (B49) system control value controls whether each shipment billed against an order on the same day is assigned to the same invoice number. See that system control value for a discussion.

If the invoice represents a credit for a return, dollar values are negative and are preceded by minus signs.

See the Display Invoice Header Screen for a general discussion of the fields in the Invoice Header table.

invoice_nbr

numeric

7

A unique number to identify the invoice.

From IHD Invoice # in the Invoice Ship To table.

invoice_ship_to

numeric

3

Identifies the order ship-to address associated with the invoice. Set to 1 if there is only one shipping address.

From Ship to # in the Invoice Ship To table.

ist_ship_date

numeric

8

The date the shipment or return was processed by the BILL_ASYNC job. YYYY-MM-DD format.

From INS Invoice date in the Invoice Ship To table.

ist_ship_merch

numeric

9.2

The total merchandise value of the shipment or return, excluding tax, freight, additional freight, or handling.

From INS Merchandise in the Invoice Ship To table.

ist_ship_tax

numeric

7.2

The total tax amount billed for the shipment or credited for the return. Includes GST and PST, if any. Tax rates vary by delivery location, and their calculation depends on the laws governing their application. The system stores tax rules in the System Control table, Customer table, SCF and other tax tables. This field does not include hidden tax.

From INS Tax in the Invoice Ship To table.

ist_ship_freight

numeric

7.2

The total freight amount billed for the shipment or credited for the return.

From INS Freight in the Invoice Ship To table.

ist_ship_addl_freight

numeric

7.2

The total dollar amount billed or credited for freight charges exceeding the order's base freight charge. This is a shipper-level charge directly associated with the order, as opposed to the line item. Additional freight is defined for the shipper in the Ship Via table.

Examples of additional freight charges that might apply include charges for overnight shipping, second day delivery, padded van, etc.

Additional freight charges might include the standard freight charges, depending on how you have set up the shipper. In this case, the Freight field will be blank.

The Add'l freight field in Order Inquiry corresponds to the Frt+ field in Order Entry.

From INS Add’l freight in the Invoice Ship To table.

ist_ship_hand

numeric

7.2

The cost of any special handling on the shipment or credited for the return, such as personalizing, monogramming, or engraving, and any gift wrapping charges. Any duty charges on the invoice are also included in this total.

From INS Handling in the Invoice Ship To table.

ist_ship_addl_charge

numeric

7.2

The total additional charges billed or credited. See the Add'l charges (Additional charges) field for a discussion.

From INS Add’l Charges in the Invoice Ship To table.

ist_ship_total_amt

numeric

9.2

The total merchandise, tax, freight, additional freight, handling, and additional charges billed or credited on the invoice.

ist_ship_status

alpha

25

The status of the shipment.

Included only if the Populate Ship Status for EmailOut XML (L61) system control value is selected.

Valid values:

Partial = Partial shipment. The OST Order status for the Order Ship To is:

- O Open.

- X Closed, but there are newer non-credit invoice records for the Order Ship To.

Complete = Complete shipment. The OST Order status for the Order Ship To is X Closed and this is the only invoice for the order, regardless of date.

Final = Final shipment. The OST Order status for the Order Ship To is X Closed and there are older invoice records for the Order Ship To, but no newer invoice records for the Order Ship To. Note: Order maintenance and item exchanges to previously closed orders will deliver the customer a second Final shipment confirmation status. This occurs because the originally closed order was opened again with the addition of the new order line.

See the Populate Ship Status for EmailOut XML (L61) system control value for examples.

Available in: 8.0 (version 3.5 of Order Management System).

ist_ship_discount

numeric

9.2

The discount amount applied to the lines for the invoice ship to, including decimals.

From the INS Discount amount in the Invoice Ship To table.

Available in: 8.0 (version 3.5 of Order Management System).

InvoiceDetail

Included only for shipment and return confirmations. There is a separate InvoiceDetail element for each item shipped or returned on the invoice.

If the invoice represents a credit for a return, dollar values and quantities are negative and are preceded by minus signs.

Note: If you credit an order by applying a negative additional charge rather than by processing a return, the InvoiceDetail is not included in the message. See Sample Return Notification XML Message: No Items for an example.

See the Second Display Invoice Detail Screen for a general discussion of the fields on the Invoice Detail table.

idt_order_dtl_seq_

nbr

numeric

5

A unique number identifying the order detail line for the item shipped or returned.

idt_line_nbr

numeric

3

A unique number identifying the Invoice Detail line for the item shipped or returned.

idt_item

alpha

12

The actual code identifying the item. If the customer ordered using an item alias, it is indicated in the idt_alias_item, below.

idt_item_desc

alpha

40

The description of the item from the Item table.

idt_SKU

alpha

14

The item’s unique characteristics, such as its color or size. Included only if the item has SKUs.

idt_SKU_desc

alpha

40

The description of the SKU from the SKU table.

idt_item_class

alpha

3

The item class, if any, assigned to the item. Defined in and validated against the Item Class table, as set up through Working with Item Classes (WICL). See Performing Initial Item Entry (MITM) for a discussion of setting up items.

idt_item_class_desc

alpha

30

The description of the item class.

idt_alias_item

alpha

12

An alternate item code you use to sell the item within a particular offer. See the Work with Alias Screen for a discussion. Included only if the customer ordered by this alias.

idt_ship_qty

numeric

5

The total quantity of the item shipped or returned on this invoice.

idt_price

numeric

7.2

The single-unit price charged or credited for the item on this invoice.

idt_extended_price

numeric

11.4

The total merchandise value charged or credited for the item on this invoice.

idt_image_url

alpha

256

The URL to the remote image defined for the item.

From SKU Image Link in the SKU table; if a SKU Image Link is not defined, from ITM Image Link in the Item table.

Available in: 8.0 (version 3.5 of Order Management System).

idt_information_url

alpha

256

The URL to the remote item information defined for the item.

From SKU Info Link in the SKU table; if a SKU Info Link is not defined, from ITM Info Link in the Item table.

Available in: 8.0 (version 3.5 of Order Management System).

idt_item_second_language_desc

alpha

40

The second language description defined for the item.

From ITM Second Language Desc in the Item table.

Available in: 8.0 (version 3.5 of Order Management System).

idt_sku_second_language_desc

alpha

40

The second language description defined for the SKU.

From SKU Second Language Desc in the SKU table.

Available in: 8.0 (version 3.5 of Order Management System).

idt_odt_qty

numeric

5

The quantity ordered on the associated order line.

From ODT Qty ordered in the Order Detail table.

Available in: 8.0 (version 3.5 of Order Management System).

InvoiceSpecialFormat

The custom special handling defined for the associated order line and displayed on the Display Custom Special Handling Screen. For more information, see:

Special Handling Overview

Establishing Custom Special Handling Formats (WSHF) on how to set up special format detail

Working with Items on the Order on how to enter custom special handling information on an order

Included only for shipment and return confirmations. There is a separate InvoiceSpecialFormat element for each item shipped or returned on the invoice that is associated with custom special handling.

Available in: 8.0 (release 3.5 of Order Management System).

idt_osf_seq_nbr

numeric

5

The sequence number assigned to the order line associated with custom special handling.

From Seq # in the Order Special Format table.

Available in: 8.0 (release 3.5 of Order Management System).

idt_osf_shf_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. See Special Handling Overview for more information.

From OSF SHF Code in the Order Special Format table.

Available in: 8.0 (release 3.5 of Order Management System).

idt_osf_sfd_seq_nbr

numeric

3

The special handling format sequence number assigned to the order special format.

From OSF Seq # in the Order Special Format table.

Available in: 8.0 (release 3.5 of Order Management System).

idt_osf_label

alpha

15

The special handling option defined for the custom special handling format; for example: thread color.

From the OSF Label in the Order Special Format table.

Available in: 8.0 (release 3.5 of Order Management System).

idt_osf_input

alpha

45

The response selected for the special handling option in the custom special handling format; for example: black.

From the OSF Input in the Order Special Format table.

Available in: 8.0 (release 3.5 of Order Management System).

idt_osf_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 in the Order Special Format table.

Available in: 8.0 (release 3.5 of Order Management System).

TrackingNumber

Included only for shipment confirmations. The information in this element is derived from PC manifesting, the generic pick in API, manual confirmation, or the Order Broker integration. See PC Manifesting Interface, Generic Pick In API (Shipments, Voids, and Backorders), Brokered Backorders, or Manually Confirming Shipments (MCON) for background.

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.

tracking_nbr

alpha

30

The shipment tracking number, if any, from the Manifest Upload Audit table, or from Order Transaction History if the shipment took place for a brokered backorder fulfilled through the Order Broker integration.

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.

tracking_ship_via

numeric

2

The ship via code, if any, from the Manifest Upload Audit table, or from Order Transaction History if the shipment took place for a brokered backorder fulfilled through the Order Broker integration. Included for brokered backorders only if the shipping agent passed from the Order Broker matches a valid ship via in Order Management System.

tracking_ship_via_

desc

alpha

30

The description of the ship via from the Ship Via table, or from Order Transaction History if the shipment took place for a brokered backorder fulfilled through the Order Broker integration. See Working with Ship Via Codes (WVIA) for a discussion.

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

tracking_ship_via_

type_desc

alpha

20

The description of the one-position or two-position ship via type:

U = UPS

FX = Federal Express

CT = CTC

PP = Parcel Post

P1 = Parcel Post Class 1

P2 = Parcel Post Class 2

P3 = Parcel Post Class 3

P4 = Parcel Post Class 4

DH = DHL

BOCardLine

Included only for backorder notifications.

Available in: 2.0 (release 1.1 of Order Management System).

bo_qty

numeric

5

The quantity of the item that is on backorder.

bo_expected_date

numeric

8

The date when you expect receipt of a purchase order that can be used to fulfill this order.

This date takes into account PO layering, in which items already backordered are filled first. This means that this date might not be from the next due purchase order.

The system updates this field using information from PO Receipts and the Evaluate Backorders programs.

If there are no outstanding purchase orders for this item, the date is calculated based on the FTC -- # of Days for Items without Expected Ship Date (C71).

bo_item

alpha

12

The code identifying the item that is backordered.

bo_item_desc

alpha

40

The description of the backordered item.

bo_SKU_desc

alpha

40

The description of the backordered SKU.

bo_SKU

alpha

14

The backordered item’s unique characteristics, such as its color and size. Included only if the item has SKU’s.

bo_image_url

alpha

256

The URL to the remote image defined for the item.

From SKU Image Link in the SKU table; if a SKU Image Link is not defined, from the ITM Image Link in the Item table.

Available in: 8.0 (version 3.5 of Order Management System).

bo_information_url

alpha

256

The URL to the remote item information defined for the item.

From SKU Info Link in the SKU table; if a SKU Info Link is not defined, from the ITM Info Link in the Item table.

Available in: 8.0 (version 3.5 of Order Management System).

bo_item_second_language_desc

alpha

40

The second language description defined for the item.

From ITM Second Language Desc in the Item table.

Available in: 8.0 (version 3.5 of Order Management System).

bo_sku_second_language_desc

alpha

40

The second language description defined for the SKU.

From SKU Second Language Desc in the SKU table.

Available in: 8.0 (version 3.5 of Order Management System).

bo_odt_qty

numeric

5

The quantity ordered on the order line.

From ODT Qty ordered in the Order Detail table.

Available in: 8.0 (version 3.5 of Order Management System).

bo_odt_seq_nbr

numeric

5

The order line sequence number for the item on backorder.

From Seq # in the Order Detail table.

Available in: 8.0 (version 3.5 of Order Management System).

BOCardOrderSpecialFormat

The custom special handling defined for the associated order line and displayed on the Display Custom Special Handling Screen. For more information, see:

Special Handling Overview

Establishing Custom Special Handling Formats (WSHF) on how to set up special format detail

Working with Items on the Order on how to enter custom special handling information on an order

Included only for backorder notifications. There is a separate BOCardOrderSpecialFormat element for each item on backorder that is associated with custom special handling.

Available in: 8.0 (release 3.5 of Order Management System).

bo_osf_seq_nbr

numeric

5

The sequence number assigned to the order line associated with custom special handling.

From Seq # in the Order Special Format table.

Available in: 8.0 (release 3.5 of Order Management System).

bo_osf_shf_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. See Special Handling Overview for more information.

From OSF SHF Code in the Order Special Format table.

Available in: 8.0 (release 3.5 of Order Management System).

bo_osf_sfd_seq_nbr

numeric

3

The special handling format sequence number assigned to the order special format.

From OSF Seq # in the Order Special Format table.

Available in: 8.0 (release 3.5 of Order Management System).

bo_osf_label

alpha

15

The special handling option defined for the custom special handling format; for example: thread color.

From the OSF Label in the Order Special Format table.

Available in: 8.0 (release 3.5 of Order Management System).

bo_osf_input

alpha

45

The response selected for the special handling option in the custom special handling format; for example: black.

From the OSF Input in the Order Special Format table.

Available in: 8.0 (release 3.5 of Order Management System).

bo_osf_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 in the Order Special Format table.

Available in: 8.0 (release 3.5 of Order Management System).

SoldoutLine

Included only for soldout notifications.

Available in: 3.0 (release 2.0 of Order Management System).

so_qty

numeric

5

The quantity sold out.

so_item

alpha

12

The code identifying the sold out item.

so_item_desc

alpha

40

The description of the sold out item.

so_SKU_desc

alpha

40

The description of the sold out SKU. Included only if the item has SKU’s.

so_SKU

alpha

14

The item’s unique characteristics, such as its color and size. Split into three 4-position fields.

so_image_url

alpha

256

The URL to the remote image defined for the item.

From SKU Image Link in the SKU table; if a SKU Image Link is not defined, from the ITM Image Link in the Item table.

Available in: 8.0 (version 3.5 of Order Management System).

so_information_url

alpha

256

The URL to the remote item information defined for the item.

From SKU Info Link in the SKU table; if a SKU Info Link is not defined, from the ITM Info Link in the Item table.

Available in: 8.0 (version 3.5 of Order Management System).

so_item_second_language_desc

alpha

40

The second language description defined for the item.

From ITM Second Language Desc in the Item table.

Available in: 8.0 (version 3.5 of Order Management System).

so_sku_second_language_desc

alpha

40

The second language description defined for the SKU.

From SKU Second Language Desc in the SKU table.

Available in: 8.0 (version 3.5 of Order Management System).

so_odt_qty

numeric

5

The quantity ordered on the order line.

From ODT Qty ordered in the Order Detail table.

Available in: 8.0 (version 3.5 of Order Management System).

so_odt_seq_nbr

numeric

5

The order line sequence number for the soldout item.

From Seq # in the Order Detail table.

Available in: 8.0 (version 3.5 of Order Management System).

SoldoutOrderSpecialFormat

The custom special handling defined for the associated order line and displayed on the Display Custom Special Handling Screen. For more information, see:

Special Handling Overview

Establishing Custom Special Handling Formats (WSHF) on how to set up special format detail

Working with Items on the Order on how to enter custom special handling information on an order

Included only for soldout notifications. There is a separate SoldoutOrderSpecialFormat element for each sold out item that is associated with custom special handling.

Available in: 8.0 (release 3.5 of Order Management System).

so_osf_seq_nbr

numeric

5

The sequence number assigned to the order line associated with custom special handling.

From Seq # in the Order Special Format table.

Available in: 8.0 (release 3.5 of Order Management System).

so_osf_shf_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. See Special Handling Overview for more information.

From OSF SHF Code in the Order Special Format table.

Available in: 8.0 (release 3.5 of Order Management System).

so_osf_sfd_seq_nbr

numeric

3

The special handling format sequence number assigned to the order special format.

From OSF Seq # in the Order Special Format table.

Available in: 8.0 (release 3.5 of Order Management System).

so_osf_label

alpha

15

The special handling option defined for the custom special handling format; for example: thread color.

From the OSF Label in the Order Special Format table.

Available in: 8.0 (release 3.5 of Order Management System).

so_osf_input

alpha

45

The response selected for the special handling option in the custom special handling format; for example: black.

From the OSF Input in the Order Special Format table.

Available in: 8.0 (release 3.5 of Order Management System).

so_osf_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 in the Order Special Format table.

Available in: 8.0 (release 3.5 of Order Management System).

StoredValueCard

Included only for stored value card notifications. See Stored Value Card Purchase and Activation for background.

Available in: 3.0 (release 2.0 of Order Management System).

svc_order_detail_seq_nbr

numeric

5

A unique number to identify the stored value card issued for an order detail line. If the quantity of the stored value card ordered on a single order detail line is 1, this number will be 1.

From SVC Sequence # in the Stored Value Card table.

svc_qty

numeric

5

The quantity of the stored value card. This number will always be 1.

svc_seq_nbr

numeric

5

A unique number to identify the order detail line for the stored value card.

Example: The customer ordered a quantity of 2 stored value cards on order line 3. When you activate the cards, the system generates 2 CWEmailOut messages. The first message provides the first stored value card number:

• svc_order_detail_seq_nbr: 3

• svc_qty: 1

• svc_seq_nbr: 1

The second message provides the second stored value card number:

• svc_order_detail_seq_nbr: 3

• svc_qty: 1

• svc_seq_nbr: 2

From Seq # in the Stored Value Card table.

svc_issue_date

numeric

8

The date when the stored value card item was billed.

From SVC Issue date in the Stored Value Card table.

svc_issue_amount

numeric

7.2

The value of the stored value card.

From SVC Issue amount in the Stored Value Card table.

svc_activation_date

numeric

8

The date you activated the stored value card. YYYY-MM-DD format.

From SVC Activation date in the Stored Value Card table.

svc_activation_time

numeric

6

The time you activated the stored value card. HH:MM:SS format.

From SVC Activation time in the Stored Value Card table.

svc_type

numeric

1

The type of stored value card. Valid values are:

V = virtual card

E = physical card, early notification

From SVC Card type in the Stored Value Card table.

svc_card_nbr

numeric

20

The card number assigned to the stored value card.

From SVC Card # in the Stored Value Card table.

svc_item

alpha

12

The item number identifying the type of stored value card.

From ITM Number in the Order Detail table.

svc_item_desc

alpha

40

The description of the stored value card.

From Description in the Item table.

svc_SKU

alpha

14

The stored value card item’s unique characteristics, such as color and style. Included only if the item has SKU’s.

From SKU Code in the Order Detail table.

svc_SKU_desc

alpha

40

The description of the SKU. Included only if the item has SKU’s.

From Description in the SKU table.

svc_message1

alpha

50

The notification can include up to four lines of gift messages. Only order message lines flagged to Print as Gift Msg are included.

From OLM Message in the Order Line Message table.

svc_message2

alpha

50

svc_message3

alpha

50

svc_message4

alpha

50

svc_id_nbr

numeric

9

The ID number assigned to the stored value card.

From SVC ID # in the Stored Value Card table.

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

CreditCardCredit

Included only for the credit card credit notifications.

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

ccc_refund_amt

numeric

9.2

The total amount that was credited to the customer credit card.

ccc_refund_date

numeric

8

The date the refund was processed. MMDDYYYY format.

CreditCardCreditLine

Included only for the credit card credit notification type. There is a separate CreditCardCreditLine element for each item on the order that was shipped and refunded.This element is not included for credits generated by applying a negative additional charge against the order rather than returning items.

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

ccc_item

alpha

12

The code identifying the item that was refunded.

ccc_item_desc

alpha

40

The description of the item that was refunded.

ccc_SKU_desc

alpha

40

The description of the SKU that was refunded. Included only if the item has SKU’s.

ccc_SKU

alpha

14

The SKU specifies the unique characteristics of the item such as color and size which was refunded.

OriginatingStore

Order Broker order? If the order is fulfilled through the Order Broker Integration:

retail pickup or delivery order: The broker_request_store identifies the store that originated the order, and the additional name and address information in the OriginatingStore element is from that store’s Store Cross Reference record.

store pickup or ship-for-pickup order: The broker_fulfill_store identifies the store where the customer picks up the order, and the additional name and address information in the OriginatingStore element is from that store’s Store Cross Reference record.

Note: For orders fulfilled through the Order Broker Integration, the information the OriginatingStore element is based on the Delivery type in the Order Ship To table; as a result, this element is not included for an order that includes brokered backordered lines.

Sales rep store? If the order is not fulfilled through the Order Broker integration as described above, and there is an Originating Store in the Order Header table, the sales_rep_store identifies that store, and the additional name and address information is from that store’s Store Cross Reference record. The Originating Store field is from:

• the sales_rep_store passed in the Inbound Order XML Message (CWORDERIN) or the Sales rep store entered at the Work with Order Ship To Properties screen, if any; otherwise,

• the Home store for the sales rep on the order, if that store’s Store Cross Reference record is flagged as Active.

Included for all notification types whenever the corresponding information is available for the order; as a result, never included for the Membership Cancellation.

Available in: 8.0 (version 3.5 of Order Management System).

Note: The broker_request_store and broker_fulfill_store attributes, as well as the logic to provide the name and address information for these stores, are available beginning in the version 8.0 message introduced with release 3.5.3 of Order Management System, not the version 8.0 message introduced in release 3.5.

sales_rep_store

alpha

10

The store code assigned to the order based on the salesrep on the order. Included only if the order is not a store pickup, ship-for-pickup, retail pickup, or delivery order. See above for more information.

Store codes are defined in and validated against the Store Cross Reference table; see Work with Store Cross Reference (WSCR).

Note: The store code defined for the order does not have to be associated with the salesrep defined on the Order Header.

From the Originating Store in the Order Header table. See the discussion above for more information.

Available in: 8.0 (version 3.5 of Order Management System).

sales_rep_email

alpha

50

The email address defined for the salesman on the order.

From the SLS EMail in the Salesman table.

Available in: 8.0 (version 3.5 of Order Management System).

sales_rep_name

alpha

30

The name of the salesman on the order.

From the SLS Name in the Salesman table.

Available in: 8.0 (version 3.5 of Order Management System).

sales_rep_phone

alpha

14

The phone number for the salesman on the order.

From the SLS Phone in the Salesman table.

Available in: 8.0 (version 3.5 of Order Management System).

store_phone

alpha

14

The phone number for the store on the order.

From the Telephone # in the Store Cross Reference table.

Available in: 8.0 (version 3.5 of Order Management System).

store_addr1

alpha

32

The street address for the store on the order.

From the Address Line 1 in the Store Cross Reference table.

Available in: 8.0 (version 3.5 of Order Management System).

store_addr2

alpha

32

The second address line for the store’s address.

From the Address Line 2 in the Store Cross Reference table.

Available in: 8.0 (version 3.5 of Order Management System).

store_addr3

alpha

32

The third address line for the store’s address.

From the Address Line 3 in the Store Cross Reference table.

Available in: 8.0 (version 3.5 of Order Management System).

store_addr4

alpha

32

The fourth address line for the store’s address.

From the Address Line 4 in the Store Cross Reference table.

Available in: 8.0 (version 3.5 of Order Management System).

store_city

alpha

25

The city for the store’s address.

From the City in the Store Cross Reference table.

Available in: 8.0 (version 3.5 of Order Management System).

store_state

alpha

2

The state code for the store’s address.

From the State in the Store Cross Reference table.

Available in: 8.0 (version 3.5 of Order Management System).

store_state_name

alpha

25

The state name.

From the STE Description in the State table.

Available in: 8.0 (version 3.5 of Order Management System).

store_postal

alpha

10

The postal code for the store’s address.

From the Postal Code in the Store Cross Reference table.

Available in: 8.0 (version 3.5 of Order Management System).

store_country

alpha

3

The country code for the store’s address.

From the Country in the Store Cross Reference table.

Available in: 8.0 (version 3.5 of Order Management System).

store_country_name

alpha

30

The country name.

From the Country description in the Country table.

Available in: 8.0 (version 3.5 of Order Management System).

originating_store_name

alpha

40

The name of the store.

From the Description in the Store Cross Reference table.

Available in: 8.0 (version 3.5 of Order Management System).

broker_request_store

alpha

10

The code identifying the store that placed a retail pickup or delivery order.

From the Fulfill location in the Order Broker table. Store codes are defined in and validated against the Store Cross Reference table; see Work with Store Cross Reference (WSCR).

When the broker_request_store identifies the originating store for a retail pickup or delivery order, the store’s name, phone number, and address are identified in additional attributes in the OriginatingStore element, described above.

Available in: 8.0 (release 3.5.3 of Order Management System).

Note: This attribute is available beginning in the version 8.0 message introduced with release 3.5.3 of Order Management System, not the version 8.0 message introduced in release 3.5.

broker_fulfill_store

alpha

10

The code identifying the store where the customer picks up a ship-for-pickup or store pickup order.

From the Store code in the Order Ship To Address table. Store codes are defined in and validated against the Store Cross Reference table; see Work with Store Cross Reference (WSCR).

When the broker_fulfill_store identifies the store where a customer picks up a ship-for-pickup or store pickup order, the store’s name and address are identified in additional attributes in the OriginatingStore element, described above.

Available in: 8.0 (release 3.5.3 of Order Management System).

Note: This attribute is available beginning in the version 8.0 message introduced with release 3.5.3 of Order Management System, not the version 8.0 message introduced in release 3.5.

LoyaltyCard

Included for the Oracle Retail Customer Engagement loyalty registration notification only.

Available in: 9.0 (release 4.5 of Order Management System).

loyalty_card_nbr

numeric

 

The loyalty card number assigned to the customer when Registering a Customer in the Customer Engagement Loyalty Program.

BeforeBodyTextLine

Included for all notification types. The text in this element and in the AfterBodyTextLine element comes from the entity associated with the order, if you have set up an email template for the entity; otherwise, it comes from the company. See Email Setup within Order Management System and Working with E-Mail Notification Templates (WEMT) for more information. In the case of the membership cancellation confirmation, the entity is derived from the Default source for the customer membership; in the case of loyalty memberships, there is no related entity, so these notifications always use the company-level template. See Membership Cancellations for a discussion.

before_line_msg

alpha

60

The contents of the Text to print above items for the email notification template. You can specify up to ten lines of text.

From EMT Template Line 1-10 in the E-Mail Template table.

AfterBodyTextLine

Included for all notification types.

after_line_msg

alpha

60

The contents of the Text to print below items for the email notification template. You can specify up to three lines of text.

From EMT Template After Line 1-3 in the E-Mail Template table.

CS17b_01 OMSCS 19.0 December 2019 OHC