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 2 Next »

Description

The flow describes a message flow of new customer order messages sent from LXIR to / EWS. Only new customer order messages are sent. Changing and canceling customer orders is not possible.

The answer to a CUSORD sent to the EWS is always a CORRES and it is always seen as a final delivery. If a customer order line cannot be picked for any reason, a CORRES message will nevertheless be sent in response and a change of the customer order line can be made at a later time and when is dependent on the reason for the picking deviation.

If several customer order lines are sent in the same CUSORD then a common reply message is always sent for these lines, CORRES from the EWS. This happens when the pick is ready for all sent lines.

LXIR - EWS only works with balances, not the concept of "be".

No information is sent back today regarding the chosen mode of transport from the EWS.

Simple flow chart

Message triggering

All triggerings are created by event in LXIR

New: Customer order placed against EWS-controlled warehouse for the client. When picking dates are sent, CUSORD is sent to the EWS if the other terms on the customer order are met in LXIR (Crossdocking and part delivery). Transmission may occur depending on the answer. A sold customer order is counted as new.

Change: Not allowed 

Cancellation: Not allowed

Requirements
  • Manual routines are required each time a payment customer of transport is placed in LXIR, which is to be handled by the EWS. (Set up in party table - agreement - customer number, etc.).
  • The article must be made available to the client.
  • Packing for the article must be made available.
  • In the case of delivery methods that require postgironr and bank giro, this is sent in the intended CUSORD-ADR field.
Specifications
LXIROrder, CUSORD

LXIROrder (1)

LXIROrder\Envelope (1)

Element 

Code

Mand

Explanation

Lxir

EWS

Comment
FromPartner
J
From system
XX
FromPartnerUser
J
Users from system / client
XX
ToPartner
J
To system
XX

ToPartnerUser


J
User System / Client
XX
DateTime
N
Time to create the message (YY-MM-DD hh: mm)
XX
ReferensNumber
J
The reference number of the message
XX
InterchangeTest
N
Indicates test message


Deleted


LXIROrder\Header (1-999)

LXIROrder\Header\HeaderInfo (1)

Element 

Code

Mand

Explanation

Lxir

EWS

Comment
DocumentNumber
J

Order number reference number

XX

DocumentName

 CUSORDJ
Order message name: CUSORD
XX

CreationDate


N
Created date
--Part

LXIROrder\Header\Addresses(1-2)

LXIROrder\Header\ Addresses\Address(1)

Element 

Code

Mand

Explanation

Lxir

EWS

Name1
J
Name field 1, customer (Delivery point)
XX

Name2

CUSORDJ

Name field 2, customer

XX

Name3


N
Name field 3, customer
-X
Address1
J
Address field 1 (Delivery point)
XX
Address2
N
Address field 2
XX
Address3
N
Address field 3
XX

State


N
Region / State
XX
City
J
City (Place of Delivery)
XX
PostalCode
J

Postcode (Delivery Point)

XX
Country
J
Country (Place of Delivery)
XX
CountryCode
J
Country code (SE = Sweden) Specifies the language of the documents
X-
Phone
N
Phone in shipto (for notification) Phone in Billto refers to office telephone. Phone in 
Servicepoint refers to the telephone number of the delivery point.
XX
Contact1
N
Customer's shipping address 2 (Name2)
XX
Email
N

Mail address for ship to (notification)

XX

LXIROrder\Header\ Addresses\Information(1)

Element 

Code

Mand

Explanation

Lxir

EWS

Comment
PartyProfile
PIECE
J

Profile (constant) in ship and billto, in service points is this identity for the delivery point.

XX

AddressType


ShipTo
BillTo

Seller

ServicePoint		J
Specifies the type of address
ShipTo = Shipping address,
BillTo = Billing Address
seller =
ServicePoint = Delivery point


X

X

X

X


X

X

X

X

Seller Only supports BankGiroAccount

Postal Giro Account

organization Number

VATNUMBER

LXIROrder\Header\OrderHeader(1)

LXIROrder\Header\OrderHeader\OrderHeaderInfo(1)

Element 

Code

Mand

Explanation

Lxir

EWS

Comment
OrderNumber
J
Internal order number
XX

OrderNumberExternal

CUSORDN

External order number

XX

OrderNumberEndCustomer


N

End customer's order number

XX

EWS=slutkundorderid

OrderDate


J
Order date (YY-MM-DD hh: mm)
XX

SequenceNumber


N

Sequence number, 000

XX

OrderType


N
E
F

W

N
Order Type
N = Normal Order
E = Express Order
F = Replacement Order

W = Webshop Order
XX

OrderReference


N
Reference
XX
Your reference

OrderReference2


N
Our reference
XX
Our reference
ShipToId
N
Customer number
XX
BillToId
N
Bills
X-
DeliveryMethod
N
Mode of delivery
XX
ServicePointId
N
identifier for Servicepoint, ServicePoint
XX

New field 090526

NoOfRows
N
Number of order lines
X-
DeliveryRouteNumber
N
For route planning
XX
WarehouseId
N

Internal stock No.

XX
ForwarderPartyId
N

Customer number with carrier

X-
VatPercent
J

VAT rate in percent

XX
PalletRegistrationNumber
N

pallet Registration

XX

Currency


J

Currency (SEK = Swedish kronor)

XX

FreightCost


N
FREIGHT
--

OrderMethod


N

Order method used when booking

X-

Nytt 2012-05-07.

AllowPartialDelivery


N

Full or partial delivery information

X-

Nytt 2012-05-07

CompanyGroupId


N

Short name Goods owner / group

XX

Nytt 2013-05-17

ConsolidateDelivery


N

Identity of orders to be collected

XX

Nytt 2014-06-04

DepartureId


N

Retirement / Depa identity

XX

Nytt 2015-05-11

RouteId
N

route number

XX

Nytt 2015-05-11

CodFee
N

Withdrawal fee / Postal deposit etc.

-X
DispatchFee
N

SERVICE FEE

-X
AmountTotal
N

Total sum

XX
VatAmountTotal
N

Tax Total Total

-X
OwnerId
N

Identity of resellers in the EWS

-X

Identitet för återförsäljare

InvoiceDate
N

invoice Date

XX
InvoiceNumber
N

invoice number

XX
DueDate
N

Due date for Invoice

XX
PaymentTerms
N

Payment terms clear

XX
PaymentType
N

Payment method short name

INV = Invoice

INV-P = Invoice

CCA = Credit Card American Express

CCV = Credit card Visa

CC = Credit card

COD = COD

XX
AskedDeliveryDate
NAsked delivery dateX
Ongoing specific field

LXIROrder\Header\OrderHeader\OrderHeaderDescriptions(0-99)

Element 

Code

Mand

Explanation

Lxir

EWS

Comment

Function


J

Code for the description

XX

Description1


J

Description field 1

XX

Description2


N

Description field 2

XX
Description3
N

Description field 3

XX

LXIROrder\Header\OrderHeader\OrderRow(1-99999)

LXIROrder\Header\OrderHeader\OrderRow\OrderRowInfo(1)

Element 

Code

Mand

Explanation

Lxir

EWS

Comment

OrderPosition


J

Order line position

XX

OrderSubPosition


J

Order line subposition

XX

OrderRowType

N

1

11

V

J

Order line type

N = Normal

1 = Postage / Shipping

11 = Credits' –Price should be negative

V = Value added service


X

X



X

X

X

X

X

X


OwnerNumber
N

Article owner

XX
ArticleId
J

Article

XX
SupplierArticleID
?

Supplier's product number

XX
PackageId


ST

J

Unit 
ST = Piece

XX

SalesPackageID


J

Sales unit

XX

OrderQuantity


J

Ordered quantity

XX

SalesOrderQuantity


J

Sold quantity

XX

Price


J

Price, 00000000.0000

XX

SalesPrice


J

Selling price

XX

VatPercent


J

VAT rate in percent 00,000

XX

Currency


J

Currency

X-

ShipDate


N

Shipping Date

X-

ExpectedDeliveryDate


N*

Expected delivery date

XX

OrderRowStatusCode


1

2

J

Order Line Status 
1 = Incoming 
2 = Reserved

XX

"1" refers to listed lines and is used together with "Expecteddelivery"

ArticleName


N

Article Name

XX

Intrastat




--

Should be replaced by CustomsCommodityCode

CustomsCommodityCode




-X

VisibilityType


N

values

AlwaysVisible

nonpublic

XX

Used only for

OrderRowType = ”V” Value added service


* If none is specified AlwaysVisible is used


* When orderrowstatuscode = '1' is specified, this is used to present a scheduled delivery date on delivery note to recipient.

LXIROrder \ header \ OrderHeader \ OrderRow \ OrderRowAdditions (0-1)

Element 

Code

Mand

Explanation

Lxir

EWS

Comment

OperationCode


N

Order Line Status 
1 = New Row


X

LXIROrder\Header\OrderHeader\OrderRow\OrderRowDescriptions(0-99)

Element 

Code

Mand

Explanation

Lxir

EWS

Comment

Function


J

Code for the description

 XX
Description1
J

Description field 1

XX
Description2
N

Description field 2

XX
Description3
N

Description field 3

XX
Description4
N

Description field 4

XX
Free Text Field MAIN

Free texts that are current are DEL, MKS, TRA, HAN, FREETEXT and TEXT 1 - 5. If free text is longer than 70 characters, the free text is cut (truncated).

Function

Explanation

Lxir

EWS

Comment

DEL

Intended for, Delivery instructions, Free text field "Notes on order headers" in LXIR (Delivery instructions in EWS)

XX
MKS

Merchandising, Free text field "Marking on order head" in LXIR

XX
TRA

Live instruction, Selected / selected options on additional services are sent in plain text, in Description1 "thermo" and coded in Description2 as "HOT".

XX
HAN

Action ground from order head

XX
FREETEXT

Free text

-X
TEXT1

Free text 1 for client

-X
TEXT2

Free text 2 for client

-X
TEXT3

Free text 3 for client

-X
TEXT4

Free text 4 for client

-X
TEXT5

Free text 5 for client

-X
OCR

OCR number

XX
DELIVERYTERMS

Delivery terms Combiterms Description1ska contain the numerical code according to incoterms 2000

-X

EMCS-SND

Description1 the sender's EMCS identity

XX

EMCS-REC

Description1 the recipient's EMCS identity

XX

EMCS-ARC

Description1 contain ARC numbers

XX
Free Text Field Row

Free texts that are current are MKS, TRA and HAN. If free text is longer than 70 characters, the free text is cut off (truncated).


A free text is sent per element, OrderRowDescriptions on. Thus, there can be several free text fields one after the other. Only Description1 is used, ie 70 characters are max in a free text.

(The five FTX_1 to the FTX_5 rows contained in the EWS message specification are seen as a long field where "#" is used as row separator between them and must be at position 70.)

Function

Explanation

Lxir

EWS

Comment

MKS

Branding (shipping market in EWS and LXIR)

XX
TRA

Live instruction, Selected / selected options on additional services are sent in plain text, in Description1 "thermo" and coded in

X-
HAN

Action ground from order line

XX
SERSerial number-X
BATBatch number-X
LXIROrderResult, CORRES

LXIROrderResult (1)

Envelope (1) LXIROrderResult

Element       

Code

Mand

Explanation

Lxir

EWS

Comment

FromPartner
JFrom systemXX
FromPartnerUser
JUsers from system / clientXX
ToPartner
JTo systemXX

ToPartnerUser


JUser System / ClientXX
DateTime
N

Time to create the message (YY-MM-DD hh: mm)

XX
ReferensNumber
J

The reference number of the message

XX
InterchangeTest
N

Indicates test message

 - -deleted

Header (1-999)

Header (1) LXIROrderResult

Element       

Code

Mand

Explanation

Lxir

EWS

Comment

CreationDate
J

Time when the message was created (YY-MM-DD hh: mm)

XX

DocumentNumber


J

Order number reference number

XX
DocumentName CUSORDJ

Order Announcement Name: CORRES

XX

LXIROrderResult \ header \ Order Head (1)

Element       

Code

Mand

Explanation

Lxir

EWS

Comment

OrderNumber
J

Internal order number

XX

SequenceNumber


J

sequence number

XX

LXIROrderResult \ header \ Shipment (0-1)

Element       

Code

Mand

Explanation

Lxir

EWS

Comment

ShipmentNumber
J

Shipping number

XX
ConsolidatedDelivery

False True

N

Delivered with previous orders

XX

Y / N

ShipmentOwner
N
XX
TransportWeight
J

Shipping weight

XX
TransportVolume
J

The volume of the broadcast

XX
TransportCost
J

The value of the consignment

XX

EWS Always sends 0

PackageNumber
J

Package number, semicolon separated

XX
PackageNumberOf
J

Number of packages

XX
PalletNumberOf
J

Number of pallets EUR

XX
PalletNumberOf2
J

Number of B-pallets

XX
PalletNumberOf3
N

Number of half pallets

XX
PalletNumberOf4
N

Number of SRS pallet

XX
DeliveryMethod
J

Delivery method and additional services (see note)

XX

LXIROrderResult \ header \ OrderRows (1-99999)

Element       

Code

Mand

Explanation

Lxir

EWS

Comment

OrderPosition
J

Order line position

XX
OrderSubPosition


J

Order line subposition

XX
OwnerNumber
J

Item owner, client number

XX
ArticleNumber
J

Article

XX
PickedQuantity
J

Picked quantity

XX
DiscrepancyQuantity
J

Remaining (deviating) quantity

XX


DiscrepancyCode


N 
S 
A 
U

N

Pick-up code: 
N = balance exists, cannot be picked (temporary pick-up obstruction) 
S = end of stock 
A = agreed over-delivery 
U = agreed sub-delivery

XX
SerialNumber
N

Serial number?

XX
BatchNumber
N

BatchNumber

XX
ConsNote

parcel number

XX

Same as Packagenumber on OrderHead

DiscrepancyCode N

Balance available cannot be picked (temporary picking obstacle). Customer order line is sent from LXIR next picking day until picking has taken place. Otherwise, the same information is sent as the original. EWS handles this as a new order. Now the same message as the original order is sent again but now with the following information in the element LXIROrder \ t

Element       

Explanation

Lxir

EWS

Comment

\ Header \ OrderHeader


X

\ OrderHeaderInfo \ OrderNumber

Same as the original order

X

\ OrderHeaderInfo \ SequenceNumber

Listed one step for each time OrderNumber is sent to the EWS

X

The current line that received the code "N":


X

\ OrderRow \ OrderRowInfo \ ShipDate

Next day for a new try

X

\ OrderRow \ OrderRowInfo \ OrderQuantity

Remaining number

X

In LxiR, the order lines will remain reserved. An N-receipt does not release the reservation. This means that for an N-acknowledgment, one will go towards the same transmission. If in one and the same message two lines are acknowledged normally and one with N then these lines will still be on the same transmission. The two normal rows will be sent away when the remaining row is acknowledged for eg External system.


N-receipt is thus a temporary code that should only be used during the same day.



DiscrepancyCode S

Out of stock. Receipt with 0 (zero) in the field OrderRows PickedQuantity can be sent to LXIR, but it is often the case that a part is delivered. Automatically leads to inventory in the EWS. Wait for an ITECHG message with inventory code ST on the article. Recalculation takes place on a confirmed date thereafter. In LxiR, what is not delivered will be reserved and moved one day.


Code S should not normally occur. It should be noted that in LXIR one can choose that partial delivery is not allowed and this can then lead to a partial delivery despite the choice.


DiscrepancyCode A

Agreed over delivery ie an agreement with the customer. If the number picked exceeds the ordered number, a new row with a new subposition and status must be created on the part that is handed over.

DiscrepancyCode U

Agreed subcontracting ie an agreement with the customer. OrderRows PickedQuantity + OrderRows DiscrepancyQuantity = ordered quantity.

If this is not correct, it should be logged

If this is true. If nothing has been picked up, the entire line should be set to cancel and the reservation of stored units released. In other cases, the number picked to be picked is set. The rest is added to a new row with new subposition and status canceled, then the units are released.

ConsNote

Here comes the shipping number in some cases and it depends on the delivery method and settings in the EWS. If a shipping number is created per order, it can be sent but not if it is the same shipping number for several different orders. 

Examples
LXIR Order

<?xml version=”1.0” encoding=”utf-8” ?>

- <LXIROrder>

  <Envelope FromPartner=”XOE” FromPartnerUser=”NOB” ToPartner=”EWS” ToPartnerUser=”NOB” DateTime=”2010-03-31 06:04” ReferensNumber=”345” />

- <Header>

  <HeaderInfo DocumentNumber=”001345” DocumentName=”CUSORD” />

- <Addresses>

  <Address Name1=”Nalle” Name2=”” Address1=”nallevej 2” Address2=”” Address3=”” City=”Nallesta” PostalCode=”1789” Country=”NORWAY” CountryCode=”NO” Phone=”0706959734” Contact1=”” Email=”” />

  <Information PartyProfile=”STYCKE” AddressType=”ShipTo” />

  </Addresses>

- <Addresses>

  <Address Name1=”Nalle” Address1=”nallevej 2” Address2=”” Address3=”” City=”Nallesta” PostalCode=”1789” Country=”NORWAY” CountryCode=”NO” Phone=”” />

  <Information PartyProfile=”STYCKE” AddressType=”BillTo” />

  </Addresses>

- <Addresses>

  <Address Name1=”DFDS Seaways” Address1=”Svinesundsvejen 336” Address2=”” Address3=”” City=”Halden” PostalCode=”1789” Country=”NORWAY” CountryCode=”NO” Phone=”” BankGiroAccount=”” PostGiroAccount=”” OrganisationNumber=”111111-1111” VatNumber=”-“ />

  <Information PartyProfile=”STYCKE” AddressType=”Seller” />

  </Addresses>

- <OrderHeader>

  <OrderHeaderInfo OrderNumber=”OC-299” OrderNumberExternal=”NOB-67” OrderNumberEndCustomer=”” OrderDate=”2010-03-30 15:25” SequenceNumber=”1” OrderType=”N” OrderReference=”Nalle Nallesson” OrderReference2=”” ShipToId=”60” BillToId=”NOB” ServicePointId=”” DeliveryMethod=”BRIABREV” NoOfRows=”2” DeliveryRouteNumber=”60” WarehouseId=”HHV” ForwarderPartyId=”NOB” VatPercent=”25.000” PalletRegistrationNumber=”” Currency=”NOK”

InvoiceDate=”3/31/2010 6:04:31 AM” InvoiceNumber=”282” DueDate=”4/14/2010 12:00:00 AM” PaymentTerms=”14” PaymentType=”CC” AmountTotal=”450.000” CompanyGroupId=”GRP01”  />

  <OrderHeaderDescriptions Function=”OCR” Description1=”” />

  <OrderHeaderDescriptions Function=”DEL” Description1=”” />

  <OrderHeaderDescriptions Function=”MKS” Description1=”” />

  <OrderHeaderDescriptions Function=”HAN” Description1=”” />

- <OrderRow>

  <OrderRowInfo OrderPosition=”10” OrderSubPosition=”0” OrderRowType=”N” OwnerNumber=”NOB” ArticleId=”12009” SupplierArticleId=”12009” PackageId=”ST” SalesPackageId=”ST” OrderQuantity=”1” SalesOrderQuantity=”1” Price=”450.0000” SalesPrice=”450.0000” VatPercent=”00.000” Currency=”NOK”

ShipDate=”2010-03-31 08:00” ExpectedDeliveryDate=”2010-04-07 08:00” OrderRowStatusCode=”2” ArticleName=”200 kr. Hamsun 2009” />

  <OrderRowDescriptions Function=”MKS” Description1=”” />

  <OrderRowDescriptions Function=”HAN” Description1=”” />

  </OrderRow>

- <OrderRow>

  <OrderRowInfo OrderPosition=”20” OrderSubPosition=”0” OrderRowType=”1” OwnerNumber=”NOB” ArticleId=”FRAKT” SupplierArticleId=”” PackageId=”ST” SalesPackageId=”ST” OrderQuantity=”1” SalesOrderQuantity=”1” Price=”00.0000” SalesPrice=”00.0000” VatPercent=”25.000” Currency=”NOK”

ShipDate=”2010-03-31 08:00” ExpectedDeliveryDate=”2010-04-07 08:00” OrderRowStatusCode=”2” ArticleName=”Frakt – Brev A-prioritet” />

  <OrderRowDescriptions Function=”MKS” Description1=”” />

  <OrderRowDescriptions Function=”HAN” Description1=”” />

  </OrderRow>

  </OrderHeader>

  </Header>

  </LXIROrder>

LxirOrderResult

<?xml version=”1.0” encoding=”ISO-8859-1” ?>

- <LXIROrderResult>

  <Envelope FromPartner=”EWS” FromPartnerUser=”NOB” ToPartner=”XOE” ToPartnerUser=”NOB” DateTime=”2010-03-11 15:37” ReferensNumber=”0010085702” InterchangeTest=”” />

- <Header>

  <Hinfo CreationDate=”2010-03-11 15:37” DocumentNumber=”0010085702” DocumentName=”CORRES” />

- <OrderHeader>

  <OrderHead OrderNumber=”OC-281” SequenceNumber=”001” />

  <Shipment ShipmentNumber=”107” ShipmentOwnerId=”NOB” ConsolidatedDelivery=”True” TransportWeight=”82” TransportVolume=”0” TransportCost=”0” PackageNumber=”108” PackageNumberOf=”1” PalletNumberOf=”0” PalletNumberOf2=”0” PalletNumberOf3=”0” PalletNumberOf4=”0” DeliveryMethod=”BRIABREV” />

  <OrderRows OrderPosition=”10” OrderSubPosition=”0” OwnerNumber="574" ArticleNumber="12009" PickedQuantity="1" DiscrepancyQuantity="0"

DiscrepancyCode="" SerialNumber="" BatchNumber="" ConsNote="108" />

  </OrderHeader>

  </Header>

  </LXIROrderResult>

Document version history

Version.

Date

Author/change

Comment

A

2003-02-17

Joakim Petersson

Move the document to LXIR with new document no.

PA1

2003-08-26

Tanja Brkic

Added documentation for Residual code A and U.

B

2004-02-12

Erik Sylvan

Changed the document to describe the flow between LXR and LWS / EWS, added example messages.

PB1

2004-02-24

Joakim Petersson

Clarified what happens in LxiR at the different codes.

C

2005-09-22

Lasse Sääf

Added Delivery Terms

PD

2008-03-18

Björn Johansson

Adjusted from LXIR3 & EWS

D

2008-03-31

Martin Fransson

Accepted

E

2008-04-14

Lasse Sääf

Corrected explanatory text for free text field row

E1

2008-05-05

Lasse Sääf

Set ReferenceNumber to Mandatory

F

2008-08-26

Patrick Gebhard

Supplemented with support for some fields in LWS

G

2009-03-05

Mathias Niebel

Complemented PaymentType for cash on delivery.

hrs

2009-04-29

Björn Johansson

Complement with INV-P in payment type

IN

2009-04-27

Martin Hagman

Supplemented with ServicePoint as type in address info

J

2009-05-26

Martin Hagman

Completed with LocationId in OrderHeaderInfo

PJ1

2009-05-27

David Frendin

Changed LocationId to ServicePointId in OrderHeaderInfo

PJ2

2009-06-16

Björn Johansson

Adjusted Order / Header addresses regarding telephone, mail and contact, supplemented party profile with delivery point.

K

2009-09-17

Björn Johansson

Adjusted support for address type vendor from Lxir, amounttotal & OCR.

L

2010-04-19

Björn Johansson

Added Order Type W, PalletNumberof2, DeliveryRouteNumber. + new examples.

M

2010-09-10

Björn Johansson

Deleted data related to LWS, published on sharepoint

N

2011-06-28

Lasse Sääf

Correct spelling for Duedate to DueDate

O

2012-05-07

Björn Johansson

Added Order Method and AllowPartialDelivery

O

2012-05-21

Björn Johansson

Supplementary text to orderrowstatuscode.

P

2012-05-17

Lasse Sääf

Added CompanyGroupId

Q

2014-06-04

Lasse Sääf

Added BatchNumber and ConsolidateDelivery

R

2015-05-11

Martin Fransson

Added DepartureId and RouteId

S

2015-08-26

Lasse Sääf

Added ConsolidatedDelivery ShipmentOwnerId Pallet NumbersOf3, Pallet NumbersOf3

T

2016-01-18

Lasse Sääf

Added VisibilityType and Value added service

U

2017-05-24

Lasse Sääf

Added State

  • No labels