SDSamtec Developer Portal
APIsOrdersReference

Return list of open, scheduled orders.

Returns scheduled orders that are still open — accepted by Samtec and not yet fully shipped. Use this to track expected ship dates for orders already in production.

GET
/v1/openorders

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

In: header

Query Parameters

topMatches?integer

Number of matches to be returned if found; defaulted to 10 with a max of 100

Formatint32
Default10
startAfter?string

Database identifier (id attribute from the Order model), e.g. 71a53e94ad4bf8ad97322e05, to use as a starting point for a page of results in a single session of paging through results. An empty value will retrieve the first page. To get the next page in the result set, pass the ID of the last document from the previous page. PLEASE NOTE: the ID values are only intended to be valid for a single session of paging through results. If you wish to page through the results again, start over by passing an empty string to the startAfter parameter.

Default""
samtecPart?string

Optional (Exact) Samtec Part Number to search for

matchOrderType?string

Type of order to search (all, sales, sample, nco); defaulted to all

Value in

  • "all"
  • "sales"
  • "sample"
  • "nco"
confirmationNumber?string

Optional, The (Exact) confirmation number to search for e.g. TTQ44XTJM6P8

includeReceivedOrders?boolean

Optional, Indicates if received orders should be returned if found

Defaultfalse
onlyPastDueOrders?boolean

Optional. Indicates whether only past-due orders should be returned.
If set to true, this overrides the includeReceivedOrders parameter and matchOrderType parameter will be set to sales.

Defaultfalse

Header Parameters

client-app-name?string

Name of the client application

Default"samtec-dev-portal"

Response Body

application/json

curl -X GET "https://example.com/v1/openorders"
[  {    "Id": "68b4a1f2c9e77a0012ab34ce",    "OrderId": 4512389,    "MfgLineNumber": 1,    "LineNumber": 1,    "LineType": "Sales",    "ConfirmationNumber": "TTQ44XTJM6P8",    "Status": "Open",    "PONumber": "PO-88214-A",    "ShippingOption": {      "Carrier": {        "Id": 3,        "Name": "FedEx"      },      "ServiceLevel": {        "Id": 1,        "Name": "Ground"      },      "BillingOption": {        "Id": 2,        "Name": "Prepaid"      }    },    "ReferencePONumber": null,    "Notes": [],    "TrackingNumbers": [],    "Entered": "2026-08-01T14:32:00Z",    "Requested": "2026-08-15T00:00:00Z",    "Scheduled": "2026-08-14T00:00:00Z",    "RescheduleDate": null,    "CustomerPart": "CP-8842-A",    "Part": "TSW-110-08-T-D",    "Currency": "USD",    "Quantity": 2500,    "NetPrice": 0.184,    "ShipTo": {      "Id": 5521,      "Customer": {        "Id": 8842,        "Name": "Acme Robotics Inc."      },      "Address": {        "Id": 1,        "Name": "Acme Robotics Inc.",        "Address1": "500 Innovation Way",        "Address2": null,        "Address3": null,        "City": "Austin",        "State": "TX",        "PostalCode": "78701",        "Country": "US"      }    },    "BillTo": {      "Id": 5522,      "Customer": {        "Id": 8842,        "Name": "Acme Robotics Inc."      },      "Address": {        "Id": 2,        "Name": "Acme Robotics Inc. - Accounts Payable",        "Address1": "500 Innovation Way",        "Address2": "Suite 200",        "Address3": null,        "City": "Austin",        "State": "TX",        "PostalCode": "78701",        "Country": "US"      }    },    "EndCustomer": {      "Id": 8842,      "Name": "Acme Robotics Inc."    },    "EndCustomerLocation": {      "Id": 5521,      "Customer": {        "Id": 8842,        "Name": "Acme Robotics Inc."      },      "Address": {        "Id": 1,        "Name": "Acme Robotics Inc.",        "Address1": "500 Innovation Way",        "Address2": null,        "Address3": null,        "City": "Austin",        "State": "TX",        "PostalCode": "78701",        "Country": "US"      }    },    "SourceId": 1,    "ConvertedNetPrice": 0.184  }]