UN layout formatting specification for UBL Order Response instances

$Date: 2004/09/05 15:15:15 $(UTC)


Table of Contents

1. Order response formatting specification
1.1. Status
1.2. Example rendering
1.3. Layout order and information
1.4. Namespaces
2. Miscellaneous information
2.1. Document header information
3. Main document and party information
3.1. Seller
3.2. Seller's reference
3.3. Date
3.4. Buyer's reference
3.5. Purchase order date
3.6. Consignee
3.7. Buyer
4. Additional document and party information
4.1. Order response status
4.2. Country of origin
4.3. Country of destination
5. Delivery and transport
5.1. Mode of transport
5.2. Date of despatch
5.3. Means of transport
5.4. Place of despatch
5.5. Vessel/flight no.
5.6. Port of loading
5.7. Port of discharge
5.8. Place of delivery
5.9. Terms of delivery
5.10. Location
5.11. Special terms
5.12. Terms of payment
5.13. Currency of payment
6. Consignment information
6.1. Shipping marks; container number
6.2. No. and kind of packages; description of goods
6.3. Total gross weight (kg)
6.4. Total cube (m3)
6.5. Total net weight (kg)
7. Line item information
7.1. Item / References
7.2. Description
7.3. Country of origin
7.4. Commodity code
7.5. Quantity
7.6. Unit price
8. Summary information
8.1. Delivery date
8.2. Note
8.3. Seller's company and telephone no.
8.4. Name of contact
8.5. Date
8.6. Signature
9. Continuation page

1.  Order response formatting specification

This formatting specification describes a rendering of the UBL Order Response document model according to the United Nations Layout Key for Trade Documents guidelines for application for the 320 Acknowledgement of Order form:

  • 320 Acknowledgement of Order: Document acknowledging an undertaking to fulfill an order and confirming conditions or acceptance of conditions.

For a list of all formatting specifications and an overview of the documentation conventions, please visit the formatting specification home page.

1.1.  Status

This specification has no formal status at this time. It should not be considered a reference interpretation of UBL documents. Feedback is sought from users of stylesheets that implement this formatting specification regarding suggestions for change for consideration by the OASIS UBL committees for incorporation into these formatting specifications.

Presentational semantics may never be formalized or normative in the UBL project due to differing international requirements and conventions for the presentation of information found in business documents. This document contains only examples from a few of what will probably be many available UBL stylesheet libraries.

1.2.  Example rendering

The following is an example rendering that illustrates the position and decoration of the information items found in an instance of the document type:

1.3.  Layout order and information

Items in this formatting specification are ordered roughly from the laid out fields on the form in the order left-to-right, top to bottom.

Certain descriptions are verbatim quotes from the United Nations guidelines document.

Important: the rendering of a number of fields is very simplified, reflecting a Western European interpretation of a subset of fields (as in names and addresses). User requirements need to be better understood for the level of granularity in these formatting specifications.

1.4.  Namespaces

The following namespaces are mapped to the prefixes in the expressions below:

  • xmlns:ro="urn:oasis:names:specification:ubl:schema:xsd:OrderResponse-1.0"

  • xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-1.0"

  • xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-1.0"

2.  Miscellaneous information

The following information is unrelated to the visible fields of the form.

2.1.  Document header information

Table 1. XPath information

XPath addresses
/​ro:OrderResponse/​ro:SellersID
/​ro:OrderResponse/​cbc:IssueDate

This information shows up in the window-title bar of the HTML browser, and in the document title supported by some XSL-FO processors.

3. Main document and party information

Header information is associated with the form as a whole, not to the individual items of goods.

3.1. Seller

Table 2. XPath information

XPath addresses
/​ro:OrderResponse/​cac:SellerParty/​cac:Party/​cac:PartyName/​cbc:Name
/​ro:OrderResponse/​cac:SellerParty/​cac:Party/​cac:Address/​cbc:BuildingNumber
/​ro:OrderResponse/​cac:SellerParty/​cac:Party/​cac:Address/​cbc:StreetName
/​ro:OrderResponse/​cac:SellerParty/​cac:Party/​cac:Address/​cbc:CityName
/​ro:OrderResponse/​cac:SellerParty/​cac:Party/​cac:Address/​cbc:CountrySubentity
/​ro:OrderResponse/​cac:SellerParty/​cac:Party/​cac:Address/​cbc:PostalZone
/​ro:OrderResponse/​cac:SellerParty/​cac:Party/​cac:Address/​cac:Country/​cbc:Name

This field is intended to show the name and address of the sender of goods or the originator of the documents, as the case may be.

3.2. Seller's reference

Table 3. XPath information

XPath address
/​ro:OrderResponse/​ro:SellersID

This number is a unique number assigned to the order response by the seller.

3.3. Date

Table 4. XPath information

XPath address
/​ro:OrderResponse/​cbc:IssueDate

This field states the date of the order response.

3.4. Buyer's reference

Table 5. XPath information

XPath address
/​ro:OrderResponse/​cac:OrderReference/​cac:BuyersID

This field provides a reference to the original order.

3.5. Purchase order date

Table 6. XPath information

XPath address
/​ro:OrderResponse/​cac:OrderReference/​cbc:IssueDate

This field provides the issue date of the original order.

3.6. Consignee

Table 7. XPath information

XPath addresses
/​ro:OrderResponse/​cac:BuyerParty/​cac:Party/​cac:PartyName/​cbc:Name
/​ro:OrderResponse/​cac:Delivery/​cac:DeliveryAddress/​cbc:BuildingNumber
/​ro:OrderResponse/​cac:Delivery/​cac:DeliveryAddress/​cbc:StreetName
/​ro:OrderResponse/​cac:Delivery/​cac:DeliveryAddress/​cbc:CityName
/​ro:OrderResponse/​cac:Delivery/​cac:DeliveryAddress/​cbc:CountrySubentity
/​ro:OrderResponse/​cac:Delivery/​cac:DeliveryAddress/​cbc:PostalZone
/​ro:OrderResponse/​cac:Delivery/​cac:DeliveryAddress/​cac:Country/​cbc:Name

These fields are used to provide the name and address of the receiver of the goods involved in the transaction.

3.7. Buyer

Table 8. XPath information

XPath addresses
/​ro:OrderResponse/​cac:BuyerParty/​cac:Party/​cac:PartyName/​cbc:Name
/​ro:OrderResponse/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:BuildingNumber
/​ro:OrderResponse/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:StreetName
/​ro:OrderResponse/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:CityName
/​ro:OrderResponse/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:CountrySubentity
/​ro:OrderResponse/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:PostalZone
/​ro:OrderResponse/​cac:BuyerParty/​cac:Party/​cac:Address/​cac:Country/​cbc:Name

These fields are used to provide the name and address of the buyer of the goods involved in the transaction.

4.  Additional document and party information

4.1. Order response status

Table 9. XPath information

XPath address
/​ro:OrderResponse/​ro:DocumentStatusCode

This field provides the status of the order response, the response status code should be translated into text form for clarity.

4.2. Country of origin

At this time this field is not being used in the order response.

4.3. Country of destination

Table 10. XPath information

XPath address
/​ro:OrderResponse/​ro:DestinationCountry/​cbc:Name

This fields provides the name of the destination country.

5. Delivery and transport

Transportation fields are header-like information and are applicable to the entire order response.

5.1. Mode of transport

At this time this field is not being used in the order response.

5.2. Date of despatch

At this time this field is not being used in the order response.

5.3. Means of transport

At this time this field is not being used in the order response.

5.4. Place of despatch

At this time this field is not being used in the order response.

5.5. Vessel/flight no.

At this time this field is not being used in the order response.

5.6. Port of loading

At this time this field is not being used in the order response.

5.7. Port of discharge

At this time this field is not being used in the order response.

5.8. Place of delivery

At this time this field is not being used in the order response.

5.9. Terms of delivery

Table 11. XPath information

XPath address
/​ro:OrderResponse/​cac:DeliveryTerms/​cac:ID

This fields provides the INCOTERM code for the terms of delivery.

5.10. Location

Table 12. XPath information

XPath address
/​ro:OrderResponse/​cac:DeliveryTerms/​cbc:RelevantLocation

This field provides the location name (if relevant) associated to the delivery terms.

5.11. Special terms

Table 13. XPath information

XPath address
/​ro:OrderResponse/​cac:DeliveryTerms/​cbc:SpecialTerms

This field provides free text description of special conditions relating to the delivery terms.

5.12. Terms of payment

At this time this field is not being used in the order response.

5.13. Currency of payment

Table 14. XPath information

XPath address
/​ro:OrderResponse/​ro:TransactionCurrencyCode

This specifies the payment currency for the entire order response.

6. Consignment information

The consignment information holds generic details and totals relating to all the goods items in the order response.

6.1. Shipping marks; container number

At this time this field is not being used in the order response.

6.2. No. and kind of packages; description of goods

At this time this field is not being used in the order response.

6.3. Total gross weight (kg)

Table 15. XPath information

XPath address
/​ro:OrderResponse/​cbc:GrossWeightMeasure

This field provides the gross weight of the order response (not the shipment as it is not known at the order response stage).

6.4. Total cube (m3)

Table 16. XPath information

XPath address
/​ro:OrderResponse/​cbc:GrossVolumeMeasure

This field provides the gross volume of the order response (not the shipment as it is not known at the order response stage).

6.5. Total net weight (kg)

Table 17. XPath information

XPath address
/​ro:OrderResponse/​cbc:NetWeightMeasure

This field provides the net weight of the order response (not the shipment as it is not known at the order response stage).

7. Line item information

Line item information is associated with the individual item of goods in the order response

7.1. Item / References

Table 18. XPath information

XPath addresses
/​ro:OrderResponse/​ro:RespondedOrderLine/​cac:LineItem/​cac:BuyersID
/​ro:OrderResponse/​ro:RespondedOrderLine/​cac:LineItem/​cac:SellersID

The first reference is the buyer's assigned reference to the line item.

The second reference is the seller's assigned reference to the line item.

7.2. Description

Table 19. XPath information

XPath address
/​ro:OrderResponse/​ro:RespondedOrderLine/​cac:LineItem/​cac:Item/​cbc:Description

This provides a free text description of the line item.

7.3. Country of origin

Table 20. XPath information

XPath address
/​ro:OrderResponse/​ro:RespondedOrderLine/​cac:LineItem/​cac:Item/​cac:OriginCountry/​cbc:Name

This field is used to provide to country of origin for the line item.

7.4. Commodity code

Table 21. XPath information

XPath address
/​ro:OrderResponse/​ro:RespondedOrderLine/​cac:LineItem/​cac:Item/​cac:CommodityClassification/​cac:CommodityCode

This field is used to provide the commodity code for the line item.

7.5. Quantity

Table 22. XPath information

XPath address
/​ro:OrderResponse/​ro:RespondedOrderLine/​cac:LineItem/​cbc:Quantity

This field states the number of items ordered for the line item.

7.6. Unit price

Table 23. XPath information

XPath address
/​ro:OrderResponse/​ro:RespondedOrderLine/​cac:LineItem/​cac:Item/​cac:BasePrice/​cbc:PriceAmount

This field is used to specify the unit price of the line item.

8. Summary information

Summary information is associated to the entire order response and not to any individual line item.

8.1. Delivery date

Table 24. XPath information

XPath address
/​ro:OrderResponse/​cac:Delivery/​cbc:PromisedDateTime

This field provides the date when the goods should be available for despatch / shipment. It is prefixed and suffixed with prose as shown on the form. This field's title as used in this specification is not shown on the actual form.

8.2. Note

Table 25. XPath information

XPath address
/​ro:OrderResponse/​cbc:Note

This notes field is used for any free text information that relates to the entire order response.

8.3. Seller's company and telephone no.

Table 26. XPath information

XPath addresses
/​ro:OrderResponse/​cac:SellerParty/​cac:Party/​cac:PartyName/​cbc:Name
/​ro:OrderResponse/​cac:SellerParty/​cac:Party/​cac:Contact/​cbc:Telephone

These fields identified the name of the seller's company and a contact telephone number.

8.4. Name of contact

Table 27. XPath information

XPath address
/​ro:OrderResponse/​cac:SellerParty/​cac:Party/​cac:Contact/​cbc:Name

This field identified the name of the seller's contact.

8.5. Date

Table 28. XPath information

XPath address
/​ro:OrderResponse/​cbc:IssueDate

This field provide the date of issue of the order response.

8.6. Signature

This field is not currently being filled automatically as it is a manual entry.

9.  Continuation page

The continuation page comprises only a copy of the document identification information described in Section 3, “Main document and party information” and room for additional line item entries described in Section 7, “Line item information”.