Download the PHP package zippendo/zippendo-php without Composer
On this page you can find all versions of the php package zippendo/zippendo-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download zippendo/zippendo-php
More information about zippendo/zippendo-php
Files in zippendo/zippendo-php
Package zippendo-php
Short Description Official PHP SDK for the Zippendo shipping API: book shipments, print labels and track parcels with PostNord, GLS, DAO, Bring, DHL, DPD, UPS and more.
License MIT
Homepage https://www.zippendo.com/docs/sdks/overview
Informations about the package zippendo-php
Zippendo PHP SDK
Official PHP client for the Zippendo shipping & logistics API. Requires PHP 8.1+ and Composer.
Book shipments and print labels with PostNord, GLS, DAO, Bring, DHL, DPD, UPS and more, track parcels, and manage orders, shipping rules and webhooks from your own code. New to the API? Start with the SDK guide or browse the API reference. To work from an AI assistant instead, connect the Zippendo MCP server.
Install
Authentication
Create an API token in your Zippendo dashboard (Settings → API tokens) — a Bearer token prefixed
with zipp_. Set it on the configuration:
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. Each takes an HTTP client and your config:
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.
Brands
A brand is a sub-account inside an organization: one company running several consumer-facing labels
(say Acme and Globex) keeps each label's orders and shipments separate, with its own company name,
address and logo on the documents its shipments produce. Scope a request to one brand with the
X-Zippendo-Brand header, whose value is the brand's ID or slug.
The header is not a method argument — it applies uniformly to every operation, so put it on the Guzzle client you hand to the resource clients, and every call they make carries it:
To address two brands from one process, build a Guzzle client per brand and pass each to its own
resource clients. Omit the header and the request covers the whole organization — the behaviour of
every existing token. A header naming a brand that does not exist in the organization is rejected
with 404 BRAND_NOT_FOUND.
An API token created with a brand_id is permanently confined to that brand and needs no header.
Sending X-Zippendo-Brand naming a different brand on such a token is refused with
403 BRAND_ACCESS_DENIED — the binding is never widened.
List operations also take a brandScope query parameter ("own" / "shared" / "both") to narrow
further within whichever brand context already applies: "own" returns only that brand's rows and
needs a brand context (otherwise 400); "shared" returns only the unassigned rows (equivalent to
brandId=none). Set X-Zippendo-Brand-Scope as a default header the same way to cover every call:
An explicit brandScope parameter passed to a call still wins over the header.
Managing brands
Brands are managed with BrandsApi. Build it from a plain Guzzle client without the brand header —
you are administering brands, not acting inside one:
Retire a brand with archiveOrgBrand — archived brands keep their slug and can be restored with
unarchiveOrgBrand. Permanent deletion is dashboard-only: it is refused while any order, shipment,
member or token still references the brand. Brands require a plan that includes them; creating one
past your plan's limit returns 403.
Listing & pagination
List endpoints accept page (1-based) and limit, and return a page with getData() plus
getTotal(), getPage(), getLimit(), and getTotalPages():
Creating resources
See ./docs/Api for the full request/response shape of every operation.
Error handling
Non-2xx responses throw ApiException. The response body is Zippendo's canonical
{ code, error, message } — branch on the machine-readable code:
Configuration
Point the client at a different environment by overriding the host:
Reference
Full per-endpoint and per-model documentation is in ./docs. Hosted reference:
https://www.zippendo.com/docs/api-reference/overview.
License
MIT
All versions of zippendo-php with dependencies
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.3
guzzlehttp/psr7 Version ^1.7 || ^2.0