Only 3-legged OAuth
/ OrderManagement
API Summary:
An Api to make changes to Open SalesOrders. Eligible changes include [Date changes to existing Schedules]
Resource URL: api.digikey.com/OrderManagement/v1/SalesOrders/{salesOrderId}
GET
api.digikey.com/OrderManagement/v1/ OrderManagement/SalesOrderById
Use a Digi-Key SalesOrderId to return a SalesOrderView
Parameters
| Name | Description | |
|---|---|---|
salesOrderId * integer($int32) (path) | Digi-Key SalesOrderId |
Responses
| Code | Description |
| 200 | Success {
"currency": "string",
"salesOrderId": 0,
"customerId": 0,
"purchaseOrderNumber": "string",
"shipMethod": "string",
"details": [
{
"poLineItemNumber": "string",
"salesOrderId": 0,
"detailId": 0,
"digiKeyPartNumber": "string",
"manufacturerPartNumber": "string",
"quantity": 0,
"quantityBackorder": 0,
"quantityShipped": 0,
"invoiceId": 0,
"standardPackSize": 0,
"schedules": [
{
"scheduleDate": "2025-04-27T20:36:56.373Z",
"detailId": 0,
"quantityScheduled": 0,
"salesOrderId": 0,
"scheduleIndex": 0
}
]
}
]
} |
| 400 | Bad Request - The input model is invalid or malformed {
"statusCode": 0,
"errorMessage": "string",
"errorDetails": "string",
"requestId": "string",
"validationErrors": [
{
"field": "string",
"message": "string"
}
]
} |
| 401 | Unauthorized - Token is expired or client Id or subscription are invalid {
"statusCode": 0,
"errorMessage": "string",
"errorDetails": "string",
"requestId": "string",
"validationErrors": [
{
"field": "string",
"message": "string"
}
]
} |
| 403 | Forbidden {
"statusCode": 0,
"errorMessage": "string",
"errorDetails": "string",
"requestId": "string",
"validationErrors": [
{
"field": "string",
"message": "string"
}
]
} |
| 429 | Too Many Requests - Your rate limit has been exceeded {
"statusCode": 0,
"errorMessage": "string",
"errorDetails": "string",
"requestId": "string",
"validationErrors": [
{
"field": "string",
"message": "string"
}
]
} |
| 503 | Service Unavailable - The service is temporarily unavailable {
"statusCode": 0,
"errorMessage": "string",
"errorDetails": "string",
"requestId": "string",
"validationErrors": [
{
"field": "string",
"message": "string"
}
]
} |
Models
ApiErrorResponse
ApiValidationError
NextAvailableDeliveryDateView
Operation
OperationType
SalesOrderByPoNumberDetail
SalesOrderDetailView
SalesOrderEligibilityView
SalesOrderScheduleForUpdate
SalesOrderSchedulesView
SalesOrderView
SalesOrdersByPoNumberView
SchedulePatchView