Jump to Content
ShippingEasy
API Reference
ShippingEasy
API Reference
API Reference

Documentation

  • Getting Started
  • API Credentials
  • Rate Limits and Throttling
  • Official API Client Libraries
  • Authentication
  • Bruno API Example Collection

Customer API

  • /ordersget
  • /orders/:idget
  • /storesget
  • /stores/:store_api_key/ordersget
  • /stores/:store_api_key/orders/:external_order_identifierget
  • /stores/:store_api_key/orderspost
  • /stores/:store_api_key/orders/:order_id/cancellationspost
  • /stores/:store_api_key/orders/:external_order_identifier/statusput
  • Quick Start
  • Ecommerce Plugin Development
  • Shipment notification callback

Ruby client

  • Github Repository
  • Getting Started
  • Finding an order
  • Retrieving multiple orders
  • Creating an order
  • Canceling an order
  • Callback Authentication

PHP client

  • Github Repository
  • Getting Started
  • Finding an order
  • Retrieving multiple orders
  • Creating an order
  • Canceling an order
  • Callback authentication
  • Accessing Other APIs

.Net Client

  • Github Repository
  • Getting Started
  • Creating an order
  • Callback Authentication
  • Accessing Other APIs

Making requests via curl

  • Example requests
Powered by 

API Credentials

Each ShippingEasy account has an API Key and an API Secret. These values are required for all API calls. They are displayed in the ShippingEasy user interface: Settings > API Credentials.

Each ShippingEasy API store has a separate key value. The store API keys are displayed on the Settings > Stores & Orders page.