Update Order Shipment 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.

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:UpdateOrderShipment [1...1]
[]
-

Required. Creates or updates a shipment request message.

      OrderRequest -

Includes all elements for the request.

        @deliveryNumber [1...1]
[1/*]
String

Required. Delivery number that links the order information to the serialized pick information for this customer delivery. *1

        previousDeliveryNumber [0...1]
[0/*]
String

Original delivery number. Records the original delivery number that is replaced when a shipment is voided and corrections are made to that delivery.

        OrderDate [0...1]
[10/10]
Date

The date of the business transaction in XML YYYY-MM-DD format. If omitted, system will set to current date. *2

        EventDateTime [0...1]
[]
DateTime

The date and time of the event in XSD Date format in GMT (YYYY-MM-DDTHH:MM:SS.sssZ). If omitted, the system will record the current date time.

        OrderComplete [1...1]
[]
Boolean

Required. The order complete flag instructs the system to process the outbound delivery, update the status of all serial numbers and sub-child aggregations, and trigger generation of regulatory reporting messages based on customer configuration. *3

  • If all of the information (order detail and picked serial numbers) are provided in a single message, the order complete flag is set to true.
  • If only partial information is provided in the message, (e.g. order detail only, picked items sent incrementally, etc.), the order complete flag is set to false for all intermediate messages, and then set to true when the delivery is complete and all information has been communicated to TraceLink.
        ShipToCountryCode [0...1]
[0/3]
String

Conditionally required if SoldFromParty and SoldToParty are omitted. Two-letter ISO country code for ship to country. This value will be referenced to advise regulatory reporting if it is required for the specified country market. Setting this value alone does not trigger regulatory reporting. Actual triggering of regulatory reporting is governed by customer administrative configuration in the TraceLink application. *4

Must be populated before OrderComplete is set to true.

See the ISOCountryCode enumeration list for valid values.

        ShipFromCountryCode [0...1]
[0/3]
String

Conditionally required when:

  • shipment type is set to either Sale-Export, Return-Export, or Transfer-Export; otherwise, it is auto-populated with the ShipToCountryCode value.
  • SoldFromParty and SoldToParty are omitted.

The two-letter ISO country code for the ship from country. Provides application with the information it needs to trigger regulatory reporting in response to relevant events.

Must be populated before OrderComplete is set to true.

See the ISOCountryCode enumeration list for valid values.

        ShortShip [0...1]
[0/*]
Boolean

Instructs the system whether to allow short picks when verifying the quantities of what is expected to be picked (in OrderItems) against the each quantities of actual scanned serial numbers (in PickedItem). *5

If set to false, other errors will still be flagged, such as incorrect product/lot and over-picks. Defaults to false.

        SaleType [0...1]
[1/*]
String

This value will be referenced to advise the application of sale (change of ownership of the product) and transfer (no change of ownership of product, but physical movement of product) for application and regulatory reporting purposes. Setting this value alone does not trigger regulatory reporting. Actual triggering of regulatory reporting is governed by customer administrative configuration in the TraceLink application.

Must be populated before OrderComplete is set to true.

See the SalesDistType enumeration list for valid values.

        ContractType [0...1]
[0/*]
String

Conditionally required if ShipFromCountryCode = KR and SalesDistributionType = EXPORTSALE or INCOUNTRYSALE. Identifies the type of the contract for the sale of goods using one of the permitted values.

See the ContractType enumeration list for valid values.

        SupplyType [0...1]
[0/*]
String

Conditionally required if ShipFromCountryCode = KR and SalesDistributionType = EXPORTSALE or INCOUNTRYSALE. Identifies the type of supply that is being performed using one of the permitted values.

Country requirements:
  • For Korea: all values except for Collection apply.
  • For Brazil: populate only if performing a Collection, Donation, or SampleDistribution.

See the SupplyType enumeration list for valid values.

        ContractNumber [0...1]
[1/*]
String Identification number of the contract. *6
        RemovalFromCirculation [0...1]
[1/*]
String

Reason the product in the delivery is taken out of the supply chain. *7

See the RemovalFromCirculationReasonCode enumeration list for valid values.

        FundingSource [0...1]
[1/*]
tring

Conditionally required if the ShipFromCountry = RU. Source of the funding. *8

See the FundingSource enumeration list for valid values.

        Comments [0...1]
[0/200]
String

Optional remarks or comments associated with the delivery.

        SoldFromParty [0...1]
[]
-

Conditionally required for:

  • transfer or sale involving non-EU FMD countries.
  • transfer or sale export from an EU FMD country to US, CN, KR, or RU due to country compliance requirements.

Represents the FromBusinessParty in the transaction.

          BusinessIdentifiers [0...1]
[]
-

Required. A list of one or more identifiers associated with the FromBusinessParty.

            BusinessIdentifier [1...*]
[]
-

Required. The identifier associated with the from business entity. See Business Identifiers by Country.

              @identifiertype [1...1]
[1/*]
String

Required. The type of the BusinessId identifier.

See the BusinessAndLocationId enumeration list for valid values.

              @identifiervalue [1...1]
[]
-

Required. Business identifier value. *9

 
          BusinessClassification [0...1]
[0/*]
String

Conditionally required for Argentina, or if ShipFromCountry = KR and SalesDistributionType = EXPORTSALE or INCOUNTRYSALE.

This field classifies the business type of the TraceLink customer or trading partner.

          BusinessName [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The business name of the trading partner. *10

          Street1 [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The first line of the street address. *11

          Street2 [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The second line of the street address. *12

          City [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The city. *13

          District [0...1]
[0/*]
String

Conditionally required for India. District Code only for India. *14

Must be a 3-digit numeric code.
          StateOrRegion [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *15

          PostalCode [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false.The ZIP or other postal code. *16

          CountryCode [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The country, using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *17

          AddressObjectGUID [0...1]
[0/*]
String

The global identifier assigned by Russian Federation Information Address System (FIAS).

Maximum 36 characters, using the digits 0-9 and letters A-F.
          HouseGUID [0...1]
[0/*]
String The global House identifier assigned by the Russian Federation Information Address System (FIAS).
Maximum 36 characters, using the digits 0-9 and letters A-F.
          TaxRegistrationCode [0...1]
[0/*]
String

Tax registration code. *18

          PremisesCode [0...1]
[0/*]
String

Internal identifier a company uses for a specific location. For example, a company with 4 locations in the city of Mumbai that internally refers to the 4th location as MUM4. *19

          Village [0...1]
[0/*]
String

Name of the village in which the company is located. *20

          HouseNumber [0...1]
[0/*]
String

Building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in Street1. *21

          Township [0...1]
[0/*]
String

Name of the township in which the company is located. *22

          CorporateFax [0...1]
[0/*]
String

Company fax number. *23

          DefaultFromMasterData [1...1]
[]
Boolean

Required. Instructs the system whether to look up the business name and address information from master data. *24

  • If set to true, only the BusinessIdentifier and type should be populated and the system will perform the look-up in master data to populate the remaining fields.
  • If set to false, the other fields are required before OrderComplete is set to true.
        ShipFromLocation [0...1]
[]
-

Represents the ShipFromLocation in the transaction.

If provided, must be populated before OrderComplete is set to true.
          BusinessIdentifiers [0...1]
[]
-

Required. A list of one or more identifiers associated with the

ShipFromLocation.

            BusinessIdentifier [1...*]
[]
-

Required. Populated with the ShipFromLocation identifier. See

Business Identifiers by Country.

              @identifiertype [1...1]
[1/*]
String

Required. The type of the location identifier.

See the BusinessAndLocationId enumeration list for valid values.

              @identifiervalue [1...1]
[]
-

Conditionally required if DefaultFromMasterData is unset or set

to false. The business name of the trading partner.

          BusinessClassification [0...1]
[0/*]
String

Conditionally required for Argentina. This field classifies the business type of the TraceLink customer or trading partner.

See the BusinessClassification enumeration list for valid values.

          BusinessName [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The business name of the trading partner.

          Street1 [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The first line of the street address.
          Street2 [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The second line of the street address.
          City [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The city.

          District [0...1]
[0/*]
String

Conditionally required for India. District Code only for India.

Must be a 3-digit numeric code.
          StateOrRegion [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code.

          PostalCode [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The ZIP or other postal code.

          CountryCode [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The country, using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.

          AddressObjectGUID [0...1]
[0/*]
String

The global identifier assigned by Russian Federation Information Address System (FIAS).

Maximum 36 characters, using the digits 0-9 and letters A-F.
          HouseGUID [0...1]
[0/*]
String The global House identifier assigned by the Russian Federation Information Address System (FIAS).
Maximum 36 characters, using the digits 0-9 and letters A-F.
          TaxRegistrationCode [0...1]
[0/*]
String

Tax registration code. *25

          PremisesCode [0...1]
[0/*]
String

Internal identifier a company uses for a specific location. For example, a company with 4 locations in the city of Mumbai that internally refers to the 4th location as MUM4. *26

          Village [0...1]
[0/*]
String

Name of the village in which the company is located. *27

          HouseNumber [0...1]
[0/*]
String

Building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in Street1. *28

          Township [0...1]
[0/*]
String

Name of the township in which the company is located. *29

          CorporateFax [0...1]
[0/*]
String

Company fax number. *30

          DefaultFromMasterData [1...1]
[]
Boolean

Required. Instructs the system whether to look up the business name and address information from master data.

  • If set to true, only the BusinessIdentifier and type should be populated and the system will perform the look-up in master data to populate the remaining fields.
  • If set to false, the other fields are required before OrderComplete is set to true.
          License [0...*]
[]
-

List of zero or more license numbers associated with the facility. This element can

be repeated to include as many license numbers as required (e.g. state and federal license).

            LicenseNumber [1...1]
[1/*]
String

Required.

License number value. *31

            State [0...1]
[1/*]
String

The state or region in which the trading partner is licensed, using the standard two-

letter abbreviation specified in ISO 3166-2:1998 country sub-division code. Provides additional context to the license number. *32

            Agency [0...1]
[1/*]
String

The agency that granted the license (e.g. National Association of Boards of

Pharmacy [NABP]). Provides additional context to the license number. *33

          Contact [0...1]
[]
-

Contact information for use by downstream trading partners to verify the

transaction information.

            Name [1...1]
[1/*]
String

Required. The name of the contact department or individual at the

company. *34

            Telephone [0...1]
[1/*]
String

The phone number of the contact department or individual at the company. This

must begin with the + character followed by the Country Calling Code. *35

            Email [0...1]
[1/*]
String

The email address of the contact department or individual at the company. Should

be included if available. *36

            Title [0...1]
[1/*]
String

The title of the individual if a person was provided in Name.

 

            Url [0...1]
[1/*]
String

The Web address for the business contact.  *37

 

        SoldToParty [0...1]
[]
-

Conditionally required if:

  • transfer or sale involving non-EU FMD countries.
  • transfer or sale export from an EU FMD country to US, CN, KR, or RU due to country compliance requirements.

Represents the ToBusinessParty in the transaction.

          BusinessIdentifiers [0...1]
[]
-

Required. A list of one or more identifiers associated with the

ToBusinessParty.

            BusinessIdentifier [1...*]
[]
-

Required. The identifier associated with the ToBusinessParty

entity. See Business Identifiers by Country.

              @identifiertype [1...1]
[1/*]
String

Required. The type of the BusinessId identifier.

See the BusinessAndLocationId enumeration list for valid values.

              @identifiervalue [1...1]
[]
-

Required. Business identifier value.

 

          BusinessClassification [0...1]
[0/*]
String

Conditionally required for Argentina, or if ShipFromCountryCode = KR and Sales Distribution Type = EXPORTSALE or INCOUNTRYSALE. This field classifies the business type of the TraceLink customer or trading partner.

See the BusinessClassification enumeration list for valid values.

          BusinessName [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The business name of the trading partner.

          Street1 [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false . The first line of the street address.

          Street2 [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The second line of the street address.

          City [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The city.

          District [0...1]
[0/*]
String

Conditionally required for India. District Code only for India.

Must be a 3-digit numeric code.
          StateOrRegion [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code.

          PostalCode [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The ZIP or other postal code.

          CountryCode [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The country, using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.

          AddressObjectGUID [0...1]
[0/*]
String

The global identifier assigned by Russian Federation Information Address System (FIAS).

Maximum 36 characters, using the digits 0-9 and letters A-F.
          HouseGUID [0...1]
[0/*]
String The global House identifier assigned by the Russian Federation Information Address System (FIAS).
Maximum 36 characters, using the digits 0-9 and letters A-F.
          TaxRegistrationCode [0...1]
[0/*]
String

Tax registration code. *38

          PremisesCode [0...1]
[0/*]
String

Internal identifier a company uses for a specific location. For example, a company with 4 locations in the city of Mumbai that internally refers to the 4th location as MUM4. *39

          Village [0...1]
[0/*]
String

Name of the village in which the company is located. *40

          HouseNumber [0...1]
[0/*]
String

Building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in Street1. *41

          Township [0...1]
[0/*]
String

Name of the township in which the company is located. *42

          CorporateFax [0...1]
[0/*]
String

Company fax number. *43

          DefaultFromMasterData [1...1]
[]
Boolean

Required. Instructs the system whether to look up the business name and address information from master data.

  • If set to true, only the BusinessIdentifier and type should be populated and the system will perform the look-up in master data to populate the remaining fields.
  • If set to false, the other fields are required before OrderComplete is set to true.
        ShipToLocation [0...1]
[]
-

Represents the ShipToLocation in the transaction.

If populated, must be populated before OrderComplete is set to true.
          BusinessIdentifiers [0...1]
[]
-

Required. A list of one or more identifiers associated with the ShipToLocation.

 

            BusinessIdentifier [1...*]
[]
-

Required. Populated with the ShipToLocation identifier. See Business Identifiers by Country.

 

              @identifiertype [1...1]
[1/*]
String

Required. The type of the location identifier.

See the BusinessAndLocationId enumeration list for valid values.

              @identifiervalue [1...1]
[]
-

Required. Business identifier value.

 

          BusinessClassification [0...1]
[0/*]
String

Conditionally required for Argentina. This field classifies the business type of the TraceLink customer or trading partner.

See the BusinessClassification enumeration list for valid values.

          BusinessName [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The business name of the trading partner.

          Street1 [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The first line of the street address.

          Street2 [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The second line of the street address.

          City [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The city.

          District [0...1]
[0/*]
String

Conditionally required for India. District Code only for India.

Must be a 3-digit numeric code.
          StateOrRegion [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code.

          PostalCode [0...1]
[1/*]
String Conditionally required if DefaultFromMasterData is unset or set to false. The ZIP or other postal code.
          CountryCode [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The country, using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.

          AddressObjectGUID [0...1]
[0/*]
String

The global identifier assigned by Russian Federation Information Address System (FIAS).

Maximum 36 characters, using the digits 0-9 and letters A-F.
          HouseGUID [0...1]
[0/*]
String The global House identifier assigned by the Russian Federation Information Address System (FIAS).
Maximum 36 characters, using the digits 0-9 and letters A-F.
          TaxRegistrationCode [0...1]
[0/*]
String

Tax registration code. *44

          PremisesCode [0...1]
[0/*]
String

Internal identifier a company uses for a specific location. For example, a company with 4 locations in the city of Mumbai that internally refers to the 4th location as MUM4. *45

          Village [0...1]
[0/*]
String

Name of the village in which the company is located. *46

          HouseNumber [0...1]
[0/*]
String

Building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in Street1. *47

          Township [0...1]
[0/*]
String

Name of the township in which the company is located. *48

          CorporateFax [0...1]
[0/*]
String

Company fax number. *49

          DefaultFromMasterData [1...1]
[]
Boolean

Required. Instructs the system whether to look up the business name and address information from master data.

  • If set to true, only the BusinessIdentifier and type should be populated and the system will perform the look-up in master data to populate the remaining fields.
  • If set to false, the other fields are required before OrderComplete is set to true.
          License [0...*]
[]
-

List of zero or more license numbers associated with the facility. Can be repeated to include as many license numbers as required (e.g. state and federal license).

 

            LicenseNumber [1...1]
[1/*]
String

Required. License number value.

 

            State [0...1]
[1/*]
String

The state or region in which the trading partner is licensed, using the standard two-

letter abbreviation specified in ISO 3166-2:1998 country sub-division code. Gives additional context to the license number.

            Agency [0...1]
[1/*]
String

The agency that granted the license (e.g. National Association of Boards of

Pharmacy [NABP]). Gives additional context to the license number.

          Contact [0...1]
[]
-

Contact information for use by downstream trading partners to verify the

transaction information.

            Name [1...1]
[1/*]
String

Required. The name of the contact department or individual at the

company.

            Telephone [0...1]
[1/*]
String

The phone number of the contact department or individual at the company. This

must begin with the + character followed by the Country Calling Code.

            Email [0...1]
[1/*]
String

The email address of the contact department or individual at the company. Should

be included if available.

            Title [0...1]
[1/*]
String

The title of the individual if a person was provided in Name.

 

            Url [0...1]
[1/*]
String

The Web address for the business contact.

 

        TransportationCarrier [0...1]
[]
-

Conditionally required for shipments made into and within Brazil

(ShipToCountryCode = BR). Represents the transportation partner that is transporting the shipment.

If populated, must be populated before OrderComplete is set to true.
          BusinessIdentifiers [0...1]
[]
-

Required. A list of one or more identifiers associated with the

ShipToLocation.

            BusinessIdentifier [1...*]
[]
-

Required. The identifier associated with the transport carrier business entity. This value is required for regulatory reporting. Different countries require different values as noted below.

Brazil: Provide the BR_PROF_REG, BR_CNES, BR_CNPJ, or BR_CPF. BR_CNPJ is the value preferred by ANVISA if the company has one.
              @identifiertype [1...1]
[1/*]
String

Required. The type of the location identifier.

 See the BusinessAndLocationId enumeration list for valid values.

              @identifiervalue [1...1]
[]
-

Required. Business identifier value.

 

          BusinessClassification [0...1]
[0/*]
String

Conditionally required for Argentina. This field classifies the business type of the TraceLink customer or trading partner.

See the BusinessClassification enumeration list for valid values.

          BusinessName [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The business name of the trading partner.

          Street1 [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The first line of the street address.

          Street2 [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The second line of the street address.

          City [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The city.

          District [0...1]
[0/*]
String

Conditionally required for India. District Code only for India.

Must be a 3-digit numeric code.
          StateOrRegion [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code.

          PostalCode [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The ZIP or other postal code.

          CountryCode [0...1]
[1/*]
String

Conditionally required if DefaultFromMasterData is unset or set

to false. The country, using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.

          AddressObjectGUID [0...1]
[0/*]
String

Conditionally required for generating the 541 – Move Destruction

Report for Russia. The global identifier assigned by Russian Federation Information Address System (FIAS).

Maximum 36 characters, using the digits 0-9 and letters A-F.
          HouseGUID [0...1]
[0/*]
String The global House identifier assigned by the Russian Federation Information Address System (FIAS).
Maximum 36 characters, using the digits 0-9 and letters A-F.
          TaxRegistrationCode [0...1]
[0/*]
String

Tax registration code. *50

          PremisesCode [0...1]
[0/*]
String

Internal identifier a company uses for a specific location. For example, a company with 4 locations in the city of Mumbai that internally refers to the 4th location as MUM4. *51

          Village [0...1]
[0/*]
String

Name of the village in which the company is located. *52

          HouseNumber [0...1]
[0/*]
String

Building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in Street1. *53

          Township [0...1]
[0/*]
String

Name of the township in which the company is located. *54

          CorporateFax [0...1]
[0/*]
String

Company fax number. *55

          DefaultFromMasterData [1...1]
[]
Boolean

Required. Instructs the system whether to look up the business name and address information from master data.

  • If set to true, only the BusinessIdentifier and type should be populated and the system will perform the look-up in master data to populate the remaining fields.
  • If set to false, the other fields are required before OrderComplete is set to true.
        DropShipment [0...1]
[0/*]
Boolean
  • If set to true, indicates shipment is a drop shipment.
  • If not set, or set to false, the system treats as a standard shipment.
        portalAccessCode [0...1]
[0/*]
String The portal access code used to access drop shipments in the serialized drop ship portal.
        EntryPort [0...1]
[0/*]
String

Name of the shipment's port of entry into a country (e.g. an airport, maritime port, border checkpoint). *56

        ExitPort [0...1]
[0/*]
String

Name of the shipment's port of exit from a country (e.g. an airport, maritime port, border checkpoint). *57

        AttemptDisaggregation [0...1]
[0/*]
Boolean
  • When set to true, instructs the system to disaggregate the picked serial number from the parent container, if it is aggregated.
  • If not set, or set to false, the system will operate in default mode, which is to generate an error if attempting to pick serial number for an item or container that is aggregated to a parent.
        IsCorrectiveShipment [0...1]
[0/*]
Boolean

Indicates that a new Serialized Operations Manager shipment is correcting a previously voided Serialized Operations Manager shipment. Valid values:

  • false – (default) The receipt is not a corrective shipment.
  • true – The receipt is a corrective shipment.
        Transactions [0...1]
[]
-

The transaction identifier associated with the shipment.

Must be populated before OrderComplete is set to true.
          Transaction [0...*]
[]
-

Required. List of one or more transaction identifiers.

 

            OrderId [0...1]
[1/*]
String

Required. The transaction identifier associated with the shipment, for regulatory reporting and business tracking purposes. At least one is required and, depending on country more than one transaction ids may be required. *58

Country requirements:
  • Argentina: provide Packing Slip Number.
  • China: provide Sales Order Number.
  • Brazil: provide PO Number, ASN Numbe,r and Invoice Number if available.
  • US: provide PO Number, ASN Number, and Invoice Number if available.
            OrderType [0...1]
[1/*]
String

Required. The transaction identifier type using the supported enumeration values.

See the TransactionId enumeration list for valid values.

            Date [0...1]
[1/*]
String

Required. The Date of the transaction in XML YYYY-MM-DD format.

This value is used for regulatory reporting of the transaction Date.

        PickedItem [0...1]
[]
-

Supports incremental picking, which adds serial numbers to the delivery while the

delivery is still open. Each time new serial numbers are submitted against the delivery, the system will add these serial numbers to the set of picked serial numbers associated with the delivery.

          WarehouseOperator [0...1]
[0/*]
String

Conditionally required for China. Name of the person

responsible for warehouse operations. This element can be communicated at any time (e.g. with, before, or after the order details or picked items have been communicated). *59

          DeliveryInspection [0...1]
[1/*]
String

The inspection status of the physical delivery against the delivery documentation.

See the DeliveryInspection enumeration list for valid values.

          DeliveryInspectionDate [0...1]
[10/10]
Date The date of the physical delivery against the delivery documentation in XML YYYY-MM-DD format. *60
          DeliveryInspectionNote [0...1]
[0/*]
String Comments about the physical delivery inspection against the delivery documentation.
          AggregationInspection [0...1]
[1/*]
String

The inspection status of the aggregation hierarchy of the container.

See the AggregationInspection enumeration list for valid values.

          Items [0...1]
[]
-

The list of serial numbers in the shipment. Can be a top-level container serial

number if the items are aggregated and/or are loose items.

            Item [0...*]
[]
-

Repeating element capturing the serial numbers.

 

              @sn [1...1]
[1/*]
String

Required. Serial Number in the format specified in the request.

 *61

              @namespace [0...1]
[1/*]
String

Not used by TraceLink.

 

              @orderItemNumber [0...1]
[1/*]
String

Reference to the Order Item. This enables the association of Unit Price, VAT, and

Gross Price to specific serial numbers.

        OrderItems [1...1]
[]
-

Conditionally required if ShipFromCountry = KR. List of items expected to be in the shipment.

  • If provided, the system will verify the picked serial numbers against the expected items in the shipment and generate an error if incorrect products were picked against the order.
  • If not provided, the system will accept the serial numbers against the order and only verify that the serial numbers are in a shippable state.
          OrderItem [0...*]
[]
-

Conditionally required if ShipFromCountry = KR and salesDistributioType = EXPORTSALE or INCOUNTRYSALE. Order item

group is a repeating element that captures the item code, lot number and quantity for each item that will be picked for the order. Each unique item code and lot number is communicated in a separate order item group.

            OrderItemNumber [0...1]
[1/*]
String

Serial number reference allowing serial numbers to be tracked to OrderItems.

 *62

            InternalItemCode [0...1]
[1/*]
String

Option 1 in OrderItem: Use to identify the product using the internal material number configured in Product Master Data. *63

Populated only if PackagingItemCode is not populated.
            PackagingItemCode [0...1]
[1/*]
String

Option 2 in OrderItem: Use to identify the product using the packaging level item code (e.g. GTIN-14) configured in Product Master Data. *64

Populated only if InternalMaterialCode is not populated.
            PackagingItemCodeType [0...1]
[1/*]
String

Conditionally required if PackagingItemCode is populated. Identifies the packaging level item code type.

See the ItemCodeType enumeration list for valid values.

            Quantity [1...1]
[]
Integer

Required. The quantity of items at the EACH (unit) level of the item code and lot if specified to be picked.

If multiple GTINs at the same packaging level are associated with the same Internal Material Code, the system automatically combines quantities from those GTINs and provides a single quantity for the Internal Material Code.
            Lot [0...1]
[1/*]
String

Required. The lot or batch code for the items to be picked (if available)

in an alphanumeric string. *65

            ExpirationDate [0...1]
[10/10]
Date

The expiration date for the items to be picked (if available). Date is in xsd:date

format YYYY-MM-DD. *66

            UnitPrice [0...1]
[]
Decimal

Conditionally required if:

  • ShipToCountryCode = KR and SalesDistributionType = EXPORTSALE or INCOUNTRYSALE.
  • ShipToCountryCode = RU.

The unit price of the item.

            CurrencyCode [0...1]
[3/3]
String

Conditionally required if UnitPrice is populated. Currency ISO code using ISO 4217-2015 format.

See the CurrencyCode enumeration list for valid values.

            GrossPrice [0...1]
[]
Decimal

Conditionally required if ShipToCountryCode = RU.

Unit price of the item including all taxes and fees. *67

            GrossPriceCurrencyCode [0...1]
[0/3]
String

Conditionally required if UnitPricePlus is populated. Currency ISO code using ISO 4217-2015 format.

See the ISOCurrency enumeration list for valid values.

            VAT [0...1]
[1/16]
Decimal Value Added Tax per unit. *68

 

            VATCurrencyCode [0...1]
[0/3]
String

Conditionally required if VAT is populated. Currency ISO code using ISO 4217-2015 format.

See the ISOCurrency enumeration list for valid values.

            Serialized [0...1]
[4/5]
Boolean

Indicates if item is not serialized. If omitted, defaults value to true.

 

            OrderItemTransactions [0...1]
[]
- The transaction identifier associated with the individual order receipt items.

 

              OrderItemTransaction [1...*]
[]
- Required. List of one or more transaction identifiers.

 

                OrderId [1...1]
[1/*]
String Required. The transaction identifier associated with the shipment. This is for regulatory reporting and business tracking purposes. At least one identifier is required. *69
                OrderType [1...1]
[1/*]
String Required. The transaction identifier type.

Valid values: *70

  • DESTRUCTION
  • INVOICE
  • NOTA_FISCAL_ELETRONICA
  • OTHER
  • PO
  • RETURN
                Date [0...1]
[1/*]
String

Conditionally required if ShipToCountryCode = RU.

The date of the transaction in XML YYY-MM-DD format. This value is used for regulatory reporting of the transaction date. *71

        CDEntries [0...1]
[]
-

A customer-defined name/value pair. Use to store customer-visible data and

metadata that is outside the processing path of the API. TraceLink does not do anything with this data currently. Though if input by the customer, the values (as entered) will be available in the response.

          CDEntry [0...*]
[]
-

Required. A repeating element that captures a list of customer-

defined values.

            CDName [0...1]
[1/*]
String

Required. Customer-defined name.

 

            CDValue [0...1]
[1/*]
String

Required. Customer-defined value used to annotate serial numbers.

            LongRunningRestSupport [-]
[-]
Boolean Not used.