module ShipEngine

#ShipEngine API

#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](www.shipengine.com/docs/auth/), and then use our [sandbox environment](www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](www.shipengine.com/docs/errors/) for tips. Here are some step-by-step tutorials to get you started: - [Learn how to create your first shipping label](www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](www.shipengine.com/docs/labels/create-a-label/) and [download them](www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](www.shipengine.com/docs/labels/messages/) and [images](www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.

The version of the OpenAPI document: 1.1.202006302006 Contact: sales@shipengine.com Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#ShipEngine API

The version of the OpenAPI document: 1.1.202006302006 Contact: sales@shipengine.com Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#ShipEngine API

The version of the OpenAPI document: 1.1.202006302006 Contact: sales@shipengine.com Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

Constants

VERSION

Public Class Methods

configure() { |default| ... } click to toggle source

Customize default settings for the SDK using block.

ShipEngine.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.

# File lib/ship_engine.rb, line 270
def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end