Orders Export
The task writes your orders into a file, with line items, customer and both addresses. It is the usual route to an ERP or accounting system that has no connection of its own: whatever can be read in there can be produced here.
What gets transferred
Released orders, and those of the last few days. You set how many days that is. Closed orders stay out of it by default.
Per order its head data, the customer, the billing and the shipping address and the line items go along. The scope of the file comes from the plan alone: a field nobody assigns does not appear in it.
The task's own configuration
Three settings decide which orders end up in the file at all, and they work together.
| Setting | What it does |
|---|---|
| Age of Orders to Sync | How many days back are read, 14 out of the box |
| Exclude Closed Orders from Sync | Ticked out of the box: what is completed no longer goes out |
| Filter By | The same conditions as in the order list, by channel or status for instance |
The reason for the limit to a few days: an execution going through the whole body of orders every time gets longer with every month without delivering more. An order from a year ago does not change any more. Where the whole set is needed for the first transfer, you raise the value once and put it back afterwards.
Below them sit the settings for a running feed: Incremental writes out only what has changed since the last execution, Only New Entries narrows that to orders that were not included before.
How the transfer plan is built
Six sections.
| Section | What sits in it |
|---|---|
| Layout | The record sets of the output: which levels the file gets and which data format writes it |
| Common | The head data of the order |
| Customer | The fields of the customer the order hangs off |
| Billing Address | The address the invoice goes to |
| Shipping Address | The address delivered to |
| Order Items | Two subgroups: Items and References |
The Order Items section is the only one divided once more. Items writes the line items themselves, and the sources there also say which kind an item is: article, shipping cost, voucher. References writes what sits between two items, which shipping cost line belongs to which article for instance. An ERP system expecting shipping costs as an item of their own needs the first group only. One that is meant to attribute them to an article needs the second as well.
For a flat file one record set in the Layout section is enough, and then each item gets a row with the fields of the order beside it. A nested XML or JSON file gets a second record set below the first, and the items sit inside it.
Special features and limits
The order status goes out but does not come back. What the other system makes of the order does not reach TRADElube through this channel. That needs a file in the other direction and Orders Import.
Customers have no export task of their own. They go along as a section of the order, and whoever needs a customer list as a file gets it through the orders the customers appear in.
Further reading
- Custom: data formats, endpoints and the other six tasks
- Orders Import (Custom): the other way round, from a file into TRADElube
- Orders (reference): the fields the columns of the file come from
- Data sources (reference): where an endpoint puts the finished file
- Transfer plan (concepts): layout, record set, grouping and replication