Developers Program

Getting ContainingOrder

Published: October 19 2006, 4:04:00 PMยทUpdated: August 01 2022, 9:39:17 AM

Products

Answer

Detailed Description

ContainingOrder container consists some of an order information as OrderID, OrderStatus and CreatingUserRole for a given transaction as below:
< ContainingOrder>
<
OrderID>698876</OrderID>
<OrderStatus>Active</OrderStatus>
<CreatingUserRole>Seller</CreatingUserRole>
</ContainingOrder>

The property is returned in the Transaction container for either GetSellerTransactions or GetItem call if the following conditions are true:

1. IncludeContainingOrder flag is set to true in the request
2. This transaction belongs to an active or completed order

Here is the sample GetItemTransaction request and part of the response.

<?xml version="1.0" encoding="utf-8" ?>
<GetItemTransactionsRequestxmlns="urn:ebay:apis:eBLBaseComponents">
<Version>967</Version>

<ItemID>110008398632</ItemID>
<ModTimeFrom>2006-10-01T18:28:52.799Z</ModTimeFrom>
<ModTimeTo>2006-10-30T18:28:52.799Z</ModTimeTo>
< IncludeContainingOrder>true</IncludeContainingOrder>
<RequesterCredentials><eBayAuthToken>TOKEN</eBayAuthToken>
</
RequesterCredentials>
</GetItemTransactionsRequest>

<?xml version="1.0" encoding="UTF-8" ?>
<GetItemTransactionsResponsexmlns="urn:ebay:apis:eBLBaseComponents">
...
<Item>
...
<ItemID>110008398632</ItemID>
...
<QuantitySold>1</QuantitySold>
...
<ListingStatus>Completed</ListingStatus>
...
</Item>
<TransactionArray>
<Transaction>
....
<Status>
...
<CompleteStatus>Incomplete</CompleteStatus>
<BuyerSelectedShipping>false</BuyerSelectedShipping>
</Status>
<TransactionID>0</TransactionID>
..
<ContainingOrder>
<OrderID>698876</OrderID>
<OrderStatus>Active</OrderStatus>
<CreatingUserRole>Seller</CreatingUserRole>
</ContainingOrder>

<TransactionPlatform>eBay</TransactionPlatform>
</Transaction>
</TransactionArray>
<PayPalPreferred>false</PayPalPreferred>
</GetItemTransactionsResponse>

Additional Resource
How well did this answer your question?