Byrd

Byrd Inbound API

Deliveries of your stock to a warehouse: announce them, follow them in, and manage their documents.

GitHub OpenAPI
Business capability
Logistics Operations Management BC-520.50

Operations 13

GET /v2/warehouse/deliveries List deliveries #
POST /v2/warehouse/deliveries Announce a delivery #
GET /v2/warehouse/deliveries/{delivery_id} Get a delivery #
PUT /v2/warehouse/deliveries/{delivery_id} Replace a delivery #
PATCH /v2/warehouse/deliveries/{delivery_id} Update a delivery #
DELETE /v2/warehouse/deliveries/{delivery_id} Cancel a delivery #
GET /v2/warehouse/deliveries/{delivery_id}/lots List the lots received in a delivery #
GET /v2/warehouse/delivery-documents List delivery documents #
POST /v2/warehouse/delivery-documents Attach a document to a delivery #
PATCH /v2/warehouse/delivery-documents/{document_id} Update a delivery document #
DELETE /v2/warehouse/delivery-documents/{document_id} Delete a delivery document #
GET /v2/warehouse/delivery-items/{item_id} Get a delivery item #
GET /v3/deliveries/count Count deliveries #

Documentation

📖
Authentication
https://artifacts.apis.io/byrd/authentication/byrd-authentication.yml
📖
RateLimits
https://artifacts.apis.io/byrd/rate-limits/byrd-rate-limits.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/byrd/openapi/byrd-inbound-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/byrd/json-schema/byrd-product-schema.json
📊
JSONSchema
https://artifacts.apis.io/byrd/json-schema/byrd-delivery-with-metrics-schema.json
📊
JSONSchema
https://artifacts.apis.io/byrd/json-schema/byrd-delivery-create-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/byrd/json-schema/byrd-delivery-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/byrd/json-schema/byrd-shipment-schema.json
📊
JSONSchema
https://artifacts.apis.io/byrd/json-schema/byrd-delivery-schema.json

Other Resources

🔗
Conventions
https://artifacts.apis.io/byrd/conventions/byrd-conventions.yml
🔗
ErrorCatalog
https://artifacts.apis.io/byrd/errors/byrd-error-codes.yml
🔗
Lifecycle
https://artifacts.apis.io/byrd/lifecycle/byrd-lifecycle.yml
🔗
ChangeLog
https://artifacts.apis.io/byrd/changelog/byrd-changelog.yml
🔗
Conformance
https://artifacts.apis.io/byrd/conformance/byrd-conformance.yml
🔗
X-MCPServerCandidate
https://artifacts.apis.io/byrd/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-inbound-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-inbound-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 Inbound API
servers:
- description: Production server
  url: https://api.getbyrd.com/
security:
- tokenAuth: []
tags:


# --- truncated at 32 KB (143 KB total) ---
# Full source: https://artifacts.apis.io/byrd/openapi/byrd-inbound-api-openapi.yml