- Details
- Written by: Mariana Cherneva
- Category: API for developers
- Hits: 1337
The product export API allows an external system (for example an eCommerce website) to receive the products from bindCommerce.
Connector configuration on bindCommerce
In order to optimize the size of the generated file, the choice of which data to export is delegated to the user through the on-screen configurations.
Information to consider
First, you need to choose which information to export.
Product information
If you have selected the export of product information, you can select the fields to include in the generated file and select a list of alternative descriptions
Information on categories
By selecting the export of categories it will be possible to select the fields to include in the generated file, to include alternative descriptions, and to specify one or more tags (separated by commas) that will be used as a filter to select the categories to include.
Attribute information
By choosing to export the attributes it will be possible to define the list of attributes to export and whether to apply a scale conversion.
Price information
By selecting the export of prices, it will be possible to define the price lists to be exported and the price information to include.
Stock availability
By choosing to export the availabilities it will be possible to define whether to withdraw the availabilities from the Products table or from a specific warehouse and select any additional stocks to include
Images
If you have selected image export, you can choose the type of image to export, whether to take images from the Products table or from an Alternative, and the maximum number of images to export. It will also be possible to define a list of tags separated by commas which will be used as a filter for images (images that have at least one tag among those specified will be selected)
Upload to Web Server node (FTP)
It is also possible to indicate a Web Server node on which to automatically upload the generated file at the end of the export process.
- Details
- Written by: Mariana Cherneva
- Category: API for developers
- Hits: 1330
bindCommerce allows you to integrate different management systems by exploiting communication via API.
To integrate a management system via API with bindCommerce it is necessary to create a specific node, which allows you to start communication between the platforms.
First of all it will therefore be necessary to go to the menu:
Process >> Nodes
Click on Add and fill in the fields as follows:
- Technology: API
- Name: indicate the name you prefer
By clicking on SAVE AND CONTINUE you will have access to further node configurations.
- API version: select the API version appropriate to the management software used
Click on SAVE AND CONTINUE and immediately click on the GENERATE TOKEN button.
Finally click on SAVE AND CLOSE.
- Details
- Written by: Mariana Cherneva
- Category: API for developers
- Hits: 1483
The document import API allows an external system (for example an ERP) to add or update one or more sales documents (orders or invoices), including any attachments.
Connector configuration on bindCommerce
To configure the appropriate connector, you need to go to the menu
Process >> Connectors
Click on Add and fill in the fields as follows:
- Connector Name: Indicate the name you prefer
- Node Type (Technology): API
- Node: the previously created API type node. For more information on creating this node visit the API Node page
- Connector type: API [import documents]
By clicking on SAVE AND CONTINUE you will have access to the URL to which the calling system will have to make the call.
- Details
- Written by: Mariana Cherneva
- Category: API for developers
- Hits: 2146
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.
- Details
- Written by: Mariana Cherneva
- Category: API for developers
- Hits: 1766
The product import API allows an external system (for example, a warehouse management system) to add and modify products on bindCommerce, in order to subsequently be sent to the sales channels.
Connector configuration on bindCommerce
To allow the API management system to create and update products on bindCommerce it will be necessary to create a specific configuration and the relative connector.
To create the configuration go to the menu:
API >> Product iport configuration
Click on Add and fill in the fields as follows:
- Configuration Name: Choose the name you think is most appropriate
- Action type: you can choose between - Creation - Creation and update - Update
- Information to consider: Title - Description - Short description - Manufacturer - Supplier - Dimensions and weight - Quantity - Attributes - Tags - Prices - Alternatives - Images - Categories
- Elimination of data not transmitted: Barcode - Images - Products
- Calculate quantity of parent product from the sum of the variants ?: option that allows you to determine if the parent products should have the quantity calculated based on the sum of the stock of the individual variants
- Calculate parent price from the minimum of variants ?: option that allows you to determine if the parent products should have the price calculated based on the lowest price of the individual variants
Click on SAVE AND CLOSE.
To create the connector that will allow you to import products from the API management to bindCommerce you need to go to the menu:
Process >> Connectors
Click on Add and fill in the fields as follows:
- Connector Name: Use whatever name you prefer
- Node Type (Technology): API
- Node: the node created earlier
- Connector type: API [import products]
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 and paste it in the appropriate field on the management control panel
- Connector Configuration: Select the configuration created earlier
- Product filter: to create a product filter, please follow the instructions given in the product Filters guide
Click on SAVE AND CLOSE.