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

EasyPost Shipments API

The Shipments API from EasyPost — 5 operation(s) for shipments.

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

Tagged areas include Shipments. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 5 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.easypost.com/v2.

6 operations 5 paths 6 schemas 3 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.easypost.com/v2
Authentication
HTTP Basic
Contact
Resource Areas
1

Authentication & Security 1

EasyPost Shipments API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (EasyPostBasic). By default, every request must be authenticated.

  • EasyPostBasic — HTTP Basic where username is your EasyPost API key and password is empty.

Paths & Operations 6

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

Shipments 6
POST
/shipments
Create a shipment
createShipment body → 201401
GET
/shipments
List shipments
listShipments 3 params → 200
GET
/shipments/{id}
Retrieve a shipment
getShipment 1 param → 200
POST
/shipments/{id}/buy
Buy a shipment
buyShipment 1 param body → 200
GET
/shipments/{id}/label
Convert a shipment label format
convertShipmentLabel 2 params → 200
POST
/shipments/{id}/refund
Refund a shipment label
refundShipment 1 param → 200

Schemas 6

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

Address
object
11 properties
Rate
object
6 properties
Parcel
object
6 properties
Shipment
object
8 properties
ShipmentInput
object
4 properties
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

easypost-shipments-api-openapi.yml Raw ↑

Other APIs EasyPost publishes across the network.

EasyPost Shipping API
EasyPost Tracking API
EasyPost Webhooks API
EasyPost Insurance & Claims API
EasyPost Reports API
EasyPost Addresses API
EasyPost Parcels API
EasyPost Refunds API
EasyPost Reports API
EasyPost Trackers API