Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 36 lines (22 sloc) 0.993 kb
ee90d89 @wvanbergen Update docs
wvanbergen authored
1 # ActiveFulfillment [![Build Status](https://travis-ci.org/Shopify/active_fulfillment.png?branch=master)](https://travis-ci.org/Shopify/active_fulfillment)
12e2815 @rromanchuk add readme file, will work on adding usage examples next..
rromanchuk authored
2
ee90d89 @wvanbergen Update docs
wvanbergen authored
3 Library for integration with order fulfillment services.
4a9d8c8 @csaunders Adds Travis CI integration
csaunders authored
4
ee90d89 @wvanbergen Update docs
wvanbergen authored
5 ## Installation
12e2815 @rromanchuk add readme file, will work on adding usage examples next..
rromanchuk authored
6
2a55baa @wvanbergen Update docs
wvanbergen authored
7 Add to your gem file, and run `bundle install`.
8
12e2815 @rromanchuk add readme file, will work on adding usage examples next..
rromanchuk authored
9 ```
2a55baa @wvanbergen Update docs
wvanbergen authored
10 gem 'active_fulfillment'
12e2815 @rromanchuk add readme file, will work on adding usage examples next..
rromanchuk authored
11 ```
11661ae @csaunders Add some contribution guidelines to the readme
csaunders authored
12
ee90d89 @wvanbergen Update docs
wvanbergen authored
13 ## Usage
14
2a55baa @wvanbergen Update docs
wvanbergen authored
15 ```
16 # The authentication options differ per service.
17 service = ActiveFulfillment.service('name').initialze(login: 'abc', password: 'def')
ee90d89 @wvanbergen Update docs
wvanbergen authored
18
2a55baa @wvanbergen Update docs
wvanbergen authored
19 # To fulfill an order:
20 service.fulfill(order_id, shipping_address, line_items, options = {})
11661ae @csaunders Add some contribution guidelines to the readme
csaunders authored
21
2a55baa @wvanbergen Update docs
wvanbergen authored
22 # To find out how much stock is left
23 service.fetch_stock_levels(options = {})
11661ae @csaunders Add some contribution guidelines to the readme
csaunders authored
24
2a55baa @wvanbergen Update docs
wvanbergen authored
25 # To obtain tracking numbers.
26 service.fetch_tracking_numbers(order_ids, options = {})
11661ae @csaunders Add some contribution guidelines to the readme
csaunders authored
27
2a55baa @wvanbergen Update docs
wvanbergen authored
28 ```
11661ae @csaunders Add some contribution guidelines to the readme
csaunders authored
29
2a55baa @wvanbergen Update docs
wvanbergen authored
30 The options hash is used to set service-specific options. See http://www.rubydoc.info/gems/active_fulfillment for the API documentation.
6b84939 @csaunders Updates list of project contributors
csaunders authored
31
2a55baa @wvanbergen Update docs
wvanbergen authored
32 ## Other information
6b84939 @csaunders Updates list of project contributors
csaunders authored
33
2a55baa @wvanbergen Update docs
wvanbergen authored
34 - This project is MIT licensed.
35 - Contributions are welcomed! See CONTRIBUTING.md for more information.
Something went wrong with that request. Please try again.