On This Page
Swell is a customizable e-commerce platform that provides you with the tools to sell products on the Internet. Swell allows you to host your digital retail stores on its platform regardless of your business model; business-to-consumer (B2C) or business-to-business (B2B).
Swell authenticates API requests from Hevo to access your account data with HTTP Basic authentication where the username is your Store ID and password is your API Key.
An active Swell account from which data is to be ingested.
An API key is available to authenticate Hevo on your Swell account.
Obtaining the Store ID and API Key
Swell automatically creates a unique store ID for each store. Hevo uses the store ID to identify the store from which to ingest the data, and the API key is used for authenticating Hevo on your Swell account. The API keys you generate in Swell do not expire. Therefore, you can use an existing key or create a new one to authenticate Hevo on your Swell account. Swell recommends creating a separate API key for each application that will be making calls on your behalf. For example, you can use the store ID and one API key for Hevo, to be used across all your Pipelines. However, you can also use the store ID with a different API key for each Pipeline.
Note: You must be logged in as an Admin user to obtain the API key.
Perform the following steps to obtains the Store ID and API Key:
Log in to your Swell account.
In the left navigation pane, under the ADMIN section, click Developer, and then click API keys.
In the API access page, copy the Store ID and save it securely like any other password.
To obtain the API key, do one of the following:
Create the API key:
In the API access page, scroll down to the Secret Keys section, and click Add secret key to generate a new API key.
In the New secret key pop-up dialog that is displayed, provide the Key Description for the API key that helps you easily identify it later.
Click Create key.
Use an existing API key. Click the masked portion of the secret key to reveal it fully.
Copy the API key and save it securely like any other password.
Configuring Swell as a Source
Perform the following steps to configure Swell as the Source in your Pipeline:
Click PIPELINES in the Asset Palette.
Click + CREATE in the Pipelines List View.
In the Select Source Type page, select Swell.
In the Configure your Swell Source page, specify the following:
Click TEST & CONTINUE.
Proceed to configuring the data ingestion and setting up the Destination.
|Default Pipeline Frequency||Minimum Pipeline Frequency||Maximum Pipeline Frequency||Custom Frequency Range (Hrs)|
|1 hr||1 hr||24 hrs||1-24|
Note: You must set the custom frequency in hours as an integer value. For example, 1, 2, 3 but not 1.5 or 1.75.
Hevo fetches all the objects in Full Load mode in each run of the Pipeline.
Pagination: Each API response for each Swell object fetches one page with up to 1000 items per page.
Rate limit: Swell does not impose a hard limit on the number of API calls that can be made in a specific time interval.
Schema and Primary Keys
Hevo uses the following schema to upload the records in the Destination database:
The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:
|Products||Contains the details of the products available for purchase in the store. Products are items that can be sold to a customer as either one-off sales or as subscriptions.|
|Variants||Contains the details of all the variants of a product in the store.|
|Stocks||Contains the details of the stock levels of products in the store. It helps you to keep track of the inventory changes.|
|Categories||Contains information of all the categories used for organizing products in the store.|
|Attributes||Contains the details of the attributes of all the products. Product attributes are additional properties of a product.|
|Orders||Contains the details of the orders placed to the store.|
|Carts||Contains the details of the carts made by customers to purchase products from the store. Carts contain all the information needed to fulfill a purchase.|
|Payments||Contains the details of the payments made to the store.|
|Refunds||Contains the details of all the refunds issued by the store to the customers.|
|Shipments||Contains the details about the shipment of an order. Shipments contain information about the orders being fulfilled, and the shipping details such as address and tracking number.|
|Returns||Contains the details of all the returns made by the customers to the store.|
|Subscriptions||Contains the details of the subscriptions plans offered by the store.|
|Accounts||Contains the details of all the customer accounts.|
|Promotions||Contains the details of the promotions offered by the store to the customers.|
|Gift Cards||Contains the details of the gift cards offered by the store to the customers. A gift card is a specific prepaid card of a certain amount of money that can be used to purchase items from the store.|
Hevo currently does not support deletes. Therefore, any data deleted in the Source may continue to exist in the Destination.
The data is loaded in Full Load mode in each Pipeline run. As a result, you cannot load the historical data alone at any time.
Refer to the following table for the list of key updates made to this page:
|Date||Release||Description of Change|