Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Fulfil REST API Client in Python

Project Description

Fulfil IO Python Client

Fulfil REST API Client in Python

Features

  • Ability to call models

Quickstart

from fulfil_client import Client

client = Client('<subdomain>', '<api_key>')

Product = client.model('product.product')

# find products
some_products = Product.find()

# find products that have a name similar to iphone
iphones = Product.find(['name', 'ilike', 'iphone'])

Contacts

Contact can have multiple addresses and contact mechanisms i.e. phone, email.

from fulfil_client import Client
client = Client('<subdomain>', '<api_key>')

Contact = client.model('party.party')
Country = client.model('country.country')
Subdivision = client.model('country.subdivision')

country_usa, = Country.find([('code', '=', 'US')])
state_california, = Subdivision.find([('code', '=', 'US-CA')])

# Creating a contact with address and contact mechanisms
contact, = Contact.create([{
    'name': 'Jon Doe',
    'addresses': [('create', [{
        'name': 'Jone Doe Apartment',
        'street': '9805 Kaiden Grove',
        'city': 'New Leland',
        'zip': '57726',
        'country': country_usa['id'],
        'subdivision': state_california['id']
    }])],
    'contact_mechanisms': [('create', [{
        'type': 'phone',
        'value': '243243234'
    }, {
        'email': 'email',
        'value': 'hello@jondoe.com'
    }])]
}])
print contact

# Searching for a contact
contact, = Contact.find([('name', '=', 'Jon Doe')])
print contact

# Get a contact by ID
contact = Contact.get(contact['id'])
print contact

Products

Products are grouped by templates, which have common information shared by products a.k.a. variants.

from decimal import Decimal

# Creating a Product Template
Template = client.model('product.template')

iphone, = Template.create([{
    'name': 'iPhone',
    'account_category': True,
}])

# Creating products
Product = client.model('product.product')
iphone6, = Product.create([{
    'template': iphone['id'],
    'variant_name': 'iPhone 6',
    'code': 'IPHONE-6',
    'list_price': Decimal('699'),
    'cost_price': Decimal('599'),
}])

# Another variation
iphone6s, = Product.create([{
    'template': iphone['id'],
    'variant_name': 'iPhone 6S',
    'code': 'IPHONE-6S',
    'list_price': Decimal('899'),
    'cost_price': Decimal('699'),
}])

Sale

contact = Contact.get(contact['id'])
iphone6 = Product.get(iphone6['id'])
iphone6s = Product.get(iphone6s['id'])

# Creating a Sale
Sale = client.model('sale.sale')
sale, = Sale.create([{
    'party': contact['id'],
    'shipment_address': contact['addresses'][0],
    'invoice_address': contact['addresses'][0],
    'lines': [('create', [{
        'product': iphone6['id'],
        'description': iphone6['rec_name'],
        'unit': iphone6['default_uom'],
        'unit_price': iphone6['list_price'],
        'quantity': 3
    }, {
        'product': iphone6s['id'],
        'description': iphone6s['rec_name'],
        'unit': iphone6['default_uom'],
        'unit_price': iphone6s['list_price'],
        'quantity': 1
    }])]
}])

Using Session Auth

from fulfil_client import Client, SessionAuth

client = Client('subdomain')
user_id, session = client.login('username', 'password')
client.set_auth(SessionAuth(user_id, session))

Using Bearer Auth

from fulfil_client import Client, BearerAuth

client = Client('subdomain')
client.set_auth(BearerAuth(bearer_token))

Using OAuth Session

Flask example

from fulfil_client.oauth import Session
from fulfil_client import Client, BearerAuth

Session.setup(CLIENT_ID, CLIENT_SECRET)
fulfil_session = Session('localhost')  # Provide subdomain

@app.route('/')
def index():
    callback_url = url_for('authorized')
    if 'oauth_token' not in session:
        authorization_url, state = fulfil_session.create_authorization_url(
            redirect_uri=callback_url, scope=['user_session']
        )
        session['oauth_state'] = state
        return redirect(authorization_url)
    client = Client('subdomain')
    client.set_auth(BearerAuth(session['oauth_token']['access_token']))
    Party = client.model('party.party')
    return jsonify(Party.find())

@app.route('/authorized')
def authorized():
    """Callback route to fetch access token from grant code
    """
    token = fulfil_session.get_token(code=request.args.get('code'))
    session['oauth_token'] = token
    return jsonify(oauth_token=token)

Credits

Fulfil.IO Inc.

History

0.2.0 (2016-6-22)

  • Change the behavior of search method.

    The method now reflects the fulfil search API which returns a list of ids. The previous behavior which returned an object with id and rec_name (record name) is now called find.

0.1.1 (2016-3-3)

  • Add method to create resource.
  • Add examples on how to create contacts, products and sales.

0.1.0 (2016-1-22)

  • First release on PyPI.
Release History

Release History

This version
History Node

0.10.2

History Node

0.10.1

History Node

0.10.0

History Node

0.9.0

History Node

0.8.1

History Node

0.8.0

History Node

0.7.7

History Node

0.7.6

History Node

0.7.5

History Node

0.7.4

History Node

0.7.3

History Node

0.7.2

History Node

0.7.1

History Node

0.7.0

History Node

0.6.17

History Node

0.6.16

History Node

0.6.15

History Node

0.6.14

History Node

0.6.13

History Node

0.6.12

History Node

0.6.11

History Node

0.6.10

History Node

0.6.9

History Node

0.6.8

History Node

0.6.7

History Node

0.6.6

History Node

0.6.5

History Node

0.6.4

History Node

0.6.3

History Node

0.6.2

History Node

0.6.1

History Node

0.6.0

History Node

0.5.1

History Node

0.5.0

History Node

0.4.0

History Node

0.3.0

History Node

0.2.1

History Node

0.1.1

History Node

0.1.0

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
fulfil_client-0.10.2.tar.gz (24.6 kB) Copy SHA256 Checksum SHA256 Source Sep 5, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting