GetFilteredInventoryItemList

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 sort key for the results

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 an array of inventory items that meet 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 ...
    • If you have specified to include quantity info, then the QuantityInfo property will be populated
    • If you have specified to include price info, then the PriceInfo property will be populated
    • If you have specified to include classification info, then the Classification property will be populated, but the attribute list will not be included
    • All other properties will have to be retrieved using the other extended "Get" methods in the API

References