# Byrd Shipments API

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

Byrd Shipments 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 Shipments. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, rate-limit docs, a changelog, and 6 JSON Schemas.

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

## Operations (25)

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

## Machine-readable artifacts (15)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/byrd/refs/heads/main/openapi/byrd-shipments-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 Inbound API](https://apis.io/apis/byrd/byrd-inbound-api/)

## Tags

Shipments

---

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