Alokai

GetProductsParameters

Definition of products request parameters.

interface GetProductsParameters extends Pick<RequestVariables, "channel">, ProductsPaginationParameters {
	"categories:in"?: number;
	"date_last_imported:max"?: string;
	"date_last_imported:min"?: string;
	"date_modified:max"?: string;
	"date_modified:min"?: string;
	"id:greater"?: number[];
	"id:in"?: number[];
	"id:less"?: number[];
	"id:max"?: number[];
	"id:min"?: number[];
	"id:not_in"?: number[];
	"intentory_level:not_in"?: number;
	"inventory_level:greater"?: number;
	"inventory_level:in"?: number;
	"inventory_level:less"?: number;
	"inventory_level:max"?: number;
	"inventory_level:min"?: number;
	"sku:in"?: string[];
	availability?: "available" | "disabled" | "preorder";
	brand_id?: number;
	categories?: number;
	condition?: "new" | "refurbished" | "used";
	date_last_imported?: string;
	date_modified?: string;
	direction?: "asc" | "desc";
	exclude_fields?: string;
	id?: number;
	include_fields?: string;
	include?: string;
	inventory_level?: number;
	inventory_low?: 0 | 1;
	is_featured?: 0 | 1;
	is_free_shipping?: 0 | 1;
	is_visible?: boolean;
	keyword_context?: "merchant" | "shopper";
	keyword?: string;
	name?: string;
	out_of_stock?: 1;
	price?: number;
	sku?: string;
	sort?: ProductsSortEnum;
	status?: number;
	total_sold?: number;
	type?: "digital" | "physical";
	upc?: string;
	weight?: number;
}

Properties

NameRequiredTypeDescription
"categories:in"OptionalnumberFilter items by categories. Use for products in multiple categories. For example, categories:in=12.
"date_last_imported:max"OptionalstringFilter items by date_last_imported. For example, date_last_imported:max=2018-06-15.
"date_last_imported:min"OptionalstringFilter items by date_last_imported. For example, date_last_imported:min=2020-06-15.
"date_modified:max"OptionalstringFilter items by date_modified. For example, date_modified:max=2020-06-15.
"date_modified:min"OptionalstringFilter items by date_modified. For example, date_modified:min=2018-06-15.
"id:greater"Optionalnumber[]Filter items by list of ids greater then passed to filter.
"id:in"Optionalnumber[]Filter items by list of ids.
"id:less"Optionalnumber[]Filter items by list of ids less then passed to filter.
"id:max"Optionalnumber[]Filter items by list of max ids.
"id:min"Optionalnumber[]Filter items by list of min ids.
"id:not_in"Optionalnumber[]Filter items by list of excluded ids.
"intentory_level:not_in"OptionalnumberFilter items by inventory_level.
"inventory_level:greater"OptionalnumberFilter items by inventory_level greater than passed to param.
"inventory_level:in"OptionalnumberFilter items by inventory_level.
"inventory_level:less"OptionalnumberFilter items by inventory_level less than passed to param.
"inventory_level:max"OptionalnumberFilter items by max inventory_level.
"inventory_level:min"OptionalnumberFilter items by min inventory_level.
"sku:in"Optionalstring[]Filter items by SKU.
availabilityOptional"available" | "disabled" | "preorder"Filter items by availability. Values are: available, disabled, preorder.
brand_idOptionalnumberFilter items by brand_id.
categoriesOptionalnumberFilter items by categories. If a product is in more than one category, using this query will not return the product. Instead use categories:in=12.
conditionOptional"new" | "refurbished" | "used"Filter items by condition.
date_last_importedOptionalstringFilter items by date_last_imported.
date_modifiedOptionalstringFilter items by date_modified.
directionOptional"asc" | "desc"Sort direction. Acceptable values are: asc, desc.
exclude_fieldsOptionalstringFields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.
idOptionalnumberFilter items by id.
include_fieldsOptionalstringFields to include, in a comma-separated list. The ID and the specified fields will be returned.
includeOptionalstringSub-resources to include on a product, in a comma-separated list. If options or modifiers is used, results are limited to 10 per page.
inventory_levelOptionalnumberFilter items by inventory_level.
inventory_lowOptional0 | 1Filter items by inventory_low. Values: 1, 0.
is_featuredOptional0 | 1Filter items by is_featured. 1 for true, 0 for false.
is_free_shippingOptional0 | 1Filter items by is_free_shipping. 1 for true, 0 for false.
is_visibleOptionalbooleanFilter items based on whether the product is currently visible on the storefront.
keyword_contextOptional"merchant" | "shopper"Set context used by the search algorithm to return results targeted towards the specified group. Use merchant to help merchants search their own catalog. Use shopper to return shopper-facing search results.
keywordOptionalstringFilter items by keywords found in the name, description, or sku fields, or in the brand name.
nameOptionalstringFilter items by name.
out_of_stockOptional1Filter items by out_of_stock. To enable the filter, pass out_of_stock=1.
priceOptionalnumberFilter items by price.
skuOptionalstringFilter items by main SKU. To filter by variant SKU, see Get All Variants.
sortOptionalProductsSortEnumField name to sort by. Note: Since id increments when new products are added, you can use that field to sort by product create date.
statusOptionalnumberFilter items by status.
total_soldOptionalnumberFilter items by total_sold.
typeOptional"digital" | "physical"Filter items by type.
upcOptionalstringFilter items by upc.
weightOptionalnumberFilter items by weight.

Referenced Types

On this page