Skip to content

Choco Order Notification XML

This XML format represents order notifications in Choco.

Tasks

Minimal XML Sample

The XML below represents the minimum information that needs to be provided to notify an order in Choco.

<?xml version="1.0"?>
<OrderNotifications>
  <OrderNotification>
    <ActionId>123acc8f-2227-4b14-a96a-215e2e83e0f8</ActionId>
    <Status>Succeeded</Status>
  </OrderNotification>
</OrderNotifications>

Successful Order Notification

When an order has been successfully processed, you should send a 'Succeeded' order notification to Choco. The following information can be provided:

XML Field   Example  Field Type  Input   Description
ZynkExternalId 12345 string Optional Used in conjunction with the Prevent Reprocessing setting. Max 255 chars
ActionId 123acc8f-2227-4b14-a96a-215e2e83e0f8 guid Required The ID of the action associated with the order. This can be found at Order/Action/ActionId in the output from the Export New Orders from Choco task
Status Succeeded enum Required Set to Succeeded 
<?xml version="1.0"?>
<OrderNotifications>
  <OrderNotification>
    <ZynkExternalId>12345</ZynkExternalId>
    <ActionId>123acc8f-2227-4b14-a96a-215e2e83e0f8</ActionId>
    <Status>Succeeded</Status>
  </OrderNotification>
</OrderNotifications>

Failed Order Notification

When an order has encountered an error and was not successfully processed, you should send a 'Failed' order notification to Choco. The following information can be provided:

XML Field   Example  Field Type  Input   Description
ZynkExternalId 12345 string Optional Used in conjunction with the Prevent Reprocessing setting. Max 255 chars
ActionId 123acc8f-2227-4b14-a96a-215e2e83e0f8 guid Required The ID of the action associated with the order. This can be found at Order/Action/ActionId in the output from the Export New Orders from Choco task
Status Failed enum Required Set to Failed
ErrorCode InvalidProductCode string Optional A machine readable error code
Message Product code 'R35D' does not exist string Optional A human readable description of the error 
<?xml version="1.0"?>
<OrderNotifications>
  <OrderNotification>
    <ZynkExternalId>12345</ZynkExternalId>
    <ActionId>123acc8f-2227-4b14-a96a-215e2e83e0f8</ActionId>
    <Status>Failed</Status>
    <ErrorCode>InvalidProductCode</ErrorCode>
    <Message>Product code 'R35D' does not exist</Message>
  </OrderNotification>
</OrderNotifications>

Skipped Order Notification

When you want to ignore an order and simply remove it from the queue, you should send a 'Skipped' order notification to Choco. The following information can be provided:

XML Field   Example  Field Type  Input   Description
ZynkExternalId 12345 string Optional Used in conjunction with the Prevent Reprocessing setting. Max 255 chars
ActionId 123acc8f-2227-4b14-a96a-215e2e83e0f8 guid Required The ID of the action associated with the order. This can be found at Order/Action/ActionId in the output from the Export New Orders from Choco task
Status Skipped enum Required Set to Skipped
SkipReasonCode OldOrder string Optional A machine readable skip reason code
Message The order is more than 90 days old string Optional A human readable description of the reason why the order was skipped 
<?xml version="1.0"?>
<OrderNotifications>
  <OrderNotification>
    <ZynkExternalId>12345</ZynkExternalId>
    <ActionId>123acc8f-2227-4b14-a96a-215e2e83e0f8</ActionId>
    <Status>Skipped</Status>
    <SkipReasonCode>OldOrder</SkipReasonCode>
    <Message>The order is more than 90 days old</Message>
  </OrderNotification>
</OrderNotifications>

Complete XML Sample

This sample shows all data that can be provided via our order notification XML format.

<?xml version="1.0"?>
<OrderNotifications>
  <OrderNotification>
    <ZynkExternalId>12345</ZynkExternalId>
    <ActionId>123acc8f-2227-4b14-a96a-215e2e83e0f8</ActionId>
    <Status>Succeeded</Status>
  </OrderNotification>
  <OrderNotification>
    <ZynkExternalId>23456</ZynkExternalId>
    <ActionId>9f7c506b-727f-4694-acdd-26cabdfa74f7</ActionId>
    <Status>Failed</Status>
    <ErrorCode>InvalidProductCode</ErrorCode>
    <Message>Product code 'R35D' does not exist</Message>
  </OrderNotification>
  <OrderNotification>
    <ZynkExternalId>34567</ZynkExternalId>
    <ActionId>538b0c8f-2227-4b14-a96a-215e2e83a287</ActionId>
    <Status>Skipped</Status>
    <SkipReasonCode>OldOrder</SkipReasonCode>
    <Message>The order is more than 90 days old</Message>
  </OrderNotification>
</OrderNotifications>