Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Easyship Shipments API

The Shipments API from Easyship — 3 operation(s) for shipments.

Easyship Shipments API is one of 7 APIs that Easyship publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Shipments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, a changelog, and 6 JSON Schemas.

This API exposes 6 operations across 3 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 2024-09.

Requests are made against 2 base URLs: https://api.easyship.com/2024-09, https://api-sandbox.easyship.com.

6 operations 3 paths 4 schemas 1 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2024-09
Base URL
https://api.easyship.com
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Easyship Shipments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Shipments 6
POST
/shipments
Create a shipment
createShipment body → 201
GET
/shipments
List shipments
listShipments 2 params → 200
GET
/shipments/{id}
Show a shipment
getShipment 1 param → 200
PATCH
/shipments/{id}
Update a shipment
updateShipment 1 param body → 200
DELETE
/shipments/{id}
Delete a shipment
deleteShipment 1 param → 204
POST
/shipments/{id}/cancel
Cancel a shipment
cancelShipment 1 param → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Address (11 properties), Item (8 properties), Shipment (8 properties), Parcel (2 properties). Each schema is shown below with its type and property counts.

Parcel
object
2 properties
Shipment
object
8 properties
Address
object
11 properties
Item
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

easyship-shipments-api-openapi.yml Raw ↑

Other APIs Easyship publishes across the network.

Easyship Addresses API
Easyship Labels API
Easyship Pickups API
Easyship Rates API
Easyship Trackings API
Easyship Webhooks API