Set Serial Number Status Request Guidelines

See How To Use this Guide before interpreting the guidelines below.

When sending an element in Date or DateTime format, a valid date must be given. "00" is not a valid day or month value and "0000" is not a valid year value.

See SerialNumberStatus Transition Availability for rules/dependencies regarding serial number state transition.

The following data is sent in the request to TraceLink:

Data Element Occurs
Length		 Type Description
soapenv:Envelope [1...1]
[–]		 -

Required. SOAP Envelope root element.
  soapenv:Header [1...1]
[–]		 -

Not used.
  soapenv:Body [1...1]
[–]		 -

Required. SOAP Message Body.
    urn:SetSerialNumberStatus [1...1]
[–]		 -

Required. SetSerialNumberStatus Message.
      SerialNumberStatusRequest [0...1]
[–]		 -

Required. Request message that either corrects an incorrect serial number status or updates an existing serial number status.
        SerialNumberList [1...1]
[–]		 -

Required. List of all serial numbers (element may be repeated) that are having their serial number status set.
          @sn [1...1]
[1/*]		 String

Required. Serial number that is having its serial number status set. See Serial Number Data Examples. *1
          @namespace [0...1]
[1/*]		 String

Not supported by TraceLink.

        SerialNumberState [1...1]
[–]		 String

Required. Serialization state of the serial number.

See the SNState enumeration list for valid values.
        ItemState [0...1]
[–]		 String

Conditionally required if SerialNumberState is Commissioned; otherwise it is ignored. Business process state of the physical item associated with the serial number.

See the ItemState enumeration list for valid values.
        QualityReleased [0...1]
[1/*]		 Boolean

Item attribute set with SerialNumberState and ItemState, indicating the item was quality released.

This attribute only applies when SerialNumberState is Commissioned. Otherwise, it is ignored.
        Sampled [0...1]
[1/*]		 Boolean

Item attribute set with SerialNumberState and ItemState, indicating the item was sampled. *2

This attribute only applies when SerialNumberState is Commissioned, Decommissioned, or Destroyed. Otherwise, it is ignored.
        Damaged [0...1]
[1/*]		 Boolean

Item attribute set with SerialNumberState and ItemState, indicating the item was damaged. *3

This attribute only applies when SerialNumberState is Commissioned, Decommissioned, or Destroyed. Otherwise, it is ignored.
        Recalled [0...1]
[1/*]		 Boolean

Item attribute set with SerialNumberState and ItemState, indicating the item was recalled.

This attribute only applies when SerialNumberState is Commissioned, Decommissioned, or Destroyed. Otherwise, it is ignored.
        Expired [0...1]
[1/*]		 Boolean

Item attribute set with SerialNumberState and ItemState, indicating the item was expired.

This attribute only applies when SerialNumberState is Commissioned, Decommissioned, or Destroyed. Otherwise, it is ignored.
        Misplaced [0...1]
[1/*]		 Boolean Item attribute set with SerialNumberState and ItemState, indicating the item was misplaced.

This attribute only applies when SerialNumberState is Commissioned, Decommissioned, or Destroyed. Otherwise, it is ignored.
        Dispensed [0...1]
[1/*]		 Boolean

Item attribute set with SerialNumberState and ItemState, indicating the item was dispensed.

This attribute only applies when SerialNumberState is Commissioned, Decommissioned, or Destroyed. Otherwise, it is ignored.
        Disposed [0...1]
[1/*]		 Boolean

Item attribute set with SerialNumberState and ItemState, indicating the item was disposed.

This attribute only applies when SerialNumberState is Commissioned, Decommissioned, or Destroyed. Otherwise, it is ignored.
        Repackaged [0...1]
[1/*]		 Boolean

Item attribute set with SerialNumberState and ItemState, indicating the item was repackaged.
        SampledByAuthorities [0...1]
[1/*]		 Boolean

Item attribute set with SerialNumberState and ItemState, indicating the item was sampled by authorities.
        Stolen [0...1]
[1/*]		 Boolean

Item attribute set with SerialNumberState and ItemState, indicating the item was stolen.
        Withdrawn [0...1]
[1/*]		 Boolean

Item attribute set with SerialNumberState and ItemState, indicating the item was withdrawn.
        ReasonCode [1...1]
[1/*]		 String

Required. The reason code for the serial number status update.

See the ReasonCode enumeration list for valid values.
        EventDateTime [0...1]
[–]		 Date

Date and time of the set serial number status event in XSD GMT date format. If omitted, the system will record the current date and `time. *4
        Location [0...1]
[1/*]		 String

Site-level SGLN of the location where the event occurred. SGLN format will be numeric component only, with urn prefix stripped (e.g. 8888882.02867.0 instead of urn:epc:id:sgln:8888882.02867.0 typically found in EPCIS events).

If it is not specified and the API credentials used in the call are specific to a company location, TraceLink will attempt to default the location based upon the corresponding Company Location master data entry. *5
        ReasonDescription [0...1]
[1/100]		 String

An explanation for the serial number status updated. If the ReasonDescription is longe than 100 characters, only the first 100 characters will be stored.
        ReportingParty [0...1]
[1/*]		 String

The value is IDType and IDValue concatenated with a | character. *6

See the IdentifierType enumeration list for valid values.
        LongRunningRestSupport [-]
[-]		 Boolean Not used.