Order properties
Fields used as order properties
Name | Required | Description | Examples | XPATH | Type | Limits | Sort |
---|---|---|---|---|---|---|---|
(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. |
|
/b24Message/order/property[@name="allowBackOrder"] |
Yes/No | 1700 | ||
(Header): Customer order notes | Any specific notes related to the order. |
|
/b24Message/order/property[@name="customerOrderNotes"] |
Text | 1800 | ||
(Header): Customer Order Reference | Notes to be put on packing slip. |
|
/b24Message/order/property[@name="customerOrderRef"] |
Text | 1900 | ||
(Header): Discount Amount | Total discount amount for the whole order, specified on header level. |
|
/b24Message/order/property[@name="discountAmount"] |
Number | 2800 | ||
(Header): Discount Percentage | Total discount percentage for the whole order, specified on header level. |
|
/b24Message/order/property[@name="discountPercentage"] |
Number | 2700 | ||
(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. |
|
/b24Message/order/property[@name="giftMessage"] |
Text | 2100 | ||
(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) |
|
/b24Message/order/property[@name="giftOrder"] |
Yes/No | 2000 | ||
(Header): Invoicee Address | Address of the invoicee. |
|
/b24Message/order/property[@name="invoiceeAddress"] |
Text | 3400 | ||
(Header): Invoicee City | City of the invoicee. |
|
/b24Message/order/property[@name="invoiceeCity"] |
Text | 3600 | ||
(Header): Invoicee Contact | Name of a invoicee. |
|
/b24Message/order/property[@name="invoiceeContact"] |
Text | 4100 | ||
(Header): Invoicee Country | Country of the invoicee. |
|
/b24Message/order/property[@name="invoiceeCountry"] |
Text | 3700 | ||
(Header): Invoicee Country Code | Country code of the invoicee. |
|
/b24Message/order/property[@name="invoiceeCountryCode"] |
Text | 3800 | ||
(Header): Invoicee Email | An e-mail address of the invoicee. |
|
/b24Message/order/property[@name="invoiceeEmailAddress"] |
Text | 4300 | ||
(Header): Invoicee GLN | The invoicee party, identified by a GLN. |
|
/b24Message/order/property[@name="invoicee"] |
Text | 3000 | ||
(Header): Invoicee Name | Name of the invoicee. |
|
/b24Message/order/property[@name="invoiceeName"] |
Text | 3100 | ||
(Header): Invoicee Name 2 | A second name field for the invoicee party |
|
/b24Message/order/property[@name="invoiceeName2"] |
Text | 3200 | ||
(Header): Invoicee Name 3 | A third name field for the invoicee party |
|
/b24Message/order/property[@name="invoiceeName3"] |
Text | 3300 | ||
(Header): Invoicee Org No | Corporate identity number of the invoicee party. |
|
/b24Message/order/property[@name="invoiceeOrgNo"] |
Text | 3900 | ||
(Header): Invoicee Phone Number | Telephone number of the invoicee. |
|
/b24Message/order/property[@name="invoiceeTelephoneNumber"] |
Text | 4200 | ||
(Header): Invoicee VAT No | VAT number (value added tax number) of the invoicee party. |
|
/b24Message/order/property[@name="invoiceeVatNo"] |
Text | 4000 | ||
(Header): Invoicee Zip code | Zip code of the invoicee. |
|
/b24Message/order/property[@name="invoiceeCityCode"] |
Text | 3500 | ||
(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 |
|
/b24Message/order/property[@name="orderGrossValue"] |
Number | 2600 | ||
(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 |
|
/b24Message/order/property[@name="orderNetValue"] |
Number | 2500 | ||
(Header): Payment Terms | No | The order's payment terms, specified in plain text. |
|
/b24Message/order/property[@name="paymentTerms"] | Text | 3550 | |
(Header): Requested Delivery Date | The requested date of delivery for the order, set by the buyer. |
|
/b24Message/order/property[@name="deliveryDate"] |
Date/Time | 1400 | ||
(Header): Requested earlieast delivery date | The earliest requested date of delivery for the order, set by the buyer. |
|
/b24Message/order/property[@name="earliestDeliveryDate"] |
Date/Time | 1500 | ||
(Header): Requested latest delivery date | The latest requested date of delivery for the order, set by the buyer. |
|
/b24Message/order/property[@name="latestDeliveryDate"] |
Date/Time | 1600 | ||
(Header): Requested Shipping Date | The date for the ordered goods to be shipped/sent from the seller (supplier or manufacturer) to the buyer. |
|
/b24Message/order/property[@name="shippingDate"] | Date/Time | 2150 | ||
(Header): Season | The season code for the referred items |
|
/b24Message/order/property[@name="season"] |
Text | 1200 | ||
(Header): Shipping Type | The buyer's/consumer's chosen delivery service level when receiving the ordered goods via shipper/carrier. |
|
/b24Message/order/property[@name="shippingType"] |
Text | 2400 | ||
(Header): Supplier generated order | Is the orders created by the supplier? |
|
/b24Message/order/property[@name="supplierGeneratedOrder"] |
Yes/No | 2200 | ||
(Header): Terms of delivery | Any specific terms of delivery set by the buyer. |
|
/b24Message/order/property[@name="termsOfDelivery"] |
Text | 2300 | ||
(Header): Ultimate Consignee Address | Address of the ultimate consignee. |
|
/b24Message/order/property[@name="ultimateConsigneeAddress"] |
Text | 4800 | ||
(Header): Ultimate Consignee City | City of the ultimate consignee. |
|
/b24Message/order/property[@name="ultimateConsigneeCity"] |
Text | 5000 | ||
(Header): Ultimate Consignee Contact | Name of a ultimate consignee. |
|
/b24Message/order/property[@name="ultimateConsigneeContact"] |
Text | 5500 | ||
(Header): Ultimate Consignee Country | Country of the ultimate consignee. |
|
/b24Message/order/property[@name="ultimateConsigneeCountry"] |
Text | 5100 | ||
(Header): Ultimate Consignee Country Code | Country code of the ultimate consignee. |
|
/b24Message/order/property[@name="ultimateConsigneeCountryCode"] |
Text | 5200 | ||
(Header): Ultimate Consignee Email | An e-mail address of the ultimate consignee. |
|
/b24Message/order/property[@name="ultimateConsigneeEmailAddress"] |
Text | 5700 | ||
(Header): Ultimate Consignee GLN | The party to which the goods are ultimately delivered, identified by a GLN. |
|
/b24Message/order/property[@name="ultimateConsignee"] |
Text | 4400 | ||
(Header): Ultimate Consignee Name | Name of the ultimate consignee. |
|
/b24Message/order/property[@name="ultimateConsigneeName"] |
Text | 4500 | ||
(Header): Ultimate Consignee Name 2 | A second name field for the ultimate consignee party |
|
/b24Message/order/property[@name="ultimateConsigneeName2"] |
Text | 4600 | ||
(Header): Ultimate Consignee Name 3 | A third name field for the ultimate consignee party |
|
/b24Message/order/property[@name="ultimateConsigneeName3"] |
Text | 4700 | ||
(Header): Ultimate Consignee Org No | Corporate identity number of the ultimate consignee party. |
|
/b24Message/order/property[@name="ultimateConsigneeOrgNo"] |
Text | 5300 | ||
(Header): Ultimate Consignee Phone number | Telephone number of the ultimate consignee. |
|
/b24Message/order/property[@name="ultimateConsigneeTelephoneNumber"] |
Text | 5600 | ||
(Header): Ultimate Consignee VAT No | VAT number (value added tax number) of the ultimate consignee party. |
|
/b24Message/order/property[@name="ultimateConsigneeVatNo"] |
Text | 5400 | ||
(Header): Ultimate Consignee Zip Code | Zip code of the ultimate consignee. |
|
/b24Message/order/property[@name="ultimateConsigneeCityCode"] |
Text | 4900 | ||
(Header): Ultimate Customer Address | Address of the ultimate customer. |
|
/b24Message/order/property[@name="ultimateCustomerAddress"] |
Text | 6200 | ||
(Header): Ultimate Customer City | City of the ultimate customer. |
|
/b24Message/order/property[@name="ultimateCustomerCity"] |
Text | 6400 | ||
(Header): Ultimate Customer Country | Country of the ultimate customer. |
|
/b24Message/order/property[@name="ultimateCustomerCountry"] |
Text | 6500 | ||
(Header): Ultimate Customer Country Code | Country code of the ultimate customer. |
|
/b24Message/order/property[@name="ultimateCustomerCountryCode"] |
Text | 6600 | ||
(Header): Ultimate Customer Email | An e-mail address of the ultimate customer. |
|
/b24Message/order/property[@name="ultimateCustomerEmailAddress"] |
Text | 6800 | ||
(Header): Ultimate Customer GLN | The GLN of the shop/marketplace where the ultimate customer purchased its ordered item(s). |
|
/b24Message/order/property[@name="ultimateCustomer"] |
Text | 6100 | ||
(Header): Ultimate Customer Name | Name of the customer to which the goods are ultimately delivered, identified by a name and address. |
|
/b24Message/order/property[@name="ultimateCustomerName"] |
Text | 5800 | ||
(Header): Ultimate Customer Name 2 | A second name field for the ultimate customer party |
|
/b24Message/order/property[@name="ultimateCustomerName2"] |
Text | 5900 | ||
(Header): Ultimate Customer Name 3 | A third name field for the ultimate customer party |
|
/b24Message/order/property[@name="ultimateCustomerName3 |
Text | 6000 | ||
(Header): Ultimate Customer Phone number | Telephone number of the ultimate customer. |
|
/b24Message/order/property[@name="ultimateCustomerTelephoneNumber"] |
Text | 6700 | ||
(Header): Ultimate Customer Zip Code | Zip code of the ultimate customer. |
|
/b24Message/order/property[@name="ultimateCustomerCityCode"] |
Text | 6300 |