Introduction

Our API makes it possible for anyone to make awesome things for Big Cartel’s massive community of artists, creators and independent businesses. Integrate Big Cartel into an existing application or service, create an add-on to extend our core features, or code something up you’d like in your own shop. Whatever it is, we hope these tools allow you to build something great.

Developer Newsletter

Stay in the loop! Join our Developer Newsletter and follow our API Changelog to stay current on new features, improvements, and bug fixes!

Are you a developer and have a question? Contact our developer support at support+developer@bigcartel.com

Versioning

The current version of the Big Cartel API is V1, and that version number is specified in all endpoints (e.g. /v1/accounts/123). Updates made to the V1 API will always be backwards-compatible, and listed with a datestamp in our API Changelog.

Status Codes

Our API returns HTTP status codes for every request. Here are some examples of typical responses you can expect to receive:

Code	Status
`200`	Everything worked as expected.
`201`	Created - a new resource was created.
`400`	Bad Request - missing or invalid parameters.
`401`	Unauthorized - invalid API credentials.
`402`	Request Failed - valid parameters, but the request failed.
`404`	Not Found - requested item doesn’t exist.
`406`	Not Acceptable - something is wrong with your request.
`5xx`	Server Error - something is wrong on our end.

If you’re receiving 400 or 406 errors, double check to make sure you’re including the required headers.

Some errors will return an additional errors object in the response with information in the following format:

{
  "errors": [
    {
      "code": "not-found",
      "title": "The item you requested was not found",
      "detail": "We couldn't find that account"
    }
  ]
}

Sorting

Many of our APIs support sorting results with the sort parameter where you pass the field name to sort by.

When sorting is supported, you can use the sort_direction parameter with either asc or desc to sort ascending or descending respectively.

GET /v1/categories?sort=name&sort_direction=desc

Pagination

Requests that return multiple objects will be limited to 20 items by default. The documentation for each endpoint will tell you which objects support pagination, and you can specify further pages using limit and offset inside the page parameter.

GET /v1/accounts/1/orders?page[limit]=10&page[offset]=0

When an object supports pagination, a links object is returned that can contain first, last, next, and prev keys with links to their respective pages depending on what page of results is being returned. For example:

{
  "data": [
    ...
  ],
  "links": {
    "next": "http://api.bigcartel.com/v1/accounts/1/orders?page%5Blimit%5D=10&page%5Boffset%5D=10",
    "last": "http://api.bigcartel.com/v1/accounts/1/orders?page%5Blimit%5D=10&page%5Boffset%5D=10"
  }
}

Additionally, we’ll return a meta object with the total number of results available to be paginated through:

{
  "data": [
    ...
  ],
  "meta": {
    "count": 60
  }
}

Images

Any image URL attribute returned from an endpoint in our API will be include a default size. However, you’d probably like a version optimized for your application. Fortunately, Big Cartel can resize the image in any way you’d like using the w and h query string parameters for width and height respectively.

Original

https://assets.bigcartel.com/example_resource/12345/example.jpg?w=1000&h=1000

Resized

https://assets.bigcartel.com/example_resource/12345/example.jpg?w=500&h=250

Rate Limiting

Our API doesn’t currently limit the number of requests in a given time period, but rate limiting will be added in the future.

However, as described in our app best practices, we strongly recommend to use webhooks to know when an update happens instead of polling regularly.

Making API Calls

All of our endpoints begin with the root URL https://api.bigcartel.com, and require a few headers to be sent along with your request.

Required Headers

All requests require an Accept header of application/vnd.api+json. When making a request that includes a JSON body, we also require that you send a Content-type header of application/vnd.api+json.

Identification

You must include a User-Agent header with the name of your application and a contact URL or email where you can be reached. This allows us to warn you if you’re doing something wrong before you get blacklisted, or feature you if you’re doing something awesome. If you don’t supply this header, you will get a 400 Bad Request response.

User-Agent: Example Inc. (http://example.com/contact/)
User-Agent: Example Project (email@example.com)

Submit an application

Want to create an app for Big Cartel sellers that uses our API or Webhooks? We approve a select number of partners and developers to create apps with us to make available to our community of sellers.

Interested in partnering with us? Submit an application and we’ll be in touch.

Already have an app? Make sure you follow our OAuth guide, explore our APIs and Webhooks to learn how to best extend and improve Big Cartel stores.

App requirements

This is a list of requirements your app must follow. We will review this during your initial app review, but also on an ongoing basis. Apps found to not follow these requirements will be removed from our app store. Also please read out app best practices to ensure you are building the best possible experience for our Big Cartel sellers.

Review the API License Agreement: Before starting development, ensure you understand the terms and conditions outlined in the API license agreement to align your app with our policies.
Build help content and workflows: You must build a unique help article for your app integration with Big Cartel to facilitate the success of our mutual customers. It should cover, at minimum, setup and usage, including ways to contact your support team for help.
Design for non-unique emails: Email is not a unique identifier in Big Cartel, which means more than 1 shop can have the same. Your app must be designed with this case in mind. Additionally, while sub-domains and custom domains are unique across accounts, it’s possible for them to be re-used over time by different accounts that are not the same user. You should rely on the account ID for as a unique property.
Don’t make incorrect assumption about the domain: A store’s domain can change over time so you must handle this. The Account’s ID is unique and long-lived so you should key off that and handle domain name changes. A domain can change due to seller’s changing their subdomain on bigcartel.com (eg. shop starts as foo.bigcartel.com then renames to bar.bigcartel.com). Additionally, many stores will transition to a custom domain (e.g. myindieshop.com) or go back and forth.
Handle the deauthorization: When an account deauthorizes your app you’ll be informed via the account.deauthorized webhook. Take appropriate actions such as disconnecting your app, invalidating the OAuth token, and notifying the seller within your UI that they need to re-authorize your app.
Pay attention to Themes and Theme Versions: Our store themes can vary wildly in layout and design, so it is important that you test across a broad array of our themes. Recognize that many shops can have old theme versions, so many not always be on the latest version. Utilize the <meta> tags in stores that tell you which theme name and theme version they are on.
Respect Store Feature Limits: For features with plan-based limits, use the Account API to identify the account’s plan and strictly adhere to the specified limits. For example, if an account is limited to 5 max images per product, do not try to upload more than that. Similarly, if they are entitled to 25 images per product, create the experience and messaging in your app that indciates this limit has not yet been reached if they are sync’ing images.
Handle Plan Changes: Monitor the account.plan.upgraded and account.plan.downgraded webhooks to detect plan changes and adjust your app’s feature set accordingly (e.g., updating max product images).
Collect Marketing Consent Correctly: If your app enables sellers to do marketing communications to customers, you must both (a) honor the customer_opted_in_to_marketing flag in the order object, and (b) have your app setup to collect marketing consent during checkout. Read our (Marketing Apps](#marketing-apps) guidelines.
Include a user agent: Follow our guidelines for not only including a user agent, but also including within it your contact information. See our section on Making API Calls for more details.

App best practices

To help you create an app that integrates well with the Big Cartel platform, please follow these best practices:

Optimize API Calls: Make efficient use of API calls by fetching only the data you need. Avoid unnecessary calls, and cache data where appropriate to reduce the load on our servers.
Use Thoughtful Rate Limiting: Ensure your app has reasonable rate limiting, considering both your needs and our platform’s capacity. Avoid querying the API for all accounts simultaneously or excessively to prevent unnecessary load on the platform.
Test Extensively: Conduct thorough testing, including unit, integration, and stress tests, to ensure your app handles real-world scenarios gracefully.
Monitor Usage and Performance: Regularly monitor the usage of your app and its impact on the Big Cartel platform. Adjust your app based on observed usage patterns to maintain optimal performance.

Following these best practices will ensure your app is efficient, reliable, and respectful of the Big Cartel platform and our sellers. Please ensure you also review and meet our list of requirements for apps.

OAuth

The Big Cartel API uses OAuth 2.0 to provide your application with access to an account without the need for sharing or storing passwords. To do this, you’ll redirect your user to Big Cartel, they’ll login and see a page explaining exactly who wants access and what they’ll have access to. After allowing or denying your request, they’ll be sent back to your site.

Using an OAuth library

Since OAuth is a common and open protocol, there are already a number of projects that make it easy to use without much work on your part.

Grab an OAuth library.
Configure it with your client_id, client_secret, and redirect_uri.
Tell it to use https://my.bigcartel.com/oauth/authorize to request authorization and https://api.bigcartel.com/oauth/token to get access tokens.

That’s it! You can now use your access_token to make API calls.

OAuth from scratch

If you’re the type that likes to have full control over your code, and don’t mind reinventing a wheel now and then, you can create your own OAuth integration.

1. Redirect the user to Big Cartel to request access

To connect your application to a Big Cartel account, redirect them to our authorization page which will prompt them to give you access to their account.

GET https://my.bigcartel.com/oauth/authorize

Parameters

Name	Type	Required	Description
`client_id`	string	true	Your unique client identifier from your application settings.
`response_type`	string	false	The only option right now is code.
`state`	string	false	An arbitrary value, sent back with each response (useful for identifying users on your end).
`redirect_uri`	string	false	URL where your users are sent after authorization.

2. Big Cartel redirects back to your site

If the user accepts your request, they’ll be redirected to your redirect_uri with a temporary code in a code parameter as well as the state you may have provided in the previous step in a state parameter. If the states don’t match what you expect, the request has been created by a third party and the process should be aborted.

If the user’s account is already connected to your application, they’ll be immediately redirected back to your redirect_uri in the same way as described above, instead of being prompted to allow or deny access.

If the user denies your request, they’ll be redirected to your redirect_uri with the an error parameter containing the appropriate error code.

3. Exchange the temporary code for an access token

You’ll now need to make a request to trade the code you received for an access_token.

POST https://api.bigcartel.com/oauth/token

Parameters

Name	Type	Required	Description
`client_id`	string	true	Your unique client identifier from your application settings.
`client_secret`	string	true	Your unique and private client secret from your application settings.
`code`	string	true	The `code` parameter you received in the previous step.
`redirect_uri`	string	false	URL where your users are sent after authorization.

Response

If successful, we’ll return a JSON response in the following format.

{
  "access_token":"YOUR-ACCESS-TOKEN",
  "token_type":"bearer",
  "account_id":12345
}

Using the access token

Now that you’ve obtained an access_token for an account, you’ll need to use it in the Authorization header to make API calls - and remember to include the required headers!

Authorization: Bearer YOUR-ACCESS-TOKEN

curl -H "Authorization: Bearer YOUR-ACCESS-TOKEN" https://api.bigcartel.com/accounts/12345

Revoking access

To revoke access to an account, send a POST request to our deauthorization endpoint and include the account ID.

This request requires that you use HTTP Basic authentication instead of OAuth - you’ll need to specify your application’s client_id for the username and client_secret for the password. If successful, you’ll receive a 204 No Content response.

https://api.bigcartel.com/oauth/deauthorize/{account-id}

OAuth errors

If at any point there are problems or invalid parameters in your request, we’ll send back an error code. Possible errors include:

Name	Description
`access_denied`	The user has denied access to their account.
`invalid_client_id`	The `client_id` you specified is invalid.
`invalid_client_secret`	The `client_secret` you specified is invalid.
`invalid_redirect_uri`	The `redirect_uri` you specified is invalid.
`invalid_response_type`	Your request’s response type is invalid.

{
  "error":"client_secret_invalid"
}

Personal Projects

If you’d like to make a private integration just for yourself, you can do that without an invite by using HTTP Basic authentication, specifying your store’s subdomain for the username. Again though, this should only be for your own store, never ask anyone for their password!

Note that most endpoints require that you include an account ID when making a request. To find the account ID for your store, just make a request to the Account API and retrieve the id attribute from the response. Make sure to include the required headers in your requests.

GET /v1/accounts

About scripts

An embeddable script is a snippet of client code that is automatically included in a shop when your app is authorized by an account. This feature allows apps to add functionality to shops seamlessly, without requiring sellers to manually copy and paste JavaScript code. It maximizes app adoption, reduces errors, and enhances the user experience for our mutual customers.

Embeddable scripts require template customization on behalf of the accounts. Therefore, only accounts with a paid Big Cartel plan can use apps with embeddable scripts.

A partner app can include one or more scripts, each defined to be included at the end of the <HEAD> or <BODY> sections. When your app is deauthorized for an account, any defined scripts will be immediately disconnected and no longer render in the shop.

While we refer to these as “scripts”, it’s also possible to add other elements such as <DIV> tags which can be helpful for dynamic targeting.

Have you already built an app for Big Cartel and want access to Embeddable Scripts? Fill out our application, so we can get the most up to date information about your app, including your embeddable script details.

Script variables

Embedded scripts can reference variables in their definition and rely on Liquid syntax for inclusion. Variables are scoped globally across your app and are accessible in any of your scripts using the app_variables namespace.

Variables can be any valid JSON type.

Any theme variables defined in the Themes API can also be used with your scripts. Common examples include Store variables such as store.hostname, referenced as {{ store.hostname }}.

In addition to Theme API variables, we offer the embeddable scripts Update App Config API. This API allows you to personalize script variables, even on a per-account basis. It’s useful for variables with values originating outside of Big Cartel, such as configuration data from your end like user IDs or per-user configuration data.

Example script that uses variables appId and widgetCount.

<!-- // BEGIN // My App Integration Code -->
<script type="application/javascript">
  window.picasso = window.picasso || [];
  (function(){
    const appId = "{{ app_variables.appId }}";
    const widgetCount = {{ app_variables.widgetCount }};
    const baseCdn = "https://picasso.com";
    window.picasso.push("configure", { api_key: appId });
    if (!document.querySelector('#picasso_css')) {
      const element = document.createElement('link');
      element.href = `${baseCdnUrl}fancy.css`;element.id = "picasso_css";
      element.rel = 'stylesheet';document.head.prepend(element);
    }
    if (!(window.picasso && !Array.isArray(window.picasso)) && !document.querySelector('#picasso_js')) {
      const element = document.createElement('script');
      element.src = `${baseCdn}brush.js`;
      element.id = "picasso_js";
      element.async = true; document.body.append(element);
    }
  })();
</script>
<!-- // END // My App Integration Code // -->

Get app config

Retrieve the configuration for your app associated with a specific shop’s account. We currently only support app script variables in configuration. Responses include details about which variables are referenced by your app scripts and which are unreferenced. This information aids in managing the lifecycle of your scripts, ensuring you know which variables are actively in use.

If an account has not authorized your app you will get a 4xx status code.

Request

GET /v1/accounts/{account-id}/apps/{client-identifier}/config

Parameters

None

Example Response

{
  "data": {
    "id": "abc123def456",
    "type": "app_config",
    "attributes": {
      "variables": {
        "appId": "1234",
        "widgetCount": 1
      }
    },
    "meta": {
      "variables": {
        "referenced": ["appId"],
        "unreferenced": ["widgetCount"]
      }
    }
  }
}

Update app config

Variables can be dynamically assigned for a given shop’s embedded script using our App Config API. This API only allows configuration of variables at this time for embedded scripts that have been associated with your app.

All variables are defined via this API can be referenced in your scripts in the app_variables namespace (e.g. {{ app_variable.my_variable }}).

Config requests must always contain the entire list of variables for your app. Any variables that are omitted will be deleted from your app’s configuration.

Request

POST /v1/accounts/{account-id}/apps/{client-identifier}/config

Parameters

Provide name value pairs for each variable and corresponding value for a given account.

Response

If successful, we’ll return a 200 OK status code. Error will return status of 400. If you receive a response with error code invalid-id, ensure you are correctly passing your client identifier as the value of id in the request.

Example Request

Create variables foo with value "ABC" and bar with value 88 for oauth client identifier abc123def456.

{
  "data": {
    "id": "abc123def456",
    "type": "app_config",
    "attributes": {
      "variables": {
        "appId": "123456",
        "widgetCount": 4
      }
    }
  }
}

Example Response

{
  "data": {
    "id": "abc123def456",
    "type": "app_config",
    "attributes": {
      "variables": {
        "appId": "1234",
        "widgetCount": 1
      }
    },
    "meta": {
      "variables": {
        "referenced": ["appId"],
        "unreferenced": ["widgetCount"]
      }
    }
  }
}

Example Error

{
  "errors": [
    {
      "status": "400",
      "code": "app.config.invalid",
      "title": "Some error message title here",
      "details": "There will be detailed error message here for context",
      "source": { "pointer": "/data/attributes/variables" },
      "meta": {}
    }
  ]
}

Script best practices

To enhance the integration of your Big Cartel apps with embeddable JavaScript, we recommend adhering to the following best practices. These guidelines are designed to optimize performance, improve security, and ensure a seamless user experience:

Prefer Embeddable Scripts: Always use embeddable scripts instead of requiring sellers to manually insert JavaScript into their shop. This approach not only streamlines the process, increasing adoption rates, but also minimizes errors associated with manual code insertion.
Use Namespaces for your app’s context: Avoid using the global window object directly for storing variables, as this can lead to conflicts with other scripts or the host environment. Instead, create a specific namespace for your app (e.g., window.myApp) to encapsulate all your variables and functions. This practice helps maintain a clean global scope and reduces the risk of naming collisions.
Don’t assume load order: Since a given account can have multiple apps, and embeddable scripts, you should make no assumptions on the load order of scripts within the <head> or <body>.
Leverage our Pages API and JavaScript Variables to Target Your Scripts: Our Pages API provides all pages for a given store, including their paths. Additionally, our JavaScript variables offer access to key data about a shop and its pages. This enables you to build powerful configurations and target your scripts to specific pages using their paths. For example, you can use the store.id JavaScript variable to retrieve the shop’s account ID without making an API call, allowing you to include your JavaScript file as follows: <script async src="https://app.com/script/{{ store.id }}.js"></script>.
Minimize External Dependencies: Only load the libraries and external dependencies that are essential for your app. This reduces load times and decreases potential conflicts with other scripts.
Handle double inclusion of your scripts: It’s possible for sellers to incorrectly double include your script, which is common if you’ve had a pre-existing integration that has upgraded to now using embedded scripts via our API. You must correctly handle these cases, and we recommend notifying your users if this occurs to favor the embeddable script and removing the manual scripts they’ve added.
Utilize Apps API for Account-Specific Data: Leverage our Apps API to manage script variables and app configuration data, such as user-specific settings. Rather than using static identifiers, utilize dynamic identifiers like the seller’s shop hostname, accessible via Liquid syntax ({{ store.hostname }}). For more details, refer to our Script Variables and Theme API variables for more info.
Ensure Asynchronous Loading: Structure your scripts to load asynchronously to prevent blocking the rendering of the page. This practice helps maintain a smooth user experience by allowing the rest of the shop’s content to load uninterrupted.
Adhere to Security Best Practices: Always encode and sanitize any data fetched from external sources to protect against XSS (Cross-Site Scripting) and other security vulnerabilities. Ensure that all data communications are performed over HTTPS.
Comprehensive testing with clear fallbacks: Thoroughly test your scripts in multiple scenarios with different browsers to ensure compatibility and functionality across different user settings. Include fallback mechanisms for scenarios where your script fails to load or encounters an error. This ensures that the shop remains functional and provides continuity in user experience.

Account

Accounts are the primary resource of our API. These represent the shops on Big Cartel, and contain the core information and settings.

Account object

Attribute	Type	Description
`id`	integer	The unique identifier for the account.
`subdomain`	string	The unique subdomain for the account on .bigcartel.com.
`store_name`	string	The name of the shop.
`description`	string	A brief description of their shop.
`contact_email`	string	The email address the shop can be contacted at.
`first_name`	string	The shop owner’s first name.
`last_name`	string	The shop owner’s last name.
`url`	string	The URL of the online store, either using a custom domain or the default .bigcartel.com one.
`website`	string	The URL of a external website the account may have, separate from Big Cartel.
`created_at`	timestamp	When the account was created.
`updated_at`	timestamp	When the account was last updated.
`under_maintenance`	boolean	Whether or not the account is in maintenance mode.
`inventory_enabled`	boolean	Whether or not inventory tracking is enabled.
`artists_enabled`	boolean	Whether or not artist categories is enabled.
`currency.id`	string	The unique 3-letter code for the account’s currency.
`currency.name`	string	The name of the account’s currency.
`currency.sign`	string	The symbol used for the account’s currency.
`currency.locale`	string	The locale associated with the account’s currency.
`country.id`	string	The unique 2-letter code for the account’s country.
`country.name`	string	The name of the account’s country.
`account_image.id`	integer	The unique identifier for the account’s image.
`account_image.url`	string	The customizable URL of the account’s image.
`plan.id`	string	The unique identifier for the account’s plan. Possible values are `gold`, `platinum`, `diamond`, or `titanium`.
`plan.name`	string	The name of the account’s plan.
`plan.max_products`	integer	The maximum number of products the account can have on their plan.
`plan.max_images_per_product`	integer	The maximum number of images per product the account can have on their plan.
`plan.monthly_rate`	decimal	The rate the account is billed each month.
`time_zone`	string	The timezone of the account.

Get an account

Get the basic account information.

Request

GET /v1/accounts/{account-id}

Parameters

None.

Example Response

{
  "data": {
    "id": "1",
    "type": "accounts",
    "attributes": {
      "subdomain": "example",
      "store_name": "My example store",
      "description": "An example store",
      "contact_email": "email@example.com",
      "first_name": "Pablo",
      "last_name": "Picasso",
      "url": "http://example.bigcartel.com",
      "website": "http://www.webcrawler.com",
      "created_at": "2014-12-25T00:00:00.000Z",
      "updated_at": "2014-12-25T00:00:00.000Z",
      "under_maintenance": false,
      "inventory_enabled": true,
      "artists_enabled": false,
      "time_zone": "Pacific Time (US & Canada)"
    },
    "links": {
      "self": "https://api.bigcartel.com/v1/accounts/1"
    },
    "relationships": {
      "currency": {
        "data": {
          "type": "currencies",
          "id": "USD"
        }
      },
      "country": {
        "data": {
          "type": "countries",
          "id": "US"
        }
      },
      "plan": {
        "data": {
          "type": "plans",
          "id": "diamond"
        }
      },
      "account_image": {
        "data": {
          "type": "account_images",
          "id": "12345"
        }
      },
      "orders": {
        "links": {
          "related": "https://api.bigcartel.com/v1/accounts/1/orders"
        }
      },
      "categories": {
        "links": {
          "self": "https://api.bigcartel.com/v1/accounts/1/relationships/categories",
          "related": "https://api.bigcartel.com/v1/accounts/1/categories"
        }
      },
      "products": {
        "links": {
          "self": "https://api.bigcartel.com/v1/accounts/1/relationships/products",
          "related": "https://api.bigcartel.com/v1/accounts/1/products"
        }
      }
    }
  },
  "included": [
    {
      "id": "USD",
      "type": "currencies",
      "attributes": {
        "name": "U.S. Dollar",
        "sign": "$",
        "locale": "en-US"
      }
    },
    {
      "id": "US",
      "type": "countries",
      "attributes": {
        "name": "United States"
      }
    },
    {
      "id": "diamond",
      "type": "plans",
      "attributes": {
        "max_products": 100,
        "max_images_per_product": 5,
        "name": "Diamond",
        "monthly_rate": "19.99"
      }
    },
    {
      "id": "12345",
      "type": "account_images",
      "attributes": {
        "url": "https://bigcartel.imgix.net/account_images/12345/filename.jpg?fit=clip&w=1000&h=1000"
      }
    }
  ]
}

Artists

Artists represent a list of all artist categories in a store, used for grouping products together (similar to Categories).

Artist object

Attribute	Type	Description
`id`	string	The unique identifier for the artist.
`name`	string	The name of the artist.
`permalink`	string	The unique permalink for the artist.
`position`	string	The position in which the artist is arranged.

Get all artists

Get all artists for an account.

Request

GET /v1/accounts/{account-id}/artists

Parameters

None.

Example Response

{
  "data": [
    {
      "id": "1",
      "type": "artists",
      "attributes": {
        "name": "Example Artist 1",
        "permalink": "example-artist-1",
        "position": 1
      },
      "links": {
        "self": "https://api.bigcartel.com/v1/accounts/1/artists/1"
      }
    },
    {
      "id": "2",
      "type": "artists",
      "attributes": {
        "name": "Example Artist 2",
        "permalink": "example-artist-2",
        "position": 2
      },
      "links": {
        "self": "https://api.bigcartel.com/v1/accounts/1/artists/2"
      }
    }
  ],
  "meta": {
    "count": "2"
  }
}

Get an artist

Get a specific artist for an account.

Request

GET /v1/accounts/{account-id}/artists/{artist-id}

Parameters

None.

Example Response

{
  "data": {
    "id": "1",
    "type": "artists",
    "attributes": {
      "name": "Example Artist 1",
      "permalink": "example-artist-1",
      "position": 1
    },
    "links": {
      "self": "https://api.bigcartel.com/v1/accounts/1/artists/1"
    }
  }
}

Create an artist

Creates a new artist.

Request

POST /v1/accounts/{account-id}/artists

Parameters

Name	Type	Required	Description
`type`	string	true	The only option right now is artists.
`name`	string	true	The name of the artist.

Response

If successful, we’ll return a 201 Created with the location of the new artist in the Location header and the same body as getting the artist.

Example Request

{
  "data": {
    "type": "artists",
    "attributes": {
      "name": "New Example Artist"
    }
  }
}

Update an artist

Updates a specific artist’s details.

Request

PATCH /v1/accounts/{account-id}/artists/{artist-id}

Parameters

Name	Type	Required	Description
`id`	string	true	The unique identifier for the artist.
`type`	string	true	The only option right now is artists.
`name`	string	true	The name of the artist.

Response

If successful, we’ll return a 200 OK and the same body as getting the artist.

Example Request

{
  "data": {
    "id": "1",
    "type": "artists",
    "attributes": {
      "name": "Updated Example Artist 1"
    }
  }
}

Reposition artists

Repositions the list of artists in the specified order.

Request

PATCH /v1/accounts/{account-id}/relationships/artists

Parameters

Name	Type	Required	Description
`type`	string	true	The only option right now is artists.
`id`	string	true	The unique identifier for the artist.

Response

If successful, we’ll return a 204 No Content response.

Example Request

{
  "data": [
    {
      "type": "artists",
      "id": "1"
    },
    {
      "type": "artists",
      "id": "3"
    },
    {
      "type": "artists",
      "id": "2"
    }
  ]
}

Delete an artist

Deletes a specific artist.

Request

DELETE /v1/accounts/{account-id}/artists/{artist-id}

Parameters

None.

Response

If successful, we’ll return a 204 No Content response.

Attribute	Type	Description
`id`	string	The unique identifier for the category.
`name`	string	The name of the category.
`permalink`	string	The unique permalink for the category.
`position`	string	The position in which the category is arranged.

Name	Type	Required	Description
`type`	string	true	The only option right now is categories.
`name`	string	true	The name of the category.

Name	Type	Required	Description
`id`	string	true	The unique identifier for the category.
`type`	string	true	The only option right now is categories.
`name`	string	true	The name of the category.

Name	Type	Required	Description
`type`	string	true	The only option right now is categories.
`id`	string	true	The unique identifier for the category.

Countries

Countries represent a list of all available countries used for shipping and billing addresses.

Country object

Attribute	Type	Description
`id`	string	The unique 2-letter code for the country.
`name`	string	The full name of the country.

Get all countries

Get a list of all countries sorted alphabetically by name.

Request

GET /v1/countries

Parameters

None.

Example Response

{
  "data":[
    {
      "id":"AF",
      "type":"countries",
      "attributes": {
        "name":"Afghanistan"
      }
    },
    {
      "id":"AL",
      "type":"countries",
      "attributes": {
        "name":"Albania"
    },
    {
      "id":"DZ",
      "type":"countries",
      "attributes": {
        "name":"Algeria"
      }
    },
    ...
    {  
      "id":"ZW",
      "type":"countries",
      "attributes": {
        "name":"Zimbabwe"
      }
    }
  ],
  "meta":{
    "count":"247"
  }
}

Discounts

Discounts represent a list of all discounts in a store.

Discount object

Attribute	Type	Description
`id`	string	The unique identifier for the discount.
`name`	string	The description of the discount.
`code`	string	The code customers enter to use the discount.
`active_at`	timestamp	The date the discount is active.
`expires_at`	timestamp	The date the discount expires.
`requirement_type`	string	Possible values are any_order, minimum_cart_total, or minimum_cart_quantity.
`expiration_type`	string	Possible values are never, on_date, or on_limit.
`reward_type`	string	Possible values are percent_discount, flat_rate_discount, or free_shipping.
`application_type`	string	Possible values are all, category, or product.
`percent_discount`	integer	The percentage discount amount.
`flat_rate_discount`	decimal	The flat rate discount amount.
`use_limit`	integer	The limit for how many times the discount can be used.
`use_count`	integer	The number of times the discount has been used.
`minimum_cart_total`	decimal	The minimum cart total required to use the discount.
`minimum_cart_quantity`	integer	The minimum amount of items in the cart required to use the discount.

Get all discounts

Get all discounts for an account.

Request

GET /v1/accounts/{account-id}/discounts

Parameters

Name	Type	Required	Description
`filter`	string	false	Filter discounts using `status`

Status example

Use status to filter discounts with a status of active or expired.

GET /v1/accounts/{account-id}/discounts?filter[status]=active

Example Response

{
  "data": [
    {
      "id": "1",
      "type": "discounts",
      "attributes": {
        "name": "10% Off Product Name",
        "code": "TENPERCENT",
        "active_at": "2017-02-24T15:27:00.000Z",
        "expires_at": null,
        "requirement_type": "any_order",
        "expiration_type": "never",
        "reward_type": "percent_discount",
        "application_type": "product",
        "percent_discount": 10,
        "flat_rate_discount": null,
        "use_limit": null,
        "use_count": 0,
        "minimum_cart_total": null,
        "minimum_cart_quantity": null
      },
      "links": {
        "self": "https://api.bigcartel.com/v1/accounts/1/discounts/1"
      },
      "relationships": {
        "product": {
          "data": {
            "type": "products",
            "id": "1"
          }
        },
        "category": {
          "data": null
        }
      }
    },
    {
      "id": "2",
      "type": "discounts",
      "attributes": {
        "name": "Free Shipping",
        "code": "FREESHIPPING",
        "active_at": "2016-12-25T06:00:00.000Z",
        "expires_at": null,
        "requirement_type": "any_order",
        "expiration_type": "on_limit",
        "reward_type": "free_shipping",
        "application_type": "all",
        "percent_discount": null,
        "flat_rate_discount": null,
        "use_limit": 5,
        "use_count": 0,
        "minimum_cart_total": null,
        "minimum_cart_quantity": null
      },
      "links": {
        "self": "https://api.bigcartel.com/v1/accounts/1/discounts/2"
      },
      "relationships": {
        "product": {
          "data": null
        },
        "category": {
          "data": null
        }
      }
    },
    {
      "id": "3",
      "type": "discounts",
      "attributes": {
        "name": "Summer sale - 20% off",
        "code": "SUMMERSALE",
        "active_at": "2017-06-01T14:18:00.000Z",
        "expires_at": "2017-08-31T05:00:00.000Z",
        "requirement_type": "any_order",
        "expiration_type": "on_date",
        "reward_type": "percent_discount",
        "application_type": "all",
        "percent_discount": 20,
        "flat_rate_discount": null,
        "use_limit": null,
        "use_count": 0,
        "minimum_cart_total": null,
        "minimum_cart_quantity": null
      },
      "links": {
        "self": "https://api.bigcartel.com/v1/accounts/1/discounts/3"
      },
      "relationships": {
        "product": {
          "data": null
        },
        "category": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "count": "3"
  },
  "included": [
    {
      "id": "1",
      "type": "products",
      "attributes": {
        "name": "Product Name",
        "permalink": "product-name",
        "status": "active",
        "description": "This is a sample product description",
        "created_at": "2014-12-25T00:00:00.000Z",
        "updated_at": "2014-12-25T00:00:00.000Z",
        "default_price": "20.0",
        "on_sale": false,
        "position": 1,
        "url": "http://example.bigcartel.com/product/product-name",
        "primary_image_url": "https://images.bigcartel.com/some_resource/12345/-/example1.jpg"
      },
      "links": {
        "self": "https://api.bigcartel.com/v1/accounts/1/products/1"
      },
      "relationships": {
        "options": {
          "data": [
            {
              "type": "product_options",
              "id": "1"
            },
            {
              "type": "product_options",
              "id": "2"
            }
          ]
        },
        "categories": {
          "data": [
            {
              "type": "categories",
              "id": "1"
            },
            {
              "type": "categories",
              "id": "2"
            },
            {
              "type": "categories",
              "id": "3"
            }
          ]
        },
        "artists": {
          "data": [
            {
              "type": "artists",
              "id": "1"
            }
          ]
        },
        "shipping_options": {
          "data": [
            {
              "type": "shipping_options",
              "id": "1"
            }
          ]
        },
        "images": {
          "data": [
            {
              "type": "product_images",
              "id": "1"
            },
            {
              "type": "product_images",
              "id": "2"
            },
            {
              "type": "product_images",
              "id": "3"
            }
          ]
        }
      }
    }
  ],
  "links": {}
}

Get a discount

Get a specific discount for an account.

Request

GET /v1/accounts/{account-id}/discounts/{discount-id}

Parameters

None.

Example Response

{
  "data": {
    "id": "1",
    "type": "discounts",
    "attributes": {
      "name": "10% Off Product Name",
      "code": "TENPERCENT",
      "active_at": "2017-02-24T15:27:00.000Z",
      "expires_at": null,
      "requirement_type": "any_order",
      "expiration_type": "never",
      "reward_type": "percent_discount",
      "application_type": "product",
      "percent_discount": 10,
      "flat_rate_discount": null,
      "use_limit": null,
      "use_count": 0,
      "minimum_cart_total": null,
      "minimum_cart_quantity": null
    },
    "links": {
      "self": "https://api.bigcartel.com/v1/accounts/1/discounts/1"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "products",
          "id": "1"
        }
      },
      "category": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "products",
      "attributes": {
        "name": "Product Name",
        "permalink": "product-name",
        "status": "active",
        "description": "This is a sample product description",
        "created_at": "2014-12-25T00:00:00.000Z",
        "updated_at": "2014-12-25T00:00:00.000Z",
        "default_price": "20.0",
        "on_sale": false,
        "position": 1,
        "url": "http://example.bigcartel.com/product/product-name",
        "primary_image_url": "https://images.bigcartel.com/some_resource/12345/-/example1.jpg"
      },
      "links": {
        "self": "https://api.bigcartel.com/v1/accounts/1/products/1"
      },
      "relationships": {
        "options": {
          "data": [
            {
              "type": "product_options",
              "id": "1"
            },
            {
              "type": "product_options",
              "id": "2"
            }
          ]
        },
        "categories": {
          "data": [
            {
              "type": "categories",
              "id": "1"
            },
            {
              "type": "categories",
              "id": "2"
            },
            {
              "type": "categories",
              "id": "3"
            }
          ]
        },
        "artists": {
          "data": [
            {
              "type": "artists",
              "id": "1"
            }
          ]
        },
        "shipping_options": {
          "data": [
            {
              "type": "shipping_options",
              "id": "1"
            }
          ]
        },
        "images": {
          "data": [
            {
              "type": "product_images",
              "id": "1"
            },
            {
              "type": "product_images",
              "id": "2"
            },
            {
              "type": "product_images",
              "id": "3"
            }
          ]
        }
      }
    }
  ]
}

Create a discount

Creates a new discount.

Request

POST /v1/accounts/{account-id}/discounts

Parameters

Name	Type	Required	Description
`type`	string	true	The only option right now is discounts.
`name`	string	true	The description of the discount.
`code`	string	true	The code customers enter to use the discount.
`active_at`	timestamp	true	The date the discount is active.
`expires_at`	timestamp	false	The date the discount expires. Must be a date in the future. Required when `expiration_type` is set to on_date.
`requirement_type`	string	true	Possible values are any_order, minimum_cart_total, or minimum_cart_quantity.
`expiration_type`	string	true	Possible values are never, on_date, or on_limit.
`reward_type`	string	true	Possible values are percent_discount, flat_rate_discount, or free_shipping.
`application_type`	string	true	Possible values are all, category, or product.
`percent_discount`	integer	false	The percentage discount amount. Must be less than 100. Required when `reward_type` is set to percent_discount.
`flat_rate_discount`	decimal	false	The flat rate discount amount. Required when `reward_type` is set to flat_rate_discount.
`use_limit`	integer	false	The limit for how many times the discount can be used. Required when `expiration_type` is set to on_limit.
`minimum_cart_total`	decimal	false	The minimum cart total required to use the discount. Required when `requirement_type` is set to minimum_cart_total.
`minimum_cart_quantity`	integer	false	The minimum amount of items in the cart required to use the discount. Required when `requirement_type` is set to minimum_cart_quantity.

The following parameters are only required when creating a discount that applies to specific categories or products - application_type will also need to be set to category or product.

Name	Type	Required	Description
`category[].type`	string	true	The only option right now is categories.
`category[].id`	integer	true	The unique identifier of the category.

`product[].type`	string	true	The only option right now is products.
`product[].id`	integer	true	The unique identifier of the product.

Response

If successful, we’ll return a 201 Created with the location of the new discount in the Location header and the same body as getting the discount.

Creates a discount to give customers free shipping on all items in a specific category.

{
  "data": {
    "type": "discounts",
    "attributes": {
      "name": "Free Shipping Discount",
      "code": "FREESHIPPING",
      "active_at": "2016-12-25T00:00:00.000Z",
      "requirement_type": "any_order",
      "reward_type": "free_shipping",
      "application_type": "category",
      "expiration_type": "never"
    },
    "relationships": {
      "category": {
        "data": {
          "type": "categories",
          "id": "1"
        }
      }
    }
  }
}

Creates a discount to give customers a flat-rate discount on their entire order if they order at least 5 items.

{
  "data": {
    "type": "discounts",
    "attributes": {
      "name": "Flat Rate Discount",
      "code": "FLATRATE",
      "active_at": "2014-12-25T00:00:00.000Z",
      "requirement_type": "minimum_cart_quantity",
      "reward_type": "flat_rate_discount",
      "application_type": "all",
      "expiration_type": "never",
      "flat_rate_discount": "10.0",
      "minimum_cart_quantity": 5
    }
  }
}

Update a discount

Updates a specific discount’s details.

Request

PATCH /v1/accounts/{account-id}/discounts/{discount-id}

Parameters

Name	Type	Required	Description
`type`	string	true	The only option right now is discounts.
`name`	string	true	The description of the discount.
`code`	string	true	The code customers enter to use the discount.
`active_at`	timestamp	false	The date the discount is active.
`expires_at`	timestamp	false	The date the discount expires. Must be a date in the future. Required when `expiration_type` is set to on_date.
`requirement_type`	string	true	Possible values are any_order, minimum_cart_total, or minimum_cart_quantity.
`expiration_type`	string	true	Possible values are never, on_date, or on_limit.
`reward_type`	string	true	Possible values are percent_discount, flat_rate_discount, or free_shipping.
`application_type`	string	true	Possible values are all, category, or product.
`percent_discount`	integer	false	The percentage discount amount. Must be less than 100. Required when `reward_type` is set to percent_discount.
`flat_rate_discount`	decimal	false	The flat rate discount amount. Required when `reward_type` is set to flat_rate_discount.
`use_limit`	integer	false	The limit for how many times the discount can be used. Required when `expiration_type` is set to on_limit.
`minimum_cart_total`	decimal	false	The minimum cart total required to use the discount. Required when `requirement_type` is set to minimum_cart_total.
`minimum_cart_quantity`	integer	false	The minimum amount of items in the cart required to use the discount. Required when `requirement_type` is set to minimum_cart_quantity.

The following parameters are only required when updating a discount that applies to specific categories or products - application_type will also need to be set to category or product.

Name	Type	Required	Description
`category[].type`	string	true	The only option right now is categories.
`category[].id`	integer	true	The unique identifier of the category.

`product[].type`	string	true	The only option right now is products.
`product[].id`	integer	true	The unique identifier of the product.

Response

If successful, we’ll return a 200 OK and the same body as getting the discount.

Example Request

Update a discount to give customers a $10 flat rate discount on any order with at least 5 items.

{
  "data": {
  	"id": "1",
    "type": "discounts",
    "attributes": {
      "name": "Flat Rate Discount",
      "code": "FLATRATE",
      "active_at": "2023-08-01T00:00:00.000Z",
      "requirement_type": "minimum_cart_quantity",
      "reward_type": "flat_rate_discount",
      "application_type": "all",
      "expiration_type": "never",
      "flat_rate_discount": "10.0",
      "minimum_cart_quantity": 5
    }
  }
}

Update a discount to give customers a 15% discount on a specific product.

{
  "data": {
  	"id": "1",
    "type": "discounts",
    "attributes": {
      "name": "15% off a red shirt",
      "code": "15OFF",
      "requirement_type": "any_order",
      "reward_type": "percent_discount",
      "application_type": "product",
      "expiration_type": "never",
      "percent_discount": 15
    },
    "relationships": {
      "product":{
        "data": {
            "type": "products",
            "id": 1234567
        }
      }
    }
  }
}

Delete a discount

Deletes a specific discount.

Request

DELETE /v1/accounts/{account-id}/discounts/{discount-id}

Parameters

None.

Response

If successful, we’ll return a 204 No Content response.

Orders

Orders represent a purchase someone has made from a store, and contains all of the information required to review the order, ship it to the buyer, and track it’s shipping and payment status.

Order object

Attribute	Type	Description
`id`	string	The unique identifier for the order.
`item_count`	integer	The number of items in the order.
`item_total`	decimal	The total price of all items.
`discount_total`	decimal	The total price of all discounts.
`shipping_total`	decimal	The total price of all shipping costs.
`tax_total`	decimal	The total price of all taxes.
`total`	decimal	The total price of everything.
`customer_first_name`	string	The first name of the buyer.
`customer_last_name`	string	The last name of the buyer.
`customer_email`	string	The email address of the buyer.
`customer_phone_number`	string	The phone number of the buyer.
`customer_opted_in_to_marketing`	boolean	Whether or not the buyer opted-in to marketing at checkout. Marketing apps must honor this.
`customer_note`	string	An optional note about the order. Buyer visible.
`shipping_address_1`	string	The street address for shipping.
`shipping_address_2`	string	An optional addition to the street address for shipping.
`shipping_city`	string	The city of the shipping address.
`shipping_state`	string	The state or province of the shipping address.
`shipping_zip`	string	The zip or postal code of the shipping address.
`shipping_country_id`	string	The unique 2-letter code for the order’s country.
`shipping_country_name`	string	The name of the order’s country.
`shipping_latitude`	integer	The latitude of the shipping address.
`shipping_longitude`	integer	The longitude of the shipping address.
`shipping_status`	string	The status of shipping the order. Possible values are `shipped` and `unshipped`.
`payment_status`	string	The status of payment for the order. Possible values are `unpaid`, `pending`, `completed`, `failed`, and `invalid`.
`created_at`	timestamp	When the order was created.
`updated_at`	timestamp	When the order was last updated.
`completed_at`	timestamp	When the order was placed and paid for.
`currency.id`	string	The unique 3-letter code for the order’s currency.
`currency.name`	string	The name of the order’s currency.
`currency.sign`	string	The symbol used for the order’s currency.
`currency.locale`	string	The locale associated with the order’s currency.
`events[].id`	integer	The unique identifier of the order event.
`events[].message`	string	A message describing the order event.
`events[].created_at`	timestamp	When the order event was created.
`items[].id`	integer	The unique identifier of the order item.
`items[].product_name`	string	The name of the item’s product.
`items[].product_option_name`	string	The name of the item’s product option.
`items[].quantity`	integer	The quantity of the item.
`items[].price`	decimal	The price of the item.
`items[].total`	decimal	The total price of the item, `quantity` multiplied by `price`.
`items[].image_url`	string	The customizable URL of the product image.
`items[].product_id`	string	The unique identifier of the product.
`items[].product_option_id`	string	The unique identifier of the product option.
`transactions[].id`	integer	The unique identifier of the order transaction.
`transactions[].label`	string	A message describing the transaction.
`transactions[].amount`	decimal	The total price of the transaction.
`transactions[].processor`	string	The name of the payment processor. Possible values are `cash`, `paypal_standard`, `paypal_express`, and `stripe`.
`transactions[].processor_id`	string	The payment processor’s transaction ID.
`transactions[].processor_url`	string	The URL to view the transaction on the processor’s website.
`transactions[].currency.id`	integer	The unique 3-letter code for the transaction’s currency.
`transactions[].currency.name`	string	The name of the transaction’s currency.
`transactions[].currency.sign`	string	The symbol used for the transaction’s currency.
`transactions[].currency.locale`	string	The locale associated with the transaction’s currency.
`adjustments[].id`	integer	The unique identifier of the order adjustment.
`adjustments[].amount`	decimal	The price of the adjustment.
`adjustments[].label`	string	A message describing the adjustment.

Get all orders

Get all orders for an account.

Request

GET /v1/accounts/{account-id}/orders

Parameters

Name	Type	Required	Description
`search`	string	false	Search orders that match the customer name (`customer_first_name` + `customer_last_name`), `customer_email`, and `id` attributes.
`filter`	string	false	Filter orders using the `shipping_status`, `completed_at_from`, `completed_at_to`, `updated_at_from` and `updated_at_to`.
`sort`	string	false	Sort orders using the specified attribute, in ascending order by default. Prefix the value with `-` to specify descending order. Allowed values are completed_at, created_at, and updated_at.

Search example

Get all orders that match example@example.com.

GET /v1/accounts/{account-id}/orders?search=example@example.com

Filter examples

Use shipping_status to filter orders using shipped or unshipped.

GET /v1/accounts/{account-id}/orders?filter[shipping_status]=shipped

Use completed_at_from to filter orders based on their completion date (placed and paid for). This is the starting range of the filter.

GET /v1/accounts/{account-id}/orders?filter[completed_at_from]=2024-02-1

Use completed_at_to to filter orders based on their completion date (placed and paid for). This is the end range of the filter and if omitted the API always assumes now/today.

GET /v1/accounts/{account-id}/orders?filter[completed_at_to]=2024-02-28

Use completed_at_from and completed_at_to in combination to filter a specific order completed date range.

GET /v1/accounts/{account-id}/orders?filter[completed_at_from]=2024-02-01&filter[completed_at_to]=2024-02-28

Sort example

Get all orders, sorted by the time they were created, in descending order.

GET /v1/accounts/{account-id}/orders?sort=-created_at

Example Response

{
  "data": [
    {
      "id": "LMFN-543196",
      "type": "orders",
      "attributes": {
        "item_count": 1,
        "item_total": "100.1",
        "discount_total": "10.0",
        "shipping_total": "10.0",
        "tax_total": "0.0",
        "total": "100.1",
        "customer_first_name": "Joe",
        "customer_last_name": "Somebody",
        "customer_email": "joe@somebody.com",
        "customer_phone_number": "+1 (123) 456-7890",
        "customer_opted_in_to_marketing": false,
        "customer_note": "Created by Joe",
        "shipping_address_1": "123 some street",
        "shipping_address_2": "#123",
        "shipping_city": "Somewhere",
        "shipping_state": "UT",
        "shipping_zip": "64801",
        "shipping_country_id": "US",
        "shipping_country_name": "United States",
        "shipping_latitude": null,
        "shipping_longitude": null,
        "shipping_status": "unshipped",
        "payment_status": "completed",
        "created_at": "2014-12-25T00:00:00.000Z",
        "updated_at": "2014-12-25T00:00:00.000Z",
        "completed_at": "2014-12-25T00:00:00.000Z"
      },
      "links": {
        "self": "https://api.bigcartel.com/v1/accounts/1/orders/LMFN-543196"
      },
      "relationships": {
        "currency": {
          "data": {
            "type": "currencies",
            "id": "USD"
          }
        },
        "shipping_country": {
          "data": {
            "type": "countries",
            "id": "US"
          }
        },
        "events": {
          "data": [
            {
              "type": "order_events",
              "id": "1"
            }
          ]
        },
        "items": {
          "data": [
            {
              "type": "order_line_items",
              "id": "2"
            }
          ]
        },
        "transactions": {
          "data": [
            {
              "type": "order_transactions/payments",
              "id": "3"
            }
          ]
        },
        "adjustments": {
          "data": [
            {
              "type": "order_adjustments/shipping",
              "id": "4"
            },
            {
              "type": "order_adjustments/tax",
              "id": "5"
            },
            {
              "type": "order_adjustments/discount",
              "id": "6"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "count": 25
  },
  "included": [
    {
      "id": "USD",
      "type": "currencies",
      "attributes": {
        "name": "U.S. Dollar",
        "sign": "$",
        "locale": "en-US"
      }
    },
    {
      "id": "US",
      "type": "countries",
      "attributes": {
        "name": "United States"
      }
    },
    {
      "id": "1",
      "type": "order_events",
      "attributes": {
        "created_at": "2014-12-25T00:00:00.000Z",
        "message": "Payment completed"
      }
    },
    {
      "id": "2",
      "type": "order_line_items",
      "attributes": {
        "product_name": "This product",
        "product_option_name": "This option",
        "product_id": "7",
        "product_option_id": "8",
        "quantity": 1,
        "price": "100.0",
        "total": "100.0",
        "image_url": "https://images.bigcartel.com/some_resource/12345/-/example.jpg"
      },
      "relationships": {
        "product": {
          "data": {
            "type": "product",
            "id": "7"
          }
        },
        "product_option": {
          "data": {
            "type": "product_option",
            "id": "8"
          }
        }
      }
    },
    {
      "id": "3",
      "type": "order_transactions/payments",
      "attributes": {
        "label": "Visa ending in 1234",
        "amount": "100.0",
        "processor": "stripe",
        "processor_id": "ex_123456789",
        "processor_url": "https://manage.stripe.com/test/payments/ex_123456789"
      },
      "data": {
        "currency": {
          "data": {
            "type": "currencies",
            "id": "USD"
          }
        }
      }
    },
    {
      "id": "4",
      "type": "order_adjustments/shipping",
      "attributes": {
        "amount": "10.0",
        "label": "Shipping charges"
      }
    },
    {
      "id": "5",
      "type": "order_adjustments/tax",
      "attributes": {
        "amount": "0.1"
      }
    },
    {
      "id": "6",
      "type": "order_adjustments/discount",
      "attributes": {
        "amount": "10.0",
        "label": "[FREESHIPPING] Free shipping discount"
      }
    }
  ],
  "links": {
    "next": "https://api.bigcartel.com/v1/accounts/1/orders?page%5Blimit%5D=10&page%5Boffset%5D=10",
    "last": "https://api.bigcartel.com/v1/accounts/1/orders?page%5Blimit%5D=10&page%5Boffset%5D=10"
  }
}

Get an order

Get a specific order for an account.

Request

GET /v1/accounts/{account-id}/orders/{order-id}

Parameters

None.

Example Response

{
  "data": {
    "id": "LMFN-543196",
    "type": "orders",
    "attributes": {
      "item_count": 1,
      "item_total": "100.1",
      "discount_total": "10.0",
      "shipping_total": "10.0",
      "tax_total": "0.0",
      "total": "100.1",
      "customer_first_name": "Joe",
      "customer_last_name": "Somebody",
      "customer_email": "joe@somebody.com",
      "customer_phone_number": "+1 (123) 456-7890",
      "customer_opted_in_to_marketing": false,
      "customer_note": "Request: Floral pattern with daisies",
      "shipping_address_1": "123 some street",
      "shipping_address_2": "#123",
      "shipping_city": "Somewhere",
      "shipping_state": "UT",
      "shipping_zip": "64801",
      "shipping_country_id": "US",
      "shipping_country_name": "United States",
      "shipping_latitude": null,
      "shipping_longitude": null,
      "shipping_status": "unshipped",
      "payment_status": "completed",
      "created_at": "2014-12-25T00:00:00.000Z",
      "updated_at": "2014-12-25T00:00:00.000Z",
      "completed_at": "2014-12-25T00:00:00.000Z"
    },
    "links": {
      "self": "https://api.bigcartel.com/v1/accounts/1/orders/LMFN-543196"
    },
    "relationships": {
      "currency": {
        "data": {
          "type": "currencies",
          "id": "USD"
        }
      },
      "shipping_country": {
        "data": {
          "type": "countries",
          "id": "US"
        }
      },
      "events": {
        "data": [
          {
            "type": "order_events",
            "id": "1"
          }
        ]
      },
      "items": {
        "data": [
          {
            "type": "order_line_items",
            "id": "2"
          }
        ]
      },
      "transactions": {
        "data": [
          {
            "type": "order_transactions/payments",
            "id": "3"
          }
        ]
      },
      "adjustments": {
        "data": [
          {
            "type": "order_adjustments/shipping",
            "id": "4"
          },
          {
            "type": "order_adjustments/tax",
            "id": "5"
          },
          {
            "type": "order_adjustments/discount",
            "id": "6"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "USD",
      "type": "currencies",
      "attributes": {
        "name": "U.S. Dollar",
        "sign": "$",
        "locale": "en-US"
      }
    },
    {
      "id": "US",
      "type": "countries",
      "attributes": {
        "name": "United States"
      }
    },
    {
      "id": "1",
      "type": "order_events",
      "attributes": {
        "created_at": "2014-12-25T00:00:00.000Z",
        "message": "Payment completed"
      }
    },
    {
      "id": "2",
      "type": "order_line_items",
      "attributes": {
        "product_name": "This product",
        "product_option_name": "This option",
        "product_id": "7",
        "product_option_id": "8",
        "quantity": 1,
        "price": "100.0",
        "total": "100.0",
        "image_url": "https://images.bigcartel.com/some_resource/12345/-/example.jpg"
      },
      "relationships": {
        "product": {
          "data": {
            "type": "product",
            "id": "7"
          }
        },
        "product_option": {
          "data": {
            "type": "product_option",
            "id": "8"
          }
        }
      }
    },
    {
      "id": "3",
      "type": "order_transactions/payments",
      "attributes": {
        "label": "Visa ending in 1234",
        "amount": "100.0",
        "processor": "stripe",
        "processor_id": "ex_123456789",
        "processor_url": "https://manage.stripe.com/test/payments/ex_123456789"
      },
      "relationships": {
        "currency": {
          "data": {
            "type": "currencies",
            "id": "USD"
          }
        }
      }
    },
    {
      "id": "4",
      "type": "order_adjustments/shipping",
      "attributes": {
        "amount": "10.0",
        "label": "Shipping charges"
      }
    },
    {
      "id": "5",
      "type": "order_adjustments/tax",
      "attributes": {
        "amount": "0.1"
      }
    },
    {
      "id": "6",
      "type": "order_adjustments/discount",
      "attributes": {
        "amount": "10.0",
        "label": "[FREESHIPPING] Free shipping discount"
      }
    }
  ]
}

Update an order

Updates a specific order’s details.

Request

PATCH /v1/accounts/{account-id}/orders/{order-id}

Parameters

Name	Type	Required	Description
`id`	string	true	The unique identifier for the order.
`type`	string	true	The only option right now is orders.
`customer_first_name`	string	false	The first name of the buyer.
`customer_last_name`	string	false	The last name of the buyer.
`customer_email`	string	false	The email address of the buyer.
`customer_phone_number`	string	false	The phone number of the buyer.
`customer_note`	string	false	A note about the order. Visible to the buyer.
`shipping_address_1`	string	false	The street address for shipping.
`shipping_address_2`	string	false	An optional addition to the street address for shipping.
`shipping_city`	string	false	The city of the shipping address.
`shipping_state`	string	false	The state or province of the shipping address.
`shipping_zip`	string	false	The zip or postal code of the shipping address.
`shipping_country_id`	string	false	The unique 2-letter code for the order’s country.
`shipping_status`	string	false	The status of shipping the order. Possible values are shipped or unshipped. An order cannot be set to shipped if it has at least one shipment and any unshipped line items. The `shipping_status` value will just be ignored.

Response

If successful, we’ll return a 200 OK and the same body as getting the order.

Example Request

{
  "data": {
    "id": "LMFN-543196",
    "type": "orders",
    "attributes": {
      "shipping_status": "shipped"
    }
  }
}

Pages

Pages allows you to interact with pages in a user’s store.

This can be used to create powerful experiences that simplify your app’s integration into a Big Cartel shop. For example, after your oauth app is authorized for a shop, you could automatically create a page that includes the necessary javascript to embed your new feature without the user needing to copy and paste code.

Page object

Attribute	Type	Description
`id`	string	The unique identifier for the page.
`path`	string	The unique path for the page.
`category`	string	The category type of the page. Pages that are part of a theme are `Theme` and custom pages are `Custom`.
`content`	string	The content of the custom page, truncated to max of 2048 characters. This is only returned for custom pages.
`use_layout`	boolean	Whether the custom page inherits the layout from the theme.

Get all pages

Get all pages for a store. category attribute indicates whether a page is a part of a store’s theme or a custom page created by the seller.

Request

GET /v1/accounts/{account-id}/pages

Parameters

None.

{
  "data": [
    {
      "id": "1112",
      "type": "pages",
      "attributes": {
        "name": "Cart",
        "path": "/cart",
        "category": "Theme"
      }
    },
    {
      "id": "1113",
      "type": "pages",
      "attributes": {
        "name": "Contact",
        "path": "/contact",
        "category": "Theme"
      }
    },
    {
      "id": "1114",
      "type": "pages",
      "attributes": {
        "name": "Home",
        "path": "/",
        "category": "Theme"
      }
    },
    {
      "id": "1115",
      "type": "pages",
      "attributes": {
        "name": "Maintenance",
        "path": "/maintenance",
        "category": "Theme"
      }
    },
    {
      "id": "1116",
      "type": "pages",
      "attributes": {
        "name": "Product",
        "path": "/product",
        "category": "Theme"
      }
    },
    {
      "id": "1117",
      "type": "pages",
      "attributes": {
        "name": "Products",
        "path": "/products",
        "category": "Theme"
      }
    },
    {
      "id": "1118",
      "type": "pages",
      "attributes": {
        "name": "FAQ",
        "path": "/frequently-asked-questions",
        "category": "Custom"
      }
    }
  ],
  "meta": {
    "count": "7"
  },
  "included": [],
  "links": {}
}

Get a page

Get a pages for a store. category attribute indicates whether a page is a part of a store’s theme or a custom page created by the seller.

Request

GET /v1/accounts/{account-id}/pages/{page_id}

Parameters

None.

Example of a custom page:

{
  "data":
    {
      "id": "1112",
      "type": "pages",
      "attributes": {
        "name": "Blog",
        "path": "/blog",
        "category": "Custom",
        "content": "<strong>hello</strong> world!",
        "use_layout": true
      }
    }
}

Example of a Theme page:

{
  "data":
    {
      "id": "1116",
      "type": "pages",
      "attributes": {
        "name": "Products",
        "path": "/products",
        "category": "Theme"
      }
    }
}

Create a page

Creates a new custom page.

New pages are always in draft. To appear in a shop publicly, the seller must publish their shop from their Big Cartel shop designer.

Request

POST /v1/accounts/{account-id}/pages

Parameters

Name	Type	Required	Description
`type`	string	true	The only option right now is pages.
`name`	string	true	The name of the page. The path for the page is automatically derived from the name (e.g. `My Blog` -> `/my-blog`).
`content`	string	false	The page content.
`use_layout`	string	false	Whether the page should inherit from the store’s theme. By default this is `true`.

Response

If successful, we’ll return 200 status code with a response confirming the page attributes.

Example Request

{
  "data": {
    "type": "pages",
    "attributes": {
      "name": "My Blog",
      "content": "<strong>hello</strong> world"
    }
  }
}

Example Response

{
  "data": {
    "id": "456",
    "type": "pages",
    "attributes": {
      "name": "My Blog",
      "path": "/my-blog",
      "category": "Custom",
      "content": "<strong>hello</strong> world",
      "use_layout": true
    }
  }
}

Update a page

Updates a specific page. Only custom pages can be updated.

Request

PATCH /v1/accounts/{account-id}/pages/{page-id}

Parameters

Name	Type	Required	Description
`type`	string	true	The only option right now is pages.
`name`	string	true	The name of the page. The path for the page is automatically derived from the name (e.g. `My Blog` -> `/my-blog`).
`content`	string	false	The page content. If not provided the existing content remains untouched.
`use_layout`	string	false	Whether the page should inherit from the store’s theme. By default this is `true`.

Response

If successful, we’ll return a 200 OK and the same body as get a page.

Pages best practices

Here are the guidelines, best practices, and considerations when using our Pages API:

Design and build for the best user experience: New custom pages created through the API are always initially created in draft, it requires users to do a publish in their Big Cartel shop designer for the pages to be publicly visible in their store. Build the correct user experience and messaging which communicates this information to the user from your app so there is a seamless experience from your app to Big Cartel
Consider using the Pages API: The most common case for your integration is going to be to create a new custom page when you need custom code embeds in a user’s store. However, if you want to build a robust experience that allows a user to amend an existing page, use our Pages API to fetch page information to present the user the option to use an existing page, then use the Page Update API appropriately.
Clearly communicate destructive actions: Updating an existing page can be a destructive action since you can overwrite all the content. Always provide an option to amend your content to the existing page without forcing a complete replacement. If you do want to overwrite a page’s content in entirety, clearly communicate this to the user so they are sufficiently aware of the risks.
Add code comments: When creating pages with custom content, ensure you add comments to clarify ownership and purpose of the code. e.g. .
Handle Possible Conflicts with Embeddable Scripts: If you are using our Embeddable Scripts, ensure you handle potential conflicts with any scripts you add to a custom page.
Utilize Built-in JavaScript Variables: We provide many useful variables for use within your custom page code, which can save you time. For instance, use {{store.id}} to get a store’s ID as a unique identifier, such as in the example: <script async src="https://app.com/script/{{ store.id }}.js"></script>.
Minimize External Dependencies: Only load libraries and external dependencies that are essential for your app. This reduces load times and decreases potential conflicts with other scripts.
Do Not Assume Ownership of Pages: Custom pages can be edited by the user and other apps outside of your workflow, so you cannot assume a page remains unchanged.
Comprehensive Testing with Clear Fallbacks: Thoroughly test your integrations that involve creating, updating, or retrieving custom pages. Include fallback mechanisms to ensure the shop remains functional and provides a great user experience.

Products

Products represent a list of all products in a store.

Product object

Attribute	Type	Description
`id`	string	The unique identifier for the product.
`name`	string	The name of the product.
`permalink`	string	The unique permalink for the product.
`status`	string	The status of the product. Possible values are `active`, `hidden`, `sold_out`, or `coming_soon`.
`description`	string	The description of the product.
`created_at`	timestamp	When the product was created.
`updated_at`	timestamp	When the product was last updated.
`default_price`	decimal	The default price of the product.
`on_sale`	boolean	Whether or not the product is on sale.
`position`	integer	The position in which the product is arranged.
`url`	string	The full URL to access the product.
`primary_image_url`	string	The primary image URL of the product.
`options[].id`	integer	The unique identifier for the product option.
`options[].name`	string	The name of the product option.
`options[].price`	decimal	The price of the product option.
`options[].quantity`	integer	The quantity in stock of the product option.
`options[].sold`	integer	The number of times the product option has been sold.
`artists[].id`	integer	The unique identifier for the artist.
`artists[].name`	string	The name of the artist.
`artists[].permalink`	string	The unique permalink for the artist.
`artists[].position`	string	The position in which the artist is arranged.
`categories[].id`	integer	The unique identifier for the category.
`categories[].name`	string	The name of the category.
`categories[].permalink`	string	The unique permalink for the category.
`categories[].position`	string	The position in which the category is arranged.
`shipping_options[].id`	integer	The unique identifier for the shipping option.
`shipping_options[].price_alone`	decimal	The shipped alone amount for the shipping area.
`shipping_options[].price_with_others`	decimal	The shipped with others amount for the shipping area.
`shipping_options[].country.id`	string	The unique 2-letter code for the product shipping area’s country.
`images[].id`	integer	The unique identifier for product image.
`images[].url`	string	The customizable URL of the product image.

Get all products

Get all products for an account.

Request

GET /v1/accounts/{account-id}/products

Parameters

Name	Type	Required	Description
`filter`	string	false	Filter products using `status`, `category_id`, `artist_id`, `quantity_gte`, or `quantity_lte`. Category and Artist IDs attribute allows a comma separated list of values.
`search`	string	false	Search products by name. Searches are case insensitive and by default are substring searches. Use `search_type` to search with exact match.
`search_type`	string	false	Specifies the type of search using either `substring` or `exact`. By default searches are always substring searches.

Search examples

Return all products with a name that matches substring case-insensitive search on “foo”.

GET /v1/accounts/{account-id}/products?search=foo

Return all products with a name that matches exact case-insensitive search on “foo”.

GET /v1/accounts/{account-id}/products?search=foo&search_type=exact

Filter examples

Use status to filter products using active, coming_soon, hidden, or sold_out.

GET /v1/accounts/{account-id}/products?filter[status]=sold_out

Use category_id to filter products by category.

GET /v1/accounts/{account-id}/products?filter[category_id]=1,2,3

Use artist_id to filter products by artist.

GET /v1/accounts/{account-id}/products?filter[artist_id]=1,2,3

Use quantity_gte to filter products by inventory quantity >= 0

GET /v1/accounts/{account-id}/products?filter[quantity_gte]=1

Use quantity_gte and quantity_lte to filter products with inventory quantities 5-100 (inclusive).

GET /v1/accounts/{account-id}/products?filter[quantity_gte]=5&filter[quantity_lte]=100

Example Response

{
  "data": [
    {
      "id": "1",
      "type": "products",
      "attributes": {
        "name": "Product Name",
        "permalink": "product-name",
        "status": "active",
        "description": "This is a sample product description",
        "created_at": "2014-12-25T00:00:00.000Z",
        "updated_at": "2014-12-25T00:00:00.000Z",
        "default_price": "20.0",
        "on_sale": false,
        "position": 1,
        "url": "http://example.bigcartel.com/product/product-name",
        "primary_image_url": "https://images.bigcartel.com/some_resource/12345/-/example1.jpg"
      },
      "relationships": {
        "options": {
          "data": [
            {
              "type": "product_options",
              "id": "1"
            }
          ]
        },
        "categories": {
          "data": [
            {
              "type": "categories",
              "id": "1"
            }
          ]
        },
        "artists": {
          "data": [
            {
              "type": "artists",
              "id": "1"
            }
          ]
        },
        "shipping_options": {
          "data": [
            {
              "type": "shipping_options",
              "id": "1"
            }
          ]
        },
        "images": {
          "data": [
            {
              "type": "product_images",
              "id": "1"
            },
            {
              "type": "product_images",
              "id": "2"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "count": "10"
  },
  "included": [
    {
      "id": "1",
      "type": "product_options",
      "attributes": {
        "name": "Default",
        "price": "18.0",
        "quantity": 25,
        "sold": 5
      }
    },
    {
      "id": "1",
      "type": "categories",
      "attributes": {
        "name": "Example Category",
        "permalink": "example-category",
        "position": 1
      },
      "links": {
        "self": "https://api.bigcartel.com/v1/accounts/1/categories/1"
      }
    },
    {
      "id": "1",
      "type": "artists",
      "attributes": {
        "name": "Example artist",
        "permalink": "example-artist",
        "position": 1
      },
      "links": {
        "self": "https://api.bigcartel.com/v1/accounts/1/artists/1"
      }
    },
    {
      "id": "1",
      "type": "shipping_options",
      "attributes": {
        "price_alone": "10.0",
        "price_with_others": "5.0"
      },
      "relationships": {
        "country": {
          "data": {
            "type": "countries",
            "id": "US"
          }
        }
      }
    },
    {
      "id": "1",
      "type": "product_images",
      "attributes": {
        "url": "https://images.bigcartel.com/some_resource/12345/-/example1.jpg"
      },
      "links": {
        "self": "https://api.bigcartel.com/v1/accounts/1/product_images/1"
      }
    },
    {
      "id": "2",
      "type": "product_images",
      "attributes": {
        "url": "https://images.bigcartel.com/some_resource/12345/-/example2.jpg"
      },
      "links": {
        "self": "https://api.bigcartel.com/v1/accounts/1/product_images/2"
      }
    }
  ],
  "links": {
    "next": "https://api.bigcartel.com/v1/accounts/1/products?page%5Blimit%5D=10&page%5Boffset%5D=10",
    "last": "https://api.bigcartel.com/v1/accounts/1/products?page%5Blimit%5D=10&page%5Boffset%5D=10"
  }
}

Get a product

Get a specific product for an account.

Request

GET /v1/accounts/{account-id}/products/{product-id}

Parameters

None.

Example Response

{
  "data": {
    "id": "1",
    "type": "products",
    "attributes": {
      "name": "Product Name",
      "permalink": "product-name",
      "status": "active",
      "description": "This is a sample product description",
      "created_at": "2014-12-25T00:00:00.000Z",
      "updated_at": "2014-12-25T00:00:00.000Z",
      "default_price": "20.0",
      "on_sale": false,
      "position": 1,
      "url": "http://example.bigcartel.com/product/product-name",
      "primary_image_url": "https://images.bigcartel.com/some_resource/12345/-/example1.jpg"
    },
    "relationships": {
      "options": {
        "data": [
          {
            "type": "product_options",
            "id": "1"
          }
        ]
      },
      "categories": {
        "data": [
          {
            "type": "categories",
            "id": "1"
          }
        ]
      },
      "shipping_options": {
        "data": [
          {
            "type": "shipping_options",
            "id": "1"
          }
        ]
      },
      "images": {
        "data": [
          {
            "type": "product_images",
            "id": "1"
          },
          {
            "type": "product_images",
            "id": "2"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "product_options",
      "attributes": {
        "name": "Default",
        "price": "18.0",
        "quantity": 25,
        "sold": 5
      }
    },
    {
      "id": "1",
      "type": "categories",
      "attributes": {
        "name": "Example Category",
        "permalink": "example-category",
        "position": 1
      },
      "links": {
        "self": "https://api.bigcartel.com/v1/accounts/1/categories/1"
      }
    },
    {
      "id": "1",
      "type": "shipping_options",
      "attributes": {
        "price_alone": "10.0",
        "price_with_others": "5.0"
      },
      "relationships": {
        "country": {
          "data": {
            "type": "countries",
            "id": "US"
          }
        }
      }
    },
    {
      "id": "1",
      "type": "product_images",
      "attributes": {
        "url": "https://images.bigcartel.com/some_resource/12345/-/example1.jpg"
      },
      "links": {
        "self": "https://api.bigcartel.com/v1/accounts/1/product_images/1"
      }
    },
    {
      "id": "2",
      "type": "product_images",
      "attributes": {
        "url": "https://images.bigcartel.com/some_resource/12345/-/example2.jpg"
      },
      "links": {
        "self": "https://api.bigcartel.com/v1/accounts/1/product_images/2"
      }
    }
  ]
}

Update a product

Updates a specific product.

Note: To reposition products please see Repositioning Products

Request

PATCH /v1/accounts/{account-id}/products/{product-id}

Parameters

Name	Type	Required	Description
`id`	string	true	The unique identifier for the product.
`type`	string	true	The only option right now is products.
`name`	string	false	The name of the product.
`description`	string	false	The description of the product.
`status`	string	false	The status of the product. Possible values are `active`, `sold_out`, `hidden` and `coming_soon`.
`on_sale`	boolean	false	Whether or not the product is on sale.
`permalink`	string	false	The unique permalink for the product.

Response

If successful, we’ll return a 200 OK and the same body as getting the product.

Example Request

{
  "data": {
    "id": "123456789",
    "type": "products",
    "attributes": {
      "name": "Astronaut Painting [Pre-Order]",
      "on_sale": true
    }
  }
}

Reposition products

Repositions the list of products in the specified order.

Request

PATCH /v1/accounts/{account-id}/relationships/products

Parameters

Name	Type	Required	Description
`type`	string	true	The only option right now is products.
`id`	string	true	The unique identifier for the product.

Response

If successful, we’ll return a 204 No Content response.

Example Request

{
  "data": [
    {
      "type": "products",
      "id": "1"
    },
    {
      "type": "products",
      "id": "3"
    },
    {
      "type": "products",
      "id": "2"
    }
  ]
}

Shipments

Shipments represent a shipment a store owner has created for an order, and contains tracking information as well as what items from an order have been shipped.

Shipment object

Attribute	Type	Description
`id`	integer	The unique identifier for the order shipment.
`carrier`	string	The name of the shipping carrier.
`tracking_number`	string	The tracking number of the shipment.
`tracking_url`	string	The URL of the tracking status on the carrier’s website.
`last_notified_at`	timestamp	The date the customer was notified about the shipment.
`created_at`	timestamp	The date the order shipment was created.
`updated_at`	timestamp	The date the order shipment was last updated.
`items[].id`	integer	The unique identifier of the order item.
`items[].quantity`	integer	The quantity of the item that has been shipped.
`items[].order_item.id`	string	The unique identifier of the order item.

Get all shipments

Get all shipments for an order.

Request

GET /v1/accounts/{account-id}/orders/{order-id}/shipments

Parameters

None.

Example Response

{
    "data": [
        {
            "id": "1",
            "type": "shipments",
            "attributes": {
              "carrier": "USPS",
              "tracking_number": "1234567",
              "tracking_url": "http://tracking.com/1234567",
              "last_notified_at": "2018-12-25T22:38:56.000Z",
              "created_at": "2018-12-17T22:38:56.000Z",
               "updated_at": "2018-12-17T22:38:56.000Z"
            },
            "links": {
                "self": "https://api.bigcartel.com/v1/accounts/1/orders/ABCD-1234/shipments/1"
            },
            "relationships": {
                "order": {
                    "data": {
                        "type": "orders",
                        "id": "ABCD-1234"
                    }
                },
                "items": {
                    "data": [
                        {
                            "type": "shipment_items",
                            "id": "1"
                        }
                    ]
                }
            }
        }
    ],
    "meta": {
        "count": "1"
    },
    "included": [
        {
            "id": "ABCD-1234",
            "type": "orders",
            "attributes": {
              "item_count": 2,
              "item_total": "100.1",
              "discount_total": "10.0",
              "shipping_total": "10.0",
              "tax_total": "0.0",
              "total": "100.1",
              "customer_first_name": "Joe",
              "customer_last_name": "Somebody",
              "customer_email": "joe@somebody.com",
              "customer_opted_in_to_marketing": false,
              "customer_note": "Created by Joe",
              "shipping_address_1": "123 some street",
              "shipping_address_2": "#123",
              "shipping_city": "Somewhere",
              "shipping_state": "UT",
              "shipping_zip": "64801",
              "shipping_country_id": "US",
              "shipping_country_name": "United States",
              "shipping_latitude": null,
              "shipping_longitude": null,
              "shipping_status": "shipped",
              "payment_status": "completed",
              "created_at": "2014-12-25T00:00:00.000Z",
              "updated_at": "2014-12-25T00:00:00.000Z",
              "completed_at": "2014-12-25T00:00:00.000Z"
            },
            "links": {
                "self": "https://api.bigcartel.com/v1/accounts/1/orders/ABCD-1234"
            },
            "relationships": {
                "currency": {
                    "data": {
                        "type": "currencies",
                        "id": "USD"
                    }
                },
                "shipping_country": {
                    "data": {
                        "type": "countries",
                        "id": "US"
                    }
                },
                "events": {
                    "data": [
                        {
                            "type": "order_events",
                            "id": "1"
                        }
                    ]
                },
                "warnings": {
                    "data": []
                },
                "items": {
                    "data": [
                        {
                            "type": "order_line_items",
                            "id": "1"
                        }
                    ]
                },
                "transactions": {
                    "data": [
                        {
                            "type": "order_transactions/payments",
                            "id": "1"
                        }
                    ]
                },
                "adjustments": {
                    "data": [
                        {
                            "type": "order_adjustments/shipping",
                            "id": "1"
                        },
                        {
                            "type": "order_adjustments/discount",
                            "id": "1"
                        }
                    ]
                }
            }
        },
        {
            "id": "1",
            "type": "shipment_items",
            "attributes": {
                "quantity": 1,
                "order_line_item_id": "1"
            },
            "relationships": {
                "shipment": {
                    "data": {
                        "type": "shipments",
                        "id": "1"
                    }
                },
                "order_line_item": {
                    "data": {
                        "type": "order_line_items",
                        "id": "1"
                    }
                }
            }
        }
    ],
    "links": {}
}

Get a shipment

Get a specific shipment for an order.

Request

GET /v1/accounts/{account-id}/orders/{order-id}/shipments/{shipment-id}

Parameters

None.

Example Response

{
    "data": {
        "id": "1",
        "type": "shipments",
        "attributes": {
            "carrier": "USPS",
            "tracking_number": "1234567",
            "tracking_url": "http://tracking.com/1234567",
            "last_notified_at": "2018-12-25T22:38:56.000Z",
            "created_at": "2018-12-17T22:38:56.000Z",
            "updated_at": "2018-12-17T22:38:56.000Z"
        },
        "links": {
            "self": "https://api.bigcartel.com/v1/accounts/1/orders/ABCD-1234/shipments/1"
        },
        "relationships": {
            "order": {
                "data": {
                    "type": "orders",
                    "id": "ABCD-1234"
                }
            },
            "items": {
                "data": [
                    {
                        "type": "shipment_items",
                        "id": "1"
                    },
                    {
                        "type": "shipment_items",
                        "id": "2"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "id": "ABCD-1234",
            "type": "orders",
            "attributes": {
              "item_count": 2,
              "item_total": "100.1",
              "discount_total": "10.0",
              "shipping_total": "10.0",
              "tax_total": "0.0",
              "total": "100.1",
              "customer_first_name": "Joe",
              "customer_last_name": "Somebody",
              "customer_email": "joe@somebody.com",
              "customer_opted_in_to_marketing": false,
              "customer_note": "Created by Joe",
              "shipping_address_1": "123 some street",
              "shipping_address_2": "#123",
              "shipping_city": "Somewhere",
              "shipping_state": "UT",
              "shipping_zip": "64801",
              "shipping_country_id": "US",
              "shipping_country_name": "United States",
              "shipping_latitude": null,
              "shipping_longitude": null,
              "shipping_status": "shipped",
              "payment_status": "completed",
              "created_at": "2014-12-25T00:00:00.000Z",
              "updated_at": "2014-12-25T00:00:00.000Z",
              "completed_at": "2014-12-25T00:00:00.000Z"
            },
            "links": {
                "self": "https://api.bigcartel.com/v1/accounts/1788058/orders/QLOY-054276"
            },
            "relationships": {
                "currency": {
                    "data": {
                        "type": "currencies",
                        "id": "USD"
                    }
                },
                "shipping_country": {
                    "data": {
                        "type": "countries",
                        "id": "US"
                    }
                },
                "events": {
                    "data": [
                        {
                            "type": "order_events",
                            "id": "1"
                        },
                        {
                            "type": "order_events",
                            "id": "2"
                        },
                        {
                            "type": "order_events",
                            "id": "3"
                        }
                    ]
                },
                "warnings": {
                    "data": []
                },
                "items": {
                    "data": [
                        {
                            "type": "order_line_items",
                            "id": "1"
                        },
                        {
                            "type": "order_line_items",
                            "id": "2"
                        }
                    ]
                },
                "transactions": {
                    "data": [
                        {
                            "type": "order_transactions/payments",
                            "id": "1"
                        }
                    ]
                },
                "adjustments": {
                    "data": [
                        {
                            "type": "order_adjustments/shipping",
                            "id": "1"
                        }
                    ]
                }
            }
        },
        {
            "id": "1",
            "type": "shipment_items",
            "attributes": {
                "quantity": 1,
                "order_line_item_id": "1"
            },
            "relationships": {
                "shipment": {
                    "data": {
                        "type": "shipments",
                        "id": "1"
                    }
                },
                "order_line_item": {
                    "data": {
                        "type": "order_line_items",
                        "id": "1"
                    }
                }
            }
        },
        {
            "id": "1",
            "type": "shipment_items",
            "attributes": {
                "quantity": 1,
                "order_line_item_id": "1"
            },
            "relationships": {
                "shipment": {
                    "data": {
                        "type": "shipments",
                        "id": "1"
                    }
                },
                "order_line_item": {
                    "data": {
                        "type": "order_line_items",
                        "id": "1"
                    }
                }
            }
        }
    ]
}

Create a shipment

Creates a new shipment.

Request

POST /v1/accounts/{account-id}/orders/{order-id}/shipments

Parameters

Name	Type	Required	Description
`type`	string	required	The only option right now is shipments.
`carrier`	string	false	The name of the shipping carrier. (USPS, UPS, Fedex, etc).
`tracking_number`	string	false	The tracking number of the shipment.
`tracking_url`	string	false	The URL of the tracking status on the carrier’s website.
`notify_customer`	boolean	true	Whether the customer should get a notification email about the shipment.
`items[].quantity`	integer	true	The number of items included in this shipment.
`items[].order_line_item_id`	integer	true	The unique identifier of the order item.

Response

If successful, we’ll return a 201 Created with the location of the new shipment in the Location header and the same body as getting the shipment.

Create a shipment that has one item in it, and will notify the customer when it is created.

{
"data": {
  "type": "shipments",
   "attributes": {
      "carrier": "USPS",
       "tracking_number": "1234567",
       "tracking_url": "https://trackingurl.com/1234567",
       "notify_customer": true,
       "items": [{"quantity": 1, "order_line_item_id": 12345}]
    }
  }
}

Update a shipment

Updates a specific shipment’s details.

Request

PATCH /v1/accounts/{account-id}/orders/{order-id}/shipments/{shipment-id}

Parameters

Name	Type	Required	Description
`id`	integer	required	The id of the shipment.
`type`	string	required	The only option right now is shipment.
`carrier`	string	false	The name of the shipping carrier. (USPS, UPS, Fedex, etc).
`tracking_number`	string	false	The tracking number of the shipment.
`tracking_url`	string	false	The URL of the tracking status on the carrier’s website.
`notify_customer`	boolean	true	Whether the customer should get a notification email about the shipment.
`items[].quantity`	integer	true	The number of items included in this shipment.
`items[].order_line_item_id`	integer	true	The unique identifier of the order item.

Response

If successful, we’ll return a 200 OK and the same body as getting the shipment.

Example Request

{
"data": {
  "id": 1,
  "type": "shipments",
   "attributes": {
      "carrier": "USPS",
       "tracking_number": "1234567",
       "tracking_url": "https://trackingurl.com/1234567",
       "items": [{"quantity": 1, "order_line_item_id": 12345}]
    }
  }
}

Delete a shipment

Deletes a specific shipment.

Request

DELETE /v1/accounts/{account-id}/orders/{order-id}/shipments/{shipment-id}

Parameters

None.

Response

If successful, we’ll return a 204 No Content response.

Intro to webhooks

Our API makes use of webhooks to notify your application of important changes that have occurred outside of your application for accounts you’ve connected to. You’ll also receive webhooks for changes you make with the API, but you shouldn’t need those since all API requests you make will receive a synchronous response.

Webhooks are only available when building an application that uses OAuth for authentication. Want to build an app? Apply for now.

Types of webhooks

By default, all apps will have webhooks enabled for all account.* webhooks. The other webhooks for order, product and shipment are approved on a per-app basis. During the application process you’ll be able to request access to the webhooks you need.

Type	Payload	Description
`account.deauthorized`	`id` of the account	Sent when an account has been closed or the owner has revoked access to your application.
`account.updated`	account	Sent when an account is updated.
`account.plan.downgraded`	account	Sent when an account is downgraded.
`account.plan.upgraded`	account	Sent when an account is upgraded.
`order.created`	order	Sent when a new order is placed.
`order.updated`	order	Sent when an order changes.
`product.created`	product	Sent when a new product is created.
`product.updated`	product	Sent when a product is updated, either by the account or when it’s part of a new order.
`product.deleted`	product	Sent when a product is deleted. This payload will only include the product `id` instead of the full product object.
`shipment.created`	shipment	Sent when a new shipment is created.
`shipment.updated`	shipment	Sent when a shipment is updated
`shipment.deleted`	shipment	Sent when a shipment is deleted. This payload will only include the shipment `id` instead of the full shipment object.

Responding to webhooks

To acknowledge you received the webhook without any problem, your server should return a 2xx HTTP status code. Any response code other than that will tell Big Cartel that you didn’t receive the webhook, and we’ll continue to retry it at degrading intervals for the next 7 days.

Verifying webhooks

In order to ensure the webhook you received is legit, we suggest you verify its signature. To do that, create an HMAC signed using the SHA256 hash algorithm, using your application’s client_secret and the body of the webhook request as keys, and make sure it matches the webhook’s X-Webhook-Signature header.

Ruby

require 'openssl'
require 'base64'

sha256 = OpenSSL::Digest::SHA256.new
secret = 'YOUR_CLIENT_SECRET'
body = request.body.read
signature = OpenSSL::HMAC.hexdigest(sha256, secret, body)

Python

import hmac
from hashlib import sha256

secret = 'YOUR_CLIENT_SECRET'
body = request.data
signature = hmac.new(secret, body, sha256).hexdigest()

Node

var crypto = require('crypto');
var hmac = crypto.createHmac('sha256', clientSecret);
    hmac.update(responseBody);
var signature = hmac.digest().toString('hex');

PHP

$secret = 'YOUR_CLIENT_SECRET';
$body = file_get_contents('php://input');
$signature = hash_hmac('sha256', $body, $secret);

Receiving webhooks

Webhooks will be sent as an HTTP POST request to the webhook_url for your application in the following JSON format:

{
  "account_id": "12345",
  "type": "order.created",
  "payload": { ... }
}

Marketing Apps

If you’d like to integrate an email marketing service with Big Cartel, you must allow buyers to opt-in to this marketing, as stated in Section 4e of our API License Agreement.

To help with this, we can configure your app so that any shops using it will present buyers with a “Subscribe to our email list” checkbox in the checkout process. From there, you should use the customer_opted_in_to_marketing order attribute to opt them in or out.

Terms of Service

Before you start making API calls, please make sure to read the full API License Agreement so that you understand the rules and guidelines you are agreeing to by using the API.

Changelog

This changelog represents the evolution of our V1 API. All changes are automatic and fully backwards-compatible, unless stated otherwise.

2024-07-20

Added Get a page to get details about a theme or custom page
Added Create a page and Update a page so custom pages can be created and managed.
Added information about the Page object

2024-05-16

Added support for Embeddable Scripts that allows apps to automatically add client scripts to seller’s stores eliminating the need for manually copyiang and pasting Javascript to complete setup of your app.
Revised documentation for clarity on our requirements and best practices for apps

2024-05-06

Added new Pages API to get information about a store’s pages. At this time, only Get All Pages is supported.

2024-04-30

Get All Products now supports filtering based on inventory quantity of product (or its variants) using the filter parameter with the quantity_gte and quantity_lte params.
Order Line Items now include product_id (and product_option_id when applicable) as attributes

2024-04-29

Get All Orders now supports filtering based on date range of updated_at date using the filter parameter.

2024-04-19

Get All Orders now supports filtering based on date range of completed_at date using the filter parameter.

2024-04-15

Updated order object to contain shipping_country_id and shipping_country_name.

2023-12-06

Get Account now includes time_zone, first_name and last_name

2023-08-24

Get All Discounts and Get All Products now supports sorting on most fields, in addition to supporting the existing filtering based on status.

2023-08-09

Added more examples for Update Discount
Corrected description of name property on Discounts—it is the description of the discount
Corrected active_at property as not required for Update Discount

2019-07-11

The Order object now includes customer_phone_number.

2019-01-07

New endpoint to create a shipment.
New endpoint to get a shipment.
New endpoint to get all shipments.
New endpoint to update a shipment.
New endpoint to delete a shipment.

2017-09-18

The OAuth flow has been updated to automatically redirect users back to your application’s redirect_uri if their account is already connected to your application, instead of being prompted to allow or deny access.

2017-06-01

The account.closed webhook is now account.deauthorized.

2017-04-24

The account.closed webhook is now sent when an account owner has revoked access to your application.

2017-03-23

The Order object now includes customer_opted_in_to_marketing for marketing apps.

2017-02-27

New endpoint to create a discount.
New endpoint to get a discount.
New endpoint to get all discounts.
New endpoint to update a discount.
New endpoint to delete a discount.

2017-02-15

New Deauthorization endpoint for revoking access to an account.

2016-03-11

The Account object now includes inventory_enabled and artists_enabled.

2016-02-29

The Product object now includes the url and primary_image_url attributes.

2016-02-11

The Products endpoint now supports sorting by created_at and updated_at.

2015-12-03

The Orders endpoint now supports sorting by completed_at and created_at.

2015-11-06

New webhooks for product.created, product.updated, and product.deleted.

2015-10-27

New filter parameter for filtering products by status, category, or artist.
The Account object now includes under_maintenance.
All webhooks now include the account_id attribute.

2015-08-18

The Account object now includes account.image.

2015-08-10

New webhook for account.plan.downgraded.
New webhook for account.plan.upgraded.
The Account object now includes plan.monthly_rate, and plan.id is represented as a string instead of an integer.

2015-06-19

New endpoint to get all products.
New endpoint to get a product.
New endpoint to reposition products.

2015-06-04

New endpoint to reposition artists.
New endpoint to delete an artist.
New endpoint to update an artist.
New endpoint to create an artist.
New endpoint to get all artists.
New endpoint to get an artist.

2015-05-25

New endpoint to reposition categories.
New endpoint to delete a category.
New endpoint to update a category.
New endpoint to create a category.
New endpoint to get all categories.
New endpoint to get a category.

2015-05-20

New endpoint to update an order.
New sort parameter for sorting orders.

2015-05-05

New filter parameter for filtering shipped/unshipped orders.
New search parameter for searching orders.
New endpoint to get all countries.
New webhook for account.closed.

2015-04-20

New endpoint to get an account.
New endpoint to get all orders.
New endpoint to get an order.
New webhook for account.updated.
New webhook for order.created.
New webhook for order.updated.

Introduction

Developer Newsletter

Versioning

Status Codes

Sorting

Pagination

Images

Rate Limiting

Making API Calls

Required Headers

Identification

Submit an application

App requirements

App best practices

OAuth

Using an OAuth library

OAuth from scratch

1. Redirect the user to Big Cartel to request access

Parameters

2. Big Cartel redirects back to your site

3. Exchange the temporary code for an access token

Parameters

Response

Using the access token

Revoking access

OAuth errors

Personal Projects

About scripts

Script variables

Get app config

Request

Parameters

Update app config

Request

Parameters

Response

Script best practices

Account

Account object

Get an account

Request

Parameters

Artists

Artist object

Get all artists

Request

Parameters

Get an artist

Request

Parameters

Create an artist

Request

Parameters

Response

Update an artist

Request

Parameters

Response

Reposition artists

Request

Parameters

Response

Delete an artist

Request

Parameters

Response

Categories

Category object

Get all categories

Request

Parameters

Get a category

Request

Parameters

Create a category

Request

Parameters

Response

Update a category

Request