1. SCM (Supply Chain Management)
  2. Vendors, Purchasing, and Receiving
  3. Purchasing and Receiving
  4. SuiteProcurement
  5. SuiteProcurement Support for Non-curated Trading Partners
  6. Document Formats

Document Formats

The following information specifies the required document formats and their respective fields to be exchanged between NetSuite customers and noncurated trading partners.

For each of the request types, ensure to follow the prescribed cXML document format and include the required fields when sending or receiving documents.

To download the cXML standard, see https://cxml.org/.

Punchout to Trading Partner Store (Required)

The following is the required document format to send request from OBN to non-curated trading partners.

Request

Code 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="20250130063800.CqW17kmh1YVnqIM-nWiYbdNsFowHCPfXXkyua209bFJk70CUtav4!-1689794875!1738219080097.-124267@businessnetwork-stage.oracle.com"
   timestamp="2025-01-30T06:3
8:00+00:00">
   <Header>
      <From>
         <Credential domain="NetworkID">
            <Identity>netsuitetestamazon</Identity>
         </Credential>
      </From>
      <To>
         <Credential domain="DUNS">
            <Identity>OBN-100-8634</Identity>
         </Credential>
      </To>
      <Sender>
         <Credential domain="Oracle Exchange Test 6.2.4">
            <Identity>testexchange.oracle.com</Identity>
            <SharedSecret>d9epqANuvzIkFOG1FBxlWFpCLpSSe6</SharedSecret>
         </Credential>
         <UserAgent>Oracle Exchange Test 6.2.4</UserAgent>
      </Sender>
   </Header>
   <Request>
      <PunchOutSetupRequest operation="create">
         <BuyerCookie>
            416d617a6f6e20427573696e6573737361692e726f686974682e736865656c61406e657473756974652e636f6d2d31323432363734323032</BuyerCookie>
         <Extrinsic name="User" />
         <Extrinsic name="BusinessUnitId" />
         <Extrinsic name="UniqueName" />
         <Extrinsic name="FirstName">James<Extrinsic/>
         <Extrinsic name="LastName">Bond<Extrinsic/>
         <BrowserFormPost>
            <URL>
               https://8595686.extforms.netsuite.com/app/site/hosting/scriptlet.nl?script=878&deploy=1&compid=8595686&ns-at=AAEJ7tMQIs31D5lYubWJQARIuDVGwu2nSSizM9TV-VEBa2iWYts&&subsidiary=1&sptransactionid=5609fad3-ac0d-4675-a4f9-452b6feefa08&entity=14227&purchaseReqPref=F</URL>
         </BrowserFormPost>
         <Contact>
            <Name xml:lang="en-US">James Bond</Name>
            <Email>james.bond@abc-xxxxxx.com</Email>
            <Phone>+91-9123456789</Phone>
         </Contact>
         <SupplierSetup>
            <URL>https://www.abc-xxxxxx.com/eprocurement/punchout</URL>
         </SupplierSetup>
      </PunchOutSetupRequest>
   </Request>
</cXML>

The following table provides information about the required fields in the cXML document.

Attribute

Optional/Required

Notes

<PunchOutSetupRequest >

Required

—

<Extrinsic name="FirstName">James</Extrinsic>

Required

—

<Extrinsic name="LastName">Bond</Extrinsic>

Required

—

<BrowserFormPost>

Required

—

<URL>

Required

This is the URL where the cart data is stored after a buyer checks out from the trading partner store.

<Contact>

Required

—

<Name xml:lang="en-US">James Bond</Name>

Required

—

<Email>james.bond@abcorg.com</Email>

Required

—

<Phone>+91-9123456789</Phone>

Required

—

Response

Code Sample

              <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.025/cXML.dtd">
<cXML payloadID="1738219081776.635.7151@abc-xxxxxx.com" timestamp="2025-01-30T06:38:01+06:38"
    xml:lang="en-US">
    <Response>
        <Status code="200" text="success" />
        <PunchOutSetupResponse>
            <StartPage>
                <URL>https://www.abc-xxxxxx.com/eprocurement/initiate-clean-punchout/136-5579490-6426513</URL>
            </StartPage>
        </PunchOutSetupResponse>
    </Response>
</cXML>

The following table provides information about the required fields in the cXML document.

Attribute

Optional/Required

Notes

<PunchOutSetupResponse>

Required

—

<StartPage> <URL>

Required

This is the URL where the user lands for shopping, after authentication on OBN.

Punchout back to NetSuite (Required)

The following is the response format from trading partner to NetSuite (cart data).

Request

Code Sample

              <?xml version="1.0"?><!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.1.006/cXML.dtd"><cXML version="1.0" payloadID="123" timestamp="2024-12-09T03:24:50-EST">
<Header>
<From>
<Credential domain="DUNS">
<Identity>151064821</Identity>
</Credential>
</From>
<To>
<Credential domain="Clarus">
<Identity>oracle-t</Identity>
</Credential>
</To>
<Sender>
<Credential domain="Clarus">
<Identity>Staples</Identity>
</Credential>
<UserAgent>Network</UserAgent>
</Sender>
</Header>
<Message>
<PunchOutOrderMessage>
<BuyerCookie>537461706c657320496e632e76656e6b61746172616d616e612e6d616a657469406e657473756974652e636f6d2d31343334313735333231</BuyerCookie>
<PunchOutOrderMessageHeader operationAllowed="edit">
<Total>
<Money currency="USD">49.99</Money>
</Total>
<Shipping>
<Money currency="USD">0.0</Money>
<Description xml:lang="EN">7647397779</Description>
</Shipping>
</PunchOutOrderMessageHeader>
<ItemIn quantity="1">
<ItemID>
<SupplierPartID>24588453</SupplierPartID>
<SupplierPartAuxiliaryID></SupplierPartAuxiliaryID>
</ItemID>
<ItemDetail>
<UnitPrice>
<Money currency="USD">49.99</Money>
</UnitPrice>
<Description xml:lang="EN">ABC Cartwright Ergonomic Fabric Swivel Task Chair, Black (ST62400)</Description>
<UnitOfMeasure>EA</UnitOfMeasure>
<Classification domain="UNSPSC">56101504</Classification>
<ManufacturerPartID>ST62400</ManufacturerPartID>
<ManufacturerName>ABC Brands</ManufacturerName>
</ItemDetail>
<Shipping>
<Money currency="USD">0</Money>
<Description xml:lang="en-US">7647397779</Description>
</Shipping>
</ItemIn>
</PunchOutOrderMessage>
</Message>
</cXML>

The following table provides information about the required fields in the cXML document.

Attribute

Optional/Required

Notes

<ItemIn>

Required

This information is required for each of the item ordered.

<SupplierPartID>

Required

Refers to the Item ID.

This information is included in the purchase request and sent back to the trading partner.

<SupplierPartAuxiliaryID>

Optional

Refers to the CART ID.

This information is required only if the trading partner wants to include the cart ID in the purchase request.

<UnitPrice>

Required

Refers to money and currency.

<Description>

Required

—

<UnitOfMeasure>

Required

—

<Classification>

Required

This set up should be done in advance through the Item Categories in the preferences.

<ManufacturerPartID>

Optional

Refers to the ID of the seller in the marketplace.

This information is required only if the trading partner want to include the ID in the purchase request.

<ManufacturerName>

Optional

Refers to the name of the seller in the marketplace.

This information is required only if the trading partner want to include the ID in the purchase request.

Purchase Order (Required)

The following is the request format from OBN to trading partner. Based on the setup of delivery methods, it can be HTTP request, email (XML), or others.

Request

Code Sample

              <?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.007/cXML.dtd">
<cXML version="1.2.007" payloadID="20250202.195717329.TEST.doc-1-15353" timestamp="2025-02-02T13:57:17">
   <Header>
      <From>
         <Credential domain="NetworkID">
            <Identity>abccompany</Identity>
         </Credential>
      </From>
      <To>
         <Credential domain="NetworkID">
            <Identity>1234345435</Identity>
         </Credential>
      </To>
      <Sender>
         <Credential domain="OracleSN">
            <Identity>*************</Identity>
            <SharedSecret>************************</SharedSecret>
         </Credential>
         <UserAgent>Oracle Supplier Network</UserAgent>
      </Sender>
   </Header>
   <Request>
      <OrderRequest>
         <OrderRequestHeader orderID="9605" orderDate="2025-02-02T08:00:00.000Z" orderType="regular" type="new">
            <Total>
               <Money currency="USD">3599.97</Money>
            </Total>
            <ShipTo>
               <Address isoCountryCode="US" addressID="">
                  <Name xml:lang="en">Automation TC User01</Name>
                  <PostalAddress>
                     <DeliverTo>Attention</DeliverTo>
                     <Street>345 Spear St</Street>
                     <City>San Francisco</City>
                     <State>CA</State>
                     <PostalCode>94105</PostalCode>
                     <Country isoCountryCode="US">US</Country>
                  </PostalAddress>
                  <Email>suiteprocurement_aut01@abccompany.com</Email>
                  <Phone>
                     <TelephoneNumber>
                        <CountryCode isoCountryCode="US"/>
                        <AreaOrCityCode/>
                        <Number>(987) 123-0000</Number>
                        <Extension/>
                     </TelephoneNumber>
                  </Phone>
               </Address>
            </ShipTo>
            <BillTo>
               <Address isoCountryCode="IN" addressID="">
                  <Name xml:lang="en">ABC Company</Name>
                  <PostalAddress>
                     <DeliverTo>TAX Agency AL vendor</DeliverTo>
                     <Street>345 Spear St</Street>
                     <City>San Francisco</City>
                     <State>CA</State>
                     <PostalCode>94105</PostalCode>
                     <Country isoCountryCode="IN">IN</Country>
                  </PostalAddress>
                  <Email>TaxAgencyAL@Test.com</Email>
                  <Phone>
                     <TelephoneNumber>
                        <CountryCode isoCountryCode="IN"/>
                        <AreaOrCityCode/>
                        <Number>(987) 123-0000</Number>
                        <Extension/>
                     </TelephoneNumber>
                  </Phone>
                  <Fax>
                     <TelephoneNumber>
                        <CountryCode isoCountryCode=""/>
                        <AreaOrCityCode/>
                        <Number/>
                        <Extension/>
                     </TelephoneNumber>
                  </Fax>
               </Address>
            </BillTo>
            <Shipping trackingDomain="">
               <Money currency="USD"/>
               <Description xml:lang="en"/>
            </Shipping>
            <Contact role="">
               <Name xml:lang="en"/>
               <PostalAddress>
                  <City/>
                  <State/>
                  <PostalCode/>
                  <Country isoCountryCode=""/>
               </PostalAddress>
               <Email/>
               <Phone>
                  <TelephoneNumber>
                     <CountryCode isoCountryCode=""/>
                     <AreaOrCityCode/>
                     <Number/>
                     <Extension/>
                  </TelephoneNumber>
               </Phone>
            </Contact>
         </OrderRequestHeader>
         <ItemOut lineNumber="1" quantity="3" requestedDeliveryDate="">
            <ItemID>
               <SupplierPartID>24608083</SupplierPartID>
               <SupplierPartAuxiliaryID/>
            </ItemID>
            <ItemDetail>
               <UnitPrice>
                  <Money currency="USD">1199.99</Money>
               </UnitPrice>
               <Description xml:lang="en"/>
               <UnitOfMeasure>EA</UnitOfMeasure>
               <Classification domain="DUMMY"/>
            </ItemDetail>
            <ShipTo>
               <Address isoCountryCode="US" addressID="">
                  <Name xml:lang="en">Automation TC User01</Name>
                  <PostalAddress>
                     <DeliverTo>Attention</DeliverTo>
                     <Street>345 Spear St</Street>
                     <City>Sa Francisco</City>
                     <State>CA</State>
                     <PostalCode>94105</PostalCode>
                     <Country isoCountryCode="US">US</Country>
                  </PostalAddress>
                  <Email>suiteprocurement_aut01@abccompany.com</Email>
                  <Phone>
                     <TelephoneNumber>
                        <CountryCode isoCountryCode="US"/>
                        <AreaOrCityCode/>
                        <Number>(987) 123-0000</Number>
                        <Extension/>
                     </TelephoneNumber>
                  </Phone>
               </Address>
            </ShipTo>
            <Tax>
               <Money currency="USD">0</Money>
               <Description xml:lang="en"/>
               <TaxDetail category="None">
                  <TaxableAmount>
                     <Money currency="USD">3599.9700000000003</Money>
                  </TaxableAmount>
                  <TaxAmount>
                     <Money currency="USD">0</Money>
                  </TaxAmount>
                  <TaxLocation xml:lang="en"/>
                  <Description xml:lang="en"/>
               </TaxDetail>
            </Tax>
         </ItemOut>
      </OrderRequest>
   </Request>
</cXML>

The following table provides information about the required fields in the cXML document.

Attribute

Optional/Required

Notes

<OrderRequestHeader orderID="" orderDate="" orderType="" type="">

Required

Required attributes:

  • Order ID

  • Order Date

<Money currency="">

Required

Required attribute is currency.

<ShipTo>

Required

All the fields under ShipTo are required except Phone. Phone can be blank, if there is none.

<BillTo>

Required

All the fields under BillTo are required except Phone. Phone can be blank, if there is none.

<Contact>

Optional

This information is sent only if a contact exists in the purchase request record in NetSuite.

<ItemOut lineNumber="" quantity="" requestedDeliveryDate="">

Required

Required attributes:

  • Line Number

  • Quantity

<SupplierPartID>

Required

—

<SupplierPartAuxiliaryID>

Optional

If the Punchout back to NetSuite(Cart Data) response includes the information, it is sent.

<UnitPrice>

<Money currency=""></Money>

Required

—

<UnitOfMeasure>

Required

—

<Tax>

Optional

—

Purchase Order Acknowledgment (Optional)

The following is the response format from trading partner to OBN.

Response

Code Sample

              <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.024/Fulfill.dtd">
<cXML payloadID="1722107623364.150.1960@amazon.com" timestamp="2024-07-27T19:13:43+0000" xml:lang="en-US">
    <Header>
        <From>
            <Credential domain="NetworkId">
                <Identity>amazonbusinessintegrations</Identity>
            </Credential>
        </From>
        <To>
            <Credential domain="NetworkID">
                <Identity>netsuitetestamazon</Identity>
            </Credential>
        </To>
        <Sender>
            <Credential domain="NetworkId">
                <Identity>amazonbusinessintegrations</Identity>
                  
            </Credential>
            <UserAgent>Amazon LLC eProcurement Application</UserAgent>
        </Sender>
    </Header>
    <Request deploymentMode="test">
        <ConfirmationRequest>
            <ConfirmationHeader confirmID="123-9644542-188162426" operation="new" type="detail" noticeDate="2024-10-14T19:13:43+0000">
                <Total>
                    <Money currency="USD">27.74</Money>
                </Total>
                <Shipping>
                    <Money currency="USD">3.19</Money>
                    <Description xml:lang="en-US">Cost of shipping, not including shipping tax</Description>
                </Shipping>
                <Tax>
                    <Money currency="USD">12.27</Money>
                    <Description xml:lang="en-US">Cost of tax, including shipping tax</Description>
                </Tax>
            </ConfirmationHeader>
            <OrderReference orderID="13240" orderDate="2024-10-16T07:00:00Z">
                <DocumentReference payloadID="20240916.000826323.TEST.doc-1-2608"/>
            </OrderReference>
            <ConfirmationItem quantity="1" lineNumber="3">
                <UnitOfMeasure>EA</UnitOfMeasure>
                <ConfirmationStatus quantity="1" type="accept">
                    <UnitOfMeasure>EA</UnitOfMeasure>
                    <UnitPrice>
                        <Money currency="USD">9.99</Money>
                    </UnitPrice>
                    <Tax>
                        <Money currency="USD">2.09</Money>
                        <Description xml:lang="en-US">MengRan 3.9'' Ballpoint Ink Pen Refills for Click Pens,1mm Medium Tip,Compatible with Parker Pen Refill,Pack of 10 (Black Ink)</Description>
                        <TaxDetail category="none" percentageRate="8.29" purpose="subtotalTax">
                            <TaxAmount>
                                <Money currency="USD">1.26</Money>
                            </TaxAmount>
                        </TaxDetail>
                        <TaxDetail category="none" percentageRate="8.30" purpose="shippingTax">
                            <TaxAmount>
                                <Money currency="USD">0.58</Money>
                            </TaxAmount>
                        </TaxDetail>
                    </Tax>
                    <Shipping>
                        <Money currency="USD">6.09</Money>
                        <Description xml:lang="en-US">Cost of shipping, not including shipping tax</Description>
                    </Shipping>
                    <Comments type="confirmID">113-9644542-1886651</Comments>
                </ConfirmationStatus>
            </ConfirmationItem>
            <ConfirmationItem quantity="1" lineNumber="4">
                <UnitOfMeasure>EA</UnitOfMeasure>
                <ConfirmationStatus quantity="1" type="accept">
                    <UnitOfMeasure>EA</UnitOfMeasure>
                    <UnitPrice>
                        <Money currency="USD">2.29</Money>
                    </UnitPrice>
                    <Tax>
                        <Money currency="USD">2.09</Money>
                        <Description xml:lang="en-US">BIC Round Stic Extra Life Ballpoint Pen, Medium Point (1.0mm), Blue, For Smooth & Comfortable Writing, 12-Count</Description>
                        <TaxDetail category="none" percentageRate="8.29" purpose="subtotalTax">
                            <TaxAmount>
                                <Money currency="USD">1.10</Money>
                            </TaxAmount>
                        </TaxDetail>
                        <TaxDetail category="none" percentageRate="8.30" purpose="shippingTax">
                            <TaxAmount>
                                <Money currency="USD">0.58</Money>
                            </TaxAmount>
                        </TaxDetail>
                    </Tax>
                    <Shipping>
                        <Money currency="USD">6.18</Money>
                        <Description xml:lang="en-US">Cost of shipping, not including shipping tax</Description>
                    </Shipping>
                    <Comments type="confirmID">113-9644542-1886651</Comments>
                </ConfirmationStatus>
            </ConfirmationItem>
        </ConfirmationRequest>
    </Request>
</cXML>

The following table provides information about the required fields in the cXML document.

Attribute

Optional/Required

Notes

<ConfirmationHeader confirmID="" operation="" type="" noticeDate="">

Required

Required attributes:

  • Confirm ID– A unique ID for the Purchase Order Acknowledgement.

  • Operation– The value should be new.

  • Type– The value should be detail.

  • Notice Date

<Total>

Required

Required attribute is currency.

<Shipping>

Required

Required attribute is currency.

<Tax>

Required

Required attribute is currency.

<ConfirmationItem quantity="" lineNumber="">

Required

Required attributes:

  • Quantity– Refers to quantity of the particular item.

  • Line Number– As specified earlier as part of the purchase request.

<ConfirmationStatus quantity="" type="accept">

Required

Values for the attribute type can be any of the following: accept, reject, or detail.

<UnitOfMeasure>

Required

—

<UnitPrice>

Required

—

<Money currency=""></Money>

Required

—

<Tax>

Optional

—

<Shipping>

Required

If there is a shipping amount associated with the purchase request.

Invoice (Required)

The following is the response format from trading partner to OBN.

Response

Code Sample

              <?xml version="1.0" encoding="UTF-8"?>             
<cXML version="1.0" payloadID="123344-2001@curlpost" timestamp="2017-03-20T23:59:45-07:00">            
    <Header>       
        <From>     
            <Credential domain="DUNS"> 
                <Identity>042447644</Identity>
            </Credential>
        </From>    
        <To>   
            <Credential domain="TAXID">
                <Identity>123456784567</Identity>
            </Credential>
        </To>
    </Header>          
    <Request>          
        <InvoiceDetailRequest>         
            <InvoiceDetailRequestHeader invoiceID="Testing2803422025" purpose="standard" invoiceDate="2001-04-20T23:59:20-07:00">                        
                <InvoicePartner>
                    <Contact role="soldTo" addressID="B2.4.319">
                        <Name xml:lang="en">Mike Smith</Name>    
                            <PostalAddress name="default">     
                            <DeliverTo>Mike Smith</DeliverTo>
                            <Street>15 Camino del Cerro</Street> 
                            <City>Los Gatos</City>
                            <State>CA</State>
                            <PostalCode>95032</PostalCode>
                            <Country isoCountryCode="US">United States</Country> 
                        </PostalAddress>   
                        <Email name="default">admin@ariba.com</Email>    
                        <Phone name="work">    
                            <TelephoneNumber>
                                <CountryCode isoCountryCode="US">1</CountryCode>
                                <AreaOrCityCode>408</AreaOrCityCode>
                                <Number>3582000</Number>
                            </TelephoneNumber> 
                        </Phone>   
                        <Fax name="work">  
                            <TelephoneNumber>
                                <CountryCode isoCountryCode="US">1</CountryCode>
                                <AreaOrCityCode>408</AreaOrCityCode>
                                <Number>3582000</Number>
                            </TelephoneNumber> 
                        </Fax>     
                    </Contact>         
                </InvoicePartner>                   
            </InvoiceDetailRequestHeader>      
            <InvoiceDetailOrder>       
                <InvoiceDetailOrderInfo>             
                    <OrderReference orderID="16127">                 
                    </OrderReference>           
                </InvoiceDetailOrderInfo>
                <InvoiceDetailItem quantity="1">    
                    <UnitOfMeasure>EA</UnitOfMeasure>
                    <UnitPrice>
                        <Money currency="USD">130</Money>        
                    </UnitPrice>       
                    <InvoiceDetailItemReference lineNumber="1">        
                        <ItemID>   
                            <SupplierPartID>8243328</SupplierPartID>
                        </ItemID>  
                        <Description xml:lang="en">HP Z2 Mini G9 Workstation 1 Core i9 14th Gen i9 14900 64 GB 1 TB SSD</Description>  
                    </InvoiceDetailItemReference>                          
                </InvoiceDetailItem>           
            </InvoiceDetailOrder>              
            <InvoiceDetailSummary>                                 
                <Tax>          
                    <Money currency="USD">490</Money>            
                    <TaxDetail purpose="tax" category="State sales tax" percentageRate="8">    
                        <TaxableAmount>
                            <Money currency="USD">2725.46</Money>
                        </TaxableAmount>
                        <TaxAmount>
                            <Money currency="USD">80</Money>
                        </TaxAmount>  
                    </TaxDetail>   
                    <TaxDetail purpose="tax" category="Federal sales tax" percentageRate="2">  
                        <TaxableAmount>
                            <Money currency="USD">4900</Money>
                        </TaxableAmount>
                        <TaxAmount>
                            <Money currency="USD">98</Money>
                        </TaxAmount>
                    </TaxDetail>   
                </Tax>         
                <SpecialHandlingAmount>        
                    <Money currency="USD">0.00</Money>   
                </SpecialHandlingAmount>       
                <ShippingAmount>       
                    <Money currency="USD">0.00</Money>     
                </ShippingAmount>           
                <InvoiceDetailDiscount>        
                    <Money currency="USD">0.00</Money>  
                </InvoiceDetailDiscount>       
                <NetAmount>                                    
                    <Money currency="USD">2725.46</Money>                               
                </NetAmount>                                                                 
            </InvoiceDetailSummary>                                        
        </InvoiceDetailRequest>                                            
    </Request>                                                 
</cXML>

The following table provides information about the required fields in the cXML document.

Attribute

Optional/Required

Notes

<InvoiceDetailRequestHeader invoiceID="" purpose="standard" invoiceDate="">

Required

Required attributes:

  • Invoice ID

  • Purpose– The value should be standard.

  • Invoice Date

<InvoicePartner>

Required

Includes trading partner contact information.

<InvoiceDetailOrder>

Required

—

<InvoiceDetailOrderInfo> <OrderReference orderID="">

Required

—

<InvoiceDetailItem quantity="">

Required

—

<InvoiceDetailItemReference lineNumber="1">

Required

Refers to the line number in NetSuite purchase request item line, which is specified as the linenumber in purchase request earlier.

<SupplierPartID>

Required

—

<Money currency="">

Required

Required attribute is currency.

<InvoiceDetailSummary>

Required

—

<TaxDetail purpose="" category="" percentageRate="">

Optional

Required attributes:

  • purpose

  • category

  • percentageRate

Credit Memo (Required)

The following is the response format from trading partner to OBN.

Response

Code Sample

              <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.030/InvoiceDetail.dtd">
<cXML payloadID="1724904618314.1557.1858@amazon.com" timestamp="2024-08-23T06:39:57+0000" xml:lang="en-US">
    <Header>
        <From>
            <Credential domain="DUNS">
                <Identity>OBN-100-8634</Identity>
            </Credential>
        </From>
        <To>
            <Credential domain="NetworkID">
                <Identity>OBN1210187</Identity>
            </Credential>
        </To>
        <Sender>
            <Credential domain="NetworkId">
                <Identity>**************************</Identity>
                <SharedSecret>**************</SharedSecret>
            </Credential>
            <UserAgent>Amazon LLC eProcurement Application</UserAgent>
        </Sender>
    </Header>
    <Request >
        <InvoiceDetailRequest>
            <InvoiceDetailRequestHeader invoiceID="f216d009dggc6437" purpose="creditMemo"  invoiceDate="2024-10-04T06:39:57+0000">    
            </InvoiceDetailRequestHeader>
            <InvoiceDetailOrder>
                <InvoiceDetailOrderInfo>
                    <OrderReference orderID="16127" >
                    </OrderReference>
                </InvoiceDetailOrderInfo>
                <InvoiceDetailItem  quantity="1">
                    <UnitOfMeasure>EA</UnitOfMeasure>
                    <UnitPrice>
                        <Money currency="USD">2725.46</Money>
                    </UnitPrice>
                    <InvoiceDetailItemReference lineNumber="1">
                        <ItemID>
                            <SupplierPartID>8243328</SupplierPartID>
                        </ItemID>
                        <Description xml:lang="en-US">HP Z2 Mini G9 Workstation 1 Core i9 14th Gen i9 14900 64 GB 1 TB SSD</Description>
                    </InvoiceDetailItemReference> 
                </InvoiceDetailItem>
            </InvoiceDetailOrder>
            <InvoiceDetailSummary>
                <Tax>
                    <Money currency="USD">20</Money>
                    <TaxDetail purpose="tax" category="sales" percentageRate="8.28">
                        <TaxableAmount>
                            <Money currency="USD">2725.46</Money>
                        </TaxableAmount>
                        <TaxAmount>
                            <Money currency="USD">25</Money>
                        </TaxAmount>
                    </TaxDetail>
                </Tax>
                <SpecialHandlingAmount>
                    <Money currency="USD">0.00</Money>
                    <Description xml:lang="en-US">Other Charges</Description>
                </SpecialHandlingAmount>
                <ShippingAmount>
                    <Money currency="USD">2.99</Money>
                </ShippingAmount>
                <InvoiceDetailDiscount >
                    <Money currency="USD">0.00</Money>
                </InvoiceDetailDiscount>
                <NetAmount>
                    <Money currency="USD">2725.46</Money>
                </NetAmount>
            </InvoiceDetailSummary>
        </InvoiceDetailRequest>
    </Request>
</cXML>

The following table provides information about the required fields in the cXML document.

Attribute

Optional/Required

Notes

<InvoiceDetailRequestHeader invoiceID="" purpose="creditMemo" invoiceDate="">

Required

Required attributes:

  • Invoice ID

  • Purpose– The value should be standard.

  • Invoice Date

<InvoiceDetailOrder>

Required

—

<InvoiceDetailOrderInfo> <OrderReference orderID="" >

Required

Required attribute is orderID.

<InvoiceDetailSummary>

Required

—

<TaxDetail purpose="" category="" percentageRate="">

Required

Required attributes:

  • purpose

  • category

  • percentageRate

Shipment Notification (Optional)

The following is the response format from trading partner to OBN.

Response

Code Sample

              <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.024/Fulfill.dtd">
<cXML payloadID="1714120384582.415.9132@amazon.com" timestamp="2024-09-11T08:33:04+00:00" xml:lang="ja-JP">
    <Header>
        <From>
            <Credential domain="MISC">
                <Identity>AmazonBusinessJP</Identity>
            </Credential>
        </From>
        <To>
            <Credential domain="DUNS">
                <Identity>690566815</Identity>
            </Credential>
        </To>
        <Sender>
            <Credential domain="OracleSN">
                <Identity>****************************</Identity>
                <SharedSecret>**********</SharedSecret>
            </Credential>
            <UserAgent>Amazon LLC eProcurement Application</UserAgent>
        </Sender>
    </Header>
    <Request>
        <ShipNoticeRequest>
            <ShipNoticeHeader shipmentID="7731011412213" operation="new" noticeDate="2024-10-14T08:33:04+00:00" shipmentDate="2024-10-15T15:00:00+00:00" deliveryDate="2024-10-16T15:00:00+00:00" shipmentType="actual"/>
            <ShipControl>
                <CarrierIdentifier domain="companyName">FEDEX</CarrierIdentifier>
                <ShipmentIdentifier>490377311213</ShipmentIdentifier>
                <PackageIdentification rangeBegin="1" rangeEnd="1"/>
            </ShipControl>
            <ShipNoticePortion>
                <OrderReference orderID="13240" orderDate="2024-10-09T04:46:05.000000">
                    <DocumentReference payloadID="20240911.044624812.PROD.7443.337852-1"/>
                </OrderReference>
                <Extrinsic name="shipmentNum">1</Extrinsic>
                <ShipNoticeItem quantity="1" lineNumber="3">
                    <UnitOfMeasure>EA</UnitOfMeasure>
                </ShipNoticeItem>
                <ShipNoticeItem quantity="1" lineNumber="4">
                    <UnitOfMeasure>EA</UnitOfMeasure>
                </ShipNoticeItem>
            </ShipNoticePortion>
        </ShipNoticeRequest>
    </Request>
</cXML>

The following table provides information about the required fields in the cXML document.

Attribute

Optional/Required

Notes

<ShipNoticeHeader shipmentID="" operation="new" noticeDate="" shipmentDate="" deliveryDate="" shipmentType=""/>

Required

Required attributes:

  • shipmentID

  • operation

  • noticeDate

  • shipmentDate

  • deliveryDate

<CarrierIdentifier domain="companyName">

Required

—

<ShipmentIdentifier>

Required

—

<OrderReference orderID="" orderDate=""> <DocumentReference payloadID=""/> </OrderReference>

Required

—

<ShipNoticeItem quantity="" lineNumber="">

Required

Required attributes:

  • Quantity

  • Line Number

General Notices