Remove crypto codes APIs

Use the following messages to remove crypto key and crypto code attributes from specified serial numbers. When a Remove Crypto Codes request is successful, the response includes an AsyncID. Use this token in the Fetch Remove Crypto Codes Result request to retrieve the status of the associated Remove Crypto Codes message.

Access to the Web Services Description Language (WSDL), where the XSDs reside along with other functionality information, is needed for integration. The URL for the WSDL contains the name of the TraceLink environment being accessed, followed by a specific app path. The following are the itest and prod WSDLs for removing crypto codes:

  • itest: https://itestapi.tracelink.com/soap/crypto?wsdl
  • prod: https://api.tracelink.com/soap/crypto?wsdl

Ensure authentication success before attempting to access the WSDL.

Remove Crypto Codes (SOAP)

Guidelines

Data Element Occurs
Length		 Type
 Description
soapenv:Envelope

[1...1]

[1/*]

 -

Required. The SOAP envelope.
  soapenv:Header

[1...1]

[-]

 -

Required. Not used.
  soapenv:Body

[1...1]

[-]

 -

Required. The SOAP message body.
    urn:RemoveCryptoCodes

[1...1]

[-]

 -

Required. The body for the Remove Crypto Codes request.
      RemoveCryptoCodesRequest

[1...1]

[-]

 -

Required. The Remove Crypto Codes Request element group.
        Items

[0...1]

[-]

 -

Conditionally required if GTIN and LotNumber are not present. The list of serial numbers from which to remove the crypto key and crypto code attributes.
          Item

[1...*]

[-]

 -

Required. The serial number and its attributes.
            @sn

[1...1]

[1/*]

 -

Required. The serial number in AI(01)+AI(21) format.
            @namespace

[0...1]

[0/*]

 -

Not used. The namespace of the serial number.
            @orderItemNumber

[0...1]

[0/*]

 -

Not used. The order item number associated with the serial number.
            @barcodeContent

[0...1]

[0/*]

 -

Not used. The actual barcode content of the serial number.
        GTIN

[0...1]

[0/14]

 -

Conditionally required if either of the following is true:

  • Items is not present.
  • LotNumber is present.

The GTIN of the serial numbers from which to remove the crypto key and crypto code attributes.
        Lotnumber

[0...1]

[0/*]

 -

Conditionally required if either of the following is true:

  • Items is not present.
  • GTIN is present.

The lot number of the serial numbers from which to remove the crypto key and crypto code attributes.

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:tracelink:soap">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:RemoveCryptoCodes>
            <RemoveCryptoCodesRequest>
                <Items>
                    <Item sn="01508820250106612184927439238FDSJHK" namespace="" orderItemNumber="" barcodeContent=""/>
                    <Item sn="0150882025010661215KL2J3D9JNF4K4L59" namespace="" orderItemNumber="" barcodeContent=""/>
                    <Item sn="0150882025010661212LKJ3409UDJN349DH" namespace="" orderItemNumber="" barcodeContent=""/>
                </Items>
                <GTIN></GTIN>
                <LotNumber></LotNumber>
            </RemoveCryptoCodesRequest>
        </urn:RemoveCryptoCodes>
    </soapenv:Body>
</soapenv:Envelope>

Errors

There are no errors for the Remove Crytpo Codes message. Errors are returned when using the Fetch Remove Crypto Codes Result message.

Guidelines

Data Element Occurs
Length		 Type Description
S:Envelope

[ 1...1]

[-]

 -

Required. The SOAP envelope.
  S:Body

[ 1...1]

[-]

 -

Required. The SOAP message body.
    ns3:RemoveCryptoCodes

[ 1...1]

[-]

 - Required. The Remove Crypto Codes response message.
      TLResponse

[ 1...1]

[-]

 - Required. The message response.
        Success

[ 1...1]

[0/5]

 Boolean

Required. Indicates if the message was successful. Valid values:

  • true – The Remove Crypto Codes request was successful.
  • false – The Remove Crypto Codes request was not successful.
          TLResponsePayload

[ 1...1]

[-]

 - Required. The asynchronous response ID element group.
            AsyncID

[ 1...1]

[0/36]

 String Required. Use this token to retrieve the processing status in the Fetch Remove Crypto Codes Result message.
            IsComplete

[ 1...1]

[0/5]

 Boolean

Required. Indicates if the Remove Crypto Codes request is complete. Valid values:

  • true – the Remove Crypto Codes Request is complete.
  • false – the Remove Crypto Codes Request is not complete. Use the AsyncID in the Fetch Remove Crypto Codes Result message to retrieve the results of the Remove Crypto Codes message.

Example

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns3:RemoveCryptoCodesResponse xmlns:ns2="http://tracelink.com/som" xmlns:ns3="urn:tracelink:soap">
            <TLResponse>
                <Success>true</Success>
                <TLResponsePayload xsi:type="ns2:TLAsyncResponseType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                    <AsyncID>d770f5c1-5ba7-4c2d-a4bd-2093ef101ddb</AsyncID>
                    <IsComplete>false</IsComplete>
                </TLResponsePayload>
            </TLResponse>
        </ns3:RemoveCryptoCodesResponse>
    </S:Body>
</S:Envelope>

Fetch Remove Crypto Codes Result (SOAP)

Guidelines

Data Element Occurs
Length		 Type
 Description
soapenv:Envelope

[1...1]

[1/*]

 -

Required. The SOAP envelope.
  soapenv:Header

[1...1]

[-]

 -

Required. Not used.
  soapenv:Body

[1...1]

[-]

 -

Required. The SOAP message body.
    urn:FetchRemoveCryptoCodeResult

[1...1]

[-]

 -

Required. The Fetch Remove Crypto Codes Result request message.
      RequestId

[1...1]

[0/*]

 String

Required. The AsyncID received in the Remove Crypto Codes response message.

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:tracelink:soap">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:FetchRemoveCryptoCodeResult>
         <RequestId>bbda2bfe-0b35-49bb-aa4b-09a0478abce0</RequestId>
      </urn:FetchRemoveCryptoCodeResult>
   </soapenv:Body>
</soapenv:Envelope>

Errors

Error Code Error Messages
VALIDATION Incorrect arguments: Only specify serial numbers in the Items list or both a GTIN and Lot Number.
VALIDATION The following serial number(s) in the request do not exist: <serialNumber1>, <serialNumber2>.
VALIDATION LotNumber <lotNumber> not found for GTIN <GTINValue>.

Guidelines

  • If Success = true and neither TLResponsePayload nor ExceptionReturn is present, the serial number(s) in the Remove Crypto Codes message successfully had their crypto key and crypto code attributes removed.
  • If Success = true and TLResponsePayload is present, the Remove Crypto Codes message was successfully submitted but is still being processed.
  • If Success = true and ExceptionReturn is present, the Remove Crypto Codes message was successfully submitted but there is at least one error.

Data Element Occurs
Length		 Type Description
S:Envelope

[ 1...1]

[-]

 -

Required. The SOAP envelope.
  S:Body

[ 1...1]

[-]

 -

Required. The SOAP message body.
    ns3:FetchRemoveCryptoCodeResultResponse

[ 1...1]

[-]

 -

Required. The Fetch Remove Crypto Codes Result response message.
      TLResponse

[ 1...1]

[-]

 -

Required. The message response.
        Success

[ 1...1]

[0/5]

 Boolean

Required. Indicates if the message was successful. Valid values:

  • true – The Fetch Remove Crypto Codes Result request was successful.
  • false – The Fetch Remove Crypto Codes Result request was not successful.
      TLResponsePayload

[ 0...1]

[-]

 -

The container for the asynchronous response ID.
        AsyncID

[ 0...1]

[0/36]

 String

Required. If the Remove Crypto Codes message associated with the RequestId given in the Fetch Remove Crypto Codes request is incomplete, or the RequestId is invalid, the RequestId from the request is returned here.
        IsComplete

[ 0...1]

[0/5]

 Boolean

Required. Indicates if the Remove Crypto Codes request is not complete. Valid values:

  • false – The Remove Crypto Codes Request is not complete.
      ExceptionReturn

[ 0...1]

[-]

 -

The element group for errors.
        CallException

[ 0...1]

[-]

 -

Required. Indicates that there is an error.
          ExceptionCode

[ 0...1]

[0/*]

 String

Required. The exception code associated with the error.
          ExceptionMessage

[ 0...1]

[0/*]

 String

Required. The specific error from the request message.

Example

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns3:FetchRemoveCryptoCodesResultResponse xmlns:ns2="http://tracelink.com/som" xmlns:ns3="urn:tracelink:soap">
         <TLResponse>
            <Success>true</Success>
            <TLResponsePayload xsi:type="ns2:TLAsyncResponseType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
               <AsyncID>bbda2bfe-0b35-49bb-aa4b-09a0478abce0</AsyncID>
               <IsComplete>false</IsComplete>
            </TLResponsePayload>
         </TLResponse>
      </ns3:FetchRemoveCryptoCodesResultResponse>
   </S:Body>
</S:Envelope>