About the PulpoWMS category

o.plokha · August 1, 2024, 10:13am

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

Extra information

System documentation: Pulpo WMS API Reference

Connector package documentation

1. Setting up HTTP Client Pulpo WMS

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
Select Pulpo WMS HTTP Client as PlatForm and click next step
Fill in the Base URI, Token URL, Username, Password and Scopes.
(See the Pulpo WMS Token Documentation
Click on “Grant access to Pulpo WMS” and you will get the key for the client.
You can optionally enable logging of request to get the log of the authentication.
Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use.

2. Subscribing to Entities from Pulpo WMS

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select “Pulpo WMS Subscriber” as the subscriber.
Select the Method that you want the subscriber to fetch the data.
Select the entity you want to subscribe to from Pulpo WMS.
Add any request parameters needed to subscribe to the entity.
Select the Pulpo WMS HTTP Client to use.
You can optionally add a transformer to transform the request parameters into something you will request from Pulpo WMS.
You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept

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

Entity

The entity you want to subscribe to Pulpo WMS. Please refer to the entities from Pulpo WMS API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on the Pulpo WMS API Reference.

Please look at the example below on how to fill path field when we want retrieve a Product by subscribing “Inventory - Fetch a product” entity.

From the end point, we can see that we need to set the product id as parameters. That is why we set the “id” inside the path key in the Request Parameters.

Alumio will then make a request to Pulpo WMS with the URL /inventory/products/12345

Path is the path parameter of the url. For example the {id}.
Query is 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 (Currently only supported on Post Method).

HTTP Client

The HTTP Client configuration you will use to access Pulpo WMS.

3. Publishing Entity to Pulpo WMS

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select “Pulpo WMS Publisher” as the publisher.
Select the Method that you want the publisher to perform with the data.
Select the Pulpo WMS entity you want the data to be published to.
You can optionally add any query data to the request on the key query.
You can optionally add any payload data to the request on the key payload.
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), though you can also add or modify payload using the Request Transformer.

Method

Currently, we support HTTP Post method, HTTP Put Method, HTTP Patch Method and HTTP Delete method on submitting data to Pulpo WMS.

Entity

We support publishing to most Pulpo WMS endpoints.
Please refer to Pulpo WMS API Reference page.

For example, we want to update a field inside a warehouse. Please select “Put” as the Method and “Warehouse - Update fields of warehouse by given id”.

From the documentation, we can see that we need to set a path and a body parameters. That is why we set the path id and the body parameters inside the payload key in the data.

Alumio will send an API request to Pulpo WMS with URL /warehouses/1916

Path is the path parameter of the url. For example the {id}.
Query is 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.