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}/Details/{detailId}/Schedules/{scheduleIndex}
PATCH
api.digikey.com/OrderManagement/v1/ OrderManagement/PartialScheduleUpdate
Partial update for a schedule given Digi-Key SalesOrderId, detailId, and scheduleIndex
Parameters
| Name | Description | |
|---|---|---|
salesOrderId * integer($int32) (path) | Digi-Key SalesOrderId | |
detailId * integer($int32) (path) | Id to distinguish detail line | |
scheduleIndex * integer($int32) (path) | Id of the Schedule | |
acceptNextDelivery boolean (query) | ||
body (body) | A json patch document [{"op": "replace","path": "/ScheduleDate","value": "2022-12-10T05:00:00Z"}] [
{
"operationType": 0,
"path": "string",
"op": "string",
"from": "string"
}
] |
Responses
| Code | Description |
| 200 | Success {
"original": {
"scheduleDate": "2025-04-27T14:21:31.767Z",
"detailId": 0,
"quantityScheduled": 0,
"salesOrderId": 0,
"scheduleIndex": 0
},
"patched": {
"scheduleDate": "2025-04-27T14:21:31.767Z",
"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