Tracking Request

Endpoint Definition

Request

Request-Urls:

- https://solventum.viya.me/api/custom/request-tracking/gs1ti/v1
- https://solventum.viya.me/api/custom/request-tracking/gs1ti/v1?environment=QA
- https://solventum.viya.me/api/custom/request-tracking/gs1ti/v1?environment=UAT
- https://solventum.viya.me/api/custom/request-tracking/gs1ti/v1?environment=DEV

Request-Method: PUT
Accept: application/xml; charset=utf-8
Accept-encoding: gzip, deflate
x-api-pat:: {{PAT_TOKEN}}

Request Body

Using the contents as discussed, currently the following XSD is used:

https://www.gs1.org/standards/edi-xml/xml-transport-instruction-and-response/3-2

Response Headers

Content-type: application/xml; charset=utf-8

Responses:

The GS1-TI endpoint will be an async endpoint, adding new gs1-ti messages to a que that are processed by Viya. The GS1-TI is a custom ingress and will result in two seperate object created in Viya. A Trailer/Consignment (for the Despatch Advice) and multiple shipments, with Handling Units & Overpacks.

202 Accepted

Payload: No Content

401 Unauthorized

Payload: No Content

500 Server Error

Payload: No Content

503 Service Unavailable

Payload: No Content

Tracking reference determination

Tracking can be handled on consignment level or on handling unit level. The tracking reference is determined by the following rules:

if SSCC is not equal to LOGISTICS_SERVICE_PROVIDER_ASSIGNED, at consignment Logistic unit level, then Logistic unit level tracking (box level)
- transportInstructionMessage.transportInstruction.transportInstructionConsignment.transportInstructionConsignmentItem.logisticUnit.
if SSCC = LOGISTICS_SERVICE_PROVIDER_ASSIGNED, at consignment Logistic unit level, then consignment level tracking (CARRIER_ASSIGNED)
- transportInstructionMessage.transportInstruction.transportInstructionConsignment.

Exception Responses / process

Exceptions for the GS1-TI endpoint will result in a callback to a status endpoint and/or an mail to the person responsible for the process. Depending on the exception a change in SAP can be made and the process can be retried or a issues is raised to resolve the technical problem.

Most common exceptions:

GS1-TI - Despatch Advice example

    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <ns0:transportInstructionMessage xmlns:ns0="urn:gs1:ecom:transport_instruction:xsd:3">
      <ns1:StandardBusinessDocumentHeader xmlns:ns1="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader">
        <ns1:HeaderVersion>1.0</ns1:HeaderVersion>
        <ns1:Sender>
          <ns1:Identifier Authority="GS1">0000000000000</ns1:Identifier>
        </ns1:Sender>
        <ns1:Receiver>
          <ns1:Identifier Authority="GS1">0000000000000</ns1:Identifier>
        </ns1:Receiver>
        <ns1:DocumentIdentification>
          <ns1:Standard>GS1</ns1:Standard>
          <ns1:TypeVersion>3.2.1</ns1:TypeVersion>
          <ns1:InstanceIdentifier>SIS</ns1:InstanceIdentifier>
          <ns1:Type/>
          <ns1:CreationDateAndTime>2024-05-08T17:36:39Z</ns1:CreationDateAndTime>
        </ns1:DocumentIdentification>
        <ns1:BusinessScope>
          <ns1:Scope>
            <ns1:Type>SAP_VERSION</ns1:Type>
            <ns1:InstanceIdentifier/>
            <ns1:Identifier>3.2.1</ns1:Identifier>
          </ns1:Scope>
        </ns1:BusinessScope>
      </ns1:StandardBusinessDocumentHeader>
      <transportInstruction>
        <creationDateTime>2024-05-08T17:35:11Z</creationDateTime>
        <documentStatusCode>ORIGINAL</documentStatusCode>
        <lastUpdateDateTime>2024-05-08T17:36:08Z</lastUpdateDateTime>
        <documentEffectiveDate>
          <date>2024-05-08</date>
          <time>17:35:11</time>
        </documentEffectiveDate>
        <transportInstructionIdentification>
          <entityIdentification>47598347589347</entityIdentification>
        </transportInstructionIdentification>
        <transportInstructionFunction>CONSIGNMENT</transportInstructionFunction>
        <logisticServicesSeller>
          <gln>0000000000000</gln>
          <additionalPartyIdentification additionalPartyIdentificationTypeCode="FOR_INTERNAL_USE_1">0006500000</additionalPartyIdentification>
          <address>
            <city>Hilversum</city>
            <countryCode>NL</countryCode>
            <name>Viya Headquarters</name>
            <postalCode>1223RE</postalCode>
            <state></state>
            <streetAddressOne>Arendstraat 21</streetAddressOne>
          </address>
        </logisticServicesSeller>
        <logisticServicesBuyer>
          <gln>0000000000000</gln>
          <additionalPartyIdentification additionalPartyIdentificationTypeCode="FOR_INTERNAL_USE_1"></additionalPartyIdentification>
          <address>
            <city>Amsterdam</city>
            <countryCode>NL</countryCode>
            <name>Customer HEADQUARTERS</name>
            <postalCode>1000</postalCode>
            <streetAddressOne>Prinsengracht</streetAddressOne>
          </address>
        </logisticServicesBuyer>
        <transportInstructionConsignment>
          <ginc>8010000108006134370825</ginc>
          <transportInstructionStatusCode>CONFIRMED</transportInstructionStatusCode>
          <consignor>
            <gln>0000000000000</gln>
            <additionalPartyIdentification additionalPartyIdentificationTypeCode="FOR_INTERNAL_USE_1">C111</additionalPartyIdentification>
            <address>
              <city>Utrecht</city>
              <countryCode>NL</countryCode>
              <name>NL Hub Utrecht</name>
              <postalCode>2222</postalCode>
              <streetAddressOne>Street 1</streetAddressOne>
            </address>
          </consignor>
          <consignee>
            <gln>0000000000000</gln>
            <additionalPartyIdentification additionalPartyIdentificationTypeCode="FOR_INTERNAL_USE_1">0016102860</additionalPartyIdentification>
            <address>
              <city>Maastricht</city>
              <countryCode>NL</countryCode>
              <name>Consginee Test</name>
              <postalCode>5555</postalCode>
              <state>14</state>
              <streetAddressOne>Straat</streetAddressOne>
            </address>
          </consignee>
          <pickUpParty>
            <gln>0000000000000</gln>
            <additionalPartyIdentification additionalPartyIdentificationTypeCode="FOR_INTERNAL_USE_1">C034</additionalPartyIdentification>
            <address>
              <city>Utrecht</city>
              <countryCode>NL</countryCode>
              <name>NL Hub Utrecht</name>
              <postalCode>2222</postalCode>
              <streetAddressOne>Street 1</streetAddressOne>
            </address>
          </pickUpParty>
          <transportInstructionTerms>
            <transportServiceCategoryType>30</transportServiceCategoryType>
            <transportServiceConditionType>1</transportServiceConditionType>
            <transportServiceLevelCode>DIRECT</transportServiceLevelCode>
          </transportInstructionTerms>
          <transportCargoCharacteristics>
            <cargoTypeCode>11</cargoTypeCode>
            <cargoTypeDescription languageCode="EN">LTL</cargoTypeDescription>
            <totalGrossVolume measurementUnitCode="CBM">1.00</totalGrossVolume>
            <totalGrossWeight measurementUnitCode="KGM">2.544</totalGrossWeight>
          </transportCargoCharacteristics>
          <transportInstructionTransportMovement>
            <sequenceNumber>1</sequenceNumber>
            <transportModeTypeCode>30</transportModeTypeCode>
            <carrier>
              <gln>0000000000000</gln>
              <additionalPartyIdentification additionalPartyIdentificationTypeCode="FOR_INTERNAL_USE_1">0000</additionalPartyIdentification>
              <additionalPartyIdentification additionalPartyIdentificationTypeCode="BUYER_ASSIGNED_IDENTIFIER_FOR_A_PARTY">0006500053</additionalPartyIdentification>
              <address>
                <city>Utrecht</city>
                <countryCode>NL</countryCode>
                <name>NL Hub Utrecht</name>
                <postalCode>2222</postalCode>
                <streetAddressOne>Street 1</streetAddressOne>
              </address>
            </carrier>
            <transportMeans>
              <transportMeansType>NOINFO</transportMeansType>
              <transportMeansID>NOINFO</transportMeansID>
            </transportMeans>
            <plannedDeparture>
              <logisticLocation>
                <gln>0000000000000</gln>
                <additionalLocationIdentification identificationSchemeAgencyCode="FOR_INTERNAL_USE_1">C034</additionalLocationIdentification>
                <locationName>0009001271</locationName>
                <address>
                  <city>Utrecht</city>
                  <countryCode>NL</countryCode>
                  <name>NL Hub Utrecht</name>
                  <postalCode>2222</postalCode>
                  <streetAddressOne>Street 1</streetAddressOne>
                </address>
              </logisticLocation>
              <logisticEventDateTime>
                <date>2024-05-09</date>
                <time>15:50:40</time>
              </logisticEventDateTime>
            </plannedDeparture>
            <plannedArrival>
              <logisticLocation>
                <gln>0000000000000</gln>
                <additionalLocationIdentification identificationSchemeAgencyCode="FOR_INTERNAL_USE_1">0016102860</additionalLocationIdentification>
                <locationName>0016102860</locationName>
                <address>
                  <city>Utrecht</city>
                  <countryCode>NL</countryCode>
                  <name>NL Hub Utrecht</name>
                  <postalCode>2222</postalCode>
                  <streetAddressOne>Street 1</streetAddressOne>
                </address>
              </logisticLocation>
              <logisticEventDateTime>
                <date>2024-05-09</date>
                <time>17:30:35</time>
              </logisticEventDateTime>
            </plannedArrival>
          </transportInstructionTransportMovement>
          <deliveryTerms>
            <incotermsCode>CIP</incotermsCode>
          </deliveryTerms>
          <packageTotal>
            <packageTypeCode>BX</packageTypeCode>
            <totalPackageQuantity>1</totalPackageQuantity>
            <totalGrossVolume measurementUnitCode="CBM">0.015</totalGrossVolume>
            <totalGrossWeight measurementUnitCode="KGM">3.810 </totalGrossWeight>
          </packageTotal>
          <containedShipmentReference>
            <gsin>40236092869904416</gsin>
            <additionalShipmentIdentification additionalShipmentIdentificationTypeCode="CARRIER_ASSIGNED">8091818992</additionalShipmentIdentification>
            <additionalShipmentIdentification additionalShipmentIdentificationTypeCode="LOGISTICS_SERVICE_PROVIDER_ASSIGNED">1818992</additionalShipmentIdentification>
          </containedShipmentReference>
          <transportReference>
            <entityIdentification>9999999999</entityIdentification>
            <transportReferenceTypeCode>TEST</transportReferenceTypeCode>
          </transportReference>
          <handlingInstruction>
            <handlingInstructionText languageCode="EN">Allow Shipment</handlingInstructionText>
          </handlingInstruction>
          <transportInstructionConsignmentItem>
            <lineItemNumber>1</lineItemNumber>
            <transportCargoCharacteristics>
              <cargoTypeCode>12</cargoTypeCode>
              <harmonizedSystemCode>0</harmonizedSystemCode>
            </transportCargoCharacteristics>
            <logisticUnit>
              <sscc>059025961363267233</sscc>
              <additionalLogisticUnitIdentification additionalLogisticUnitIdentificationTypeCode="LOGISTICS_SERVICE_PROVIDER_ASSIGNED">0000000010</additionalLogisticUnitIdentification>
              <grossWeight measurementUnitCode="KGM">3.810</grossWeight>
              <packageTypeCode>BX</packageTypeCode>
              <dimension>
                <depth measurementUnitCode="CM">79.000000</depth>
                <height measurementUnitCode="CM">26.000000</height>
                <width measurementUnitCode="CM">24.000000</width>
              </dimension>
            </logisticUnit>
          </transportInstructionConsignmentItem>
        </transportInstructionConsignment>
        <transportInstructionShipment>
          <gsin>40236092869904416</gsin>
          <additionalShipmentIdentification additionalShipmentIdentificationTypeCode="CARRIER_ASSIGNED">8091818992_2024-05-08</additionalShipmentIdentification>
          <additionalShipmentIdentification additionalShipmentIdentificationTypeCode="LOGISTICS_SERVICE_PROVIDER_ASSIGNED">1818992</additionalShipmentIdentification>
          <transportInstructionStatusCode>CONFIRMED</transportInstructionStatusCode>
          <transportInstructionStatusReasonDescription languageCode="EN">71</transportInstructionStatusReasonDescription>
          <receiver>
            <gln>0000000000000</gln>
            <additionalPartyIdentification additionalPartyIdentificationTypeCode="FOR_INTERNAL_USE_1">0016102860</additionalPartyIdentification>
            <address>
              <city>Utrecht</city>
              <countryCode>NL</countryCode>
              <name>NL Hub Utrecht</name>
              <postalCode>2222</postalCode>
              <streetAddressOne>Street 1</streetAddressOne>
            </address>
          </receiver>
          <shipper>
            <gln>0000000000000</gln>
            <additionalPartyIdentification additionalPartyIdentificationTypeCode="FOR_INTERNAL_USE_1">C034</additionalPartyIdentification>
            <address>
              <city>Utrecht</city>
              <countryCode>NL</countryCode>
              <name>NL Hub Utrecht</name>
              <postalCode>2222</postalCode>
              <streetAddressOne>Street 1</streetAddressOne>
            </address>
          </shipper>
          <carrier>
            <gln>0000000000000</gln>
            <additionalPartyIdentification additionalPartyIdentificationTypeCode="FOR_INTERNAL_USE_1">0006500053</additionalPartyIdentification>
            <address>
              <city>Utrecht</city>
              <countryCode>NL</countryCode>
              <name>NL Hub Utrecht</name>
              <postalCode>2222</postalCode>
              <streetAddressOne>Street 1</streetAddressOne>
            </address>
          </carrier>
          <shipTo>
            <gln>0000000000000</gln>
            <additionalPartyIdentification additionalPartyIdentificationTypeCode="FOR_INTERNAL_USE_1">0016102860</additionalPartyIdentification>
            <address>
              <city>Utrecht</city>
              <countryCode>NL</countryCode>
              <name>NL Hub Utrecht</name>
              <postalCode>2222</postalCode>
              <streetAddressOne>Street 1</streetAddressOne>
            </address>
          </shipTo>
          <transportInstructionTerms>
            <transportServiceCategoryType>TM</transportServiceCategoryType>
            <transportServiceConditionType>SERVICE_LEVEL_NOT_DEFINED</transportServiceConditionType>
            <transportServiceLevelCode>STANDARD</transportServiceLevelCode>
          </transportInstructionTerms>
          <transportCargoCharacteristics>
            <cargoTypeCode>11</cargoTypeCode>
            <finalDestinationCountry>PL</finalDestinationCountry>
            <totalGrossVolume measurementUnitCode="CBM">0.015 </totalGrossVolume>
            <totalGrossWeight measurementUnitCode="KGM">3.810 </totalGrossWeight>
            <totalPackageQuantity>1</totalPackageQuantity>
          </transportCargoCharacteristics>
          <plannedDelivery>
            <logisticEventTypeCode>SERVICE_PROVIDER_DELIVERY_DATE</logisticEventTypeCode>
            <logisticLocation>
              <additionalLocationIdentification identificationSchemeAgencyCodeCodeListVersion="SAPTM">Y0016102860</additionalLocationIdentification>
            </logisticLocation>
            <logisticEventDateTime>
              <date>2024-05-09</date>
              <time>15:50:40</time>
            </logisticEventDateTime>
          </plannedDelivery>
          <deliveryTerms>
            <incotermsCode>CIP</incotermsCode>
          </deliveryTerms>
          <packageTotal>
            <packageTypeCode>BX</packageTypeCode>
            <totalPackageQuantity>1</totalPackageQuantity>
            <totalGrossVolume measurementUnitCode="CBM">0.015</totalGrossVolume>
            <totalGrossWeight measurementUnitCode="KGM">3.810 </totalGrossWeight>
          </packageTotal>
          <transportReference>
            <entityIdentification>6134370825</entityIdentification>
            <transportReferenceTypeCode>TRI</transportReferenceTypeCode>
          </transportReference>
          <transportReference>
            <entityIdentification>8091818992</entityIdentification>
            <transportReferenceTypeCode>SRN</transportReferenceTypeCode>
          </transportReference>
          <handlingInstruction>
            <handlingInstructionText languageCode="EN">DASC | Dabrowa (allow split shipments)</handlingInstructionText>
          </handlingInstruction>
          <transportInstructionShipmentItem>
            <lineItemNumber>1</lineItemNumber>
            <note languageCode="EN">NUMBER_OF_OUTER_PACKAGES= |GROSS_WEIGHT_DANGEROUS=|OUTER_PACKAGE_INFORMATION= |HAZARDOUS_PACKAGE_TYPE=|DG_PACKING=BOX</note>
            <logisticUnit>
              <sscc>059025961363267226</sscc>
              <additionalLogisticUnitIdentification additionalLogisticUnitIdentificationTypeCode="LOGISTICS_SERVICE_PROVIDER_ASSIGNED">0000000030</additionalLogisticUnitIdentification>
              <parentLogisticUnitId>
                <sscc>059025961363267233</sscc>
                <additionalLogisticUnitIdentification additionalLogisticUnitIdentificationTypeCode="LOGISTICS_SERVICE_PROVIDER_ASSIGNED">0000000010</additionalLogisticUnitIdentification>
              </parentLogisticUnitId>
              <grossWeight measurementUnitCode="KGM">3.810</grossWeight>
              <packageTypeCode>BX</packageTypeCode>
              <dimension>
                <depth measurementUnitCode="CM">79.000000</depth>
                <height measurementUnitCode="CM">26.000000</height>
                <width measurementUnitCode="CM">24.000000</width>
              </dimension>
            </logisticUnit>
            <transactionalTradeItem>
              <gtin>07318640063280</gtin>
              <additionalTradeItemIdentification additionalTradeItemIdentificationTypeCode="SUPPLIER_ASSIGNED">XH001680434</additionalTradeItemIdentification>
              <additionalTradeItemIdentification additionalTradeItemIdentificationTypeCode="BUYER_ASSIGNED">NOINFO</additionalTradeItemIdentification>
              <tradeItemQuantity>3.000</tradeItemQuantity>
              <tradeItemDescription languageCode="EN">MT53H7A4400-EU LITECOM PMR 446 HEADBAND</tradeItemDescription>
              <transactionalItemData>
                <tradeItemQuantity>3.000</tradeItemQuantity>
              </transactionalItemData>
            </transactionalTradeItem>
            <transportReference>
              <entityIdentification>402663430500010</entityIdentification>
              <transportReferenceTypeCode>AAJ</transportReferenceTypeCode>
            </transportReference>
            <transportReference>
              <entityIdentification>ZD/454/2024</entityIdentification>
              <transportReferenceTypeCode>AAO</transportReferenceTypeCode>
            </transportReference>
            <packageTotal>
              <packageTypeCode>BX</packageTypeCode>
              <totalPackageQuantity>1</totalPackageQuantity>
              <totalGrossVolume measurementUnitCode="CBM">0.015 </totalGrossVolume>
              <totalGrossWeight measurementUnitCode="KGM">3.810 </totalGrossWeight>
            </packageTotal>
            <dangerousGoodsInformation>
              <dangerousGoodsUNIdentifier>0000</dangerousGoodsUNIdentifier>
              <dangerousGoodsShippingName languageCode="EN">BATTERIES, DRY</dangerousGoodsShippingName>
              <dangerousGoodsDescription languageCode="EN">IND_LIMITED_QTY=N|IND_EXCEPTED_QTY=N|</dangerousGoodsDescription>
              <dangerousGoodsRegulationInformation>
                <dangerousGoodsRegulationCode>ICA</dangerousGoodsRegulationCode>
                <dangerousGoodsRegulationName>International Air Transport Dangerous Goods Regulations - Passenger Aircraft</dangerousGoodsRegulationName>
                <dangerousGoodsHazardClass>NO_INFORMATION</dangerousGoodsHazardClass>
                <dangerousGoodsPackingGroup>NO_INFORMATION</dangerousGoodsPackingGroup>
                <dangerousGoodsAttribute>
                  <dangerousGoodsAttributeTypeCode>MARINE_POLLUTANT</dangerousGoodsAttributeTypeCode>
                  <dangerousGoodsAttributeText>N</dangerousGoodsAttributeText>
                </dangerousGoodsAttribute>
                <dangerousGoodsAttribute>
                  <dangerousGoodsAttributeTypeCode>FLASHPOINT</dangerousGoodsAttributeTypeCode>
                  <dangerousGoodsAttributeText>NO_INFORMATION</dangerousGoodsAttributeText>
                </dangerousGoodsAttribute>
                <dangerousGoodsAttribute>
                  <dangerousGoodsAttributeTypeCode>PACKAGING_INFORMATION</dangerousGoodsAttributeTypeCode>
                  <dangerousGoodsAttributeText>SPA123</dangerousGoodsAttributeText>
                </dangerousGoodsAttribute>
              </dangerousGoodsRegulationInformation>
            </dangerousGoodsInformation>
            <avpList>
              <eComStringAttributeValuePairList attributeName="SUPPLIER_SOLD_QUANTITY">3.000 </eComStringAttributeValuePairList>
              <eComStringAttributeValuePairList attributeName="SUPPLIER_SOLD_UOM">EA</eComStringAttributeValuePairList>
              <eComStringAttributeValuePairList attributeName="SUPPLIER_PRODUCT_DESCRIPTION">MT53H7A4400-EU LITECOM PMR 446 HEADBAND</eComStringAttributeValuePairList>
              <eComStringAttributeValuePairList attributeName="BUYER_SOLD_QUANTITY">3.00000000000000 </eComStringAttributeValuePairList>
              <eComStringAttributeValuePairList attributeName="BUYER_SOLD_UOM">EA</eComStringAttributeValuePairList>
              <eComStringAttributeValuePairList attributeName="BUYER_PRODUCT_DESCRIPTION">MT53H7A4400-EU LITECOM PMR 446 HEADBAND</eComStringAttributeValuePairList>
              <eComStringAttributeValuePairList attributeName="DAMAGED_PARENT">NODAMAGE</eComStringAttributeValuePairList>
              <eComStringAttributeValuePairList attributeName="DAMAGED">NODAMAGE</eComStringAttributeValuePairList>
            </avpList>
          </transportInstructionShipmentItem>
        </transportInstructionShipment>
      </transportInstruction>
    </ns0:transportInstructionMessage>

GS1-TI - Exception example

    <problem xmlns="urn:ietf:rfc:7807">
        <messageId>12893752289</messageId>
        <reference>TRL1036LNUM</reference>
        <title>Invalid XML according to schema</title>
        <status>400</status>
        <detail>Elements in the XML are invalid, see details in errors</detail>
        <instance>api/v0/gs1-ti</instance>
        <type>https://httpstatuses.com/400</type>
        <timestamp>2021-06-14 09:13:18<timestamp>
        <errors>The element 'transportInstruction' has invalid child element 'NonExistent'. List of possible elements expected: 'logisticServicesSeller';
                The 'date' element is invalid - The value 'aaa' is invalid according to its datatype. http://www.w3.org/2001/XMLSchema:date' - The string 'aaa' is not a valid Date value
        </errors>
    </problem>