/// <summary>
/// Retrieves a paginated list containing details of a user's Selling Manager inventory.
/// This call is subject to change without notice; the deprecation process is
/// inapplicable to this call.
/// </summary>
///
/// <param name="Sort">
/// Sets the sorting method for the results.
/// </param>
///
/// <param name="FolderID">
/// Specifies the inventory folder containing the requested inventory information.
/// </param>
///
/// <param name="Pagination">
/// Details about how many Products to return per page and which page to view.
/// </param>
///
/// <param name="SortOrder">
/// Order to be used for sorting retrieved product lists.
/// </param>
///
/// <param name="Search">
/// Specifies types and values to search for in the seller's listings.
/// </param>
///
/// <param name="StoreCategoryID">
/// Specifies a store category whose products will be returned.
/// </param>
///
/// <param name="FilterList">
/// Container for the list of filters that can be applied to the inventory information requested.
/// </param>
///
public DateTime GetSellingManagerInventory(SellingManagerProductSortCodeType Sort, long FolderID, PaginationType Pagination, SortOrderCodeType SortOrder, SellingManagerSearchType Search, long StoreCategoryID, SellingManagerInventoryPropertyTypeCodeTypeCollection FilterList)
{
this.Sort = Sort;
this.FolderID = FolderID;
this.Pagination = Pagination;
this.SortOrder = SortOrder;
this.Search = Search;
this.StoreCategoryID = StoreCategoryID;
this.FilterList = FilterList;
Execute();
return ApiResponse.InventoryCountLastCalculatedDate;
}
/// <summary>
/// Retrieves a paginated list containing details of a user's Selling Manager Inventory. This call is subject to change without notice; the deprecation process is inapplicable to this call. The user must have a Selling Manager Pro subscription to use this call.
/// </summary>
///
/// <param name="Sort">
/// This field is used if the seller would like to sort Selling Manager Inventory results based on a specific aspect such as Product Name, Average Price, etc. See <b>SellingManagerProductSortCodeType</b> to read more about the available sorting options.
/// </param>
///
/// <param name="FolderID">
/// This field is included if the seller wants to view Selling Manager Inventory from a specific folder.
/// </param>
///
/// <param name="Pagination">
/// This container is used if the seller would like to control how many products are returned per page and which page to view.
/// </param>
///
/// <param name="SortOrder">
/// This field allows the seller to sort in ascending or descending order (based on the selected aspect in the <b>Sort</b> field).
/// </param>
///
/// <param name="Search">
/// This container is used if the seller would like to search for Selling Manager Inventory based on certain identifiers like Item ID, listing title, buyer user ID, etc. The seller will specify one of the supported search types in <b>SellingManagerSearchTypeCodeType</b>, and then provides the value for that search type.
/// </param>
///
/// <param name="StoreCategoryID">
/// This field is used if the seller would like to retrieve all Selling Manager Inventory listed in a specific eBay Store Category.
/// </param>
///
/// <param name="FilterList">
/// One or more <b>Filter</b> fields can be used to retrieve Selling Manager Inventory that is in a certain state, such as active listings, inactive listings, or listings that are low in stock.
/// </param>
///
public DateTime GetSellingManagerInventory(SellingManagerProductSortCodeType Sort, long FolderID, PaginationType Pagination, SortOrderCodeType SortOrder, SellingManagerSearchType Search, long StoreCategoryID, SellingManagerInventoryPropertyTypeCodeTypeCollection FilterList)
{
this.Sort = Sort;
this.FolderID = FolderID;
this.Pagination = Pagination;
this.SortOrder = SortOrder;
this.Search = Search;
this.StoreCategoryID = StoreCategoryID;
this.FilterList = FilterList;
Execute();
return(ApiResponse.InventoryCountLastCalculatedDate);
}
/// <summary>
/// Retrieves the orders for which the authenticated user is a participant, either as the buyer
/// or the seller. <b>Also for Half.com</b>. The call returns all the
/// orders that meet the request specifications.
/// </summary>
///
/// <param name="OrderIDList">
/// A container for eBay order IDs. If one or more order IDs are specified in this
/// container, no other call-specific input fields are applicable.
///
/// Not applicable to Half.com.
/// </param>
///
/// <param name="CreateTimeFrom">
/// The <b>CreateTimeFrom</b> and <b>CreateTimeTo</b> fields
/// specify a date range for retrieving orders. The <b>CreateTimeFrom</b> field is the
/// starting date range. All eBay orders that were created within this date range are
/// returned in the output. The maximum date range that may be specified with the
/// <b>CreateTimeFrom</b> and <b>CreateTimeTo</b> fields is 90
/// days. <b>CreateTimeFrom</b>/<b>CreateTimeTo</b> date
/// filters are ignored if the <b>NumberOfDays</b> date filter is used in the request, or if
/// one or more order IDs are passed in the request.
///
/// Applicable to Half.com.
/// </param>
///
/// <param name="CreateTimeTo">
/// The <b>CreateTimeFrom</b> and <b>CreateTimeTo</b> fields specify a date range for retrieving
/// orders. The <b>CreateTimeTo</b> field is the ending date range. All eBay orders that were
/// created within this date range are returned in the output. The maximum
/// date range that may be specified with the <b>CreateTimeFrom</b> and <b>CreateTimeTo</b> fields
/// is 90 days. If the <b>CreateTimeFrom</b> field is used and the
/// <b>CreateTimeTo</b> field is omitted, the "TimeTo" value defaults to the present time or
/// to 90 days past the <b>CreateTimeFrom</b> value (if <b>CreateTimeFrom</b> value is more than 90
/// days in the past). <b>CreateTimeFrom</b>/<b>CreateTimeTo</b> date filters are ignored if the
/// <b>NumberOfDays</b> date filter is used in the request, or if one or more order IDs are
/// passed in the request.
///
/// <span class="tablenote"><strong>Note:</strong>
/// If a GetOrders call is made within a few seconds after the creation of a multiple
/// line item order, the caller runs the risk of retrieving orders that are in an
/// inconsistent state, since the order consolidation involved in a multi-line item order
/// may not have been completed. For
/// this reason, it is recommended that sellers include the
/// <b>CreateTimeTo</b> field in the call, and set its value to: <i>
/// Current Time</i> - 2 minutes.
///
/// Applicable to Half.com.
/// </span>
///
/// <param name="OrderRole">
/// Filters the returned orders based on the role of the user. The user's role is
/// either buyer or seller. If this field is used with a date filter, returned orders
/// must satisfy both the date range and the OrderRole value.
///
/// Applicable to eBay.com and Half.com.
/// </param>
///
/// <param name="OrderStatus">
/// The field is used to retrieve orders that are in a specific state. If this field is used with a date filter, only orders that satisfy both the date range and the <b>OrderStatus</b> value are retrieved.
///
/// For eBay orders, this field's value can be set to 'Active', 'Completed', 'Canceled' or 'Inactive' to retrieve orders in these states. The 'Shipped' value is only applicable for Half.com orders.
///
/// To retrieve Half.com orders, this field's value should be set to 'Shipped', and the <b>ListingType</b> field should be included and set to 'Half'.
///
/// If one or more <b>OrderID</b> values are specified through the <b>OrderIDArray</b> container, the <b>OrderStatus</b> field should not be used, and it is ignored if it is used.
/// </param>
///
/// <param name="ListingType">
/// Specify Half to retrieve Half.com orders.
///
/// <span class="tablenote"><strong>Note:</strong>
/// Do not use this field if you are retrieving eBay orders.
///
/// This field cannot be used as a listing type filter on eBay.com. If not
/// provided, or if you specify any value other than Half, this field has
/// no useful effect and the call retrieves eBay orders of all types. Also,
/// you can't retrieve both eBay and Half.com orders in the same response.
/// </span>
/// </param>
///
/// <param name="Pagination">
/// If many orders are available to retrieve, you may need to call GetOrders multiple times to retrieve all
/// the data. Each result set is returned as a page of entries. Use the
/// Pagination filters to control the maximum number of entries to
/// retrieve per page (i.e., per call), the page number to retrieve, and
/// other data.
/// </param>
///
/// <param name="ModTimeFrom">
/// The ModTimeFrom and ModTimeTo fields specify a date range for retrieving
/// existing orders that have been modified within this time window (for example,
/// 'Incomplete' status to 'Pending' status or 'Pending' status to 'Complete' status). The
/// ModTimeFrom field is the starting date range. All eBay orders that were last
/// modified within this date range are returned in the output. The maximum date
/// range that may be specified with the ModTimeFrom and ModTimeTo fields is 30
/// days. ModTimeFrom/ModTimeTo date filters are ignored if the
/// CreateTimeFrom/CreateTimeTo or NumberOfDays date filters are used in the
/// request, or if one or more order IDs are passed in the request.
///
/// Applicable to Half.com.
/// </param>
///
/// <param name="ModTimeTo">
/// The ModTimeFrom and ModTimeTo fields specify a date range for retrieving
/// existing orders that have been modified within this time window (for example,
/// 'Incomplete' status to 'Pending' status or 'Pending' status to 'Complete'
/// status). The ModTimeTo field is the ending date range. All eBay orders that were
/// last modified within this date range are returned in the output. The maximum
/// date range that may be specified with the ModTimeFrom and ModTimeTo fields is 30
/// days. If the ModTimeFrom field is used and the ModTimeTo field is omitted, the
/// "TimeTo" value defaults to the present time (if ModTimeFrom value is less than
/// 30 days in the past) or to 30 days past the ModTimeFrom value.
/// ModTimeFrom/ModTimeTo date filters are ignored if the
/// CreateTimeFrom/CreateTimeTo or NumberOfDays date filters are used in the
/// request, or if one or more order IDs are passed in the request.
///
/// Applicable to Half.com.
/// </param>
///
/// <param name="NumberOfDays">
/// This filter specifies the number of days (24-hour periods) in the past to search
/// for orders. All eBay orders that were either created or modified within this
/// period are returned in the output. This field cannot be used in conjunction with
/// the CreateTimeFrom/CreateTimeTo or ModTimeFrom/ModTimeTo date filters. This date
/// filter is ignored if one or more order IDs are passed in the request.
///
/// Applicable to Half.com.
/// </param>
///
/// <param name="IncludeFinalValueFee">
/// Indicates whether to include the Final Value Fee (FVF) for all Transaction objects in the
/// response. The Final Value Fee is returned in Transaction.FinalValueFee. The Final
/// Value Fee is assessed right after the creation of an eBay order line item.
///
/// </param>
///
/// <param name="SortingOrder">
/// Specifies how orders returned by this call should be sorted (using <strong>LastModifiedTime</strong> as the sort key). A value of <code>Ascending</code> returns the earliest modified orders first, and a value of <code>Descending</code> returns the latest modified orders first.
/// <br/><br/>
/// Default: <code>Ascending</code>
/// </param>
public OrderTypeCollection GetOrders(StringCollection OrderIDList, DateTime CreateTimeFrom, DateTime CreateTimeTo, TradingRoleCodeType OrderRole, OrderStatusCodeType OrderStatus, ListingTypeCodeType ListingType, PaginationType Pagination, DateTime ModTimeFrom, DateTime ModTimeTo, int NumberOfDays, bool IncludeFinalValueFee, SortOrderCodeType SortingOrder)
{
this.OrderIDList = OrderIDList;
this.CreateTimeFrom = CreateTimeFrom;
this.CreateTimeTo = CreateTimeTo;
this.OrderRole = OrderRole;
this.OrderStatus = OrderStatus;
this.ListingType = ListingType;
this.Pagination = Pagination;
this.ModTimeFrom = ModTimeFrom;
this.ModTimeTo = ModTimeTo;
this.NumberOfDays = NumberOfDays;
this.IncludeFinalValueFee = IncludeFinalValueFee;
this.SortingOrder = SortingOrder;
Execute();
return(ApiResponse.OrderArray);
}
/// <summary>
/// Returns a Selling Manager user's sold listings.
///
/// This call is subject to change without notice; the deprecation process is inapplicable to this call. The user must have a Selling Manager Pro subscription to use this call.
/// </summary>
///
/// <param name="Search">
/// This container is used if the seller would like to search for Selling Manager Sele Records based on certain identifiers like Saler Record ID, Item ID, listing title, buyer user ID, etc. The seller will specify one of the supported search types in <b>SellingManagerSearchTypeCodeType</b>, and then provides the value for that search type.
/// </param>
///
/// <param name="StoreCategoryID">
/// This field is used if the seller would like to retrieve all Selling Manager Sale Records for products listed in a specific eBay Store Category.
/// </param>
///
/// <param name="FilterList">
/// One or more <b>Filter</b> fields can be used to retrieve Selling Manager Sale Records for orders that are in a certain state. See <b>SellingManagerSoldListingsPropertyTypeCodeType</b> for the supported values.
/// </param>
///
/// <param name="Archived">
/// This field is included and set to <code>true</code> if the seller would like to retrieve one or more archived orders between 90 and 120 days old.
/// </param>
///
/// <param name="Sort">
/// This field is used if the seller would like to sort Selling Manager Sale Record results based on a specific aspect such as purchase date, checkout status, total price, etc. See <b>SellingManagerSoldListingsSortTypeCodeType</b> to read more about the available sorting options.
/// </param>
///
/// <param name="SortOrder">
/// This field allows the seller to sort in ascending or descending order (based on the selected aspect in the <b>Sort</b> field).
/// </param>
///
/// <param name="Pagination">
/// This container is used if the seller would like to control how many Sale Records are returned per page and which page to view.
/// </param>
///
/// <param name="SaleDateRange">
/// This container allows the seller to retrieve orders that were purchased within a specified time range. A time range can be set up to 90 days in the past (or up to 120 days if the <b>Archived</b> field is included and set to <code>true</code>.
/// </param>
///
public SellingManagerSoldOrderTypeCollection GetSellingManagerSoldListings(SellingManagerSearchType Search, long StoreCategoryID, SellingManagerSoldListingsPropertyTypeCodeTypeCollection FilterList, bool Archived, SellingManagerSoldListingsSortTypeCodeType Sort, SortOrderCodeType SortOrder, PaginationType Pagination, TimeRangeType SaleDateRange)
{
this.Search = Search;
this.StoreCategoryID = StoreCategoryID;
this.FilterList = FilterList;
this.Archived = Archived;
this.Sort = Sort;
this.SortOrder = SortOrder;
this.Pagination = Pagination;
this.SaleDateRange = SaleDateRange;
Execute();
return(ApiResponse.SaleRecord);
}
/// <summary>
/// Retrieves the orders for which the authenticated user is a participant, either as the buyer
/// or the seller. <b>Also for Half.com</b>. The call returns all the
/// orders that meet the request specifications.
/// </summary>
///
/// <param name="OrderIDList">
/// A container for eBay order IDs. If one or more order IDs are specified in this
/// container, no other call-specific input fields are applicable.
///
/// Not applicable to Half.com.
/// </param>
///
/// <param name="CreateTimeFrom">
/// The <b>CreateTimeFrom</b> and <b>CreateTimeTo</b> fields
/// specify a date range for retrieving orders. The <b>CreateTimeFrom</b> field is the
/// starting date range. All eBay orders that were created within this date range are
/// returned in the output. The maximum date range that may be specified with the
/// <b>CreateTimeFrom</b> and <b>CreateTimeTo</b> fields is 90
/// days. <b>CreateTimeFrom</b>/<b>CreateTimeTo</b> date
/// filters are ignored if the <b>NumberOfDays</b> date filter is used in the request, or if
/// one or more order IDs are passed in the request.
///
/// Applicable to Half.com.
/// </param>
///
/// <param name="CreateTimeTo">
/// The <b>CreateTimeFrom</b> and <b>CreateTimeTo</b> fields specify a date range for retrieving
/// orders. The <b>CreateTimeTo</b> field is the ending date range. All eBay orders that were
/// created within this date range are returned in the output. The maximum
/// date range that may be specified with the <b>CreateTimeFrom</b> and <b>CreateTimeTo</b> fields
/// is 90 days. If the <b>CreateTimeFrom</b> field is used and the
/// <b>CreateTimeTo</b> field is omitted, the "TimeTo" value defaults to the present time or
/// to 90 days past the <b>CreateTimeFrom</b> value (if <b>CreateTimeFrom</b> value is more than 90
/// days in the past). <b>CreateTimeFrom</b>/<b>CreateTimeTo</b> date filters are ignored if the
/// <b>NumberOfDays</b> date filter is used in the request, or if one or more order IDs are
/// passed in the request.
///
/// <span class="tablenote"><strong>Note:</strong>
/// If a GetOrders call is made within a few seconds after the creation of a multiple
/// line item order, the caller runs the risk of retrieving orders that are in an
/// inconsistent state, since the order consolidation involved in a multi-line item order
/// may not have been completed. For
/// this reason, it is recommended that sellers include the
/// <b>CreateTimeTo</b> field in the call, and set its value to: <i>
/// Current Time</i> - 2 minutes.
///
/// Applicable to Half.com.
/// </param>
///
/// <param name="OrderRole">
/// Filters the returned orders based on the role of the user. The user's role is
/// either buyer or seller. If this field is used with a date filter, returned orders
/// must satisfy both the date range and the OrderRole value.
///
/// Applicable to eBay.com and Half.com.
/// </param>
///
/// <param name="OrderStatus">
/// The field is used to retrieve orders that are in a specific state. If this field is used with a date filter, only orders that satisfy both the date range and the <b>OrderStatus</b> value are retrieved.
///
/// For eBay orders, this field's value can be set to 'Active', 'Completed', 'Canceled' or 'Inactive' to retrieve orders in these states. The 'Shipped' value is only applicable for Half.com orders.
///
/// To retrieve Half.com orders, this field's value should be set to 'Shipped', and the <b>ListingType</b> field should be included and set to 'Half'.
///
/// If one or more <b>OrderID</b> values are specified through the <b>OrderIDArray</b> container, the <b>OrderStatus</b> field should not be used, and it is ignored if it is used.
/// </param>
///
/// <param name="ListingType">
/// Specify Half to retrieve Half.com orders.
///
/// <span class="tablenote"><strong>Note:</strong>
/// Do not use this field if you are retrieving eBay orders.
///
/// This field cannot be used as a listing type filter on eBay.com. If not
/// provided, or if you specify any value other than Half, this field has
/// no useful effect and the call retrieves eBay orders of all types. Also,
/// you can't retrieve both eBay and Half.com orders in the same response.
/// </span>
/// </param>
///
/// <param name="Pagination">
/// If many orders are available to retrieve, you may need to call GetOrders multiple times to retrieve all
/// the data. Each result set is returned as a page of entries. Use the
/// Pagination filters to control the maximum number of entries to
/// retrieve per page (i.e., per call), the page number to retrieve, and
/// other data.
/// </param>
///
/// <param name="ModTimeFrom">
/// The ModTimeFrom and ModTimeTo fields specify a date range for retrieving
/// existing orders that have been modified within this time window (for example,
/// 'Incomplete' status to 'Pending' status or 'Pending' status to 'Complete' status). The
/// ModTimeFrom field is the starting date range. All eBay orders that were last
/// modified within this date range are returned in the output. The maximum date
/// range that may be specified with the ModTimeFrom and ModTimeTo fields is 30
/// days. ModTimeFrom/ModTimeTo date filters are ignored if the
/// CreateTimeFrom/CreateTimeTo or NumberOfDays date filters are used in the
/// request, or if one or more order IDs are passed in the request.
///
/// Applicable to Half.com.
/// </param>
///
/// <param name="ModTimeTo">
/// The ModTimeFrom and ModTimeTo fields specify a date range for retrieving
/// existing orders that have been modified within this time window (for example,
/// 'Incomplete' status to 'Pending' status or 'Pending' status to 'Complete'
/// status). The ModTimeTo field is the ending date range. All eBay orders that were
/// last modified within this date range are returned in the output. The maximum
/// date range that may be specified with the ModTimeFrom and ModTimeTo fields is 30
/// days. If the ModTimeFrom field is used and the ModTimeTo field is omitted, the
/// "TimeTo" value defaults to the present time (if ModTimeFrom value is less than
/// 30 days in the past) or to 30 days past the ModTimeFrom value.
/// ModTimeFrom/ModTimeTo date filters are ignored if the
/// CreateTimeFrom/CreateTimeTo or NumberOfDays date filters are used in the
/// request, or if one or more order IDs are passed in the request.
///
/// Applicable to Half.com.
/// </param>
///
/// <param name="NumberOfDays">
/// This filter specifies the number of days (24-hour periods) in the past to search
/// for orders. All eBay orders that were either created or modified within this
/// period are returned in the output. This field cannot be used in conjunction with
/// the CreateTimeFrom/CreateTimeTo or ModTimeFrom/ModTimeTo date filters. This date
/// filter is ignored if one or more order IDs are passed in the request.
///
/// Applicable to Half.com.
/// </param>
///
/// <param name="IncludeFinalValueFee">
/// Indicates whether to include the Final Value Fee (FVF) for all Transaction objects in the
/// response. The Final Value Fee is returned in Transaction.FinalValueFee. The Final
/// Value Fee is assessed right after the creation of an eBay order line item.
///
/// </param>
///
/// <param name="SortingOrder">
/// Specifies how orders returned by this call should be sorted (using <strong>LastModifiedTime</strong> as the sort key). A value of <code>Ascending</code> returns the earliest modified orders first, and a value of <code>Descending</code> returns the latest modified orders first.
/// <br/><br/>
/// Default: <code>Ascending</code>
/// </param>
///
public OrderTypeCollection GetOrders(StringCollection OrderIDList, DateTime CreateTimeFrom, DateTime CreateTimeTo, TradingRoleCodeType OrderRole, OrderStatusCodeType OrderStatus, ListingTypeCodeType ListingType, PaginationType Pagination, DateTime ModTimeFrom, DateTime ModTimeTo, int NumberOfDays, bool IncludeFinalValueFee, SortOrderCodeType SortingOrder)
{
this.OrderIDList = OrderIDList;
this.CreateTimeFrom = CreateTimeFrom;
this.CreateTimeTo = CreateTimeTo;
this.OrderRole = OrderRole;
this.OrderStatus = OrderStatus;
this.ListingType = ListingType;
this.Pagination = Pagination;
this.ModTimeFrom = ModTimeFrom;
this.ModTimeTo = ModTimeTo;
this.NumberOfDays = NumberOfDays;
this.IncludeFinalValueFee = IncludeFinalValueFee;
this.SortingOrder = SortingOrder;
Execute();
return ApiResponse.OrderArray;
}
/// <summary>
/// Returns a Selling Manager user's sold listings.
///
/// This call is subject to change without notice; the deprecation process is
/// inapplicable to this call.
/// </summary>
///
/// <param name="Search">
/// Search filters for sold listings.
/// </param>
///
/// <param name="StoreCategoryID">
/// Listings with this store category ID will be listed.
/// </param>
///
/// <param name="FilterList">
/// This holds the list of filters that can be applicable for sold listings.
/// </param>
///
/// <param name="Archived">
/// Requests listing records that are more than 90 days old. Records are archived between 90
/// and 120 days after being created, and thereafter can only be retrieved using this tag.
/// </param>
///
/// <param name="Sort">
/// Field to be used to sort the response.
/// </param>
///
/// <param name="SortOrder">
/// Order to be used for sorting the requested listings.
/// </param>
///
/// <param name="Pagination">
/// Details about how many listings to return per page and which page to view.
/// </param>
///
/// <param name="SaleDateRange">
/// Specifies the earliest (oldest) and latest (most recent) dates to use in a date
/// range filter based on item start time. A time range can be up to 120
/// days.
/// </param>
///
public SellingManagerSoldOrderTypeCollection GetSellingManagerSoldListings(SellingManagerSearchType Search, long StoreCategoryID, SellingManagerSoldListingsPropertyTypeCodeTypeCollection FilterList, bool Archived, SellingManagerSoldListingsSortTypeCodeType Sort, SortOrderCodeType SortOrder, PaginationType Pagination, TimeRangeType SaleDateRange)
{
this.Search = Search;
this.StoreCategoryID = StoreCategoryID;
this.FilterList = FilterList;
this.Archived = Archived;
this.Sort = Sort;
this.SortOrder = SortOrder;
this.Pagination = Pagination;
this.SaleDateRange = SaleDateRange;
Execute();
return ApiResponse.SaleRecord;
}
