Byrd

Byrd Shipments API

Orders shipped to your customers: create and release them, follow their units and picks, and handle their returns.

GitHub OpenAPI

Operations 25

GET /v2/returns List returns #
GET /v2/returns/{return_id} Get a return #
GET /v3/picks List picks #
POST /v3/returns/announce Announce a return #
POST /v3/returns/{return_id}/documents Regenerate the documents of a return #
GET /v3/shipments List shipments #
POST /v3/shipments Create a shipment #
GET /v3/shipments/count Count shipments #
POST /v3/shipments/recall Recall shipments #
POST /v3/shipments/release Release shipments #
GET /v3/shipments/report Download a shipment report #
GET /v3/shipments/{shipment_id} Get a shipment #
PATCH /v3/shipments/{shipment_id} Update a shipment #
DELETE /v3/shipments/{shipment_id} Delete a shipment #
GET /v3/shipments/{shipment_id}/documents List shipment documents #
POST /v3/shipments/{shipment_id}/documents Upload shipment documents #
GET /v3/shipments/{shipment_id}/documents/{document_id}/file Download a shipment document file #
GET /v3/shipments/{shipment_id}/picks List a shipment's picks #
POST /v3/shipments/{shipment_id}/recall Recall a shipment #
GET /v3/shipments/{shipment_id}/reservations List a shipment's reservations #
POST /v3/shipments/{shipment_id}/schedule-pickup Schedule the pickup of a B2B shipment #
GET /v3/shipments/{shipment_id}/units/{unit_id} Get a shipment unit #
POST /v3/shipments/{shipment_id}/validate-address Validate a shipment's address #
GET /v3/units List units #
GET /v3/units/count Count units #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/byrd/refs/heads/main/authentication/byrd-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/byrd/refs/heads/main/rate-limits/byrd-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/byrd/refs/heads/main/openapi/byrd-shipments-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/byrd/refs/heads/main/json-schema/byrd-product-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/byrd/refs/heads/main/json-schema/byrd-delivery-with-metrics-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/byrd/refs/heads/main/json-schema/byrd-delivery-create-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/byrd/refs/heads/main/json-schema/byrd-delivery-create-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/byrd/refs/heads/main/json-schema/byrd-shipment-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/byrd/refs/heads/main/json-schema/byrd-delivery-schema.json

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/byrd/refs/heads/main/conventions/byrd-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/byrd/refs/heads/main/errors/byrd-error-codes.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/byrd/refs/heads/main/lifecycle/byrd-lifecycle.yml
🔗
ChangeLog
https://raw.githubusercontent.com/api-evangelist/byrd/refs/heads/main/changelog/byrd-changelog.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/byrd/refs/heads/main/conformance/byrd-conformance.yml
🔗
X-MCPServerCandidate
https://raw.githubusercontent.com/api-evangelist/byrd/refs/heads/main/mcp/byrd-mcp.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/byrd:byrd-shipments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

byrd-shipments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: The byrd APIs for managing products, inbound deliveries, shipments and returns.
  contact:
    email: info@getbyrd.com
    name: General company contact
    url: https://getbyrd.com/kontakt/
  license:
    name: Copyright byrd technologies GmbH
  termsOfService: https://getbyrd.com/agb/
  version: '20260924'
  title: byrd Shipments API
servers:
- description: Production server
  url: https://api.getbyrd.com/
security:
- tokenAuth: []
tags:


# --- truncated at 32 KB (303 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/byrd/refs/heads/main/openapi/byrd-shipments-api-openapi.yml