About the BigCommerce B2B category

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 Bigcommerce Bundle B2B

Steps

  1. In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Bigcommerce Bundle B2B HTTP Client as the prototype of the HTTP Client.
  2. Fill in the Base URI (Recommend: https://api.bundleb2b.net), Store Hash, Email, Password, Name, BeginAt, EndAt, and ChannelID.

Subscribing to Entities from Bigcommerce Bundle B2B

Steps

  1. Go to Connections → Incoming and create a new incoming configuration and select Bigcommerce Bundle B2B Subscriber as the subscriber.
  2. Select the entity you want to subscribe to from Bigcommerce Bundle B2B.
  3. Add any request parameters needed to subscribe to the entity (optional).
  4. You can optionally add a transformer to transform the request parameters into something you need.
  5. Select the Bigcommerce Bundle B2B HTTP Client to use.

General Concept

We follow Bigcommerce Bundle B2B documentation on building this connector so you can easily use the connector based on Bigcommerce Bundle B2B API Reference.

Entity

It’s the entity you want to subscribe from Bigcommerce Bundle B2B. Please refer to the entities in Management APIs from the Bigcommerce Bundle B2B API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on Bigcommerce Bundle B2B API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing Get a User entity

image

image

That’s why we need to define the userId property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on the Get a user entity.

/api/v3/io/users/123

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 Bigcommerce Bundle B2B.

Publishing Entity to Bigcommerce Bundle B2B

Steps

  1. Go to Connections → Outgoing, create a new outgoing configuration, and select Bigcommerce Bundle B2B Publisher as the publisher.
  2. Select the action that you want the publisher to do with the data.
  3. Select the Bigcommerce Bundle B2B entity you want the data to be published.
  4. Select the HTTP Client to use.

image

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

Action

Currently, we support Create (HTTP POST method), Update (HTTP PUT method), and Delete (HTTP DELETE method).

Entity

We support publishing to most Bigcommerce Bundle B2B endpoints. Please refer to the entities in Management APIs from the Bigcommerce Bundle B2B API Reference page. Based on the documentation, some endpoints may need one or more path parameters.

For endpoints that require an object as the request payload, please look at the example below. For example, we want to Delete a User. Please select “Delete” as the action and “Delete a User” as the entity of the publisher.

image

image

You can put the payload you want to send to Bigcommerce Bundle B2B into the payload property in the data. Here is an example of the Possible Response after Creation.

image

Alumio will send an API request to Bigcommerce Bundle B2B with the URL

/api/v3/io/users/123

HTTP Client

It’s the HTTP Client configuration or prototype you will use to access Bigcommerce Bundle B2B.