xml RETANN (Return Announcement)

The Return message intent is to exchange information related to returns

General usage

- The message includes functionality to differentiate classes of returns, and to permit financial valuation of returns facilitating price protection claims, auditing, statutory declarations, etc.

Name Required Description Examples Xpath Type Limits Sort Id
EDI message name

The name of the EDI message

 
 <returnAnnouncement text="Btwentyfour Example Returns Announcement">
/b24Message/returnAnnouncement/@text Text 1000 1
Environment

Environment/test indicator - either "Production" or "Test"

 
 <returnAnnouncement text="Btwentyfour Example Returns Announcement" environment="Production">
/b24Message/returnAnnouncement/@environment Text 1100 2
Currency

The currency in which the price information in the order is specified

 
 <returnAnnouncement text="Btwentyfour Example Returns Announcement" environment="Production" currency="EUR">
/b24Message/returnAnnouncement/@currency Text 1200 3
Btwentyfour message ID

Message ID set by Btwentyfour Open Commerce Platform.

 
 <returnAnnouncement text="Btwentyfour Example Returns Announcement" environment="Production" currency="EUR" messageId="123456" messageDate="2021-12-09T12:19:05.167Z">
/b24Message/returnAnnouncement/@messageId Number 1300 4
Btwentyfour message date

Message date set by Btwentyfour Open Commerce Platform.

 
 <returnAnnouncement text="Btwentyfour Example Returns Announcement" environment="Production" currency="EUR" messageId="123456" messageDate="2021-12-09T12:19:05.167Z">
/b24Message/returnAnnouncement/@messageDate Date/Time 1400 5
Sender Yes

The sender of the EDI message, identified by a GLN

 
 <sender gln="7340117836950"/>
/b24Message/returnAnnouncement/sender/@gln Number 1500 6
Recipient Yes

The recipient of the EDI message, identified by a GLN

 
 <recipient gln="7340117815580"/>
/b24Message/returnAnnouncement/recipient/@gln Number 1600 7
Return Announcement number Yes

The ID of the return announcement, set by the sender

 
 <documentReference documentType="ReturnAnnouncement" id="777888" date="2021-12-09"/>
/b24Message/returnAnnouncement/documentReference[@documentType="ReturnAnnouncement"]/@id Text 1700 8
Return Announcement date Yes

The date of the return announcement, set by the sender

 
 <documentReference documentType="ReturnAnnouncement" id="777888" date="2021-12-09"/>
/b24Message/returnAnnouncement/documentReference[@documentType="ReturnAnnouncement"]/@date Date/Time 1800 9
Buyer order number

The purchase order number set by the buyer

 
 <documentReference documentType="BuyerOrder" id="555666" date="2020-12-01">
/b24Message/returnAnnouncement/documentReference[@documentType="BuyerOrder"]/@id Text 1900 10
Order date

The purchase order date set by the buyer

 
 <documentReference documentType="BuyerOrder" id="555666" date="2020-12-01">
/b24Message/returnAnnouncement/documentReference[@documentType="BuyerOrder"]/@date Date/Time 2000 11
Despatch advice identification

The despatch advice number set by the supplier

 
 <documentReference documentType="DespatchAdvice" id="95159" date="2021-12-02">
/b24Message/returnAnnouncement/documentReference[@documentType="DespatchAdvice"]/@id Text 2100 12
Despatch advice date

The despatch advice date set by the supplier

 
 <documentReference documentType="DespatchAdvice" id="95159" date="2021-12-02">
/b24Message/returnAnnouncement/documentReference[@documentType="DespatchAdvice"]/@date Date/Time 2200 13
Delivery note number

The delivery note number set by the supplier

 
 <documentReference documentType=DeliveryNote" id="95159" date="2021-12-02">
/b24Message/returnAnnouncement/documentReference[@documentType="DeliveryNote"]/@id Text 2300 14
Delivery note date

The delivery note date set by the supplier

 
 <documentReference documentType="DeliveryNote" id="95159" date="2021-12-02">
/b24Message/returnAnnouncement/documentReference[@documentType="DeliveryNote"]/@date Date/Time 2400 15
Agreement Number

The reference number/ID of an agreement

 
 <documentReference documentType="AgreementNumber" id="325899" date="2021-12-09"/>
/b24Message/returnAnnouncement/documentReference[@documentType="AgreementNumber"]/@id Text 2500 16
Agreement date

The reference date of an agreement

 
 <documentReference documentType="AgreementNumber" id="325899" date="2021-12-09"/>
/b24Message/returnAnnouncement/documentReference[@documentType="AgreementNumber"]/@date Date/Time 2600 17
Delivery date

The date when the goods were delivered

 
 <property name="deliveryDate">2021-12-09</property>
/b24Message/returnAnnouncement/property[@name="deliveryDate"] Date/Time 2700 18
Earliest collection date

The collection date, earliest

 
 <property name="earliestCollectionDate">2021-12-08</property>
/b24Message/returnAnnouncement/property[@name="earliestCollectionDate"] Date/Time 2800 19
Latest collection date

The collection date, latest

 
 <property name="latestCollectionDate">2021-12-09</property>
/b24Message/returnAnnouncement/property[@name="latestCollectionDate"] Date/Time 2900 20
Supplier GLN Yes

The supplier/brand, identified by a GLN

 
 <supplier gln="7340117815580" name="Btwentyfour Demo Supplier">
/b24Message/returnAnnouncement/supplier/@gln Number 3000 21
Supplier Name

Name of the supplier party

 
 <supplier gln="7340117815580" name="Btwentyfour Demo Supplier">
/b24Message/returnAnnouncement/supplier/@name Text 3100 22
Supplier Org Number

Corporate identity number of the supplier party

 
 <supplier gln="7340117815580" name="Btwentyfour Demo Supplier" orgNo="99999999-9999">
/b24Message/returnAnnouncement/supplier/@orgNo Text 3200 23
Supplier VAT number

VAT number (value added tax number) of the supplier party

 
 <supplier gln="7340117815580" name="Btwentyfour Demo Supplier" vatNo="SE999999999999">
/b24Message/returnAnnouncement/supplier/@vatNo Text 3300 24
Supplier Contact

Name of a contact person

 
 <supplier gln="7340117815580" name="Btwentyfour Demo Supplier" contact="ReferenceName">
/b24Message/returnAnnouncement/supplier/@contact Text 3400 25
Supplier Address

Address of the supplier party

 
 <address>StreetAddress</address>
/b24Message/returnAnnouncement/supplier/location/address Text 3500 26
Supplier Zip Code

Zip code of the supplier party

 
 <city code="ZipCode">CityName</city>
/b24Message/returnAnnouncement/supplier/location/city/@code Text 3600 27
Supplier City

City of the supplier party

 
 <city code="ZipCode">CityName</city>
/b24Message/returnAnnouncement/supplier/location/city Text 3700 28
Supplier Country

Country of the supplier party

 
 <country code="CountryCode">CountryName</country>
/b24Message/returnAnnouncement/supplier/location/country Text 3800 29
Supplier Country Code

Country code of the supplier party

 
 <country code="CountryCode">CountryName</country>
/b24Message/returnAnnouncement/supplier/location/country/@code Text 3900 30
Supplier Phone number

Telephone number of the contact person

 
 <telephoneNumber>+45000000002</telephoneNumber>
/b24Message/returnAnnouncement/supplier/location/telephoneNumber Number 4000 31
Supplier Email

An e-mail address of the contact person

 
 <emailAddress>supplier@email.com</emailAddress>
/b24Message/returnAnnouncement/supplier/location/emailAddress Text 4100 32
Supplier external ID

External identifier, set by sender of the message

 
 <property name="id">5122186</property>
/b24Message/returnAnnouncement/supplier/property[@name="id"] Text 4200 33
Supplier internal ID

Internal identifier, mapped in the Btwentyfour Open Commerce Platform.

 
 <property name="internalId">8899</property>
/b24Message/returnAnnouncement/supplier/property[@name="internalId"] Text 4300 34
Supplier Name 2

A second name field for the supplier party

 
 <property name="name2">The second supplier name</property>
/b24Message/returnAnnouncement/supplier/property[@name="name2"] Text 4400 35
Buyer GLN Yes

The buying party, identified by a GLN

 
 <buyer gln="7340117836950" name="Btwentyfour Demo Buying Group">
/b24Message/returnAnnouncement/buyer/@gln Number 4500 36
Buyer Name

Name of the buyer party

 
 <buyer gln="7340117836950" name="Btwentyfour Demo Buying Group">
/b24Message/returnAnnouncement/buyer/@name Text 4600 37
Buyer Address

Address of the buyer party

 
 <address>StreetAddress</address>
/b24Message/returnAnnouncement/buyer/location/address Text 4700 38
Buyer Zip Code

Zip code of the buyer party

 
 <city code="ZipCode">CityName</city>
/b24Message/returnAnnouncement/buyer/location/city/@code Text 4800 39
Buyer City

City of the buyer party

 
 <city code="ZipCode">CityName</city>
/b24Message/returnAnnouncement/buyer/location/city Text 4900 40
Buyer State

State of the buyer party

 
 <state code="StateCode">StateName</state>
/b24Message/returnAnnouncement/buyer/location/state Text 5000 41
Buyer State Code

State code of the buyer party

 
 <state code="StateCode">StateName</state>
/b24Message/returnAnnouncement/buyer/location/state/@code Text 5100 42
Buyer Country

Country of the buyer party

 
 <country code="CountryCode">CountryName</country>
/b24Message/returnAnnouncement/buyer/location/country Text 5200 43
Buyer Country Code

Country code of the buyer party

 
 <country code="CountryCode">CountryName</country>
/b24Message/returnAnnouncement/buyer/location/country/@code Text 5300 44
Buyer Phone number

Telephone number of the contact person

 
 <telephoneNumber>+45000000001</telephoneNumber>
/b24Message/returnAnnouncement/buyer/location/telephoneNumber Number 5400 45
Buyer Email

An e-mail address of the contact person

 
 <emailAddress>buyer@email.com</emailAddress>
/b24Message/returnAnnouncement/buyer/location/emailAddress Text 5500 46
Buyer external ID

External identifier, set by sender of the message

 
 <property name="id">3512421</property>
/b24Message/returnAnnouncement/buyer/property[@name="id"] Text 5600 47
Buyer internal ID

Internal identifier, mapped in the Btwentyfour Open Commerce Platform.

 
 <property name="internalId">1133</property>
/b24Message/returnAnnouncement/buyer/property[@name="internalId"] Text 5700 48
Buyer Name 2

A second name field for the buyer party

 
 <property name="name2">The second buyer name</property>
/b24Message/returnAnnouncement/buyer/property[@name="name2"] Text 5800 49
Site GLN

The site/store location party, identified by a GLN

 
 <site gln="7340117804522" name="Site Location Name" contact="Reference Name" orgNo="77777777-7777" vatNo="DK6666666666666">
/b24Message/returnAnnouncement/site/@gln Number 5900 50
Site Name

Name of the site party

 
 <site gln="7340117804522" name="Site Location Name" contact="Reference Name" orgNo="77777777-7777" vatNo="DK6666666666666">
/b24Message/returnAnnouncement/site/@name Text 6000 51
Site Address

Address of the site party

 
 <address>StreetAddress</address>
/b24Message/returnAnnouncement/site/location/address Text 6100 52
Site Zip Code

Zip code of the site party

 
 <city code="ZipCode">CityName</city>
/b24Message/returnAnnouncement/site/location/city/@code Text 6200 53
Site City

City of the site party

 
 <city code="ZipCode">CityName</city>
/b24Message/returnAnnouncement/site/location/city Text 6300 54
Site State

State of the site party

 
 <state code="StateCode">StateName</state>
/b24Message/returnAnnouncement/site/location/state Text 6400 55
Site State Code

State code of the site party

 
 <state code="StateCode">StateName</state>
/b24Message/returnAnnouncement/site/location/state/@code Text 6500 56
Site Country

Country of the site party

 
 <country code="CountryCode">CountryName</country>
/b24Message/returnAnnouncement/site/location/country Text 6600 57
Site Country Code

Country code of the site party

 
 <country code="CountryCode">CountryName</country>
/b24Message/returnAnnouncement/site/location/country/@code Text 6700 58
Site Phone number

Telephone number of the contact person

 
 <telephoneNumber>+45000000003</telephoneNumber>
/b24Message/returnAnnouncement/site/location/telephoneNumber Number 6800 59
Site Email

An e-mail address of the contact person

 
 <emailAddress>SiteLocation@email.com</emailAddress>
/b24Message/returnAnnouncement/site/location/emailAddress Text 6900 60
Site external ID

External identifier, set by sender of the message

 
 <property name="id">1422182</property>
/b24Message/returnAnnouncement/site/property[@name="id"] Text 7000 61
Site internal ID

Internal identifier, mapped in the Btwentyfour Open Commerce Platform.

 
 <property name="internalId">1132</property>
/b24Message/returnAnnouncement/site/property[@name="internalId"] Text 7100 62
Site Name 2

A second name field for the site party

 
 <property name="name2">The second site location party name</property>
/b24Message/returnAnnouncement/site/property[@name="name2"] Text 7200 63
Supplier Item ID

The supplier's unique item ID of the product

 
 <item id="1000000001111">
/b24Message/returnAnnouncement/item/@id Text 7300 64
Return announcement line number

The return announcement line number

 
 <documentReference documentType="ReturnAnnouncement" id="777888" date="2021-12-09" lineNo="1"/>
/b24Message/returnAnnouncement/item/documentReference[@documentType="ReturnAnnouncement"]/@lineNo Text 7400 65
Article description

The supplier's article description

 
 <property name="description">product description</property>
/b24Message/returnAnnouncement/item/property[@name="description"] Text 7500 66
Unit of measure

Unit of measure

 
 <property name="unitOfMeasure">PCE</property>
/b24Message/returnAnnouncement/item/@unitOfMeasure Text 7600 67
Barcode with type Yes

The supplier's EAN/UPC code of the product

 
 <itemReference registry="Supplier" coding="EAN13">7313492579392</itemReference>
/b24Message/returnAnnouncement/item/itemReference[@registry="Supplier" and @coding="barcodeType"] Number 7700 68
Buyer Item id

The buyer's unique item ID of the product

 
 <itemReference registry="Buyer" name="itemId">198877</itemReference>
/b24Message/returnAnnouncement/item/itemReference[@registry="Buyer" and @name="itemId"] Text 7800 69
Net price with currency

The net price of the product

 
 <price type="netPrice" value="90.00" currency="EUR"/>
/b24Message/returnAnnouncement/item/price[@type="netPrice"]/@value and @currency Number 7900 70
Gross price with currency

The gross price of the product

 
 <price type="grossPrice" value="100.00" currency="EUR"/>
/b24Message/returnAnnouncement/item/price[@type="grossPrice"]/@value and @currency Number 8000 71
Discount percentage

The discount percentage for the product

 
 <price type="discountPercentage" value="10.00" currency="EUR"/>
/b24Message/returnAnnouncement/item/price[@type="discountPercentage"]/@value Number 8100 72
Discount amount

The discount amount for the product

 
 <price type="discountAmount" value="15.00" currency="EUR"/>
/b24Message/returnAnnouncement/item/price[@type="discountAmount"]/@value Number 8200 73
Quantity Return Yes

The quantity of the item

 
 <quantity type="Return" value="5">
/b24Message/returnAnnouncement/item/quantity[@type="Return" and @value] Number 8300 74
Reason Yes

Reason for return

 
 <quantityReason code="4D" value="1">Damaged Goods</quantityReason >
/b24Message/returnAnnouncement/item/quantity/quantityReason[@code & @value] Text 8400 75