Socket
Book a DemoInstallSign in
Socket
Book a DemoInstallSign in

ship_engine

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

ship_engine

1.0.5
bundlerRubygems
Version published
Maintainers
1
Created
Source

ship_engine

ShipEngine - the Ruby gem for the 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 to understand the basics. Learn how to authenticate yourself to ShipEngine, and then use our sandbox environment 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 for tips.

Here are some step-by-step tutorials to get you started:

Shipping Labels for Every Major Carrier

ShipEngine makes it easy to create shipping labels for any carrier and download them in a variety of file formats. You can even customize labels with your own messages and images.

Real-Time Package Tracking

With ShipEngine you can get the current status of a package or subscribe to real-time tracking updates via webhooks. You can also create custimized tracking pages 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 using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can get rate estimates with limited address info.

Worldwide Address Validation

ShipEngine supports address validation for virtually every country on Earth, including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.1.202006302006
  • Package version: 1.0.3
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://www.shipengine.com/contact/

Installation

Build a gem

To build the Ruby code into a gem:

gem build ship_engine.gemspec

Then either install the gem locally:

gem install ./ship_engine-1.0.3.gem

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

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 'ship_engine', :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 'ship_engine'

# Setup authorization
ShipEngine.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['API-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['API-Key'] = 'Bearer'
end

api_instance = ShipEngine::AddressesApi.new
parse_address_request_body = {"text":"Margie McMiller at 3800 North Lamar suite 200 in austin, tx.  The zip code there is 78652."} # ParseAddressRequestBody | The only required field is `text`, which is the text to be parsed. You can optionally also provide an `address` containing already-known values. For example, you may already know the recipient's name, city, and country, and only want to parse the street address into separate lines. 

begin
  #Parse an address
  result = api_instance.parse_address(parse_address_request_body)
  p result
rescue ShipEngine::ApiError => e
  puts "Exception when calling AddressesApi->parse_address: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.shipengine.com

ClassMethodHTTP requestDescription
ShipEngine::AddressesApiparse_addressPUT /v1/addresses/recognizeParse an address
ShipEngine::AddressesApivalidate_addressPOST /v1/addresses/validateValidate An Address
ShipEngine::BatchesApiadd_to_batchPOST /v1/batches/{batch_id}/addAdd to a Batch
ShipEngine::BatchesApicreate_batchPOST /v1/batchesCreate A Batch
ShipEngine::BatchesApidelete_batchDELETE /v1/batches/{batch_id}Delete Batch By Id
ShipEngine::BatchesApiget_batch_by_external_idGET /v1/batches/external_batch_id/{external_batch_id}Get Batch By External ID
ShipEngine::BatchesApiget_batch_by_idGET /v1/batches/{batch_id}Get Batch By ID
ShipEngine::BatchesApilist_batch_errorsGET /v1/batches/{batch_id}/errorsGet Batch Errors
ShipEngine::BatchesApilist_batchesGET /v1/batchesList Batches
ShipEngine::BatchesApiprocess_batchPOST /v1/batches/{batch_id}/process/labelsProcess Batch ID Labels
ShipEngine::BatchesApiremove_from_batchPOST /v1/batches/{batch_id}/removeRemove From Batch
ShipEngine::BatchesApiupdate_batchPUT /v1/batches/{batch_id}Update Batch By Id
ShipEngine::CarrierAccountsApiconnect_carrierPOST /v1/connections/carriers/{carrier_name}Connect a carrier account
ShipEngine::CarrierAccountsApidisconnect_carrierDELETE /v1/connections/carriers/{carrier_name}/{carrier_id}Disconnect a carrier
ShipEngine::CarrierAccountsApiget_carrier_settingsGET /v1/connections/carriers/{carrier_name}/{carrier_id}/settingsGet carrier settings
ShipEngine::CarrierAccountsApiupdate_carrier_settingsPUT /v1/connections/carriers/{carrier_name}/{carrier_id}/settingsUpdate carrier settings
ShipEngine::CarriersApiadd_funds_to_carrierPUT /v1/carriers/{carrier_id}/add_fundsAdd Funds To Carrier
ShipEngine::CarriersApiget_carrier_by_idGET /v1/carriers/{carrier_id}Get Carrier By ID
ShipEngine::CarriersApiget_carrier_optionsGET /v1/carriers/{carrier_id}/optionsGet Carrier Options
ShipEngine::CarriersApilist_carrier_package_typesGET /v1/carriers/{carrier_id}/packagesList Carrier Package Types
ShipEngine::CarriersApilist_carrier_servicesGET /v1/carriers/{carrier_id}/servicesList Carrier Services
ShipEngine::CarriersApilist_carriersGET /v1/carriersList Carriers
ShipEngine::DownloadsApidownload_fileGET /v1/downloads/{dir}/{subdir}/{filename}Download File
ShipEngine::InsuranceApiadd_funds_to_insurancePATCH /v1/insurance/shipsurance/add_fundsAdd Funds To Insurance
ShipEngine::InsuranceApiconnect_insurerPOST /v1/connections/insurance/shipsuranceConnect a Shipsurance Account
ShipEngine::InsuranceApidisconnect_insurerDELETE /v1/connections/insurance/shipsuranceDisconnect a Shipsurance Account
ShipEngine::InsuranceApiget_insurance_balanceGET /v1/insurance/shipsurance/balanceGet Insurance Funds Balance
ShipEngine::LabelsApicreate_labelPOST /v1/labelsPurchase Label
ShipEngine::LabelsApicreate_label_from_ratePOST /v1/labels/rates/{rate_id}Purchase Label with Rate ID
ShipEngine::LabelsApicreate_label_from_shipmentPOST /v1/labels/shipment/{shipment_id}Purchase Label with Shipment ID
ShipEngine::LabelsApicreate_return_labelPOST /v1/labels/{label_id}/returnCreate a return label
ShipEngine::LabelsApiget_label_by_external_shipment_idGET /v1/labels/external_shipment_id/{external_shipment_id}Get Label By External Shipment ID
ShipEngine::LabelsApiget_label_by_idGET /v1/labels/{label_id}Get Label By ID
ShipEngine::LabelsApiget_tracking_log_from_labelGET /v1/labels/{label_id}/trackGet Label Tracking Information
ShipEngine::LabelsApilist_labelsGET /v1/labelsList labels
ShipEngine::LabelsApivoid_labelPUT /v1/labels/{label_id}/voidVoid a Label By ID
ShipEngine::ManifestsApicreate_manifestPOST /v1/manifestsCreate Manifest
ShipEngine::ManifestsApiget_manifest_by_idGET /v1/manifests/{manifest_id}Get Manifest By Id
ShipEngine::ManifestsApilist_manifestsGET /v1/manifestsList Manifests
ShipEngine::PackageTypesApicreate_package_typePOST /v1/packagesCreate Custom Package Type
ShipEngine::PackageTypesApidelete_package_typeDELETE /v1/packages/{package_id}Delete A Custom Package By ID
ShipEngine::PackageTypesApiget_package_type_by_idGET /v1/packages/{package_id}Get Custom Package Type By ID
ShipEngine::PackageTypesApilist_package_typesGET /v1/packagesList Custom Package Types
ShipEngine::PackageTypesApiupdate_package_typePUT /v1/packages/{package_id}Update Custom Package Type By ID
ShipEngine::RatesApicalculate_ratesPOST /v1/ratesGet Shipping Rates
ShipEngine::RatesApicompare_bulk_ratesPOST /v1/rates/bulkGet Bulk Rates
ShipEngine::RatesApiestimate_ratesPOST /v1/rates/estimateEstimate Rates
ShipEngine::RatesApiget_rate_by_idGET /v1/rates/{rate_id}Get Rate By ID
ShipEngine::ShipmentsApicancel_shipmentsPUT /v1/shipments/{shipment_id}/cancelCancel a Shipment
ShipEngine::ShipmentsApicreate_shipmentsPOST /v1/shipmentsCreate Shipments
ShipEngine::ShipmentsApiget_shipment_by_external_idGET /v1/shipments/external_shipment_id/{external_shipment_id}Get Shipment By External ID
ShipEngine::ShipmentsApiget_shipment_by_idGET /v1/shipments/{shipment_id}Get Shipment By ID
ShipEngine::ShipmentsApilist_shipment_errorsGET /v1/shipments/{shipment_id}/errorsGet Shipment Errors
ShipEngine::ShipmentsApilist_shipment_ratesGET /v1/shipments/{shipment_id}/ratesGet Shipment Rates
ShipEngine::ShipmentsApilist_shipmentsGET /v1/shipmentsList Shipments
ShipEngine::ShipmentsApiparse_shipmentPUT /v1/shipments/recognizeParse shipping info
ShipEngine::ShipmentsApitag_shipmentPOST /v1/shipments/{shipment_id}/tags/{tag_name}Add Tag to Shipment
ShipEngine::ShipmentsApiuntag_shipmentDELETE /v1/shipments/{shipment_id}/tags/{tag_name}Remove Tag from Shipment
ShipEngine::ShipmentsApiupdate_shipmentPUT /v1/shipments/{shipment_id}Update Shipment By ID
ShipEngine::TagsApicreate_tagPOST /v1/tags/{tag_name}Create a New Tag
ShipEngine::TagsApidelete_tagDELETE /v1/tags/{tag_name}Delete Tag
ShipEngine::TagsApilist_tagsGET /v1/tagsGet Tags
ShipEngine::TagsApirename_tagPUT /v1/tags/{tag_name}/{new_tag_name}Update Tag Name
ShipEngine::TrackingApiget_tracking_logGET /v1/trackingGet Tracking Information
ShipEngine::TrackingApistart_trackingPOST /v1/tracking/startStart Tracking a Package
ShipEngine::TrackingApistop_trackingPOST /v1/tracking/stopStop Tracking a Package
ShipEngine::WarehousesApicreate_warehousePOST /v1/warehousesCreate Warehouse
ShipEngine::WarehousesApidelete_warehouseDELETE /v1/warehouses/{warehouse_id}Delete Warehouse By ID
ShipEngine::WarehousesApiget_warehouse_by_idGET /v1/warehouses/{warehouse_id}Get Warehouse By Id
ShipEngine::WarehousesApilist_warehousesGET /v1/warehousesList Warehouses
ShipEngine::WarehousesApiupdate_warehousePUT /v1/warehouses/{warehouse_id}Update WareHouse By Id
ShipEngine::WebhooksApicreate_webhookPOST /v1/environment/webhooksCreate a Webhook
ShipEngine::WebhooksApidelete_webhookDELETE /v1/environment/webhooks/{webhook_id}Delete Webhook By ID
ShipEngine::WebhooksApiget_webhook_by_idGET /v1/environment/webhooks/{webhook_id}Get Webhook By ID
ShipEngine::WebhooksApilist_webhooksGET /v1/environment/webhooksList Webhooks
ShipEngine::WebhooksApiupdate_webhookPUT /v1/environment/webhooks/{webhook_id}Update a Webhook

Documentation for Models

Documentation for Authorization

api_key

  • Type: API key
  • API key parameter name: API-Key
  • Location: HTTP header

FAQs

Package last updated on 06 Sep 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

Astral Launches pyx: A Python-Native Package Registry

Security News

Astral Launches pyx: A Python-Native Package Registry

Astral unveils pyx, a Python-native package registry in beta, designed to speed installs, enhance security, and integrate deeply with uv.

By Sarah Gooding  -  Aug 13, 2025
SocketSocket SOC 2 Logo

Product

About

Packages

Explore npm
Explore Cargo
Explore Go
Explore Maven
Explore NuGet
Explore PyPI
Explore Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.