KCS Wholesale

Previously known as Unit4 Wholesale, now Kerridge CS Wholesale.

​

Extra information

System documentation: Kerridge Unit4 Wholesale API Reference

​

Connector package documentation

​

Table of Contents

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

​

1. Setting up HTTP Client Kerridge Unit4 Wholesale

1.1 Steps

1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client.
2. Select Kerridge Unit4 Wholesale HTTP Client as PlatForm and click next step
3. Fill in the Authentication type and Environment Type. Then complete the field base on the Authentication Type you choose.
4. You can optionally enable logging of request to get the log of the authentication.
5. 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 Kerridge Unit4 Wholesale

2.1 Steps

1. Go to Connections -> Incoming and create a new incoming configuration and select “Kerridge Unit4 Wholesale Subscriber” as the subscriber.
2. Select the entity you want to subscribe to from Kerridge Unit4 Wholesale.
3. Add any request parameters needed to subscribe to the entity.
4. Select the Kerridge Unit4 Wholesale HTTP Client to use.
5. You can optionally add a transformer to transform the request parameters into something you will request from Kerridge Unit4 Wholesale.
6. You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept We follow Kerridge Unit4 Wholesale documentation on building this connector, so you can easily use the connector based on Kerridge Unit4 Wholesale API Reference. Entity The entity you want to subscribe to Kerridge Unit4 Wholesale. Please refer to the entities from Kerridge Unit4 Wholesale API Reference page. Request Parameters These are the parameters you can provide to get the needed entity based on the Kerridge Unit4 Wholesale API Reference . Please look at the example below on how to fill path field when subscribing “Products ID” entity. Based on the documentation, we can see that the end point require “id” as a parameter. That is why we set the “id” inside the path key in the Request Parameters. Alumio will then make a request to Kerridge Unit4 Wholesale with the URL /products/100000%2CAACCXW%2CP%2C1

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

HTTP Client The HTTP Client configuration you will use to access Kerridge Unit4 Wholesale.

​

3. Publishing Entity to Kerridge Unit4 Wholesale

3.1 Steps

1. Go to Connections -> Outgoing, create a new outgoing configuration and select “Kerridge Unit4 Wholesale Publisher” as the publisher.
2. Select the Action that you want the publisher to perform with the data.
3. Select the Kerridge Unit4 Wholesale entity you want the data to be published to.
4. You can optionally add any query data to the request on the key query.
5. You can optionally add any payload data to the request on the key payload.
6. 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 Create (HTTP POST method), Update (HTTP PUT method) and Delete (HTTP DELETE method) on submitting data to Kerridge Unit4 Wholesale. Entity We support publishing to most Kerridge Unit4 Wholesale endpoints. Please refer to Kerridge Unit4 Wholesale API Reference page. For example, we want to add a new contact. Please select “Update” as the Method and “Products” as the entity of the publisher. Based on the documentation, it requires a path “id” and a request body. That is why we set the “id” inside the path key and the request body inside the payload key inside Alumio data. Alumio will send an API request to Kerridge Unit4 Wholesale with URL /products/1

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

HTTP Client The HTTP Client configuration you will use to access Kerridge Unit4 Wholesale.