Project

sheepla

0.0
No commit activity in last 3 years
No release in over 3 years
Sheepla XML API wrapper
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

>= 1.6.4, ~> 1.6
~> 4.0
 Project Readme

sheepla-rails

This is a Ruby Gem for Sheepla XML API.

Instalation

gem install sheepla

or add it to your Gemfile:

gem 'sheepla'

Usage

Create instance of gem:

sheepla = Sheepla::API.new('YOUR_ADMINISTRATION_API_KEY')

Then create order using all required parameters, as stated in documentation of Sheepla API.

    sample_data = {
      order_value: 299,
      order_value_currency: "PLN",
      external_delivery_type_id: "07",
      external_delivery_type_name: "DHL AH",
      external_payment_type_id: "pp",
      external_payment_type_name: "PayPal",
      external_carrier_name: "DHL Poland",
      external_carrier_id: "dhl02",
      external_country_id: "PL",
      external_buyer_id: "b123",
      external_order_id: "ah-200-abc",
      shipment_template: 122,
      comments: "Some info about delivery",
      created_on: DateTime.now,
      delivery_price: 12,
      delivery_price_currency: "PLN",
      delivery_address: {
        street: "Orba 1 Street",
        zip_code: "01-234",
        city: "Hel",
        country_alpha2_code: 1045,
        first_name: "Jean",
        last_name: "Kowalski",
        company_name: "LTD JK",
        phone: "963852741",
        email: "jean.kowalski@orba.pl"
      },
      order_items: [
        {
          name: "IPad",
          sku: "sku1",
          qty: "1",
          unit: "szt.",
          weight: "2",
          width: "1",
          height: "35",
          length: "20",
          volume: "0.001",
          priceGross: "2000",
          ean13: "1647984612122",
          issn: "9223372036854775807"
        }, {
          name: "Nokia L4",
          sku: "sku2",
          qty: "1",
          unit: "szt.",
          weight: "1.6",
          width: "1",
          height: "15",
          length: "10",
          volume: "0.001",
          priceGross: "1000",
          orderItemDiscountType: "orderItemDiscountType2",
          orderItemDiscountValue: "-5",
          ean13: "7647984612122",
          issn: "9223372036854775807"
        }
      ]
    }

sheepla.create_order(sample_data)

After that, just add shipment to order, using external_order_id:

sheepla.add_shipment_to_order('ah-200-abc')

TODO

Add advanced methods. Add tests.

Licence

Copyright (c) 2014 Marcin Adamczyk, released under the MIT license

Feel free to contact me if you need help: marcin.adamczyk [--a-t--] subcom.me