# Byrd Inbound API

**Canonical:** https://apis.io/apis/byrd/byrd-inbound-api/  
**Provider:** Byrd — https://apis.io/providers/byrd/  
**Base URL:** https://api.getbyrd.com  
**Documentation:** https://developers.getbyrd.com

Byrd Inbound API is one of 5 APIs that [Byrd](https://apis.io/providers/byrd/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Inbound. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, rate-limit docs, a changelog, and 6 JSON Schemas.

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

## Operations (13)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (15)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/byrd/refs/heads/main/openapi/byrd-inbound-api-openapi.yml
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/byrd/refs/heads/main/authentication/byrd-authentication.yml
- **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
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/byrd/refs/heads/main/rate-limits/byrd-rate-limits.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
- **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 Byrd APIs (4)

- [Byrd Account API](https://apis.io/apis/byrd/byrd-account-api/)
- [Byrd Authentication API](https://apis.io/apis/byrd/byrd-authentication-api/)
- [Byrd Catalog API](https://apis.io/apis/byrd/byrd-catalog-api/)
- [Byrd Shipments API](https://apis.io/apis/byrd/byrd-shipments-api/)

## Tags

Inbound

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/byrd/byrd-inbound-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/byrd/.