Skip to main content
Markdown

Delivery Notes

openTRANS 2.1​

File extension: .xml
File name: <ID>.xml

Workist delivers delivery notes in the openTRANS 2.1 format ORDERRESPONSE. For delivery notes you are the buyer: the document comes from your supplier and refers to your order.

The format has a fixed structure. Your channel's field selection does not change it. Prices and per-line delivery dates are not included. The delivery note number is in SUPPLIER_ORDER_ID, the delivery note date in ORDERRESPONSE_DATE. With Use short external file name the file gets a short ID instead of a UUID; the other options of the output file configuration have no effect for delivery notes.

Every line needs a quantity that can be read as a number, otherwise Workist creates no file.

Full example​

<?xml version="1.0" encoding="utf-8"?>
<ORDERRESPONSE xmlns:bmecat="http://www.bmecat.org/bmecat/2005" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.1" xmlns="http://www.opentrans.org/XMLSchema/2.1" xsi:schemaLocation="http://www.opentrans.org/XMLSchema/2.1 opentrans_2_1.xsd">
  <ORDERRESPONSE_HEADER>
    <CONTROL_INFO>
      <GENERATOR_INFO>Workist</GENERATOR_INFO>
      <GENERATION_DATE>2025-03-15T14:30:25.123456</GENERATION_DATE>
    </CONTROL_INFO>
    <ORDERRESPONSE_INFO>
      <ORDER_ID>PO-2025-0001</ORDER_ID>
      <ORDERRESPONSE_DATE>2025-03-20</ORDERRESPONSE_DATE>
      <SUPPLIER_ORDER_ID>DN-2025-300</SUPPLIER_ORDER_ID>
      <DELIVERY_DATE>
        <DELIVERY_START_DATE>2025-03-20</DELIVERY_START_DATE>
        <DELIVERY_END_DATE>2025-03-20</DELIVERY_END_DATE>
      </DELIVERY_DATE>
      <PARTIES>
        <PARTY>
          <bmecat:PARTY_ID type="party_specific">workist</bmecat:PARTY_ID>
          <PARTY_ROLE>document_creator</PARTY_ROLE>
        </PARTY>
        <PARTY>
          <bmecat:PARTY_ID type="party_specific">K-1001</bmecat:PARTY_ID>
          <PARTY_ROLE>buyer</PARTY_ROLE>
        </PARTY>
        <PARTY>
          <bmecat:PARTY_ID>SUP-500</bmecat:PARTY_ID>
          <PARTY_ROLE>supplier</PARTY_ROLE>
          <ADDRESS>
            <bmecat:NAME>Best Supplier GmbH</bmecat:NAME>
            <bmecat:STREET>Lieferantenweg 10</bmecat:STREET>
            <bmecat:ZIP>20095</bmecat:ZIP>
            <bmecat:CITY>Hamburg</bmecat:CITY>
            <bmecat:COUNTRY>DE</bmecat:COUNTRY>
            <bmecat:COUNTRY_SUBDIVISION>HH</bmecat:COUNTRY_SUBDIVISION>
          </ADDRESS>
        </PARTY>
        <PARTY>
          <bmecat:PARTY_ID>WH-01</bmecat:PARTY_ID>
          <PARTY_ROLE>delivery</PARTY_ROLE>
          <ADDRESS>
            <bmecat:NAME>Acme Corporation GmbH</bmecat:NAME>
            <bmecat:NAME2>Goods Receipt</bmecat:NAME2>
            <bmecat:STREET>Lager Strasse 5</bmecat:STREET>
            <bmecat:ZIP>20095</bmecat:ZIP>
            <bmecat:CITY>Hamburg</bmecat:CITY>
            <bmecat:COUNTRY>DE</bmecat:COUNTRY>
            <bmecat:COUNTRY_SUBDIVISION>HH</bmecat:COUNTRY_SUBDIVISION>
          </ADDRESS>
        </PARTY>
      </PARTIES>
      <ORDER_PARTIES_REFERENCE>
        <bmecat:BUYER_IDREF>K-1001</bmecat:BUYER_IDREF>
        <bmecat:SUPPLIER_IDREF>SUP-500</bmecat:SUPPLIER_IDREF>
      </ORDER_PARTIES_REFERENCE>
    </ORDERRESPONSE_INFO>
  </ORDERRESPONSE_HEADER>
  <ORDERRESPONSE_ITEM_LIST>
    <ORDERRESPONSE_ITEM>
      <LINE_ITEM_ID>10</LINE_ITEM_ID>
      <PRODUCT_ID>
        <bmecat:SUPPLIER_PID type="supplier_specific">SUP-ART-777</bmecat:SUPPLIER_PID>
        <bmecat:INTERNATIONAL_PID>4006381333931</bmecat:INTERNATIONAL_PID>
        <bmecat:BUYER_PID>ART-001-A</bmecat:BUYER_PID>
        <bmecat:DESCRIPTION_LONG>Industrial Sensor Module Type A</bmecat:DESCRIPTION_LONG>
      </PRODUCT_ID>
      <QUANTITY>100.0</QUANTITY>
      <bmecat:ORDER_UNIT>PCE</bmecat:ORDER_UNIT>
    </ORDERRESPONSE_ITEM>
  </ORDERRESPONSE_ITEM_LIST>
  <ORDERRESPONSE_SUMMARY>
    <TOTAL_ITEM_NUM>1</TOTAL_ITEM_NUM>
  </ORDERRESPONSE_SUMMARY>
</ORDERRESPONSE>

Elements​

ElementContent
CONTROL_INFOGENERATOR_INFO = Workist, GENERATION_DATE = creation time (UTC).
ORDERRESPONSE_INFOORDER_ID = your order number the delivery note refers to; ORDERRESPONSE_DATE = delivery note date; SUPPLIER_ORDER_ID = delivery note number (if any).
DELIVERY_DATEOnly with a delivery date: DELIVERY_START_DATE and DELIVERY_END_DATE = delivery date.
PARTY document_creatorWorkist as creator: PARTY_ID = workist (type = party_specific), PARTY_ROLE = document_creator.
PARTY buyerYou as the buyer: PARTY_ID (type = party_specific) = customer number of the buyer (you or your branch), otherwise buyer; PARTY_ROLE = buyer. No address.
PARTY supplierSupplier, if recognised: PARTY_ID = supplier number from your master data, PARTY_ROLE = supplier; NAME, STREET, ZIP, CITY, COUNTRY (country code), COUNTRY_SUBDIVISION.
PARTY deliveryDelivery address: PARTY_ID = address number, PARTY_ROLE = delivery; NAME = company, NAME2 = name, STREET, ZIP, CITY, COUNTRY (country code), COUNTRY_SUBDIVISION.
ORDER_PARTIES_REFERENCEBUYER_IDREF = PARTY_ID of the buyer, SUPPLIER_IDREF = supplier number.
ORDERRESPONSE_ITEMOne per line: LINE_ITEM_ID = line number, QUANTITY = quantity with a decimal point (e.g. 100.0), ORDER_UNIT = unit of measure.
PRODUCT_IDSUPPLIER_PID (type = supplier_specific) = the supplier's article number as on the document; INTERNATIONAL_PID = third article number from your master data (article_id3, e.g. EAN); BUYER_PID = your article number (article_id1); DESCRIPTION_LONG = article description.
ORDERRESPONSE_SUMMARYTOTAL_ITEM_NUM = number of lines.