Get Products

View as Markdown
Retrieves a paginated list of products. Supports filtering by search term, barcode, SKU, status, and other criteria.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token or OAuth2

Query parameters

SearchstringOptional
Search Products by name, sku, inventory id or product Id.
BarcodestringOptional
Barcode Associated with variant
BarcodesstringOptional
Barcodes Associated with variant
CategoryIdsstringOptional
List of Category Ids associated with product
ChannelIdsstringOptional
Looks for Products variants by their channel IDs
HasDigitalVariantsstringOptional

Looks for Products with/without digital variants

HasVariantsstringOptional

Looks for Products with/without variants

InventoryIdstringOptional
Looks for variants by its associated inventory id
IsInventorySyncEnabledstringOptional
Looks for Products variants by their IsInventorySyncEnabled is true
LastUpdatedTimestampstringOptional
Looks for Products that have been updated since the given date
LegacyIdsstringOptional

Looks for Products with by Legacy Product Id(s)

NamestringOptional

Looks for Products/Variants by name

OnHandstringOptional
Looks for Products with inventory
PlatformIdsstringOptional
Looks for Products variants by their external Platform IDs
ProductIdstringOptional
Looks for Products with an assigned Id
ProductTypestringOptional
Looks for Products by type
ReviewsPendingstringOptional
Looks for Products by ReviewsPending
SalesChannelstringOptional

Looks for Products variants assigned to a platform/sales channel

SellerSKUstringOptional
Looks for Products that match the provided Seller query
SKUstringOptional
Looks for Products that match the provided Sku query
TaxonomyIdsstringOptional
Looks for Products variants by their taxonomy id or any descendants of the taxonomies sent separated by comma
VariantIdstringOptional
Looks for products that contain a variant with the given ID
VariantStatusstringOptional
Looks for Products with variants that contain provided status
PageSizestringOptional

1-250

SortBystringOptional
Id, Name, Category, TotalOnHandQty
SortOrderstringOptional
ASC,DESC

Response

Success
firststring or null
itemslist of objects or null
laststring or null
nextstring or null
prevstring or null

Errors