Report_NC_PurchaseOrder message
The Report_NC_PurchaseOrder message is an outbound message that contains order details for a completed order. The HCL Commerce outbound messaging system generates this message using the OrderCreateXML.jsp composition template and sends its data to an outbound message queue, where a back-end system receives the message. This application takes the message and continues any back-end business processes required to complete the specified task for the order. Use Report_NC_PurchaseOrder to fulfill the order process of orders that begin with the HCL Commerce system, but also require some additional or back-end work by a separate system.
The Report_NC_PurchaseOrder message uses the XML message format and follows Report_NC_PO_10.dtd.
The DTD file consists of a set of XML elements. The message contains order, customer, billing, merchant, and shipping information. The following data describes Report_NC_PO_10.dtd, which is used for the Report_NC_PurchaseOrder message:
The format and the source of the XML element values are described in the following table. For a description of the database column, follow the link to its associated table. All fields are optional unless otherwise noted. The tag value length in the XML message for database fields of type INT, BIGINT and DOUBLE should be CHAR (10), CHAR(19), and CHAR(16) respectively.
Level | XML Element | Comment | Table Name | Column Name |
---|---|---|---|---|
1 | ReportPO Header | Mandatory | N/A | N/A |
1.1 | OrderNumber ByBuyer | N/A | N/A | |
1.2 | OrderNumber ByMerchant | ORDERS | ORMORDER | |
1.3 | OrderNumber ByNC | ORDERS | ORDERS_ID | |
1.4 | DateTime Reference | N/A | N/A | |
1.4.1 | PlacedDate | ORDERS | TIMEPLACED | |
1.4.2 | PlacedTime | ORDERS | TIMEPLACED | |
1.4.3 | LastUpdate Date | N/A | N/A | |
1.4.4 | LatestUpdate Time | N/A | N/A | |
1.5 | TotalPriceInfo | Mandatory | N/A | N/A |
1.5.A1 | currency | Attribute | ORDERS | CURRENCY |
1.5.1 | TotalNet Price | Mandatory | ORDERS | TOTALPRODUCT |
1.5.2 | TaxInfo | N/A | N/A | |
1.5.2.1 | Monetary Amount | Mandatory | ORDERS | TOTALTAX |
1.5.2.1.A1 | currency | Attribute | ORDERS | CURRENCY |
1.5.2.2 | TaxType | N/A | N/A | |
1.5.2.3 | Percentage | N/A | N/A | |
1.5.2.4 | TaxExemption StatusType | N/A | N/A | |
1.5.2.5 | TaxExemption Number | N/A | N/A | |
1.5.2.6 | TaxJurisdiction Code | N/A | N/A | |
1.5.2.7 | TaxJurisdiction CodeType | N/A | N/A | |
1.5.3 | Total ShippingPrice | Mandatory | ORDERS | TOTALSHIPPING |
1.5.4 | TotalTaxOn ShippingPrice | Mandatory | ORDERS | TOTALTAXSHIPPING |
1.6 | Instruction | N/A | N/A | |
1.7 | ShipStatus | ORDERS | STATUS | |
1.8 | BillToInfo | N/A | N/A | |
1.8.1 | OrgName | N/A | N/A | |
1.8.2 | Address | Mandatory | N/A | N/A |
1.8.2.1 | AddressLine | Mandatory; first repeated occurrence | ADDRESS | ADDRESS1 |
1.8.2.1 | AddressLine | second repeated occurrence | ADDRESS | ADDRESS2 |
1.8.2.1 | AddressLine | third repeated occurrence | ADDRESS | ADDRESS3 |
1.8.2.2 | City | Mandatory | ADDRESS | CITY |
1.8.2.3 | State | Mandatory | ADDRESS | STATE |
1.8.2.4 | Zip | Mandatory | ADDRESS | ZIPCODE |
1.8.2.5 | Country | Mandatory | ADDRESS | COUNTRY |
1.8.3 | ContactPerson Name | Mandatory | N/A | N/A |
1.8.3.1 | Title | N/A | N/A | |
1.8.3.2 | FullName | N/A | N/A | |
1.8.3.3 | LastName | Mandatory | ADDRESS | LASTNAME |
1.8.3.4 | FirstName | ADDRESS | FIRSTNAME | |
1.8.3.5 | MiddleName | ADDRESS | MIDDLENAME | |
1.8.3.6 | AlternateName | ADDRESS | NICKNAME | |
1.8.4 | ContactInfo | Mandatory | N/A | N/A |
1.8.4.1 | Telephone | first repeated occurrence | ADDRESS | PHONE1 |
1.8.4.1 | Telephone | second repeated occurrence | ADDRESS | PHONE2 |
1.8.4.2 | first repeated occurrence | ADDRESS | EMAIL1 | |
1.8.4.2 | second repeated occurrence | ADDRESS | EMAIL2 | |
1.8.4.3 | Fax | ADDRESS | FAX1 | |
1.9 | MerchantInfo | N/A | N/A | |
1.9.1 | OrgName | Mandatory | STOREENTDS | DISPLAYNAME |
1.9.2 | OrgID | first repeated occurrence | N/A | N/A |
1.9.2.A1 | type | attribute | ORDERS | STOREENT_ID |
1.9.3 | Address | Mandatory | N/A | N/A |
1.9.3.1 | AddressLine | Mandatory; first repeated occurrence | STADDRESS | ADDRESS1 |
1.9.3.1 | AddressLine | second repeated occurrence | STADDRESS | ADDRESS2 |
1.9.3.1 | AddressLine | third repeated occurrence | STADDRESS | ADDRESS3 |
1.9.3.2 | City | Mandatory | STADDRESS | CITY |
1.9.3.3 | State | Mandatory | STADDRESS | STATE |
1.9.3.4 | Zip | Mandatory | STADDRESS | ZIPCODE |
1.9.3.5 | Country | Mandatory | STADDRESS | COUNTRY |
1.9.4 | URL | N/A | N/A | |
1.9.5 | Telephone | STADDRESS | PHONE1 | |
1.9.6 | ContactPerson Name | N/A | N/A | |
1.9.6.1 | Title | STADDRESS | PERSONTITLE | |
1.9.6.2 | FullName | N/A | N/A | |
1.9.6.3 | LastName | Mandatory | STADDRESS | LASTNAME |
1.9.6.4 | FirstName | STADDRESS | FIRSTNAME | |
1.9.6.5 | MiddleName | STADDRESS | MIDDLENAME | |
1.9.6.6 | AlternateName | N/A | N/A | |
1.9.7 | ContactInfo | Mandatory | N/A | N/A |
1.9.7.1 | Telephone | first repeated occurrence | STADDRESS | PHONE1 |
1.9.7.1 | Telephone | second repeated occurrence | STADDRESS | PHONE2 |
1.9.7.2 | first repeated occurrence | STADDRESS | EMAIL1 | |
1.9.7.3 | second repeated occurrence | STADDRESS | EMAIL2 | |
1.9.7.4 | Fax | STADDRESS | FAX1 | |
1.10 | BuyOrgInfo | N/A | N/A | |
1.10.1 | OrgName | Mandatory | ADDRESS | ORGNAME |
1.10.2 | OrgID | first repeated occurrence; | N/A | N/A |
1.10.2.A1 | type | Attribute; | N/A | N/A |
1.10.3 | Address | N/A | N/A | |
1.10.3.1 | AddressLine | Mandatory; first repeated occurrence | N/A | N/A |
1.10.3.1 | AddressLine | second repeated occurrence | N/A | N/A |
1.10.3.1 | AddressLine | third repeated occurrence | N/A | N/A |
1.10.3.2 | City | Mandatory | N/A | N/A |
1.10.3.3 | State | Mandatory | N/A | N/A |
1.10.3.4 | Zip | Mandatory | N/A | N/A |
1.10.3.5 | Country | Mandatory | N/A | N/A |
1.10.4 | URL | N/A | N/A | |
1.10.5 | ContactInfo | N/A | N/A | |
1.10.5.1 | Telephone | first repeated occurrence | N/A | N/A |
1.10.5.1 | Telephone | second repeated occurrence | N/A | N/A |
1.10.5.2 | first repeated occurrence | N/A | N/A | |
1.10.5.2 | second repeated occurrence | N/A | N/A | |
1.10.5.3 | Fax | N/A | N/A | |
1.11 | ShipToInfo | N/A | N/A | |
1.11.1 | ContactPerson Name | Mandatory | N/A | N/A |
1.11.1.1 | Title | N/A | N/A | |
1.11.1.2 | FullName | Mandatory | N/A | N/A |
1.11.1.3 | LastName | Mandatory | N/A | N/A |
1.11.1.4 | FirstName | N/A | N/A | |
1.11.1.5 | MiddleName | N/A | N/A | |
1.11.1.6 | AlternateName | N/A | N/A | |
1.11.2 | OfficeAddress Line | N/A | N/A | |
1.11.3 | Address | Mandatory | N/A | N/A |
1.11.3.1 | AdddressLine | Mandatory; first repeated occurrence | N/A | N/A |
1.11.3.1 | AdddressLine | second repeated occurrence | N/A | N/A |
1.11.3.1 | AdddressLine | third repeated occurrence | N/A | N/A |
1.11.3.2 | City | Mandatory | N/A | N/A |
1.11.3.3 | State | Mandatory | N/A | N/A |
1.11.3.4 | Zip | Mandatory | N/A | N/A |
1.11.3.5 | Country | Mandatory | N/A | N/A |
1.11.4 | ContactInfo | N/A | N/A | |
1.11.4.1 | Telephone | first repeated occurrence | N/A | N/A |
1.11.4.1 | Telephone | second repeated occurrence | N/A | N/A |
1.11.4.2 | first repeated occurrence | N/A | N/A | |
1.11.4.2 | second repeated occurrence | N/A | N/A | |
1.11.4.3 | Fax | N/A | N/A | |
1.11.5 | Comment | N/A | N/A | |
1.12 | Requisitioner Info | N/A | N/A | |
1.12.1 | RequisitionerID | first repeated occurrence | ORDERS | MEMBER_ID |
1.12.1.A1 | type | Mandatory; attribute | N/A | N/A |
1.12.1 | RequisitionerID | second repeated occurrence | USERREG | LOGONID |
1.12.1.A2 | type | Mandatory; attribute | N/A | N/A |
1.12.2 | Requisitioner Group | N/A | N/A | |
1.12.3 | Address | N/A | N/A | |
1.12.3.1 | AddressLine | Mandatory; first repeated occurrence | ADDRESS | ADDRESS1 |
1.12.3.1 | AddressLine | second repeated occurrence | ADDRESS | ADDRESS2 |
1.12.3.1 | AddressLine | third repeated occurrence | ADDRESS | ADDRESS3 |
1.12.3.2 | City | Mandatory | ADDRESS | CITY |
1.12.3.3 | State | Mandatory | ADDRESS | STATE |
1.12.3.4 | Zip | Mandatory | ADDRESS | ZIPCODE |
1.12.3.5 | Country | Mandatory | ADDRESS | COUNTRY |
1.12.4 | ContactPerson Name | N/A | N/A | |
1.12.4.1 | Title | ADDRESS | PERSONTITLE | |
1.12.4.2 | FullName | Mandatory | N/A | N/A |
1.12.4.3 | LastName | Mandatory | ADDRESS | LASTNAME |
1.12.4.4 | FirstName | ADDRESS | FIRSTNAME | |
1.12.4.5 | MiddleName | ADDRESS | MIDDLENAME | |
1.12.4.6 | AlternateName | N/A | N/A | |
1.12.5 | ContactInfo | Mandatory | N/A | N/A |
1.12.5.1 | Telephone | first repeated occurrence | ADDRESS | PHONE1 |
1.12.5.1 | Telephone | second repeated occurrence | ADDRESS | PHONE2 |
1.12.5.2 | first repeated occurrence | ADDRESS | EMAIL1 | |
1.12.5.2 | second repeated occurrence | ADDRESS | EMAIL2 | |
1.12.5.3 | Fax | ADDRESS | FAX1 | |
1.13 | ShipDate Reference | N/A | N/A | |
1.13.1 | Requested ShipDate | N/A | N/A | |
1.13.2 | Scheduled ShipDate | N/A | N/A | |
1.13.3 | Actual ShipDate | N/A | N/A | |
1.14 | PCardInfo | N/A | N/A | |
1.14.1 | Monetary Amount | ORDPAYMTHD | MAXAMOUNT | |
1.14.1.A1 | currency | Attribute | ORDERS | CURRENCY |
1.14.2 | CardType | ORDPAYMTHD | PAYMETHOD | |
1.14.3 | CardNumber | ORDPAYMTHD | PAYDEVICE | |
1.14.4 | Expiration Date | ORDPAYMTHD | ENDDATE | |
1.14.5 | IssueDate | ORDPAYMTHD | STARTDATE | |
1.14.6 | Credit Authorization Number | N/A | N/A | |
1.14.7 | Customer Reference Number | N/A | N/A | |
1.15 | Shipping CarrierInfo | N/A | N/A | |
1.15.1 | Carrier | N/A | N/A | |
1.15.2 | Method | N/A | N/A | |
1.16 | BuyOrg Accounting Detail | N/A | N/A | |
1.16.1 | Percentage | N/A | N/A | |
1.16.2 | Monetary Amount | N/A | N/A | |
1.16.2.A1 | currency | Attribute | N/A | N/A |
1.16.3 | BudgetCode | Mandatory | N/A | N/A |
1.16.4 | Description | N/A | N/A | |
1.16.5 | Calculation Code | Mandatory | N/A | N/A |
1.17.2 | OrderCustomer Field | first repeated occurrence | ORDERS | FIELD1 |
1.17.2 | OrderCustomer Field | first repeated occurrence | ORDERS | FIELD2 |
1.17.2 | OrderCustomer Field | second repeated occurrence | ORDERS | FIELD3 |
1.18 | UserData | N/A | N/A | |
2 | ReportPOItem | Mandatory; first repeated occurrence | N/A | N/A |
2.1 | ItemLine Number | N/A | N/A | |
2.2 | ItemNumber ByNC | ORDERITEMS | ORDERITEMS_ID | |
2.3 | ProductNumber ByBuyer | N/A | N/A | |
2.4 | ProductNumber ByMerchant | Mandatory | CATENTRY | PARTNUMBER |
2.5 | Manufacturer Name | N/A | N/A | |
2.6 | Manufacturer URL | N/A | N/A | |
2.7 | Manufacturer PartNumber | N/A | N/A | |
2.8 | ItemUnitPrice | Mandatory | ORDERITEMS | PRICE |
2.8.A1 | currency | Attribute | ORDERITEMS | CURRENCY |
2.9 | TaxInfo | first repeated occurrence | N/A | N/A |
2.9.1 | Monetary Amount | first repeated occurrence | N/A | N/A |
2.9.1.A1 | currency | attribute | N/A | N/A |
2.9.2 | TaxType | N/A | N/A | |
2.9.3 | Percentage | N/A | N/A | |
2.9.4 | TaxExemption StatusType | N/A | N/A | |
2.9.5 | TaxExemption Number | N/A | N/A | |
2.9.6 | TaxJurisdiction Code | N/A | N/A | |
2.9.7 | TaxJurisdiction CodeType | N/A | N/A | |
2.10 | ItemProduct Quantity | Mandatory | ORDERITEMS | QUANTITY |
2.11 | UnitOf Measure | N/A | N/A | |
2.12 | Classification | N/A | N/A | |
2.13 | ItemProduct ShortDescription | CATENTDESC | SHORTDESCRIPTION | |
2.14 | Instruction | N/A | N/A | |
2.15 | ShipToInfo | N/A | N/A | |
2.15.1 | ContactPerson Name | Mandatory | N/A | N/A |
2.15.1.1 | Title | N/A | N/A | |
2.15.1.2 | FullName | Mandatory | N/A | N/A |
2.15.1.3 | LastName | Mandatory | ADDRESS | LASTNAME |
2.15.1.4 | FirstName | ADDRESS | FIRSTNAME | |
2.15.1.5 | MiddleName | ADDRESS | MIDDLENAME | |
2.15.1.6 | AlternateName | ADDRESS | NICKNAME | |
2.15.2 | Office AddressLine | not supported for this version | N/A | N/A |
2.15.3 | Address | N/A | N/A | |
2.15.3.1 | AddressLine | Mandatory; first repeated occurrence | ADDRESS | ADDRESS1 |
2.15.3.1 | AddressLine | second repeated occurrence | ADDRESS | ADDRESS2 |
2.15.3.1 | AddressLine | third repeated occurrence | ADDRESS | ADDRESS3 |
2.15.3.2 | City | Mandatory | ADDRESS | CITY |
2.15.3.3 | State | Mandatory | ADDRESS | STATE |
2.15.3.4 | Zip | Mandatory | ADDRESS | ZIPCODE |
2.15.3.5 | Country | Mandatory | ADDRESS | COUNTRY |
2.15.4 | ContactInfo | Mandatory | N/A | N/A |
2.15.4.1 | Telephone | first repeated occurrence | ADDRESS | PHONE1 |
2.15.4.1 | Telephone | second repeated occurrence | ADDRESS | PHONE2 |
2.15.4.2 | first repeated occurrence | ADDRESS | EMAIL1 | |
2.15.4.2 | second repeated occurrence | ADDRESS | EMAIL2 | |
2.15.4.3 | Fax | ADDRESS | FAX1 | |
2.15.5 | Comment | ORDERITEMS | COMMENTS | |
2.16 | Shipping CarrierInfo | N/A | N/A | |
2.16.1 | Carrier | Mandatory | SHIPMODE | CARRIER |
2.16.2 | Method | Mandatory | SHIPMODE | CODE |
2.17 | ShipStatus | ORDERITEMS | STATUS | |
2.18 | DateTime Reference | Mandatory | N/A | N/A |
2.18.1 | PlacedDate | Mandatory | ORDERITEMS | LASTCREATE |
2.18.2 | PlacedTime | ORDERITEMS | LASTCREATE | |
2.18.3 | LastUpdate Date | ORDERITEMS | LASTUPDATE | |
2.18.4 | LastUpdate Time | ORDERITEMS | LASTUPDATE | |
2.19 | Product Measurement | N/A | N/A | |
2.20 | BuyOrg Accounting Detail | first repeated occurrence | N/A | N/A |
2.20.1 | Percentage | N/A | N/A | |
2.20.2 | Monetary Amount | N/A | N/A | |
2.20.2.A1 | currency | Attribute | N/A | N/A |
2.20.3 | BudgetCode | Mandatory | N/A | N/A |
2.20.4 | Description | N/A | N/A | |
2.20.5 | Calculation Code | Mandatory | N/A | N/A |
2.21 | Service Allowance Charge | first repeated occurrence | N/A | N/A |
2.21.1 | Allowance ChargeCode | Mandatory | N/A | N/A |
2.21.2 | Percentage | N/A | N/A | |
2.21.2 | Monetary Amount | N/A | N/A | |
2.21.2.A1 | currency | Attribute | N/A | N/A |
2.21.3 | Description | N/A | N/A | |
2.21.4 | Calculation Code | Mandatory | N/A | N/A |
2.22 | ItemShipping Schedule | N/A | N/A | |
2.22.1 | Quantity | Mandatory | N/A | N/A |
2.22.2 | ShipDate Reference | Mandatory | N/A | N/A |
2.22.2.1 | Requested ShipDate | N/A | N/A | |
2.22.2.1 | Scheduled ShipDate | N/A | N/A | |
2.22.2.3 | ActualShip Date | N/A | N/A | |
2.23 | ItemCustomer Field | first repeated occurrence | ORDERITEMS | FIELD1 |
2.23 | ItemCustomer Field | second repeated occurrence | ORDERITEMS | FIELD2 |
2.24 | UserData | N/A | N/A |