Skip to content

List of all products

Request

Using this endpoint, you can get list of all products with detailed info of each product (like in Product Detail endpoint) asynchronously. See how Asynchronous requests work on our developer's portal.

Response will be in jsonlines format with each product taking one line of output file.

One product in response has the same format as product detail response. See Product snapshot schema for more details.

This endpoint has several sections, which are exported only when requested in the include parameter (see Section on demand).

Include parameterMeaning
imagesExport will also contain the list of all product images. For more information about the chapter Product images.
variantParametersExport will also contain a field of variant parameters and a variant description, as they are visible to customers.
allCategoriesExport will also contain information on all the categories that the product was assigned into
flagsDetails on product designation
descriptiveParametersExport will also contain descriptive parameters of the product
measureUnitExport will also contain measure unit info of every variant.
surchargeParametersExport will also contain surcharge parameters of the product.
setItemsExport will also contain items, products, in set.
filteringParametersExport will also contain filtering parameters of the product.
recyclingFeeExport will also contain recycling fee.
consumptionTaxExport will also contain consumption tax. Requires the "Consumption tax" module to be enabled on the current e-shop.
warrantyExport will also contain product warranty.
sortVariantsProduct variants will be sorted as in administration.
giftsList of gifts (variants) related to product
alternativeProductsThe response will also contain alternative products.
relatedProductsThe response will also contain related products.
relatedVideosThe response will also contain related videos.
relatedFilesThe response will also contain related files.
perStockAmountsThe response will also contain amounts/claims per individual stocks. Requires the "stock" module to be enabled on the current e-shop.
perPricelistPricesThe response will also contain prices per individual price lists.

Use productCodes or productGuids request parameter to get the list of specific products. Product codes/GUIDs are separated by a comma. If you use this query parameter, other filters are not applied, and the set of particular products is returned. Please note that these parameters accepts max. 50 product codes/GUIDs in request parameter and cannot be combined.

Result file is compressed using GZIP.

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
includestring

Optional parts of response

Example:include=images,variantParameters,allCategories,flags,descriptiveParameters,measureUnit,surchargeParameters,setItems,filteringParameters,recyclingFee,c
productCodesstring

Define the output set of products. Use max. 50 product codes separated by a comma. No additional filters take effect. Cannot be combined with productGuids query parameter.

Example:productCodes=15/ZLU,15/ZEL,27/XL,33/FIA,DS53437473,428
productGuidsstring

Define the output set of products. Use max. 50 product GUIDs separated by a comma. No additional filters take effect. Cannot be combined with productCodes query parameter.

Example:productGuids=356eb81e-d966-11e0-b04f-57a43310b768,519d8f84-1609-11f0-bcf6-06999863e34a,519d8f84-1609-11f0-bcf6-06999863e34a
availabilityIdinteger

product availability id. Optional.

Example:availabilityId=1
availabilityWhenSoldOutIdinteger

product availability id when not stocked. Optional.

Example:availabilityWhenSoldOutId=-2
creationTimeFromstring

date of product creation, lower limit. Optional.

Example:creationTimeFrom=2017-02-28T17:04:47+0100
creationTimeTostring

date of product creation, upper limit. Optional.

Example:creationTimeTo=2028-02-28T17:04:47+0100
visibilitystring

Product visibility (visible, hidden, only for logged-in users...) - see also Product visibility code list. Optional.

Example:visibility=visible
typestring

Product type (product, service, bazar...) - see also Product types code list. Optional.

Example:type=product
brandNamestring

product brand (manufacturer) name. Optional.

Example:brandName=Storm
brandCodestring

product brand (manufacturer) code from /api/brands endpoint. Optional.

Example:brandCode=storm
defaultCategoryGuidstring

product default category. Optional.

Example:defaultCategoryGuid=5c499a23-70ac-11e9-9208-08002774f818
categoryGuidstring

product category - only the products added to specific category will be included. Optional.

Example:categoryGuid=5c499a23-70ac-11e9-9208-08002774f818
flagstring

product flag - only products with selected flag will be included

Example:flag=action
supplierGuidstring

supplier GUID - only products with selected supplier will be included

Example:supplierGuid=16a67ec6-d957-11e0-b04f-57a43310b768
changeTimeFromstring

date of product last update, lower limit. Optional.

Example:changeTimeFrom=2017-02-28T17:04:47+0100
changeTimeTostring

date of product last update, upper limit. Optional.

Example:changeTimeTo=2028-02-28T17:04:47+0100
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/products/snapshot?include=images%2CvariantParameters%2CallCategories%2Cflags%2CdescriptiveParameters%2CmeasureUnit%2CsurchargeParameters%2CsetItems%2CfilteringParameters%2CrecyclingFee%2CconsumptionTax%2Cwarranty%2CsortVariants%2Cgifts%2CalternativeProducts%2CrelatedProducts%2CrelatedVideos%2CrelatedFiles%2CperStockAmounts%2CperPricelistPrices&productCodes=15%2FZLU%2C15%2FZEL%2C27%2FXL%2C33%2FFIA%2CDS53437473%2C428&productGuids=356eb81e-d966-11e0-b04f-57a43310b768%2C519d8f84-1609-11f0-bcf6-06999863e34a%2C519d8f84-1609-11f0-bcf6-06999863e34a&availabilityId=1&availabilityWhenSoldOutId=-2&creationTimeFrom=2017-02-28T17%3A04%3A47%2B0100&creationTimeTo=2028-02-28T17%3A04%3A47%2B0100&visibility=visible&type=product&brandName=Storm&brandCode=storm&defaultCategoryGuid=5c499a23-70ac-11e9-9208-08002774f818&categoryGuid=5c499a23-70ac-11e9-9208-08002774f818&flag=action&supplierGuid=16a67ec6-d957-11e0-b04f-57a43310b768&changeTimeFrom=2017-02-28T17%3A04%3A47%2B0100&changeTimeTo=2028-02-28T17%3A04%3A47%2B0100' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

Accepted

Bodyapplication/json
dataobject
errorsArray of objects or null(Errors)
metadataobject(Metadata)
Response
{
  "data": {
    "jobId": "ad24xod"
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}