Update Order Receipt 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]
[-]		 - Required. Not used. SOAP Message Header.
  soapenv:Body [1...1]
[-]		 - Required. SOAP Message Body.
    urn:UpdateOrderReceipt [1...1]
[-]		 - Required. Creates or updates a Receipt request message.
      OrderReceiptRequest [1...1]
[-]		 - Required. The Receipt request message that communicates pertinent details such as the business transaction identifiers, date, sender and recipient information. This element is required before the receipt complete flag can be set. However, it can be communicated at any time.
        @deliveryNumber [1...1]
[1/*]		 String Required. Delivery number that links the order information/receipt. *1
        previousDeliveryNumber [0...1]
[0/*]		 String

Original delivery number. Records the original delivery number that is replaced when a receipt is voided and corrections are made to that receipt.
        ReceiptDate [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
        ReceiptTime [0...1]
[0/*]		 Time Conditionally required for China. The time of the transaction in XML HH:MM:SS format. *3
        EventDateTime [0...1]
[-]		 String Date and time of the event in XSD Date format in GMT (YYYY-MM-DDTHH:MM:SSZ). If omitted, the system will record the current date time. *4
        ReceiptComplete [1...1]
[-]		 Boolean Required. Indicates whether the receipt can be considered complete and all editing is finished (true = complete).
        ReceiptToCountryCode [0...1]
[2/2]		 String

Conditionally required if both ReceiptFromParty and ReceiptToParty are empty or null. The two-letter ship from country code from the original shipment. Provides application with the information needed to trigger regulatory reporting in response to relevant events. *5

See the ISOCountryCode enumeration list for valid values.
        ReceiptFromCountryCode [0...1]
[2/2]		 String

Conditionally required if both ReceiptFromParty and ReceiptToParty are empty or null. Two-letter ship to ISO country code from the original shipment. 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 TraceLink. *6

See the ISOCountryCode enumeration list for valid values.
        IsPendingReceipt [0...1]
[0/*]		 Boolean Indicates if the receipt is pending (true = pending).
        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). If this value is set to false, other errors will still be flagged, such as incorrect product/lot and over picks. If not specified, value of false is assumed.
        ReceiptType [0...1]
[1/*]		 String

Conditionally required if ReceiptComplete = true and ReceiptType was not provided in a previously saved incomplete or pending receipt for the delivery number. The types of regulatory reporting may be triggered based on the nature of the transaction. Can send the ReceiptType in a previously saved incomplete or pending receipt for the delivery number.

See the ReceiptDistributionType enumeration list for valid values.
        TransferWithoutShipment [0...1]
[0/*]		 Boolean

Indicates that the serial numbers are already in an Available state because there is no associated shipment event. Valid values:

  • true – Serial numbers are in the Available state.
  • false (default) – Serial numbers are in the Pending Receipt state.

Only use when ReceiptType = INCOUNTRY_TRANSFER or IMPORT_TRANSFER.
        ContractType [0...1]
[0/*]		 String

Conditionally required if ReceiptFromCountryCode = KR and ReceiptDistributionType = INCOUNTRYRETURN. Identifies the type of 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 when:

  • ReceiptFromCountryCode = KR and ReceiptDistributionType = INCOUNTRYRETURN
  • For Brazil, populate only if performing a Collection, Donation, or SampleDistribution.

Identifies the type of supply that is being performed using one of the permitted values. All values except for Collection apply. For regulatory use.

See the SupplyType enumeration list for valid values.
        ContractNumber [0...1]
[1/*]		 String Identification number of the contract. *7
        FundingSource [0...1]
[1/*]		 String

Source of the funding. *8

See the FundingSource enumeration list for valid values.
        RemovalFromCirculation [0...1]
[1/*]		 String

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

See the RemovalFromCirculationReasonCode enumeration list for valid values.
        Comments [0...1]
[0/*]		 String Optional remarks or comments associated with delivery.
        ReceiptFromParty [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 because of country compliance requirements.
  • The source was not provided in a previously saved incomplete or pending receipt for the delivery number.

Optional if:

  • Transfer or sale within EU FMD countries.
  • Transfer or sale import into an EU FMD country.
  • Transfer or sale export from an EU FMD country to a country other than US, CN, KR, or RU.

Information about the business party that sent the shipment being received. This selection governs whether master data look-up will be used to populate the address, license, and contact elements. Can send the ReceiptFromParty in a previously saved incomplete or pending receipt for the delivery number.
          BusinessIdentifiers [-]
[-]		 - Conditionally required if no master data look-up is desired. Full ReceiptFromParty business address field data that will be populated by the customer directly in the interface.
            BusinessIdentifier [1...*]
[-]		 - Required. The identifier associated with the ReceiptFrom entity. This value is required for regulatory reporting. Different countries require different values as noted below. *10
Country requirements:
  • Argentina: Both the GLN and the CUIT number associated with the sold from party are provided.
  • Brazil: The BR_CNPJ number associated with the sold from party is provided.
  • China: The company identifier registered with China SFDA used to identify the sold from party is provided.
  • Turkey: The GLN associated with the sold from party is provided.
  • US: A DEA, GLN, or HIN identifier associated with the sold from party is provided.
              @identifiertype [1...1]
[1/*]		 String Required. See the BusinessAndLocationId enumeration list for valid values. *11
              @identifiervalue [1...1]
[-]		 - Business identifier value. *12
          BusinessClassification [0...1]
[0/*]		 String

Conditionally required for Argentina or if ReceiptFromCountryCode = KR and ReceiptDistributionType = INCOUNTRYRETURN. The business type of the TraceLink customer or trading partner.

Valid values for Argentina:

  • DISTRIBUTOR
  • HEALTHCARE
  • LOGISTICS
  • MANUFACTURER
  • PHARMACY
  • WHOLESALER

Valid values if ReceiptFromCountryCode = KR and ReceiptDistributionType = INCOUNTRYRETURN:

  • IMPORTER
  • MANUFACTURER
  • WHOLESALE
          BusinessName [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The business name of the TraceLink Customer or Trading Partner. *13
          Street1 [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The first line of the street address for the company indicated in the BusinessName field. *14
          Street2 [0...1]
[0/*]		 String The second line of the street address for the company indicated in the BusinessName field. *15
          City [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The city of the company indicated in the BusinessName field. *16
          District [0...1]
[0/*]		 String

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

Must be a 3-digit numeric code.
          StateOrRegion [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. The state, province, or region of the company specified in the BusinessName field. *18
          PostalCode [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The zip or other postal code of the company indicated in the BusinessName field. *19
          CountryCode [1...1]
[1/*]		 String

Conditionally required if DefaultFromMasterData is set to false. Two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. The country code of the company indicated in the BusinessName field. *20

See the ISOCountryCode enumeration list for valid values.
          AddressObjectGUID [0...1]
[0/*]		 String

Conditionally required 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. *21
          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. *22
          Village [0...1]
[0/*]		 String

Name of the village in which the company is located. *23
          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. *24
          Township [0...1]
[0/*]		 String

Name of the township in which the company is located. *25
          CorporateFax [0...1]
[0/*]		 String

Company fax number. *26
          DefaultFromMasterData [1...1]
[-]		 Boolean Required. Instructs the system whether to look up the business name and address information from master data (defaults to false).
  • 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 ReceiptComplete is set to true.
        ReceiptFromLocation [0...1]
[0/*]		 - Conditionally required if ReceiptFromLocation was not provided in a previously saved incomplete or pending receipt for the delivery number. Information about the business party location that sent the shipment being received. This field contains the full ReceiptFrom business address field data that will be populated by the customer directly in the interface. Populate this element fully only if no master data look-up is desired. Can send the ReceiptFromLocation in a previously saved incomplete or pending receipt for the delivery number.
          BusinessIdentifiers [1...*]
[-]		 - Required. The identifier associated with the ReceiptFrom location. This value is required for regulatory reporting. Different countries require different values as noted below.
Country requirements:
  • Argentina: Both the GLN and the CUIT number associated with the sold from party are provided.
  • Brazil: The BR_CNPJ number associated with the sold from party is provided.
  • China: The company identifier registered with China SFDA used to identify the sold from party is provided.
  • Turkey: The GLN associated with the sold from party is provided.
  • US: A DEA, GLN, or HIN identifier associated with the sold from party is provided.
            BusinessIdentifier [1...*]
[-]		 - Required. The identifier associated with the receipt from location. This value is required for regulatory reporting. Different countries require different values as noted below.
Country requirements:
  • Argentina: Both the GLN and the CUIT number associated with the sold from party are provided.
  • Brazil: The BR_CNPJ number associated with the sold from party is provided.
  • China: The company identifier registered with China SFDA used to identify the sold from party is provided.
  • Turkey: The GLN associated with the sold from party is provided.
  • US: A DEA, GLN, or HIN identifier associated with the sold from party is provided.
              @identifiertype [1...1]
[1/*]		 String Required. See the BusinessAndLocationId enumeration list for valid values.:
              @identifiervalue [1...1]
[-]		 - Required. Business identifier value.
          BusinessName [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The business name of the ReceiptFrom location business entity.
          Street1 [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The first line of the street address for the company indicated in the BusinessName field.
          Street2 [0...1]
[0/*]		 String The second line of the street address for the company indicated in the BusinessName field.
          City [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The city of the company indicated in the BusinessName field.
          District [0...1]
[0/*]		 String Conditionally required for India. District Code only for India.
Must be a 3-digit numeric code.
          StateOrRegion [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The state, province, or region of the company specified in the BusinessName field. Use the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code.
          PostalCode [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The zip or other postal code of the company indicated in the BusinessName field.
          CountryCode [1...1]
[1/*]		 String

Conditionally required if DefaultFromMasterData is set to false. The country code of the company indicated in the BusinessName field.

See the ISOCountryCode enumeration list for valid values.
          AddressObjectGUID [0...1]
[0/*]		 String

Conditionally required 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. *27
          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. *28
          Village [0...1]
[0/*]		 String

Name of the village in which the company is located. *29
          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. *30
          Township [0...1]
[0/*]		 String

Name of the township in which the company is located. *31
          CorporateFax [0...1]
[0/*]		 String

Company fax number. *32
          DefaultFromMasterData [1...1]
[-]		 Boolean Required. Instructs the system whether to look up the business name and address information from master data (defaults to false).
  • 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 ReceiptComplete.
          License [0...*]
[-]		 - List of zero or more license numbers associated with the facility. This element may be repeated to include as many license numbers as required (e.g. state and federal license).
            LicenseNumber [0...*]
[0/*]		 String Conditionally required for US. The license number of the ReceiptTo or ReceiptFrom facility. This element may be repeated to include as many license numbers as required (e.g. state and federal license). *33
            State [0...1]
[0/*]		 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. *34
            Agency [0...1]
[0/*]		 String Additional context for the LicenseNumber field. The agency that granted the license to the facility (e.g. Florida DOH, NABP). *35
          ContactInfo [0...1]
[-]		 String

Contact information for use by downstream trading partners to authenticate (i.e. verify) the transaction information recorded on the pedigree with the sender party. This field must contain a name and telephone number but could also include an individual's title, email and/or URL.

Do not include for ReceiptFromLocation.
            Name [0...1]
[0/*]		 String Required. The name of the contact department or individual at the designated company. *36
            Title [0...1]
[0/*]		 String The job title of the individual indicated in the Name field. Title information is optional within the ContactInfo field. *37
            Telephone [1...1]
[1/*]		 String Required. The phone number of the contact department or individual at the designated company. This value must begin with the + character followed by the ReceiptTo or ReceiptFrom facility Calling Code. *38
            Email [0...1]
[0/*]		 String The email address of the contact department or individual at the designated company. *39
Should be included if available.
            Url [0...1]
[0/*]		 String

The designated company’s web address that facilitates authentication. *40

URL information is optional within the ContactInfo field.
        ReceiptToParty [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 because of country compliance requirements.
  • The source was not provided in a previously saved incomplete or pending receipt for the delivery number.

Optional if:

  • Transfer or sale within EU FMD countries.
  • Transfer or sale import into an EU FMD country.
  • Transfer or sale export from an EU FMD country to a country other than US, CN, KR, or RU.

Information about the supply chain partner that is receiving the receipt. This selection governs whether master data look-up will be used to populate the address, license and contact elements. Can send the ReceiptToParty in a previously saved incomplete or pending receipt for the delivery number.
          BusinessIdentifiers [-]
[1/*]		 - Required. Full ReceiptToParty business address field data that will be populated by the customer directly in the interface.
Populate this element fully only if no master data look-up is desired.
            BusinessIdentifier [1...*]
[-]		 - Required. The identifier associated with the ReceiptToParty. This value is required for regulatory reporting. Different countries require different values as noted below.
Country requirements:
  • Argentina: Both the GLN and the CUIT number associated with the sold from party are provided.
  • Brazil: The BR_CNPJ number associated with the sold from party is provided.
  • China: The company identifier registered with China SFDA used to identify the sold from party is provided.
  • Turkey: The GLN associated with the sold from party is provided.
  • US: A DEA, GLN, or HIN identifier associated with the sold from party is provided.
              @identifiertype [1...1]
[1/*]		 String Required. 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 ReceiptFromCountryCode = KR and ReceiptDistributionType = INCOUNTRYRETURN. The business type of the TraceLink customer or trading partner.

Valid values for Argentina:

  • DISTRIBUTOR
  • HEALTHCARE
  • LOGISTICS
  • MANUFACTURER
  • PHARMACY
  • WHOLESALER

Valid values if ReceiptFromCountryCode = KR and ReceiptDistributionType = INCOUNTRYRETURN:

  • IMPORTER
  • MANUFACTURER
  • WHOLESALER
          BusinessName [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The business name of the TraceLink Customer or Trading Partner.
          Street1 [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The first line of the street address for the company indicated in the BusinessName field.
          Street2 [0...1]
[0/*]		 String The second line of the street address for the company indicated in the BusinessName field.
          City [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The city of the company indicated in the BusinessName field.
          District [0...1]
[0/*]		 String Conditionally required for India. District Code only for India.
Must be a 3-digit numeric code.
          StateOrRegion [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. The state, province, or region of the company specified in the BusinessName field.
          PostalCode [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The zip or other postal code of the company indicated in the BusinessName field.
          CountryCode [1...1]
[1/*]		 String

Conditionally required if DefaultFromMasterData is set to false. Two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. The country code of the company indicated in the BusinessName field.

See the ISOCountryCode enumeration list for valid values.

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

Conditionally required 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. *41
          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. *42
          Village [0...1]
[0/*]		 String

Name of the village in which the company is located. *43
          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. *44
          Township [0...1]
[0/*]		 String

Name of the township in which the company is located. *45
          CorporateFax [0...1]
[0/*]		 String

Company fax number. *46
          DefaultFromMasterData [1...1]
[-]		 Boolean Required. Instructs the system whether to look up the business name and address information from master data (defaults to false).
  • 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 ReceiptComplete is set to true.
        ReceiptToLocation [-]
[1/*]		 - Conditionally required if ReceiptToLocation was not provided in a previously saved incomplete or pending receipt for the delivery number. Full ReceiptToLocation business address field data that will be populated by the customer directly in the interface. Can send the ReceiptToLocation in a previously saved incomplete or pending receipt for the delivery number.
          BusinessIdentifiers [1...*]
[-]		 - Required. The identifier associated with either the sold from business entity or the sold to business entity. This value is required for regulatory reporting. Different countries require different values as noted below.
Country requirements:
  • Argentina: Both the GLN and the CUIT number associated with the sold from party are provided.
  • Brazil: The BR_CNPJ number associated with the sold from party is provided.
  • China: The company identifier registered with China SFDA used to identify the sold from party is provided.
  • Turkey: The GLN associated with the sold from party is provided.
  • US: A DEA, GLN, or HIN identifier associated with the sold from party is provided.
            BusinessIdentifier [1...*]
[-]		 - Required. The identifier associated with the receipt to party location. This value is required for regulatory reporting. Different countries require different values as noted below.
Country requirements:
  • Argentina: Both the GLN and the CUIT number associated with the sold from party are provided.
  • Brazil: The BR_CNPJ number associated with the sold from party is provided.
  • China: The company identifier registered with China SFDA used to identify the sold from party is provided.
  • Turkey: The GLN associated with the sold from party is provided.
  • US: A DEA, GLN, or HIN identifier associated with the sold from party is provided.
              @identifiertype [1...1]
[1/*]		 String Required. See the BusinessAndLocationId enumeration list for valid values.
              @identifiervalue [1...1]
[-]		 - Business identifier value.
          BusinessName [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The business name of the ReceiptToLocation business entity.
          Street1 [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The first line of the street address for the company indicated in the BusinessName field.
          Street2 [0...1]
[0/*]		 String The second line of the street address for the company indicated in the BusinessName field.
          City [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The city of the company indicated in the BusinessName field.
          District [0...1]
[0/*]		 String Conditionally required for India. District Code only for India.
Must be a 3-digit numeric code.
          StateOrRegion [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The state, province, or region of the company specified in the BusinessName field. Use the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code.
          PostalCode [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The zip or other postal code of the company indicated in the BusinessName field.
          CountryCode [1...1]
[1/*]		 String

Conditionally required if DefaultFromMasterData is set to false. The country code of the company indicated in the BusinessName field.

See the ISOCountryCode enumeration list for valid values.

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

Conditionally required 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. *47
          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. *48
          Village [0...1]
[0/*]		 String

Name of the village in which the company is located. *49
          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. *50
          Township [0...1]
[0/*]		 String

Name of the township in which the company is located. *51
          CorporateFax [0...1]
[0/*]		 String

Company fax number. *52
          DefaultFromMasterData [1...1]
[-]		 Boolean Required. Instructs the system whether to look up the business name and address information from master data (defaults to false).
  • 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 ReceiptComplete is set to true.
          License [0...*]
[-]		 - List of zero or more license numbers associated with the facility. This element may be repeated to include as many license numbers as required (e.g. state and federal license).
            LicenseNumber [0...*]
[0/*]		 String Conditionally required for US. The license number of the ReceiptTo or ReceiptFrom facility. This element may be repeated to include as many license numbers as required (e.g. state and federal license).
            State [0...1]
[0/*]		 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.
            Agency [0...1]
[0/*]		 String This attribute is used to give additional context to the LicenseNumber field. It indicates the agency that granted the license to the facility (e.g. Florida DOH, NABP).
          ContactInfo [0...1]
[-]		 String Contact information for use by downstream trading partners to authenticate (i.e. verify) the transaction information recorded on the pedigree with the sender party.

This field must contain a name and telephone number but could also include an individual's title, email and/or URL.

            Name [0...1]
[0/*]		 String Required. The name of the contact department or individual at the designated company.
            Title [0...1]
[0/*]		 String The individual's job title who is indicated in the Name field.
            Telephone [1...1]
[1/*]		 String Required. The phone number of the contact department or individual at the designated company. This value must begin with the + character followed by the ReceiptTo or ReceiptFrom facility Calling Code.
            Email [0...1]
[0/*]		 String The email address of the contact department or individual at the designated company.
            Url [0...1]
[0/*]		 String URL information is optional within the ContactInfo field. The URL refers to the designated company’s web address that facilitates authentication.
        transportationCarrier [0...1]
[-]		 - Conditionally required for shipments made into and within Brazil (where ShipToCountryCode = BR). Information about the transportation partner that is transporting the shipment. This is used only for Brazil.
          BusinessIdentifiers [-]
[1/*]		 -

Required. Full transportationCarrier business address field data that will be populated by the customer directly in the interface.

Populate this element fully only if no master data look-up is desired.
            BusinessIdentifier [1...*]
[-]		 - Required. The identifier associated with either the sold from business entity or the sold to business entity. This value is required for regulatory reporting. Different countries require different values as noted below.
Country requirements:
  • Argentina: Both the GLN and the CUIT number associated with the sold from party are provided.
  • Brazil: The BR_CNPJ number associated with the sold from party is provided.
  • China: The company identifier registered with China SFDA used to identify the sold from party is provided.
  • Turkey: The GLN associated with the sold from party is provided.
  • US: A DEA, GLN, or HIN identifier associated with the sold from party is provided.
              @identifiertype [1...1]
[1/*]		 String Required. See the BusinessAndLocationId enumeration list for valid values.
              @identifiervalue [1...1]
[-]		 - Required. Business identifier value.
          BusinessClassification [0...1]
[0/*]		 String

The business type of the carrier party.

Valid values:

  • DISTRIBUTOR
  • HEALTHCARE
  • LOGISTICS
  • MANUFACTURER
  • PHARMACY
  • WHOLESALER

Valid values for South Korea:

  • IMPORTER
  • MANUFACTURER
  • WHOLESALER
Do not populate for Brazil.
          BusinessName [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The business name of the transportation carrier business.
          Street1 [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The first line of the street address for the company indicated in the BusinessName field.
          Street2 [0...1]
[0/*]		 String The second line of the street address for the company indicated in the BusinessName field.
          City [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The city of the company indicated in the BusinessName field.
          District [0...1]
[0/*]		 String Conditionally required for India. District Code only for India.
Must be a 3-digit numeric code.
          StateOrRegion [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The state, province, or region using the standard two-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. The state, province, or region of the company specified in the BusinessName field.
          PostalCode [1...1]
[1/*]		 String Conditionally required if DefaultFromMasterData is set to false. The zip or other postal code of the company indicated in the BusinessName field.
          CountryCode [1...1]
[1/*]		 String

Conditionally required if DefaultFromMasterData is set to false. The country code of the company indicated in the BusinessName field using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.

See the ISOCountryCode enumeration list for valid values.
          AddressObjectGUID [0...1]
[0/*]		 String

Conditionally required 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. *53
          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. *54
          Village [0...1]
[0/*]		 String

Name of the village in which the company is located. *55
          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. *56
          Township [0...1]
[0/*]		 String

Name of the township in which the company is located. *57
          CorporateFax [0...1]
[0/*]		 String

Company fax number. *58
          DefaultFromMasterData [1...1]
[-]		 Boolean Required. Instructs the system whether to look up the business name and address information from master data (defaults to false).
  • 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 ReceiptComplete is set to true.
        EntryPort [0...1]
[0/*]		 String

Name of the shipment's port of entry into a country (e.g. an airport, maritime port, border checkpoint). *59
        ExitPort [0...1]
[0/*]		 String

Name of the shipment's port of exit from a country (e.g. an airport, maritime port, border checkpoint). *60
        Transactions [0...*]
[-]		 - Conditionally required before ReceiptComplete is set to true. The transaction identifier associated with the shipment.
          Transaction [0...1]
[-]		 - 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. *61
Country requirements:
  • Argentina: provide Packing Slip Number.
  • Brazil: provide PO Number, ASN Number and Invoice Number if available.
  • China: provide Sales Order Number.
  • US: provide PO Number, ASN Number and Invoice Number if available.
            OrderReceiptType [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.
        ReceiptItem [-]
[-]		 - -
          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). *62
          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. *63
          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.
          RegisterUnknownSNs [0...1]
[0/1]		 Boolean

Determines whether the serial numbers that are unknown to Serialized Operations Manager should be registered. Valid values:

  • true – register all serial numbers that do not currently exist in Serialized Operations Manager in an available state.
  • false – (default) reject all serial numbers that do not currently exist in Serialized Operations Manager.
          Items [0...1]
[-]		 - Contains the serial numbers in the receipt. Can provide serial numbers in a previously saved incomplete or pending receipt for the delivery number.
            Item [0...*]
[-]		 - Repeating element capturing the serial numbers.
              @sn [1...1]
[1/*]		 String Required. Serial Number in the format specified in the request. *64
              @namespace [0...1]
[1/*]		 String Not used by TraceLink. See Serial Number Data Examples. See the Encoding enumeration list for valid values.
              @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.
        OrderReceiptItems [0...1]
[-]		 - Order item list group is populated to communicate the expected pick quantities for each item code at the EACH (unit) level. This information is used in verification of the actual serial number picked to verify the correct product, correct lot number (if provided) and correct each quantity.
          OrderReceiptItem [1...*]
[-]		 - Conditionally required to have at least one OrderReceiptItem group if ReceiptFromCountryCode = KR and ReceiptDistributionType = INCOUNTRYRETURN. 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 are communicated in a separate order item group.
            OrderItemNumber [0...1]
[1/*]		 String Serial number reference allowing serial numbers to be tracked to OrderItems. *65
            InternalItemCode [0...1]
[1/*]		 String Conditionally required if PackagingItemCode is not populated. Use to identify the product using the internal item code configured in Product Master Data. *66
            PackagingItemCode [0...1]
[1/*]		 String Conditionally required if InternalItemCode is not populated. Use to identify the product using the packaging level item code (e.g. GTIN-14) configured in Product Master Data. *67
            PackagingItemCodeType [0...1]
[0/*]		 String Conditionally required if PackagingItemCode is populated. The product code type for the packaging item code using the supported enumeration values.

Valid values:

  • CN-RESCODE
  • GTIN-14
  • NTIN
            Quantity [1...1]
[1/*]		 Integer Required. The quantity of items at the EACH (unit) level of the item code and lot if specified to be picked. *68
            Lot [0...1]
[0/*]		 String The lot or batch code for the items to be picked (if available) in an alphanumeric string. *69
            ExpirationDate [0...1]
[10/10]		 Date The expiration date of the items to be picked, if available. Date is in format "YYYY-MM-DD".
            UnitPrice [0...1]
[-]		 Decimal

Conditionally required if:

  • ShipFromCountry = KR (Korea) and Sales Distribution Type = EXPORTSALE or INCOUNTRYSALE.
  • ShipToCountryCode = RU.

Unit price of item. *70
            CurrencyCode [0...1]
[0/3]		 String

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

See the ISOCurrency enumeration list for valid values.
            GrossPrice [0...1]
[-]		 Decimal Unit price of the item including all taxes and fees. *71
            GrossPriceCurrencyCode [0...1]
[0/3]		 String

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

See the ISOCurrency enumeration list for valid values.
            VAT [0...1]
[-]		 Decimal Value Added Tax per unit. *72
            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]
[-]		 Boolean Indicates if item is not serialized. If omitted, defaults to true. *73
            OrderReceiptItemTransactions [0...1]
[-]		 - The transaction identifier associated with the individual order receipt items.
              OrderReceiptItemTransaction [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. *74
                OrderType [1...1]
[1/*]		 String Required. The transaction identifier type.

Valid values: *75

  • DESTRUCTION
  • INVOICE
  • NOTA_FISCAL_ELETRONICA
  • OTHER
  • PO
  • RETURN
                Date [0...1]
[1/*]		 String The date of the transaction in XML YYY-MM-DD format. This value is used for regulatory reporting of the transaction date. *76
        LongRunningRestSupport [-]
[-]		 Boolean Not used.
        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. Note, 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.
        IsCorrectiveReceipt [0...1]
[0/*]		 Boolean

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

  • false – (default) The receipt is not a corrective receipt.
  • true – The receipt is a corrective receipt.
        TransactionExchangeId [0...1]
[0/*]		 String Internal use only – indicates the Transaction Exchange GUID that is associated with the SOM Receipt.
        IsDisaggregateFromParent [0...1]
[0/*]		 Boolean

Indicates whether the child serial number should be implicitly disaggregated from the parent container. Valid values:

  • false – (default) The child serial number is not disaggregated from the parent container. An error displays if the child serial number is received but the parent serial number is not.
  • true – The child serial number is disaggregated from the parent container.