The export orders API allows an external system to query bindCommerce to obtain orders that have been imported from the sales platforms (eCommerce, marketplace, etc ...).

The choice of which orders to expose to the API is made through the bindCommerce interface. It is possible to create multiple connectors (which correspond to different URLs to be called by the external system), each of which responding to a different configuration (filter which orders to return to the API).

Orders can act jointly on the API

• an order filter: based on the characteristics of the order (e.g. shipment status, destination of the goods, etc ...)
• a product filter: based on the characteristics of the products contained therein (for example, it is possible to export only orders that contain order lines that refer to products from a specific supplier)

It is also possible to apply transformations to exported orders (such as changing the billing address or prices).

Export order configuration

bindCommerce allows you to export all orders to API management thanks to a simple configuration.

To create the configuration from the bindCommerce control panel go to the menu:

API >> Export orders

Click on Add and fill in the required fields as shown below:

• Configuration Name: Choose the desired name
• Technology: API
• Order processing: Premium function. For the configuration, please refer to the appropriate Order Transformation technical guide
• Web Server for file storage: if this field is set, the connector can be inserted in a bindCommerce procedure and the file stored in the FTP area indicated. To ensure that the file stored in the FTP area has the date and time as a suffix in the name, you need to create a custom parameter with the name ERP_FILENAME_BY_DATETIME and value 1.

Click on SAVE AND CLOSE.

Export order connector

To create the connector that will allow you to export orders from bindCommerce to the API management system, you need to go to the menu:

Processes >> Connectors

Click on Add and fill in the fields as follows:

• Connector Name: Choose the name you think is most appropriate
• Node Type (Technology): API
• Node: the node created earlier
• Connector type: API [export orders]

By clicking on SAVE AND CONTINUE you will have access to the additional fields to be filled in.

• The calling system must use the following string: copy the URL in this field
• Connector Configuration: Select the configuration created earlier
• Filter on sales documents: to create a filter on orders, please follow the instructions given in the specific Order Filters tutorial
• Product filter: to create a product filter, please follow the instructions given in the Product Filters tutorial

Click on SAVE AND CLOSE.