/ 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}/changeeligibility
GET
api.digikey.com/ordermanagement/v2/ OrderManagement/SalesOrderChangeEligibility
Use a Digi-Key SalesOrderId to check the change eligibility of a salesOrder
Parameters
Name | Description | |
---|---|---|
salesOrderId * integer($int32) (path) | Digi-Key SalesOrderId | |
Authorization * string (header) | OAuth Bearer Token. Please see OAuth 2.0 Documentation page for more info. |
Responses
Code | Description |
200 | Success {
"Eligibility": true,
"SalesOrderId": 0,
"DetailsWithOpenSchedulesCount": 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