ChannelEngine

Deprecation of the Merchant API client libraries

This library is no longer supported by ChannelEngine. To build your own library via OpenAPI Generator, using your programming language of choice, check out the Merchant API: API clients article in our Help Center.

ChannelEngine’s APIs follow the OpenAPI/Swagger specifications, which you can find in our API reference.

Additional information for developers

For detailed information on ChannelEngine’s APIs, go to the REST APIs category in our Help Center.

channelengine_api_client_ruby

ChannelEngineApiClient - the Ruby gem for the ChannelEngine API V2

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This SDK is automatically generated by the Swagger Codegen project:

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

Installation

Build a gem

To build the Ruby code into a gem:

gem build channelengine_api_client_ruby.gemspec

Then either install the gem locally:

gem install ./channelengine_api_client_ruby-2.4.2.gem

(for development, run gem install --dev ./channelengine_api_client_ruby-2.4.2.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 'channelengine_api_client_ruby', '~> 2.4.2'

Install from Git

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

gem 'channelengine_api_client_ruby', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.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 'channelengine_api_client_ruby'

# Setup authorization
ChannelEngineApiClient.configure do |config|
  # Configure API key authorization: apikey
  config.api_key['apikey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['apikey'] = 'Bearer'
end

api_instance = ChannelEngineApiClient::CancellationApi.new

cancellation = ChannelEngineApiClient::MerchantCancellationRequest.new # MerchantCancellationRequest | 


begin
  #Merchant: Create Cancellation
  result = api_instance.cancellation_create(cancellation)
  p result
rescue ChannelEngineApiClient::ApiError => e
  puts "Exception when calling CancellationApi->cancellation_create: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://demo.channelengine.net/api

Class	Method	HTTP request	Description
ChannelEngineApiClient::CancellationApi	cancellation_create	POST /v2/cancellations	Merchant: Create Cancellation
ChannelEngineApiClient::CancellationApi	cancellation_index	GET /v2/cancellations	Channel: Get Cancellations
ChannelEngineApiClient::OfferApi	offer_stock_price_update	PUT /v2/offer	Update stock or price.
ChannelEngineApiClient::OrderApi	order_acknowledge	POST /v2/orders/acknowledge	Merchant: Acknowledge Order
ChannelEngineApiClient::OrderApi	order_create	POST /v2/orders	Channel: Create Order
ChannelEngineApiClient::OrderApi	order_get_by_filter	GET /v2/orders	Merchant: Get Orders By Filter
ChannelEngineApiClient::OrderApi	order_get_new	GET /v2/orders/new	Merchant: Get New Orders
ChannelEngineApiClient::OrderApi	order_invoice	GET /v2/orders/{merchantOrderNo}/invoice	Merchant: Download Invoice
ChannelEngineApiClient::OrderApi	order_packing_slip	GET /v2/orders/{merchantOrderNo}/packingslip	Merchant: Download Packing Slip
ChannelEngineApiClient::ProductApi	product_acknowledge_data_changes	POST /v2/products/data	Channel: Acknowledge Product Data Changes
ChannelEngineApiClient::ProductApi	product_acknowledge_offer_changes	POST /v2/products/offers	Channel: Acknowledge Product Offer Changes
ChannelEngineApiClient::ProductApi	product_create	POST /v2/products	Merchant: Upsert Products
ChannelEngineApiClient::ProductApi	product_delete	DELETE /v2/products/{merchantProductNo}	Merchant: Delete Product
ChannelEngineApiClient::ProductApi	product_get_by_merchant_product_no	GET /v2/products/merchant/{merchantProductNo}	Merchant: Get Product
ChannelEngineApiClient::ProductApi	product_get_data_changes	GET /v2/products/data	Channel: Get Product Data Changes
ChannelEngineApiClient::ProductApi	product_get_offer_changes	GET /v2/products/offers	Channel: Get Product Offer Changes
ChannelEngineApiClient::ReturnApi	return_declare_for_channel	POST /v2/returns/channel	Channel: Create Return
ChannelEngineApiClient::ReturnApi	return_declare_for_merchant	POST /v2/returns/merchant	Merchant: Create Return
ChannelEngineApiClient::ReturnApi	return_get_declared_by_channel	GET /v2/returns/merchant	Merchant: Get Returns
ChannelEngineApiClient::ReturnApi	return_get_declared_by_merchant	GET /v2/returns/channel	Channel: Get Returns
ChannelEngineApiClient::ShipmentApi	shipment_create	POST /v2/shipments	Merchant: Create Shipment
ChannelEngineApiClient::ShipmentApi	shipment_index	GET /v2/shipments	Channel: Get Shipments
ChannelEngineApiClient::ShipmentApi	shipment_update	PUT /v2/shipments/{merchantShipmentNo}	Merchant: Update Shipment

Documentation for Models

• ChannelEngineApiClient::ApiResponse
• ChannelEngineApiClient::ChannelCancellationLineResponse
• ChannelEngineApiClient::ChannelCancellationResponse
• ChannelEngineApiClient::ChannelOfferResponse
• ChannelEngineApiClient::ChannelOrderLineRequest
• ChannelEngineApiClient::ChannelOrderRequest
• ChannelEngineApiClient::ChannelProcessedChangesRequest
• ChannelEngineApiClient::ChannelProductChangesResponse
• ChannelEngineApiClient::ChannelProductResponse
• ChannelEngineApiClient::ChannelReferencesRequest
• ChannelEngineApiClient::ChannelReturnLineRequest
• ChannelEngineApiClient::ChannelReturnLineResponse
• ChannelEngineApiClient::ChannelReturnRequest
• ChannelEngineApiClient::ChannelReturnResponse
• ChannelEngineApiClient::ChannelShipmentLineResponse
• ChannelEngineApiClient::ChannelShipmentResponse
• ChannelEngineApiClient::CollectionOfChannelCancellationResponse
• ChannelEngineApiClient::CollectionOfChannelOfferResponse
• ChannelEngineApiClient::CollectionOfChannelReturnResponse
• ChannelEngineApiClient::CollectionOfChannelShipmentResponse
• ChannelEngineApiClient::CollectionOfMerchantOrderResponse
• ChannelEngineApiClient::CollectionOfMerchantReturnResponse
• ChannelEngineApiClient::EntitiesAddressModels
• ChannelEngineApiClient::ExtraDataItem
• ChannelEngineApiClient::MerchantCancellationLineRequest
• ChannelEngineApiClient::MerchantCancellationRequest
• ChannelEngineApiClient::MerchantOrderLineResponse
• ChannelEngineApiClient::MerchantOrderResponse
• ChannelEngineApiClient::MerchantProductRequest
• ChannelEngineApiClient::MerchantProductResponse
• ChannelEngineApiClient::MerchantReturnLineRequest
• ChannelEngineApiClient::MerchantReturnLineResponse
• ChannelEngineApiClient::MerchantReturnRequest
• ChannelEngineApiClient::MerchantReturnResponse
• ChannelEngineApiClient::MerchantShipmentLineRequest
• ChannelEngineApiClient::MerchantShipmentRequest
• ChannelEngineApiClient::MerchantShipmentTrackingRequest
• ChannelEngineApiClient::MerchantStockPriceUpdateRequest
• ChannelEngineApiClient::OrderAcknowledgement
• ChannelEngineApiClient::OrderFilter
• ChannelEngineApiClient::ProductCreationResult
• ChannelEngineApiClient::ProductMessage
• ChannelEngineApiClient::SingleOfChannelProductChangesResponse
• ChannelEngineApiClient::SingleOfCollectionsDictionary2Generic
• ChannelEngineApiClient::SingleOfMerchantProductResponse
• ChannelEngineApiClient::SingleOfProductCreationResult

Documentation for Authorization

apikey

• Type: API key
• API key parameter name: apikey
• Location: URL query string