Promotional Pricing Request Message (CWPromotionalRequest)

Promotional Pricing Request Message (CWPromotionalRequest)

The Promotional Pricing job, started through Working with Integration Layer Processes (IJCT), receives CWPromotionalRequest messages from the web storefront to determine if any promotional pricing is eligible for the order being created on the web storefront.

The main purposes of this job:

• determine if any promotional pricing is eligible for the order on the web storefront.

• send the Promotional Pricing Response Message (CWPromotionalResponse) to the web storefront, indicating the promotions that can be applied to the order.

Note: The CWPromotionalRequest message is used to apply promotional pricing to orders on the web storefront. CWDirect may receive the order from the web storefront in the E-Commerce New Order Message (CWCreateOrder) or Inbound Order XML Message (CWORDERIN).

E-Commerce: The CWPromotionalRequest message is available for XML only.

For more information: See:

• E-Commerce Promotional Pricing

• Promotional Pricing Messages: Sample XMLs

• XML Messages for a table that provides links to the DTD, schema, and a sample XML layout for each XML message.

Attribute Name	Type	Length	Comments
Message One Message element is required.
source	alpha		Identifies the source of the message. IDC indicates the XML message is from the web storefront. Required.
target	alpha		Identifies the target of the message. RDC indicates the XML message is sent to CWDirect. Required.
type	alpha		Identifies the type of information in the XML message. CWPROMOTIONALREQUEST indicates the message contains promotional pricing information. Required.
PromotionalHeader One Header element is required.
company_code	numeric	3	The CWDirect company code associated with the promotional request. Maps to the Company field in the Promotion Pricing file. Must be a valid company code. Required.
external_reference_nbr	numeric	8	Web assigned reference number. You can use either the external_reference_nbr in the request or the associated MQ message ID to correlate the message request to the message response. Required.
source_code	alpha	9	The source code associated with the promotional request. The source_code is used to determine if there are any valid promotions for this source code. Also used to determine the offer for offer pricing. Maps to the Source code field in the Promotion Pricing file. Either source_code or offer_id is required, but both can be sent.
offer_id	alpha	3	The offer associated with the promotional request. The offer_id is used to determine if there are any valid promotions for this offer code. Also used to determine the offer price and item number if alias is passed. Maps to the Offer number field in the Promotion Pricing file. Either source_code or offer_id is required, but both can be sent. The offer_id is also required if alias is sent.
merch_total	numeric	9.2	Used to determine if any promotions exist when ordering items whose sum equals or is greater than this dollar amount. This should be an accumulative dollar amount of all items on the order. Required for order/dollar promotions.
PromotionalItem The PromotionalItems element, if provided, can include one or more PromotionalItem elements.
item_id	alpha	12	The item number from the web storefront. Used to determine if any promotions exist when ordering this item. Maps to the Required purchase ITM num field in the Promotion Pricing file. Either item_id and sku, short_sku, or alias_item is required.
sku	alpha	14	The SKU code for the item, if any, from the web storefront. Used to determine if any promotions exist when ordering this SKU. Either item_id and sku, short_sku, or alias_item is required.
short_sku_number	numeric	7	The short SKU code defined for the item on the web storefront. Used to determine the item and SKU. Ignored if the item_id is provided, even if the item_id is invalid.
line_offer_id	alpha	3	The offer associated with the item on the order. The offer_id is used to determine if there are any valid promotions for this offer code. Also used to determine the offer price and item number if alias is passed. Maps to the Offer number field in the Promotion Pricing file. Required if alias is sent.
alias_item	alpha	12	The alias code defined for the item in the specified offer. If the alias_item is populated, the offer_id or line_offer_id must be populated. Used to determine the item and SKU. Ignored if the item_id or short_sku is provided, even if the value is invalid.
order_quantity	numeric	5	The quantity of the item being ordered on the web storefront. Used to determine if any promotions exist when ordering this quantity of the item/SKU. Required.

Promotional Pricing Response Message (CWPromotionalResponse)

The Promotional Pricing job, started through Working with Integration Layer Processes (IJCT), sends a CWPromotionalResponse message to the web storefront indicating the promotional pricing eligible for the order, based on the information received in the Promotional Pricing Request Message (CWPromotionalRequest).

E-Commerce: The CWPromotionalResponse message is available for XML only.

For more information: See:

• E-Commerce Promotional Pricing

• Available Discounts and Promotions

• Promotional Pricing Messages: Sample XMLs

• XML Messages for a table that provides links to the DTD, schema, and a sample XML layout for each XML message.

Attribute Name	Type	Length	Comments
Message One Message element is required.
source	alpha		Identifies the source of the message. CWDIRECT indicates the XML message is from the web storefront. Required.
target	alpha		Identifies the target of the message. WEB indicates the XML message is sent to the web storefront. Required.
type	alpha		Identifies the type of information in the message. CWPromotionalResponse indicates the message contains a promotional response.
date_created	numeric	8	Identifies the date when the message was created, in YYYY-MM-DD format.
time_created	numeric	6	Identifies the time when the message was created, in HH:MM:SS format.
Header One Header element is required.
company_code	numeric	3	The company code associated with the promotions in the response. From the Company field in the Promotion Pricing file.
external_reference_nbr	numeric	8	The reference number assigned by the web storefront and sent in the Promotional Pricing Request Message (CWPromotionalRequest).
errors	alpha	1	Indicates if any errors occurred while determining if any eligible promotions exist for the web order, based on the information passed in the Promotional Pricing Request Message (CWPromotionalRequest). N = No errors exist; the promotions eligible for the web order are included in the CWPromotionalResponse message. Y = Errors exist; the number of eligible promotions for the web order is 0.
nbr_eligible_ promotions	numeric	3	The number of eligible promotions for the information included in the Promotional Pricing Request Message (CWPromotionalRequest). 0 displays if there are no eligible promotions for the web order; all other tags in the CWPromotionalResponse message will be blank.
Promotion One or more Promotion elements can be included in the message.
promotion_id	alpha	5	The promotion ID for the promotion eligible to apply to the web order. From the PRP Promotion ID field in the Promotion Pricing file.
qualifying_source	alpha	9	The source code the customer used on the web order to be eligible for the promotion. Either qualifying_source or qualifying_offer will be populated, but not both. From the Source code field in the Promotion Pricing file.
qualifying_offer	alpha	3	The offer code the customer used on the web order to be eligible for the promotion. Either qualifying_source or qualifying_offer will be populated, but not both. From the Offer number field in the Promotion Pricing file.
qualifying_dollars	numeric	11.2	The merchandise total that the customer must order on the web order to be eligible for the promotion. Only applies to O (order/dollar type promotions). From the PRP dollars required field in the Promotion Pricing file.
qualifying_qty	numeric	5	The order quantity (from the required item or items within the required group) that the customer must order on the web order to be eligible for an incentive item or incentive group. Only applies to I (item) or G (group) type promotions. This is not the sum of the quantities sent in the Promotional Pricing Request Message (CWPromotionalRequest). From the PRP Qty required field in the Promotion Pricing file.
incentive_type	alpha	1	Defines whether a specific item or a group of items is used as an incentive. Valid values: G = Group; the item(s) associated with the incentive group are included in the CWPromotionalResponse sent back to the web storefront. I = Item; the item is included in the CWPromotionalResponse sent back to the web storefront. From the PRP Type of incentive field in the Promotion Pricing file.
qty_eligible	numeric	5	The maximum order quantity allowed for an incentive item or item(s) from an incentive group. From the PRP Qty limit field in the Promotion Pricing file.
incentive_discount_pct	numeric	5.2	The percentage by which the offer price of the item will be discounted. Only the incentive_discount_pct, incentive_discount_dollars, or no_charge tag will be populated. None of these tags will be populated if an incentive price has been defined. From the PRP Incentive Disc Percnt field in the Promotion Pricing file.
incentive_discount_dollars	numeric	7.2	The dollar amount that will be subtracted from the offer price. Only the incentive_discount_pct, incentive_discount_dollars, or no_charge tag will be populated. None of these tags will be populated if an incentive price has been defined. From the PRP Incentive Disc Dollar field in the Promotion Pricing file.
no_charge	alpha	1	Indicates whether to charge for an incentive item or item(s) from an incentive group. Valid values: Y = The customer is receiving incentive items free of charge. blank = The customer is receiving incentive items for the specified price. From the No charge? field in the Promotion Pricing file.
QualifyingItem One or more QualifyingItem elements can be included in the message.
qualifying_item_id	alpha	12	The item(s) the customer ordered that made the web order eligible for the promotion. The response only includes the items from the Promotional Pricing Request Message (CWPromotionalRequest) that made the web order eligible for the promotion. All items within the qualifying group are not included in the response message. • From the Incentive ITM Number field in the Promotion Pricing file, OR • From the ITM Number field in the Group Code Detail file.
qualifying_item_ desc	alpha	40	A description of the qualifying item. From the Description field in the Item file.
qualifying_sku	alpha	14	The SKU(s) the customer ordered that made the web order eligible for the promotion. The response only includes the SKUs from the Promotional Pricing Request Message (CWPromotionalRequest) that made the web order eligible for the promotion. All SKUs within the qualifying group are not included in the response message. • From the Incentive SKU Code field in the Promotion Pricing file, OR • From the SKU Code field in the Group Code Detail file.
qualifying_sku_desc	alpha	40	A description of the qualifying SKU. From the Description field in the SKU file.
qualifying_short_ sku	numeric	7	The short SKU of the item the customer ordered that made the web order eligible for the promotion. From the Short SKU field in the SKU file.
qualifying_alias_ item	alpha	12	The alias of the item the customer ordered that made the web order eligible for the promotion. This field is only populated if the alias exists for the offer that was passed in the Promotional Pricing Request Message (CWPromotionalRequest). From the Alias item field in the Page Letter Alias file.
IncentiveItem One or more Incentive Item elements can be included in the message.
incentive_item_id	alpha	12	The incentive item that the customer is eligible to receive. If the item is a SKU’d item, all SKUs for the item are included in the response message. • From the Incentive ITM Number field in the Promotion Pricing file, OR • From the ITM Number field in the Group Code Detail file.
incentive_item_desc	alpha	40	A description of the incentive item. From the Description field in the Item file.
incentive_sku	alpha	14	The incentive SKU the customer is eligible to receive. If the item is a SKU’d item, all SKUs for the item are included in the response message. • From the Incentive SKU Code field in the Promotion Pricing file, OR • From the SKU Code field in the Group Code Detail file.
incentive_sku_desc	alpha	40	A description of the incentive SKU. From the Description field in the SKU file.
incentive_short_sku	numeric	7	The short SKU of the item that the customer is eligible to receive. From the Short SKU field in the SKU file.
incentive_alias_item	alpha	12	The alias of the item that the customer is eligible to receive. This field is only populated if the alias exists for the offer that was passed in the Promotional Pricing Request Message (CWPromotionalRequest). From the Alias item field in the Page Letter Alias file.
incentive_price	numeric	7.2	The incentive price for the item. This field remains blank if an incentive price has not been defined and the SKU price and offer price cannot be determined. Note: The tax inclusive price cannot be used because the tax status is not known. • From the PRP Incentive price field in the Promotion Pricing file, OR • Calculated by subtracting the discount percentage or discount dollars from the offer price.
offer_price	numeric	7.2	The offer price for the item. This field remains blank if a SKU offer price and offer price have not been defined. Note: The tax inclusive price cannot be used because the tax status is not known. • From the Price field in the SKU Price file, OR • From the Price field in the Item Price file.