/ OrderManagement
API Summary:
An API for changing schedule dates and quantity on outstanding orders that have not yet to been fulfilled.
Resource URL: api.digikey.com/ordermanagement/v2/salesorders/{salesOrderId}/details/{detailId}/quantitybackorder
GET
api.digikey.com/ordermanagement/v2/ OrderManagement/GetBackOrder
Use a Digi-Key SalesOrderId and a detailId to return the amount of backorder quanity for the detail
Parameters
| Name | Description | |
|---|---|---|
salesOrderId * integer($int32) (path) | Digi-Key SalesOrderId | |
detailId * integer($int32) (path) | Id to distinguish detail line | |
Authorization * string (header) | OAuth Bearer Token. Please see OAuth 2.0 Documentation page for more info. |
Responses
| Code | Description |
| 200 | Success {
"PoLineItemNumber": "string",
"SalesOrderId": 0,
"DetailId": 0,
"DigiKeyPartNumber": "string",
"ManufacturerPartNumber": "string",
"Quantity": 0,
"QuantityBackorder": 0,
"QuantityShipped": 0,
"InvoiceId": 0,
"StandardPackSize": 0,
"Schedules": [
{
"ScheduleDate": "2025-04-13T22:38:31.936Z",
"DetailId": 0,
"QuantityScheduled": 0,
"SalesOrderId": 0,
"ScheduleIndex": 0
}
]
} |
| 400 | Bad Request - The input model is invalid or malformed {
"ErrorResponseVersion": "string",
"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 {
"ErrorResponseVersion": "string",
"StatusCode": 0,
"ErrorMessage": "string",
"ErrorDetails": "string",
"RequestId": "string",
"ValidationErrors": [
{
"Field": "string",
"Message": "string"
}
]
} |
| 403 | Forbidden {
"ErrorResponseVersion": "string",
"StatusCode": 0,
"ErrorMessage": "string",
"ErrorDetails": "string",
"RequestId": "string",
"ValidationErrors": [
{
"Field": "string",
"Message": "string"
}
]
} |
| 429 | Too Many Requests - Your rate limit has been exceeded {
"ErrorResponseVersion": "string",
"StatusCode": 0,
"ErrorMessage": "string",
"ErrorDetails": "string",
"RequestId": "string",
"ValidationErrors": [
{
"Field": "string",
"Message": "string"
}
]
} |
| 503 | Service Unavailable - The service is temporarily unavailable {
"ErrorResponseVersion": "string",
"StatusCode": 0,
"ErrorMessage": "string",
"ErrorDetails": "string",
"RequestId": "string",
"ValidationErrors": [
{
"Field": "string",
"Message": "string"
}
]
} |
Models
ApiErrorResponse
ApiValidationError
BackOrderQuantityRequest
NextAvailableDeliveryDateView
Operation
QuantityView
SalesOrderByPoNumberDetail
SalesOrderDetailView
SalesOrderEligibilityView
SalesOrderScheduleForUpdate
SalesOrderSchedulesView
SalesOrderView
SalesOrdersByPoNumberView
ScheduleDateToUpdate
ScheduleDateView
SchedulesView