Deprecation Notice

This is an old API and has now been deprecated, meaning its current functionality is stable but unchangeable.

Introduction

Our API is a great way to display product details, basic store information, and custom page content on an external website or in a custom application or service. The endpoints in this API don’t require any authentication, so they can only be used for reading publicly available store data.

Usage

To retrieve data from your store, simply make a request to our API and specify your store’s subdomain along with a method and your preferred response format. We’ll send back a JSON or XML response, depending on whether the format you’ve specified is .xml or .json.

https://api.bigcartel.com/{subdomain}/{method}.{format}

For example if you’d like to retrieve a list of products from mystore in JSON format, just make a GET request to the following URL:

GET https://api.bigcartel.com/mystore/products.json

Store

Returns store information like the description, currency settings, categories, and more.

Request

https://api.bigcartel.com/{subdomain}/store.json

Parameters

None.

Example Response

{
  "id":123,
  "subdomain":"mystore",
  "name":"My Store",
  "description":"My store has lots of great products",
  "url":"http://mystore.bigcartel.com",
  "website":"http://www.mystore.com",
  "products_count":10,
  "currency":{
    "id":1,
    "sign":"$",
    "name":"U.S. Dollar",
    "code":"USD",
    "locale":"en-US"
  },
  "country":{
    "id":43,
    "name":"United States",
    "code":"US"
  },
  "pages":[
    {
      "name":"FAQ",
      "permalink":"faq"
    }
  ],
  "categories":[
    {
      "id":12153,
      "permalink":"cds",
      "url":"/category/cds",
      "name":"CDs"
    },
    {
      "id":12154,
      "permalink":"hats",
      "url":"/category/hats",
      "name":"Hats"
    },
    {
      "id":12157,
      "permalink":"tees",
      "url":"/category/tees",
      "name":"Tees"
    }
  ],
  "artists":[
  ]
}

Products

Returns a list of products from a store, including all options, images, artists, and categories.

Request

https://api.bigcartel.com/{subdomain}/products.json

Parameters

Name	Type	Required	Description
`limit`	integer	false	A max number of products to return. Returns all products by default.

Example Response

[
  {
    "id":10180984,
    "name":"DIY or DIE Hoodie",
    "permalink":"diy-or-die-hoodie",
    "position":1,
    "price":49.99,
    "default_price":49.99,
    "tax":0.0,
    "url":"/product/diy-or-die-hoodie",
    "status":"active",
    "on_sale":false,
    "created_at":"2013-03-27T04:40:28.000Z",
    "description":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer sodales tempus eros. Curabitur bibendum orci sit amet eros aliquam nec pretium felis accumsan.",
    "options":[
      {
        "id":31857742,
        "name":"Small",
        "price":49.99,
        "sold_out":false,
        "has_custom_price":false
      },
      {
        "id":31857745,
        "name":"Medium",
        "price":49.99,
        "sold_out":false,
        "has_custom_price":false
      }
    ],
    "images":[
      {
        "url":"http://images.cdn.bigcartel.com/bigcartel/product_images/100023343/-/0000_BIG_CARTEL_IMG_7614.jpg",
        "secure_url":"https://d1j5c7u4mzbpxw.cloudfront.net/bigcartel/product_images/100023343/-/0000_BIG_CARTEL_IMG_7614.jpg",
        "width":1000,
        "height":666
      },
      {
        "url":"http://images.cdn.bigcartel.com/bigcartel/product_images/100023331/-/0000_BIG_CARTEL_IMG_7599.jpg",
        "secure_url":"https://d1j5c7u4mzbpxw.cloudfront.net/bigcartel/product_images/100023331/-/0000_BIG_CARTEL_IMG_7599.jpg",
        "width":1000,
        "height":666
      }
    ],
    "artists":[
      {
        "id":188734,
        "name":"Beeteeth",
        "permalink":"beeteeth",
        "url":"/artist/beeteeth"
      }
    ],
    "categories":[
      {
        "id":4922005,
        "name":"Hoodies",
        "permalink":"hoodies",
        "url":"/category/hoodies"
      }
    ]
  }
]

Page

Returns details on a custom page matching the given permalink.

Request

https://api.bigcartel.com/{subdomain}/page/{permalink}.json

Parameters

None.

Example Response

{
  "id":228715662,
  "name":"About Us",
  "permalink":"about-us",
  "url":"/about-us",
  "category":"custom",
  "content":"This is our about us page!"
}