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
- Fork it ( https://github.com/citizens/bigcartel-api/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request