WinShopAPI docs
ReferenceProduct

Get several products

Returns the products listed in `productIds`, each shaped by the `details` sub-queries. Prefer this over looping `GET {productId}` when you already know the whole set of ids. Requires `Permissions.Product.View`.

GET
/api/products/product-details

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Query Parameters

productIds?array<>
details?array<>|null

Response Body

application/json
  1. response
[index: integer]?
curl -X GET 'https://<your-instance>/api/products/product-details' \  -H 'Authorization: Bearer <access-token>'
[  {    "adr": "string",    "ageLimitId": 0,    "alternativeShade": "string",    "atest": "string",    "automaticBatchNumber": true,    "availableForRent": true,    "availableOnExternalWarehouse": true,    "baseVatRateId": 0,    "calculateOnMovement": true,    "calculatedItemIntake": true,    "calculatedItemShowRecipeOnInvoices": true,    "calculatedItemStockTakingProhibited": true,    "canBeInsured": true,    "canBeInsuredForFree": true,    "canBeProducedAtProductionTerminal": true,    "canBeReadOnlyThroughEAN": true,    "cannotPayWithFoodStamps": true,    "carrierId": 0,    "collectionCard": true,    "color": 0,    "commercialPackagingId": 0,    "commissionPercent": 0,    "commodity": "string",    "companyCreditFromCodeBook": true,    "comparatorUnitId": 0,    "countryOfOriginId": 0,    "createdAt": "2019-08-24T14:15:22Z",    "creditWithInvoice": true,    "customsCodeId": 0,    "deactivateAfterSellOut": true,    "density": 0,    "depth": 0,    "depthInPackaging": 0,    "depthInPackagingUnitId": 0,    "depthUnitId": 0,    "descriptionEshop": "string",    "deviation": 0,    "diameter": 0,    "diameterInPackaging": 0,    "diameterInPackagingUnitId": 0,    "diameterUnitId": 0,    "dimension": "string",    "dimensionStandard": "string",    "dimensionUnitId": 0,    "doNotPairPermanently": true,    "dryMatter": 0,    "electricDevice": true,    "electronicSecurity": true,    "environmentalTaxId": 0,    "eshop1": true,    "eshop2": true,    "eshop3": true,    "eshop4": true,    "eshop5": true,    "eshopReservationsOnly": true,    "eshopSeasonId": 0,    "eshopThemeId": 0,    "eshopUnitId": 0,    "estimatedProductionTime": 0,    "excludeFromRepricing": true,    "exportForCompetitivePricing": true,    "exportRegardlessOfStockStatus": true,    "exportedToInternet": true,    "fixedDiscountOnInternet": true,    "franchiseCountryVATRate": 0,    "franchiseSupplyFromOwnWarehouses": true,    "franchiseSupplyFromOwnWarehousesSK": true,    "groupId": 0,    "guid": "string",    "height": 0,    "heightInPackaging": 0,    "heightInPackagingUnitId": 0,    "heightUnitId": 0,    "hideOnTouchScreen": true,    "hidePriceOnInternet": true,    "homeWarehouseId": 0,    "ignoreWarehouseStatus": true,    "infoPanelId": 0,    "intakeLossPercentage": 0,    "isAssembly": true,    "isBatch": true,    "isBazaar": true,    "isButchering": true,    "isCalculatedItem": true,    "isColorAndSize": true,    "isCommissionItem": true,    "isCredit": true,    "isDataBar": true,    "isDiscountProhibited": true,    "isDownPayment": true,    "isInactive": true,    "isInsurance": true,    "isIntakeProhibited": true,    "isNew": true,    "isNotForSaleSeparately": true,    "isOnSaleOut": true,    "isOrderingProhibited": true,    "isOutlet": true,    "isRemitenda": true,    "isSaleForbiddenIfNotOnStock": true,    "isSaleProhibited": true,    "isScrap": true,    "isService": true,    "isServis": true,    "isUnpacked": true,    "isVoucher": true,    "isbn": "string",    "labelTypeId": 0,    "lastMainSupplierPurchasePrice": 0,    "lastModify": "2019-08-24T14:15:22Z",    "lastPurchasePrice": 0,    "limitedEdition": true,    "listOutPriority": 0,    "loadCapacity": 0,    "mandatoryExpiration": true,    "manufacturersBrandId": 0,    "manufacturersWebSite": "string",    "materialLiability": true,    "materialStandard": "string",    "maxDiscount": 0,    "maxOperatingTemperature": 0,    "maxProductionBatch": 0,    "maxStorageTemperature": 0,    "minMargin": 0,    "minOperatingTemperature": 0,    "minStorageTemperature": 0,    "modelId": 0,    "monitorFatContent": true,    "nameWithoutDiacritics": "string",    "newsPanelId": 0,    "notifyOnSaleIntoNegative": true,    "notifyOnSaleIntoNegativeOnAnyWarehouse": true,    "notifyOnSoldOut": true,    "notifyWhenStockQuantityBellowMinimum": true,    "onlyToOrder": true,    "orderCustomerOnlyWholePackages": true,    "orderInternalOnlyWholePackages": true,    "orderOnlyWholePackages": 0,    "orderSupplierOnlyWholePackages": true,    "packagingSet": true,    "packagingSetItemCount": 0,    "paintThinner": "string",    "pickUpOnlyAtStore": true,    "plu": 0,    "pluQuickCodeWeight": 0,    "pluWeight": 0,    "points": 0,    "posCanChangePrice": true,    "posCanEnterProductName": true,    "posCannotReturnIfNotNegative": true,    "posDoNotAddUpSameProduct": true,    "posEetNoSend": true,    "posPriceChangeMin": 0,    "posPrintComposition": true,    "posPrintNote": true,    "posPrintNote1OnProduct": true,    "posPrintNote2OnProduct": true,    "posPrintNote3OnProduct": true,    "posPrintNote4OnProduct": true,    "posPrintNotes1": true,    "posPrintPackaging": true,    "posPrintUsageInstructions": true,    "posPrintWarrantyConditions": true,    "posQueryProductionNumber": true,    "posShowRelatedProducts": true,    "priceHit": true,    "printExpirationOnDocument": true,    "printInPriceList": true,    "productClass": "string",    "productCode": "string",    "productFunctionalityId": 0,    "productId": 0,    "productManagerUserId": 0,    "productName": "string",    "productNameEshop": "string",    "productNameEshopShort": "string",    "productNameShort": "string",    "productStatusId": 0,    "productionMustWeigh": true,    "quality": "string",    "qualityId": 0,    "quantityUnitId": 0,    "recyclingFeeId": 0,    "returnablePackaging": true,    "returnablePackagingPrice": 0,    "returnablePackagingProductId": 0,    "returnablePackagingQuantity": 0,    "returnablePackagingWeight": true,    "ripeningTime": 0,    "roDiscount": true,    "royaltyId": 0,    "s01": "string",    "s02": "string",    "s03": "string",    "s04": "string",    "sapMaterialNumber": "string",    "sazka": true,    "seasonId": 0,    "sendToScale": true,    "setComponent": true,    "setPrice": 0,    "shade": "string",    "shareWithFranchise": true,    "shareWithFranchiseSK": true,    "shelfLife": 0,    "shelfLifeEshop": 0,    "shouldWeighGoods": true,    "showLabelsOnDispatchTerminal": true,    "showOnDispatchTerminal": true,    "showOnIntakeDispatchTerminal": true,    "showOnPackingTouchCashRegister": true,    "showOnProductionDispatchTerminal": true,    "showOnTransferDispatchTerminal": true,    "skp": 0,    "specializedTransportation": true,    "statisticalNumber": "string",    "stockPrice": 0,    "storageLossPercentage": 0,    "strengthId": 0,    "subGroupId": 0,    "supplierId": 0,    "supplierProductCode": "string",    "takeAway": true,    "temperatureControlDuringIntake": true,    "temporaryCard": true,    "themeId": 0,    "transportCost": 0,    "typeNumber": "string",    "unitId": 0,    "unitsPerPackage": 0,    "useCommercialPackagingOnIntake": true,    "useCommercialPackagingOnOrder": true,    "userId": 0,    "usesColor": true,    "usesDimension": true,    "usesLength": true,    "usesLocations": true,    "usesSerialNumber": true,    "usesSerialNumbers": true,    "usesSize": true,    "usesVariants": true,    "virtualCard": true,    "voc": 0,    "volume": "string",    "volumeInPackaging": "string",    "volumeInPackagingUnitId": 0,    "volumeUnitId": 0,    "voucherCheckNumber": true,    "wastePercentage": 0,    "weight": 0,    "weightInPackaging": 0,    "weightInPackagingUnitId": 0,    "weightUnitId": 0,    "width": 0,    "widthInPackaging": 0,    "widthInPackagingUnitId": 0,    "widthUnitId": 0,    "alternativeProducts": [      {        "alternativeProductId": 0,        "id": 0,        "productId": 0      }    ],    "attachments": [      {        "fileName": "string",        "id": 0,        "level1Id": 0,        "level2Id": 0,        "level3Id": 0,        "pathToFile": "string",        "productId": 0      }    ],    "barcodes": [      {        "allowedWarehouseId": 0,        "barcode": "string",        "batchId": 0,        "colorId": 0,        "createdAt": "2019-08-24T14:15:22Z",        "dimensionId": 0,        "discountBillCustomerId": 0,        "discountBillLimit": 0,        "discountBillPercentage": 0,        "ean128": true,        "ean13": true,        "ean39": true,        "expirationDate": "2019-08-24T14:15:22Z",        "financialPromotionId": 0,        "forSaleOnlyInStock": true,        "guid": "string",        "id": 0,        "isInvalid": true,        "isMain": true,        "isNotPrintable": true,        "isWeight": true,        "lastModify": "2019-08-24T14:15:22Z",        "lengthId": 0,        "originalQuantity": 0,        "personalization": 0,        "price": 0,        "priceCoefficient": 0,        "productId": 0,        "quantity": 0,        "quantityCoefficient": 0,        "sizeId": 0,        "unitId": 0,        "usedAt": 0,        "usedWarehouseId": 0,        "userId": 0,        "validFrom": "2019-08-24T14:15:22Z",        "validTo": "2019-08-24T14:15:22Z",        "variantId": 0      }    ],    "buildingMaterial": {      "basisWeight": 0,      "colorId": 0,      "consumption": "string",      "density": 0,      "edge": "string",      "handle": "string",      "id": 0,      "materialId": 0,      "onlyInStockOrOrder": "string",      "paletteDimensionsId": 0,      "paletteTypeId": 0,      "productId": 0,      "sizeId": 0,      "strength": 0,      "sumOfThermalConductivity": 0,      "surfaceFinishId": 0,      "thickness": 0,      "type": "string",      "typeId": 0    },    "colorSizeVariants": [      {        "batchId": 0,        "cDontExportToInternet": true,        "cIsNew": true,        "cPriceHit": true,        "colorId": 0,        "dimensionId": 0,        "id": 0,        "lengthId": 0,        "note": "string",        "productId": 0,        "sizeEshop": "string",        "sizeId": 0,        "variantId": 0      }    ],    "eshopCategorizationGroups": [      0    ],    "eshopCategorizationSubGroups": [      0    ],    "eshopCategorizationThemes": [      0    ],    "foreignNames": [      {        "countryCode": 0,        "foreignName": "string",        "guid": "string",        "id": 0,        "productId": 0      }    ],    "gardening": {      "bindingId": 0,      "contentsId": 0,      "flowerCount": 0,      "flowerId": 0,      "flowerProductId": 0,      "id": 0,      "mainFlowerId": 0,      "occasionId": 0,      "productId": 0    },    "gardeningColorFullness": {      "colourFullnessId": 0,      "id": 0,      "productId": 0    },    "gardeningStyle": {      "id": 0,      "productId": 0,      "styleId": 0    },    "individualParameters": [      {        "cardId": 0,        "date": "2019-08-24T14:15:22Z",        "id": 0,        "isTrue": true,        "parameterId": 0,        "productId": 0,        "text": "string",        "unitId": 0,        "value": 0,        "valueId": 0,        "warehouseId": 0      }    ],    "jewellery": {      "chronographId": 0,      "claspType": "string",      "class": "string",      "commodity": "string",      "dateDisplayId": 0,      "glassId": 0,      "id": 0,      "materialId": 0,      "materialPricePerGram": 0,      "materialPurityId": 0,      "materialSize": 0,      "materialWeight": 0,      "movementId": 0,      "movementTypeId": 0,      "note": "string",      "ornamentSize": "string",      "productId": 0,      "secondStone": "string",      "specifications": "string",      "stoneCertificate": "string",      "stoneClarityId": 0,      "stoneColorId": 0,      "stoneCut": "string",      "stoneSize": 0,      "stoneTypeId": 0,      "strapColor": "string",      "strapId": 0,      "strapSizeId": 0,      "watchCaseId": 0,      "watchCaseSizeId": 0,      "watchFaceColor": "string",      "watchFaceDimensions": "string",      "watchFaceShapeId": 0,      "watchFaceTypeId": 0,      "watchStyleId": 0,      "waterTightnessId": 0    },    "notes": {      "guid": "string",      "id": 0,      "note": "string",      "note1": "string",      "productId": 0    },    "photos": [      {        "guid": "string",        "id": 0,        "photoUrl1": "string",        "photoUrl2": "string",        "photoUrl3": "string",        "photoUrl4": "string",        "photoUrl5": "string",        "photoUrl6": "string",        "productId": 0      }    ],    "prices": [      {        "batchId": 0,        "cSaleOut": true,        "colorId": 0,        "dateOfLastRepricing1": "2019-08-24T14:15:22Z",        "dateOfLastRepricing10": "2019-08-24T14:15:22Z",        "dateOfLastRepricing11": "2019-08-24T14:15:22Z",        "dateOfLastRepricing12": "2019-08-24T14:15:22Z",        "dateOfLastRepricing13": "2019-08-24T14:15:22Z",        "dateOfLastRepricing14": "2019-08-24T14:15:22Z",        "dateOfLastRepricing15": "2019-08-24T14:15:22Z",        "dateOfLastRepricing2": "2019-08-24T14:15:22Z",        "dateOfLastRepricing3": "2019-08-24T14:15:22Z",        "dateOfLastRepricing4": "2019-08-24T14:15:22Z",        "dateOfLastRepricing5": "2019-08-24T14:15:22Z",        "dateOfLastRepricing6": "2019-08-24T14:15:22Z",        "dateOfLastRepricing7": "2019-08-24T14:15:22Z",        "dateOfLastRepricing8": "2019-08-24T14:15:22Z",        "dateOfLastRepricing9": "2019-08-24T14:15:22Z",        "dimensionId": 0,        "guid": "string",        "id": 0,        "isMainPrice": true,        "lengthId": 0,        "price1": 0,        "price10": 0,        "price10WoVat": 0,        "price11": 0,        "price11WoVat": 0,        "price12": 0,        "price12WoVat": 0,        "price13": 0,        "price13WoVat": 0,        "price14": 0,        "price14WoVat": 0,        "price15": 0,        "price15WoVat": 0,        "price1WoVat": 0,        "price2": 0,        "price2WoVat": 0,        "price3": 0,        "price3WoVat": 0,        "price4": 0,        "price4WoVat": 0,        "price5": 0,        "price5WoVat": 0,        "price6": 0,        "price6WoVat": 0,        "price7": 0,        "price7WoVat": 0,        "price8": 0,        "price8WoVat": 0,        "price9": 0,        "price9WoVat": 0,        "productId": 0,        "referencePrice1": 0,        "referencePrice10": 0,        "referencePrice11": 0,        "referencePrice12": 0,        "referencePrice13": 0,        "referencePrice14": 0,        "referencePrice15": 0,        "referencePrice2": 0,        "referencePrice3": 0,        "referencePrice4": 0,        "referencePrice5": 0,        "referencePrice6": 0,        "referencePrice7": 0,        "referencePrice8": 0,        "referencePrice9": 0,        "sizeId": 0,        "usesMainPrice": true,        "variantId": 0      }    ],    "recipes": [      {        "calculateIfInRecipe": true,        "componentProductId": 0,        "createdAt": "2019-08-24T14:15:22Z",        "id": 0,        "isMandatory": true,        "item": 0,        "maxQuantity": 0,        "priceRatio": 0,        "productId": 0,        "quantity": 0,        "showOnShippingTerminal": true,        "substituteComponentProductId": 0,        "substituteWarehouseId": 0,        "tolerancePrecent": 0,        "variantId": 0,        "warehouseId": 0      }    ],    "relatedProducts": [      {        "id": 0,        "productId": 0,        "relatedProductId": 0      }    ],    "shoe": {      "bagHeight": 0,      "bagWidth": 0,      "calfWidthId": 0,      "heelHeight": 0,      "id": 0,      "isA4FormatBags": true,      "isAnkleBoots": true,      "isBackless": true,      "isBackpackBags": true,      "isBagsWithHandles": true,      "isBallShoe": true,      "isBeltBags": true,      "isClutchBags": true,      "isCrossBodyBags": true,      "isDetachableStrapBags": true,      "isFlipFlops": true,      "isFormal": true,      "isFormalBags": true,      "isHandheldBags": true,      "isInsulated": true,      "isLaceUp": true,      "isLargeBags": true,      "isLuxury": true,      "isNarrowCalf": true,      "isOversize": true,      "isPerforated": true,      "isRealSheepWool": true,      "isRemovableInsole": true,      "isShoulderBags": true,      "isSnowBoots": true,      "isSportsShoe": true,      "isTopZipBags": true,      "isWalletBags": true,      "isWedding": true,      "isWideCalf": true,      "isWithFur": true,      "manufacturingMethodId": 0,      "materialLiningId": 0,      "materialSoleId": 0,      "materialUpperId": 0,      "memoryFoamInsole": true,      "paramEshop1": "string",      "paramEshop2": "string",      "paramEshop3": "string",      "productId": 0,      "remonte": true,      "revolution": true,      "secondaryColorId": 0,      "shoeHeightId": 0,      "shoeHeightWithoutHeel": 0,      "shoeType2Id": 0,      "shoeType3Id": 0,      "shoeTypeId": 0,      "shoeWidthId": 0,      "soleHeight": 0,      "soleTypeId": 0,      "tertiaryColorId": 0,      "texMembrane": true    },    "similarProducts": [      {        "id": 0,        "productId": 0,        "similarProductId": 0      }    ],    "sport": {      "accessoriesSummerBagTypeId": 0,      "accessoriesSummerBottleVolume": 0,      "accessoriesSummerCycleComputerTypeId": 0,      "accessoriesSummerFenderLightId": 0,      "accessoriesSummerPumpTypeId": 0,      "accessoriesWinterBottleVolume": 0,      "accessoriesWinterGlassTypeId": 0,      "accessoriesWinterHelmetSkeletonId": 0,      "accessoriesWinterNumberOfPairs": 0,      "accessoriesWinterPouchTypeId": 0,      "accessoriesWinterProtectionTypeId": 0,      "accessoriesWinterProtectorTypeId": 0,      "bikeAssortmentOfGoodsId": 0,      "bikeBrakeId": 0,      "bikeFrameMaterialId": 0,      "bikeFullSuspension": true,      "bikePriceLevelId": 0,      "bikeSuspensionId": 0,      "bikeTypeId": 0,      "bikeWheelDiameter": 0,      "clothesBreathability": 0,      "clothesGaiterId": 0,      "clothesShoeTypeId": 0,      "clothesSleeveTrousersLegId": 0,      "clothesWaterColumn": 0,      "id": 0,      "isAccessoriesSummerWaterBag": true,      "isAccessoriesWinterBagWithWheels": true,      "isAccessoriesWinterHeated": true,      "isAccessoriesWinterOtg": true,      "isAccessoriesWinterVisor": true,      "isB2b": true,      "isClothesFreeCut": true,      "isClothesHeated": true,      "isClothesSuspenders": true,      "isClothesWinter": true,      "isKickbackScooter": true,      "isRental": true,      "isTestCentrum": true,      "partsShoeTypeId": 0,      "partsTyreTypeId": 0,      "partsValveId": 0,      "partsWheelDiameterId": 0,      "productId": 0,      "skiingBindingId": 0,      "skiingBindingSystemId": 0,      "skiingCategoryId": 0,      "skiingFlexion": 0,      "skiingMaterialId": 0,      "skiingRadius": 0,      "skiingRiserChamberId": 0,      "skiingShoeWidth": 0,      "skiingTechniqueId": 0,      "sportClothesSportTypeIds": [        0      ],      "sportGeneralModelIds": [        0      ],      "sportSkiingRiderProfileIds": [        0      ]    },    "suppliersInfo": [      {        "countryOfDispatch": 0,        "deliveryTime": 0,        "guid": "string",        "id": 0,        "isMain": true,        "lastModify": "2019-08-24T14:15:22Z",        "lastPurchasePrice": 0,        "lastPurchasePriceCurrencyId": 0,        "lastPurchasePriceForeignCurrency": 0,        "minQuantityToOrder": 0,        "minimalShelfLife": 0,        "productId": 0,        "productName": "string",        "promoFromDate": "2019-08-24T14:15:22Z",        "promoPurchasePrice": 0,        "promoPurchasePriceForeignCurrency": 0,        "promoPurchasePriceForeignCurrencyId": 0,        "promoToDate": "2019-08-24T14:15:22Z",        "shelfLife": 0,        "supplierId": 0,        "supplierProductCode": "string",        "unitId": 0,        "unitsInPackage": 0,        "warranty": 0      }    ],    "suppliersProductCodes": [      {        "allowedWarehouseId": 0,        "colorId": 0,        "createdAt": "2019-08-24T14:15:22Z",        "dimensionId": 0,        "id": 0,        "isInvalid": true,        "lastModify": "2019-08-24T14:15:22Z",        "lengthId": 0,        "price": 0,        "priceCoefficient": 0,        "productId": 0,        "quantityCoefficient": 0,        "sizeId": 0,        "supplierId": 0,        "supplierProductCode": "string",        "unitId": 0,        "userId": 0,        "variantId": 0      }    ],    "texts": {      "characteristics": "string",      "guid": "string",      "id": 0,      "instructionToUse": "string",      "productComposition": "string",      "productId": 0,      "rating": "string",      "suitableUse": "string",      "technologicalProcess": "string",      "warrantyTermsAndConditions": "string"    },    "units": [      {        "depth": 0,        "depthInPackaging": 0,        "depthInPackagingUnitId": 0,        "depthUnitId": 0,        "diameter": 0,        "diameterInPackaging": 0,        "diameterInPackagingUnitId": 0,        "diameterUnitId": 0,        "dimension": "string",        "dimensionUnitId": 0,        "guid": "string",        "height": 0,        "heightInPackaging": 0,        "heightInPackagingUnitId": 0,        "heightUnitId": 0,        "id": 0,        "isInvisible": true,        "productId": 0,        "quantityCoefficient": 0,        "unit": 0,        "unitId": 0,        "unitOrder": 0,        "volume": "string",        "volumeInPackaging": "string",        "volumeInPackagingUnitId": 0,        "volumeUnitId": 0,        "weight": 0,        "weightInPackaging": 0,        "weightInPackagingUnitId": 0,        "weightUnitId": 0,        "width": 0,        "widthInPackaging": 0,        "widthInPackagingUnitId": 0,        "widthUnitId": 0      }    ],    "userGroups": [      {        "id": 0,        "productId": 0,        "userGroupId": 0      }    ]  }]