Przejdź do głównej zawartości

Pobierz listę produktów

GET
/api/products/v4/products
curl --request GET \
--url 'https://twoja-instancja-pim-api.enterprise.sellrocket.pl/api/products/v4/products?sortBy=Stock&sortOrder=desc&availability=Available&pageSize=100&pageNumber=0&searchOperator=AND' \
--header 'Authorization: Bearer <token>'

Zwraca stronicowaną listę produktów z filtrami (katalog, magazyn, kategoria, nazwa, EAN, SKU i in.); dopasowania w wariantach są zwijane do produktu nadrzędnego. Odpowiednik getInventoryProductsList w BaseLinker.

catalogId
integer format: int64
warehouseId
integer format: int64
warehouseIds
Array<integer>
priceGroupId
integer format: int64
productId
integer format: int64
productIds
Array<integer>
categoryId
integer format: int64
productName
string
ean
string
eans
Array<string>
sku
string
skus
Array<string>
vat
number format: double
quantityFrom
integer format: int32
quantityTo
integer format: int32
priceFrom
number format: double
priceTo
number format: double
weightFrom
number format: double
weightTo
number format: double
widthFrom
number format: double
widthTo
number format: double
heightFrom
number format: double
heightTo
number format: double
lengthFrom
number format: double
lengthTo
number format: double
sortBy
string
default: CreatedAt
Dozwolone wartości: Stock Price Location Id CatalogId Catalog ManufacturerId Manufacturer Name NameWithParentName Vat VatSymbol Ean Sku Weight Width Height Length Stocks ProductPriceGroups ProductLinks CategoryId Category Properties ComplexFields AdditionalEans ParentId Parent Variants IsParent IsBundle IsAsteriskMarked BundleItems Bundles Translations CreatedAt UpdatedAt
andFilters
Array<string>
excludedIds
Array<integer>
includedIds
Array<integer>
sortOrder
string
default: desc
availability
string
default: All
Dozwolone wartości: Available NotAvailable All
productConnections
Array<string>
excludedProductConnections
Array<string>
hasNoProductConnections
boolean
pageSize
integer format: int32
default: 100 <= 1000

Max value : 1000

pageNumber
integer format: int32
0
isBundle
boolean
strictFilter
boolean
searchInVariants
boolean
searchOperator
string
Dozwolone wartości: AND OR
includes.includeCatalog
boolean
includes.includeManufacturer
boolean
includes.includeCategory
boolean
includes.includeStocks
boolean
includes.includeProperties
boolean
includes.includeProductLinks
boolean
includes.includeComplexFields
boolean
includes.includeVariants
boolean
includes.includeBundleItems
boolean
includes.includeTranslations
boolean
location
string
categoriesIds
Array<integer>
manufacturersIds
Array<integer>
externalProductId
string
productPropertyExternalId
string
language
string

Success

object
totalRecords
integer format: int32
totalPages
integer format: int32
data
Array<object>
nullable
object
id
integer format: int64
name
string
nullable
parentId
integer format: int64
nullable
isParent
boolean
variantsCount
integer format: int32
nameWithParentName
string
nullable
catalogId
integer format: int64
vat
number format: double
ean
string
nullable
sku
string
nullable
weight
number format: double
width
number format: double
height
number format: double
length
number format: double
isBundle
boolean
createdAt
string format: date-time
updatedAt
string format: date-time
nullable
isAsteriskMarked
boolean
nullable
catalog
object
id
integer format: int64
name
string
nullable
description
string
nullable
languages
Array<string>
nullable
isDefault
boolean
reservations
boolean
defaultWarehouseId
integer format: int64
defaultPriceGroupId
integer format: int64
category
object
id
integer format: int64
name
string
nullable
parentId
integer format: int64
catalogId
integer format: int64
manufacturer
object
id
integer format: int64
name
string
nullable
stocks
Array<object>
nullable
object
id
string
nullable
warehouseId
integer format: int64
quantity
integer format: int32
locationName
string
nullable
vatAmount
number format: double
vatSymbol
string
nullable
createdAt
string format: date-time
updatedAt
string format: date-time
nullable
productPriceGroups
Array<object>
nullable
object
id
string
nullable
productId
string
nullable
priceGroupId
integer format: int64
catalogId
integer format: int64
price
number format: double
nullable
currency
string
Dozwolone wartości: None PLN EUR AED AFN ALL AMD ANG AOA ARS AUD AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BRL BSD BTC BTN BWP BYN BZD CAD CDF CHF CLP CNY COP CRC CUC CUP CVE CZK DJF DKK DOP DZD EGP ERN ETB FJD FKP GBP GEL GHS GMD GNF GTQ GYD HKD HNL HRK HTG HUF IDR ILS INR IQD IRR ISK JMD JPY KES KGS KHR KMF KPW KRW KWD KYD LAK LBP LKR LRD LSL LTL LVL LYD MAD MDL MGA MKD MMK MNT MOP MRO MUR MVR MWK MXN MYR MZM NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLY PYG QAR RON RSD RUB RWF SAR SBD SCR SDG SEK SGD SHP SLL SOS SRD STD SVC SYP SZL THB TJS TMT TND TOP TRY TTD TWD TZS UAH UGX USD UYU UZS VED VEF VND VUV WST XAF XCD XOF XPF YER ZAR ZMW ZWL
createdAt
string format: date-time
updatedAt
string format: date-time
nullable
properties
Array<object>
nullable
object
id
string
nullable
name
string
nullable
value
string
nullable
externalId
string
nullable
productLinks
Array<object>
nullable
object
id
string
nullable
productId
string
nullable
externalProductId
string
nullable
externalVariantId
string
nullable
externalConnectionId
string
nullable
connectionId
integer format: int64
createdAt
string format: date-time
updatedAt
string format: date-time
nullable
complexFields
Array<object>
nullable
object
name
string
nullable
value
string
nullable
bundleItems
Array<object>
nullable
object
id
integer format: int64
bundleItemProductId
integer format: int64
quantity
integer format: int64
name
string
nullable
stocks
Array<object>
nullable
object
id
string
nullable
warehouseId
integer format: int64
quantity
integer format: int32
locationName
string
nullable
vatAmount
number format: double
vatSymbol
string
nullable
createdAt
string format: date-time
updatedAt
string format: date-time
nullable
translations
object
key
additional properties
object
name
string
nullable
descriptionComplexFields
Array<object>
nullable
object
name
string
nullable
description
string
nullable
productProperties
Array<object>
nullable
object
name
string
nullable
value
string
nullable