04 - XML OrderResponse
04 - XML OrderResponse
Order Response
Version 2010
Generated by GEFEG.FX
order_response_A2
XML - INDUSTRIAL SOLUTION
Guideline Structure
order_response_A2
1 .. 1 xsd:sequence
1 .. 1 DocumentID
0 .. 1 Variant
1 .. 1 xsd:sequence
0 .. 1 EarliestDeliveryDate
0 .. 1 TransportPriority
0 .. 1 Campaign
0 .. 1 DeliveryRemarks
1 .. 1 ErrorHead
1 .. 1 xsd:sequence
1 .. 1 ErrorCode
0 .. 1 BlanketOrderReference
1 .. 1 xsd:sequence
1 .. 1 DocumentID
1 .. 1 CustomerReference
1 .. 1 xsd:sequence
1 .. 1 DocumentID
1 .. 1 BuyerParty
1 .. 1 xsd:sequence
1 .. 1 PartyID
1 .. 1 AgencyCode
0 .. 1 OrderingParty
1 .. 1 xsd:sequence
1 .. 1 PartyID
1 .. 1 AgencyCode
0 .. 1 Consignee
1 .. 1 xsd:sequence
1 .. 1 PartyID
1 .. 1 AgencyCode
0 .. 1 PaymentTerms
1 .. 1 xsd:sequence
1 .. 1 PaymentMethod
1 .. unbounded OrderLine
1 .. 1 xsd:sequence
1 .. 1 LineID
0 .. 1 SuppliersOrderLineID
0 .. 1 AdditionalCustomerReferenceNumber
1 .. 1 xsd:sequence
1 .. 1 DocumentID
1 .. 1 OrderedArticle
1 .. 1 xsd:sequence
1 .. 1 ArticleIdentification
1 .. 1 xsd:sequence
0 .. 1 BuyersArticleID
0 .. 1 ManufacturersArticleID
0 .. 1 EANUCCArticleID
1 .. 1 ArticleDescription
1 .. 1 xsd:sequence
1 .. 1 ArticleDescriptionText
1 .. 1 xsd:sequence
0 .. 1 RequestedDeliveryDate
0 .. 1 ArticleComment
1 .. 1 OrderReference
1 .. 1 xsd:sequence
1 .. 1 DocumentID
1 .. 1 Error
1 .. 1 xsd:sequence
1 .. 1 ErrorCode
0 .. 1 ErrorText
1 .. unbounded ScheduleDetails
1 .. 1 xsd:sequence
1 .. 1 DeliveryDate
1 .. 1 ConfirmedQuantity
1 .. 1 xsd:sequence
1 .. 1 QuantityValue
1 .. 1 OrderedQuantity
1 .. 1 xsd:sequence
1 .. 1 QuantityValue
order_response_A2 Name Root element tag Identification numbers and text: The allowed characters are
Descr. The tag of the root element indicates the document type and a [a-z, A-Z,0-9 and the underscore '_']. The terms
suffix 'Mandatory', 'must be used', 'has to be used' and any min
Remark The root element tag of this order response is always occurence greater than '0' mean that an XML element must
"order_response_A2". be sent with a value in it .
xsd:sequence Occurrence 1 .. 1
DocumentID Occurrence 1 .. 1
Length .. 17
Name Message version
Descr. Identification of Message version
Remark In some cases the status of this element is optional, and so
not used by some users. In order to guarantee a compatibility
of all business partners in the future these few applications will
be updated step by step.
This field should only contain should contain ‘A2’ as fix value.
Variant Occurrence 0 .. 1
Length 1
Name Variant number
Descr. Variant of the message.
Remark The variant of this release is “5”. The EDIWheel website will
provide further information about the currently available
variants.
xsd:sequence Occurrence 1 .. 1
EarliestDeliveryDate Occurrence 0 .. 1
Length .. 10
Pattern \d{4}-\d{2}-\d{2}
Name Earliest delivery date
Descr. Earliest delivery date at the place of delivery.
Remark This header information provides optimization in the logistic.
TransportPriority Occurrence 0 .. 1 Rush:If the customer wants to receive delivery faster than
Length .. 4 the agreed regular terms, then he can use this element to
Name Transport priority inform the supplier that the order must be treated differently
Remark In order to express that the order is a normal order the from the usual case. As mentioned before, the delivery
element must not be used. terms are agreed as a default at the supplier/customer level
The customer can inform the supplier how this order should so they can be specified differently on a case by case basis.
be handled. If the element is not used it means the order will The rush order simply means that the goods ordered in this
be handled by the supplier under the default way and the order should be delivered faster as usual.
goods will be delivered within the default delivery scheme or
according to the RequestDeliveryDates provided at line level. Replenishment:It means that the customer either sends an
The default delivery schemes are supplier/customer/country order for which he does not expect an exact timing or
specific and therefore not specified in this documentation. sends an ordrer for which the supplier will compute the
Before starting any integration, the customer and the supplier contractual RequestedDeliveryDate. It should be used only
must agree on what is the normal delivery term. on bilateral agreement between the customer and the
supplier. Note some suppliers in some countries will confirm
the dates for such kind of order so the rule should be if date
is confirmed, than it means the supplier will deliver on those
dates, if the date is 99991231, than no exact date is
confirmed in the order confirmation message and it means
as well that the suppliers customer service will contact the
customer to agree on delivery dates and quantities.There
are no general rules about the volume or about the way the
supplier is processing this replenishment orders.
Applicable Codes
the suppliers customer service will always contact the dealer
to agree exactly what and when will be delivered.
Campaign Occurrence 0 .. 1 This information is mainly used in the order / order
Length .. 12 confirmation message and is optional. Not supported by all
Name Campaign suppliers.
Descr. Identification of a Campaign/ a Promotion.
This element is used to identify if the order is related to a
sales campaign/promotion. The content of the element
should be the campaign number given by the supplier.
Applicable Codes
905 No items in message
906 Customer reference number already used - (valid only for
orders where the reference MUST be unique)
907 Invalid consignee (ship-to) party ID number
908 No authority to select consignee (ship-to)
909 The mandatory customer reference number is missing in the
order
910 Internal error in ad hoc system
912 Requested delivery date invalid
913 Invalid consignee (ship-to) party ID number
914 Missing buyer (sold-to) identification number
915 Buyer (sold-to) party ID number invalid
916 Adhoc version number incorrect (document ID or variant)
917 Incorrect ad hoc message type
918 No authority to specify earliest requested (header level) or
requested (item level) delivery date
919 No authority for brand/sales organisation
920 Account not activated for this buyer (sold-to) party ID number
921 Access permission password is expired
922 Incorrect/invalid blanket order (contract) number
924 Incorrect buyer (sold-to) agency code qualifier
925 Incorrect consignee (ship-to) agency code qualifier
926 Missing mapping for the customer assigned buyer (sold-to)
party ID
927 Missing mapping for the customer assigned consignee (ship-
to) party ID
929 Incorrect promotion (campaign) code (wrong value)
930 Incorrect payment method code
932 Buyer (sold-to) definition error in supplier system (sales area,
deletion indicator etc.)
934 Customer not allowed to create backorders
935 Order can not be created, at least one line is in error
936 Wrong buyer - consignee combination (sold-to/ship-to
combination)
937 Consignee (ship-to) definition error in supplier system (sales
area, deletion indicator etc.)
938 All items in error, no sales order created
939 Wrong or not allowed order type (transport priority)
Applicable Codes
943 Error in ERP system during creation of sales order
944 Promotion (campaign) code validity period expired
946 Ad hoc version number missing
950 No authority to use this message type
999 Miscellaneous
BlanketOrderReference Occurrence 0 .. 1 This value is used only in the order message. Not supported
Name Blanket order reference information by all suppliers.
Remark Equivalent EDIFACT code is BO
xsd:sequence Occurrence 1 .. 1
DocumentID Occurrence 1 .. 1
Length .. 35
Name Reference to contract number
Descr. Reference to the contract referring to the present order.
CustomerReference Occurrence 1 .. 1
Name Customer reference information
xsd:sequence Occurrence 1 .. 1
DocumentID Occurrence 1 .. 1 Only used in the order message. If a customer reference is
Length .. 35 sent within an inquiry the supplier will simply ignore it and
return as received.
BuyerParty Occurrence 1 .. 1
Remark Contracting party, e.g. party who is doing / establishing the
sales contract by a legal way. In other words it's the entity
who's doing the business contract with the supplier and who
takes the legal responsibility. Depending on the customers
organisation it could be a central purchasing department
(headquarter) or a main dealer.
xsd:sequence Occurrence 1 .. 1
PartyID Occurrence 1 .. 1 By the party ID, called buyer party, is considered the
Length .. 17 number which identifies the purchasing party. In other
Name Buyer ID words, who is demanding goods. Depending on the
Descr. Identification number of a buyer. customer organisation, it might be the same as the ship-to
(consignee) or the same as the invoice payer.
AgencyCode Occurrence 1 .. 1
Descr. Code identifying the agency responsible for a code list.
Length .. 3
Name Type of the buyer's identification number.
Applicable Codes
9 EAN (International Article Numbering association)
91 Assigned by seller or seller's agent
92 Assigned by buyer or buyer's agent
OrderingParty Occurrence 0 .. 1
Remark The initial ordering / stipulating party is the partner who is
placing/creating the purchase order in the customer system.
This element has to be used when the ordering party is
different from the buyer (example shop versus head office).
Note: This level is not supported by all manufactureers.
xsd:sequence Occurrence 1 .. 1
PartyID Occurrence 1 .. 1
Length .. 17
Name Ordering Party ID
AgencyCode Occurrence 1 .. 1
Descr. Code identifying the agency responsible for a code list.
Length .. 3
Name Type of the ordering party's identification number.
Applicable Codes
9 EAN (International Article Numbering association)
91 Assigned by seller or seller's agent
92 Assigned by buyer or buyer's agent
Consignee Occurrence 0 .. 1 This code is used to identify the address where the goods
Remark The delivery address in the header is valid for all items. are to be sent. For the supplier this address is where the
Indicating a consignee [ship-to] on the item level, which differs goods will be shipped (ship-to address).
from the consignee specified on the header level, is not The customer has to agree upfront with the supplier which
possible. are the concerned ship-to addresses for a given sold-to.
If the delivery address is not identical with the buyer address,
a consignee has to be sent. Exception: if a note in the
supplier's system indicates that the goods have always to be
delivered to another recorded address, then it is not necessary
to send a separate consignee.
xsd:sequence Occurrence 1 .. 1
PartyID Occurrence 1 .. 1
Length .. 17
Name Identification consignee/delivery address
AgencyCode Occurrence 1 .. 1 Condition: If AgencyCode is used then PartyID must be
Descr. Code identifying the agency responsible for a code list. used and vice versa.
Length .. 3
Name Type of the consignee's identification number.
Applicable Codes
9 EAN (International Article Numbering association)
91 Assigned by seller or seller's agent
92 Assigned by buyer or buyer's agent
PaymentTerms Occurrence 0 .. 1
Name Payment terms information
xsd:sequence Occurrence 1 .. 1
PaymentMethod Occurrence 1 .. 1 This functionality is not supported by all suppliers.
Length .. 10 In some European market’s, the customer might get a
Name Payment method different discount depending on the payment method. For
Descr. Identification of the method of payment. example paying cash at delivery, he could have a 2% extra
Remark In order to express that the normal payment method (by discount, or paying by a Visa card.
Invoice) is used the element (i.e. the element group) must not This option is supplier/customer dependent so before using
be used. this field, a preliminary bilateral agreement is required.
If not used, the supplier will apply the usual agreed payment
terms.
Applicable Codes
C Cash
K Credit Card
OrderLine Occurrence 1 .. unbounded
Name Line item information
Remark It should be checked with each supplier what the supported
maximum occurence is.
xsd:sequence Occurrence 1 .. 1
LineID Occurrence 1 .. 1
Length .. 6
Name Line identification number
Descr. Identification of a line in a document
SuppliersOrderLineID Occurrence 0 .. 1
Length .. 6
Name Suppliers's Order Line ID
Descr. Supplier assigned ID of a line of a sales order
Remark This field will not be provided by all suppliers
AdditionalCustomerReferenceNumber Occurrence 0 .. 1
Name Additional Customer's reference information
xsd:sequence Occurrence 1 .. 1
DocumentID Occurrence 1 .. 1 If the customer wants to have more references (ex. 4 tyres
Length .. 35 for Mr. Smith) by sending this to the supplier, the supplier
Name Document ID can print this information on the delivery document. The
Descr. Customer’s reference to the business transaction on item information in this field is not checked on the supplier side
level. and is taken there as a kind of free text.
OrderedArticle Occurrence 1 .. 1
Remark Article information
xsd:sequence Occurrence 1 .. 1
ArticleIdentification Occurrence 1 .. 1 The customer MUST send either the EAN code or the
Remark Normally the EAN is mandatory because it’s used as primary supplier product code. The reason for this is that the
key to identify the article on manufacturers side. In some supplier does not know the product code assigned by the
cases the suppliers article number must be used as primary customer. Nevertheless, if the customer wishes to send as
key (example: complete wheels) instead the EAN, but this well his product code, the supplier will store this number on
must be based on a bilateral agreement. the sales order, will print it on the delivery documents (on
request) and will return it in all subsequent EDI messages
(order confirmation, delivery, invoice).
'_'].
Error Occurrence 1 .. 1
xsd:sequence Occurrence 1 .. 1
ErrorCode Occurrence 1 .. 1
Length .. 3
Name Error code
Remark Code 903 should only be used in old versions.
Applicable Codes
0 No errors occurred
499 Miscellaneous - processing error
901 Document number invalid [identification number of document,
blanket order reference, customer reference, additional
customer reference number]
902 Too many items (order lines, despatch note lines)
903 Invalid article identification code
904 Quantity value invalid, must be greater than 0
911 Incorrect EAN number (not known on supplier side)
912 Requested delivery date invalid
918 No authority to specify earliest requested (header level) or
requested (item level) delivery date
919 No authority for brand/sales organisation
928 Mandatory EAN code missing for this line
931 Material definition error in supplier system (sales view, plant
view, prices etc)
933 This material can not be ordered via ad hoc EDI EDI ( In this
case a substituting article can be proposed if the substitution
indicator has been flagged in the inquiry).
940 Incorrect supplier material number (not known on supplier
side)
941 Wrong EAN/supplier material number combination
942 Maximum allowed quantity overpassed
945 Material status set to not sellable (material can not be
purchased anymore) ( In this case a substituting article can
be proposed if the substitution indicator has been flagged in
the inquiry).
970 Manufacturers order number invalid or not found
971 Customers order number invalid or not found
972 Requested delivery date out of authorised period horizon
Applicable Codes
973 Material is temporarily orderable only by phone. For more
details contact the call centre ( In this case a substituting
article can be proposed if the substitution indicator has been
flagged in the inquiry).
974 The ordered quantity is not equal to he content of the
packaging, or does not correspond to the multiple of the
packaging content.
975 Quantity value invalid. Must be an integer value.
999 Miscellaneous
ErrorText Occurrence 0 .. 1 The error text provided by the supplier has to be in English.
Length .. 60 It’s recommended to translate the error code definition by
Name Error text the customers software providers in the country specific
Descr. Detailled explanations of an error, that has occurred. language.
ScheduleDetails Occurrence 1 .. unbounded In practice, a requested quantity for a requested date can
Remark If both Delivery Date and Delivery Period are allowed then be split in several partial deliveries: the supplier will send
they shall be used mutually exclusive. back a kind of ‘delivery schedule proposal’ called in all
documents ‘Schedule details’.
xsd:sequence Occurrence 1 .. 1
DeliveryDate Occurrence 1 .. 1 The date 9999-12-31 will be returned in case if no delivery
Length .. 10 date could be determined. This is the date on which the
Pattern \d{4}-\d{2}-\d{2} supplier is forecasting the arrival of the goods at the
Name Date of delivery consignee / ship-to address. Note if the ship-to address is
Descr. Date of delivery at the place of delivery very far from the suppliers warehouse the exact timing
Remark If no date can be reflected by the ERP system, then the field could be different.
will be set to 9999-12-31.
ConfirmedQuantity Occurrence 1 .. 1
xsd:sequence Occurrence 1 .. 1
QuantityValue Occurrence 1 .. 1
TotalDigits 15
Name Confirmed quantity
Remark Quantity must be larger than 0. No decimals are allowed.
OrderedQuantity Occurrence 1 .. 1
xsd:sequence Occurrence 1 .. 1
QuantityValue Occurrence 1 .. 1
TotalDigits 9
Name Ordered quantity
Remark Quantity must be larger than 0. No decimals are allowed.