GET api/SerialNumber?companyCode={companyCode}&serialNumberIdentifier={serialNumberIdentifier}&productIdentifier={productIdentifier}&urnIdentifier={urnIdentifier}&stockLocationIdentifier={stockLocationIdentifier}&purchaseOrderIdentifier={purchaseOrderIdentifier}&salesOrderIdentifier={salesOrderIdentifier}&carrierReferenceID={carrierReferenceID}

Get by Identifiers

Request Information

URI Parameters

NameDescriptionTypeAdditional information
companyCode

Company Identifier (value is mandatory)

string

Required

serialNumberIdentifier

SerialNumber Identifier (value is optional)

string

Required

productIdentifier

Product Identifier (value is optional)

string

Required

urnIdentifier

Urn Identifier (value is optional)

string

Required

stockLocationIdentifier

StockLocation Identifier (value is optional)

string

Required

purchaseOrderIdentifier

PurchaseOrder Identifier (value is optional)

string

Required

salesOrderIdentifier

SalesOrder Identifier (value is optional)

string

Required

carrierReferenceID

CarrierReferenceID (Track&Trace) (value is optional)

string

Required

Body Parameters

None.

Response Information

Resource Description

Response message with a list of serial number. HttpStatusCode.Conflict when user isn't connected to Company

GetSerialNumberListMessageResponse
NameDescriptionTypeAdditional information
Header

MessageHeader

None.

SerialNumberList

Collection of SerialNumberListResponseItem

None.

Footer

MessageFooter

None.

Response Formats

application/json, text/json

Sample:
{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "SerialNumberList": [
    {
      "SerialNumberIdentifier": "string 1",
      "CompanyIdentifier": "string 2",
      "ProductIdentifier": "string 3",
      "UrnIdentifier": "string 4",
      "StockLocationIdentifier": "string 5",
      "SalesOrderIdentifier": "string 6",
      "SalesOrderLineIdentifier": 1,
      "SalesOrderLineIdentifierSpecified": true,
      "PurchaseOrderIdentifier": "string 8",
      "PurchaseOrderLineIdentifier": 1,
      "PurchaseOrderLineIdentifierSpecified": true,
      "IsValidated": true,
      "CarrierReferenceID": "string 11",
      "ExaminationDate": "2025-12-06T04:00:27.492442+01:00",
      "ExaminationDateSpecified": true
    },
    {
      "SerialNumberIdentifier": "string 1",
      "CompanyIdentifier": "string 2",
      "ProductIdentifier": "string 3",
      "UrnIdentifier": "string 4",
      "StockLocationIdentifier": "string 5",
      "SalesOrderIdentifier": "string 6",
      "SalesOrderLineIdentifier": 1,
      "SalesOrderLineIdentifierSpecified": true,
      "PurchaseOrderIdentifier": "string 8",
      "PurchaseOrderLineIdentifier": 1,
      "PurchaseOrderLineIdentifierSpecified": true,
      "IsValidated": true,
      "CarrierReferenceID": "string 11",
      "ExaminationDate": "2025-12-06T04:00:27.492442+01:00",
      "ExaminationDateSpecified": true
    }
  ],
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:
<GetSerialNumberListMessageResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Header>
    <Version>string 1</Version>
    <Identification>string 2</Identification>
    <Sender>string 3</Sender>
  </Header>
  <SerialNumberList>
    <SerialNumberListResponseItem>
      <SerialNumberIdentifier>string 1</SerialNumberIdentifier>
      <CompanyIdentifier>string 2</CompanyIdentifier>
      <ProductIdentifier>string 3</ProductIdentifier>
      <UrnIdentifier>string 4</UrnIdentifier>
      <StockLocationIdentifier>string 5</StockLocationIdentifier>
      <SalesOrderIdentifier>string 6</SalesOrderIdentifier>
      <SalesOrderLineIdentifier>1</SalesOrderLineIdentifier>
      <SalesOrderLineIdentifierSpecified>true</SalesOrderLineIdentifierSpecified>
      <PurchaseOrderIdentifier>string 8</PurchaseOrderIdentifier>
      <PurchaseOrderLineIdentifier>1</PurchaseOrderLineIdentifier>
      <PurchaseOrderLineIdentifierSpecified>true</PurchaseOrderLineIdentifierSpecified>
      <IsValidated>true</IsValidated>
      <CarrierReferenceID>string 11</CarrierReferenceID>
      <ExaminationDate>2025-12-06T04:00:27.492442+01:00</ExaminationDate>
      <ExaminationDateSpecified>true</ExaminationDateSpecified>
    </SerialNumberListResponseItem>
    <SerialNumberListResponseItem>
      <SerialNumberIdentifier>string 1</SerialNumberIdentifier>
      <CompanyIdentifier>string 2</CompanyIdentifier>
      <ProductIdentifier>string 3</ProductIdentifier>
      <UrnIdentifier>string 4</UrnIdentifier>
      <StockLocationIdentifier>string 5</StockLocationIdentifier>
      <SalesOrderIdentifier>string 6</SalesOrderIdentifier>
      <SalesOrderLineIdentifier>1</SalesOrderLineIdentifier>
      <SalesOrderLineIdentifierSpecified>true</SalesOrderLineIdentifierSpecified>
      <PurchaseOrderIdentifier>string 8</PurchaseOrderIdentifier>
      <PurchaseOrderLineIdentifier>1</PurchaseOrderLineIdentifier>
      <PurchaseOrderLineIdentifierSpecified>true</PurchaseOrderLineIdentifierSpecified>
      <IsValidated>true</IsValidated>
      <CarrierReferenceID>string 11</CarrierReferenceID>
      <ExaminationDate>2025-12-06T04:00:27.492442+01:00</ExaminationDate>
      <ExaminationDateSpecified>true</ExaminationDateSpecified>
    </SerialNumberListResponseItem>
  </SerialNumberList>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</GetSerialNumberListMessageResponse>