PATCH api/SerialNumber

Update SerialNumber

Request Information

URI Parameters

None.

Body Parameters

Message with serial number items to update

Name	Type	Additional information
Header	MessageHeader	None.
SerialNumbers	Collection of SerialNumberPatchItem	None.
Footer	MessageFooter	None.

Request Formats

application/json, text/json

Sample:

{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "SerialNumbers": [
    {
      "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,
      "IsValidatedSpecified": true,
      "CarrierReferenceID": "string 11",
      "ExaminationDate": "2025-12-06T03:59:11.8464752+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,
      "IsValidatedSpecified": true,
      "CarrierReferenceID": "string 11",
      "ExaminationDate": "2025-12-06T03:59:11.8464752+01:00",
      "ExaminationDateSpecified": true
    }
  ],
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:

<PatchSerialNumberMessageRequest 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>
  <SerialNumbers>
    <SerialNumberPatchItem>
      <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>
      <IsValidatedSpecified>true</IsValidatedSpecified>
      <CarrierReferenceID>string 11</CarrierReferenceID>
      <ExaminationDate>2025-12-06T03:59:11.8464752+01:00</ExaminationDate>
      <ExaminationDateSpecified>true</ExaminationDateSpecified>
    </SerialNumberPatchItem>
    <SerialNumberPatchItem>
      <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>
      <IsValidatedSpecified>true</IsValidatedSpecified>
      <CarrierReferenceID>string 11</CarrierReferenceID>
      <ExaminationDate>2025-12-06T03:59:11.8464752+01:00</ExaminationDate>
      <ExaminationDateSpecified>true</ExaminationDateSpecified>
    </SerialNumberPatchItem>
  </SerialNumbers>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</PatchSerialNumberMessageRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Ok: Message with result. Invalid APIKey: HttpStatusCode.Conflict

PatchSerialNumberMessageResponse

Name	Type	Additional information
Header	MessageHeader	None.
SerialNumbers	Collection of SerialNumberPatchResult	None.
Footer	MessageFooter	None.

Response Formats

application/json, text/json

Sample:

{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "SerialNumbers": [
    {
      "ProcessingStatus": "P",
      "SerialNumberPatchResultMsg": "string 1",
      "SerialNumberIdentifier": "string 2",
      "CompanyIdentifier": "string 3",
      "ProductIdentifier": "string 4",
      "UrnIdentifier": "string 5",
      "StockLocationIdentifier": "string 6",
      "SalesOrderIdentifier": "string 7",
      "SalesOrderLineIdentifier": 1,
      "SalesOrderLineIdentifierSpecified": true,
      "PurchaseOrderIdentifier": "string 9",
      "PurchaseOrderLineIdentifier": 1,
      "PurchaseOrderLineIdentifierSpecified": true,
      "IsValidated": true,
      "IsValidatedSpecified": true,
      "CarrierReferenceID": "string 12",
      "ExaminationDate": "2025-12-06T03:59:11.8777201+01:00",
      "ExaminationDateSpecified": true
    },
    {
      "ProcessingStatus": "P",
      "SerialNumberPatchResultMsg": "string 1",
      "SerialNumberIdentifier": "string 2",
      "CompanyIdentifier": "string 3",
      "ProductIdentifier": "string 4",
      "UrnIdentifier": "string 5",
      "StockLocationIdentifier": "string 6",
      "SalesOrderIdentifier": "string 7",
      "SalesOrderLineIdentifier": 1,
      "SalesOrderLineIdentifierSpecified": true,
      "PurchaseOrderIdentifier": "string 9",
      "PurchaseOrderLineIdentifier": 1,
      "PurchaseOrderLineIdentifierSpecified": true,
      "IsValidated": true,
      "IsValidatedSpecified": true,
      "CarrierReferenceID": "string 12",
      "ExaminationDate": "2025-12-06T03:59:11.8777201+01:00",
      "ExaminationDateSpecified": true
    }
  ],
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:

<PatchSerialNumberMessageResponse 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>
  <SerialNumbers>
    <SerialNumberPatchResult>
      <SerialNumberIdentifier>string 2</SerialNumberIdentifier>
      <CompanyIdentifier>string 3</CompanyIdentifier>
      <ProductIdentifier>string 4</ProductIdentifier>
      <UrnIdentifier>string 5</UrnIdentifier>
      <StockLocationIdentifier>string 6</StockLocationIdentifier>
      <SalesOrderIdentifier>string 7</SalesOrderIdentifier>
      <SalesOrderLineIdentifier>1</SalesOrderLineIdentifier>
      <SalesOrderLineIdentifierSpecified>true</SalesOrderLineIdentifierSpecified>
      <PurchaseOrderIdentifier>string 9</PurchaseOrderIdentifier>
      <PurchaseOrderLineIdentifier>1</PurchaseOrderLineIdentifier>
      <PurchaseOrderLineIdentifierSpecified>true</PurchaseOrderLineIdentifierSpecified>
      <IsValidated>true</IsValidated>
      <IsValidatedSpecified>true</IsValidatedSpecified>
      <CarrierReferenceID>string 12</CarrierReferenceID>
      <ExaminationDate>2025-12-06T03:59:11.8777201+01:00</ExaminationDate>
      <ExaminationDateSpecified>true</ExaminationDateSpecified>
      <ProcessingStatus>P</ProcessingStatus>
      <SerialNumberPatchResultMsg>string 1</SerialNumberPatchResultMsg>
    </SerialNumberPatchResult>
    <SerialNumberPatchResult>
      <SerialNumberIdentifier>string 2</SerialNumberIdentifier>
      <CompanyIdentifier>string 3</CompanyIdentifier>
      <ProductIdentifier>string 4</ProductIdentifier>
      <UrnIdentifier>string 5</UrnIdentifier>
      <StockLocationIdentifier>string 6</StockLocationIdentifier>
      <SalesOrderIdentifier>string 7</SalesOrderIdentifier>
      <SalesOrderLineIdentifier>1</SalesOrderLineIdentifier>
      <SalesOrderLineIdentifierSpecified>true</SalesOrderLineIdentifierSpecified>
      <PurchaseOrderIdentifier>string 9</PurchaseOrderIdentifier>
      <PurchaseOrderLineIdentifier>1</PurchaseOrderLineIdentifier>
      <PurchaseOrderLineIdentifierSpecified>true</PurchaseOrderLineIdentifierSpecified>
      <IsValidated>true</IsValidated>
      <IsValidatedSpecified>true</IsValidatedSpecified>
      <CarrierReferenceID>string 12</CarrierReferenceID>
      <ExaminationDate>2025-12-06T03:59:11.8777201+01:00</ExaminationDate>
      <ExaminationDateSpecified>true</ExaminationDateSpecified>
      <ProcessingStatus>P</ProcessingStatus>
      <SerialNumberPatchResultMsg>string 1</SerialNumberPatchResultMsg>
    </SerialNumberPatchResult>
  </SerialNumbers>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</PatchSerialNumberMessageResponse>