About the Returnless category

[anon99371720]

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

Extra information

System documentation: Returnless API Reference

Connector package documentation

​​Table of Contents

• 1. Setting up HTTP Client Returnless
  • 1.1 Steps
• 2. Subscribing to entities from Returnless
  • 2.1 Steps
  • 2.2 General concept
• 3. Publishing entity to Returnless
  • 3.1 Steps
  • 3.2 General concept

1. Setting up the HTTP Client Returnless

1.1 Steps

1. In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client and select Returnless Client as the HTTP Client.
2. Fill in the Base URI, API user, and API Password
   (For more information, see Returnless API Reference)
3. You can optionally enable logging of request to get the log of the authentication.
4. Save the HTTP Client for use.

2. Subscribing to Entities from Returnless

2.1 Steps

1. Go to Connections → Incoming and create a new incoming configuration and select Returnless Subscriber as the subscriber.
2. Select the entity you want to subscribe to from Returnless.
3. Add any request parameters needed to subscribe to the entity.
4. You can optionally add a transformer to modify the request parameters into something you will request from Returnless.
5. Select the Returnless HTTP Client to use.
6. You can also optionally enable pagination to allow Alumio to fetch paginated entities.

2.2 General Concept

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

Entity

This is the entity you want to subscribe to Returnless. Please refer to the entities from Returnless API Reference page.

Request Parameters

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

Please refer to the example below on how to fill the path field when subscribing “Get single request” entity:

Based on the documentation, we can see that the endpoint requires “request_id” as a path. That is why we set the “request_id” inside the path key in the Request Parameters.

• “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

Alumio will then make a request to Returnless with the URL /requests/123

Input Transformer

Any transformers set here will be executed before the Request Parameters are loaded. So, you can add any transformer to provide and manipulate the request parameters into anything you need, either as path parameters and/or as query parameters of an entity.

HTTP Client

The HTTP Client configuration you will use to access Returnless.

3. Publishing Entity to Returnless

3.1 Steps

1. Go to Connections → Outgoing, create a new outgoing configuration, and select the Returnless Publisher as the publisher.
2. Select the action that you want the publisher to perform with the data.
3. Select the Returnless entity you want the data to be published to.
4. (Optional) Add any path data to the request on the key path.
5. (Optional) Add any query data to the request on the key query.
6. (Optional) Add any payload data to the request on the key payload.
7. 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.

Action

Currently, we support Update (HTTP PUT method) on submitting data to Returnless.

Entity

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

For example, we want to update a return to status complete. Please select “Put” as the Action and “Update Return” as the entity of the publisher.

Based on the documentation, we can see that the endpoint requires “return_id” as a path. That is why we set the “return_id” inside the path key in the data. It also needs a query for “status”. So, we also need to add the “status” key inside the query key in the data.
It doesn’t require a body, so we set the payload empty for this request.

Alumio will send an API request to Returnless with URL /returns/123?status=complete

• “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.

HTTP Client

This is the HTTP Client configuration you will use to access Returnless.