SDSamtec Developer Portal
APIsOrdersReference

Searches order history across open, scheduled, and shipped orders. At least one filter parameter is required.

Returns open, scheduled, and shipped order lines matching the given filters, optionally including shipment tracking details. At least one filter (order ID, PO number, confirmation number, part number, customer part number, end customer name, or a date range) is required.

GET
/v1/history

Authorization

Bearer
AuthorizationBearer <token>

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

In: header

Query Parameters

matchOrderType?string

Filters by order type. Defaults to all.

Value in

  • "all"
  • "sales"
  • "sample"
  • "nco"
topMatches?integer

Maximum number of results to return. Defaults to 10, maximum 100.

Formatint32
Default10
startAfter?string

Pagination cursor. Pass the id value from the last result of the previous page to retrieve the next page. Leave empty to start from the beginning. Cursor values are only valid within a single paging session.

Default""
initialDate?string

Start of a date range filter. ISO 8601 date format, e.g. 2024-12-17. Must be provided together with finalDate.

finalDate?string

End of a date range filter. ISO 8601 date format, e.g. 2024-12-17. Must be provided together with initialDate.

orderId?integer

Filters to a specific Samtec order ID. Required when filtering by mfgLineNumber or lineNumber.

Formatint32
mfgLineNumber?integer

Samtec-assigned line number to filter by. Requires orderId or poNumber.

Formatint32
lineNumber?integer

Your customer line number to filter by. Requires orderId or poNumber.

Formatint32
confirmationNumber?string

Filters to an exact confirmation number, e.g. TTQ44XTJM6P8.

poNumber?string

Filters by purchase order number.

samtecPart?string

Filters by Samtec part number.

customerPart?string

Filters by your internal part number.

endCustomerName?string

Filters by end customer name.

includeCancelledLines?boolean

When true, cancelled lines are included in results.

Defaultfalse
includeShipments?boolean

When true, includes shipment details on lines that have fully or partially shipped. Has no effect on lines that have not yet shipped.

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/history"
[  {    "Id": "68b4a1f2c9e77a0012ab34ce",    "OrderId": 4512389,    "MfgLineNumber": 1,    "LineNumber": 1,    "LineType": "Sales",    "ConfirmationNumber": "TTQ44XTJM6P8",    "Status": "Fully Shipped",    "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,    "Shipments": [      {        "ShipmentId": 991234,        "ShipmentReference": "SHP-2054187",        "LeadTrackingNumber": "1Z999AA10123456784",        "ShipDate": "2026-08-14T09:00:00Z",        "ShipAttention": "Receiving Dept",        "QuantityShipped": 2500      }    ]  }]