Customer order

Description

Description of message flow regarding new customer order messages sent to XTND BACKEND.

Only new customer order messages is sent, change and cancellation is not possible.

Specification

XML Struktur

LxirEnvelope(1)

LxirEnvelope/Header(1)

Element	Code	Mand.	Explanation
DateTime		Y	Date and time stamp when message was created
DocumentNumber		N	Counter for document no
DocumentVersion		N	Document version
DocumentName		N	Document name
ToPartnerUser		Y	Short name [KORT] on the client the message refers to. Code available from contact person for integration.
ToPartner		Y	[KORT]
FromPartnerUser		Y	[KORT]
FromPartner		N	Fixed value, Short name loading system

LxirEnvelope /Body(1)

LxirEnvelope /Body /LxirCustomerOrder(n)

Element	Code	Mand.	Explanation
OperationCode		Y	OperationCode for Order valid values 1
Number		Y	Internal ordernumber
OrderDate		N	Orderdate (ÅÅÅÅ-MM-DD hh:mm)
AskedDeliveryDate		Y	Desired delivery date (ÅÅÅÅ-MM-DD tt:mm) (enligt incoterms)
Notes		N	Notes
OrderType		N	Order type (1 "Normalorder", 2 "Quickorder",4 "Expressorder",2048 "Season order",4096 "Webshop order") Default is 1 “NormalOrder” if elementet is missing.
PaymentType		Y	Payment (INV "Billing", AUTO Autogiro", ADV "Advance payment", FAC "Factoring", CAS "Cash payment", LAS "Last schrift", CC "Credit card", MOH "Manual on hold", FAM "Invoice me")
FreightFree		Y	freight free
OrderNumberEndCustomer		N	Ordernummer for end customer
YourReference		N	Your reference
OurReference		N	Our reference
InvoiceEmail		N	E-mail address for invoice. Can put attribute in this element to control which system is master: DataMaster = "Internal" atl. "External".
OrderEmail		N	E-mail address for invoice. Can put attribute in this element to control which system is master: DataMaster = "Internal" atl. "External".
OrderPhoneNumber		N	Phone number
AdvisePhoneNumber		N	Advise phone number
PartialDelivery		N	Allow partial delivery of orders. The item is omitted completely if value is missing and default value is to be used.
TransportCondition		N	Transport Conditions
DeliveryMethod		N	Method of delivery
HandlingMark		N	Handling remark
ShippingMark		N	Shippment remark
ClientSalesChannelId		N	This field is for Extend internal use and is normally not set by an external integrating party. It must exist if LxirCustomerOrder is used for a XTND Backend Sales Channel integration.
OrderReviewReasonNotes		N	Any reason to force the order to be reviewed in review que in XTND Backend can be entered here. Requires XTND Backend configuration to be enabled for review que processing.
SalesChannel		N	Freetext data to describe which sales channel the order originates from. For reporting and statistics.
DeliveryLocationId		N	The identity of any servicepoint location connected to the current Delivery method being used

LxirCustomerOrder/Customer(1)

Element	Code	Mand.	Explanation
OperationCode		N	Operational code for customer valid value is 1
Number		N	Customer number
CustomerType	1 (Private) 2 (Business) 4(Unknown) 8 (Reseller)	N	Customer Type (according to valid customer types, see code field). The item is omitted completely if value is missing and default value is to be used.
CustomerGroup		N	Customer group as a customer should belong to
CompanyOrName		Y	Delivery name
LastName		N	Private customers only
InvoiceName		Y	Name of invoice
VATNumber		N	VAT-Nummer
PaymentTermsNumberOfDays		N	Normal number of days (For calculation of due date)
InternalCustomer		N	Internal customer
PalletRegistrationNumber		N	Pallet registration number. Can put attribute in this element to control which system is master: DataMaster = "Internal" atl. "External".

LxirCustomerOrder/Customer/Addresses/Address(n)

Element	Code	Mand.	Explanation
Type	***	Y	Values "Delivery" "Invoice" ("Delivery" mandatory )
DataMaster	***	N	Value ”Internal” ”External”
Address1		Y	Address field 1
Address2		N	Address field 2
Address3		N	Address field 3
PostalCode		Y	Postal code (will be validated)
City		Y	City
State		N	State
CountryCode		Y	Country code (SE=Sverige) (ISO 3166-1)

LxirCustomerOrder/External(0-1)

Element	Code	Mand.	Explanation
ExternalFreeTextData		N	Free text data that could be sent back in order confirmation or despatch advise

LxirCustomerOrder/Payments(0-1)/Payment(n)

Element	Code	Mand.	Explanation
PaymentReference		N	Contains any payment reference to the order being processed
PaymentProvider		N	Payment provider
Amount		N	The amount

LxirCustomerOrder/OrderRows(1)/Row(n)

Element	Code	Mand.	Explanation
OperationCode	Y	OperationCode valid values 1
Position		Y	Position (row number)
SubPosition		J	Sub position (row)
Notes		N	Notes for order row
ProductNumber		Y	Product number
ProductName		N	Produkt name
OrderQuantity		Y	Order Quantity
SalesUnit		Y	Unit for ordering
Price		N	Price per unit
Currency		Y	Currency ID ex. SEK,EUR USD (ISO 4217)
VatPercent		N*	VAT percent
HandlingMark		N	Handling notes
ShippingMark		N	Shipping notes
CustomerProductNumber		N	Customer product number
ExternalFreeTextData		N	Free text data that could be sent back in order confirmation or despatch advise

Example

<?xml version="1.0" encoding="UTF-8"?>

<Header DateTime="2011-12-05T13:43:24" DocumentNumber="25" DocumentVersion="1.0" DocumentName="LxirCustomerOrder"

ToPartnerUser="GBG" ToPartner="GBG" FromPartnerUser="GBG" FromPartner="XOE"/>

<Body>

<FreightFree>false</FreightFree>

<OrderNumberEndCustomer>oendcust</OrderNumberEndCustomer>

<YourReference>YourReference</YourReference>

<OurReference>OurReference</OurReference>

<InvoiceEmail>InvoiceEmail</InvoiceEmail>

<OrderEmail>OrderEmail</OrderEmail>

<OrderPhoneNumber>OrderPhoneNumber</OrderPhoneNumber>

<AdvisePhoneNumber>AdvisePhoneNumber</AdvisePhoneNumber>

<PartialDelivery>false</PartialDelivery>

<TransportCondition>TransportCondition</TransportCondition>

<DeliveryMethod>DeliveryMethod</DeliveryMethod>

<HandlingMark>HandlingMark</HandlingMark>

<ShippingMark>ShippingMark</ShippingMark>

<CustomerGroup>Provision 15%</CustomerGroup>

<CompanyOrName>CompanyOrName</CompanyOrName>

<LastName>LastName</LastName>

<InvoiceName>InvoiceName</InvoiceName>

<VATNumber>VATNumber</VATNumber>

<InternalCustomer>false</InternalCustomer>

</Address>

</Addresses>

</Customer>

</OrderHeader>

<Row>

<ProductNumber>T001Taberg</ProductNumber>

<ProductName>etttvåtre</ProductName>

<CustomerProductNumber>CT001Taberg</CustomerProductNumber>

</Row>

<Row>

<ProductNumber>T002Taberg</ProductNumber>

<ProductName>MyNameIsTwo</ProductName>

</Row>

</OrderRows>

</LxirCustomerOrder>

</Body>

</LxirEnvelope>

Schedule

Document version history

Version	Date	Author/change	Commenct
1.1	2012-05-11	Lasse Sääf	Document created
1.2	2012-11-29	Martin Hagman	Clarified Position, SubPosition. Attached XSD. Better sample data.
1.3	2013-01-22	Martin H/Asta O	Clarifications and corrections of Freight Free, Customer Type and Partial Delivery elements. Clarified default values. Added descriptive text about LxirEnvelope
1.4	2014-02-13	Martin H	Clarified maximum length of product name at row level (80 characters)
1.5	2014-08-26	Martin H	Added optional attribute "DataMaster" on the Customer Address element
1.6	2015-02-13	Martin H	Added PalletRegistrationNumber. The element supports the same type of DataMaster attributes found on the customer segment.
1.7	2015-04-01	Muhammad Jawad	Added CustomerProductNumber
1.8	2015-06-22	Muhammad Jawad	Added the DataMaster for OrderEmail and InvoiceEmail
1.9	2016-03-23	Martin H	Added ExternalFreeTextData, update address information in document footer
2.0	2018-08-16	Martin F	Translated
2.1	2021-03-19	Josefin Kvillert	Changed wording Extend Backend to XTND Backend
2.2	2022-01-26	Martin H	Added ClientSalesChannelId, OrderReviewReasonNotes, SalesChannel, DeliveryLocationId on order header. Added payment segment as well.