InventoryItemCriteria

Overview

Contains all the possible filter properties for Inventory Item retrieval methods.

Fields

Field Name

Data Type

Description

Notes / Constraints

DateRangeField

InventoryItemDateRangeField

Specifies the Date Field property of an Inventory Item to filter on

MUST be set in order to use the DateRangeStartGMT and DateRangeEndGMT fields

DateRangeStartGMT

DateTime

Beginning of the filter date range in the format YYYY-MM-DDTHH:MM:SS

Example: 2015-08-28T10:53:42

DateRangeEndGMT

DateTime

End of the filter date range in the format YYYY-MM-DDTHH:MM:SS

Example: 2015-08-28T18:53:42

PartialSku

string

Use this field if you want to find a partial string with your Sku values.

No wildcards are necessary or supported.

SkuStartsWith

string

Use this field if you want to find all of your Skus that start with a specific value.

No wildcards are necessary or supported.
Cannot be used in conjunction with PartialSku.

SkuEndsWith

string

Use this field if you want to find all of your Skus that end with a specific value.

No wildcards are necessary or supported.
Cannot be used in conjunction with PartialSku.

ClassificationName

string

Use this field if you want to find all of your Skus assigned to a specific Classification.

LabelName

string

Use this field if you want to find all of your Skus assigned to a specific Label.

QuantityCheckField

InventoryItemQuantityCheckField

Use this field if you want to find all of your Skus based upon a specific Quantity Field.

QuantityCheckType

NumericFilterType

Use this field to specify the comparison operation to use for the specified Quantity Field.

Requires the specification of a QuantityCheckField value

QuantityCheckValue

int

Use this field to specify the numeric value for the Quantity Field comparison.

Requires the specification of a QuantityCheckField value and QuantityCheckType value

PageNumber *

integer

PageNumber range starts at 1, not 0

PageSize *

integer

Maximum allowed value is 100

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

References