Skip to main content
Buyerquest Community

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

This topic details the elements, locations and sample values for cXML punchouts to and from BuyerQuest -- for the setup request (POSR) and the order message (POOM)

Overview

A new cart is created through a Punchout Setup Request (POSR) encoded in create mode. Any necessary edits made produce a POSR in edit mode. Examples of POSR in both create and edit mode are included here. 

Punchout Setup Request Elements for a New POSR

The Punchout Setup Request (POSR) to BuyerQuest cXML elements are detailed here with location and sample element values.  

This example shows the encoding for a new POSR -- note that the operation value is create, indicating a new Punchout Setup Request. 

Element Element Location in BQ  Is Required Sample Element Value
<From>
      <Credential domain="">
    NetworkID
<From>
       <Identity>{Element Value}</Identity>
    p2pqa2_cxml
<To>
     <Credential domain="">
    Typically “NetworkID” or “DUNS”
<To>
      <Identity>{Element Value}</Identity>
    AN01005508132-T
<Sender>
     <Credential domain="">
    DUNS
<Sender>
     <Identity>{Element Value}</Identity>
    info@punchoutcatalogs.net
<Sender>
      <SharedSecret>{Element Value}</SharedSecret>
    RRD2500
<Sender>
     <UserAgent>{Element Value}</UserAgent>
    Gateway Sandbox
<PunchOutSetupRequest operation="{Element Value}">     create
<PunchOutSetupRequest operation="{Element Value}">
    <BuyerCookie>{Element Value}</BuyerCookie>
    l8vjqubjj7abohgk6nlv3p8b83
<PunchOutSetupRequest operation="create">
     <Extrinsic name="FirstName">{Element Value}</Extrinsic>
User's First Name Yes Jim
<PunchOutSetupRequest operation="create">
     <Extrinsic name="LastName">{Element Value}</Extrinsic>
User's Last Name Yes Halpert
<PunchOutSetupRequest operation="create">
     <Extrinsic name="UniqueName">{Element Value}</Extrinsic>
    Jim
<PunchOutSetupRequest operation="create">
     <Extrinsic name="UserEmail">{Element Value}</Extrinsic>
User's  Login ID   noah.jim@xyz.com
<PunchOutSetupRequest operation="create">
     <Extrinsic name="User">{Element Value}</Extrinsic>
    Jim
<PunchOutSetupRequest operation="create">
     <Extrinsic name="BusinessUnit">{Element Value}</Extrinsic>
    Pharmacy
<PunchOutSetupRequest operation="create">
     <BrowserFormPost>
     <URL>(Element Value)</URL>
    https://uat.buyerquest.net/xzy/punch.../cxmlresponse/
<PunchOutSetupRequest operation="">
     <Contact>
     <Name xml:lang="en-US">>(Element Value)</Name>
    ADMINISTRATOR SUPERUSER
<PunchOutSetupRequest operation="">
     <Contact>
     <Email>(Element Value)</Email>
    administrator@buyerquest.com
<PunchOutSetupRequest operation="">
     <SupplierSetup>
     <Email>(Element Value)</Email>
    https://testcustompoint.rrd.com/xs2/orders/punchout?
eventID=EVT_CXML_REQ

New Punchout Setup Request (POSR) Sample Message

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd">
<cXML payloadID="1211221788.71299@ip-10-251-122-83" timestamp="Mon May 19 18:29:48 +0000 2008" xml:lang="en-US">
  <Header>
    <From>
      <Credential domain="DUNS">
        <Identity>buyerquest-t</Identity>
      </Credential>
    </From>
    <To>
      <Credential domain="DUNS">
        <Identity>buyerquest-t</Identity>
      </Credential>
    </To>
    <Sender>
      <Credential domain="DUNS">
        <Identity>buyerquest-t</Identity>
        <SharedSecret>test</SharedSecret>
      </Credential>
      <UserAgent>BuyerQuest Procurement 1.0</UserAgent>
    </Sender>
  </Header>
  <Request>
    <PunchOutSetupRequest operation="create">
      <BuyerCookie>c64af92dc27e68172e030d3dfd1bc944</BuyerCookie>
      <Extrinsic name="FirstName">Jim</Extrinsic>
      <Extrinsic name="LastName">Halpert</Extrinsic>
      <Extrinsic name="UniqueName">jim</Extrinsic>
      <Extrinsic name="UserEmail">noah+jim@buyerquest.com</Extrinsic>
      <Extrinsic name="User">jim</Extrinsic>
      <Extrinsic name="BusinessUnit">MARKETING</Extrinsic>
      <Contact role="endUser">
        <Name xml:lang="en-US">jim</Name>
        <Email>noah+jim@buyerquest.com</Email>
      </Contact>
      <BrowserFormPost>
        <URL>https://qa.xyz.com/punchout/checkout/4</URL>
      </BrowserFormPost>
    </PunchOutSetupRequest>
  </Request>
</cXML>

Punchout to BuyerQuest cXML (POSR) in Edit Mode 

A POSR in Edit mode features the same encoding as for a new POSR, except that the operation attribute for the PunchOutSetupRequest element is set to "edit" instead of "create".

Element Is Required Sample Element Value
 <PunchOutSetupRequest operation="edit"> yes Edit
<Extrinsic name="ShoppingCartAuxID">"{Element Value}"></Extrinsic>   000113

Sample POSR Message in Edit Mode

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd">
<cXML payloadID="1211221788.71299@ip-10-251-122-83" timestamp="Mon May 19 18:29:48 +0000 2008" xml:lang="en-US">
  <Header>
    <From>
      <Credential domain="DUNS">
        <Identity>buyerquest-t</Identity>
      </Credential>
    </From>
    <To>
      <Credential domain="DUNS">
        <Identity>buyerquest-t</Identity>
      </Credential>
    </To>
    <Sender>
      <Credential domain="DUNS">
        <Identity>buyerquest-t</Identity>
        <SharedSecret>test</SharedSecret>
      </Credential>
      <UserAgent>BuyerQuest Procurement 1.0</UserAgent>
    </Sender>
  </Header>
  <Request>
    <PunchOutSetupRequest operation="edit">
      <BuyerCookie>c64af92dc27e68172e030d3dfd1bc944</BuyerCookie>
      <Extrinsic name="FirstName">Jim</Extrinsic>
      <Extrinsic name="LastName">Halpert</Extrinsic>
      <Extrinsic name="UniqueName">jim</Extrinsic>
      <Extrinsic name="UserEmail">noah+jim@buyerquest.com</Extrinsic>
      <Extrinsic name="User">jim</Extrinsic>
      <Extrinsic name="BusinessUnit">MARKETING</Extrinsic>
      <Extrinsic name="ShoppingCartAuxID">000113</Extrinsic>
      <Contact role="endUser">
        <Name xml:lang="en-US">jim</Name>
        <Email>noah+jim@buyerquest.com</Email>
      </Contact>
      <BrowserFormPost>
        <URL>https://qa.xyz.com/punchout/checkout/4</URL>
      </BrowserFormPost>
    </PunchOutSetupRequest>
  </Request>
</cXML>

Punchout Order Message (POOM) Elements 

Elements and sample values in the Punchout Order Message (POOM) to BuyerQuest are listed below. 

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 ARANIMALS
<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

Punchout Order Message (POOM) Sample Message

Example PunchOutOrderMessage                                                        
<?xml version="1.0" encoding="UTF-8"?>                                                        
<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.007/cXML.dtd">                                                        
<cXML timestamp="2017-12-06T08:02:19-8:00" payloadID="152398475934.5@supplierexample.com" version="1.1.010">                                                        
    <Header>                                                    
        <From>                                                
            <Credential domain="DUNS">                                            
                <Identity>123456789</Identity>                                        
            </Credential>                                            
        </From>                                                
        <To>                                                
            <Credential domain="DUNS">                                            
                <Identity>098765432</Identity>                                        
            </Credential>                                            
        </To>                                                
        <Sender>                                                
            <Credential domain="DUNS">                                            
                <Identity>741258963</Identity>                                        
            </Credential>                                            
            <UserAgent>PunchoutSite</UserAgent>                                            
        </Sender>                                                
    </Header>                                                    
    <Message>                                                    
        <PunchOutOrderMessage>                                                
            <BuyerCookie>h6vmjs38vvj5oq84b1ga5dt0r4</BuyerCookie>                                            
            <PunchOutOrderMessageHeader operationAllowed="edit">                                            
                <Total>                                        
                    <Money currency="CAD">4.84</Money>                                    
                </Total>                                        
            </PunchOutOrderMessageHeader>                                            
            <ItemIn quantity="1">                                            
                <ItemID>                                        
                    <SupplierPartID>MGH-30001</SupplierPartID>                                    
                    <SupplierPartAuxiliaryID>74606729</SupplierPartAuxiliaryID>                                    
                </ItemID>                                        
                <ItemDetail>                                        
                    <UnitPrice>                                    
                        <Money currency="CAD">4.84</Money>                                
                    </UnitPrice>                                    
                    <Description xml:lang="en">Velcro Cable Organizers - Roll of 100 - Asst Colors</Description>                                    
                    <UnitOfMeasure>RL</UnitOfMeasure>                                    
                    <Classification domain="UNSPSC">44111500</Classification>                                    
                    <ManufacturerPartID>68733487</ManufacturerPartID>                                    
                    <ManufacturerName>Acme Inc.</ManufacturerName>                                    
                    <Extrinsic name="User">jane.doe@example.com</Extrinsic>                                    
                    <Extrinsic name="Color">Assorted</Extrinsic>                                    
                    <Extrinsic name="Length">5 inches</Extrinsic>                                    
                </ItemDetail>                                        
            </ItemIn>                                            
        </PunchOutOrderMessage>                                                
    </Message>                                                    
</cXML>