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

PATCH
api.digikey.com/ordermanagement/v2/ OrderManagement/ReplaceQuantity
Change Quantity and Schedules request.
Product quantity cannot be changed if product has shipped. 
Path of /Quantity is required. The Value should be the new total quantity requested for line item.
 [ {
          "op": "replace",
           "path": "/Quantity",
           "value": "100" ///The new requested value for the line item
        }]
To edit schedules use
"Replace"  - value should be a new schedule(s) with cumaltive quantity equal to new requested quantity
"Add" - value should be a new schedule schedule with quantity with new difference
"Remove" - value will be empty and path will be path to schedule to remove. Example "path": "/Schedules/2"
 example of a request for total line quantity 100 with replacement schedule
    Example 1 -   line item will have 100 with two scheudle of 50    
    [
        {
          "op": "replace",
           "path": "/Quantity",
           "value": "100"
        },
        {
        "op": "replace",
        "path": "/Schedules",
        "value": 
            [
             {
                "ScheduleDate": "2022-05-20T05:00:00Z",
                 "QuantityScheduled": 50
             },
             {
                "ScheduleDate": "2022-06-20T05:00:00Z",
                 "QuantityScheduled": 50
             }       
             ]
         }
     ]
    Example 2 - line item will have 100. This example only works if there is an existing scheduled quantity of 50
    [
        {
          "op": "replace",
           "path": "/Quantity",
           "value": "100"
        },
        {
        "op": "add",
        "path": "/Schedules",
        "value": 
            [
             {
                "ScheduleDate": "2022-05-20T05:00:00Z",
                 "QuantityScheduled": 50
             }
            ]
       }
    ]
    Example 3 -line item will have 50. A quantity decrease with the removal of the second schedule 

    [
        {
          "op": "replace",
           "path": "/Quantity",
           "value": "50"
        },
        {
        "op": "remove",
        "path": "/Schedules/2"
        }
    ]   
    Example 4 - Only Quantity with no schedule. This will result in the program picking a default schedule to adjust the quantity
    [
        {
          "op": "replace",
           "path": "/Quantity",
           "value": "100"
        }
    ]

Parameters

NameDescription
salesOrderId *
integer($int32)
(path)

Digi-Key SalesOrderId

detailId *
integer($int32)
(path)
Id to distinguish detail line
acceptNextDelivery
boolean
(query)
Authorization *
string
(header)

OAuth Bearer Token. Please see OAuth 2.0 Documentation page for more info.

body
(body)
[
  {
    "path": "string",
    "op": "string",
    "from": "string"
  }
]

Responses

CodeDescription
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-14T00:40:40.295Z",
      "DetailId": 0,
      "QuantityScheduled": 0,
      "SalesOrderId": 0,
      "ScheduleIndex": 0
    }
  ]
}
202
Accepted
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