Stránkovaný výpis produktů
Filtrovatelný, stránkovaný seznam produktů.
Základní info
- URL:
https://b2bapi-{INSTANCE}/api/products-list - Povolené metody:
POST - V těle dotazu je třeba vyplnit informace pro filtrování a stránkování
Parametry
| Parametr | In | Povinný | Popis |
|---|---|---|---|
filter | body | ne | Filtr (popsán níže) |
pageNumber | body | ano | Číslo stránky |
pageSize | body | ano | Velikost stránky |
orderBy | body | ne | Pole, podle kterého se řadí (např. ['themeName asc', 'productCode desc']) |
limitFields | body | ne | Pole, které se mají vrátit (např. ['productCode', 'productName', 'price']) |
Filtr
- Basic
| Parametr | Typ | Popis |
|---|---|---|
productCode | string | Kód zboží, stačí jen část |
productId | int[] | Unikátní identifikátory |
name | string | Název, stačí jen část |
barcode | string | Čárový kód, stačí jen část |
themeId | int[] | ID témata |
groupId | int[] | ID skupiny |
subGroupId | int[] | ID podskupiny |
modelId | int[] | ID modely |
seasonId | int[] | ID sezóny |
vatRate | int[] | ID Sazby DPH |
manufacturersBrandId | int[] | ID značky výrobců |
unitId | int[] | ID měrné jednotky |
{
"filter": {
"basic": {
"productCode": "string",
"productId": [0],
"name": "string",
"barcode": "string",
"themeId": [0],
"groupId": [0],
"subGroupId": [0],
"modelId": [0],
"seasonId": [0],
"vatRate": [0],
"manufacturersBrandId": [0],
"unitId": [0]
}
},
"pageNumber": 0,
"pageSize": 0,
"orderBy": ["string"],
"limitFields": ["string"]
}Schéma
| Pole | Datový typ | Popis |
|---|---|---|
productId | int | Unikátní identifikátor |
productCode | string | Kód zboží |
productName | string | Název |
themeCode | string | Kód témata |
themeName | string | Název témata |
groupCode | string | Kód skupiny |
groupName | string | Název skupiny |
subGroupCode | string | Kód podskupiny |
subGroupName | string | Název podskupiny |
modelName | string | Název modelu |
quantityInStock | string | Stav zásob na skladu Nabývá hodnot: - 0: produkt není skladem - 1+ skladem je 1-5 - 5+ skladem je 5-10 - 10+ skladem je 10-50 - 50+ skladem je více než 50 Hodnoty jsou v hlavní měrné jednotce |
vatRate | string | Sazba DPH |
price | decimal | Běžná cena produktu (bez započítaných slev a promoakcí) |
priceWoVat | decimal | Běžná cena produktu bez DPH (bez započítaných slev a promoakcí) |
seasonCode | string | Kód sezóny |
seasonName | string | Název sezóny |
unitName | string | Měrná jednotka |
isbn | string | ISBN |
mainBarcode | string | Hlavní čárový kód |
createdDate | Date | Datum založení |
manufacturersBrandName | string | Značka výrobce |
isService | bool | Je služba |
isInactive | bool | Je neaktivní (pokud true, nelze použít v objednávce) |
hasVariants | bool | Má varianty (pokud true, je třeba u objednávání použít čárový kód se specifikací varianty ) |
themeId | int | ID témata |
groupId | int | ID skupiny |
subGroupId | int | ID podskupiny |
modelId | int | ID modelu |
seasonId | int | ID sezóny |
manufacturersBrandId | int | ID značky výrobce |
unitId | int | ID měrné jednotky |