How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PackageX shipments API

The shipments API from PackageX — 2 operation(s) for shipments.

PackageX shipments API is published by PackageX 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 and an API reference.

This API exposes 4 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version 0.1.

Requests are made against 2 base URLs: https://sandbox--api.packagex.io, https://api.packagex.io.

4 operations 2 paths 9 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.1
Base URL
https://api.packagex.io
Authentication
API Key
Resource Areas
1

Authentication & Security 1

PackageX shipments API declares 1 security scheme for authenticating requests. An API key is passed in the header as PX-API-KEY (api_key). By default, every request must be authenticated.

Paths & Operations 4

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

shipments 4
GET
/v1/shipments
Lists shipments up to the specified limit starting at the specified page
shipments.list 2 params → 200default
POST
/v1/shipments
Gets shipping rates for a new shipment.
shipments.create body → 200default
GET
/v1/shipments/{shipment}
Retrieves a specific shipment
shipments.retrieve 1 param → 200default
POST
/v1/shipments/{shipment}
Purchases a shipping label
shipments.purchase 1 param body → 200default

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are shipment (28 properties), address (16 properties), error (8 properties), response (8 properties). Each schema is shown below with its type and property counts.

shipment
object
A shipment object
28 properties
error
object
An error response
8 properties
tracking_update
object
The record of each tracking update from a shipment
7 properties
pagination
object
The pagination object returned in responses where multiple values are returned
3 properties
parcel
object
A parcel or package that will be included in a shipment
7 properties
rate
object
The shipping rate object showing the service level, price, and shipping provider information
7 properties
address
object
The PackageX address object
16 properties
provider
object
Details about a shipping provider for a given rate or shipment
7 properties
response
object
An error response
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

packagex-shipments-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of PackageX shipments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.