Order properties

Fields used as order properties

Name Required Description Examples XPATH Type Limits Sort
(Header) : Requested Latest Shipping Date No

The latest date for the ordered goods to be shipped/sent from the seller (supplier or manufacturer) to the buyer. (order should not be shipped later than…)

 
<property name="latestShippingDate">2020-09-14</property>

 

 /b24Message/order/property[@name="latestShippingDate"] Date/Time 2760
(Header): Allow Backorder

Indicates whether the buyer allows items to be back-ordered or not. If no, ("N"), then the whole order should be cancelled unless the seller cannot fulfill the the ordered quantities.

 
 <property name="allowBackOrder">N</property>

/b24Message/order/property[@name="allowBackOrder"]

 Yes/No 3000
(Header): Customer order notes

Any specific notes related to the order.

 
 <property name="customerOrderNotes">longer note made by Buyer to the supplier</property>

/b24Message/order/property[@name="customerOrderNotes"]

 Text 3100
(Header): Customer Order Reference

Notes to be put on packing slip.

 
 <property name="customerOrderRef">Note to be put on packing slip</property>

/b24Message/order/property[@name="customerOrderRef"]

 Text 3200
(Header): Discount Amount

Total discount amount for the whole order, specified on header level.

 
 <property name="discountAmount">36.00</property>

/b24Message/order/property[@name="discountAmount"]

 Number 4200
(Header): Discount Percentage

Total discount percentage for the whole order, specified on header level.

 
 <property name="discountPercentage">20.00</property>

/b24Message/order/property[@name="discountPercentage"]

 Number 4100
(Header): Gift Message

Gift Message/personal greeting to be added to the order before delivery. Typical application scenario would be a B2C where consumer is buying a present and have the gift message specified for the intended gift recipient.

 
 <property name="giftMessage">I am so happy for you!</property>

/b24Message/order/property[@name="giftMessage"]

 Text 3400
(Header): Gift Order

Indicates if the order is a gift order or not, Y=Yes/True, order is a gift, N=No/False, order is NOT a gift. (Any order not containing the gift-order field at all, is to be considered as NOT being a gift order)

 
 <property name="giftOrder">Y</property>

/b24Message/order/property[@name="giftOrder"]

 Yes/No 3300
(Header): Incoterms No

Series of three-letter abbreviations/codes, indicating trade terms related to common contractual sales practices. Incoterms rules are intended to clearly communicate the tasks, costs, and risks associated with the global or international transportation and delivery of goods.
 

 
<property name="incoterms" code="DDP">Delivery Duty Paid</property>

 

 /b24Message/order/property[@name="incoterms"]/@code Text 3650
(Header): Invoicee Address

Address of the invoicee.

 
 <property name="invoiceeAddress">invoiceeAddress</property>

/b24Message/order/property[@name="invoiceeAddress"]

 Text 4700
(Header): Invoicee City

City of the invoicee.

 
 <property name="invoiceeCity">invoiceeCity</property>

/b24Message/order/property[@name="invoiceeCity"]

 Text 5000
(Header): Invoicee Contact

Name of a invoicee.

 
 <property name="invoiceeContact">invoiceeContact</property>

/b24Message/order/property[@name="invoiceeContact"]

 Text 5500
(Header): Invoicee Country

Country of the invoicee.

 
 <property name="invoiceeCountry">invoiceeCountryName</property>

/b24Message/order/property[@name="invoiceeCountry"]

 Text 5100
(Header): Invoicee Country Code

Country code of the invoicee.

 
 <property name="invoiceeCountryCode">invoiceeCountryCode</property>

/b24Message/order/property[@name="invoiceeCountryCode"]

 Text 5200
(Header): Invoicee Email

An e-mail address of the invoicee.

 
 <property name="invoiceeEmailAddress">invoiceeEmailAddress</property>

/b24Message/order/property[@name="invoiceeEmailAddress"]

 Text 5700
(Header): Invoicee GLN

The invoicee party, identified by a GLN.

 
 <property name="invoicee">invoiceeGLN</property>

/b24Message/order/property[@name="invoicee"]

 Text 4300
(Header): Invoicee Name

Name of the invoicee.

 
 <property name="invoiceeName">invoiceeName</property>

/b24Message/order/property[@name="invoiceeName"]

 Text 4400
(Header): Invoicee Name 2

A second name field for the invoicee party

 
 <property name="invoiceeName2">The second invoicee name</property>

/b24Message/order/property[@name="invoiceeName2"]

 Text 4500
(Header): Invoicee Name 3

A third name field for the invoicee party

 
 <property name="invoiceeName3">The third invoicee name</property>

/b24Message/order/property[@name="invoiceeName3"]

 Text 4600
(Header): Invoicee Org No

Corporate identity number of the invoicee party.

 
 <property name="invoiceeOrgNo">invoiceeOrgNo</property>

/b24Message/order/property[@name="invoiceeOrgNo"]

 Text 5300
(Header): Invoicee Phone Number

Telephone number of the invoicee.

 
 <property name="invoiceeTelephoneNumber">invoiceeTelephoneNumber</property>

/b24Message/order/property[@name="invoiceeTelephoneNumber"]

 Text 5600
(Header): Invoicee VAT No

VAT number (value added tax number) of the invoicee party.

 
 <property name="invoiceeVatNo">invoiceeVatNumber</property>

/b24Message/order/property[@name="invoiceeVatNo"]

 Text 5400
(Header): Invoicee Zip code

Zip code of the invoicee.

 
 <property name="invoiceeCityCode">invoiceeZipCode</property>

/b24Message/order/property[@name="invoiceeCityCode"]

 Text 4800
(Header): Order gross value

The total gross value of the order, before discount is applied (the sum of grossPrice multiplied by quantity for all items). Set by the buyer

 
 <property name="orderGrossValue">600.00</property>

/b24Message/order/property[@name="orderGrossValue"]

 Number 4000
(Header): Order net value

The total net value of the order, after discount is applied (the sum of netPrice multiplied by quantity for all items). Set by the buyer

 
 <property name="orderNetValue">540.00</property>

/b24Message/order/property[@name="orderNetValue"]

 Number 3900
(Header): Payment Terms No

The order's payment terms, specified in plain text.

 
 <property name="paymentTerms">30 Days</property>

/b24Message/order/property[@name="paymentTerms"]

 Text 4900
(Header): Port of Arrival No

The intended port of arrival/destination for the ordered goods. (Code = UN/LOCODE) 

 
<property name="portOfArrival" code="SEVFA">Västra Frölunda/Göteborg</property>

 

 /b24Message/order/property[@name="portOfArrival"] Text 3750
(Header): Purchaser No

The name of the buying organization's responsible person for the purchase/purchase order.

 
<property name="purchaser">FristName LastName</property>

 

 /b24Message/order/property[@name="purchaser"] Text 3220
(Header): Purchaser Email Address No

The email address of the buying organization's purchaser/responsible person for the purchase order.

 
<property name="purchaserEmailAddress">name.lastname@comapny.org</property>

 

 /b24Message/order/property[@name="purchaserEmailAddress"] Text 3240
(Header): Purchasing Assistant No

Name of person/resource assisting with the purchase/purchase order within the buying organization.

 
<property name="purchasingAssistant">FirstName LastName</property>

 

 /b24Message/order/property[@name="purchasingAssistant"] Text 3260
(Header): Purchasing Assistant Email No

The email address of the buying organization's purchasing assistant.

 
<property name="purchasingAssistantEmailAddress">name.lastname@company.org</property>

 

 /b24Message/order/property[@name="purchasingAssistantEmail"] Text 3280
(Header): Requested Delivery Date

The requested date of delivery for the order, set by the buyer.

 
 <property name="deliveryDate">2015-11-01</property>

/b24Message/order/property[@name="deliveryDate"]

 Date/Time 2700
(Header): Requested earlieast delivery date

The earliest requested date of delivery for the order, set by the buyer.

 
 <property name="earliestDeliveryDate">2015-11-01</property>

/b24Message/order/property[@name="earliestDeliveryDate"]

 Date/Time 2800
(Header): Requested latest delivery date

The latest requested date of delivery for the order, set by the buyer.

 
 <property name="latestDeliveryDate">2015-12-01</property>

/b24Message/order/property[@name="latestDeliveryDate"]

 Date/Time 2900
(Header): Requested Shipping Date

The date for the ordered goods to be shipped/sent from the seller (supplier or manufacturer) to the buyer.

 
 <property name="shippingDate">YYYY-MM-DD</property>

/b24Message/order/property[@name="shippingDate"]

 Date/Time 3500
(Header): Season

The season code for the referred items

 
 <property name="season">SS21</property>

/b24Message/order/property[@name="season"]

 Text 2600
(Header): Shipping Type

The buyer's/consumer's chosen delivery service level when receiving the ordered goods via shipper/carrier.

 
 <property name="shippingType">Standard Pick up Point</property>

/b24Message/order/property[@name="shippingType"]

 Text 3800
(Header): Supplier generated order

Is the orders created by the supplier?

 
 <property name="supplierGeneratedOrder">Y</property>

/b24Message/order/property[@name="supplierGeneratedOrder"]

 Yes/No 3600
(Header): Terms of Delivery No

Free text information/description about agreed/used delivery terms for ordered goods.

 
 <property name="termsOfDelivery">The seller hands over the goods once they have been imported and placed at the disposal of the buyer on the arriving means of transport, ready for unloading at the specified destination. The seller bears all costs and risks associated with transporting the goods to the specified place and shall clear the goods not only for export but also for import, pay all duties for export and import and complete all customs formalities.</property>

/b24Message/order/property[@name="termsOfDelivery"]

 Text N/A 3700
(Header): Transportation Method No

The method/mode of transport used for the shipping the ordered goods (such as "Maritime/Sea", "Air", "Road")
 

 
<property name="transportationMethod" code="1">Maritime (Sea) transport</property>

 

 /b24Message/order/property[@name="transportationMethod"] Text 3600
(Header): Ultimate Consignee Address

Address of the ultimate consignee.

 
 <property name="ultimateConsigneeAddress">ultimateConsigneeAddress</property>

/b24Message/order/property[@name="ultimateConsigneeAddress"]

 Text 6200
(Header): Ultimate Consignee City

City of the ultimate consignee.

 
 <property name="ultimateConsigneeCity">ultimateConsigneeCity</property>

/b24Message/order/property[@name="ultimateConsigneeCity"]

 Text 6400
(Header): Ultimate Consignee Contact

Name of a ultimate consignee.

 
 <property name="ultimateConsigneeContact">ultimateConsigneeContact</property>

/b24Message/order/property[@name="ultimateConsigneeContact"]

 Text 6900
(Header): Ultimate Consignee Country

Country of the ultimate consignee.

 
 <property name="ultimateConsigneeCountry">ultimateConsigneeCountryName</property>

/b24Message/order/property[@name="ultimateConsigneeCountry"]

 Text 6500
(Header): Ultimate Consignee Country Code

Country code of the ultimate consignee.

 
 <property name="ultimateConsigneeCountryCode">ultimateConsigneeCountryCode</property>

/b24Message/order/property[@name="ultimateConsigneeCountryCode"]

 Text 6600
(Header): Ultimate Consignee Email

An e-mail address of the ultimate consignee.

 
 <property name="ultimateConsigneeEmailAddress">ultimateConsigneeEmailAddress</property>

/b24Message/order/property[@name="ultimateConsigneeEmailAddress"]

 Text 7100
(Header): Ultimate Consignee GLN

The party to which the goods are ultimately delivered, identified by a GLN.

 
 <property name="ultimateConsignee">ultimateConsigneeGLN</property>

/b24Message/order/property[@name="ultimateConsignee"]

 Text 5800
(Header): Ultimate Consignee Name

Name of the ultimate consignee.

 
 <property name="ultimateConsigneeName">ultimateConsigneeName</property>

/b24Message/order/property[@name="ultimateConsigneeName"]

 Text 5900
(Header): Ultimate Consignee Name 2

A second name field for the ultimate consignee party

 
 <property name="ultimateConsigneeName2">The second ultimate consignee name</property>

/b24Message/order/property[@name="ultimateConsigneeName2"]

 Text 6000
(Header): Ultimate Consignee Name 3

A third name field for the ultimate consignee party

 
 <property name="ultimateConsigneeName3">The third ultimate consignee name</property>

/b24Message/order/property[@name="ultimateConsigneeName3"]

 Text 6100
(Header): Ultimate Consignee Org No

Corporate identity number of the ultimate consignee party.

 
 <property name="ultimateConsigneeOrgNo">ultimateConsigneeOrgNo</property>

/b24Message/order/property[@name="ultimateConsigneeOrgNo"]

 Text 6700
(Header): Ultimate Consignee Phone number

Telephone number of the ultimate consignee.

 
 <property name="ultimateConsigneeTelephoneNumber">ultimateConsigneeTelephoneNumber</property>

/b24Message/order/property[@name="ultimateConsigneeTelephoneNumber"]

 Text 7000
(Header): Ultimate Consignee VAT No

VAT number (value added tax number) of the ultimate consignee party.

 
 <property name="ultimateConsigneeVatNo">ultimateConsigneeVatNumber</property>

/b24Message/order/property[@name="ultimateConsigneeVatNo"]

 Text 6800
(Header): Ultimate Consignee Zip Code

Zip code of the ultimate consignee.

 
 <property name="ultimateConsigneeCityCode">ultimateConsigneeZipCode</property>

/b24Message/order/property[@name="ultimateConsigneeCityCode"]

 Text 6300
(Header): Ultimate Customer Address

Address of the ultimate customer.

 
 <property name="ultimateCustomerAddress">ultimateCustomerAddress</property>

/b24Message/order/property[@name="ultimateCustomerAddress"]

 Text 7600
(Header): Ultimate Customer City

City of the ultimate customer.

 
 <property name="ultimateCustomerCity">ultimateCustomerCity</property>

/b24Message/order/property[@name="ultimateCustomerCity"]

 Text 7800
(Header): Ultimate Customer Country

Country of the ultimate customer.

 
 <property name="ultimateCustomerCountry">ultimateCustomerCountryName</property>

/b24Message/order/property[@name="ultimateCustomerCountry"]

 Text 7900
(Header): Ultimate Customer Country Code

Country code of the ultimate customer.

 
 <property name="ultimateCustomerCountryCode">ultimateCustomerCountryCode</property>

/b24Message/order/property[@name="ultimateCustomerCountryCode"]

 Text 8000
(Header): Ultimate Customer Email

An e-mail address of the ultimate customer.

 
 <property name="ultimateCustomerEmailAddress">ultimateCustomerEmailAddress</property>

/b24Message/order/property[@name="ultimateCustomerEmailAddress"]

 Text 8200
(Header): Ultimate Customer GLN

The GLN of the shop/marketplace where the ultimate customer purchased its ordered item(s).

 
 <property name="ultimateCustomer">ultimateCustomerGLN</property>

/b24Message/order/property[@name="ultimateCustomer"]

 Text 7500
(Header): Ultimate Customer Name

Name of the customer to which the goods are ultimately delivered, identified by a name and address.

 
 <property name="ultimateCustomerName">ultimateCustomerName</property>

/b24Message/order/property[@name="ultimateCustomerName"]

 Text 7200
(Header): Ultimate Customer Name 2

A second name field for the ultimate customer party

 
 <property name="ultimateCustomerName2">The second ultimate customer name</property>

/b24Message/order/property[@name="ultimateCustomerName2"]

 Text 7300
(Header): Ultimate Customer Name 3

A third name field for the ultimate customer party

 
 <property name="ultimateCustomerName3">The third ultimate customer name</property>

/b24Message/order/property[@name="ultimateCustomerName3

 Text 7400
(Header): Ultimate Customer Phone number

Telephone number of the ultimate customer.

 
 <property name="ultimateCustomerTelephoneNumber">ultimateCustomerTelephoneNumber</property>

/b24Message/order/property[@name="ultimateCustomerTelephoneNumber"]

 Text 8100
(Header): Ultimate Customer Zip Code

Zip code of the ultimate customer.

 
 <property name="ultimateCustomerCityCode">ultimateCustomerZipCode</property>

/b24Message/order/property[@name="ultimateCustomerCityCode"]

 Text 7700