Add topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.
Extra information
System documentation: REST API Documentation
Connector package documentation
Table of Contents
- 1. Setting up HTTP Client Lightspeed E-Commerce
- 1.1 Steps
- 2. Subscribing to Entities from Lightspeed E-Commerce
- 2.1 Steps
- 2.2 General Concept
- 3. Publishing Entity to Lightspeed E-Commerce
- 3.1 Steps
- 3.2 General Concept
1. Setting up HTTP Client Lightspeed Ecommerce
1.1 Steps
- In the Alumio Dashboard, go to Clients → HTTP Clients.
- Create a new HTTP Client and select Lightspeed E-Commerce HTTP Client as the prototype.
- Fill in the Base or Cluster URL, API Key, API Secret, and Shop language.
- Refer to this article to get the API key and API secret.
2. Subscribing to Entities from Lightspeed Ecommerce
2.1 Steps
- Go to Connections → Incoming and create a new incoming configuration and select Lightspeed E-Commerce Subscriber as the subscriber.
- Select the entity you want to subscribe.
- Select the Lightspeed E-Commerce HTTP Client to use.
2.2 General Concept
We follow the Lightspeed E-Commerce documentation for building this connector, so you can easily use the connector based on the Lightspeed E-Commerce Reference.
- “Path” is the path parameter of the url. For example the {id}.
- “Query” is defined as a set of parameters attached to the end of a url.
Example: URL.com - MediaOptions
Entity
This is the entity you want to subscribe to from Lightspeed E-Commerce.
Please refer to the entities in Management APIs from the Lightspeed E-Commerce API Reference page.
Request Parameters
These are the parameters you can provide to get the needed entity based on the Lightspeed E-Commerce API Docs.
Follow the instructions below for filling it in to get a Quote with Id 1016615295.
Input Transformer
Any transformers set here will be executed after the Request Parameters are loaded. So, you can basically 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
It’s the HTTP Client configuration or prototype you will use to access Lightspeed E-Commerce.
3. Publishing Entity to Lightspeed Ecommerce
3.1 Steps
- Go to Connections → Outgoing, create a new outgoing configuration and select Lightspeed E-Commerce Publisher as the publisher.
2.Select the action that you want the publisher to do with the data. - Select the Lightspeed E-Commerce entity you want the data to be published towards.
- 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. The payload used by a publisher originates from the data (from routes, from transformers in outgoing configuration), though you can also add or modify the payload using the Request Transformer.
Action
Currently, we support Create (HTTP POST method), Update (HTTP PATCH method), and Delete (HTTP DELETE Method).
Entity
We support publishing to most Lightspeed E-Commerce endpoints. Based on the documentation, some endpoints may need one or more path 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: URL.com - MediaOptions - “Payload” is the data contained within a request.
HTTP Client
This is the HTTP Client configuration or prototype you will use to access Lightspeed E-Commerce.