Structure and content of order messages

The following fields from an order must be included in each message related to the order:

TB.Order Message
ITEMS > ITEM > TB_ID MESSAGE > TB_ORDER_ITEM_ID The TB_ORDER_ITEM_ID is only required in a message if the message concerns items of the order, this means dispatch, cancellation and return messages. Order-related messages, such as payment, shipment or service cost deductions as well as alterations of the payment state of an order don’t need the reference of a TB_ORDER_ITEM_ID.

The reported quantities (SHIP, DIFF, RETURN) must be interpreted as additions. Thus, each partial delivery represents a new message with the according quantity and is separately sent for the concerned order item. The complete item state is not repeated. Example: Overall order quantity of an order item (ORDER/ ITEMS/ ITEM/ QUANTITY) = 10. If the delivery takes place in two packages with each 5 pieces, this is done in two messages of the type SHIP with a QUANTITY = 5 each.

Please regard the representation of the fields regarding mandatory fields/nodes! In screenshots, solid borders indicate mandatory values, broken lines indicate optional values. Within the chapters, the indication of mandatory/optional only refers to the appropriate node and not to the complete XSD. Example: The "IDCODE" in Order messages – MESSAGE is shown as solid line and is thus mandatory. The next higher level is indicated as optional by means of the dashed line. The result from this is: if you provide a shipping number within a message, the included "IDCODE" is mandatory, whilst the proposal for a return shipping code ("IDCODE_RETURN_PROPOSAL") is in any case optional. The indication of the complete "MESSAGE” node with a dashed line results from the fact that messages are part of the TB.Order scheme. As this also includes the orders, not every TB.Order-conform XML file must be a message.

Elements of messages