A newer version of this documentation is available: View the Latest Version

Configuration

Order export settings

Config Type Default Description

Enable Order Export

Yes/No

No

Enables/disables the order export for the current scope (website)

Filter Conditions

Payment- Status- Mapping

It defines the export conditions corresponding to the order status for the payment types.

  • Only orders that meet at minimum one condition will get exported. If no filter is defined, then all orders will get exported

Enable Datetime Filter

Yes/No

No

Enables/disables the date filter for the order export.

  • Only orders that meet at minimum one condition will get exported. If no filter is defined, then all orders will get exported

Datetime filter periode

Text / Timeperiod

It defines a period for the date filter.

  • Orders older than XXX will not get exported

order export setting

Export format

Config Type Default Description

Export Format

Select

Custom Template

It defines the order export format.

  • The format is configurable for each website and can get easily extended/customized

  • The Custom Template gets used in Export Template by default

  • It is also possible to select Default openTrans 2.1

Export Template

Text / Twig-Editor

{
  "order_id": "{{ order.getIncrementId() }}",
  "items": [
    {% for item in order.getItems() %}
    {
      "sku": "{{ item.getSku() }}",
      "qty": "{{ item.getQuantityOrdered() }}"
    }
    {% if not loop.last %},{% endif %}
    {% endfor %}
  ]
}

With the here given configuration, you can customize the Custom Template for the order export with Twig.

order export setting

Transport adapter

Config Type Default Description

Transport Adapter

Select

Local Filesystem

Defines the adapter to perform the order export.

  • The adapter can get configured for each website and can get easily extended/customized

  • By default, the local file system gets used

Local Filesystem Target Directory

Text

var/pacemaker/export

The destination directory gets used with the filesystem adapter.

Local Filesystem Filename Pattern

Text

order-INCREMENT_ID.json

Scheme for creating the export file when the filesystem adapter will get used.

Please note that when using the OpenTrans format, set the file extension to an XML extension e.g. ".xml".

transport adapter setting

Response handler

Config Type Default Description

Response Handler

Select

Default JSON

It Defines the order export response handler.

  • That is optional to process external, asynchronous system responses from ERP or OMS

  • By default, a JSON file gets expected, automatically getting executed

  • The Response Handler can get easily extended/customized

JSON Response Source Directory

Text

`var/pacemaker/import

The processed response gets stored in this destination directory.

JSON Response Filename Pattern

Text

order-update-INCREMENT_ID.json

Scheme for the JSON file name which will get generated.

response haendler setting

Notification

Config Type Default Description

Notification Handler

Select

No notification Handler

Sender email address for monitor mails.

Disable Default Order Confirmation E-mails

Yes/No

No

If active, the standard order confirmation email gets not sent.

notification setting

Open TRANS Configuration

Config Type Default Description

Order Header Template

Editor Textarea

see screenshot

You can define the order header format by using Twig template engine.

Order Item Template

Editor Textarea

see screenshot

You can define the order item format by using Twig template engine.

Order Summary Data Template

Editor Textarea

see screenshot

You can define the order summary data format by using Twig template engine.

openTrans

Line items extension

Config Type Default Description

Enable Line Items

Yes/No

No

Extend order items with row-unit attribute.

Enable Number Generator

Yes/No

No

Generate a unique line unit number for an order.

Number Offset

Number

1

The value by which the count per order item gets increased.

Enable String Padding

Yes/No

No

Increment the number up to a specified string length.

String Padding Length

Number

6

Padding string length.

String Padding Character

Text

0

Letter of padding string length.

String Padding Direction

Select

Left

The direction in which the string is populated.

line items extension setting

Order Export Reservation Handling

Config Type Default Description

Reservation Revocation

Select

Use Magento Standrd

Define the moment/option when the stock reservation should be resolved.

The exact options are explained here.

reservation handling

Order Status Payment Adjustment

Config Type Default Description

Enable Status Payment Adjustment

Yes/No

No

Enables the order status adjustment depending on the payment

Payment mapping for Order Status Adjustment

Mapping: PaymentMethod / OrderStatus / Yes\No / TimePeriod

Maps the Payment method to a time period when the order will be cancelled automatically (from the defined order status).

Cron expression

Cron-Schedule

* * * * *

Define a valid cron expression for scheduling the order status adjustment pipeline.

order status payment adjustment