Articles in this section

cXML Order Integration - Change Orders

Justin Gillion
  • Updated

Identifying change orders within the order integration

Change orders can be setup in 2 ways within Unimarket:

  1. Unimarket can issue a new number when an order is changed; or
  2. Unimarket can issue the same number with an order version number

Using new numbers

If the configuration is set to use a new order number each time an order is edited, then the following sequence of events will occur:

  1. Order is created. An order integration message is sent with a new order number and the Type of 'NEW'
  2. Order is then edited by the user.
  3. A second order integration message is sent with the original order number, and the Type of 'DELETE' 
  4. A third order integration message follows with a new order number, and the Type of 'NEW'
<OrderRequest>
    <OrderRequestHeader orderDate="2023-04-06T14:33:37.680+12:00"
                        orderID="1004891"
                        orderType="regular"
                        type="delete">
 <OrderRequest>
     <OrderRequestHeader orderDate="2023-04-06T14:35:19.707+12:00"
                         orderID="1004892"
                         orderType="regular"
                         type="new">

The message details of the replacement order provides extrinsic details that link the replacement order back to the originating (edited) order via the order-source-type and the order-source-identifier (order number of the edited order).

</Extrinsic>
<Extrinsic name="shippingNote"/>
<Extrinsic name="order-submission">ELECTRONIC</Extrinsic>
<Extrinsic name="requisition-created-date">2023-04-06T14:34:20.000+12:00</Extrinsic>
<Extrinsic name="organization">Unimarket eProcurement</Extrinsic>
<Extrinsic name="organization-unit">Information Technology</Extrinsic>
<Extrinsic name="requisition-justification"/>
<Extrinsic name="is-retrofit-order">no</Extrinsic>
<Extrinsic name="order-source-type">EDIT_ORDER</Extrinsic>
<Extrinsic name="order-source-identifier">1004891</Extrinsic>
<Extrinsic name="requisition-source-type">EDIT_ORDER</Extrinsic>

 

Using order versions

If the configuration is set to use a new order version each time an order is edited, then the following sequence of events will occur:

  1. Order is created. An order integration message is sent with a new order number and the Type of 'NEW'
  2. Order is then edited by the user.
  3. A second order integration message is sent with the original order number, and the Type of 'UPDATE'. This will also contain a version number.
<OrderRequest>
        <OrderRequestHeader orderDate="2023-03-09T16:54:51.281+10:00"
                            orderID="100024"
                            orderType="regular"
                            type="new">

After the order is changed:

<OrderRequest>
       <OrderRequestHeader isInternalVersion="no"
                           orderDate="2023-03-09T16:55:38.672+10:00"
                           orderID="100024"
                           orderType="regular"
                           orderVersion="2"
                           type="update">

 

 

 

Related articles