README.md

wine_shipping

WineShipping - the Ruby gem for the API from Wineshipping

Wineshipping API is a programmatically consumable service or an Application Programming Interface (API) platform designed to enable Wineshipping LLC's client applications to natively transmit and manage their order, view inventory, track shipments etc.

In order to access API operations request a user key and password from Wineshipping. For any questions please contact Wineshipping Helpdesk at [email protected].

This SDK is automatically generated by the Swagger Codegen project:

• API version: V3
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build wine_shipping.gemspec

Then either install the gem locally:

gem install ./wine_shipping-1.0.0.gem

(for development, run gem install --dev ./wine_shipping-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'wine_shipping', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:

gem 'wine_shipping', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'wine_shipping'

api_instance = WineShipping::AddressApi.new

addr_vc_request = WineShipping::AddressValidationClassificationRequest.new # AddressValidationClassificationRequest | 


begin
  result = api_instance.validation_and_classification(addr_vc_request)
  p result
rescue WineShipping::ApiError => e
  puts "Exception when calling AddressApi->validation_and_classification: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://wsservices-test.azurewebsites.net

Class	Method	HTTP request	Description
WineShipping::AddressApi	validation_and_classification	POST /api/Address/ValidationAndClassification
WineShipping::InventoryApi	get_inventory_status	POST /api/Inventory/GetStatus
WineShipping::SKUApi	create_sku	POST /api/SKU/CreateSKU
WineShipping::SalesOrderApi	create_sales_order	POST /api/SalesOrder/CreateSalesOrder
WineShipping::SalesOrderApi	get_orders_on_hold	POST /api/SalesOrder/GetOrdersOnHold
WineShipping::SalesOrderApi	get_returns	POST /api/SalesOrder/GetReturns
WineShipping::SalesOrderApi	update_sales_order	POST /api/SalesOrder/UpdateSalesOrder
WineShipping::TrackingApi	get_details	POST /api/Tracking/GetDetails

Documentation for Models

• WineShipping::Address
• WineShipping::AddressValidationClassificationRequest
• WineShipping::AddressValidationClassificationResult
• WineShipping::Authentication
• WineShipping::BillingContactInfo
• WineShipping::CandidateAddress
• WineShipping::CandidateAddressFormat
• WineShipping::DeliveryContactInfo
• WineShipping::GeographicCoordinates
• WineShipping::InventoryStatusRequest
• WineShipping::InventoryStatusResult
• WineShipping::ItemInfo
• WineShipping::OrderOnHold
• WineShipping::OrderOnHoldItem
• WineShipping::PALAddress
• WineShipping::PALRequest
• WineShipping::PALResponse
• WineShipping::PackageItem
• WineShipping::RecipientContactInfo
• WineShipping::RequestorInfo
• WineShipping::ReturnResult
• WineShipping::ReturnSalesOrderHeader
• WineShipping::ReturnSalesOrderLine
• WineShipping::ReturnsRequest
• WineShipping::SKUDetails
• WineShipping::SKUInfo
• WineShipping::SalesOrderDetails
• WineShipping::SalesOrderInfo
• WineShipping::ShipmentInfo
• WineShipping::TrackingRequest
• WineShipping::TrackingResult
• WineShipping::WarehouseInventoryStatus

Documentation for Authorization

All endpoints do not require authorization.