Order Management v1

Active 3-legged

Read sales orders and manage delivery schedules for open orders. Requires an active DigiKey credit account.

https://api.digikey.com/OrderManagement/v1 OpenAPI spec →

Endpoints

Method	Path	Description
GET	`/SalesOrders/{salesOrderId}`	Full sales order detail
GET	`/SalesOrders/{salesOrderId}/ChangeEligibility`	Whether the order or its lines can be schedule-changed
GET	`/SalesOrders/{salesOrderId}/Details`	All line-item detail records
GET	`/SalesOrders/{salesOrderId}/Details/{detailId}`	Single line-item detail
GET	`/SalesOrders/{salesOrderId}/Details/{detailId}/Schedules`	All delivery schedules for a line item
PUT	`/SalesOrders/{salesOrderId}/Details/{detailId}/Schedules`	Replace all schedules for a line item
GET	`/SalesOrders/{salesOrderId}/Details/{detailId}/Schedules/{scheduleIndex}`	Single schedule by index
PATCH	`/SalesOrders/{salesOrderId}/Details/{detailId}/Schedules/{scheduleIndex}`	Partial update of a schedule entry
GET	`/SalesOrders/Search/PoNumber/{poNumber}`	Find sales orders by PO number
GET	`/SalesOrders/{salesOrderId}/NextAvailableDeliveryDate`	Earliest possible delivery date

GET /SalesOrders/{salesOrderId}

Returns the full detail record for a single open sales order.

Path parameter: salesOrderId — DigiKey sales order ID (e.g. 88152456).

The salesOrderId is returned when you place an order via Ordering v3, or can be retrieved from Order Status v4.

GET /SalesOrders/{salesOrderId}/ChangeEligibility

Check whether delivery schedules can be modified before attempting a change. Returns eligibility status per line item.

GET /SalesOrders/Search/PoNumber/{poNumber}

Find all sales orders associated with your purchase order number.

Path parameter: poNumber — your PO number from the original order.

Delivery schedule management

For open orders with scheduled future delivery, you can adjust the delivery dates and quantities:

Call /ChangeEligibility to confirm the line items support changes.
Call /Details/{detailId}/Schedules to read current schedules.
Use PUT /Details/{detailId}/Schedules to replace all schedules, or PATCH /Details/{detailId}/Schedules/{scheduleIndex} for a partial update.

Notes

This API is read/write for schedule management only. To place a new order, use Ordering v3. To check shipment status, use Order Status v4.

3-legged authentication required. The authorized user must have order management permissions on the DigiKey account.

Models

Request and response object schemas for this API. Error models (ApiErrorResponse, DKProblemDetails) are documented on the Authentication & Concepts page.

`NextAvailableDeliveryDateView`

Field	Type	Required	Description
`NextRelease`	string (date-time)
`EstimatedDeliveryDate`	string (date-time)

`SalesOrderDetailView`

Field	Type	Required	Description
`PoLineItemNumber`	string
`SalesOrderId`	integer (int32)
`DetailId`	integer (int32)
`DigiKeyPartNumber`	string
`ManufacturerPartNumber`	string
`Quantity`	integer (int32)
`QuantityBackorder`	integer (int32)
`QuantityShipped`	integer (int32)
`InvoiceId`	integer (int64)
`StandardPackSize`	integer (int32)
`Schedules`	array of SalesOrderSchedulesView

`SalesOrderEligibilityView`

Field	Type	Required	Description
`Eligibility`	boolean
`SalesOrderId`	integer (int32)
`DetailsWithOpenSchedulesCount`	integer (int32)

`SalesOrderSchedulesView`

Field	Type	Required	Description
`ScheduleDate`	string (date-time)
`DetailId`	integer (int32)
`QuantityScheduled`	integer (int32)
`SalesOrderId`	integer (int32)
`ScheduleIndex`	integer (int32)

`SalesOrderView`

Field	Type	Required	Description
`Currency`	string
`SalesOrderId`	integer (int32)
`CustomerId`	integer (int32)
`PurchaseOrderNumber`	string
`ShipMethod`	string
`Details`	array of SalesOrderDetailView

`SalesOrdersByPoNumberView`

Field	Type	Required	Description
`SalesOrdersDetails`	array of SalesOrderByPoNumberDetail

`SchedulePatchView`

Field	Type	Required	Description
`Original`	SalesOrderSchedulesView
`Patched`	SalesOrderSchedulesView