File Format Examples

The Pacemaker Order Update component supports various document types for order updates. This section provides comprehensive examples of all supported file formats for uploaded documents.

Supported Document Types

The component supports the following document types:

  • Shipments - Delivery notifications for shipped orders

  • Invoices - Invoice documents for billing

  • Cancellations - Order cancellation notifications

  • Creditmemos - Credit memo documents for refunds

Supported File Formats

Each document type can be processed in two formats:

  • JSON Format (Base-JSON) - Direct field mapping to API interfaces

  • XML Format (OpenTrans) - Standardized OpenTrans 2.1 schema

Document Examples

Shipments

Shipment documents notify about order deliveries and can include tracking information.

JSON Format (Base-JSON)

Minimal Shipment File:

{
  "target_increment_id": 855,
  "external_order_id": 855,
  "items": {},
  "comment_creation": "Comment"
}

Complete Shipment File:

{
  "external_order_id": "external_order_id",
  "target_increment_id": "target-id",
  "external_reference_key": "external-reference",
  "tracks": [
    {
      "tracking_number": 123,
      "title": "test",
      "carrier": "TestCarrier",
      "carrier_code": "custom"
     }
  ],
  "packages": {},
  "items": [
    {
      "order_item_id": "1000",
      "quantity": 50
    }
  ],
  "comment_creation": "Comment",
  "is_append_comment": true,
  "is_notify_customer": true,
  "creation_arguments": null
}

XML Format (OpenTrans)

Minimal Shipment File:

<?xml version="1.0" encoding="UTF-8"?>
<DISPATCHNOTIFICATION version="2.1" xmlns="http://www.opentrans.org/XMLSchema/2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentrans.org/XMLSchema/2.1/opentrans_2_1.xsd" xmlns:bmecat="http://www.bmecat.org/bmecat/2005" xmlns:xmime="http://www.w3.org/2005/05/xmlmime">
    <DISPATCHNOTIFICATION_HEADER>
        <CONTROL_INFO>
            <GENERATION_DATE>2009-05-13T06:20:00+01:00</GENERATION_DATE>
        </CONTROL_INFO>

        <DISPATCHNOTIFICATION_INFO>
            <DISPATCHNOTIFICATION_ID>LA86</DISPATCHNOTIFICATION_ID>
            <SHIPMENT_ID>LA86</SHIPMENT_ID>
            <DISPATCHNOTIFICATION_DATE>2009-05-13T09:00:00+01:00</DISPATCHNOTIFICATION_DATE>
            <PARTIES>
                <PARTY>
                    <PARTY_ID type="supplier_specific">968314</PARTY_ID>
                    <PARTY_ROLE>customer</PARTY_ROLE>
                    <ADDRESS>
                        <NAME>Customer Corp..</NAME>
                        <CONTACT_DETAILS>
                            <CONTACT_NAME>Doe</CONTACT_NAME>
                            <FIRST_NAME>Günther</FIRST_NAME>
                        </CONTACT_DETAILS>
                        <ZIP>70199</ZIP>
                        <STREET>incstreet 102</STREET>
                        <STATE>Hamburg</STATE>
                        <COUNTRY>Germany</COUNTRY>
                        <COUNTRY_CODED>DE</COUNTRY_CODED>
                        <EMAIL>power@blubb.com</EMAIL>
                    </ADDRESS>
                </PARTY>
                <PARTY>
                    <PARTY_ID type="supplier_specific">980301</PARTY_ID>
                    <PARTY_ROLE>deliverer</PARTY_ROLE>
                    <ADDRESS>
                        <CONTACT_DETAILS>
                            <CONTACT_ID>1</CONTACT_ID>
                            <CONTACT_NAME>Test Xml.</CONTACT_NAME>
                            <PHONE>+49 711 000 000</PHONE>
                        </CONTACT_DETAILS>
                        <STREET>incstreet 102</STREET>
                        <ZIP>70199</ZIP>
                        <CITY>Stuttgart</CITY>
                        <STATE>Baden Württemberg</STATE>
                    </ADDRESS>
                </PARTY>
            </PARTIES>
            <BUYER_IDREF>968314</BUYER_IDREF>
            <SHIPMENT_PARTIES_REFERENCE>
                <DELIVERY_IDREF>968314</DELIVERY_IDREF>
            </SHIPMENT_PARTIES_REFERENCE>
            <SHIPMENT_ID>123</SHIPMENT_ID>
            <TRACKING_TRACING_URL>http://trace.your.package.com</TRACKING_TRACING_URL>
            <COMMENT>Comment</COMMENT>
            <APPEND_COMMENT>true</APPEND_COMMENT>
            <NOTIFY_CUSTOMER>true</NOTIFY_CUSTOMER>
        </DISPATCHNOTIFICATION_INFO>
    </DISPATCHNOTIFICATION_HEADER>

    <DISPATCHNOTIFICATION_ITEM_LIST>
        <DISPATCHNOTIFICATION_ITEM>
            <LINE_ITEM_ID>order_id</LINE_ITEM_ID>
            <PRODUCT_ID>
                <SUPPLIER_PID>SKU</SUPPLIER_PID>
                <DESCRIPTION_SHORT>screws</DESCRIPTION_SHORT>
            </PRODUCT_ID>
            <QUANTITY>1</QUANTITY>
            <ORDER_REFERENCE>
                <ORDER_ID>external_order_id</ORDER_ID>
                <LINE_ITEM_ID>52</LINE_ITEM_ID>
            </ORDER_REFERENCE>
            <SHIPMENT_PARTIES_REFERENCE>
                <DELIVERY_IDREF>968314</DELIVERY_IDREF>
            </SHIPMENT_PARTIES_REFERENCE>
        </DISPATCHNOTIFICATION_ITEM>
        <DISPATCHNOTIFICATION_ITEM>
            <LINE_ITEM_ID>external_order_id</LINE_ITEM_ID>
            <PRODUCT_ID>
                <SUPPLIER_PID>SKU</SUPPLIER_PID>
                <DESCRIPTION_SHORT>screws</DESCRIPTION_SHORT>
            </PRODUCT_ID>
            <QUANTITY>1</QUANTITY>
            <ORDER_REFERENCE>
                <ORDER_ID>external_order_id</ORDER_ID>
                <LINE_ITEM_ID>23</LINE_ITEM_ID>
            </ORDER_REFERENCE>
            <SHIPMENT_PARTIES_REFERENCE>
                <DELIVERY_IDREF>968314</DELIVERY_IDREF>
            </SHIPMENT_PARTIES_REFERENCE>
        </DISPATCHNOTIFICATION_ITEM>
    </DISPATCHNOTIFICATION_ITEM_LIST>

    <CREATION_ARGUMENTS></CREATION_ARGUMENTS>

</DISPATCHNOTIFICATION>

Invoices

Invoice documents are used for billing purposes and can include detailed pricing information.

JSON Format (Base-JSON)

{
  "target_increment_id": "target-id",
  "external_order_id": "external-order",
  "external_reference_key": "external-reference",
  "items": [
  {
    "order_item_id": "10029",
    "quantity": 2
  },
  {
    "order_item_id": "10030",
    "quantity": 4
  }
],
  "comment_creation": "Comment",
  "creation_arguments": {
    "arg": "creation"
  },
  "is_capture_online": "true",
  "is_notify_customer": 0,
  "is_append_comment": 1
}

XML Format (OpenTrans)

<?xml version="1.0" encoding="UTF-8"?>
<INVOICE version="2.1" xmlns="http://www.opentrans.org/XMLSchema/2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentrans.org/XMLSchema/2.1/opentrans_2_1.xsd" xmlns:bmecat="http://www.bmecat.org/bmecat/2005" xmlns:xmime="http://www.w3.org/2005/05/xmlmime" xmlns:xsig="http://www.w3.org/2000/09/xmldsig#">
	<INVOICE_HEADER>
		<CONTROL_INFO>
			<GENERATION_DATE>2009-05-13T06:20:00+01:00</GENERATION_DATE>
		</CONTROL_INFO>

		<INVOICE_INFO>
            <PAYMENT>
                <CAPTURE>online</CAPTURE>
            </PAYMENT>
			<INVOICE_ID>I21298</INVOICE_ID>
			<TARGET_INCREMENT_ID>123465</TARGET_INCREMENT_ID>
			<INVOICE_DATE>2009-05-13T09:00:00+01:00</INVOICE_DATE>
			<INVOICE_TYPE>invoice</INVOICE_TYPE>
			<PARTIES>
				<PARTY>
					<PARTY_ID type="supplier_specific">968314</PARTY_ID>
					<PARTY_ROLE>buyer</PARTY_ROLE>
					<ADDRESS>
						<NAME>Supershop Store International</NAME>
					</ADDRESS>
				</PARTY>
			</PARTIES>
			<INVOICE_RECIPIENT_IDREF type="supplier_specific">968314</INVOICE_RECIPIENT_IDREF>
			<CURRENCY>EUR</CURRENCY>
			<TERMS_AND_CONDITIONS>Available at www.supershopstore.com/terms</TERMS_AND_CONDITIONS>
		</INVOICE_INFO>

		<ORDER_HISTORY>
			<ORDER_ID>100000026</ORDER_ID>
			<ORDER_DATE>2009-05-02T08:10:30+01:00</ORDER_DATE>
		</ORDER_HISTORY>

		<COMMENT>Comment</COMMENT>
        <APPEND_COMMENT>true</APPEND_COMMENT>
        <NOTIFY_CUSTOMER>true</NOTIFY_CUSTOMER>
	</INVOICE_HEADER>

	<INVOICE_ITEM_LIST>
		<INVOICE_ITEM>
			<LINE_ITEM_ID>1258</LINE_ITEM_ID>
			<PRODUCT_ID>
				<SUPPLIER_PID>NB-A4</SUPPLIER_PID>
			</PRODUCT_ID>
			<QUANTITY>4</QUANTITY>
			<ORDER_UNIT>PK</ORDER_UNIT>

			<PRODUCT_PRICE_FIX>
				<PRICE_AMOUNT>1200</PRICE_AMOUNT>
				<ALLOW_OR_CHARGES_FIX>
					<ALLOW_OR_CHARGE type="allowance">
						<ALLOW_OR_CHARGE_TYPE>rebate</ALLOW_OR_CHARGE_TYPE>
						<ALLOW_OR_CHARGE_VALUE>
							<AOC_PERCENTAGE_FACTOR>10.00</AOC_PERCENTAGE_FACTOR>
						</ALLOW_OR_CHARGE_VALUE>
					</ALLOW_OR_CHARGE>
					<ALLOW_OR_CHARGES_TOTAL_AMOUNT>120</ALLOW_OR_CHARGES_TOTAL_AMOUNT>
				</ALLOW_OR_CHARGES_FIX>
				<TAX_DETAILS_FIX>
					<TAX_CATEGORY>standard_rate</TAX_CATEGORY>
					<TAX_TYPE>vat</TAX_TYPE>
					<TAX>0.19</TAX>
					<TAX_AMOUNT>889.20</TAX_AMOUNT>
				</TAX_DETAILS_FIX>
			</PRODUCT_PRICE_FIX>

			<PRICE_LINE_AMOUNT>4680.00</PRICE_LINE_AMOUNT>

		</INVOICE_ITEM>
        <INVOICE_ITEM>
            <LINE_ITEM_ID>1259</LINE_ITEM_ID>
            <PRODUCT_ID>
                <SUPPLIER_PID>NB-A4</SUPPLIER_PID>
            </PRODUCT_ID>
            <QUANTITY>3</QUANTITY>
            <ORDER_UNIT>PK</ORDER_UNIT>

            <PRODUCT_PRICE_FIX>
                <PRICE_AMOUNT>1300</PRICE_AMOUNT>
                <ALLOW_OR_CHARGES_FIX>
                    <ALLOW_OR_CHARGE type="allowance">
                        <ALLOW_OR_CHARGE_TYPE>rebate</ALLOW_OR_CHARGE_TYPE>
                        <ALLOW_OR_CHARGE_VALUE>
                            <AOC_PERCENTAGE_FACTOR>10.00</AOC_PERCENTAGE_FACTOR>
                        </ALLOW_OR_CHARGE_VALUE>
                    </ALLOW_OR_CHARGE>
                    <ALLOW_OR_CHARGES_TOTAL_AMOUNT>120</ALLOW_OR_CHARGES_TOTAL_AMOUNT>
                </ALLOW_OR_CHARGES_FIX>
                <TAX_DETAILS_FIX>
                    <TAX_CATEGORY>standard_rate</TAX_CATEGORY>
                    <TAX_TYPE>vat</TAX_TYPE>
                    <TAX>0.19</TAX>
                    <TAX_AMOUNT>889.20</TAX_AMOUNT>
                </TAX_DETAILS_FIX>
            </PRODUCT_PRICE_FIX>

            <PRICE_LINE_AMOUNT>4680.00</PRICE_LINE_AMOUNT>

        </INVOICE_ITEM>
	</INVOICE_ITEM_LIST>

	<INVOICE_SUMMARY>
		<TOTAL_ITEM_NUM>1</TOTAL_ITEM_NUM>
		<NET_VALUE_GOODS>4680.00</NET_VALUE_GOODS>
		<TOTAL_AMOUNT>5569.20</TOTAL_AMOUNT>
		<TOTAL_TAX>
			<TAX_DETAILS_FIX>
				<TAX_CATEGORY>standard_rate</TAX_CATEGORY>
				<TAX_TYPE>vat</TAX_TYPE>
				<TAX>0.19</TAX>
				<TAX_AMOUNT>889.20</TAX_AMOUNT>
			</TAX_DETAILS_FIX>
		</TOTAL_TAX>
	</INVOICE_SUMMARY>

    <CREATION_ARGUMENTS>
        <arg>creation</arg>
    </CREATION_ARGUMENTS>
</INVOICE>

Cancellations

Cancellation documents are used to cancel orders or order items.

JSON Format (Base-JSON)

{
  "target_increment_id": "target-id",
  "external_order_id": "external-order",
  "external_reference_key": "external-reference",
  "items": [
    {
      "order_item_id": "10030",
      "quantity": 2
    }
  ]
}

XML Format (OpenTrans)

<?xml version="1.0" encoding="UTF-8"?>
<INVOICE version="2.1" xmlns="http://www.opentrans.org/XMLSchema/2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentrans.org/XMLSchema/2.1/opentrans_2_1.xsd" xmlns:bmecat="http://www.bmecat.org/bmecat/2005" xmlns:xmime="http://www.w3.org/2005/05/xmlmime" xmlns:xsig="http://www.w3.org/2000/09/xmldsig#">
    <INVOICE_HEADER>
        <CONTROL_INFO>
            <GENERATION_DATE>2009-05-13T06:20:00+01:00</GENERATION_DATE>
        </CONTROL_INFO>

        <INVOICE_INFO>
            <PAYMENT>
                <CAPTURE>online</CAPTURE>
            </PAYMENT>
            <INVOICE_ID>I21298</INVOICE_ID>
            <TARGET_INCREMENT_ID>123465</TARGET_INCREMENT_ID>
            <INVOICE_DATE>2009-05-13T09:00:00+01:00</INVOICE_DATE>
            <INVOICE_TYPE>cancellation</INVOICE_TYPE>
            <PARTIES>
                <PARTY>
                    <PARTY_ID type="supplier_specific">968314</PARTY_ID>
                    <PARTY_ROLE>buyer</PARTY_ROLE>
                    <ADDRESS>
                        <NAME>Supershop Store International</NAME>
                    </ADDRESS>
                </PARTY>
            </PARTIES>
            <INVOICE_RECIPIENT_IDREF type="supplier_specific">968314</INVOICE_RECIPIENT_IDREF>
            <CURRENCY>EUR</CURRENCY>
            <TERMS_AND_CONDITIONS>Available at www.supershopstore.com/terms</TERMS_AND_CONDITIONS>
        </INVOICE_INFO>

        <ORDER_HISTORY>
            <ORDER_ID>100000026</ORDER_ID>
            <ORDER_DATE>2009-05-02T08:10:30+01:00</ORDER_DATE>
        </ORDER_HISTORY>

        <COMMENT>Comment</COMMENT>
        <APPEND_COMMENT>true</APPEND_COMMENT>
        <NOTIFY_CUSTOMER>true</NOTIFY_CUSTOMER>
    </INVOICE_HEADER>

    <INVOICE_ITEM_LIST>
        <INVOICE_ITEM>
            <LINE_ITEM_ID>1258</LINE_ITEM_ID>
            <PRODUCT_ID>
                <SUPPLIER_PID>NB-A4</SUPPLIER_PID>
            </PRODUCT_ID>
            <QUANTITY>4</QUANTITY>
            <ORDER_UNIT>PK</ORDER_UNIT>

            <PRODUCT_PRICE_FIX>
                <PRICE_AMOUNT>1200</PRICE_AMOUNT>
                <ALLOW_OR_CHARGES_FIX>
                    <ALLOW_OR_CHARGE type="allowance">
                        <ALLOW_OR_CHARGE_TYPE>rebate</ALLOW_OR_CHARGE_TYPE>
                        <ALLOW_OR_CHARGE_VALUE>
                            <AOC_PERCENTAGE_FACTOR>10.00</AOC_PERCENTAGE_FACTOR>
                        </ALLOW_OR_CHARGE_VALUE>
                    </ALLOW_OR_CHARGE>
                    <ALLOW_OR_CHARGES_TOTAL_AMOUNT>120</ALLOW_OR_CHARGES_TOTAL_AMOUNT>
                </ALLOW_OR_CHARGES_FIX>
                <TAX_DETAILS_FIX>
                    <TAX_CATEGORY>standard_rate</TAX_CATEGORY>
                    <TAX_TYPE>vat</TAX_TYPE>
                    <TAX>0.19</TAX>
                    <TAX_AMOUNT>889.20</TAX_AMOUNT>
                </TAX_DETAILS_FIX>
            </PRODUCT_PRICE_FIX>

            <PRICE_LINE_AMOUNT>4680.00</PRICE_LINE_AMOUNT>

        </INVOICE_ITEM>
        <INVOICE_ITEM>
            <LINE_ITEM_ID>1259</LINE_ITEM_ID>
            <PRODUCT_ID>
                <SUPPLIER_PID>NB-A4</SUPPLIER_PID>
            </PRODUCT_ID>
            <QUANTITY>3</QUANTITY>
            <ORDER_UNIT>PK</ORDER_UNIT>

            <PRODUCT_PRICE_FIX>
                <PRICE_AMOUNT>1300</PRICE_AMOUNT>
                <ALLOW_OR_CHARGES_FIX>
                    <ALLOW_OR_CHARGE type="allowance">
                        <ALLOW_OR_CHARGE_TYPE>rebate</ALLOW_OR_CHARGE_TYPE>
                        <ALLOW_OR_CHARGE_VALUE>
                            <AOC_PERCENTAGE_FACTOR>10.00</AOC_PERCENTAGE_FACTOR>
                        </ALLOW_OR_CHARGE_VALUE>
                    </ALLOW_OR_CHARGE>
                    <ALLOW_OR_CHARGES_TOTAL_AMOUNT>120</ALLOW_OR_CHARGES_TOTAL_AMOUNT>
                </ALLOW_OR_CHARGES_FIX>
                <TAX_DETAILS_FIX>
                    <TAX_CATEGORY>standard_rate</TAX_CATEGORY>
                    <TAX_TYPE>vat</TAX_TYPE>
                    <TAX>0.19</TAX>
                    <TAX_AMOUNT>889.20</TAX_AMOUNT>
                </TAX_DETAILS_FIX>
            </PRODUCT_PRICE_FIX>

            <PRICE_LINE_AMOUNT>4680.00</PRICE_LINE_AMOUNT>

        </INVOICE_ITEM>
    </INVOICE_ITEM_LIST>

    <INVOICE_SUMMARY>
        <TOTAL_ITEM_NUM>1</TOTAL_ITEM_NUM>
        <NET_VALUE_GOODS>4680.00</NET_VALUE_GOODS>
        <TOTAL_AMOUNT>5569.20</TOTAL_AMOUNT>
        <TOTAL_TAX>
            <TAX_DETAILS_FIX>
                <TAX_CATEGORY>standard_rate</TAX_CATEGORY>
                <TAX_TYPE>vat</TAX_TYPE>
                <TAX>0.19</TAX>
                <TAX_AMOUNT>889.20</TAX_AMOUNT>
            </TAX_DETAILS_FIX>
        </TOTAL_TAX>
    </INVOICE_SUMMARY>

    <CREATION_ARGUMENTS>
        <arg>creation</arg>
    </CREATION_ARGUMENTS>
</INVOICE>

Creditmemos

Creditmemo documents are used for refunds and credit processing.

JSON Format (Base-JSON)

{
  "target_increment_id": "target-id",
  "external_order_id": "external-order",
  "external_reference_key": "external-reference",
  "invoice_id": "",
  "is_online": true,
  "is_notify_customer": false,
   "items": [
      {
        "order_item_id": "1000",
        "quantity": 50
      }
   ],
  "comment_creation": "Comment",
  "is_append_comment": null,
  "creation_arguments": null
}

XML Format (OpenTrans)

<?xml version="1.0" encoding="UTF-8"?>
<INVOICE version="2.1" xmlns="http://www.opentrans.org/XMLSchema/2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentrans.org/XMLSchema/2.1/opentrans_2_1.xsd" xmlns:bmecat="http://www.bmecat.org/bmecat/2005" xmlns:xmime="http://www.w3.org/2005/05/xmlmime" xmlns:xsig="http://www.w3.org/2000/09/xmldsig#">
    <INVOICE_HEADER>
        <CONTROL_INFO>
            <GENERATION_DATE>2009-05-13T06:20:00+01:00</GENERATION_DATE>
        </CONTROL_INFO>

        <INVOICE_INFO>
            <PAYMENT>
                <CAPTURE>online</CAPTURE>
            </PAYMENT>
            <INVOICE_ID>I21298</INVOICE_ID>
            <TARGET_INCREMENT_ID>123465</TARGET_INCREMENT_ID>
            <INVOICE_DATE>2009-05-13T09:00:00+01:00</INVOICE_DATE>
            <INVOICE_TYPE>creditmemo</INVOICE_TYPE>
            <PARTIES>
                <PARTY>
                    <PARTY_ID type="supplier_specific">968314</PARTY_ID>
                    <PARTY_ROLE>buyer</PARTY_ROLE>
                    <ADDRESS>
                        <NAME>Supershop Store International</NAME>
                    </ADDRESS>
                </PARTY>
            </PARTIES>
            <INVOICE_RECIPIENT_IDREF type="supplier_specific">968314</INVOICE_RECIPIENT_IDREF>
            <CURRENCY>EUR</CURRENCY>
            <TERMS_AND_CONDITIONS>Available at www.supershopstore.com/terms</TERMS_AND_CONDITIONS>
        </INVOICE_INFO>

        <ORDER_HISTORY>
            <ORDER_ID>external-order</ORDER_ID>
            <ORDER_DATE>2009-05-02T08:10:30+01:00</ORDER_DATE>
        </ORDER_HISTORY>

        <COMMENT>Comment</COMMENT>
        <APPEND_COMMENT>false</APPEND_COMMENT>
        <NOTIFY_CUSTOMER>false</NOTIFY_CUSTOMER>
    </INVOICE_HEADER>

    <INVOICE_ITEM_LIST>
        <INVOICE_ITEM>
            <LINE_ITEM_ID>1258</LINE_ITEM_ID>
            <PRODUCT_ID>
                <SUPPLIER_PID>NB-A4</SUPPLIER_PID>
            </PRODUCT_ID>
            <QUANTITY>4</QUANTITY>
            <ORDER_UNIT>PK</ORDER_UNIT>

            <PRODUCT_PRICE_FIX>
                <PRICE_AMOUNT>1200</PRICE_AMOUNT>
                <ALLOW_OR_CHARGES_FIX>
                    <ALLOW_OR_CHARGE type="allowance">
                        <ALLOW_OR_CHARGE_TYPE>rebate</ALLOW_OR_CHARGE_TYPE>
                        <ALLOW_OR_CHARGE_VALUE>
                            <AOC_PERCENTAGE_FACTOR>10.00</AOC_PERCENTAGE_FACTOR>
                        </ALLOW_OR_CHARGE_VALUE>
                    </ALLOW_OR_CHARGE>
                    <ALLOW_OR_CHARGES_TOTAL_AMOUNT>120</ALLOW_OR_CHARGES_TOTAL_AMOUNT>
                </ALLOW_OR_CHARGES_FIX>
                <TAX_DETAILS_FIX>
                    <TAX_CATEGORY>standard_rate</TAX_CATEGORY>
                    <TAX_TYPE>vat</TAX_TYPE>
                    <TAX>0.19</TAX>
                    <TAX_AMOUNT>889.20</TAX_AMOUNT>
                </TAX_DETAILS_FIX>
            </PRODUCT_PRICE_FIX>

            <PRICE_LINE_AMOUNT>4680.00</PRICE_LINE_AMOUNT>

        </INVOICE_ITEM>
        <INVOICE_ITEM>
            <LINE_ITEM_ID>1259</LINE_ITEM_ID>
            <PRODUCT_ID>
                <SUPPLIER_PID>NB-A4</SUPPLIER_PID>
            </PRODUCT_ID>
            <QUANTITY>3</QUANTITY>
            <ORDER_UNIT>PK</ORDER_UNIT>

            <PRODUCT_PRICE_FIX>
                <PRICE_AMOUNT>1300</PRICE_AMOUNT>
                <ALLOW_OR_CHARGES_FIX>
                    <ALLOW_OR_CHARGE type="allowance">
                        <ALLOW_OR_CHARGE_TYPE>rebate</ALLOW_OR_CHARGE_TYPE>
                        <ALLOW_OR_CHARGE_VALUE>
                            <AOC_PERCENTAGE_FACTOR>10.00</AOC_PERCENTAGE_FACTOR>
                        </ALLOW_OR_CHARGE_VALUE>
                    </ALLOW_OR_CHARGE>
                    <ALLOW_OR_CHARGES_TOTAL_AMOUNT>120</ALLOW_OR_CHARGES_TOTAL_AMOUNT>
                </ALLOW_OR_CHARGES_FIX>
                <TAX_DETAILS_FIX>
                    <TAX_CATEGORY>standard_rate</TAX_CATEGORY>
                    <TAX_TYPE>vat</TAX_TYPE>
                    <TAX>0.19</TAX>
                    <TAX_AMOUNT>889.20</TAX_AMOUNT>
                </TAX_DETAILS_FIX>
            </PRODUCT_PRICE_FIX>

            <PRICE_LINE_AMOUNT>4680.00</PRICE_LINE_AMOUNT>

        </INVOICE_ITEM>
    </INVOICE_ITEM_LIST>

    <INVOICE_SUMMARY>
        <TOTAL_ITEM_NUM>1</TOTAL_ITEM_NUM>
        <NET_VALUE_GOODS>4680.00</NET_VALUE_GOODS>
        <TOTAL_AMOUNT>5569.20</TOTAL_AMOUNT>
        <TOTAL_TAX>
            <TAX_DETAILS_FIX>
                <TAX_CATEGORY>standard_rate</TAX_CATEGORY>
                <TAX_TYPE>vat</TAX_TYPE>
                <TAX>0.19</TAX>
                <TAX_AMOUNT>889.20</TAX_AMOUNT>
            </TAX_DETAILS_FIX>
        </TOTAL_TAX>
    </INVOICE_SUMMARY>
</INVOICE>

Important Notes on File Formats

Common Required Fields (All Formats)

  • external_order_id: External order ID for Magento order mapping

  • items: Array with order items (order_item_id and quantity)

Format-Specific Differences

JSON Format (Base-JSON)

  • Direct field names corresponding to API interfaces

  • Boolean values as true/false or 1/0

  • Simple structure for quick integration

XML Format (OpenTrans)

  • Standardized OpenTrans 2.1 schema

  • Different root elements per document type:

    • Shipments: <DISPATCHNOTIFICATION>

    • Invoices/Creditmemos/Cancellations: <INVOICE> with corresponding INVOICE_TYPE

  • Extended metadata and party information possible

File Processing

Files are placed in the configured monitoring directory and automatically detected and processed by the File System Observer.

These example files can be used as templates for integration with external systems and cover all supported scenarios of the Pacemaker Order-Update component.

WIR HÄTTEN IHNEN DIESE MELDUNG AUCH GERNE ERSPART ...

... aber wir müssen Sie informieren, dass wir auf unserer Website Cookies verwenden:
  1. Diese Website verwendet keine technisch notwendigen Cookies.
  2. "Böse" Tracking-Cookies von Google Analytics (natürlich mit IP-Anonymisierung) und Leadfeeder, damit wir unsere Inhalte besser auf Ihre Bedürfnisse anpassen können.
Solange Sie nicht explizit akzeptieren, tracken wir Sie auch nicht.
Versprochen!

Detaillierte Infos in unserer Datenschutzerklärung

P.S.: Während der Entwicklung dieser Website wurden intensiv Chocolate Cookies eingesetzt.
Die sind aber alle schon weg - wir bräuchten bitte neue.
Akzeptieren Verweigern