TaxDutyQuoteResponse → OrderCreateRequest

There is tax information throughout the Pricing section on each OrderItem in an OrderCreateRequest. This tax information comes from the TaxDutyQuoteResponse. The mappings and examples below will stop at TaxData elements because they are the same type in each request; they map to each other perfectly. As such the mappings and examples will focus on where these TaxData elements are in the TaxDutyQuoteResponse and OrderCreateRequest.

Promotion-related tax information is left out of this mapping because the TaxDutyQuoteResponse will always return zeroes (0) for it. You do not need to worry about copying these zero values over to OrderCreateRequest (though doing so will not harm anything either).

In addition to the item-specific tax data, there is an order-level Tax Transaction ID. This value, found in /TaxDutyQuoteResponse/TaxTransactionid, can optionally be copied to /OrderCreateRequest/Order/TaxHeader/@taxTransactionId.

Mapping

The TaxDutyQuoteResponse field mappings start at: /TaxDutyQuoteResponse/Shipping/ShipGroups/ShipGroup/Items/OrderItem/Pricing

The OrderCreateRequest field mappings start at: /OrderCreateRequest/Order/OrderItems/OrderItem/Pricing

The OrderItem elements are matched up by the lineNumber attribute for TaxDutyQuoteResponse and the webLineId attribute for OrderCreateRequest.

TaxDutyQuoteResponse Field	OrderCreateRequest Field	Transform
//Merchandise/TaxData	//Merchandise/TaxData	copy as is
//Shipping/TaxData	//Shipping/TaxData	copy as is
//Duty/TaxData	//Duty/TaxData	copy as is
//Fees/Fee/Charge/TaxData	//Fees/Fee/TaxData	copy as is

TaxDutyQuoteResponse Field

OrderCreateRequest Field

Transform

Comment

//Merchandise/TaxData

copy as is

//Shipping/TaxData

copy as is

//Duty/TaxData

copy as is

//Fees/Fee/Charge/TaxData

//Fees/Fee/TaxData

copy as is

Mapping Example

<?xml version="1.0" encoding="UTF-8"?>
<TaxDutyQuoteResponse
    xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
  <Shipping>
    <ShipGroups>
      <ShipGroup id="shipgroup_1" chargeType="FLATRATE">
        <DestinationTarget ref="dest_1"/>
        <Items>
          <OrderItem lineNumber="1"> (1)
            <ItemId>12-345</ItemId> (2)
            ...
            <Pricing>
              <Merchandise>
                <Amount>123.45</Amount>
                <TaxData> (3)
                  ...
                </TaxData>
                <UnitPrice>123.45</UnitPrice>
              </Merchandise>
              <Shipping>
                <Amount>12.34</Amount>
                <TaxData> (4)
                  ...
                </TaxData>
              </Shipping>
              <Duty>
                <Amount>1.23</Amount>
                <TaxData> (5)
                  ...
                </TaxData>
              </Duty>
              <Fees>
                <Fee>
                  ...
                  <Charge>
                    <Amount>1.23</Amount>
                    <TaxData> (6)
                      ...
                    </TaxData>
                  </Charge>
                </Fee>
              </Fees>
            </Pricing>
          </OrderItem>
        </Items>
      </ShipGroup>
    </ShipGroups>
  </Shipping>
  <TaxTransactionId>3721007</TaxTransactionId>
</TaxDutyQuoteResponse>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<OrderCreateRequest
    xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
    requestId="123456789">
  <Order customerOrderId="12345">
    ...
    <OrderItems>
      <OrderItem id="orderItem1" webLineId="1"> (1)
        <ItemId>12-345</ItemId> (2)
        ...
        <Pricing>
          <Merchandise>
            <Amount>123.45</Amount>
            <TaxData> (3)
              ...
            </TaxData>
            <UnitPrice>123.45</UnitPrice>
          </Merchandise>
          <Shipping>
            <Amount>12.34</Amount>
            <TaxData> (4)
              ...
            </TaxData>
          </Shipping>
          <Duty>
            <Amount>1.23</Amount>
            <TaxData> (5)
              ...
            </TaxData>
          </Duty>
          <Fees>
            <Fee>
              ...
              <TaxData> (6)
                ...
              </TaxData>
            </Fee>
          </Fees>
        </Pricing>
        ...
      </OrderItem>
    </OrderItems>
  </Order>
  ...
  <TaxHeader taxTransactionId=”3721007”>
    <Error>false</Error>
  </TaxHeader>
</OrderCreateRequest>