Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.
Extra information
Connector package documentation:
System documentation:
Setting up HTTP Client Orderchamp
Steps
- In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Orderchamp HTTP Client as the prototype of the HTTP Client.
- Fill in the Base URI, and Bearer Token.
Subscribing to Entities from Orderchamp
Steps
- Go to Connections → Incoming and create a new incoming configuration and select Orderchamp Subscriber as the subscriber.
- add Request Method as post.
- Add any request parameters needed to subscribe to the orderchamp.
- You can optionally add a transformer to transform the request parameters into something you need.
- Select the Orderchamp HTTP Client to use
General Concept
We follow Orderchamp documentation on building this connector so you can easily use the connector based on Orderchamp API Reference.
Entity
It’s the entity you want to subscribe from Orderchamp. Please refer to the entities in Management APIs from the Orderchamp API Reference page.
Request Parameters
These are the parameters you can provide to get the needed entity based on Orderchamp API Reference. Please look at the example below on how to fill Request Parameters field when subscribing Single Request.
query{
account{
name
type
slug
}
}
Input Transformer
Any transformers set here will be executed after the Request Parameters are 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
It’s the HTTP Client configuration or prototype you will use to access Orderchamp.
Publishing Entity to Orderchamp
Steps
- Go to Connections → Outgoing, create a new outgoing configuration and select Orderchamp Publisher as the publisher.
- Add any Request URI that you want to add (optional).
- Fill the Request Parameters with the data you want to do.
- You can also optionally add any transformers to transform the data into anything you need before submitting it to Orderchamp.
- Select the HTTP Client to use.
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.
Entity
We support publishing to most Orderchamp endpoints but not with publishing binary files at the moment. Please refer to the entities in Management APIs from the Orderchamp API Reference page. Based on the documentation, some endpoints may need one or more path parameters.
HTTP Client
It’s the HTTP Client configuration or prototype you will use to access Orderchamp.
Important Note
- Heres an example on using placeholder inside the query parameter.
query {
products(
first: 1,
query: "sku:&{sku}"){
edges{
node{
id updatedAt totalInventory status
variants(first: 1){
edges{
node{
idinventoryItem{
id
}
}
}
}
}
}
}
)
}
- You can left the Request Uri empty, the Request Uri will be taken from HTTP Client.