Account API

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.
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 separate website the account may have.
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.

Get an account

Get the basic account information.

GET /v1/accounts/{account-id}
{
  "data": {
    "id": "1",
    "type": "accounts",
    "attributes": {
      "subdomain": "example",
      "store_name": "My example store",
      "description": "An example store",
      "contact_email": "email@example.com",
      "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
    },
    "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"
      }
    }
  ]
}

Parameters

None.