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

Note:             If you use the Narvar Integration, Narvar generates shipment confirmation emails to the customer based on an order request message sent through billing, and the shipment confirmation is not generated through the process described above.

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

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

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

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

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

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

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

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

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

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

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

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

currency_code

alpha

3

The currency code associated with the order. This tag is populated only when:

•         The outbound version for the CWEmailOut message is set to 11.0 or higher.

•         The Order element is included (the message is related to an order).

•         The currency_code is set to:

•         The currency from the Order Header Extended record, if any. The Order Header Extended specifies a currency only if you use alternate currency pricing (see system control value H89) or multi-currency by offer (see system control value E03).

•         Otherwise, if you do not use alternate currency pricing or multi-currency by offer, the currency_code is from the Local Currency Code (A55) system control value.

Available in: 11.0 (release 18.2.2 or 19.2 of Order Management System).

Note:  Do not enable version 11.0 of the CWEmailOut message unless integrating systems are prepared for this new attribute.

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

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

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

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

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

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

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

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

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

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

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

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

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

idtLineNbr

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

13.2

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

idt_extended_price

numeric

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

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

 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

OrderShipmentLineDetail

Included only for shipment confirmations. Most of the tags in the element are the same as those in the InvoiceDetail element.

The data in this element is populated through the CWPickIn message, CWManifestIn message, manual confirmation (MCON), and the Order Broker order inquiry status response message, indicating the order was shipped (fulfilled status).

Available in: 11.0 (release 18.2.2 or 19.2 of Order Management System).

Note:  Do not enable version 11.0 of the CWEmailOut message unless integrating systems are prepared to receive this new element.

idt_order_dtl_seq_nbr

numeric

3

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

idt_line_nbr

numeric

3

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

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. Included only if the item has SKUs.

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.

ship_qty

numeric

5

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

idt_price

numeric

13.2

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

idt_image_url

alpha

256

The URL to the remote image defined for the item, if any.

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

idt_information_url

alpha

256

The URL to the remote item information defined for the item, if any.

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

idt_item_second_language_desc

alpha

40

The second language description defined for the item, if any.

From ITM Second Language Desc in the Item table.

idt_sku_second_language_desc

alpha

40

The second language description defined for the SKU, if any.

From SKU Second Language Desc in the SKU table.

idt_odt_qty

numeric

5

The quantity ordered on the associated order line.

From ODT Qty ordered in the Order Detail table.

ship_date

numeric

8

The date the shipment was processed by the BILL_ASYNC job, if it was shipped through Order Management System.

YYYY-MM-DD format.

If shipped through Order Broker: If:

•         The OROB_MESSAGE_VERSION property (PROP) is set to 19.0 or higher, and

•         The order line has been fulfilled through Order Broker, and

•         The fulfilling system passed its own shipment date as the status_date when it submitted the fulfillment status update to Order Broker,

This is the date when the fulfilling location shipped the order line, as passed in the shipment_date tag in the status request response message from Order Broker.

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

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

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

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

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