UN layout formatting specification for UBL Order Response instances

$Date: 2004/09/09 01:30:40 $(UTC)


Contents

1. Order response formatting specification
2. Status
3. Example rendering
4. Layout order and information
5. Namespaces
6. Main document and party information
6.1. Seller
6.2. Seller's reference
6.3. Date
6.4. Buyer’s reference
6.5. Purchase Order Date
6.6. Purchase Order Date
6.7. Consignee
6.8. Buyer
7. Additional document and party information
7.1. Order response status
7.2. Country of origin
7.3. Country of destination
8. Delivery and transport
8.1. Mode of transport
8.2. Date of despatch
8.3. Means of transport
8.4. Place of despatch
8.5. Vessel/flight No.
8.6. Port of loading
8.7. Port of discharge
8.8. Place of delivery
8.9. Terms of delivery
8.10. Location
8.11. Special terms
8.12. Terms of payment
8.13. Currency of payment
9. Consignment information
9.1. Shipping marks; container number
9.2. No. and kind of packages; description of goods
9.3. Total gross weight (kg)
9.4. Total cube(m3)
9.5. Total net weight (kg)
10. Line item information
10.1. Item / References
10.2. Description
10.3. Country of origin
10.4. Commodity code
10.5. Quantity
10.6. Unit price
11. Summary information
11.1. Notes
11.2. Seller's company and telephone no.
11.3. Name of contact
11.4. Date
11.5. Signature
12. Continuation page
12.1. Item / References
12.2. Description
12.3. Country of origin
12.4. Commodity code
12.5. Quantity
12.6. Unit price
12.7.

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.

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

3.  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:

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

5.  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"

6. Main document and party information

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

6.1. Seller

Box Label: "Seller"

Table 1. 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/​cac:CountrySubentityCode
/​ro:OrderResponse/​cac:SellerParty/​cac:Party/​cac:Address/​cbc:PostalZone
/​ro:OrderResponse/​cac:SellerParty/​cac:Party/​cac:Address/​cac:Country/​cbc:Name

Table 2. Box Geometry

row1height6
column1width4

Table 3. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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.

Note that only one of cbc:CountrySubentity and cac:CountrySubentityCode need be used, with preference to cbc:CountrySubentity if it exists.

6.2. Seller's reference

Box Label: "Seller's reference"

Table 4. XPath information

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

Table 5. Box Geometry

row1height2
column5width4

Table 6. Box Borders

line-beforetrue
line-after
line-starttrue
line-endtrue

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

6.3. Date

Box Label: "Date"

Table 7. XPath information

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

Table 8. Box Geometry

row3height2
column5width4

Table 9. Box Borders

line-before
line-aftertrue
line-starttrue
line-endtrue

This field states the date of the order response.

6.4. Buyer’s reference

Box Label: "Buyer’s reference"

Table 10. XPath information

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

Table 11. Box Geometry

row5height2
column5width2

Table 12. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-end

This field provides a reference to the original order.

6.5. Purchase Order Date

Box Label: "Purchase Order Date"

Table 13. Box Geometry

row5height2
column7width2

Table 14. Box Borders

line-beforetrue
line-after
line-start
line-endtrue

This field provides a location for additiona reference information.

6.6. Purchase Order Date

Box Label: "Purchase Order Date"

Table 15. Box Geometry

row5height2
column7width2

Table 16. Box Borders

line-beforetrue
line-aftertrue
line-start
line-endtrue

This field provides the issue date of the original order.

6.7. Consignee

Box Label: "Consignee"

Table 17. 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/​cac:CountrySubentityCode
/​ro:OrderResponse/​cac:Delivery/​cac:DeliveryAddress/​cbc:PostalZone
/​ro:OrderResponse/​cac:Delivery/​cac:DeliveryAddress/​cac:Country/​cbc:Name

Table 18. Box Geometry

row7height6
column1width4

Table 19. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

Note that only one of cbc:CountrySubentity and cac:CountrySubentityCode need be used, with preference to cbc:CountrySubentity if it exists.

6.8. Buyer

Box Label: "Buyer"

Table 20. 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/​cac:CountrySubentityCode
/​ro:OrderResponse/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:PostalZone
/​ro:OrderResponse/​cac:BuyerParty/​cac:Party/​cac:Address/​cac:Country/​cbc:Name

Table 21. Box Geometry

row7height6
column5width4

Table 22. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

Note that only one of cbc:CountrySubentity and cac:CountrySubentityCode need be used, with preference to cbc:CountrySubentity if it exists.

7.  Additional document and party information

7.1. Order response status

Box Label: "Order response status"

Table 23. XPath information

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

Table 24. Box Geometry

row13height2
column5width4

Table 25. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

7.2. Country of origin

Box Label: "Country of origin"

Table 26. XPath information

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

Table 27. Box Geometry

row15height2
column5width2

Table 28. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

7.3. Country of destination

Box Label: "Country of destination"

Table 29. XPath information

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

Table 30. Box Geometry

row15height2
column7width2

Table 31. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

This fields provides the name of the destination country.

8. Delivery and transport

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

8.1. Mode of transport

Box Label: "Mode of transport"

Table 32. Box Geometry

row17height2
column1width2

Table 33. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

8.2. Date of despatch

Box Label: "Date of despatch"

Table 34. Box Geometry

row17height2
column3width2

Table 35. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

8.3. Means of transport

Box Label: "Means of transport"

Table 36. Box Geometry

row19height2
column1width2

Table 37. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

8.4. Place of despatch

Box Label: "Place of despatch"

Table 38. Box Geometry

row19height2
column3width2

Table 39. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

8.5. Vessel/flight No.

Box Label: "Vessel/flight No."

Table 40. Box Geometry

row21height2
column1width2

Table 41. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

8.6. Port of loading

Box Label: "Port of loading"

Table 42. Box Geometry

row21height2
column3width2

Table 43. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

8.7. Port of discharge

Box Label: "Port of discharge"

Table 44. Box Geometry

row23height2
column1width2

Table 45. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

8.8. Place of delivery

Box Label: "Place of delivery"

Table 46. Box Geometry

row23height2
column3width2

Table 47. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

8.9. Terms of delivery

Box Label: "Terms of delivery"

Table 48. XPath information

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

Table 49. Box Geometry

row17height2
column5width2

Table 50. Box Borders

line-beforetrue
line-after
line-starttrue
line-end

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

8.10. Location

Box Label: "Location"

Table 51. XPath information

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

Table 52. Box Geometry

row17height2
column7width2

Table 53. Box Borders

line-beforetrue
line-after
line-start
line-endtrue

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

8.11. Special terms

Box Label: "Special terms"

Table 54. XPath information

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

Table 55. Box Geometry

row19height2
column5width4

Table 56. Box Borders

line-before
line-after
line-starttrue
line-endtrue

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

8.12. Terms of payment

Box Label: "Terms of payment"

Table 57. Box Geometry

row21height2
column5width2

Table 58. Box Borders

line-before
line-after
line-starttrue
line-end

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

8.13. Currency of payment

Box Label: "Currency of payment"

Table 59. XPath information

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

Table 60. Box Geometry

row21height2
column7width2

Table 61. Box Borders

line-before
line-after
line-start
line-endtrue

This specifies the payment currency for the entire order response.

9. Consignment information

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

9.1. Shipping marks; container number

Box Label: "Shipping marks; container number"

Table 62. Box Geometry

row25height8
column1width2

Table 63. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-end

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

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

Box Label: "No. and kind of packages; description of goods"

Table 64. Box Geometry

row25height8
column3width4

Table 65. Box Borders

line-beforetrue
line-aftertrue
line-start
line-end

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

9.3. Total gross weight (kg)

Box Label: "Total gross weight (kg)"

Table 66. XPath information

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

Table 67. Box Geometry

row25height4
column7width1

Table 68. Box Borders

line-beforetrue
line-aftertrue
line-start
line-end

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

9.4. Total cube(m3)

Box Label: "Total cube(m3)"

Table 69. Box Geometry

row25height4
column8width1

Table 70. Box Borders

line-beforetrue
line-after
line-start
line-endtrue

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

9.5. Total net weight (kg)

Box Label: "Total net weight (kg)"

Table 71. XPath information

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

Table 72. Box Geometry

row29height4
column7width1

Table 73. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

10. Line item information

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

10.1. Item / References

Box Label: "Item / References"

Table 74. XPath information

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

Table 75. Box Geometry

row33height16
column1width1

Table 76. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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.

10.2. Description

Box Label: "Description"

Table 77. XPath information

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

Table 78. Box Geometry

row33height16
column2width2

Table 79. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

This provides a free text description of the line item.

10.3. Country of origin

Box Label: "Country of origin"

Table 80. XPath information

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

Table 81. Box Geometry

row15height2
column5width2

Table 82. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

10.4. Commodity code

Box Label: "Commodity code"

Table 83. XPath information

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

Table 84. Box Geometry

row33height16
column5width1

Table 85. Box Borders

line-beforetrue
line-aftertrue
line-start
line-endtrue

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

10.5. Quantity

Box Label: "Quantity"

Table 86. XPath information

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

Table 87. Box Geometry

row33height16
column6width1

Table 88. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

10.6. Unit price

Box Label: "Unit price"

Table 89. XPath information

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

Table 90. Box Geometry

row33height16
column7width1

Table 91. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-end

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

11. Summary information

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

11.1. Notes

Box Label: "Notes"

Table 92. Box Geometry

row49height16
column1width5

Table 93. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-end

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

11.2. Seller's company and telephone no.

Box Label: "Seller's company and telephone no."

Table 94. XPath information

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

Table 95. Box Geometry

row57height2
column6width3

Table 96. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

11.3. Name of contact

Box Label: "Name of contact"

Table 97. XPath information

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

Table 98. Box Geometry

row59height2
column6width3

Table 99. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

11.4. Date

Box Label: "Date"

Table 100. XPath information

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

Table 101. Box Geometry

row61height2
column6width3

Table 102. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

11.5. Signature

Box Label: "Signature"

Table 103. Box Geometry

row63height2
column6width3

Table 104. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

12.  Continuation page

The continuation page comprises only a copy of the document identification information described in Section 6, “Main document and party information” and room for additional line item entries described in Section 10, “Line item information”. Alternative box representations are described below:

12.1. Item / References

Box Label: "Item / References"

Table 105. XPath information

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

Table 106. Box Geometry

row13height52
column1width1

Table 107. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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.

12.2. Description

Box Label: "Description"

Table 108. XPath information

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

Table 109. Box Geometry

row13height52
column2width2

Table 110. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

This provides a free text description of the line item.

12.3. Country of origin

Box Label: "Country of origin"

Table 111. XPath information

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

Table 112. Box Geometry

row13height52
column4width1

Table 113. Box Borders

line-beforetrue
line-aftertrue
line-start
line-endtrue

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

12.4. Commodity code

Box Label: "Commodity code"

Table 114. XPath information

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

Table 115. Box Geometry

row13height52
column5width1

Table 116. Box Borders

line-beforetrue
line-aftertrue
line-start
line-endtrue

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

12.5. Quantity

Box Label: "Quantity"

Table 117. XPath information

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

Table 118. Box Geometry

row13height52
column6width1

Table 119. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

12.6. Unit price

Box Label: "Unit price"

Table 120. XPath information

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

Table 121. Box Geometry

row13height52
column7width1

Table 122. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-end

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

12.7. 

Box Label: ""

This field states the actual line item amount which will be quantity multiplied by the unit price, the result is not calculated it will be transmitted.