Integrated Cart with PO Service cXML Technical Specification

Article Contents

Process Flow

Process Steps

Data Definitions – Integrated Cart

Sample XML Transactions – Integrated Cart

Process Steps – PO Service

Business Assumptions – PO Service

Data Definitions – PO Service

Sample XML Transactions – PO Service

Overview

This document contains the processing flow, field definitions, and general information necessary in order to design an Integrated Cart between the ESM Solutions (ESM) Purchase application and a third-party ERP.  The Integration Notes section provides important design guidelines that ESM Solutions follows.  The Process Flow sections describe the life cycles of the various transactions across the two systems.  The Data Definitions sections provides a list of supported XML fields, and the Sample XML Transactions section illustrates example formats in which they might be used.  The formats and methodologies in this document are based on the cXML 1.2.023 standard.  For more information on cXML, visit the www.cxml.org web site.

Process Flow

Process Steps

The user initiates a “punch-out” action from within the ERP application.

The ERP application generates a “PunchoutSetupRequest” XML document, and posts it to the ESM server (via a synchronous server-to-server streamed XML post).

The ESM server validates the credentials, generates a user session, and responds synchronously to the post with a shopping cart URL.

The ERP system navigates the client browser (via a pop-up or within a frame) to the provided cart URL

The user builds a shopping cart within the ESM Shopping Cart site.  Data values visible to the user in the UI are:

Item Name

Product Description

Supplier Name

Manufacturer Name

Manufacturer Part #

Catalog Item #

Unit of Measure

Catalog Name

Contract name

Contract #

Quantity

Unit Price

The user selects the “Continue” Button.

The ESM system posts the cart XML to the ERP system URL provided in the original “PunchoutSetupRequest” document.

The ERP application processes the cart XML, creating a local copy of the cart, and responds synchronously to the web post with a success or failure XML message.

Data Definitions – Integrated Cart

NAME	Description	Data Type	Length	Used In Documents	Required/Optional
Header/From/Credential/Identity	ESM’s Customer ID for the buying entity	nvarchar	500	ICPunchOutSetupRequest	Required
Header/From/Credential/Domain		nvarchar	-	ICPunchOutSetupRequest	Required
Header/To/Credential/Identity	ESM’s User ID for the purchaser	nvarchar	500	ICPunchOutSetupRequest	Required
Header/Sender/Credential/Identity	ESM’s Customer ID for the buying entity	nvarchar	500	ICPunchOutSetupRequest	Required
Header/Sender/Credential/SharedSecret	ESM’s password for the purchaser	nvarchar	500	ICPunchOutSetupRequest	Required
Request/ PunchOutSetupRequest/Operation	Operation to be performed (CREATE)	nvarchar	20	ICPunchOutSetupRequest	Required
Request/ PunchOutSetupRequest/BuyerCookie	Unique ID provided by the purchaser	nvarchar	255	ICPunchOutSetupRequest	Required
Request/ PunchOutSetupRequest/Extrinsic/UserEmail	User's Email Address	nvarchar	100	ICPunchOutSetupRequest	Required
Request/ PunchOutSetupRequest/Extrinsic/UserFirstName	User's First Name	nvarchar	50	ICPunchOutSetupRequest	Required
Request/ PunchOutSetupRequest/Extrinsic/UserLastName	User's Last Name	nvarchar	50	ICPunchOutSetupRequest	Required
Request/ PunchOutSetupRequest/BrowserFormPost/URL	URL for Final Shopping cart post	nvarchar	500	ICPunchOutSetupRequest	Required
Response/Status/Code	Response Code to indicate success, Failures, etc	nvarchar	20	ICPunchOutSetupResponse	Required
Response/Status/Text	Response Text to indicate success, Failures, etc	nvarchar	20	ICPunchOutSetupResponse	Required
Response/ PunchOutSetupResponse/StartPage/URL	URL for users Shopping Cart Experience	nvarchar	500	ICPunchOutSetupResponse	Optional
Header/From/Credential/Identity	ESM’s User ID for the purchaser	nvarchar	500	ICPunchOutCartRequest	Required
Header/To/Credential/Identity	ESM’s Customer ID for the buying entity	nvarchar	500	ICPunchOutCartRequest	Required
Header/Sender/Credential/Identity	ESM’s User ID for the purchaser	nvarchar	500	ICPunchOutCartRequest	Required
Message/PunchOutOrderMessage/BuyerCookie	Unique ID provided by the purchaser	nvarchar	255	ICPunchOutCartRequest	Required
Message/PunchOutOrderMessage/PunchOutOrderMessageHeader/OperationAllowed	Operation to be performed (CREATE)	nvarchar	20	ICPunchOutCartRequest	Required
Message/PunchOutOrderMessage/PunchOutOrderMessageHeader/Total/Money	Total price of all items in the Cart in Currency USD	decimal	(18,6)	ICPunchOutCartRequest	Required
Message/PunchOutOrderMessage/ ItemIn/Quantity	Quantity requested for a cart item	integer	7	ICPunchOutCartRequest	Required
Message/PunchOutOrderMessage/ItemIn/ItemID/SupplierPartID	Suppliers identifier for a cart item	nvarchar	255	ICPunchOutCartRequest	Required
Message/PunchOutOrderMessage/ItemIn/ItemID/SupplierPartAuxiliaryID	Supplier generated key that identifies a cart item uniquely when combined with SupplierPartID	nvarchar	255	ICPunchOutCartRequest	Required
Message/PunchOutOrderMessage/ItemIn/ItemDetail/UnitPrice/Money	Unit price for a cart item	decimal	(18,6)	ICPunchOutCartRequest	Required
Message/PunchOutOrderMessage/ItemIn/ItemDetail/Description	Description for a cart item	nvarchar	Max	ICPunchOutCartRequest	Required
Message/PunchOutOrderMessage/ItemIn/ItemDetail/UnitofMeasure	Unit of measure for a cart item	nvarchar	32	ICPunchOutCartRequest	Required
Message/PunchOutOrderMessage/ItemIn/ItemDetail/Classification/Domain	Classification domain for a cart item	nvarchar	255	ICPunchOutCartRequest	Required
Message/PunchOutOrderMessage/ItemIn/ItemDetail/Classification	Classification for a cart item	nvarchar	255	ICPunchOutCartRequest	Required
Message/PunchOutOrderMessage/ItemIn/ItemDetail/ManufacturerPartID	Manufacturer’s item number for a cart item	nvarchar	255	ICPunchOutCartRequest	Optional
Message/PunchOutOrderMessage/ItemIn/ItemDetail/ManufacturerName	Name of manufacturer for a cart item	nvarchar	1000	ICPunchOutCartRequest	Optional
Message/PunchOutOrderMessage/ItemIn/ItemDetail/URL	Cart item URL	nvarchar	200	ICPunchOutCartRequest	Optional
Message/PunchOutOrderMessage/ItemIn/ItemDetail/Extrinsic/RequisitionID	ID of Requisition created for this cart in ESM	integer	10	ICPunchOutCartRequest	Required
Message/PunchOutOrderMessage/ItemIn/ItemDetail/Extrinsic/RequisitionItemID	ID of Requisition Item created for this cart item in ESM	integer	10	ICPunchOutCartRequest	Required
Message/PunchOutOrderMessage/ItemIn/ItemDetail/Extrinsic/ShippingPercentage	Shipping Percentage for each cart item	decimal	(18,6)	ICPunchOutCartRequest	Optional
Message/PunchOutOrderMessage/ItemIn/ItemDetail/Extrinsic/SupplierID	ID of Supplier created inside Easy Purchase	integer	10	ICPunchOutCartRequest	Required
Message/PunchOutOrderMessage/ItemIn/ItemDetail/Extrinsic/GLSupplierID	ID of Supplier created inside Customer’s General Ledger system	nvarchar	20	ICPunchOutCartRequest	Required
Message/PunchOutOrderMessage/ItemIn/ItemDetail/Extrinsic/SupplierName	Name of Supplier created  in ESM Application	nvarchar	255	ICPunchOutCartRequest	Required
Message/PunchOutOrderMessage/ItemIn/ItemDetail/Extrinsic/CatalogID	ID of Supplier Catalog created inside Easy Purchase	integer	10	ICPunchOutCartRequest	Required
Message/PunchOutOrderMessage/ItemIn/ItemDetail/Extrinsic/CatalogName	Name of Catalog created  in ESM Application	nvarchar	50	ICPunchOutCartRequest	Required

Sample XML Transactions – Integrated Cart

Punchout Setup Request - CREATE from ERP

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE cXML SYSTEM "http://xml.cXML.org/schemas/cXML/1.2.023/cXML.dtd">

<cXML payloadID="1233444-200@ariba.acme.com" timestamp="1999-03-12T18:39:09-08:00">

  <Header>

    <From>

      <Credential domain="NetworkId">

        <Identity>PPD-123</Identity>

      </Credential>

    </From>

    <To>

      <Credential domain="DUNS">

        <Identity>ik</Identity>

      </Credential>

    </To>

    <Sender>

      <Credential domain="NetworkId">

        <Identity>PPD-123</Identity>

        <SharedSecret>PPD-345</SharedSecret>

      </Credential>

      <UserAgent>IC Test entity user agent</UserAgent>

    </Sender>

  </Header>

  <Request>

    <PunchOutSetupRequest operation="create">

      <BuyerCookie>34234234ADFSDF234234</BuyerCookie>

      <Extrinsic name="UserEmail">ppd@esmsolutions.com</Extrinsic>

      <Extrinsic name="UserFirstName">Pravin</Extrinsic>

      <Extrinsic name="UserLastName">Pawar</Extrinsic>

      <BrowserFormPost>

        <URL>http://192.168.1.37:804/home/receivecartrequest</URL>

      </BrowserFormPost>

    </PunchOutSetupRequest>

  </Request>

</cXML>

 

Punch-Out Setup Response - CREATE from ESM

<?xml version="1.0" encoding="utf-8" >

<!DOCTYPE cXML SYSTEM "http://xml.cXML.org/schemas/cXML/1.2.023/cXML.dtd">

<cXML timestamp="2013-01-18T16:00:26" payloadID="5377558e-f6b9-4926-bd2a-62fbe6050740">

   <Response>

      <Status code="200" text="OK"/>

       <PunchOutSetupResponse>

        <StartPage>

         <URL>https://epmqa.esmsolutions.com/IntegratedCart/AutoLoginForIntegratedCart?token=3c24a244-0406-47aa-ba2c- 22efcb20a743</URL>

   </StartPage>

  </PunchOutSetupResponse>

 </Response>

</cXML>

 

Shopping Cart Request - CREATE from ESM

<?xml version="1.0" encoding="utf-8" >

<!DOCTYPE cXML SYSTEM "http://xml.cXML.org/schemas/cXML/1.2.023/cXML.dtd">

<cXML timestamp="2013-01-21T10:43:20" payloadID="f601d58b-8578-43c4-bbca-669f487549bb">

  <Header>

    <From>

      <Credential domain="DUNS">

        <Identity>132443859</Identity>

      </Credential>

    </From>

    <To>

      <Credential domain="NetworkId">

        <Identity>PPD-123</Identity>

      </Credential>

    </To>

    <Sender>

      <Credential domain="DUNS">

        <Identity>132443859</Identity>

      </Credential>

      <UserAgent>ESMPunchOut v1.0</UserAgent>

    </Sender>

  </Header>

  <Message>

    <PunchOutOrderMessage>

      <BuyerCookie>34234234ADFSDF234234</BuyerCookie>

      <PunchOutOrderMessageHeader operationAllowed="create">

        <Total>

          <Money currency="USD">1.160000</Money>

        </Total>

      </PunchOutOrderMessageHeader>

      <ItemIn Quantity="1">

        <ItemID>

          <SupplierPartID>01280000043</SupplierPartID>

          <SupplierPartAuxiliaryID>123</SupplierPartAuxiliaryID>

        </ItemID>

        <ItemDetail>

          <UnitPrice>

            <Money currency="USD">0.240000</Money>

          </UnitPrice>

          <Description xml:lang="en-US">

Multi-purpose Standard Cell Size Batteries: Type - Non-Rechargeable Battery; Chemical System - Alkaline; Cell Size - AA; Voltage - 1.5V; Capacity - 2500 mAh; Terminals - Flat Terminals; Height - 1.98"H; Diameter - 0.56"Dia; Package Quantity - 6; Manufacturer Series - Ultra Pro™

          </Description>

          <UnitOfMeasure>Each</UnitOfMeasure>

          <Classification domain="UNSPSC">12345 </ Classification >

          <ManufacturerPartID>AL-AA</ManufacturerPartID>

          <ManufacturerName>Some Manufacturer</ManufacturerName>

          <URL>http://www.wescodirect.com/wescodirect/images/products/large/ray_alaa.jpg</URL>

          <Extrinsic name="RequisitionId">4128</Extrinsic>

          <Extrinsic name="RequisitionItemId">34</Extrinsic>

          <Extrinsic name="ShippingPercentage">10.000000</Extrinsic>

          <Extrinsic name="SupplierId">23</Extrinsic>

          <Extrinsic name="GLSupplierId">23nj435</Extrinsic>

          <Extrinsic name="SupplierName">Supplier Name</Extrinsic>

          <Extrinsic name="CatalogId">2</Extrinsic>

          <Extrinsic name="CatalogName">Catalog Name</Extrinsic>

        </ItemDetail>

      </ItemIn>

      <ItemIn Quantity="2">

        <ItemID>

          <SupplierPartID>01280014597</SupplierPartID>

          <SupplierPartAuxiliaryID>456</SupplierPartAuxiliaryID>

        </ItemID>

        <ItemDetail>

          <UnitPrice>

            <Money currency="USD">0.460000</Money>

          </UnitPrice>

          <Description xml:lang="en-US">

Bulbs: Bulb Type - Standard; Primary Application - Flashlight; No. of Cells - 2; Battery Type - D; Base - Flanged; Package - 1

          </Description>

          <UnitOfMeasure>Each</UnitOfMeasure>

          <Classification domain="UNSPSC">34567</Classification>

          <ManufacturerPartID>PR6-BULB</ManufacturerPartID>

          <ManufacturerName>Some Manufacturer</ManufacturerName>

          <URL>http://www.wescodirect.com/wescodirect/images/products/large/78280014597pcds.jpg</URL>

          <Extrinsic name="RequisitionId">4128</Extrinsic>

          <Extrinsic name="RequisitionItemId">354</Extrinsic>

          <Extrinsic name="ShippingPercentage">10.000000</Extrinsic>

          <Extrinsic name="SupplierId">23</Extrinsic>

          <Extrinsic name="GLSupplierId">23nj4353e3</Extrinsic>

          <Extrinsic name="SupplierName">Supplier Name</Extrinsic>

          <Extrinsic name="CatalogId">2</Extrinsic>

          <Extrinsic name="CatalogName">Catalog Name</Extrinsic>

        </ItemDetail>

      </ItemIn>

    </PunchOutOrderMessage>

  </Message>

</cXML>

 

Shopping Cart Response - CREATE from ERP

<html>

<head>

</head>

<body onload="javascript:close()" bgcolor="#ffffff" text="#000000" topmargin="0">

    <table width="100%" height="100%">

        <tr valign="center">

            <td align="center">

                <table>

                    <tr height="24">

                        <td align="center">

                            <font face="Arial" size="2">Your shopping cart has been successfully exported into vendor's Marketplace. </font>

                        </td>

                    </tr>

                    <tr height="24">

                        <td align="center">

                            <font face="Arial" size="2">You may now close this window. </font>

                        </td>

                    </tr>

                </table>

            </td>

        </tr>

    </table>

</body>

</html>

 

Process Steps – PO Service

The user submits their requisition through the ERP system for approval. 

Once final approval is achieved in the ERP  the requistion will be approved as a purchase order and flagged for transmission through the ESM Solutions PO Service Module. 

ERP will pass all relevent purchase order information to ESM Solutions using the PO Transmission Data specification detailed below.

Once the ESM Solutions PO Service receives the information it will leverage the existing ESM Solutions electronic supplier transmission methods that are in place which include Email and PO XML.

The ESM Solutions system will reply with a succes/failure message based on the requisition information transmitted.

Upon transmission of the PO information to the Supplier, the ESM Solutions system will email a po confirmation back to the purchasing department. 

 

Business Assumptions – PO Service

The PO Service will only work for requisition items that were created from the ESM Solutions Supplier Catalogs.

Upon implementation, the ship-to address information will be manually populated in the ESM Solutions system with the same address information that exists in the General Ledger  system.  This address information will be shared with the ESM Solutions vendors for mapping purposes. 

An email service will be used to communicate to the customer that a purchase order was created and transmitted.

ERP system  will ensure that the user who is creating and issuing the purchase order will know that the po is being released through the ESM Solutions PO service which will be different from other purchase orders that are created in the native ERP system.

 

Data Definitions – PO Service

NAME	Description	Data Type	Length	Used In Documents	Required/Optional
Header/From/Credential/Identity	ESM’s Customer ID for the buying entity	nvarchar	500	ICPunchOutOrderRequest	Required
Header/From/Credential/Domain		nvarchar	-	ICPunchOutOrderRequest	Required
Header/To/Credential/Identity	ESM’s User ID for the purchaser	nvarchar	500	ICPunchOutOrderRequest	Required
Header/Sender/Credential/Identity	ESM’s Customer ID for the buying entity	nvarchar	500	ICPunchOutOrderRequest	Required
Header/Sender/Credential/SharedSecret	ESM’s password for the purchaser	nvarchar	500	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/OrderID	The identifier for this order. Analogous to the purchase order number.	Integer	10	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/OrderDate	The date and time this order was placed	datetime	20	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/Type	Type of the request: new (default), update, or delete.  Note: Update and Delete are not supported at this time	Integer	10	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/Total/Money	Total dollar amount for PO	Decimal	(18,6)	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/ShipTo/Address/AddressID	Unique Identifier for the Shipping  location	nvarchar	20	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/ShipTo/Address/Name	Customer delivery building name	nvarchar	50	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/ShipTo/Address/PostalAddress/DeliverTo	Customer delivery building contact name	nvarchar	110	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/ShipTo/Address/PostalAddress/Street	Customer delivery building address (Street1)	nvarchar	50	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/ShipTo/Address/PostalAddress/Street	Customer delivery building address (Street2)	nvarchar	50	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/ShipTo/Address/PostalAddress/City	Customer delivery building address (City)	nvarchar	30	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/ShipTo/Address/PostalAddress/State	Customer delivery building address (State)	nvarchar	100	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/ShipTo/Address/PostalAddress/PostalCode	Customer delivery building address (Postal Code)	nvarchar	15	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/ShipTo/Address/PostalAddress/Country	Customer delivery building address (Country)	nvarchar	100	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/ShipTo/Address/Email	Customer delivery building contact email	nvarchar	100	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/ShipTo/Address/Phone/TelephoneNumber/CountryCode	Customer delivery building contact phone (Country code). Send fixed value “1”.	integer	10	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/ShipTo/Address/Phone/TelephoneNumber/AreaOrCityCode	Customer delivery building contact phone (Area code)	integer	10	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/ShipTo/Address/Phone/TelephoneNumber/Number	Customer delivery building contact phone (Number)	nvarchar	50	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/BillTo/Address/AddressID	Unique Identifier for the Billing location	nvarchar	20	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/BillTo/Address/Name	Customer billing building name	nvarchar	50	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/BillTo/Address/PostalAddress/DeliverTo	Customer billing  building contact name	nvarchar	110	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/BillTo/Address/PostalAddress/Street	Customer billing  building address (Street1)	nvarchar	50	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/BillTo/Address/PostalAddress/Street	Customer billing  building address (Street2)	nvarchar	50	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/BillTo/Address/PostalAddress/City	Customer billing  building address (City)	nvarchar	30	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/BillTo/Address/PostalAddress/State	Customer billing  building address (State)	nvarchar	100	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/BillTo/Address/PostalAddress/PostalCode	Customer billing  building address (Postal Code)	nvarchar	15	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/BillTo/Address/PostalAddress/Country	Customer billing  building address (Country)	nvarchar	100	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/BillTo/Address/Email	Customer billing  building contact email	nvarchar	100	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/BillTo/Address/Phone/TelephoneNumber/CountryCode	Customer billing building contact phone (Country code). Send fixed value “1”.	integer	10	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/BillTo/Address/Phone/TelephoneNumber/AreaOrCityCode	Customer billing  building contact phone (Area code)	integer	10	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/BillTo/Address/Phone/TelephoneNumber/Number	Customer billing  building contact phone (Number)	nvarchar	50	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/Shipping/Money	Purchase Order shipping charge	Decimal	(18,6)	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/Shipping/Description	Purchase Order shipping description. Send a fixed value “Shipping”.	nvarchar	20	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/Tax/Money	Purchase Order tax charge	Decimal	(18,6)	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/Tax/Description	Purchase Order tax description. Send a fixed value “State Tax”.	nvarchar	20	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/Payment/PCard/Number	Credit card number	nvarchar	20	ICPunchOutOrderRequest	Optional
Request/OrderRequest/OrderRequestHeader/Payment/PCard/Expiration	Credit card expiration date	DateTime	20	ICPunchOutOrderRequest	Optional
Request/OrderRequest/OrderRequestHeader/Payment/PCard/Name	Credit card name	nvarchar	100	ICPunchOutOrderRequest	Optional
Request/OrderRequest/OrderRequestHeader/Comments	User comments or instructions	nvarchar	500	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/Extrinsic/UserEmail	User's Email Address	nvarchar	100	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/Extrinsic/UserFirstName	User's First Name	nvarchar	50	ICPunchOutOrderRequest	Required
Request/OrderRequest/OrderRequestHeader/Extrinsic/UserLastName	User's Last Name	nvarchar	50	ICPunchOutOrderRequest	Required
Request/OrderRequest/ItemOut/Quantity	Number of units of item ordered	Integer	7	ICPunchOutOrderRequest	Required
Request/OrderRequest/ItemOut/RequestedDeliveryDate	The date by which order should be delivered	DateTime	20	ICPunchOutOrderRequest	Optional
Request/OrderRequest/ItemOut/ItemID/SupplierPartID	Supplier Item ID	nvarchar	255	ICPunchOutOrderRequest	Required
Request/OrderRequest/ItemOut/ItemID/SupplierPartAuxiliaryID	Supplier generated key that identifies an item uniquely when combined with SupplierPartID	nvarchar	255	ICPunchOutOrderRequest	Required
Request/OrderRequest/ItemOut/ItemDetail/UnitPrice/Money	Price of item per unit	Decimal	(18,6)	ICPunchOutOrderRequest	Required
Request/OrderRequest/ItemOut/ItemDetail/Description	Textual description of item	nvarchar	max	ICPunchOutOrderRequest	Required
Request/OrderRequest/ItemOut/ItemDetail/UnitOfMeasure	Item’s unit of measure	nvarchar	32	ICPunchOutOrderRequest	Required
Request/OrderRequest/ItemOut/ItemDetail/Classification/Domain	Item’s Classification domain	nvarchar	255	ICPunchOutOrderRequest	Required
Request/OrderRequest/ItemOut/ItemDetail/Classification/Domain	Item’s Classification	nvarchar	255	ICPunchOutOrderRequest	Required
Request/OrderRequest/ItemOut/ItemDetail/ManufacturerPartID	Manufacturer Part Number	nvarchar	255	ICPunchOutOrderRequest	Optional
Request/OrderRequest/ItemOut/ItemDetail/ManufacturerName	Name of Manufacturer	nvarchar	1000	ICPunchOutOrderRequest	Optional
Request/OrderRequest/ItemOut/ItemDetail/Extrinsic/RequisitionID	RequisitionID provided by ESM for the item	integer	10	ICPunchOutOrderRequest	Required
Request/OrderRequest/ItemOut/ItemDetail/Extrinsic/RequisitionItemID	RequisitionItemID provided by ESM for the item	integer	10	ICPunchOutOrderRequest	Required
Request/OrderRequest/ItemOut/Contact/Name	Desktop Deliver-to person’s name	nvarchar	50	ICPunchOutOrderRequest	Optional
Request/OrderRequest/ItemOut/Comments	User comments or instructions	nvarchar	500	ICPunchOutOrderRequest	Optional
Response/Status/Code	Response Code to indicate success, Failures, etc	nvarchar	20	ICPunchOutOrderResponse	Required
Response/Status/Text	Response Text to indicate success, Failures, etc	nvarchar	20	ICPunchOutOrderResponse	Required

 

Sample XML Transactions – PO Service

Sample Order Request XML

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE cXML SYSTEM "http://xml.cXML.org/schemas/cXML/1.2.023/cXML.dtd">

<cXML payloadID="1233444-200@ariba.acme.com" timestamp="1999-03-12T18:39:09-08:00">

    <Header>

        <From>

            <Credential domain=" NetworkId ">               

                                            <Identity>PPD-123</Identity>

            </Credential>                                                                                                              

        </From>

        <To>

            <Credential domain="DUNS">

                                            <Identity>jk</Identity>                                                          

            </Credential>

        </To>

        <Sender>

            <Credential domain=" NetworkId ">               

<Identity> PPD-123</Identity>

                                            <SharedSecret> PPD-345</SharedSecret>

                                            </Credential>

            <UserAgent> IC Test entity user agent </UserAgent>

        </Sender>

    </Header>

    <Request>

        <OrderRequest>

             <OrderRequestHeader orderID="DO1234" orderDate="1999-03-12T18:41:29-08:00" type="new">

                 <Total>

                     <Money currency="USD">2.68</Money>

                 </Total>

                 <ShipTo>

                     <Address addressID="123" isoCountryCode="US">

                         <Name xml:lang="en">Acme</Name>

                         <PostalAddress name="default">

                             <DeliverTo>Joe Smith</DeliverTo>

                             <Street>123 Anystreet</Street>

                                                         <Street>Some Boulevard</Street>

                             <City>Sunnyvale</City>

                             <State>CA</State>

                             <PostalCode>90489</PostalCode>

                             <Country isoCountryCode="US">United States</Country>

                         </PostalAddress>

                                                     <Email name="Office">a@a.com</Email>

         <Phone name="Office">

                                                         <TelephoneNumber>

                                            <CountryCode isoCountryCode="US">1</CountryCode>

                                                                                                                                            <AreaOrCityCode>201</AreaOrCityCode>

                                                                                                                                            <Number>456789</Number>                                                                                                                                                                                                                   

                                                         </TelephoneNumber>

                                                     </Phone>

                     </Address>

                 </ShipTo>

                 <BillTo>

                     <Address addressID="123" isoCountryCode="US">

                         <Name xml:lang="en">Acme</Name>

                         <PostalAddress name="default">

                             <Street>123 Anystreet</Street>

                                                         <Street>Some Boulevard</Street>

                             <City>Sunnyvale</City>

                             <State>CA</State>

                             <PostalCode>90489</PostalCode>

                             <Country isoCountryCode="US">United States</Country>

                         </PostalAddress>

                                                     <Email name="Office">a@a.com</Email>

             <Phone name="Office">

                                                                                                                                            <TelephoneNumber>

                                                                                                                                                <CountryCode isoCountryCode="US">1</CountryCode>

                                                                                                                                                <AreaOrCityCode>201</AreaOrCityCode>

                                                                                                                                                <Number>456789</Number>                                                                                                                                                                                                                               

                                                                                                                                            </TelephoneNumber>

                                                         </Phone>

                     </Address>

                 </BillTo>

                                            <Shipping>

                                                 <Money currency="USD">0.19</Money>

                     <Description xml:lang="en">Shipping</Description>

                                            </Shipping>

                 <Tax>

                     <Money currency="USD">0.19</Money>

                     <Description xml:lang="en">State Tax</Description>

                 </Tax>

                 <Payment>

                     <PCard number="1234567890123456" expiration="1999-03-12" name="John Smith"/>

                 </Payment>

                 <Comments>Anything well formed in XML can go here.</Comments>           

                 <Extrinsic name="UserEmail">ppd@esmsolutions.com</Extrinsic>

                 <Extrinsic name="UserFirstName">Pravin</Extrinsic>

                 <Extrinsic name="UserLastName">Pawar</Extrinsic>                                         

             </OrderRequestHeader>

             <ItemOut quantity="2" requestedDeliveryDate="1999-03-12">

                 <ItemID>

                     <SupplierPartID>1233244</SupplierPartID>

                                                 <SupplierPartAuxiliaryID>supplier cookie to describe configuration options on this item</SupplierPartAuxiliaryID>

                 </ItemID>

                 <ItemDetail>

                     <UnitPrice>

                     <Money currency="USD">1.34</Money>

                     </UnitPrice>

                     <Description xml:lang="en">hello</Description>

                     <UnitOfMeasure>EA</UnitOfMeasure>

                     <Classification domain="UNSPSC">12345</Classification>

                     <ManufacturerPartID>234</ManufacturerPartID>

                     <ManufacturerName>foobar</ManufacturerName>

                                                 <Extrinsic name="RequisitionId">12</ Extrinsic >

                                                 <Extrinsic name="RequisitionItemId">132</ Extrinsic >

                 </ItemDetail>

                                            <Contact>

                     <Name xml:lang="en">Acme</Name>

                                             </Contact>

                 <Comments>Anything well formed in XML can go here.</Comments>

             </ItemOut>

             <ItemOut quantity="5" requestedDeliveryDate="1999-03-12">

                 <ItemID>

                     <SupplierPartID>1566</SupplierPartID>

     <SupplierPartAuxiliaryID>supplier cookie to describe configuration options on this item</SupplierPartAuxiliaryID>

                 </ItemID>

                 <ItemDetail>

                     <UnitPrice>

                     <Money currency="USD">1.34</Money>

                     </UnitPrice>

                     <Description xml:lang="en">hello</Description>

                     <UnitOfMeasure>EA</UnitOfMeasure>

                     <Classification domain="UNSPSC">12345</Classification>

                     <ManufacturerPartID>234</ManufacturerPartID>

                     <ManufacturerName>foobar</ManufacturerName>

                                                 <Extrinsic  name="RequisitionId">12</ Extrinsic >

                                                 <Extrinsic name="RequisitionItemId">135</ Extrinsic >

                 </ItemDetail>

                                            <Contact>

                     <Name xml:lang="en">Acme</Name>

                                            </Contact>

                 <Comments>Anything well formed in XML can go here.</Comments>

             </ItemOut>

          </OrderRequest>

    </Request>

</cXML>

 

Sample Order Acknowledgement XML (successful)

<?xml version="1.0" encoding="UTF-8"?>

<cXML timestamp="2001-10-31T23:07:22-08:00" payloadID="1004598442900-8367273815197467070@10.10.13.100">

                                            <Response>

                                            <Status code="201" text="Accepted">Acknowledged</Status>

                                            </Response>

</cXML>

 

Sample Order Acknowledgement XML (unsuccessful)

<?xml version="1.0" encoding="UTF-8"?>

<cXML timestamp="2001-10-31T23:07:22-08:00" payloadID="1004598442900-8367273815197467070@10.10.13.100">

                                            <Response>

                                            <Status code="401" text="Rejected">Customer Id not recognized</Status>

                                            </Response>

</cXML>