# Digi-Key Order Management API

**Canonical:** https://apis.io/apis/digi-key/digi-key-ordermanagement-api/  
**Provider:** Digi-Key — https://apis.io/providers/digi-key/  
**Base URL:** https://api.digikey.com/OrderManagement/v1  
**Documentation:** https://developer.digikey.com/products/ordering/ordermanagement

Digi-Key Order Management API is one of 12 APIs that [Digi-Key](https://apis.io/providers/digi-key/) 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 Order Management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 6 JSON Schemas.

The OrderManagement API from Digi-Key — 8 operation(s) for ordermanagement.

## Operations (10)

| Method | Path | Summary |
|---|---|---|
| GET | `/SalesOrders/{salesOrderId}` | Use a Digi-Key SalesOrderId to return a SalesOrderView |
| GET | `/SalesOrders/Search/PoNumber/{poNumber}` | Get SalesOrder information by Purchase Order number |
| GET | `/SalesOrders/{salesOrderId}/ChangeEligibility` | Use a Digi-Key SalesOrderId to check the change eligibility of a salesOrder |
| GET | `/SalesOrders/{salesOrderId}/NextAvailableDeliveryDate` | The NextAvailableDeliveryDate provides an estimate of the earliest delivery… |
| GET | `/SalesOrders/{salesOrderId}/Details` | Use a Digi-Key SalesOrderId to return the list of SalesOrderDetailViews… |
| GET | `/SalesOrders/{salesOrderId}/Details/{detailId}` | Use a Digi-Key SalesOrderId and a detailId to return a specific… |
| GET | `/SalesOrders/{salesOrderId}/Details/{detailId}/Schedules` | Use a Digi-Key SalesOrderId and a detailId to return a specific… |
| PUT | `/SalesOrders/{salesOrderId}/Details/{detailId}/Schedules` | Create or Replace schedules for a given Digi-Key SalesOrderId and detailId. |
| GET | `/SalesOrders/{salesOrderId}/Details/{detailId}/Schedules/{scheduleIndex}` | Use a Digi-Key SalesOrderId, detailId, and scheduleIndex to return a specific… |
| PATCH | `/SalesOrders/{salesOrderId}/Details/{detailId}/Schedules/{scheduleIndex}` | Partial update for a schedule given Digi-Key SalesOrderId, detailId, and… |

## Machine-readable artifacts (18)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/digi-key/refs/heads/main/openapi/digi-key-ordermanagement-api-openapi.yml
- **Documentation** — https://developer.digikey.com/products/ordering/ordermanagement
- **Documentation** — https://developer.digikey.com/products/barcode/barcoding
- **Documentation** — https://developer.digikey.com/products/reference-apis/customerresource
- **Documentation** — https://developer.digikey.com/products/mylists/mylists
- **Documentation** — https://developer.digikey.com/products/ordering/ordering
- **Documentation** — https://developer.digikey.com/products/order-status/orderstatus
- **Documentation** — https://developer.digikey.com/products/barcode/packinglist
- **Documentation** — https://developer.digikey.com/products/product-information-v4/productchangenotifications
- **Documentation** — https://developer.digikey.com/products/product-information-v4/productsearch
- **Documentation** — https://developer.digikey.com/products/quote/quote-v4
- **Documentation** — https://developer.digikey.com/products/supplychain/supplychain
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/digi-key/refs/heads/main/json-schema/digi-key-sales-order-detail-view-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/digi-key/refs/heads/main/json-schema/digi-key-sales-order-view-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/digi-key/refs/heads/main/json-schema/digi-key-sales-order-schedules-view-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/digi-key/refs/heads/main/json-schema/digi-key-sales-order-schedule-for-update-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/digi-key/refs/heads/main/json-schema/digi-key-sales-order-eligibility-view-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/digi-key/refs/heads/main/json-schema/digi-key-schedule-patch-view-schema.json

## Other Digi-Key APIs (11)

- [Digi-Key Barcoding API](https://apis.io/apis/digi-key/digi-key-barcoding-api/)
- [Digi-Key Bonded Inventory API](https://apis.io/apis/digi-key/digi-key-bondedinventory-api/)
- [Digi-Key Customer Resource API](https://apis.io/apis/digi-key/digi-key-customerresource-api/)
- [Digi-Key Lists API](https://apis.io/apis/digi-key/digi-key-lists-api/)
- [Digi-Key Order History API](https://apis.io/apis/digi-key/digi-key-orderhistory-api/)
- [Digi-Key Orders API](https://apis.io/apis/digi-key/digi-key-orders-api/)
- [Digi-Key Pack List API](https://apis.io/apis/digi-key/digi-key-packlist-api/)
- [Digi-Key Parts API](https://apis.io/apis/digi-key/digi-key-parts-api/)
- [Digi-Key Pcn API](https://apis.io/apis/digi-key/digi-key-pcn-api/)
- [Digi-Key Quotes API](https://apis.io/apis/digi-key/digi-key-quotes-api/)
- [Digi-Key Product Search API](https://apis.io/apis/digi-key/digi-key-product-search-api/)

## Tags

Order Management

---

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