Zippendo Python SDK
Official Python client for the Zippendo shipping & logistics API. Models are pydantic v2, so requests and responses are both type-hinted and validated at runtime. Requires Python 3.8+.
Install
pip install zippendo
Authentication
Create an API token in your Zippendo dashboard (Settings → API tokens) — a Bearer token prefixed
with zipp_. Pass it as access_token:
import os
import zippendo
config = zippendo.Configuration(access_token=os.environ["ZIPPENDO_API_TOKEN"])
The base URL defaults to https://api.zippendo.com.
Resources & clients
The API is split into resource clients — ShipmentsApi, OrdersApi, CarriersApi, AddressesApi,
RulesApi, WebhooksApi, TokensApi, and more. Create an ApiClient from your config, then the
resource clients you need:
with zippendo.ApiClient(config) as client:
shipments = zippendo.ShipmentsApi(client)
orders = zippendo.OrdersApi(client)
The org_id parameter
Every call takes an org_id (your organization ID, found in the dashboard). It is explicit on each
call by design: one API token can be granted access to multiple organizations, and org_id selects
which one the request acts on.
Listing & pagination
List endpoints accept page (1-based) and limit, and return a page with data plus total,
page, limit, and total_pages:
with zippendo.ApiClient(config) as client:
shipments = zippendo.ShipmentsApi(client)
result = shipments.list_shipments("org_8f3kd92ld0", page=1, limit=50)
print(result.data) # list[Shipment]
print(result.total, result.total_pages) # pagination metadata
Creating resources
with zippendo.ApiClient(config) as client:
orders = zippendo.OrdersApi(client)
order = orders.create_order(
"org_8f3kd92ld0",
zippendo.CreateOrderRequest(
order_number="1001",
order_channel_id="chan_7d2k1",
order_lines=[zippendo.CreateOrderRequestOrderLinesInner(name="T-shirt", quantity=2)],
),
)
print(order.id)
See ./docs for the full request/response shape of every operation.
Error handling
Non-2xx responses raise ApiException. The body is Zippendo's canonical { code, error, message } —
branch on the machine-readable code:
from zippendo.rest import ApiException
try:
shipments.get_shipment("org_8f3kd92ld0", "shp_missing")
except ApiException as e:
print(e.status, e.body) # e.body contains the JSON, e.g. {"code": "SHIPMENT_NOT_FOUND", ...}
Configuration
Point the client at a different environment by overriding host:
config = zippendo.Configuration(
access_token=os.environ["ZIPPENDO_API_TOKEN"],
host="https://staging.api.zippendo.com",
)
Reference
Full per-endpoint and per-model documentation is in ./docs. Hosted reference:
https://www.zippendo.com/docs/api-reference/overview.
License
1 maintainer
Metadata
1 maintainer
Release files for zippendo 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| zippendo-1.0.0.tar.gz | 164.3 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| zippendo-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 500.7 kB
Release files / zippendo-1.0.0.tar.gz
| Download URL | zippendo-1.0.0.tar.gz |
|---|---|
| Size | 164.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ec2a91760d8e8c144dc8d7748a7b10dfa003cf96a701d3b13d28936bceb020ba
|
|
BLAKE2b-256 checksum How to use checksums |
1a9137559d5dad6d11ffdcf061bbe40fcfcf1a4d1fc7d59b717cfea4d9d004dc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.6
|
Release files / zippendo-1.0.0-py3-none-any.whl
| Download URL | zippendo-1.0.0-py3-none-any.whl |
|---|---|
| Size | 336.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2be3ac88a2a34afd7a545c8d63db0f819c60d49ddb690155fbf2a323e64d72cb
|
|
BLAKE2b-256 checksum How to use checksums |
6771b981592cccee474b5291ae42bc0b407b50c919d805537b5804c3e6e9ae29
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.6
|
Security for zippendo 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
