Order Status
OrderStatus
SearchOrders
RetrieveSalesOrder
Switch to Sandbox Mode
Production Mode
Download Swagger File

/ OrderHistory


API Summary:

Retrieve a list of orders within a date range or get the status and contents of a specific order. Note: When you place an order with DigiKey, we create a single “Order” in our internal systems and one or more “Sales Orders.” On our website and packing materials, we mention SalesOrder Number, Sales Order ID and Order Number. Those are referencing the “Sales Order ID” and not the “Order Number.”

Resource URL: api.digikey.com/orderstatus/v4/salesorder/{salesOrderId}

GET
api.digikey.com/orderstatus/v4/ OrderHistory/RetrieveSalesOrder
Retrieves a SalesOrder for a specific salesOrderId

This API uses both two-legged OAuth and three-legged OAuth. See Documentation | OAuth 2.0: 2 Legged Flow or OAuth 2.0: 3 Legged Flow for information.


Which endpoint should I use?

  • If you know the SalesOrderID for the Order you want to retrieve information, call the RetrieveSalesOrder endpoint.
  • Otherwise, call the SearchOrders endpoint and specify a date range. This endpoint will return the same information for every Order placed during that time period.

Parameters

NameDescription
salesOrderId *
integer($int32)
(path)
The ID number for the Sales Order you want to retrieve.
X-DIGIKEY-Client-Id *
string
(header)
The Client Id for your app.
X-DIGIKEY-Locale-Language
string
(header)

Two letter code for language to search on. Langauge must be supported by the selected site. If searching on keyword, this language is used to find matches. Acceptable values include: en, ja, de, fr, ko, zhs, zht, it, es, he, nl, sv, pl, fi, da, no.
Default value: en

X-DIGIKEY-Locale-Currency
string
(header)

Three letter code for Currency to return part pricing for. Currency must be supported by the selected site. Acceptable values include: USD, CAD, JPY, GBP, EUR, HKD, SGD, TWD, KRW, AUD, NZD, INR, DKK, NOK, SEK, ILS, CNY, PLN, CHF, CZK, HUF, RON, ZAR, MYR, THB, PHP.
Default value: primary currency for the entered Locale-site.

X-DIGIKEY-Locale-Site
string
(header)

We return the order’s status in English unless you set the Locale to alternative values. They do not need to be the same ones used to place the Order. Two letter country/region code. Acceptable values include: US, CA, JP, UK, DE, AT, BE, DK, FI, GR, IE, IT, LU, NL, NO, PT, ES, KR, HK, SG, CN, TW, AU, FR, IN, NZ, SE, MX, CH, IL, PL, SK, SI, LV, LT, EE, CZ, HU, BG, MY, ZA, RO, TH, PH.

X-DIGIKEY-Customer-Id
string
(header)
Enter the DigiKey Customer ID used to place the order

Responses

CodeDescription
200
OK
{
  "CustomerId": 123456789,
  "Contact": {
    "FirstName": "string",
    "LastName": "string",
    "Email": "string"
  },
  "SalesOrderId": 123456789,
  "Status": {
    "SalesOrderStatus": "Unknown",
    "ShortDescription": "string",
    "LongDescription": "string"
  },
  "PurchaseOrder": "3129082341",
  "TotalPrice": 0,
  "DateEntered": "2019-05-30T21:16:13.7526329Z",
  "OrderNumber": 123456789012345,
  "ShipMethod": "UPS Overnight",
  "Currency": "USD",
  "ShippingAddress": {
    "FirstName": "John",
    "LastName": "Doe",
    "CompanyName": "Corporation X",
    "AddressLine1": "123 North Street",
    "AddressLine2": "123 North Street",
    "AddressLine3": "123 North Street",
    "City": "Metrocity",
    "State": "MN",
    "County": "Little County",
    "ZipCode": "78303",
    "IsoCode": "USA",
    "Phone": "555-555-5555",
    "InvoiceId": 12345678
  },
  "LineItems": [
    {
      "SalesOrderId": 123456789,
      "DetailId": 0,
      "TotalPrice": 0,
      "PurchaseOrder": "string",
      "CustomerReference": "string",
      "CountryOfOrigin": "string",
      "DigiKeyProductNumber": "P5555",
      "ManufacturerProductNumber": "ECA-1VHG102",
      "Description": "CAP ALUM 1000UF 20% 35V RADIAL",
      "PackType": "TapeReel",
      "QuantityOrdered": 20,
      "QuantityShipped": 14,
      "QuantityBackOrder": 3,
      "UnitPrice": 578000,
      "PoLineItemNumber": "string",
      "ItemShipments": [
        {
          "QuantityShipped": 3,
          "InvoiceId": 12345678,
          "ShippedDate": "2023-01-26T09:03:54-06:00",
          "TrackingNumber": "string",
          "ExpectedDeliveryDate": "string"
        }
      ],
      "Schedules": [
        {
          "QuantityScheduled": 0,
          "ScheduledDate": "2019-05-30T21:16:13.7526329Z",
          "DigiKeyReleaseDate": "2025-04-08T19:02:16.066Z"
        }
      ]
    }
  ]
}
400

Bad Request - The input model is invalid or malformed.

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "correlationId": "string",
  "errors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}
401

Unauthorized - Token is expired or Client Id or subscription are invalid.

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "correlationId": "string",
  "errors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}
403
The target resource is forbidden.
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "correlationId": "string",
  "errors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}
404

Not Found - The requested resource could not be found

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "correlationId": "string",
  "errors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}
429

Too Many Requests - Your rate limit has been exceeded

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "correlationId": "string",
  "errors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}
500
An unhandled error occurred.
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "correlationId": "string",
  "errors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}
503

Service Unavailable - The service is temporarily unavailable

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "correlationId": "string",
  "errors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

Models

Address
Contact
DKProblemDetails
ItemShipInfo
LineItem
Order
OrderResponse
OrderStatusInfo
SalesOrder
SalesOrderStatusInfo
Schedule