Big Cartel

Documentation >
Apps >
Commerce >
Big Cartel

Big Cartel¶

The Big Cartel modules allow you to watch, create, update, list, retrieve, and delete the categories, discounts, and products in your Big Cartel account.

Getting Started with Big Cartel¶

Prerequisites

A Big Cartel account

In order to use Big Cartel with Ibexa Connect, it is necessary to have a Big Cartel account. If you do not have one, you can create a Big Cartel account at bigcartel.com/pricing.

Note

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

Connecting Big Cartel to Ibexa Connect¶

1. Go to Ibexa Connect and open the Big Cartel module's Create a connection dialog.

2. In the Connection name field, enter a name for the connection and click Continue.

3. Enter your login credentials to authenticate.

The connection has been established.

Category¶

Returns all categories.


Limit	Set the maximum number of categories Ibexa Connect should return during one scenario execution cycle.

Get a Category¶

Retrieves a category object from your Big Cartel account.


Category ID	Select the Category ID whose details you want to retrieve.

Create a Category¶

Creates a new category.


Name	Enter the name of the category.

Update a Category¶

Updates a category object in your Big Cartel account.


Category ID	Select the Category ID whose details you want to update.
Name	Enter a new name for the category.

Delete a Category¶

Deletes the category object and its associated data.


Category ID	Select the Category ID you want to delete.

Discount¶

List Discounts¶

Gets all discounts for an account.


Filter	Select the option to filter the discounts you want to list.
Limit	Set the maximum number of discounts Ibexa Connect should return during one scenario execution cycle.

Get a Discount¶

Gets a specific discount for an account.


Discount ID	Select the Discount ID whose details you want to retrieve.

Create a Discount¶

Creates a new discount.

Name	Enter a name for the discount.
Code	Enter a code for the discount which the customer will use to avail of the discount.
Active At	Enter the date on which the discount is available.
Requirement Type	Select the required type for the user to qualify for the discount: Any order Minimum Cart Total Minimum Cart Quantity
Expiration Type	Select the option when the discount expires: Never On Date On Limit
Reward Type	Select the rewards in which discount is offered: Percent Discount Flate Rate Discount Free Shipping
Percent Discount	Enter the discount offered in percentage. For example, `85%`.
Flat Rate Discount	Enter the discount amount offered. For example, `150`.
Application Type	Select the application for which the discount is applicable: All Category Product
Category ID	Select the Category ID for which the discount is applicable.
Product ID	Select the Product ID for which the discount is applicable.

Update a Discount¶

Updates a discount object in your Big Cartel account.

Discount ID	Select the Discount ID whose details you want to update.
Name	Enter a name for the discount.
Code	Enter a code for the discount which the customer will use to avail of the discount.
Active At	Enter the date on which the discount is available.
Requirement Type	Select the required type for the user to qualify for the discount: Any order Minimum Cart Total Minimum Cart Quantity
Expiration Type	Select the option when the discount expires: Never On Date On Limit
Reward Type	Select the rewards in which discount is offered: Percent Discount Flate Rate Discount Free Shipping
Percent Discount	Enter the discount offered in percentage. For example, `85%`.
Flat Rate Discount	Enter the discount amount offered. For example, `150`.
Application Type	Select the application for which the discount is applicable: All Category Product
Category ID	Select the Category ID for which the discount is applicable.
Product ID	Select the Product ID for which the discount is applicable.

Delete a Discount¶

Deletes a specific discount.


Discount ID	Select the Discount ID you want to delete.

Product¶

Watch New Products¶

Triggers when a new product is created.


Limit	Set the maximum number of products Ibexa Connect should return during one scenario execution cycle.

Watch Products Actions¶

Triggers when a product is created, updated, or deleted.

Note

You do not have to add a webhook in your Big Cartel account as it is automatically done for you once you add and save an instant trigger module to your scenario.


Webhook Name	Enter a name for the webhook.

List Products¶

Gets all products for an account.

Filter by	Select the option to filter the products: Status Category ID Artist ID
Filter Value	Select the product's status you want to list: Active Coming Soon Hidden Sold Out
Categories	Add the categories whose products you want to list.
Artists	Add the artists whose products you want to list.
Sort By	Select the option to sort the products: Position Created At Updated At

Get a Product¶

Returns a specific product for an account.


Product ID	Select the product ID whose details you want to retrieve.

Other¶

Make an API Call¶

Performs an arbitrary authorized API call.

URL	Enter a path relative to `https://api.bigcartel.com/{apiversion}/accounts/{accountid}`. For example: `/products` For the list of available endpoints, refer to the Big Cartel API Documentation.
Method	Select the HTTP method you want to use: `GET` to retrieve information for an entry. `POST` to create a new entry. `PUT` to update/replace an existing entry. `PATCH` to make a partial entry update. `DELETE` to delete an entry.
Headers	Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String	Enter the request query string.
Body	Enter the body content for your API call.

Example of Use - List Products¶

The following API call returns all the products from your Big Cartel account:

URL: /products

Method: GET

Matches of the search can be found in the module's Output under Bundle > Body > data. In our example, 5 products were returned: