Extensiv API Rubygem

A friendly ruby interface to the Extensiv/CartRover API.

CartRover's API has four different levels. Cart, Merchant, Warehouse, and Master. This gem currently offers access to the Cart API only.

API documentation is available at https://developers.cartrover.com/

Installation

Add this line to your application's Gemfile:

gem "extensiv_ruby"

And then execute:

$ bundle

Or install it yourself as:

$ gem install extensiv_ruby

Cart API

To access the API, you'll need to create a Extensiv::CartClient and pass in your api_user and api_key.

client = Extensiv::CartClient.new(api_user: ENV["CARTROVER_API_USER"], api_key: ENV["CARTROVER_API_KEY"])

Orders

client.order.retrieve(cust_ref: "ref")
#=> Extensiv::Order

client.order.status(cust_ref: "ref")
#=> Extensiv::OrderStatus

# Possible order statuses: new, at_wms, shipped, confirmed, error, canceled, new_or_at_wms, shipped_or_confirmed, any
client.order.list(status: "ref", {limit: 20})
#=> Extensiv::Collection

client.order.create({})
#=> Extensiv::Response

client.order.batch_create([{}])
#=> Extensiv::Response

client.order.cancel(cust_ref: "ref")
#=> Extensiv::Response

client.order.update_status_confirmed(cust_ref: "ref", {})
#=> Extensiv::Response

Inventory

client.inventory.list({})
#=> Extensiv::Collection

client.inventory.retrieve(sku: "sku_id")
#=> Extensiv::Inventory

Product

client.product.info(sku: "sku_id")
#=> Extensiv::Product

Shipping Methods

client.ship_methods.list({})
#=> Extensiv::Collection

extensiv_ruby

Runtime