About the Vendiro category

anon99371720 · September 21, 2022, 11:04am

Add topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: Vendiro API Reference

Connector package documentation

1. Setting up HTTP Client Vendiro

1.1 Steps

In Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client and select Vendiro Client as the prototype of the HTTP Client.
Fill in the Bearer Toke according to your Vendiro account.
You can optionally enable logging of requests to get the log of the authentication.
Save the HTTP Client.

2. Subscribing to Entities from Vendiro

2.1 Steps

Go to Connections → Incoming, create a new incoming configuration, and select Vendiro Subscriber as the subscriber.
Select the entity you want to subscribe to Vendiro.
Add any request parameters needed to subscribe to the entity. Please refer to an example in the General Concept section.
You can optionally add a transformer to transform the request parameters into something you need.
Select the Vendiro HTTP Client to use.
You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept

We follow Vendiro documentation on building this connector, so you can easily use the connector based on Vendiro API Reference.

Entity

It’s the entity you want to subscribe to Exact Global. Please refer to the entities in Management APIs from Vendiro API Reference page.

Request Parameters

It’s the parameters you can provide to get the needed entity based on Vendiro API Reference.

Please look at the example below on how to fill Request Parameters field when subscribing Get Account Information entity. We can see in the documentation that setting by ID entity requires ID as a path parameter to define which order we want to fetch the details from.

Input Transformer

Any transformer’s set here will be executed after the Request Parameters loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need, either as path parameters and/or as query parameters of an entity.

HTTP Client

You will use the HTTP Client configuration or prototype to access Vendiro.

3. Publishing entity to Vendiro

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration, and select Vendiro Publisher as the publisher.
Select the method that you want the publisher to use with the data.
Select the Vendiro entity you want the data to be published to.
Select the HTTP Client to use.

3.2 General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration). However, you can also add or modify payload using the Request Transformer.

Method

Currently we support POST, PUT methods for submitting data to Vendiro.

Entity

We support publishing to most Vendiro endpoints. Please refer to Vendiro API Reference page. Based on the documentation, some endpoints may need one or more path parameters.

For example, we want to “Send Update Stock”.

The documentation says that we need SKU and stock in the payload. In that case, you need to provide SKU and stock property into the payload property in the data, either as an output from Routes or output from Transformers in Outgoing Configuration. Here is an example of the required data.

Path is the path parameter of the url. For example, the {id}.
Query is a defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0
Payload is the data contained within a request.

Alumio will send an API request to Vendiro with URL /client/products/reserved-stock