Dashboard > ChannelAdvisor Developer Network > ... > Inventory Service Methods > GetFilteredInventoryItemList
Log In   View a printable version of the current page.
GetFilteredInventoryItemList
Added by Andy Berryman, last edited by Andy Berryman on Sep 06, 2007  (view change)
Labels: 
(None)


Overview

Retrieve the basic details for Inventory Items that match the specified filter criteria.

Request

Field Name
Data Type Description
accountID * string
A unique identifier representing the ChannelAdvisor account you wish to access.
itemCriteria * InventoryItemCriteria Specifies the filter criteria to use when retrieving the list of results
detailLevel * InventoryItemDetailLevel Specifies the level of detail to return for each item in the list of results
sortField InventoryItemSortField Specifies the Inventory Item property to sort the results by
sortDirection SortDirection Specifies the direction to sort the results

Response

Field Name
Data Type Description
GetFilteredInventoryItemListResult APIResult<InventoryItemResponse[]>
If the Status property of the return object is set to Success, then the ResultData property will be set to an array of objects containing the basic detail information for the specified criteria.

Notes

  • * Indicates a REQUIRED Field ... Fields that are NOT required may be set to a null value or left out of a manually built SOAP packet 
  • For each InventoryItemResponse object in the result ...
    • The following "base" properties will be populated (if they have a value):
      • Sku
      • Title
      • Weight
      • SupplierCode
      • FlagStyle
      • FlagDescription
      • IsBlocked 
    • If you have specified to IncludeQuantityInfo (through the detailLevel parameter), then the QuantityInfo property WILL be populated
    • If you have specified to IncludePriceInfo (through the detailLevel parameter), then the PriceInfo property WILL be populated
      • Will contain all configured Prices except SecondChanceOfferPrice and StorePrice
    • If you have specified to IncludeClassificationInfo (through the detailLevel parameter), then the ClassificationInfo property WILL be populated
    • All other properties will have to be retrieved using the other extended "Get" methods in the API

References

Powered by Atlassian Confluence, the Enterprise Wiki. (Version: 2.5.1 Build:#806 May 06, 2007) - Bug/feature request - Contact Administrators