Orders
The following output formats are supported for orders.
Workist XML
Supported document type: Orders
File extension: .xml
The Workist XML format for orders is a structured XML file divided into three main sections: general header information, address/shipping details, and line items.
Full Example
<?xml version="1.0" encoding="UTF-8"?>
<Order_v1>
<General>
<!-- Customer information -->
<Sell_to_Customer>
<Customer_Number>CUST-12345</Customer_Number>
<Name>Acme Corporation</Name>
<Contact_Number>CP-001</Contact_Number>
<Contact>Max Mustermann</Contact>
<Contact_Email>max@acme.de</Contact_Email>
<Contact_Phone>+49 89 12345678</Contact_Phone>
<Country>DE</Country>
<Country_Code>DE</Country_Code>
<Customer_Type>regular</Customer_Type>
</Sell_to_Customer>
<!-- Order details -->
<Order_Date>2025-03-15</Order_Date>
<VAT_Registration_Number>DE123456789</VAT_Registration_Number>
<Customer_Order_Number>PO-2025-0001</Customer_Order_Number>
<Quote_Reference_Number>QT-2025-100</Quote_Reference_Number>
<Project_Number>PRJ-500</Project_Number>
<Distribution_Channel>10</Distribution_Channel>
<Order_Type>standard</Order_Type>
<Delivery_Terms>DDP</Delivery_Terms>
<Shipping_Terms>express</Shipping_Terms>
<Payment_Terms>net 30</Payment_Terms>
<Total_Amount_Net>1250.00</Total_Amount_Net>
<Total_Amount>1487.50</Total_Amount>
<Framework_Contract_Number>FC-2025-200</Framework_Contract_Number>
<Info_Text>Please deliver to loading dock B.</Info_Text>
<Info_Text>Handle with care - fragile items.</Info_Text>
<Commission_Number>COM-999</Commission_Number>
<Incoterm>DAP</Incoterm>
<Delivery_Unload_Method>forklift</Delivery_Unload_Method>
<Goods_Receiving_Time>08:00-16:00</Goods_Receiving_Time>
<External_Document_Link>a1b2c3d4.pdf</External_Document_Link>
<Workist_URL>https://app.workist.com/orders/12345</Workist_URL>
<Received_By>inbox@customer.com</Received_By>
<ERP_Locked>false</ERP_Locked>
<!-- Attached files (if configured) -->
<Additional_Files>
<Additional_File>
<File_Name>a1b2c3d4_original.pdf</File_Name>
<Classification>original_document</Classification>
<File_Name_Original>order_scan.pdf</File_Name_Original>
</Additional_File>
</Additional_Files>
</General>
<!-- Billing address -->
<Invoicing>
<Bill_to_Customer>
<Code>BILL-001</Code>
<Name>Acme Corp Billing Dept</Name>
<Additional_Name_Info>Acme Corporation GmbH</Additional_Name_Info>
<Address>Billing Strasse 10</Address>
<Additional_Address_Info>Building C, 3rd Floor</Additional_Address_Info>
<City>Munich</City>
<Post_Code>80331</Post_Code>
<Country>DE</Country>
<Country_Code>DE</Country_Code>
<Phone>+49 89 11111111</Phone>
<Email>billing@acme.de</Email>
</Bill_to_Customer>
</Invoicing>
<!-- Delivery address and shipping details -->
<Shipping>
<Ship_to_Customer>
<Code>SHIP-002</Code>
<Name>Acme Warehouse</Name>
<Additional_Name_Info>Acme Corporation GmbH</Additional_Name_Info>
<Address>Lager Strasse 5</Address>
<Additional_Address_Info>Gate 3</Additional_Address_Info>
<City>Hamburg</City>
<Post_Code>20095</Post_Code>
<Country>DE</Country>
<Country_Code>DE</Country_Code>
<Phone>+49 40 22222222</Phone>
<Email>warehouse@acme.de</Email>
</Ship_to_Customer>
<Expected_Delivery_Date>2025-04-01</Expected_Delivery_Date>
<Expected_Delivery_Time_From>08:00</Expected_Delivery_Time_From>
<Expected_Delivery_Time_Until>16:00</Expected_Delivery_Time_Until>
<Goods_Issue_Date>2025-03-28</Goods_Issue_Date>
</Shipping>
<!-- Line items -->
<Line>
<Batch_Number>LOT-2025-A</Batch_Number>
<Description>Industrial Sensor Module Type A</Description>
<Unit_of_Measure>PCE</Unit_of_Measure>
<Quantity>100</Quantity>
<Unit_Price>12.50</Unit_Price>
<Price_Unit>1</Price_Unit>
<Total_Price>1250.00</Total_Price>
<Line_Discount_Percent>5.0</Line_Discount_Percent>
<Line_Discount_Amount>62.50</Line_Discount_Amount>
<Item_Variant>blue</Item_Variant>
<Common_Item_Number>ART-001-A</Common_Item_Number>
<Common_Item_Number_2>GTIN-12345</Common_Item_Number_2>
<Common_Item_Number_3>EAN-67890</Common_Item_Number_3>
<Customer_Item_Number>CUST-ART-555</Customer_Item_Number>
<Item_Number_Confidence>0,95</Item_Number_Confidence>
<Expected_Delivery_Date>2025-04-01</Expected_Delivery_Date>
<Goods_Issue_Date>2025-03-28</Goods_Issue_Date>
<Commission_Number>COM-LINE-01</Commission_Number>
<Sales_Organisation>1000</Sales_Organisation>
<Framework_Contract_Number>FC-2025-200</Framework_Contract_Number>
<Quote_Reference_Number>QT-2025-100</Quote_Reference_Number>
<Pos>10</Pos>
<Container_Quantity>10</Container_Quantity>
<Container_Type>box</Container_Type>
<Order_Number>SUB-ORD-001</Order_Number>
<Currency>EUR</Currency>
</Line>
</Order_v1>
Header Fields
| XML Element | Type | Description |
|---|---|---|
Sell_to_Customer | Block | Customer information incl. number, name, country and type |
| Contact fields | Block | Contact number, name, email and phone (inside Sell_to_Customer) |
Order_Date | Date | Order date in YYYY-MM-DD format |
VAT_Registration_Number | Text | VAT identification number |
Customer_Order_Number | Text | Customer's purchase order number |
Quote_Reference_Number | Text | Reference to an associated quotation |
Project_Number | Text | Project identifier |
Distribution_Channel | Text | Sales channel or sales organisation |
Order_Type | Text | Order type (e.g. standard, rush order) |
Delivery_Terms | Text | Delivery terms (e.g. DDP, FCA) |
Shipping_Terms | Text | Shipping method |
Payment_Terms | Text | Payment terms |
Total_Amount_Net | Decimal | Net total amount |
Total_Amount | Decimal | Gross total amount |
Framework_Contract_Number | Text | Framework contract reference |
Info_Text | Text | Free-text notes (up to 5 blocks of 70 characters each) |
Commission_Number | Text | Commission reference |
Incoterm | Text | Incoterm code |
Delivery_Unload_Method | Text | Unloading method at the destination |
Goods_Receiving_Time | Text | Permitted time window for goods receipt |
External_Document_Link | Text | File name of the attached original PDF |
Workist_URL | Text | Direct link to the record in the Workist platform |
Received_By | Text | Email address that originally received the document |
ERP_Locked | Boolean | Whether the order is locked in the ERP |
Billing and Delivery Address Fields
| XML Element | Type | Description |
|---|---|---|
Code | Text | Address identifier / code |
Name | Text | Contact person or recipient name |
Additional_Name_Info | Text | Company or additional name |
Address | Text | Street address with house number |
Additional_Address_Info | Text | Additional address details (building, floor, etc.) |
City | Text | City |
Post_Code | Text | Postal code |
Country | Text | Country code (ISO 3166-1 alpha-2, e.g. DE) |
Country_Subdivision | Text | State or region code (e.g. BY, HH) |
Phone | Text | Phone number |
Email | Text | Email address |
Shipping Fields
| XML Element | Type | Description |
|---|---|---|
Expected_Delivery_Date | Date | Requested delivery date |
Expected_Delivery_End_Date | Date | End of delivery window |
Expected_Delivery_Time_From | Text | Start of delivery time window (HH:MM) |
Expected_Delivery_Time_Until | Text | End of delivery time window (HH:MM) |
Goods_Issue_Date | Date | Goods issue date / dispatch date |
Line Item Fields
| XML Element | Type | Description |
|---|---|---|
Pos | Text | Line item number |
Description | Text | Product description |
Common_Item_Number | Text | Primary article number (supplier) |
Common_Item_Number_2 | Text | Secondary article number |
Common_Item_Number_3 | Text | Tertiary article number (e.g. EAN/GTIN) |
Customer_Item_Number | Text | Customer's own article number |
Item_Number_Confidence | Decimal | Confidence score for automatic article number assignment |
Quantity | Decimal | Order quantity |
Unit_of_Measure | Text | Unit of measure (e.g. PCE, KG, M) |
Unit_Price | Decimal | Price per unit |
Price_Unit | Decimal | Price unit basis (1, 10, 100 or 1000) |
Total_Price | Decimal | Line item total price |
Line_Discount_Percent | Text | Discount percentage |
Line_Discount_Amount | Text | Discount amount |
Item_Variant | Text | Product variant |
Batch_Number | Text | Batch or lot number |
Expected_Delivery_Date | Date | Delivery date at line item level |
Goods_Issue_Date | Date | Goods issue date at line item level |
Commission_Number | Text | Commission reference at line item level |
Sales_Organisation | Text | Sales organisation |
Framework_Contract_Number | Text | Framework contract reference at line item level |
Quote_Reference_Number | Text | Quotation reference at line item level |
Container_Quantity | Decimal | Converted container quantity |
Container_Type | Text | Container type |
Order_Number | Text | Sub-order number at line item level |
Currency | Text | Currency code at line item level (e.g. EUR) |
SAP IDoc ORDERS05
Supported document types: Orders, Requests for Quotation
File extension: .xml
The SAP IDoc ORDERS05 format is designed for direct integration with SAP systems. It uses a segment-based structure with a control record (EDI_DC40), followed by data segments for the order header, dates, business partners and line items.
Full Example
<?xml version="1.0" encoding="UTF-8"?>
<ORDERS05>
<IDOC BEGIN="1">
<!-- Control record -->
<EDI_DC40 SEGMENT="1">
<TABNAM>EDI_DC40</TABNAM>
<MANDT>050</MANDT>
<DOCNUM>0000000000000001</DOCNUM>
<STATUS>30</STATUS>
<DIRECT>2</DIRECT>
<IDOCTYP>ORDERS05</IDOCTYP>
<MESTYP>ORDERS</MESTYP>
<SNDPOR>WORKIST</SNDPOR>
<SNDPRT>LS</SNDPRT>
<SNDPRN>WORKIST</SNDPRN>
<RCVPOR>XML_WKI</RCVPOR>
<RCVPRT>LS</RCVPRT>
<RCVPRN>SUPPLIER</RCVPRN>
<CREDAT>20250315</CREDAT>
<CRETIM>143025</CRETIM>
</EDI_DC40>
<!-- Order header -->
<E1EDK01 SEGMENT="1">
<ACTION>000</ACTION>
<BELNR>PO-2025-0001</BELNR>
<RECIPNT_NO>SUPPLIER</RECIPNT_NO>
</E1EDK01>
<!-- Order date -->
<E1EDK03 SEGMENT="1">
<IDDAT>012</IDDAT>
<DATUM>20250315</DATUM>
</E1EDK03>
<!-- Delivery date -->
<E1EDK03 SEGMENT="1">
<IDDAT>002</IDDAT>
<DATUM>20250401</DATUM>
</E1EDK03>
<!-- Ordering party -->
<E1EDKA1 SEGMENT="1">
<PARVW>AG</PARVW>
<PARTN>CUST-12345</PARTN>
</E1EDKA1>
<!-- Contact person -->
<E1EDKA1 SEGMENT="1">
<PARVW>Z1</PARVW>
<PARTN>CP-001</PARTN>
<NAME1>Max Mustermann</NAME1>
<TELF1>+49 89 12345678</TELF1>
<TELBX>max@acme.de</TELBX>
</E1EDKA1>
<!-- Delivery address -->
<E1EDKA1 SEGMENT="1">
<PARVW>WE</PARVW>
<PARTN>SHIP-002</PARTN>
<NAME1>Acme Warehouse</NAME1>
<STRAS>Lager Strasse 5</STRAS>
<ORT01>Hamburg</ORT01>
<PSTLZ>20095</PSTLZ>
<LAND1>DE</LAND1>
</E1EDKA1>
<!-- Billing address -->
<E1EDKA1 SEGMENT="1">
<PARVW>RE</PARVW>
<PARTN>BILL-001</PARTN>
<NAME1>Acme Corp Billing</NAME1>
<STRAS>Billing Strasse 10</STRAS>
<ORT01>Munich</ORT01>
<PSTLZ>80331</PSTLZ>
<LAND1>DE</LAND1>
</E1EDKA1>
<!-- Order reference -->
<E1EDK02 SEGMENT="1">
<QUALF>001</QUALF>
<BELNR>PO-2025-0001</BELNR>
<DATUM>20250315</DATUM>
</E1EDK02>
<!-- Line item -->
<E1EDP01 SEGMENT="1">
<POSEX>0</POSEX>
<ACTION>001</ACTION>
<MENGE>100</MENGE>
<MENEE>PCE</MENEE>
<E1EDP03 SEGMENT="1">
<IDDAT>002</IDDAT>
<DATUM>20250401</DATUM>
<UZEIT>000000</UZEIT>
</E1EDP03>
<E1EDP19 SEGMENT="1">
<QUALF>002</QUALF>
<IDTNR>ART-001-A</IDTNR>
</E1EDP19>
</E1EDP01>
</IDOC>
</ORDERS05>
Configuration Options
| Parameter | Default | Max. Length | Description |
|---|---|---|---|
MANDT | 050 | 3 | SAP client number |
SNDPOR | WORKIST | 10 | Sender port |
SNDPRT | LS | 2 | Sender partner type |
SNDPRN | WORKIST | 10 | Sender partner number |
RCVPOR | XML_WKI | 10 | Receiver port |
RCVPRT | LS | 2 | Receiver partner type |
RCVPRN | SUPPLIER | 10 | Receiver partner number |
RECIPNT_NO | SUPPLIER | 10 | Recipient number in the order header |
Partner Role Codes
| Code | Role | Description |
|---|---|---|
AG | Ordering party | The ordering customer |
Z1 | Contact | Contact person at the ordering party |
WE | Goods recipient | Delivery address |
RE | Invoice recipient | Billing / invoice address |
Field Length Limits
| Field | Max. Characters |
|---|---|
| Name fields (NAME1, NAME2) | 35 |
| Street (STRAS) | 35 |
| City (ORT01) | 35 |
| Postal code (PSTLZ) | 9 |
| Country (LAND1) | 3 |
| Partner number (PARTN) | 17 |
| Order number (BELNR) | 35 |
| Article number (IDTNR) | 35 |
OpenTRANS 2.1
Supported document type: Orders
File extension: .xml
The OpenTrans 2.1 format follows the official OpenTrans standard for electronic order exchange. It uses a partner-based model where business partners are defined in a PARTIES section and referenced throughout the document.
Full Example
<?xml version="1.0" encoding="UTF-8"?>
<ORDER version="2.1"
xmlns="http://www.opentrans.org/XMLSchema/2.1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:bmecat="http://www.bmecat.org/bmecat/2005"
xsi:schemaLocation="http://www.opentrans.org/XMLSchema/2.1 opentrans_2_1.xsd"
type="standard">
<ORDER_HEADER>
<CONTROL_INFO>
<GENERATOR_INFO>Workist</GENERATOR_INFO>
<GENERATION_DATE>2025-03-15T14:30:25</GENERATION_DATE>
</CONTROL_INFO>
<SOURCING_INFO>
<QUOTATION_ID>QT-2025-100</QUOTATION_ID>
<AGREEMENT>
<bmecat:AGREEMENT_ID>PRJ-500</bmecat:AGREEMENT_ID>
<bmecat:AGREEMENT_END_DATE>2025-03-15T14:30:25</bmecat:AGREEMENT_END_DATE>
</AGREEMENT>
</SOURCING_INFO>
<ORDER_INFO>
<ORDER_ID>PO-2025-0001</ORDER_ID>
<ORDER_DATE>2025-03-15</ORDER_DATE>
<DELIVERY_DATE>
<DELIVERY_START_DATE>2025-04-01</DELIVERY_START_DATE>
<DELIVERY_END_DATE>2025-04-05</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">supplier</bmecat:PARTY_ID>
<PARTY_ROLE>supplier</PARTY_ROLE>
</PARTY>
<PARTY>
<bmecat:PARTY_ID>CUST-12345</bmecat:PARTY_ID>
<PARTY_ROLE>buyer</PARTY_ROLE>
<ADDRESS>
<bmecat:NAME>Acme Corporation</bmecat:NAME>
<CONTACT_DETAILS>
<bmecat:CONTACT_ID>CP-001</bmecat:CONTACT_ID>
<bmecat:CONTACT_NAME>Mustermann</bmecat:CONTACT_NAME>
<bmecat:FIRST_NAME>Max</bmecat:FIRST_NAME>
<bmecat:PHONE>+49 89 12345678</bmecat:PHONE>
<bmecat:EMAILS>
<bmecat:EMAIL>max@acme.de</bmecat:EMAIL>
</bmecat:EMAILS>
</CONTACT_DETAILS>
<bmecat:STREET>Hauptstrasse 42</bmecat:STREET>
<bmecat:ZIP>80331</bmecat:ZIP>
<bmecat:CITY>Munich</bmecat:CITY>
<bmecat:COUNTRY_CODED>DE</bmecat:COUNTRY_CODED>
</ADDRESS>
</PARTY>
<PARTY>
<bmecat:PARTY_ID>SHIP-002</bmecat:PARTY_ID>
<PARTY_ROLE>delivery</PARTY_ROLE>
<ADDRESS>
<bmecat:NAME>Acme Warehouse</bmecat:NAME>
<bmecat:STREET>Lager Strasse 5</bmecat:STREET>
<bmecat:ZIP>20095</bmecat:ZIP>
<bmecat:CITY>Hamburg</bmecat:CITY>
<bmecat:COUNTRY_CODED>DE</bmecat:COUNTRY_CODED>
</ADDRESS>
</PARTY>
<PARTY>
<bmecat:PARTY_ID>BILL-001</bmecat:PARTY_ID>
<PARTY_ROLE>invoice_recipient</PARTY_ROLE>
<ADDRESS>
<bmecat:NAME>Acme Corp Billing</bmecat:NAME>
<bmecat:STREET>Billing Strasse 10</bmecat:STREET>
<bmecat:ZIP>80331</bmecat:ZIP>
<bmecat:CITY>Munich</bmecat:CITY>
<bmecat:COUNTRY_CODED>DE</bmecat:COUNTRY_CODED>
</ADDRESS>
</PARTY>
</PARTIES>
<ORDER_PARTIES_REFERENCE>
<bmecat:BUYER_IDREF>CUST-12345</bmecat:BUYER_IDREF>
<bmecat:SUPPLIER_IDREF>supplier</bmecat:SUPPLIER_IDREF>
<INVOICE_RECIPIENT_IDREF>BILL-001</INVOICE_RECIPIENT_IDREF>
<SHIPMENT_PARTIES_REFERENCE>
<DELIVERY_IDREF>SHIP-002</DELIVERY_IDREF>
</SHIPMENT_PARTIES_REFERENCE>
</ORDER_PARTIES_REFERENCE>
<bmecat:CURRENCY>EUR</bmecat:CURRENCY>
</ORDER_INFO>
</ORDER_HEADER>
<ORDER_ITEM_LIST>
<ORDER_ITEM>
<LINE_ITEM_ID>10</LINE_ITEM_ID>
<PRODUCT_ID>
<bmecat:SUPPLIER_PID type="supplier_specific">ART-001-A</bmecat:SUPPLIER_PID>
<bmecat:BUYER_PID>CUST-ART-555</bmecat:BUYER_PID>
<bmecat:DESCRIPTION_LONG>Industrial Sensor Module Type A</bmecat:DESCRIPTION_LONG>
</PRODUCT_ID>
<QUANTITY>100</QUANTITY>
<bmecat:ORDER_UNIT>PCE</bmecat:ORDER_UNIT>
<DELIVERY_DATE>
<DELIVERY_START_DATE>2025-04-01</DELIVERY_START_DATE>
<DELIVERY_END_DATE>2025-04-01</DELIVERY_END_DATE>
</DELIVERY_DATE>
</ORDER_ITEM>
</ORDER_ITEM_LIST>
<ORDER_SUMMARY>
<TOTAL_ITEM_NUM>1</TOTAL_ITEM_NUM>
</ORDER_SUMMARY>
</ORDER>
Partner Roles
| Role | Description |
|---|---|
document_creator | The system that created the document (Workist) |
supplier | The supplier receiving the order |
buyer | The ordering customer, incl. contact details |
delivery | Delivery / shipping address |
invoice_recipient | Billing / invoice address |
cXML OrderRequest
Supported document type: Orders
File extension: .xml
The cXML format (Commerce XML) follows the cXML standard for procurement. It includes a header with sender/receiver credentials, an order request with addresses, and line items with pricing.
Full Example
<?xml version="1.0" encoding="UTF-8"?>
<cXML payloadID="record-12345" timestamp="2025-03-15T14:30:25">
<Header>
<From>
<Credential domain="SystemId">CUST-12345</Credential>
</From>
<To>
<Credential domain="SystemId">supplier</Credential>
</To>
<Sender>
<Credential domain="SystemId">workist</Credential>
<UserAgent>Workist Platform</UserAgent>
</Sender>
</Header>
<Request deploymentMode="production">
<OrderRequest deploymentMode="production">
<OrderRequestHeader orderDate="2025-03-15"
orderID="PO-2025-0001"
orderType="regular"
orderVersion="1"
type="new">
<Total>
<Money currency="EUR">1250.00</Money>
</Total>
<ShipTo>
<Address addressID="SHIP-002" isoCountryCode="DE">
<Name xml:lang="de">Acme Warehouse</Name>
<PostalAddress>
<DeliverTo>Contact Person Name</DeliverTo>
<Street>Lager Strasse 5</Street>
<City>Hamburg</City>
<State>HH</State>
<PostalCode>20095</PostalCode>
<Country isoCountryCode="DE">DE</Country>
</PostalAddress>
<Email>warehouse@acme.de</Email>
</Address>
</ShipTo>
<BillTo>
<Address addressID="CUST-12345" isoCountryCode="DE">
<Name xml:lang="de">Acme Corp GmbH</Name>
<PostalAddress>
<DeliverTo>Finance Department</DeliverTo>
<Street>Hauptstrasse 42</Street>
<City>Munich</City>
<State>BY</State>
<PostalCode>80331</PostalCode>
<Country isoCountryCode="DE">DE</Country>
</PostalAddress>
</Address>
<IdReference domain="buyerID" identifier="CUST-12345"/>
</BillTo>
<Contact role="buyerCorporate">
<Name xml:lang="de">Max Mustermann</Name>
</Contact>
</OrderRequestHeader>
</OrderRequest>
</Request>
<ItemOut lineNumber="10" quantity="100">
<ItemID>
<SupplierPartID>ART-001-A</SupplierPartID>
</ItemID>
<ItemDetail>
<UnitPrice>
<Money currency="EUR">12.50</Money>
</UnitPrice>
<Description xml:lang="de">Industrial Sensor Module Type A</Description>
<UnitOfMeasure>PCE</UnitOfMeasure>
</ItemDetail>
<ScheduleLine lineNumber="10" quantity="100" requestedDeliveryDate="2025-04-01T00:00:00+00:00">
<UnitOfMeasure>PCE</UnitOfMeasure>
</ScheduleLine>
</ItemOut>
</cXML>
Configuration Options
| Parameter | Default | Description |
|---|---|---|
| Receiver ID | supplier | Identity of the receiving system in the To credential |
| Deployment mode | production | Set to test for test environments |
EDX SalesHeader
Supported document type: Orders
File extension: .xml
The EDX format uses a SalesHeader/SalesLine structure embedded in an EDXTransmission envelope.
note
The exact fields in this format are configured according to your specific integration requirements. Please contact your Workist representative for details about your EDX configuration.
Full Example
<?xml version="1.0" encoding="UTF-8"?>
<EDXTransmission>
<Order_Doc>
<Sales_Header>
<!-- Header fields vary depending on integration setup -->
<Shipping>
<Code>SHIP-002</Code>
<Name>Acme Warehouse</Name>
<Address>Lager Strasse 5</Address>
<City>Hamburg</City>
<Post_Code>20095</Post_Code>
<Country>DE</Country>
</Shipping>
<Billing>
<Code>BILL-001</Code>
<Name>Billing Department</Name>
<Address>Billing Strasse 10</Address>
<City>Munich</City>
<Post_Code>80331</Post_Code>
<Country>DE</Country>
</Billing>
<Sales_Line>
<Document_No>PO-2025-0001</Document_No>
<Line_No>1000</Line_No>
<EDXLine_No>1000</EDXLine_No>
<!-- Article number, description, quantity, unit, unit price -->
</Sales_Line>
</Sales_Header>
</Order_Doc>
</EDXTransmission>
ProAlpha PAI EDI
Supported document types: Orders, Order Confirmations
File extension: .edi
The ProAlpha PAI format is a fixed-field-width EDI format with a segment-based structure. Each line represents a segment identified by a 3-digit type code at the beginning.
Full Example
000 000010pAI 003EDI ORDERS 0 13032025 00101503202500113032025
002 00201001CUST-12345
003 003010010000020648
005 00501001 01CUST-12345 Acme Corporation Max Mustermann Hauptstrasse 42 Munich 80331 DE
005 00501003SHIP-002 01SHIP-002 Acme Warehouse Contact Person Lager Strasse 5 Hamburg 20095 DE
005 00501004BILL-001 01BILL-001 Billing Department Finance Billing Strasse 10 Munich 80331 DE
050 05001003PO-2025-0001 13032025
100 10001016010420250000010420250000
120 12001EUR
500 50001001000010 010 ART-001-A CUST-ART-555 Industrial Sensor Module Type A 00LOT-2025-A 001000000000100000 000000000012500 1
501 501010150104202500000104202500000
999 99901000016
Segment Types
| Segment | Name | Description |
|---|---|---|
000 | Transmission header | Format metadata, message type, order number and date |
002 | Sender ID | Customer number identification |
003 | Receiver ID | Receiver identification |
005 | Address | Address segments: 001 = customer, 002 = recipient, 003 = delivery address, 004 = billing address, 900 = contact name |
050 | References | Order number and date reference |
100 | Header date | Date information: 016 = delivery date, 003 = order date |
120 | Currency | Currency code (e.g. EUR) |
500 | Line item | Article data incl. position, article numbers, description, quantity, unit and price |
501 | Line item date | Delivery date at line item level |
999 | End segment | Segment counter close |
Unit of Measure Mapping
| Input unit | PAI code | Description |
|---|---|---|
st (piece) | 001 | Piece |
g (gram) | 001 | Gram (mapped to piece) |
h (hour) | 062 | Hour |
kg (kilogram) | 032 | Kilogram |
ltr (litre) | 051 | Litre |
m (metre) | 013 | Metre |
ml (millilitre) | 050 | Millilitre |
paa (package) | 099 | Package |
stz (set) | 099 | Set |
X12 850 Purchase Order
Supported document type: Orders
File extension: .edi
The ANSI X12 850 format is a standard EDI format for purchase orders, commonly used in North American supply chains. Segments are separated by asterisks (*) and terminated with tildes (~).
Full Example
ISA*00* *00* *ZZ*CUST-12345 *ZZ*ACME *250315*0000*U*00401*123456789*0*P*>~
GS*PO*CUST-12345* *20250315*0000*1234*X*004010~
ST*850*123456789~
BEG*00**PO-2025-0001**20250315~
PER*BD*Max Mustermann*TE*+49 89 12345678*EM*max@acme.de~
DTM*002*20250401~
MSG*Please deliver to loading dock B~
N1*ST*Acme Corporation**CUST-12345~
PO1*10*100*PCE*12.50**VN*ART-001-A~
PID*F****Industrial Sensor Module Type A~
PO1*20*50*KG*8.75**VN*ART-002-B~
PID*F****Connector Cable 2m~
CTT*2~
SE*12*123456789~
GE*1*1234~
IEA*1*123456789~
Segment Reference
| Segment | Name | Description |
|---|---|---|
ISA | Interchange Control Header | Authorization, security, sender/receiver IDs, date, time and version |
GS | Functional Group Header | Function identifier (PO), sender, receiver, date and control number |
ST | Transaction Set Header | Transaction code 850 (purchase order) and control number |
BEG | Beginning Segment | Transaction type, order number and order date |
PER | Contact Information | Contact role (BD = purchasing department), name, phone (TE) and email (EM) |
DTM | Date/Time | Date qualifier (002 = delivery) and date in YYYYMMDD format |
MSG | Free-Text Message | Order notes or special instructions |
N1 | Party Name | Partner type (ST = ship-to), company name and customer number |
PO1 | Line Item | Position, quantity, unit, price, article number qualifier (VN = vendor), article number |
PID | Product Description | Description type (F = free-form) and product description |
CTT | Transaction Totals | Total number of line items |
SE | Transaction Set Trailer | Segment counter and control number |
GE | Functional Group Trailer | Transaction set counter and control number |
IEA | Interchange Trailer | Functional group counter and control number |
EDIFACT ORDERS
Supported document type: Orders
File extension: .edi
The EDIFACT ORDERS format follows the UN/EDIFACT standard for electronic order exchange.
Delimiters
| Character | Function |
|---|---|
: | Component data element separator |
+ | Data element separator |
. | Decimal notation mark |
? | Release / escape character |
* | Repetition separator |
' | Segment terminator |
Full Example
UNA:+.?*'
UNB+UNOC:3+SENDER_ID+RECEIVER_ID+250315:1430+REFERENCE_NUMBER'
UNH+1+ORDERS:D:96A:UN'
BGM+220+PO-2025-0001+9'
DTM+137:20250315:102'
DTM+2:20250401:102'
NAD+BY+CUST-12345::91++Acme Corporation+Hauptstrasse 42+Munich++80331+DE'
NAD+DP+SHIP-002::91++Acme Warehouse+Lager Strasse 5+Hamburg++20095+DE'
CTA+OC+:Max Mustermann'
COM+max@acme.de:EM'
COM++49 89 12345678:TE'
LIN+10++ART-001-A:SA'
PIA+1+CUST-ART-555:BP'
IMD+F++:::Industrial Sensor Module Type A'
QTY+21:100:PCE'
PRI+AAA:12.50'
UNS+S'
CNT+2:1'
UNT+20+1'
UNZ+1+REFERENCE_NUMBER'
Key Segments
| Segment | Name | Description |
|---|---|---|
UNA | Service String Advice | Defines the delimiters |
UNB | Interchange Header | Sender, receiver, date/time and reference |
UNH | Message Header | Message type (ORDERS) and version |
BGM | Beginning of Message | Document type (220 = purchase order) and order number |
DTM | Date/Time | Dates (137 = document date, 2 = delivery date) |
NAD | Name and Address | Partner addresses (BY = buyer, DP = delivery party) |
CTA | Contact Information | Contact details (OC = order contact) |
COM | Communication | Email (EM) and phone (TE) |
LIN | Line Item | Line item number and article number |
PIA | Additional Product ID | Customer article number (BP = buyer's part number) |
IMD | Item Description | Product description |
QTY | Quantity | Quantity and unit (21 = ordered quantity) |
PRI | Price | Unit price (AAA = net price) |
UNT | Message Trailer | Segment counter |
UNZ | Interchange Trailer | Message counter and reference |
note
EDIFACT implementations may include additional segments or variations based on your specific integration requirements.
Excel
Supported document type: Orders
File extension: .xlsx
The Excel output maps order data into a spreadsheet with one row per line item. The column layout is configured per integration.
Typical Column Layout
| Column | Description |
|---|---|
| A | Position / line number |
| B | Article number |
| C | Product description |
| D | Quantity |
| E | Unit of measure |
| F | Unit price |
| G | Total price |
| H | Delivery date |
note
The exact column layout, headings and formatting are adapted to your specific requirements. Additional columns (e.g. customer article number, batch number, commission number) can be added depending on configuration.