Order Acknowledgement XML Message (CWORDEROUT) | Contents | SCVs | Search | Glossary | Reports | Solutions | XML | Index | Order Creation Errors |
Order Reject Request Message (CWORDERREJECT)
Message structure: There is not a separate DTD or schema for the reject message. This message is based on the same structure as the Inbound Order XML Message (CWORDERIN); however, it is not necessary to include any tags besides those listed below. See the Order Reject Request Message: Sample below for an example.
When the message does include additional tags beyond those listed below, the order API returns an Invalid XML Message error if any of the additional information is invalid.
For more information: See Rejecting the Order (Order API) for background.
Message Attribute |
Alpha/ numeric |
Positions |
Comments |
Message |
|||
source |
alphanumeric |
|
Identifies the source of the XML message. |
target |
alphanumeric |
|
Identifies the target of the XML message. |
type |
alphanumeric |
|
Must be set to CWORDERREJECT. Note: Not case-sensitive. For example, a setting of CWOrderReject is also acceptable. |
Header |
|||
company_code |
numeric |
3 |
Identifies the company for the order. Validated against the Company table. Padding with zeroes (for example, 005) is optional. Required. |
Identifying the Order: The reject message must specify either an order_number or rdc_order_nbr identifying an existing order in the company indicated. The order must be in error and not have a payment method. If the message includes both the order_number and the rdc_order_nbr, they should both point to the same order. Multi-recipient order? If the reject message specifies a multi-recipient order, the system cancels all recipients. |
|||
order_number |
alphanumeric |
30 |
The E-commerce order number in the Order Header Extended table and in the E-Commerce Order Reference table. From the order_number passed in the Inbound Order XML Message (CWORDERIN). |
rdc_order_nbr |
numeric |
9 |
The order number assigned by CWSerenade. |
Order Reject Request Message: Sample
The following sample includes all of the tags that could potentially be used to identify an order for rejection. The message can specify the order_number, rdc_order_nbr, or both, in addition to the company number.
<Message source="String" target="String" type="CWORDERREJECT" >
<Header company_code="6" order_number="1010mu123" rdc_order_nbr="10851" >
</Header>
</Message>
Order Reject Response Message: Samples
The order API returns a response such as one of the following examples provided the Order Reject Request Message (CWORDERREJECT) if the reject request message was valid, such as the sample above.
If the order rejection is successful, the response passed is:
<Message>PASS</Message>
Otherwise, if the order rejection is unsuccessful, the response passed is:
<Message>FAIL</Message>
A rejection is unsuccessful if the request message did not specify an existing order that is currently in error status without a payment method.
Order Acknowledgement XML Message (CWORDEROUT) | Contents | SCVs | Search | Glossary | Reports | Solutions | XML | Index | Order Creation Errors |
GO01_01x OROMS 5.0 2018 OTN