Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 43 Next »

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.

OrderSource
NOrder source

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
NThis 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
NAny 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
NFreetext data to describe which sales channel the order originates from. For reporting and statistics.
DeliveryLocationId
NThe 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
YAddress field 1
Address2
NAddress field 2
Address3
NAddress field 3
PostalCode
YPostal code  (will be validated)
City
YCity
State
NState
CountryCode
YCountry 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
NPayment provider
Amount
NThe amount


LxirCustomerOrder/OrderRows(1)/Row(n)


Element             

Code

Mand.

Explanation

OperationCode

Y

OperationCode valid values 1

Position
YPosition (row number)
SubPosition
JSub position (row)
Notes
NNotes for order row
ProductNumber
YProduct number
ProductName
NProdukt name
OrderQuantity
YOrder Quantity
SalesUnit
YUnit for ordering
Price
NPrice per unit
Currency
YCurrency ID ex. SEK,EUR USD (ISO 4217)
VatPercent
N*VAT percent. It is possible to put attribute in this element to control which system is master: DataMaster = "Internal" alt. "External". This attribute is optional. If not set, default is "External", meaning VATPercent will be processed from XML data. If set to Internal, the XML element content will be skipped and order process will try fetch VAT from the Extend pricelist (min price) for the customer.
HandlingMark
NHandling notes
ShippingMark
NShipping notes
CustomerProductNumber
NCustomer product number
WarehouseIdentifier
NWarehouse short name
ExplicitCost
NDefined cost of the product. decimal
ExplicitCostCurrency
NCurrency code e.g. SEK, EUR USD (ISO 4217)
GTIN
NBarcode


LxirCustomerOrder/OrderRows(1)/Row(n)

LxirCustomerOrder/OrderRows(1)/Row/External

Element             

Code

Mand.

Explanation

ExternalFreeTextData


N

Free text data that could be sent back in order confirmation or despatch advise

Example

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

<LxirEnvelope>

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

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

  <Body>

    <LxirCustomerOrder>

      <OrderHeader>

        <OperationCode>1</OperationCode>

        <Number>12371</Number>

        <OrderDate>2010-01-01T00:10:10.00000</OrderDate>

        <AskedDeliveryDate>2010-01-01</AskedDeliveryDate>

        <Notes>not</Notes>

        <OrderType>1</OrderType>

        <PaymentType>INV</PaymentType>

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

        <Customer>

          <OperationCode>1</OperationCode>

          <Number/>

          <CustomerType>1</CustomerType>

          <CustomerGroup>Provision 15%</CustomerGroup>

          <CompanyOrName>CompanyOrName</CompanyOrName>

          <LastName>LastName</LastName>

          <InvoiceName>InvoiceName</InvoiceName>

          <VATNumber>VATNumber</VATNumber>

          <PaymentTermsNumberOfDays>10</PaymentTermsNumberOfDays>

          <InternalCustomer>false</InternalCustomer>

          <Addresses>

            <Address Type="Delivery" DataMaster="Internal">

              <Address1>rad1</Address1>

              <Address2>rad2</Address2>

              <Address3>rad3</Address3>

              <PostalCode>57174</PostalCode>

              <City>rad5</City>

              <State/>

              <CountryCode>SE</CountryCode>

            </Address>

          </Addresses>

        </Customer>

<External>

    <ExternalFreeTextData>X-23</ExternalFreeTextData>

<External/>

      </OrderHeader>

      <OrderRows>

        <Row>

          <OperationCode>1</OperationCode>

          <Position/>

          <SubPosition/>

          <Notes/>

          <ProductNumber>T001Taberg</ProductNumber>

          <ProductName>etttvåtre</ProductName>

          <OrderQuantity>25</OrderQuantity>

          <SalesUnit>st</SalesUnit>

          <Price>1.2</Price>

          <Currency>SEK</Currency>

          <VatPercent/>

          <HandlingMark/>

          <ShippingMark/>

           <CustomerProductNumber>CT001Taberg</CustomerProductNumber>

        </Row>

        <Row>

          <OperationCode>1</OperationCode>

          <Position/>

          <SubPosition/>

          <Notes/>

          <ProductNumber>T002Taberg</ProductNumber>

          <ProductName>MyNameIsTwo</ProductName>

          <OrderQuantity>25</OrderQuantity>

          <SalesUnit>st</SalesUnit>

          <Price>2.2</Price>

          <Currency>SEK</Currency>

          <VatPercent/>

          <HandlingMark/>

          <ShippingMark/>

   <External>

    <ExternalFreeTextData>X-23</ExternalFreeTextData>

  <External/>

        </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.22012-11-29Martin Hagman
Clarified Position, SubPosition. Attached XSD. Better sample data.
1.32013-01-22Martin H/Asta OClarifications and corrections of Freight Free, Customer Type and Partial Delivery elements. Clarified default values. Added descriptive text about LxirEnvelope
1.42014-02-13Martin H
Clarified maximum length of product name at row level (80 characters)
1.52014-08-26Martin HAdded optional attribute "DataMaster" on the Customer Address element
1.62015-02-13Martin HAdded PalletRegistrationNumber. The element supports the same type of DataMaster attributes found on the customer segment.
1.72015-04-01

Muhammad Jawad

 Added CustomerProductNumber
1.82015-06-22

Muhammad Jawad

 Added the DataMaster for OrderEmail and InvoiceEmail
1.92016-03-23Martin HAdded ExternalFreeTextData, update address information in document footer
2.02018-08-16Martin FTranslated
2.12021-03-19Josefin KvillertChanged wording Extend Backend to XTND Backend
2.22022-01-26Martin HAdded ClientSalesChannelId, OrderReviewReasonNotes, SalesChannel, DeliveryLocationId on order header. Added payment segment as well.
2.32022-02-05Zohaib AneesAdded OrderReviewReasonNotes, SalesChannel, DeliveryLocationId in OrderHeader and added updated xsds
2.42022-04-29Martin HAdded DataMaster attribute to VatPercent element










  • No labels