Get Receipt Response Guidelines

soapenv:Envelope

1...1
–

–

Required. The SOAP envelope root element.

soapenv:Body

1...1
–

–

Required. The SOAP message body.

urn:GetReceiptResponse

1...1
–

–

Required. The Get Receipt response message.

OrderReceiptResponse

1...1
1/*

String

Required. The delivery number of the requested SOM receipt.

Success

1...1
–

Boolean

Required. Indicates if the Get Receipt request was successfully processed.

OrderReceipt

1...1
1/*

–

Required. The receipt response group element that contains the receipt details, such as business transaction identifiers, date, and sender and recipient information.

@deliverynumber

1...1
1/*

String

Required. The delivery number that was submitted in the request message, which links the order information to the receipt.

@quantity

1...1
1/*

Integer

Required. The total number of serial numbers on the receipt.

voidCorrectInfo

1...1–

–

Required. The receipt's void information.

voidStatus

1...1
0/*

String

Required. The void status of the receipt.

Valid values:

VOID
NOT_VOIDED

voidDate

1...1
0/*

String

Required. The date and time the receipt was voided. If voidStatus = NOT_VOIDED, this field is populated with the system data and time of the response.

transactionDate

1...1
0/*

String

Required. The date and time the void transaction for the receipt was processed. If voidStatus = NOT_VOIDED, this field is populated with the system date and time of the response.

ReceiptDate

0...1
0/*

Date

The date of the transaction in XML YYYY-MM-DD format. If not provided, this field is populated with the current system date.

ReceiptTime

0...1
0/*

Time

Conditionally required if ReceiptToCountryCode = CN. The time of the transaction in XML HH:MM:SS format.

EventDateTime

0...1
0/*

String

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

ReceiptComplete

1...1
0/*

Boolean

Required. Indicates whether all editing is finished and the receipt is complete.

ReceiptFromCountryCode

0...1
0/*

String

Conditionally required if the shipment type is set to Sale-Export, Return-Export, or Transfer-Export. The two-letter ISO country code for the ship-from country from the original shipment. This value provides SOM with the information needed to trigger regulatory reporting in response to relevant events. Setting this value alone does not trigger regulatory reporting.

ReceiptToCountryCode

0...1
0/*

String

Conditionally required if the shipment type is set to Sale-Export, Return-Export, or Transfer-Export. The two-letter ISO country code for the ship-to country from the original shipment. This value provides SOM with the information needed to trigger regulatory reporting in response to relevant events. Setting this value alone does not trigger regulatory reporting.

IsPendingReceipt

0...1
0/*

Boolean

Indicates whether the receipt is pending.

ShortShip

0...1
0/*

Boolean

Instructs the system whether to allow short picks when verifying quantities of what is expected to be picked (in OrderItems) against the each quantities of the scanned serial numbers (in PickedItem). If ShortShip = false, other errors may still be flagged, such as incorrect product or lot and over-picks.

Valid values:

true
false (default)

ReceiptType

0...1
1/*

String

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

ContractType

0...1
0/*

String

Conditionally required if either:

ShipToCountryCode = RU
ReceiptFromCountryCode = KR and ReceiptDistributionType = INCOUNTRY_RETURN

The type of contract for the sale of goods.

SupplyType

0...1
0/*

String

Conditionally required if either:

ShipToCountryCode = RU
ReceiptFromCountryCode = KR and ReceiptDistributionType = INCOUNTRY_RETURN

The type of supply.

See the SupplyType enumeration list for valid values.

ContractNumber

0...1
0/*

String

The contract identification number.

FundingSource

0...1
0/*

String

Conditionally required if ShipToCountryCode = RU. The funding source.

See the FundingSource enumeration list for valid values.

Comments

0...1
0/*

String

Comments or remarks associated with the delivery.

ReceiptFromParty

0...1
–

–

Conditionally required\ for transfer or sales in non-EU FMD markets where either:

both the ReceiptToCountryCode and ReceiptFromCountryCode are non-EU FMD countries
the ReceiptToCountryCode = CN, KR, RU, or US and ReceiptFromCountryCode is an EU FMD country

Information for the business party that sent the shipment.

Either the BusinessIdentifier or the DefaultFromMasterData field must be provided with the ReceiptFromParty field. This selection governs whether master data look-up will be used to populate the address, license, and contact elements.

BusinessIdentifiers

0...1
–

–

Required. This field contains all ReceiptFromParty business address information that is populated by the customer in the web user interface.

BusinessIdentifier

1...*
–

–

Required. The business identifier associated with the ReceiptFrom entity.

See the BusinessIdentifiersByCountry enumeration list for valid values.

@identifiertype

1...1
1/*

String

Required. [ The identifier type.

See the BusinessAndLocationId enumeration list for valid values.

@identifiervalue

1...1
1/*

String

Required. Business identifier value. *8

BusinessClassification

0...1
0/*

String

Conditionally required for Argentina or when ReceiptFromCountryCode = KR and ReceiptDistributionType = INCOUNTRY_RETURN. The business type of the TraceLink Customer or Trade Partner.

Valid values:

MANUFACTURER
DISTRIBUTOR
LOGISTICS
WHOLESALER
PHARMACY
HEALTHCARE

Valid values for South Korea:

MANUFACTURER
IMPORTER
WHOLESALER

District

0...1
0/*

String

Conditionally required for India. 3-digit numeric code.

BusinessName

1...1
1/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The business name of the TraceLink Customer or Trading Partner.

Street1

1...1
1/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The first line of the street address.

Street2

0...1
0/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The second line of the street address.

City

1...1
1/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The city.

StateOrRegion

1...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

1...1
1/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The ZIP or other postal code.

CountryCode

1...11/*

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 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.

DefaultFromMasterData

1...1
–

Boolean

Required. Instructs the system whether to look up the business name and address information in Master Data.

Valid values:

true
false (default)

ReceiptFromLocation

0...1
1/*

–

Required. Information about the business party location from which the shipment was sent.

BusinessIdentifiers

0...1
–

–

Required. This field contains all ReceiptFromParty business location information that is populated by the customer in the web user interface.

BusinessIdentifier

1...*
–

–

Required. The business identifier associated with the ReceiptFrom entity.

See the BusinessIdentifiersByCountry enumeration list for valid values.

@identifiertype

1...1
1/*

String

Required. The identifier type.

See the BusinessAndLocationId enumeration list for valid values.

@identifiervalue

1...1
1/*

String

Required. Business identifier value.

BusinessClassification

0...1
0/*

String

Conditionally required for Argentina or when ReceiptFromCountryCode = KR and ReceiptDistributionType = INCOUNTRY_RETURN. The business type of the TraceLink Customer or Trade Partner.

Valid values:

MANUFACTURER
DISTRIBUTOR
LOGISTICS
WHOLESALER
PHARMACY
HEALTHCARE

Valid values for South Korea:

MANUFACTURER
IMPORTER
WHOLESALER

District

0...1
0/*

String

Conditionally required for India. 3-digit numeric code.

BusinessName

1...1
1/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The business name of the TraceLink Customer or Trading Partner.

Street1

1...1
1/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The first line of the street address.

Street2

0...1
0/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The second line of the street address.

City

1...1
1/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The city.

StateOrRegion

1...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

1...1
1/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The ZIP or other postal code.

CountryCode

1...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 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.

DefaultFromMasterData

1...1
–

Boolean

Required. Instructs the system whether to look up the business name and address information in Master Data.

Valid values:

true
false (default)

License

0...*
0/1

–

List of zero or more license numbers associated with the facility. This element may be repeated to include as many license numbers or license types as required (e.g. state, federal license).

LicenseNumber

0...*
0/*

String

Conditionally required for US. The license number value of the Receipt To or Receipt From entity.

State

0...1
0/*

String

The state or region in which the Trade Partner is licensed, using the standard two-letter abbreviation specified in ISO 3166-2:1998 country sub-division code.

Agency

0...1
0/*

String

The agency that granted the license to the facility (such as Florida Department of Health).

ContactInfo

0...1
0/1

–

The contact information for use by downstream Trade Partners to verify the transaction information recorded on the pedigree with the sender party.

Name

0...1
0/*

String

Required. The name of the contact department or designated contact person at the company.

Title

0...1
0/*

String

The job title for the designated contact person.

Telephone

0...1
0/*

String

Required. The phone number for the contact department or designated contact person. This value must begin with the + character followed by the Receipt To or Receipt From facility Calling Code.

Email

0...1
0/*

String

The email address for the contact department or designated contact person.

URL

0...1
0/*

String

The company's web address to aid in verification.

ReceiptToParty

–
–

–

Required. The information for the business party that received the shipment.

BusinessIdentifiers

0...1
–

–

Conditionally required if Master Data lookup is not used. This field contains all ReceiptToParty business information that is populated by the customer in the web user interface.

BusinessIdentifier

1...*
–

–

Required. The business identifier associated with the Receipt To entity.

See the BusinessIdentifiersByCountry enumeration list for valid values.

@identifiertype

1...1
1/*

String

Required. The identifier type.

See the BusinessAndLocationId enumeration list for valid values.

@identifiervalue

1...1
1/*

String

Required. Business identifier value.

BusinessClassification

0...1
0/*

String

Conditionally required for Argentina or when ReceiptFromCountryCode = KR and ReceiptDistributionType = INCOUNTRY_RETURN. The business type of the TraceLink Customer or Trade Partner.

Valid values:

MANUFACTURER
DISTRIBUTOR
LOGISTICS
WHOLESALER
PHARMACY
HEALTHCARE

Valid values for South Korea:

MANUFACTURER
IMPORTER
WHOLESALER

District

0...1
0/*

String

Conditionally required for India. 3-digit numeric code.

BusinessName

1...1
1/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The business name of the TraceLink Customer or Trading Partner.

Street1

1...1
1/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The first line of the street address.

Street2

0...1
0/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The second line of the street address.

City

1...1
1/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The city.

StateOrRegion

1...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

1...1
1/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The ZIP or other postal code.

CountryCode

1...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 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.

DefaultFromMasterData

1...1
–

Boolean

Required. Instructs the system whether to look up the business name and address information in Master Data.

Valid values:

true
false (default)

ReceiptToLocation

–
–

–

Required. Information about the business party location to which the shipment was sent.

BusinessIdentifiers

0...1
–

–

Required. This field contains all ReceiptToParty business location information that is populated by the customer in the web user interface.

BusinessIdentifier

1...*
–

–

Required. The business identifier associated with the ReceiptFrom entity.

See the BusinessIdentifiersByCountry enumeration list for valid values.

@identifiertype

1...1
1/*

String

Required. [ The identifier type.

See the BusinessAndLocationId enumeration list for valid values.

@identifiervalue

1...1
1/*

String

Required. Business identifier value.

BusinessClassification

0...1
0/*

String

Conditionally required for Argentina or when ReceiptFromCountryCode = KR and ReceiptDistributionType = INCOUNTRY_RETURN. The business type of the TraceLink Customer or Trade Partner.

Valid values:

MANUFACTURER
DISTRIBUTOR
LOGISTICS
WHOLESALER
PHARMACY
HEALTHCARE

Valid values for South Korea:

MANUFACTURER
IMPORTER
WHOLESALER

District

0...1
0/*

String

Conditionally required for India. 3-digit numeric code.

BusinessName

1...1
1/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The business name of the TraceLink Customer or Trading Partner.

Street1

1...1
1/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The first line of the street address.

Street2

0...1
0/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The second line of the street address.

City

1...1
1/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The city.

StateOrRegion

1...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

1...1
1/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The ZIP or other postal code.

CountryCode

1...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 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.

DefaultFromMasterData

1...1
–

Boolean

Required. Instructs the system whether to look up the business name and address information in Master Data.

Valid values:

true
false (default)

License

0...*
0/1

–

List of zero or more license numbers associated with the facility. This element may be repeated to include as many license numbers or license types as required (e.g. state, federal license).

LicenseNumber

0...*
0/*

String

Conditionally required for US. The license number value of the Receipt To or Receipt From entity.

State

0...1
0/*

String

The state or region in which the Trade Partner is licensed, using the standard two-letter abbreviation specified in ISO 3166-2:1998 country sub-division code.

Agency

0...1
0/*

String

The agency that granted the license to the facility (such as Florida Department of Health).

ContactInfo

0...1
0/1

–

The contact information for use by downstream Trade Partners to verify the transaction information recorded on the pedigree with the sender party.

Name

0...1
0/*

String

Required. The name of the contact department or designated contact person at the company.

Title

0...1
0/*

String

The job title for the designated contact person.

Telephone

0...1
0/*

String

Required. The phone number for the contact department or designated contact person. This value must begin with the + character followed by the ReceiptToorReceiptFromfacilityCallingCode.

Email

0...1
0/*

String

The email address for the contact department or designated contact person.

URL

0...1
0/*

String

The company's web address to aid in verification.

transportationCarrier

0...1
–

–

Conditionally required for Brazil or where ShipToCountryCode = BR. Information about the transportation partner that is transporting the shipment.

BusinessIdentifiers

0...1
–

–

This field contains all transportationCarrier business information that is populated by the customer in the web user interface.

BusinessIdentifier

1...*
–

–

The business identifier associated with the transportationCarrier entity. This value is required for regulatory reporting.

See the BusinessIdentifiersByCountry enumeration list for valid values.

@identifiertype

1...1
1/*

String

The identifier type.

See the BusinessAndLocationId enumeration list for valid values.

@identifiervalue

1...1
1/*

String

Required. Business identifier value.

BusinessClassification

0...1
0/*

String

Conditionally required for Argentina or when ReceiptFromCountryCode = KR and ReceiptDistributionType = INCOUNTRY_RETURN. The business type of the TraceLink Customer or Trade Partner.

Valid values:

MANUFACTURER
DISTRIBUTOR
LOGISTICS
WHOLESALER
PHARMACY
HEALTHCARE

Valid values for South Korea:

MANUFACTURER
IMPORTER
WHOLESALER

District

0...1
0/*

String

Conditionally required for India. 3-digit numeric code.

BusinessName

1...1
1/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The business name of the TraceLink Customer or Trading Partner.

Street1

1...1
1/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The first line of the street address.

Street2

0...1
0/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The second line of the street address.

City

1...1
1/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The city.

StateOrRegion

1...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

1...1
1/*

String

Conditionally required if DefaultFromMasterData is unset or set to false. The ZIP or other postal code.

CountryCode

1...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 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.

DefaultFromMasterData

1...1
–

Boolean

Required. Instructs the system whether to look up the business name and address information in Master Data.

Valid values:

true
false (default)

Transactions

0...1
–

–

Conditionally required if ReceiptComplete is set to true. The parent element for one or more transaction identifiers associated with the shipment.

Transaction

0...*
1/*

–

Required. The list of one or more transaction identifiers.

OrderID

0...1
1/*

String

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

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 OrderReceiptType enumeration list for valid values.

Date

0...1
1/*

Date

Required. The date of the transaction in XML YYYY-MM-DD format. This value is used for regulatory reporting of the transaction date.

Aggregations

0...1
–

–

The aggregations of the shipment.

RegisterUnknownSNs

0...1
0/1

Boolean

Instructs the system whether to register serial numbers that are not known at the time of receipt processing.

ReceiptItem

0...1
–

–

Parent element for serial numbers attached to the receipt.

Items

1...1
–

–

Required. Serial number element group containing serial numbers attached to the receipt.

Item

1...*
–

–

Required. Repeating serial number group.

@sn

1...1
1/*

String

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

@namespace

0...1
1/*

String

Not used by TraceLink.

@orderItemNumber

0...1
1/*

String

Reference to the Order Item, enabling the association of Unit Price, VAT, and Gross Price with specific serial numbers.

@isUpdated

1...1
1/*

Boolean

Required. Records whether the serial number is updated, which TraceLink uses for system processing.

OrderReceiptItems

0...1
–

–

The order item list group. This group element is used to communicate the expected pick quantities for each item code at the EACH level, checked against the actual serial number picked to verify the correct product, lot number, and quantity.

OrderReceiptItem

1...*
–

–

Conditionally required if ReceiptFromCountryCode = KR and ReceiptDistributionType = INCOUNTRY_RETURN. Repeating element group that contains the item code, lot number, and quantity for each item picked for the order. Each unique item code and lot number are provided in a separate order item group.

OrderReceiptItemNumber

0...1
1/*

String

The serial number reference that allows serial numbers to be associated with order items.

PackagingItemCode

0...1
1/*

String

Conditionally required if neither InternalItemCode nor CountryDrugCode is present. The product code type for the packaging item code.

PackagingItemCodeType

0...1
0/*

String

Conditionally required if PackingItemCode is present. The product code type for the packaging item code using the supported enumeration values.

See the ItemCodeType enumeration list for valid values.

InternalItemCode

0...1
1/*

String

Conditionally required if neither PackagingItemCode nor CountryDrugCode is present. The internal item code as configured in Product Master Data.

CountryDrugCode

0...1
1/*

String

Conditionally required if neither PackagingItemCode nor InternalItemCode is present. The country drug code as configured in Product Master Data.

See the CountryDrugCode enumeration list for valid values.

CountryDrugCodeType

0...1
0/*

String

Conditionally required if CountryDrugCode is present. The type of country drug code.

Quantity

1...1
1/*

Integer

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

Lot

0...1
0/*

String

The lot or batch number for the items to be picked.

ExpirationDate

0...1
10/10

Date

The date of expiration in XML YYYY-MM-DD format.

UnitPrice

0...1
0/*

Decimal

Conditionally required if either:

ShipToCountry = RU
ReceiptFromCountryCode = KR and ReceiptDistrubutionType = INCOUNTRY_RETURN

The unit price of the item.

CurrencyCode

1...1
0/3

String

Conditionally required if UnitPrice is present. The currency code in ISO 4217-2015 format. *28

See the CurrencyCode enumeration list for valid values.

GrossPrice

0...1
1/16

Decimal

Conditionally required if ShipToCountry = RU. The unit price of the item, plus all taxes and fees.

GrossPriceCurrencyCode

1...1
0/3

String

Conditionally required if GrossPrice is present. The currency code in ISO 4217-2015 format.

VAT

0...1
1/16

Decimal

The Value Added Tax per unit.

VATCurrencyCode

1...1
0/3

String

Conditionally required if VAT is present. The currency code in ISO 4217-2015 format.

See the CurrencyCode enumeration list for valid values.

Serialized

0...1
–

Boolean

Indicates whether the item is serialized.

Valid values:

true (default)
false

OrderReceiptItemTransactions

0...1
–

–

The transaction identifier associated with the individual order receipt items.

OrderReceiptItemTransaction

1...*
–

–

Required. The list of one or more transaction identifiers.

OrderId

1...1
1/*

String

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

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.

OrderType

1...1
1/*

String

Required. The transaction identifier type.

Valid values:

PO
INVOICE
DESTRUCTION
NOTAFISCAL
OTHER

Date

0...1
1/*

Date

Conditionally required if ShipToCountry = RU. The date of the transaction in XML YYYY-MM-DD format, used for regulatory reporting.

CDEntries

0...1
–

–

A customer-defined name/value pair. Used 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. However, any values input by the customer will be available (as entered) in the response.

CDEntry

0...*
–

–

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

CDName

0...1
1/*

String

Required. A customer-defined name.

CDValue

0...1
1/*

String

Required. A customer-defined value used to annotate serial numbers.

TransactionExchangeId

0...1
0/*

String

The Transaction Exchange GUID that is associated with the SOM Receipt. For internal use only.