0.0
No commit activity in last 3 years
No release in over 3 years
Ruby wrapper for the Bigcartel API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 1.7
~> 10.0

Runtime

 Project Readme

Bigcartel

The bigcartel-api gem is a ruby wrapper for interacting with the Bigcartel API. Developed for Hipment.

Installation

Add this line to your application's Gemfile:

gem 'bigcartel-api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install bigcartel-api

Getting Started

This gem requires a Bigcartel OAuth access token. There is a Bigcartel omniauth strategy here: https://github.com/citizens/omniauth-bigcartel

Authentication

Bigcartel.api_key = 'YOUR ACCESS TOKEN'

Account

To get information about the authenticated account:

Bigcartel::Account.retrieve

Orders

To get all orders:

Bigcartel::Order.all

To get a particular order:

Bigcartel::Order.find(order_number)

Contributing

  1. Fork it ( https://github.com/citizens/bigcartel-api/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request