Order Status v4

Active 2-legged 3-legged

Query order history by date range and retrieve full detail for a specific sales order including shipment tracking.

https://api.digikey.com/orderstatus/v4 OpenAPI spec →

Endpoints

Method	Path	Description
GET	`/orders`	List orders within a date range
GET	`/salesorder/{salesOrderId}`	Full detail for a single sales order

GET /orders

Returns a paginated list of orders for the account within a date range.

Query parameters

Parameter	Type	Required	Description
`Shared`	boolean	No	`true` returns all orders for the account; `false` (default) returns only the authenticated user's orders
`StartDate`	date	No	Earliest order date to include (ISO 8601, e.g. `2024-01-01`)
`EndDate`	date	No	Latest order date to include
`PageNumber`	integer	No	1-based page number
`PageSize`	integer	No	Results per page (default 10, max 25)

Example request

GET /orderstatus/v4/orders?Shared=true&StartDate=2024-01-01&EndDate=2026-03-26&PageSize=25

Response

{
  "TotalOrders": 5,
  "Orders": [
    {
      "OrderNumber": 9910000347672270,
      "CustomerId": 4530750,
      "DateEntered": "2024-08-08T20:41:01-05:00",
      "Currency": "USD",
      "PONumber": "",
      "EntireOrderStatus": {
        "OrderStatus": "Shipped",
        "ShortDescription": "Shipped",
        "LongDescription": "All products in this order have been shipped."
      },
      "SalesOrders": [
        {
          "SalesOrderId": 88152456,
          "Status": {
            "SalesOrderStatus": "Shipped",
            "ShortDescription": "Shipped"
          },
          "TotalPrice": 6.92,
          "DateEntered": "2024-08-08T20:41:01-05:00",
          "ShipMethod": "USPS ground advantage"
        }
      ]
    }
  ]
}

GET /salesorder/{salesOrderId}

Returns the full detail record for a specific sales order including line items and shipment information.

Path parameter: salesOrderId — the SalesOrderId integer from the orders list response.

Note: salesOrderId is the numeric ID within a sales order (e.g. 88152456), not the top-level OrderNumber (e.g. 9910000347672270). Both are returned by GET /orders.

Response

{
  "CustomerId": 4530750,
  "Contact": {
    "FirstName": "BEN",
    "LastName": "HEST",
    "Email": "user@example.com"
  },
  "SalesOrderId": 88152456,
  "Status": {
    "SalesOrderStatus": "Shipped",
    "ShortDescription": "Shipped",
    "LongDescription": "All products in this order have been shipped. Invoice and tracking information is available."
  },
  "TotalPrice": 6.92,
  "DateEntered": "2024-08-08T20:41:01-05:00",
  "OrderNumber": 9910000347672270,
  "ShipMethod": "USPS ground advantage",
  "Currency": "USD",
  "ShippingAddress": {
    "FirstName": "BEN",
    "LastName": "HEST",
    "AddressLine2": "701 BROOKS AVE S",
    "City": "THIEF RIVER FALLS",
    "State": "MN",
    "ZipCode": "567018405",
    "IsoCode": "US",
    "InvoiceId": 106467538
  },
  "LineItems": [
    {
      "SalesOrderId": 88152456,
      "DetailId": 1,
      "TotalPrice": 6.92,
      "DigiKeyProductNumber": "F5146-ND",
      "ManufacturerProductNumber": "157.5701.6421",
      "Description": "FUSE STRIP 425A 48VDC BOLT MOUNT",
      "PackType": "Bulk",
      "QuantityOrdered": 1,
      "QuantityShipped": 1,
      "QuantityBackOrder": 0,
      "UnitPrice": 6.92
    }
  ]
}

Order status values

Status	Meaning
`Submitted`	Order received, not yet processed
`Processing`	Order is being picked and packed
`Shipped`	All items have shipped
`Partial`	Some items shipped, some backordered
`Backordered`	Items are on backorder
`Cancelled`	Order was cancelled

Notes

The Order Status API returns historical and current order data. To manage open delivery schedules on unfulfilled orders, use Order Management v1.

Models

Request and response object schemas for this API. Error models (ApiErrorResponse, DKProblemDetails) are documented on the Authentication & Concepts page.

`OrderResponse`

Field	Type	Required	Description
`TotalOrders`	integer (int32)
`Orders`	array of Order

`SalesOrder`

DTO for a Sales Order

Field	Type	Description
`CustomerId`	integer (int32)	Customer ID for the sales order
`Contact`	Contact
`SalesOrderId`	integer (int32)	Sales order ID for the sales order
`Status`	SalesOrderStatusInfo
`PurchaseOrder`	string	Purchase order number of the sales order
`TotalPrice`	number (double)	Total price of all details, Shipping Charges, Sales Tax, Tariffs, GST, HST
`DateEntered`	string (date-time)	Date the sales order was entered
`OrderNumber`	integer (int64)	Order number of the sales order
`ShipMethod`	string	Method used to ship items in sales order
`Currency`	string	Currency used to place sales order
`ShippingAddress`	Address
`LineItems`	array of LineItem	List of line items for a sales order