Skip to main content

 

Buyerquest Community

Punchout To Supplier cXML - Punchout Setup Request (POSR) and Punchout Order Message (POOM)

  1. Last updated
  2. Save as PDF
This topic details the data elements for cXML Punchout Setup Requests (POSR) and Punchout Order Messages (POOM) to and from suppliers.

Punchout to Supplier - cXML (POSR)  

The Punchout Setup Request (POSR) is detailed below and specifies element name, location, and sample value. 

Element  Element Location Is Configurable Sample Element Value
<From>       <Credential domain=""> Navigate to Menu > Suppliers > Punchout Connections > Connections Information and add/update the From Credential Domain field Yes NetworkId
 <From>
        <Identity>{Element Value}</Identity>
 Navigate to Menu > Suppliers > Punchout Connections > Connections Information and add/update the From ID field Yes MCDPUNCHOUT
<To>
      <Credential domain="">
 Navigate to Menu > Suppliers > Punchout Connections > Connections Information and add/update the To Credential Domain field Yes NetworkId
<To>
        <Identity>{Element Value}</Identity>
 Navigate to Menu > Suppliers > Punchout Connections > Connections Information and add/update the To ID field Yes 154484505
 <Sender>
      <Credential domain="">
   No (System Generated) NetworkId
<Sender>
        <Identity>{Element Value}</Identity>
       
 Navigate to Menu > Suppliers > Punchout Connections > Connections Information and add/update the Sender ID field Yes MCDPUNCHOUT
<Sender>
        <SharedSecret>{Element Value}</SharedSecret>
 Navigate to Menu > Suppliers > Punchout Connections > Connections Information and add/update the SharedSecret field Yes RRD2500
 <Sender>
      <UserAgent>{Element Value}</UserAgent>
   No (System Generated)  
 <PunchOutSetupRequest operation="{Element Value}">   No (System Generated)  
<PunchOutSetupRequest 
operation="create">
      <BuyerCookie>{Element Value}</BuyerCookie>
      
   No (System Generated) l8vjqubjj7abohgk6nlv3p8b83
<PunchOutSetupRequest operation="{Element Value}"> Navigate to Menu > Suppliers > Manage Punchout Connections > Edit a Connection (or create new) > Allow Cart Edit Yes Edit
<ItemOut quantity="2">
 <ItemID>
 <SupplierPartID>220-6338</SupplierPartID>
 <SupplierPartAuxiliaryID>
E000028901
 </SupplierPartAuxiliaryID>
 </ItemID>		   No (System Generated) For each item that was edited this element is added under 'SupplierSet up' element.The 'Quantity', 'ItemID', 'SupplierPartID', and 'SupplierPartAuxiliaryID' fields are also sent as shown
<PunchOutSetupRequest 
operation="create">
      <Extrinsic name="{Element Value}"></Extrinsic>
     
 Navigate to Menu > Suppliers > Punchout Connections > POSR Configuration and add/edit the Extrinsic section for the appropriate Element/Element Value.  Yes UserEmail
<PunchOutSetupRequest 
operation="create">
      <Extrinsic name="{Element Value}"/>
     
 Navigate to Menu > Suppliers > Punchout Connections > POSR Configuration and add/edit the Extrinsic section for the appropriate Element/Element Value. Yes UserId
<PunchOutSetupRequest 
operation="create">
      <Extrinsic name="{Element Value}"/>
     
 Navigate to Menu > Suppliers > Punchout Connections > POSR Configuration and add/edit the Extrinsic section for the appropriate Element/Element Value. Yes UniqueName
<PunchOutSetupRequest 
operation="create">
      <Extrinsic name="{Element Value}"/>
 Navigate to Menu > Suppliers > Punchout Connections > POSR Configuration and add/edit the Extrinsics section for the appropriate Element/Element Value. Yes OperatingUnit
<PunchOutSetupRequest 
operation="create">
      <BrowserFormPost>
         <URL>{Element Value}</URL>
   
   No (System Generated) https://uat.buyerquest.net/ middlemarch/punchoutclient/transactions/ cxmlresponse/
<PunchOutSetupRequest 
operation="">
      <Contact>
        <Name xml:lang="en-US">{Element Value}</Name>
       
 Navigate to Menu > Suppliers > Punchout Connections > POSR Configuration and add/edit the Contact section for the appropriate Element/Element Value. Yes ADMINISTRATOR SUPERUSER
<PunchOutSetupRequest 
operation="">
      <Contact>    
        <Email>{Element Value}</Email>
 
 Navigate to Menu > Suppliers > Punchout Connections > POSR Configuration and add/edit the Contact section for the appropriate Element/Element Value. Yes administrator@buyerquest.com
<PunchOutSetupRequest 
operation="">
     <SupplierSetup>
        <URL>{Element Value}</URL>
 Navigate to Menu > Suppliers > Punchout Connections > Connections Information and add/update the Start Url field Yes https://testcustompoint.rrd.com/xs2/ orders/punchout?eventID=EVT_ARIBA_CXML_REQ
<PunchOutSetupRequest operation="">
     <ShipTo>
        <Address addressID="{Element Value}">
         
 Navigate to Menu > Suppliers > Punchout Connections > POSR Configuration and add/edit the Ship To section for the appropriate Element/Element Value. Yes 100000
<ShipTo>
        <Address addressID="100000">
          <Name xml:lang="en">{Element Value}</Name>
         
 Navigate to Menu > Suppliers > Punchout Connections > POSR Configuration and add/edit the Ship To section for the appropriate Element/Element Value. Yes Global Headquarters 
<ShipTo>
        <Address addressID="100000">
          <PostalAddress>
           
 Navigate to Menu > Suppliers > Punchout Connections > POSR Configuration and add/edit the Ship To section for the appropriate Element/Element Value. Yes  
<ShipTo>
        <Address addressID="100000">
            <DeliverTo>{Element Value}</DeliverTo>
 
 Navigate to Menu > Suppliers > Punchout Connections > POSR Configuration and add/edit the Ship To section for the appropriate Element/Element Value. Yes  
<ShipTo>
        <Address addressID="100000">
            <Street>{Element Value}</Street>
           
 Navigate to Menu > Suppliers > Punchout Connections > POSR Configuration and add/edit the Ship To section for the appropriate Element/Element Value. Yes 343 West Bagley Road
<ShipTo>
        <Address addressID="100000">
            <DeliverTo/>
            <City>{Element Value}</City>
           
 Navigate to Menu > Suppliers > Punchout Connections > POSR Configuration and add/edit the Ship To section for the appropriate Element/Element Value. Yes Cleveland
<ShipTo>
        <Address addressID="100000">
            <DeliverTo/>
            <State>{Element Value}</State>
           
 Navigate to Menu > Suppliers > Punchout Connections > POSR Configuration and add/edit the Ship To section for the appropriate Element/Element Value. Yes OH
<ShipTo>
        <Address addressID="100000">
            <DeliverTo/>
            <PostalCode>{Element Value}</PostalCode>
           
 Navigate to Menu > Suppliers > Punchout Connections > POSR Configuration and add/edit the Ship To section for the appropriate Element/Element Value. Yes 44017
<ShipTo>
        <Address addressID="">
            <DeliverTo/>
            <Country isoCountryCode="{Element Value}"></Country>
       
 Navigate to Menu > Suppliers > Punchout Connections > POSR Configuration and add/edit the Ship To section for the appropriate Element/Element Value. Yes The Punchout Order Message (POOM) contains the shopping cart content that was created on the supplier PunchOut catalog site and consists of the Header and Message.

Punchout Setup Request (POSR) Sample 

<?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.1.007/cXML.dtd">
 <cXML version="1.1.007" xml:lang="en-US" payloadID="20120430080911.362825875.5652@opprod.aafes.com" timestamp="2012-04-30T08:09:11-06:00">
    <Header>
       <From>
          <Credential domain="NetworkID">
             <Identity>3590j9887b01D2</Identity>
          </Credential>
       </From>
       <To>
          <Credential domain="NetworkID">
             <Identity>BQ7617F45</Identity>
          </Credential>
       </To>
       <Sender>
          <Credential domain="NetworkID">
             <Identity>3590j9887b01D2</Identity>
             <SharedSecret>984J88re410m0</SharedSecret>
          </Credential>
          <UserAgent>GatewayTest</UserAgent>
       </Sender>
    </Header>
    <Request>
       <PunchOutSetupRequest operation="create">
          <BuyerCookie>6j91k8834p01213km874930902</BuyerCookie>
          <Extrinsic name="User">Y253690</Extrinsic>
          <BrowserFormPost>
             <URL>https://buyerquest.net/gate/index.php/admin/testconn/response/</URL>
          </BrowserFormPost>
       </PunchOutSetupRequest>
    </Request>
 </cXML>

Flow Diagram for Punchout Order Message (POOM)

The diagram included here shows the process of how the supplier cXML Punchout O rder Message (POOM) is translated to items in a user's cart.

For the following process to complete successfully, the Punchout WebClient cXML Web Form must be enabled and set up to accept/map the proper elements and element values that are passed in the Punchout Order Message (POOM).   

Screen Shot 2016-03-22 at 8_50_44 AM.png

Elements and Values in the Punchout Order Message

Element  Element Notes Sample Element Value
<From>       <Credential domain=""> This comes from the Punchout Setup Request (POSR)  NetworkId
 <From>
        <Identity>{Element Value}</Identity>
 This comes from the POSR 1234567
<To>
      <Credential domain="">
 This comes from the POSR NetworkId
<To>
        <Identity>{Element Value}</Identity>
 This comes from the POSR MCDPUNCHOUT
 <Sender>
      <Credential domain="">
   DUNS
<Sender>
        <Identity>{Element Value}</Identity>
 This comes from the POSR 1234567
 <Sender>
      <UserAgent>{Element Value}</UserAgent>
   @winXS 2.0
  <Message deploymentMode="{Element Value}" inReplyTo="{Element Value}"> System Generated  "test" "123456.6789@buyerquest.net"
<BuyerCookie>{Element Value}</BuyerCookie> System Generated 123abc
<PunchOutOrderMessageHeader operationAllowed="{Element Value}"> No (System Generated) edit
<PunchOutOrderMessageHeader operationAllowed="create">
      <Total>
           <Money currency="USD">{Element Value}</Money>
 Code: Money Type: Product Attribute: List Price Code: currency Type: Text -500.00
<ItemIn quantity="{Element Value}">
     		 Code: Quantity Type:  Quantity4Cart 1
<ItemID>   <SupplierPartID>{Element Value}</SupplierPartID> Code: SupplierPartID Type: Product Attribute: SKU 2031449A
<SupplierPartAuxiliaryID>{Element Value}</SupplierPartAuxiliaryID> Code: SupplierPartAuxiliaryID Type: Text X5477050001
<ItemDetail>
          <UnitPrice>
            <Money currency="{Element Value}">{Element Value}</Money>
          </UnitPrice>		 Code: Money Type: Product Attribute: List Price Code: currency Type: Text USD -500.00
<ItemDetail>
          <Description xml:lang="{Element Value}">{Element Value}</Description>		 Code: xml:lang Type: Text Code: Description Type: Product Attribute: Short Description "en" X5477050001 ARK ANIMALS
<ItemDetail>  <UnitOfMeasure>{Element Value} </UnitOfMeasure> Code: Unit of Measure Type: Text CT
<ItemDetail>     <Classification domain="UNSPSC">{Element Value}</Classification> Code: Classification  Type: Product Attribute: UNSPSC 55121613

Web Form Fields Configured to be Included in the Punchout Order Message

Web Form fields may be configured to have data included in the Cart Transfer.

When there is a Web Form item in the Cart when the Cart Transfer is submitted, Web Form fields configured to be included are sent as extrinsics.

The configuration to include the data is available in the Web Form Setup by selecting Yes for Send Field Data to ERP in Cart Transfer. 

An example of a Web Form Field sent as an extrinsic is as follows:

<input type="hidden" name="NEW_ITEM-BASE_CAPACITY[1]" value="4000 mAh">

Note: Some standard fields from Web Forms are sent by default as non-extrinsics. They include Qty, Price, and SKU. 

Punchout Order Message (POOM) Sample  

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.035/cXML.dtd">
<cXML payloadID="1547054530" timestamp="2019-01-09T12:22:10-05:00" xml:lang="en-US">
   <Header>
     <From>
       <Credential domain="NetworkID">
         <Identity>BQ7617F45</Identity>
       </Credential>
     </From>
     <To>
       <Credential domain="NetworkId">
         <Identity>3590j9887b01D2</Identity>
       </Credential>
     </To>
     <Sender>
       <Credential domain="buyerquest.net">
         <Identity>BuyerQuest Gateway</Identity>
       </Credential>
       <UserAgent>cXML Gateway</UserAgent>
     </Sender>
   </Header>
   <Message>
     <PunchOutOrderMessage>
       <BuyerCookie>6j91k8834p01213km874930902</BuyerCookie>
       <PunchOutOrderMessageHeader operationAllowed="create">
         <Total>
           <Money currency="USD">55800.00000</Money>
         </Total>
       </PunchOutOrderMessageHeader>
       <ItemIn quantity="100.0000">
         <ItemID>
           <SupplierPartID>AE-3388CF</SupplierPartID>
         </ItemID>
         <ItemDetail>
           <UnitPrice>
             <Money currency="USD">320.00000</Money>
           </UnitPrice>
           <Description xml:lang="en">CARBON FIBER HEADSET WITH PUSH TO TALK (PTT) SWITCH IN EAR CUP WITH 26&#39; COIL CORD<ShortName>CARBON FIBER HEADSET WITH PTT AND COIL CORD</ShortName>
</Description>
          <UnitOfMeasure>EA</UnitOfMeasure>
          <Classification domain="UNSPSC">25191500</Classification>
          <ManufacturerPartID>AE-3388CF</ManufacturerPartID>
          <ManufacturerName>Airelectric Inc.</ManufacturerName>
          <LeadTime>3</LeadTime>
        </ItemDetail>
        <SupplierID domain="buyersystemid">6ty891q430999</SupplierID>
        <Comments/>
      </ItemIn>
   </PunchOutOrderMessage>
  </Message>
</cXML>