/ 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}

GET
api.digikey.com/OrderManagement/v1/ OrderManagement/SalesOrderScheduleById
Use a Digi-Key SalesOrderId, detailId, and scheduleIndex to return a specific SalesOrderSchedulesView

Parameters

NameDescription
salesOrderId *
integer($int32)
(path)

Digi-Key SalesOrderId

detailId *
integer($int32)
(path)
Id to distinguish detail line
scheduleIndex *
integer($int32)
(path)
Id of the Schedule

Responses

CodeDescription
200
Success
{
  "scheduleDate": "2025-04-07T21:09:50.518Z",
  "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