Exemplo n.º 1
0
        /// <summary>
        /// Retrieves information about one or more orders based on OrderIDs, ItemIDs, or SKU values. &nbsp;<b>Also for Half.com</b>.
        /// </summary>
        ///
        /// <param name="ItemTransactionIDArrayList">
        /// An array of one or more <b>ItemTransactionID</b> containers. Each
        /// <b>ItemTransactionID</b> container identifies an order line item
        /// to retrieve in the response.
        /// </param>
        ///
        /// <param name="OrderIDArrayList">
        /// An array of one or more <b>OrderID</b> containers. Each
        /// <b>OrderID</b> container identifies an order to retrieve in the response.
        /// Up to 20 orders (using 20 <b>OrderID</b> containers) can be
        /// retrieved with one <b>GetOrderTransactions</b> call.
        /// </param>
        ///
        /// <param name="Platform">
        /// Name of the eBay co-branded site upon which the order line item was created.
        /// This will serve as a filter for the orders to get emitted in the response.
        /// </param>
        ///
        /// <param name="IncludeFinalValueFees">
        /// Indicates whether to include Final Value Fee (FVF) in the response. For most
        /// listing types, the Final Value Fee is returned in Transaction.FinalValueFee.
        /// The Final Value Fee is returned for each order line item (Transaction
        /// container) for fixed-price listings. For all other listing
        /// types, the Final Value Fee is returned when the listing status is Completed.
        /// This value is not returned if the auction ended with Buy It Now.
        /// </param>
        ///
        public OrderTypeCollection GetOrderTransactions(ItemTransactionIDTypeCollection ItemTransactionIDArrayList, StringCollection OrderIDArrayList, TransactionPlatformCodeType Platform, bool IncludeFinalValueFees)
        {
            this.ItemTransactionIDArrayList = ItemTransactionIDArrayList;
            this.OrderIDArrayList           = OrderIDArrayList;
            this.Platform = Platform;
            this.IncludeFinalValueFees = IncludeFinalValueFees;

            Execute();
            return(ApiResponse.OrderArray);
        }
        /// <summary>
        /// Retrieves order line item information for a specified <b>ItemID</b>. &
        /// nbsp;<b>Also for Half.com</b>. The call returns zero, one, or
        /// multiple order line items, depending on the number of items sold from the listing.
        ///
        /// You can retrieve order line item data for a specific time range or
        /// number of days. If you don't specify a range or number of days, order line item
        /// data will be returned for the past 30 days.
        /// </summary>
        ///
        /// <param name="ItemID">
        /// Unique identifier for an eBay item listing. A listing can have multiple
        /// order line items (transactions), but only one <b>ItemID</b>. When you use
        /// <b>ItemID</b> alone, eBay returns all order line items that are associated with
        /// the <b>ItemID</b> (listing). If you pair <b>ItemID</b> with a specific <b>TransactionID</b>,
        /// data on a specific order line item is returned. If <b>OrderLineItemID</b> is
        /// specified in the request, any <b>ItemID</b>/<b>TransactionID</b> pair specified in the
        /// same request will be ignored.
        ///
        ///
        /// <span class="tablenote"><b>Note:</b>
        /// <b>GetItemTransactions</b> doesn't support SKU as an input because this
        /// call requires an identifier that is unique across your active
        /// and ended listings. Even when <b>InventoryTrackingMethod</b> is set to
        /// <b>SKU</b> in a listing, the SKU is only unique across your active
        /// listings (not your ended listings). To retrieve order line items
        /// by SKU, use <b>GetSellerTransactions</b> or <b>GetOrderTransactions</b> instead.
        /// </span>
        /// </param>
        ///
        /// <param name="ModTimeFrom">
        /// The <b>ModTimeFrom</b> and <b>ModTimeTo</b> fields specify a date range for retrieving
        /// order line items associated with the specified <b>ItemID</b>. The <b>ModTimeFrom</b>
        /// field is the starting date range. All eBay order line items that were
        /// last modified within this date range are returned in the output. The
        /// maximum date range that may be specified is 30 days. This field is not
        /// applicable if a specific <b>TransactionID</b> or <b>OrderLineItemID</b> is included in
        /// the request or if the <b>NumberOfDays</b> date filter is used.
        ///
        /// If you don't specify a <b>ModTimeFrom</b>/<b>ModTimeTo</b> filter, the <b>NumberOfDays</b>
        /// time filter is used and it defaults to 30 (days).
        /// </param>
        ///
        /// <param name="ModTimeTo">
        /// The <b>ModTimeFrom</b> and <b>ModTimeTo</b> fields specify a date range for retrieving
        /// order line items associated with the specified <b>ItemID</b>. The <b>ModTimeTo</b>
        /// field is the ending date range. All eBay order line items that were last
        /// modified within this date range are returned in the output. The maximum
        /// date range that may be specified is 30 days. If the <b>ModTimeFrom</b> field is
        /// used and the <b>ModTimeTo</b> field is omitted, the <b>ModTimeTo</b> value defaults to
        /// the present time or to 30 days past the <b>ModTimeFrom</b> value (if
        /// <b>ModTimeFrom</b> value is more than 30 days in the past). This field is not
        /// applicable if a specific <b>TransactionID</b> or <b>OrderLineItemID</b> is included in
        /// the request or if the <b>NumberOfDays</b> date filter is used.
        ///
        /// If you don't specify a <b>ModTimeFrom</b>/<b>ModTimeTo</b> filter, the <b>NumberOfDays</b>
        /// time filter is used and it defaults to 30 (days).
        /// </param>
        ///
        /// <param name="TransactionID">
        /// Include a <b>TransactionID</b> field in the request if you want to retrieve the
        /// data for a specific order line item (transaction). If a <b>TransactionID</b> is
        /// provided, any specified time filter is ignored.
        /// </param>
        ///
        /// <param name="Pagination">
        /// Child elements control pagination of the output. Use the <b>EntriesPerPage</b>
        /// property to control the number of order line items to
        /// return per call and the <b>PageNumber</b> property to specify the specific page
        /// of data to return. If multiple pages of order line items are returned
        /// based on input criteria and Pagination properties, <b>GetItemTransactions</b>
        /// will need to be called multiple times (with the <b>PageNumber</b> value being
        /// increased by 1 each time) to scroll through all results.
        /// </param>
        ///
        /// <param name="IncludeFinalValueFee">
        /// Indicates whether to include the Final Value Fee (FVF) for all order
        /// line items in the response. The Final Value Fee is
        /// returned in the <b>Transaction.FinalValueFee</b> field. The Final Value Fee is
        /// assessed right after the creation of an order line item.
        /// </param>
        ///
        /// <param name="IncludeContainingOrder">
        /// Include this field and set it to True if you want the <b>ContainingOrder</b>
        /// container to be returned in the response under each <b>Transaction</b> node.
        /// For single line item orders, the <b>ContainingOrder.OrderID</b> value takes the
        /// value of the <b>OrderLineItemID</b> value for the order line item. For
        /// <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice">Combined Invoice</a> orders,
        /// the <b>ContainingOrder.OrderID</b> value will be shared by at
        /// least two order line items (transactions) that are part of the same order.
        /// </param>
        ///
        /// <param name="Platform">
        /// The default behavior of <b>GetItemTransactions</b> is to retrieve all order line items originating from eBay.com and Half.com. If the user wants to retrieve only eBay.com order line items or Half.com order line items, this filter can be used to perform that function. Inserting 'eBay' into this field will restrict retrieved order line items to those originating on eBay.com, and inserting 'Half' into this field will restrict retrieved order line items to those originating on Half.com.
        /// </param>
        ///
        /// <param name="NumberOfDays">
        /// This time filter specifies the number of days (24-hour periods) in the
        /// past to search for order line items. All eBay order line items that were
        /// either created or modified within this period are returned in the
        /// response. If specified, <b>NumberOfDays</b> will override any date range
        /// specified with the <b>ModTimeFrom</b>/<b>ModTimeTo</b> time filters. This field is not
        /// applicable if a specific <b>TransactionID</b> or <b>OrderLineItemID</b> is included in
        /// the request.
        /// </param>
        ///
        /// <param name="IncludeVariations">
        /// If included in the request and set to True, all variations defined for
        /// the item are returned at the root level, including variations
        /// that have no sales. If not included in the request or set to false, the
        /// variations with sales are still returned in separate <b>Transaction</b> nodes. This information is intended to help sellers to reconcile their
        /// local inventory with eBay's records, while processing order line items
        /// (without requiring a separate call to <b>GetItem</b>).
        /// </param>
        ///
        /// <param name="OrderLineItemID">
        /// A unique identifier for an eBay order line item. This field is created
        /// as soon as there is a commitment to buy from the seller, and its value
        /// is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a
        /// hyphen in between these two IDs. If you want to retrieve data on a
        /// specific order line item, you can use an <b>OrderLineItemID</b> value in the
        /// request instead of the <b>ItemID</b>/<b>TransactionID</b> pair. If an <b>OrderLineItemID</b> is
        /// provided, any specified time filter is ignored.
        /// </param>
        ///
        public TransactionTypeCollection GetItemTransactions(string ItemID, DateTime ModTimeFrom, DateTime ModTimeTo, string TransactionID, PaginationType Pagination, bool IncludeFinalValueFee, bool IncludeContainingOrder, TransactionPlatformCodeType Platform, int NumberOfDays, bool IncludeVariations, string OrderLineItemID)
        {
            this.ItemID                 = ItemID;
            this.ModTimeFrom            = ModTimeFrom;
            this.ModTimeTo              = ModTimeTo;
            this.TransactionID          = TransactionID;
            this.Pagination             = Pagination;
            this.IncludeFinalValueFee   = IncludeFinalValueFee;
            this.IncludeContainingOrder = IncludeContainingOrder;
            this.Platform               = Platform;
            this.NumberOfDays           = NumberOfDays;
            this.IncludeVariations      = IncludeVariations;
            this.OrderLineItemID        = OrderLineItemID;

            Execute();
            return(ApiResponse.TransactionArray);
        }
Exemplo n.º 3
0
        /// <summary>
        /// Retrieves a seller's order line item information. To retrieve order line items for another seller, the <b>GetItemTransactions</b>) call must be used. This call cannot retrieve sales older than 90 days old.
        /// </summary>
        ///
        /// <param name="ModTimeFrom">
        /// The <b>ModTimeFrom</b> and <b>ModTimeTo</b> fields specify a date range for retrieving order line items associated with the seller. The <b>ModTimeFrom</b> field is the starting date range. All of the seller's order line items that were last modified within this date range are returned in the output.  The maximum date range that may be specified is 30 days. This value cannot be set back more than 90 days in the past, as this call cannot retrieve sales older than 90 days old. This field is not applicable if the <b>NumberOfDays</b> date filter is used.
        ///
        /// If you don't specify a <b>ModTimeFrom</b>/<b>ModTimeTo</b> filter, the <b>NumberOfDays</b> time filter is used and it defaults to 30 (days).
        /// </param>
        ///
        /// <param name="ModTimeTo">
        /// The <b>ModTimeFrom</b> and <b>ModTimeTo</b> fields specify a date range for retrieving
        /// order line items associated with the seller. The <b>ModTimeTo</b>
        /// field is the ending date range. All of the seller's order line items that were last
        /// modified within this date range are returned in the output.
        /// <br/><br/>
        /// The maximum
        /// date range that may be specified is 30 days.
        /// <br/><br/>
        /// If the <b>ModTimeFrom</b> field is
        /// used and the <b>ModTimeTo</b> field is omitted, the <b>ModTimeTo</b> value defaults to
        /// the present time or to 30 days past the <b>ModTimeFrom</b> value (if
        /// <b>ModTimeFrom</b> value is more than 30 days in the past). This field is not
        /// applicable if the <b>NumberOfDays</b> date filter is used.
        ///
        /// If you don't specify a <b>ModTimeFrom</b>/<b>ModTimeTo</b> filter, the <b>NumberOfDays</b>
        /// time filter is used and it defaults to 30 (days).
        /// </param>
        ///
        /// <param name="Pagination">
        /// Child elements control pagination of the output. Use <b>EntriesPerPage</b> property to
        /// control the number of transactions to return per call and <b>PageNumber</b> property to
        /// specify the page of data to return.
        /// </param>
        ///
        /// <param name="IncludeFinalValueFee">
        /// Indicates whether to include Final Value Fee (FVF) in the response. For most listing types, the Final Value Fee is returned in <b>Transaction.FinalValueFee</b>. The Final Value Fee is returned for each order line item.
        ///
        /// </param>
        ///
        /// <param name="IncludeContainingOrder">
        /// Include this field and set it to <code>true</code> if you want the <b>ContainingOrder</b> container to be returned in the response under each <b>Transaction</b> node. For single line item orders, the <b>ContainingOrder.OrderID</b> value takes the value of the <b>OrderLineItemID</b> value for the order line item. For Combined Invoice orders, the <b>ContainingOrder.OrderID</b> value will be shared by at least two order line items (transactions) that are part of the same order.
        /// </param>
        ///
        /// <param name="SKUArrayList">
        /// Container for a set of SKUs. Filters (reduces) the response to only include order line items for listings that include any of the specified SKUs. If multiple listings include the same SKU, order line items for all of them are returned (assuming they also match the other criteria in the <b>GetSellerTransactions</b> request).  You can combine SKUArray with <b>InventoryTrackingMethod</b>. For example, if you also pass in <code>InventoryTrackingMethod=SKU</code>, the response only includes order line items for listings that include <code>InventoryTrackingMethod=SKU</code> and one of the requested SKUs.
        /// </param>
        ///
        /// <param name="Platform">
        /// <span class="tablenote"><b>Note: </b> This field's purpose is to allow the seller to retrieve only eBay listings or only Half.com listings instead of both order types. Since the Half.com site has been shut down, this field is no longer necessary to use since eBay orders will be the only orders that are retrieved.
        /// </span>
        /// The default behavior of <b>GetSellerTransactions</b> is to retrieve all order line items originating from eBay.com and Half.com. If the user wants to retrieve only eBay.com order line items or Half.com order line items, this filter can be used to perform that function. Inserting 'eBay' into this field will restrict retrieved order line items to those originating on eBay.com, and inserting 'Half' into this field will restrict retrieved order line items to those originating on Half.com.
        /// </param>
        ///
        /// <param name="NumberOfDays">
        /// Enables you to specify the number of days' worth of new and modified
        /// order line items that you want to retrieve. The maximum value for this field is <code>30</code>
        /// <br/><br/>
        /// The call response contains the order line items whose status was modified within the specified number of days since the API call was made. <b>NumberOfDays</b> is often preferable to using the <b>ModTimeFrom</b> and <b>ModTimeTo</b> filters because you only need to specify one value. If you use <b>NumberOfDays</b>, then <b>ModTimeFrom</b> and <b>ModTimeTo</b> are ignored.
        /// <br/><br/>
        /// For this field, one day is defined as 24 hours.
        /// </param>
        ///
        /// <param name="InventoryTrackingMethod">
        /// Filters the response to only include order line items for listings
        /// that match this <b>InventoryTrackingMethod</b> setting.
        ///
        /// For example,
        /// <b></b>
        /// <ul>
        /// <li>If you set this to <b>SKU</b>, the call returns order line items for your listings that are tracked by SKU.</li>
        /// <li>If you set this to <b>ItemID</b>, the call omits order line items for your listings that are tracked by SKU.</li>
        /// <li>If you don't pass this in, the call returns all order line items, regardless of whether they are tracked by <b>SKU</b>, or <b>ItemID</b>.</li>
        /// </ul>
        ///
        /// <span class="tablenote"><b>Note:</b>
        /// To specify the <b>InventoryTrackingMethod</b> when you create a listing, use <b>AddFixedPriceItem</b> or <b>RelistFixedPriceItem</b>.
        /// <b>AddFixedPriceItem</b> and <b>RelistFixedPriceItem</b> are defined in
        /// the Merchant Data API (part of Large Merchant Services).
        /// </span>
        ///
        /// You can combine <b>SKUArray</b> with <b>InventoryTrackingMethod</b>.
        /// For example, if you set this to SKU and you also pass in
        /// <b>SKUArray</b>, the response only includes order line items for listings
        /// that include <code>InventoryTrackingMethod</code> = <code>SKU</code> and one of the
        /// requested SKUs.
        /// </param>
        ///
        /// <param name="IncludeCodiceFiscale">
        /// If this field is included in the call request and set to <code>true</code>, taxpayer identification information for the buyer is returned under the <b>BuyerTaxIdentifier</b>
        /// Codice Fiscale is only applicable to buyers on the Italy and Spain sites. It is required that buyers on the Italy site provide their Codice Fiscale ID before buying an item, and sellers on the Spain site have the option of requiring buyers on the Spain site to provide their taxpayer ID.
        /// </param>
        ///
        public List <TransactionType> GetSellerTransactions(DateTime ModTimeFrom, DateTime ModTimeTo, PaginationType Pagination, bool IncludeFinalValueFee, bool IncludeContainingOrder, List <string> SKUArrayList, TransactionPlatformCodeType Platform, int NumberOfDays, InventoryTrackingMethodCodeType InventoryTrackingMethod, bool IncludeCodiceFiscale)
        {
            this.ModTimeFrom            = ModTimeFrom;
            this.ModTimeTo              = ModTimeTo;
            this.Pagination             = Pagination;
            this.IncludeFinalValueFee   = IncludeFinalValueFee;
            this.IncludeContainingOrder = IncludeContainingOrder;
            this.SKUArrayList           = SKUArrayList;
            this.Platform                = Platform;
            this.NumberOfDays            = NumberOfDays;
            this.InventoryTrackingMethod = InventoryTrackingMethod;
            this.IncludeCodiceFiscale    = IncludeCodiceFiscale;

            Execute();
            return(ApiResponse.TransactionArray);
        }
		/// <summary>
		/// Retrieves order line item (transaction) information for the user for which the
		/// call is made, and not for any other user.&nbsp;<b>Also for
		/// Half.com</b>. (To retrieve order line items for another seller's listings, use
		/// GetItemTransactions.)
		/// </summary>
		/// 
		/// <param name="ModTimeFrom">
		/// The ModTimeFrom and ModTimeTo fields specify a date range for retrieving
		/// order line items associated with the seller. The ModTimeFrom
		/// field is the starting date range. All of the seller's order line items that were
		/// last modified within this date range are returned in the output. The
		/// maximum date range that may be specified is 30 days. This field is not
		/// applicable if the NumberOfDays date filter is used.
		/// 
		/// If you don't specify a ModTimeFrom/ModTimeTo filter, the NumberOfDays
		/// time filter is used and it defaults to 30 (days). 
		/// </param>
		///
		/// <param name="ModTimeTo">
		/// The ModTimeFrom and ModTimeTo fields specify a date range for retrieving
		/// order line items associated with the seller. The ModTimeTo
		/// field is the ending date range. All of the seller's order line items that were last
		/// modified within this date range are returned in the output. The maximum
		/// date range that may be specified is 30 days. If the ModTimeFrom field is
		/// used and the ModTimeTo field is omitted, the ModTimeTo value defaults to
		/// the present time or to 30 days past the ModTimeFrom value (if
		/// ModTimeFrom value is more than 30 days in the past). This field is not
		/// applicable if the NumberOfDays date filter is used.
		/// 
		/// If you don't specify a ModTimeFrom/ModTimeTo filter, the NumberOfDays
		/// time filter is used and it defaults to 30 (days).
		/// </param>
		///
		/// <param name="Pagination">
		/// Child elements control pagination of the output. Use EntriesPerPage property to
		/// control the number of transactions to return per call and PageNumber property to
		/// specify the page of data to return.
		/// </param>
		///
		/// <param name="IncludeFinalValueFee">
		/// Indicates whether to include Final Value Fee (FVF) in the response. For most
		/// listing types, the Final Value Fee is returned in Transaction.FinalValueFee.
		/// The Final Value Fee is returned for each order line item.
		/// 
		/// </param>
		///
		/// <param name="IncludeContainingOrder">
		/// Include this field and set it to True if you want the ContainingOrder
		/// container to be returned in the response under each Transaction node.
		/// For single line item orders, the ContainingOrder.OrderID value takes the
		/// value of the OrderLineItemID value for the order line item. For Combined
		/// Payment orders, the ContainingOrder.OrderID value will be shared by at
		/// least two order line items (transactions) that are part of the same
		/// order.
		/// </param>
		///
		/// <param name="SKUArrayList">
		/// Container for a set of SKUs.
		/// Filters (reduces) the response to only include order line items
		/// for listings that include any of the specified SKUs.
		/// If multiple listings include the same SKU, order line items for
		/// all of them are returned (assuming they also match the other
		/// criteria in the GetSellerTransactions request).
		/// 
		/// You can combine SKUArray with InventoryTrackingMethod.
		/// For example, if you also pass in InventoryTrackingMethod=SKU,
		/// the response only includes order line items for listings that
		/// include InventoryTrackingMethod=SKU and one of the
		/// requested SKUs.
		/// </param>
		///
		/// <param name="Platform">
		/// The default behavior of <b>GetSellerTransactions</b> is to retrieve all order line items originating from eBay.com and Half.com. If the user wants to retrieve only eBay.com order line items or Half.com order line items, this filter can be used to perform that function. Inserting 'eBay' into this field will restrict retrieved order line items to those originating on eBay.com, and inserting 'Half' into this field will restrict retrieved order line items to those originating on Half.com.
		/// </param>
		///
		/// <param name="NumberOfDays">
		/// NumberOfDays enables you to specify the number of days' worth of new and modified
		/// order line items that you want to retrieve. The call response contains the
		/// order line items whose status was modified within the specified number of days since
		/// the API call was made. NumberOfDays is often preferable to using the ModTimeFrom
		/// and ModTimeTo filters because you only need to specify one value. If you use
		/// NumberOfDays, then ModTimeFrom and ModTimeTo are ignored. For this field, one day
		/// is defined as 24 hours.
		/// </param>
		///
		/// <param name="InventoryTrackingMethod">
		/// Filters the response to only include order line items for listings
		/// that match this InventoryTrackingMethod setting. 
		/// 
		/// For example, if you set this to SKU, the call returns
		/// order line items for your listings that are tracked by SKU.
		/// If you set this to ItemID, the call omits order line items
		/// for your listings that are tracked by SKU.
		/// If you don't pass this in, the call returns all order line items,
		/// regardless of whether they are tracked by SKU or ItemID.
		/// 
		/// <span class="tablenote"><b>Note:</b>
		/// To specify InventoryTrackingMethod when you create a listing,
		/// use AddFixedPriceItem or RelistFixedPriceItem.
		/// AddFixedPriceItem and RelistFixedPriceItem are defined in
		/// the Merchant Data API (part of Large Merchant Services).
		/// </span>
		/// 
		/// 
		/// You can combine SKUArray with InventoryTrackingMethod.
		/// For example, if you set this to SKU and you also pass in
		/// SKUArray, the response only includes order line items for listings
		/// that include InventoryTrackingMethod=SKU and one of the
		/// requested SKUs.
		/// </param>
		///
		/// <param name="IncludeCodiceFiscale">
		/// If true, returns the Tax code for the user.
		/// </param>
		///
		public TransactionTypeCollection GetSellerTransactions(DateTime ModTimeFrom, DateTime ModTimeTo, PaginationType Pagination, bool IncludeFinalValueFee, bool IncludeContainingOrder, StringCollection SKUArrayList, TransactionPlatformCodeType Platform, int NumberOfDays, InventoryTrackingMethodCodeType InventoryTrackingMethod, bool IncludeCodiceFiscale)
		{
			this.ModTimeFrom = ModTimeFrom;
			this.ModTimeTo = ModTimeTo;
			this.Pagination = Pagination;
			this.IncludeFinalValueFee = IncludeFinalValueFee;
			this.IncludeContainingOrder = IncludeContainingOrder;
			this.SKUArrayList = SKUArrayList;
			this.Platform = Platform;
			this.NumberOfDays = NumberOfDays;
			this.InventoryTrackingMethod = InventoryTrackingMethod;
			this.IncludeCodiceFiscale = IncludeCodiceFiscale;

			Execute();
			return ApiResponse.TransactionArray;
		}
		/// <summary>
		/// Use this call to retrieve information about one or more orders based on OrderIDs, ItemIDs, or SKU values. &nbsp;<b>Also for Half.com</b>.
		/// </summary>
		/// 
		/// <param name="ItemTransactionIDArrayList">
		/// An array of ItemTransactionIDs.
		/// </param>
		///
		/// <param name="OrderIDArrayList">
		/// An array of OrderIDs. You can specify, at most, twenty OrderIDs.
		/// </param>
		///
		/// <param name="Platform">
		/// The default behavior of <b>GetOrderTransactions</b> is to retrieve all orders originating from eBay.com and Half.com. If the user wants to retrieve only eBay.com order line items or Half.com order line items, this filter can be used to perform that function. Inserting 'eBay' into this field will restrict retrieved order line items to those originating on eBay.com, and inserting 'Half' into this field will restrict retrieved order line items to those originating on Half.com.
		/// </param>
		///
		/// <param name="IncludeFinalValueFees">
		/// Indicates whether to include Final Value Fee (FVF) in the response. For most
		/// listing types, the Final Value Fee is returned in Transaction.FinalValueFee.
		/// The Final Value Fee is returned on a transaction-by-transaction basis for
		/// FixedPriceItem and StoresFixedPrice listing types. For all other listing
		/// types, the Final Value Fee is returned when the listing status is Completed.
		/// This value is not returned if the auction ended with Buy It Now.
		/// 
		/// For Dutch Buy It Now listings, the Final Value Fee is returned on a
		/// transaction-by-transaction basis.
		/// 
		/// <span class="tablenote"><strong>Note:</strong>
		/// As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated.
		/// eBay throws an error if you submit a Dutch item listing with AddItem
		/// or VerifyAddItem. If you use RelistItem to update a Dutch auction listing,
		/// eBay generates a warning and resets the Quantity value to 1.
		/// </span>
		/// 
		/// </param>
		///
		public OrderTypeCollection GetOrderTransactions(ItemTransactionIDTypeCollection ItemTransactionIDArrayList, StringCollection OrderIDArrayList, TransactionPlatformCodeType Platform, bool IncludeFinalValueFees)
		{
			this.ItemTransactionIDArrayList = ItemTransactionIDArrayList;
			this.OrderIDArrayList = OrderIDArrayList;
			this.Platform = Platform;
			this.IncludeFinalValueFees = IncludeFinalValueFees;

			Execute();
			return ApiResponse.OrderArray;
		}
		/// <summary>
		/// Retrieves order line item information for a specified <b>ItemID</b>. &
		/// nbsp;<b>Also for Half.com</b>. The call returns zero, one, or
		/// multiple order line items, depending on the number of items sold from the listing.
		/// 
		/// You can retrieve order line item data for a specific time range or
		/// number of days. If you don't specify a range or number of days, order line item
		/// data will be returned for the past 30 days.
		/// </summary>
		/// 
		/// <param name="ItemID">
		/// Unique identifier for an eBay item listing. A listing can have multiple
		/// order line items (transactions), but only one <b>ItemID</b>. When you use
		/// <b>ItemID</b> alone, eBay returns all order line items that are associated with
		/// the <b>ItemID</b> (listing). If you pair <b>ItemID</b> with a specific <b>TransactionID</b>,
		/// data on a specific order line item is returned. If <b>OrderLineItemID</b> is
		/// specified in the request, any <b>ItemID</b>/<b>TransactionID</b> pair specified in the
		/// same request will be ignored.
		/// 
		/// 
		/// <span class="tablenote"><b>Note:</b>
		/// <b>GetItemTransactions</b> doesn't support SKU as an input because this
		/// call requires an identifier that is unique across your active
		/// and ended listings. Even when <b>InventoryTrackingMethod</b> is set to
		/// <b>SKU</b> in a listing, the SKU is only unique across your active
		/// listings (not your ended listings). To retrieve order line items
		/// by SKU, use <b>GetSellerTransactions</b> or <b>GetOrderTransactions</b> instead.
		/// </span>
		/// </param>
		///
		/// <param name="ModTimeFrom">
		/// The <b>ModTimeFrom</b> and <b>ModTimeTo</b> fields specify a date range for retrieving
		/// order line items associated with the specified <b>ItemID</b>. The <b>ModTimeFrom</b>
		/// field is the starting date range. All eBay order line items that were
		/// last modified within this date range are returned in the output. The
		/// maximum date range that may be specified is 30 days. This field is not
		/// applicable if a specific <b>TransactionID</b> or <b>OrderLineItemID</b> is included in
		/// the request or if the <b>NumberOfDays</b> date filter is used.
		/// 
		/// If you don't specify a <b>ModTimeFrom</b>/<b>ModTimeTo</b> filter, the <b>NumberOfDays</b>
		/// time filter is used and it defaults to 30 (days). 
		/// </param>
		///
		/// <param name="ModTimeTo">
		/// The <b>ModTimeFrom</b> and <b>ModTimeTo</b> fields specify a date range for retrieving
		/// order line items associated with the specified <b>ItemID</b>. The <b>ModTimeTo</b>
		/// field is the ending date range. All eBay order line items that were last
		/// modified within this date range are returned in the output. The maximum
		/// date range that may be specified is 30 days. If the <b>ModTimeFrom</b> field is
		/// used and the <b>ModTimeTo</b> field is omitted, the <b>ModTimeTo</b> value defaults to
		/// the present time or to 30 days past the <b>ModTimeFrom</b> value (if
		/// <b>ModTimeFrom</b> value is more than 30 days in the past). This field is not
		/// applicable if a specific <b>TransactionID</b> or <b>OrderLineItemID</b> is included in
		/// the request or if the <b>NumberOfDays</b> date filter is used.
		/// 
		/// If you don't specify a <b>ModTimeFrom</b>/<b>ModTimeTo</b> filter, the <b>NumberOfDays</b>
		/// time filter is used and it defaults to 30 (days).
		/// </param>
		///
		/// <param name="TransactionID">
		/// Include a <b>TransactionID</b> field in the request if you want to retrieve the
		/// data for a specific order line item (transaction). If a <b>TransactionID</b> is
		/// provided, any specified time filter is ignored. 
		/// </param>
		///
		/// <param name="Pagination">
		/// Child elements control pagination of the output. Use the <b>EntriesPerPage</b>
		/// property to control the number of order line items to
		/// return per call and the <b>PageNumber</b> property to specify the specific page
		/// of data to return. If multiple pages of order line items are returned
		/// based on input criteria and Pagination properties, <b>GetItemTransactions</b>
		/// will need to be called multiple times (with the <b>PageNumber</b> value being
		/// increased by 1 each time) to scroll through all results.
		/// </param>
		///
		/// <param name="IncludeFinalValueFee">
		/// Indicates whether to include the Final Value Fee (FVF) for all order
		/// line items in the response. The Final Value Fee is
		/// returned in the <b>Transaction.FinalValueFee</b> field. The Final Value Fee is
		/// assessed right after the creation of an order line item.
		/// </param>
		///
		/// <param name="IncludeContainingOrder">
		/// Include this field and set it to True if you want the <b>ContainingOrder</b>
		/// container to be returned in the response under each <b>Transaction</b> node.
		/// For single line item orders, the <b>ContainingOrder.OrderID</b> value takes the
		/// value of the <b>OrderLineItemID</b> value for the order line item. For Combined
		/// Payment orders, the <b>ContainingOrder.OrderID</b> value will be shared by at
		/// least two order line items (transactions) that are part of the same order.
		/// </param>
		///
		/// <param name="Platform">
		/// The default behavior of <b>GetItemTransactions</b> is to retrieve all order line items originating from eBay.com and Half.com. If the user wants to retrieve only eBay.com order line items or Half.com order line items, this filter can be used to perform that function. Inserting 'eBay' into this field will restrict retrieved order line items to those originating on eBay.com, and inserting 'Half' into this field will restrict retrieved order line items to those originating on Half.com.
		/// </param>
		///
		/// <param name="NumberOfDays">
		/// This time filter specifies the number of days (24-hour periods) in the
		/// past to search for order line items. All eBay order line items that were
		/// either created or modified within this period are returned in the
		/// response. If specified, <b>NumberOfDays</b> will override any date range
		/// specified with the <b>ModTimeFrom</b>/<b>ModTimeTo</b> time filters. This field is not
		/// applicable if a specific <b>TransactionID</b> or <b>OrderLineItemID</b> is included in
		/// the request.
		/// </param>
		///
		/// <param name="IncludeVariations">
		/// If included in the request and set to True, all variations defined for
		/// the item are returned at the root level, including variations
		/// that have no sales. If not included in the request or set to false, the
		/// variations with sales are still returned in separate <b>Transaction</b> nodes. This information is intended to help sellers to reconcile their
		/// local inventory with eBay's records, while processing order line items
		/// (without requiring a separate call to <b>GetItem</b>).
		/// </param>
		///
		/// <param name="OrderLineItemID">
		/// A unique identifier for an eBay order line item. This field is created
		/// as soon as there is a commitment to buy from the seller, and its value
		/// is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a
		/// hyphen in between these two IDs. If you want to retrieve data on a
		/// specific order line item, you can use an <b>OrderLineItemID</b> value in the
		/// request instead of the <b>ItemID</b>/<b>TransactionID</b> pair. If an <b>OrderLineItemID</b> is
		/// provided, any specified time filter is ignored. 
		/// </param>
		///
		public TransactionTypeCollection GetItemTransactions(string ItemID, DateTime ModTimeFrom, DateTime ModTimeTo, string TransactionID, PaginationType Pagination, bool IncludeFinalValueFee, bool IncludeContainingOrder, TransactionPlatformCodeType Platform, int NumberOfDays, bool IncludeVariations, string OrderLineItemID)
		{
			this.ItemID = ItemID;
			this.ModTimeFrom = ModTimeFrom;
			this.ModTimeTo = ModTimeTo;
			this.TransactionID = TransactionID;
			this.Pagination = Pagination;
			this.IncludeFinalValueFee = IncludeFinalValueFee;
			this.IncludeContainingOrder = IncludeContainingOrder;
			this.Platform = Platform;
			this.NumberOfDays = NumberOfDays;
			this.IncludeVariations = IncludeVariations;
			this.OrderLineItemID = OrderLineItemID;

			Execute();
			return ApiResponse.TransactionArray;
		}
Exemplo n.º 7
0
        /// <summary>
        /// The base request type for the <b>GetOrderTransactions</b> call. This call retrieves detailed information about one or more orders. All recent orders can be retrieved, or the seller can search based on <b>OrderID</b> value(s), <b>ItemID</b> value(s), <b>OrderLineItemID</b> value(s), or by <b>SKU</b> value(s).
        /// </summary>
        ///
        /// <param name="ItemTransactionIDArrayList">
        /// This container is used if the seller wants to search for one or more specific order line items. An <b>ItemTransactionID</b> container is required for each order line item that is to be retrieved.  An order line item can be identified with an <b>ItemID</b>/<b>TransactionID</b> pair, with a <b>OrderLineItemID</b> value, or with a <b>SKU</b> value (if a SKU exists for the order line item).
        /// </param>
        ///
        /// <param name="OrderIDArrayList">
        /// This container is used if the seller wants to search for one or more specific orders. An <b>OrderID</b> field is required for each order that is to be retrieved.  Up to 20 <b>OrderID</b> fields can be used.
        /// </param>
        ///
        /// <param name="Platform">
        /// <span class="tablenote"><b>Note: </b> This field's purpose is to allow the seller to retrieve only eBay listings or only Half.com listings instead of both order types. Since the Half.com site has been shut down, this field is no longer necessary to use since eBay orders will be the only orders that are retrieved.
        /// </span>
        /// The default behavior of <b>GetOrderTransactions</b> is to retrieve all orders originating from eBay.com and Half.com. If the user wants to retrieve only eBay.com order line items or Half.com order line items, this filter can be used to perform that function. Inserting <code>eBay</code> into this field will restrict retrieved order line items to those originating on eBay.com, and inserting <code>Half</code> into this field will restrict retrieved order line items to those originating on Half.com.
        /// </param>
        ///
        /// <param name="IncludeFinalValueFees">
        /// This field is included and set to <code>true</code> if the seller wishes to include the Final Value Fee (FVF) for each order in the response. A Final Value Fee is calculated based on total amount of the sale, including the final price of the item and shipping/handling charges. This fee is charged to a seller's account immediately upon creation of an order line item.
        /// </param>
        ///
        public List <OrderType> GetOrderTransactions(List <ItemTransactionIDType> ItemTransactionIDArrayList, List <string> OrderIDArrayList, TransactionPlatformCodeType Platform, bool IncludeFinalValueFees)
        {
            this.ItemTransactionIDArrayList = ItemTransactionIDArrayList;
            this.OrderIDArrayList           = OrderIDArrayList;
            this.Platform = Platform;
            this.IncludeFinalValueFees = IncludeFinalValueFees;

            Execute();
            return(ApiResponse.OrderArray);
        }