The message represents an announcement that an order has been delivered receipt-linked to an order in Smartwork Backend that has come in from an external system. The message is normally created immediately after the order has been received in Smartwork.
Configuration-wise, the message can be set up to be communicated by customer, warehouse or client. That is, some customers may choose to have a reply message but others do not, etc.
XML structure
LxirEnvelope (1)
LxirEnvelope / Header (1)
Element | Code | Mand. | Explanation | Comment |
|---|---|---|---|---|
DateTime | Y | Date and time stamp when the message was created | 2011-12-05T13: 43: 24 | |
DocumentNumber | Y | Document number counter | ||
DocumentVersion | Y | document Version | 1.0 | |
DocumentName | Y | document Name | LxirCustomerOrderResponse | |
ToPartnerUser | Y | The short name [CARD] on the client the message refers to. Code is obtained from the contact person for the integration. | Ex. GBG | |
ToPartner | Y | [SHORT] | Ex. GBG | |
FromPartnerUser | Y | [SHORT] | Ex. GBG | |
FromPartner | Y | Fixed value, short name reading system | XOE |
LxirEnvelope / Body (1)
LxirEnvelope / Body / LxirCustomerOrderDespatchAdvices (1)
LxirEnvelope / Body / LxirCustomerOrderDespatchAdvices / DespatchAdvice (s)
LxirEnvelope / Body / LxirCustomerOrderDespatchAdvices / DespatchAdvice / Header
Element | Code | Mand. | Explanation | Comment |
|---|---|---|---|---|
OrderNumber | Y | Internal order number | ||
OrderDate | Y | External order number | ||
AskedDeliveryDate | Y | Desired delivery date (YYYY-MM-DD tt: mm) (according to incoterms) | ||
CreateDate | Y | Date created orders | ||
Notes | N | listing | ||
Shippingmark | N | Shipping market | ||
OurReference | N | Our reference | ||
YourReference | N | Your reference | ||
DeliveryAdviceToPhone | N | Notice to tel. no. | ||
OrdererPhone | N | The client's number no. | ||
PaymentTermsNoOfDays | N | Payment terms, number of days | ||
CurrencyId | N | Currency ISO | ||
ExternalOrderNumber | Y | External order number | ||
EndCustomerOrderNumber | N | End customer's order number | ||
ShipmentSequenceNumber | N | Sequence order for delivery from warehouse, ie which in the order of partial deliveries of orders is this (1st, 2nd, etc.) | Integer. Works only in case of stock delivery. In the case of direct delivery, no data is obtained here, not even the element itself. | |
ExternalFreeTextData | N | External free text data as possible. was registered when the origin order was loaded into SW Backend. | Max 1600 characters |
CustomerOrderResponse / Customer (1)
Element | Code | Mand. | Explanation | Comment |
|---|---|---|---|---|
CustomerNumber | Y | Customer number | ||
OrganizationNumber | N | Customer's potential. corporate | Blank if value is missing. |
CustomerOrderResponse / Customer / Addresses / Address (s)
Element | Code | Mand. | Explanation | Comment |
|---|---|---|---|---|
Type | Y | Valid values "Delivery" "Invoice" ("Delivery" is mandatory) | XML attribute | |
Address1 | Y | Address field 1 | ||
Address2 | N | Address field 2 | ||
Address3 | N | Address field 3 | ||
PostalCode | Y | Valid postcode | Ex 57132 | |
City | Y | City | ||
State | N | State | ||
CountryCode | Y | Country code (SE = Sweden) (ISO 3166-1) |
CustomerOrderResponse / Transport (1)
Element | Code | Mand. | Explanation | Comment |
|---|---|---|---|---|
ForwarderNumber | Y | Customer number | ||
ForwarderName | Y | Customer's potential. corporate | Blank if value is missing. | |
TransportModeName | Name of mode of transport | |||
TransportModeShortName | The short name of the mode of transport | |||
TransportCondition | transport Conditions | |||
ShipmentNumber | transmission number | |||
| ConsolidatedDelivery | N | True, False | ||
| ConsolidatedDeliveryPercentage | N | if Consolidated delivery then how much included in this shipment |
CustomerOrderResponse / Rows (1) / Row (n)
Element | Code | Mand. | Explanation | comment |
|---|---|---|---|---|
OrderRowStatusId | Y | Orderradstatus | Internal status Lxir | |
Position | Y | Position (row number) | Internal position Lxir | |
SubPosition | Y | Sub-position (row) | Internal subpos Lxir | |
ExternalPosition | Y | Line position in external system so that the order arrived at Lxir | ||
ProductNumber | Y | Item number | ||
ProductName | Y | product Name | ||
Notes | Y | Orderradsnotering | ||
ExpectedDeliveryDate | Y | Expected delivery date at customer (calculated) | ||
Pick Date | Y | Actual picking date, ie the time when the order was received in Smartwork Backend | ||
DeliveredProductUnitQuantity | Y | Delivered quantity in product unit | ||
DeliveredSalesUnitQuantity | Y | Delivered quantity in sales unit | ||
ProductSalesUnit | Y | Sales unit | ||
ProductUnit | Y | product unit | ||
Price | Y | Price per ordered sales unit excluding VAT | Ex. 0.0000 | |
VatPercent | Y | VAT rate, percent | ||
SupplyModeShortName | Stocks LL Direct delivery DL Flow logic FL Service TJ Package KL Flow logic - dist DA Freight FR Discount DI | Content | LL; DL etc | |
IsFinalDelivery | Y | Flag for if the delivery is the last, final on the order | ||
ExternalFreeTextData | External free text data as possible. was registered when the origin order was loaded into SW Backend. | Max 1600 characters |
<? xml version = "1.0" encoding = "UTF-8"?>
< LxirEnvelope xmlns: xsi = " http://www.w3.org/2001/XMLScheme-Instance ">
< Header DocumentNumber = "String" DateTime = "String" ToPartnerUser = "text" FromPartnerUser = "text" DocumentVersion = "String"
ToPartner = "text" FromPartner = "text" DocumentName = "String" />
< Body >
< LxirCustomerOrderDespatchAdvices >
< DespatchAdvice >
< Header >
< OrderNumber > O1-1 </ OrderNumber >
< OrderDate > 2013-03-05 </ OrderDate >
< AskedDeliveryDate > 2013-03-18 </ AskedDeliveryDate >
< CreateDate > 1967-08-13 </ CreateDate >
< Notes > Header note </ Notes >
< ShippingMark > Header shipping mark </ ShippingMark >
< OurReference > our ref </ OurReference >
< YourReference > you ref </ YourReference >
< DeliveryAdviceToPhone > Advice to phone no </ DeliveryAdviceToPhone >
< OrdererPhone > 08-123456789 </ OrdererPhone >
< PaymentTermsNoOfDays > 30 </ PaymentTermsNoOfDays >
< CurrencyId > SEK </ CurrencyId >
< ExternalOrderNumber > Order-1 </ ExternalOrderNumber >
< EndCustomerOrderNumber > MyOrder-1 </ EndCustomerOrderNumber >
< ShipmentSequenceNumber > 1 </ ShipmentSequenceNumber >
< Customer >
< CustomerNumber > 86000 </ CustomerNumber >
< OrganizationNumber > Org1 </ OrganizationNumber >
< Addresses >
< Address Type = "Invoice">
< Address1 > InvAdr1 </ Address1 >
< Address2 > InvAdr2 </ Address2 >
< Address3 > InvAdr3 </ Address3 >
< PostalCode > 55533 </ PostalCode >
< City > Jönköping </ City >
< State > State </ State >
< CountryCode > SE </ CountryCode >
</ Address >
< Address Type = "Delivery">
< Address1 > DelAdr1 </ Address1 >
< Address2 > DelAdr2 </ Address2 >
< Address3 > DelAdr3 </ Address3 >
< PostalCode > 12345 </ PostalCode >
< City > Levstad </ City >
< State > State </ State >
< CountryCode > SE </ CountryCode >
</ Address >
</ Addresses >
</ Customer >
< Transport >
< ForwarderNumber > F1 </ ForwarderNumber >
< ForwarderName > Donor </ ForwarderName >
< TransportModeName > Donor parcel </ TransportModeName >
< TransportModeShortName > SchPo </ TransportModeShortName >
< TransportCondition > con1 </ TransportCondition >
< ShipmentNumber > 5533221122 < ShipmentNumber >
< ConsolidatedDelivery > 1< ConsolidatedDelivery >
< ConsolidatedDeliveryPercentage> 10 < ConsolidatedDeliveryPercentage>
</ Transport >
</ Header >
< Rows >
< Row >
< OrderRowStatusId > 256 </ OrderRowStatusId >
< Position > 10 </ Position >
< SubPosition > 0 </ SubPosition >
< ExternalPosition > 1 </ ExternalPosition >
< ProductNumber > P1 </ ProductNumber >
< ProductName > Product name </ ProductName >
< Notes > Row note1 </ Notes >
< ExpectedDeliveryDate > 2013-05-03 </ ExpectedDeliveryDate >
< Pickdate > 2013-04-28 </ Pickdate >
< DeliveredProductUnitQuantity > 2 </ DeliveredProductUnitQuantity >
< DeliveredSalesUnitQuantity > 1 </ DeliveredSalesUnitQuantity >
< ProductSalesUnit > KRT / ProductSalesUnit >
< ProductUnit > ST < ProductUnit >
< Price > 100.0 </ Price >
< VATPercent > 25.0 </ VATPercent >
< SupplyModeShortName > LL </ SupplyModeShortName >
< IsFinalDelivery > true </ IsFinalDelivery >
</ Row >
< Row >
< OrderRowStatusId > 256 </ OrderRowStatusId >
< Position > 20 </ Position >
< SubPosition > 0 </ SubPosition >
< ExternalPosition > 2 </ ExternalPosition >
< ProductNumber > P2 </ ProductNumber >
< ProductName > Product name </ ProductName >
< Notes > Row note2 </ Notes >
< ExpectedDeliveryDate > 2013-05-01 </ ExpectedDeliveryDate >
< Pickdate > 2013-04-28 </ Pickdate >
< DeliveredProductUnitQuantity > 2 </ DeliveredProductUnitQuantity >
< DeliveredSalesUnitQuantity > 1 </ DeliveredSalesUnitQuantity >
< ProductSalesUnit > KRT / ProductSalesUnit >
< ProductUnit > ST < ProductUnit >
< Price > 120.0 </ Price >
< VATPercent > 25.0 </ VATPercent >
< SupplyModeShortName > LL </ SupplyModeShortName >
< IsFinalDelivery > true </ IsFinalDelivery >
</ Row >
</ Rows >
</ DespatchAdvice >
</ LxirCustomerOrderDespatchAdvices >
</ Body >
</ LxirEnvelope >
Version | Date | Author/change | Commenct |
A | 2016-03-23 | Martin Hagman | Document created |
| B | 2021-02-19 | Muhammad Jawad | Added consolidatedDelivery + percent node |