ShippingApi

Client for accessing common shipping API.

Installation

For standalone installation you should clone the project and manually require it wherever you need it.

If using Bundler in you project, you should install it directly from Github.

gem 'apartment', :github => 'floatingpointio/shipping_api'

Usage

To use it, you create a new ShippingAPI::Client as an API URL and an API key as params. Like this:

require 'shipping_api'

client = ShippingAPI::Client.new(
  'http://shipping.example.com/api',
  '00000000-0000-0000-0000-000000000000'
)

After you have the client you can interact with the API using client's methods. All methods are a 1-1 mapping to the official API endpoints. The only difference is that Ruby client's method names are in snake_case and the official API endpoint names are CamelCase.

If for example wanted to fetch all supported locations you would do:

response = client.get_locations 'name_or_postal'

All response objects are actually Hashes. Depending on the success of the request, the response contains either the fields of the resource specified by the API documentation, or the errors that caused the request to fail.

The valid response:

{
  "PostalLocations": [
    {"Name":"Some Location", "PostalCode":"10000"},
    {"Name":"Another Location", "PostalCode":"90000"}
  ]
}

The invalid response:

{
  errors: {
    model: [{code: 10000, msg: 'InvalidApiKey'},...],
    validation: [{field: 'FieldName', msg: 'Field is required'},...]
  }
}

All resource endpoints are specified in the official API docs.

Below is the list of available methods on the client, params should be passed as ruby hash containg key-value pairs as specified in official API docs.

get_shipment_status_by_shipment_id(id)

get_shipment_status_by_ref1_and_pickup_date(ref1, pickup_date)

get_shipment_status_by_any_ref(ref_type, search_parameter)

create_shipment_plain(params)

update_shipment_plain(params)

create_shipment(params)

update_shipment(params)

cancel_shipment(shipment_id)

get_shipping_labels_for_single_shipment(shipment_id)

get_shipping_labels_for_all_shipments

get_shipping_labels_for_shipments(shipment_ids)

request_pickup

request_pickup_for_shipments(shipment_ids)

get_pickup_list_contaning_colli(colli_id)

get_possible_date_times_for_shipments(params)

get_locations(name_or_postal)

get_all_pickup_and_delivery_intervals

get_price_information(params)

get_active_shipments