UltraCart REST API V2 SDK for Ruby
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.



UltraCartAdminV2 - the Ruby gem for the UltraCart Rest API V2

This is the next generation UltraCart REST API...

This SDK is automatically generated by the Swagger Codegen project:

  • API version: 2.0.0
  • Package version: 1.0.0
  • Build date: 2017-08-10T12:06:33.543-04:00
  • Build package: class io.swagger.codegen.languages.RubyClientCodegen For more information, please visit http://www.ultracart.com


Build a gem

To build the Ruby code into a gem:

gem build com_ultracart_admin_v2.gemspec

Then either install the gem locally:

gem install ./com_ultracart_admin_v2-1.0.0.gem

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

Install from Git

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

gem 'com_ultracart_admin_v2', :git => 'https://github.com/UltraCart/rest_api_v2_sdk_ruby.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 'com_ultracart_admin_v2'

# Setup authorization
UltraCartAdminV2.configure do |config|
  # Configure OAuth2 access token for authorization: ultraCartOauth
  config.access_token = 'YOUR ACCESS TOKEN'

  # Configure API key authorization: ultraCartSimpleApiKey
  config.api_key['x-ultracart-simple-key'] = '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['x-ultracart-simple-key'] = 'Bearer'

api_instance = UltraCartAdminV2::AutoorderApi.new

auto_order_oid = 56 # Integer | The auto order oid to retrieve.

opts = { 
  _expand: "_expand_example" # String | The object expansion to perform on the result.  See documentation for examples

  #Retrieve an auto order
  result = api_instance.get_auto_order(auto_order_oid, opts)
  p result
rescue UltraCartAdminV2::ApiError => e
  puts "Exception when calling AutoorderApi->get_auto_order: #{e}"

Documentation for API Endpoints

All URIs are relative to https://secure.ultracart.com/rest/v2

Class Method HTTP request Description
UltraCartAdminV2::AutoorderApi get_auto_order GET /auto_order/auto_orders/{auto_order_oid} Retrieve an auto order
UltraCartAdminV2::AutoorderApi get_auto_orders GET /auto_order/auto_orders Retrieve auto orders
UltraCartAdminV2::AutoorderApi update_auto_order PUT /auto_order/auto_orders/{auto_order_oid} Update an auto order
UltraCartAdminV2::ChargebackApi delete_chargeback DELETE /chargeback/chargebacks/{chargeback_dispute_oid} Delete a chargeback
UltraCartAdminV2::ChargebackApi get_chargeback_dispute GET /chargeback/chargebacks/{chargeback_dispute_oid} Retrieve a chargeback
UltraCartAdminV2::ChargebackApi get_chargeback_disputes GET /chargeback/chargebacks Retrieve chargebacks
UltraCartAdminV2::ChargebackApi insert_chargeback POST /chargeback/chargebacks Insert a chargeback
UltraCartAdminV2::ChargebackApi update_chargeback PUT /chargeback/chargebacks/{chargeback_dispute_oid} Update a chargeback
UltraCartAdminV2::CheckoutApi city_state POST /checkout/city_state City/State for Zip
UltraCartAdminV2::CheckoutApi finalize_order POST /checkout/cart/finalizeOrder Finalize Order
UltraCartAdminV2::CheckoutApi get_cart GET /checkout/cart Get cart
UltraCartAdminV2::CheckoutApi get_cart_by_cart_id GET /checkout/cart/{cart_id} Get cart (by cart id)
UltraCartAdminV2::CheckoutApi get_cart_by_return_code GET /checkout/return/{return_code} Get cart (by return code)
UltraCartAdminV2::CheckoutApi handoff_cart POST /checkout/cart/handoff Handoff cart
UltraCartAdminV2::CheckoutApi login POST /checkout/cart/profile/login Profile login
UltraCartAdminV2::CheckoutApi logout POST /checkout/cart/profile/logout Profile logout
UltraCartAdminV2::CheckoutApi register POST /checkout/cart/profile/register Profile registration
UltraCartAdminV2::CheckoutApi related_items_for_cart POST /checkout/related_items Related items
UltraCartAdminV2::CheckoutApi related_items_for_item POST /checkout/relatedItems/{item_id} Related items (specific item)
UltraCartAdminV2::CheckoutApi setup_browser_key PUT /checkout/browser_key Setup Browser Application
UltraCartAdminV2::CheckoutApi update_cart PUT /checkout/cart Update cart
UltraCartAdminV2::CheckoutApi validate_cart POST /checkout/cart/validate Validate
UltraCartAdminV2::CustomerApi delete_customer DELETE /customer/customers/{customer_profile_oid} Delete a customer
UltraCartAdminV2::CustomerApi get_customer GET /customer/customers/{customer_profile_oid} Retrieve a customer
UltraCartAdminV2::CustomerApi get_customers GET /customer/customers Retrieve customers
UltraCartAdminV2::CustomerApi insert_customer POST /customer/customers Insert a customer
UltraCartAdminV2::CustomerApi update_customer PUT /customer/customers/{customer_profile_oid} Update a customer
UltraCartAdminV2::FulfillmentApi acknowledge_orders PUT /fulfillment/distribution_centers/{distribution_center_code}/acknowledgements Acknowledge receipt of orders.
UltraCartAdminV2::FulfillmentApi get_distribution_center_orders GET /fulfillment/distribution_centers/{distribution_center_code}/orders Retrieve orders queued up for this distribution center.
UltraCartAdminV2::FulfillmentApi get_distribution_centers GET /fulfillment/distribution_centers Retrieve distribution centers
UltraCartAdminV2::FulfillmentApi ship_orders POST /fulfillment/distribution_centers/{distribution_center_code}/shipments Mark orders as shipped
UltraCartAdminV2::FulfillmentApi update_inventory POST /fulfillment/distribution_centers/{distribution_center_code}/inventory Update inventory
UltraCartAdminV2::ItemApi delete_item DELETE /item/items/{merchant_item_oid} Delete an item
UltraCartAdminV2::ItemApi get_item GET /item/items/{merchant_item_oid} Retrieve an item
UltraCartAdminV2::ItemApi get_items GET /item/items Retrieve items
UltraCartAdminV2::ItemApi insert_item POST /item/items Create an item
UltraCartAdminV2::ItemApi update_item PUT /item/items/{merchant_item_oid} Update an item
UltraCartAdminV2::ItemApi upload_temporary_multimedia POST /item/temp_multimedia Upload an image to the temporary multimedia.
UltraCartAdminV2::OauthApi oauth_access_token POST /oauth/token Exchange authorization code for access token.
UltraCartAdminV2::OauthApi oauth_revoke POST /oauth/revoke Revoke this OAuth application.
UltraCartAdminV2::OrderApi cancel_order POST /order/orders/{order_id}/cancel Cancel an order
UltraCartAdminV2::OrderApi delete_order DELETE /order/orders/{order_id} Delete an order
UltraCartAdminV2::OrderApi get_order GET /order/orders/{order_id} Retrieve an order
UltraCartAdminV2::OrderApi get_orders GET /order/orders Retrieve orders
UltraCartAdminV2::OrderApi resend_receipt POST /order/orders/{order_id}/resend_receipt Resend receipt
UltraCartAdminV2::OrderApi resend_shipment_confirmation POST /order/orders/{order_id}/resend_shipment_confirmation Resend shipment confirmation
UltraCartAdminV2::OrderApi update_order PUT /order/orders/{order_id} Update an order
UltraCartAdminV2::WebhookApi delete_webhook DELETE /webhook/webhooks/{webhookOid} Delete a webhook
UltraCartAdminV2::WebhookApi get_webhook_log GET /webhook/webhooks/{webhookOid}/logs/{requestId} Retrieve an individual log
UltraCartAdminV2::WebhookApi get_webhook_log_summaries GET /webhook/webhooks/{webhookOid}/logs Retrieve the log summaries
UltraCartAdminV2::WebhookApi get_webhooks GET /webhook/webhooks Retrieve webhooks
UltraCartAdminV2::WebhookApi insert_webhook POST /webhook/webhooks Add a webhook
UltraCartAdminV2::WebhookApi resend_event POST /webhook/webhooks/{webhookOid}/reflow/{eventName} Resend events to the webhook endpoint.
UltraCartAdminV2::WebhookApi update_webhook PUT /webhook/webhooks/{webhookOid} Update a webhook

Documentation for Models

Documentation for Authorization


  • Type: API key
  • API key parameter name: x-ultracart-browser-key
  • Location: HTTP header


  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://secure.ultracart.com/rest/v2/oauth/authorize
  • Scopes:
    • auto_order_read: Allows you to read auto order information.
    • auto_order_write: Allows you to write auto order information.
    • chargeback_read: Allows you to read chargeback information.
    • chargeback_write: Allows you to write chargeback information.
    • checkout_read: Allows you to read checkout information.
    • checkout_write: Allows you to write checkout information.
    • customer_read: Allows you to read customer information.
    • customer_write: Allows you to write customer information.
    • fulfillment_read: Allows you to read fulfillment information.
    • fulfillment_write: Allows you to write fulfillment information.
    • order_read: Allows you to read order information.
    • order_write: Allows you to write order information.
    • item_read: Allows you to read item information.
    • item_write: Allows you to write item information.
    • webhook_read: Allows you to read webhook information.
    • webhook_write: Allows you to write webhook information.
    • ultrabooks_read: 1 of 2 required to use UltraBooks
    • ultrabooks_write: 2 of 2 required to use UltraBooks


  • Type: API key
  • API key parameter name: x-ultracart-simple-key
  • Location: HTTP header