Purchase Order Acknowledgment: Standard cXML payload – TradeCentric

The purchase order acknowledgment (POA) payload sends a POA request from your system, such as your eCommerce platform or ERP system, to the TradeCentric platform so that we can deliver the POA to the buyer's eProcurement system. For standard integrations that send cXML payloads, we accept the POA payload in our standard cXML format.

This article describes the standard cXML format to use for this payload.

Important: This payload is for POAs associated with purchase orders (POs) only. The payload must include the PO identifier from the PO request payload that we sent.

Jump to:

Request payload (to TradeCentric)

Request element details

cXML root
Header
Request

Response payload (from TradeCentric)

Response element details

cXML root
Response

Request payload (to TradeCentric)

The code block below shows an example POA request payload in our standard cXML format:

cXML

HTTP POST

ConfirmationRequest

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.014/Fulfill.dtd">
<cXML payloadID="12345678" timestamp="2022-11-18T00:00:00Z">
  <Header>
    <From>
      <Credential domain="NetworkID">
        <Identity>SupplierSystem</Identity>
      </Credential>
    </From>
    <To>
      <Credential domain="NetworkID">
        <Identity>BuyerSystem</Identity>
      </Credential>
    </To>
    <Sender>
      <Credential domain="NetworkID">
        <Identity>SupplierSystem</Identity>
        <SharedSecret>ABCD1234efgh5678.IJKL9012mnopq</SharedSecret>
      </Credential>
      <UserAgent>eCommercePOA</UserAgent>
    </Sender>
  </Header>
  <Request deploymentMode="production">
    <ConfirmationRequest>
      <ConfirmationHeader noticeDate="2022-11-18" type="accept" operation="new" confirmID="POA-123">
        <Total>
          <Money currency="USD">103.97</Money>
        </Total>
        <Contact role="shipTo">
          <Name xml:lang="en">Test Corp. - Nashville Branch</Name>
          <PostalAddress name="Default">
            <DeliverTo>Contact Name</DeliverTo>
            <Street>123 Test St.</Street>
            <City>Nashville</City>
            <State>TN</State>
            <PostalCode>37011</PostalCode>
            <Country isoCountryCode="US">United States</Country>
          </PostalAddress>
          <Email>contact@buyer.com</Email>
          <Phone>
            <TelephoneNumber>
              <CountryCode isoCountryCode="US">1</CountryCode>
              <AreaOrCityCode>888</AreaOrCityCode>
              <Number>555-9876</Number>
            </TelephoneNumber>
          </Phone>
        </Contact>
        <Contact role="billTo">
          <Name xml:lang="en">Test Corp. - Nashville Branch</Name>
          <PostalAddress name="Default">
            <DeliverTo>Contact Name</DeliverTo>
            <Street>123 Test St.</Street>
            <City>Nashville</City>
            <State>TN</State>
            <PostalCode>37011</PostalCode>
            <Country isoCountryCode="US">United States</Country>
          </PostalAddress>
          <Email>contact@buyer.com</Email>
        </Contact>
        <Contact role="buyer">
          <Name xml:lang="en-US">Contact Name</Name>
          <Email>contact@testbuyer.com</Email>
        </Contact>
      </ConfirmationHeader>
      <OrderReference orderID="PO-123">
        <DocumentReference payloadID="93369535150910.10.57.136"/>
      </OrderReference>
      <ConfirmationItem lineNumber="101" quantity="2">
        <UnitOfMeasure>EA</UnitOfMeasure>
        <ConfirmationStatus quantity="2" type="detail" shipmentDate="2022-01-01">
          <UnitOfMeasure>EA</UnitOfMeasure>
          <UnitPrice>
            <Money currency="USD">41.15</Money>
          </UnitPrice>
          <Comments>This product is subject to a per-item packing fee for quantities less than 50.</Comments>
        </ConfirmationStatus>
      </ConfirmationItem>
    </ConfirmationRequest>
  </Request>
</cXML>

Request element details

A standard ConfirmationRequest cXML payload has a root element, a Header element, and a Request element. The subsections below explain each element and its fields.

cXML root

Required Max use: 1

Applies identifying information to the entire payload

Example

<cXML payloadID="12345678" timestamp="2022-11-18T00:00:00Z">
  ...
</cXML>

Root field breakdown

payloadID

POA payload identifier

RequiredType: String

Provides the unique identifier for the POA payload

Example: payloadID="12345678"
timestamp

Payload timestamp

RequiredFormat: ISO 8601

Provides the date and time when the payload was created

Example: timestamp="2022-11-18T00:00:00Z"

Header

Required Max use: 1

Identifies the organizations involved in the POA

Example

<Header>
  <From>
    <Credential domain="NetworkID">
      <Identity>SupplierSystem</Identity>
    </Credential>
  </From>
  <To>
    <Credential domain="NetworkID">
      <Identity>BuyerSystem</Identity>
    </Credential>
  </To>
  <Sender>
    <Credential domain="NetworkID">
      <Identity>SupplierSystem</Identity>
      <SharedSecret>ABCD1234efgh5678.IJKL9012mnopq</SharedSecret>
    </Credential>
    <UserAgent>eCommercePOA</UserAgent>
  </Sender>
</Header>

Header field breakdown

From
Supplier credential

Identifies your organization
- domain Identifier type
  
  RequiredType: String
  
  Specifies the type of identifier provided in the credential
  
  Example: domain="NetworkID"
- Identity Identifier
  
  RequiredType: String
  
  Provides the identifier value for the credential
  
  Example: <Identity>SupplierSystem</Identity>
To
Buyer credential

Identifies the buyer organization
- domain Identifier type
  
  RequiredType: String
  
  Specifies the type of identifier provided in the credential
  
  Example: domain="NetworkID"
- Identity Identifier
  
  RequiredType: String
  
  Provides the identifier value for the credential
  
  Example: <Identity>BuyerSystem</Identity>
Sender
Sender credential

Identifies your system and provides its authentication information
- domain Identifier type
  
  RequiredType: String
  
  Specifies the type of identifier provided in the credential
  
  Example: domain="NetworkID"
- Identity Identifier
  
  RequiredType: String
  
  Provides the identifier value for the credential
  
  Example: <Identity>SupplierSystem</Identity>
- SharedSecret Shared secret
  
  RequiredType: String
  
  Provides your shared secret, which is the password that your organization and TradeCentric agreed to use for authentication
  
  Example: <SharedSecret>ABCD1234efgh5678.IJKL9012mnopq</SharedSecret>
- UserAgent User agent
  
  OptionalType: String
  
  Provides an informational identifier, such as a name, for the sending system
  
  Example: <UserAgent>eCommercePOA</UserAgent>

Request

Required Max use: 1

Provides the POA details, which are described in the subsections below

POA identification

Required Max use: 1

Provides identifying information about the POA

Example

<Request deploymentMode="production">
  <ConfirmationRequest>
    <ConfirmationHeader noticeDate="2022-11-18" type="accept" operation="new" confirmID="POA-123">

POA identification field breakdown

deploymentMode

Deployment mode

RequiredType: StringValues: test, production

Specifies whether the request is for test or production

Example: deploymentMode="production"
ConfirmationHeader
POA header

Required

Provides identifying information about the POA
- noticeDate POA date
  
  RequiredFormat: YYYY-MM-DD
  
  Provides the POA issue date
  
  Example: noticeDate="2022-11-18"
- type POA status
  
  RequiredType: StringValues: accept, reject, except, detail, backordered, requestToPay, replace
  
  Specifies the POA status that your organization is communicating to the buyer
  
  Example: type="accept"
- operation Requested action
  
  RequiredType: String
  
  Specifies the POA action
  
  Example: operation="new" = new document
- confirmID POA identifier
  
  RequiredType: String
  
  Provides the identifier that your organization generated for the POA
  
  Example: confirmID="POA-123"

Total

Required Max use: 1

Provides the total value of the POA

Example

<Total>
  <Money currency="USD">103.97</Money>
</Total>

Total field breakdown

Money
POA total

RequiredType: Number

Provides the total value after applying all discounts or tax, shipping, and handling values

Example: <Money currency="USD">103.97</Money>
- currency Currency
  
  OptionalFormat: ISO 4217
  
  Specifies the currency for the value
  
  Example: currency="USD"

Contacts and addresses

Required Max use: Many

Provides the POA contact and address details

Example

<Contact role="shipTo">
  <Name xml:lang="en">Test Corp. - Nashville Branch</Name>
  <PostalAddress name="Default">
    <DeliverTo>Contact Name</DeliverTo>
    <Street>123 Test St.</Street>
    <City>Nashville</City>
    <State>TN</State>
    <PostalCode>37011</PostalCode>
    <Country isoCountryCode="US">United States</Country>
  </PostalAddress>
  <Email>contact@buyer.com</Email>
  <Phone>
    <TelephoneNumber>
      <CountryCode isoCountryCode="US">1</CountryCode>
      <AreaOrCityCode>888</AreaOrCityCode>
      <Number>555-9876</Number>
    </TelephoneNumber>
  </Phone>
</Contact>
<Contact role="billTo">
  <Name xml:lang="en">Test Corp. - Nashville Branch</Name>
  <PostalAddress name="Default">
    <DeliverTo>Contact Name</DeliverTo>
    <Street>123 Test St.</Street>
    <City>Nashville</City>
    <State>TN</State>
    <PostalCode>37011</PostalCode>
    <Country isoCountryCode="US">United States</Country>
  </PostalAddress>
  <Email>contact@buyer.com</Email>
</Contact>
<Contact role="buyer">
  <Name xml:lang="en-US">Contact Name</Name>
  <Email>contact@testbuyer.com</Email>
</Contact>

Contact field breakdown

role

Contact role

OptionalType: String

Specifies the type of contact provided

Example: role="shipTo", role="billTo", role="buyer"
Name
Contact or address name

OptionalType: String

Provides the contact or address name

Example: <Name xml:lang="en">Test Corp. - Nashville Branch</Name>
- xml:lang Language
  
  OptionalFormat: IETF BCP 47
  
  Specifies the language used for the name
  
  Example: xml:lang="en"
PostalAddress
Postal address

Optional

Provides the address details
- name Address identifier
  
  OptionalType: String
  
  Provides an informational identifier for the address
  
  Example: name="Default"
- DeliverTo Deliver-to contact
  
  OptionalType: String
  
  Provides the name of the delivery contact
  
  Example: <DeliverTo>Contact Name</DeliverTo>
- Street Street address
  
  OptionalType: String
  
  Provides the street address
- City City
  
  OptionalType: String
  
  Provides the city for the address
- State Region
  
  OptionalType: String
  
  Provides the state, province, or region for the address
- PostalCode Postal code
  
  OptionalType: String
  
  Provides the postal code for the address
- Country Country
  
  OptionalType: String
  
  Provides the country for the address
  
  Example: <Country isoCountryCode="US">United States</Country>
  - isoCountryCode Country code
    
    OptionalFormat: ISO 3166
    
    Specifies the country code
    
    Example: isoCountryCode="US"
Email

Contact email address

OptionalType: String

Provides the contact's email address

Example: <Email>contact@buyer.com</Email>
Phone
Contact phone number

Optional

Groups the contact's phone number details
- TelephoneNumber Telephone number
  
  Optional
  
  Provides the phone number values
  - CountryCode Telephone country code
    
    OptionalType: String
    
    Specifies the telephone country code
    
    Example: <CountryCode isoCountryCode="US">1</CountryCode>
    
    isoCountryCode ISO country code
    
    OptionalFormat: ISO 3166
    
    Specifies the ISO country code
    
    Example: isoCountryCode="US"
  - AreaOrCityCode Area or city code
    
    OptionalType: String
    
    Provides the area or city code
    
    Example: <AreaOrCityCode>888</AreaOrCityCode>
  - Number Phone number
    
    OptionalType: String
    
    Provides the phone number
    
    Example: <Number>555-9876</Number>

PO reference

Required Max use: 1

Provides details about the PO that the POA is associated with

Example

<OrderReference orderID="PO-123">
  <DocumentReference payloadID="93369535150910.10.57.136"/>
</OrderReference>

PO reference field breakdown

orderID

Buyer PO identifier

RequiredValue: Same as PO request

Provides the PO identifier from the PO request payload that we sent

Example: orderID="PO-123"
DocumentReference
PO payload reference

Optional

Provides reference information for the PO payload

Example: <DocumentReference payloadID="93369535150910.10.57.136"/>
- payloadID Payload identifier
  
  Optional Value: Same as PO request
  
  Provides the unique payload identifier from the PO request payload that we sent
  
  Example: payloadID="93369535150910.10.57.136"

Items

Required Max use: Many

Provides details about each of the line items in the POA

Example

<ConfirmationItem lineNumber="101" quantity="2">
  <UnitOfMeasure>EA</UnitOfMeasure>
  <ConfirmationStatus quantity="2" type="detail" shipmentDate="2022-01-01">
    <UnitOfMeasure>EA</UnitOfMeasure>
    <UnitPrice>
      <Money currency="USD">41.15</Money>
    </UnitPrice>
    <Comments>This product is subject to a per-item packing fee for quantities less than 50.</Comments>
  </ConfirmationStatus>
</ConfirmationItem>

Items field breakdown

lineNumber

PO line number

RequiredType: String

Provides the line number from the PO request payload that we sent

Example: lineNumber="101"
quantity

Item quantity

RequiredType: Number

Provides the acknowledged item quantity

Example: quantity="2"
UnitOfMeasure

Unit of measure

RequiredType: String

Provides the unit of measure for the item

Example: <UnitOfMeasure>EA</UnitOfMeasure>
ConfirmationStatus
Item status details

Required

Groups the confirmation details for the line item
- quantity Quantity in status
  
  RequiredType: Number
  
  Provides the item quantity that the status applies to
  
  Example: quantity="2"
- type Item status
  
  RequiredType: StringValues: accept, reject, except, detail, backordered, requestToPay, replace
  
  Specifies the status that your organization is communicating for the quantity
  
  Example: type="detail"
- shipmentDate Shipping date
  
  OptionalFormat: YYYY-MM-DD
  
  Provides the shipping date for the quantity
  
  Example: shipmentDate="2022-01-01"
- UnitOfMeasure Unit of measure
  
  OptionalType: String
  
  Provides the unit of measure for the quantity
  
  Example: <UnitOfMeasure>EA</UnitOfMeasure>
- UnitPrice Unit price
  
  Optional
  
  Provides the price of one unit of the item
  - Money Unit price value
    
    OptionalType: Number
    
    Provides the value
    
    Example: <Money currency="USD">41.15</Money>
    
    currency Currency
    
    OptionalFormat: ISO 4217
    
    Specifies the currency for the value
    
    Example: currency="USD"
- Comments Item comments
  
  OptionalType: String
  
  Provides any additional details about the item
  
  Example: <Comments>This product is subject to a per-item packing fee for quantities less than 50.</Comments>

Response payload (from TradeCentric)

Once our platform receives the POA request, we'll validate it and then return a cXML response payload. This response will indicate whether we created a final POA payload to transmit to the buyer.

The code block below shows an example response in our standard cXML format:

cXML

HTTP response

POA response

<?xml version="1.0" encoding="UTF-8"?>
<cXML xml:lang="en-US" payloadID="12345678-response" timestamp="2022-11-18T00:00:01Z">
  <Response>
    <Status code="200" text="OK">Successful</Status>
  </Response>
</cXML>

Response element details

A standard cXML response has a root element and a Response element. The subsections below explain each element and its fields.

cXML root

Applies identifying information to the entire response payload

Example

<cXML xml:lang="en-US" payloadID="12345678-response" timestamp="2022-11-18T00:00:01Z">
  ...
</cXML>

Root field breakdown

xml:lang

Language

Format: IETF BCP 47

Specifies the language used for the response

Example: xml:lang="en-US"
payloadID

Payload identifier

Type: String

Provides a unique identifier for the response

Example: payloadID="12345678-response"
timestamp

Response timestamp

Format: ISO 8601

Provides the date and time when the response was created

Example: timestamp="2022-11-18T00:00:01Z"

Response

Indicates that we either accepted or rejected the POA

Note: Errors are limited at this step of the process. For example, error responses may not indicate the specific issue on the buyer's side.

Example

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

Response field breakdown

Status
Response status

Specifies the success or error status and a corresponding message

Example: <Status code="200" text="OK">Successful</Status>, <Status code="400" text="Bad request">orderDate in OrderReference element does not match the original orderDate in PO</Status>
- code Status code
  
  Format: HTTP status code
  
  Provides the response status code
  
  Example: code="200" = success, code="400" = error
- text Status text
  
  Type: String
  
  Provides a brief description of the status
  
  Example: text="OK", text="Bad request"

Request payload (to TradeCentric)

Request element details

cXML root

POA payload identifier

Payload timestamp

Header

Supplier credential

Buyer credential

Sender credential

Request

POA identification

Deployment mode

POA header

Total

POA total

Contacts and addresses

PO reference

Buyer PO identifier

PO payload reference

Items

PO line number

Item quantity

Unit of measure

Item status details

Response payload (from TradeCentric)

Response element details

cXML root

Language

Payload identifier

Response timestamp

Response

Response status

Related articles