# List of all products

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 (in  attribute)


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


Include parameter     | Meaning
---                   | ---
images                | Export will also contain the list of all product images. For more information about the chapter Product images.
variantParameters     | Export will also contain a field of variant parameters and a variant description, as they are visible to customers.
allCategories         | Export will also contain information on all the categories that the product was assigned into
flags                 | Details on product designation
descriptiveParameters | Export will also contain descriptive parameters of the product
measureUnit           | Export will also contain measure unit info of every variant.
surchargeParameters   | Export will also contain surcharge parameters of the product.
setItems              | Export will also contain items, products, in set.
filteringParameters   | Export will also contain filtering parameters of the product.
recyclingFee          | Export will also contain recycling fee.
consumptionTax        | Export will also contain consumption tax. Requires the "Consumption tax" module to be enabled on the current e-shop.
warranty              | Export will also contain product warranty.
sortVariants          | Product variants will be sorted as in administration.
gifts                 | List of gifts (variants) related to product
alternativeProducts   | The response will also contain alternative products.
relatedProducts       | The response will also contain related products.
relatedVideos         | The response will also contain related videos.
relatedFiles          | The response will also contain related files.
perStockAmounts       | The response will also contain amounts/claims per individual stocks. Requires the "stock" module to be enabled on the current e-shop.
perPricelistPrices    | The response will also contain prices per individual price lists.

Use  or  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  and cannot be combined.

Result file is compressed using GZIP.

Endpoint: GET /api/products/snapshot
Version: 1.0.0
Security: shoptetAccessToken, shoptetPrivateApiToken

## Query parameters:

  - `include` (string)
    Optional parts of response
    Example: "images,variantParameters,allCategories,flags,descriptiveParameters,measureUnit,surchargeParameters,setItems,filteringParameters,recyclingFee,consumptionTax,warranty,sortVariants,gifts,alternativeProducts,relatedProducts,relatedVideos,relatedFiles,perStockAmounts,perPricelistPrices"

  - `productCodes` (string)
    Define the output set of products. Use max. 50 product codes separated by a comma. No additional filters take
effect. Cannot be combined with  query parameter.
    Example: "15/ZLU,15/ZEL,27/XL,33/FIA,DS53437473,428"

  - `productGuids` (string)
    Define the output set of products. Use max. 50 product GUIDs separated by a comma. No additional filters take
effect. Cannot be combined with  query parameter.
    Example: "356eb81e-d966-11e0-b04f-57a43310b768,519d8f84-1609-11f0-bcf6-06999863e34a,519d8f84-1609-11f0-bcf6-06999863e34a"

  - `creationTimeFrom` (string)
    date of product creation, lower limit. Optional.
    Example: "2017-02-28T17:04:47+0100"

  - `creationTimeTo` (string)
    date of product creation, upper limit. Optional.
    Example: "2028-02-28T17:04:47+0100"

  - `visibility` (string)
    Product visibility (visible, hidden, only for logged-in users...) - see also Product visibility code list. Optional.
    Example: "visible"

  - `type` (string)
    Product type (product, service, bazar...) - see also Product types code list. Optional.
    Example: "product"

  - `brandName` (string)
    product brand (manufacturer) name. Optional.
    Example: "Storm"

  - `brandCode` (string)
    product brand (manufacturer) code from  endpoint.
Optional.
    Example: "storm"

  - `defaultCategoryGuid` (string)
    product default category. Optional.
    Example: "5c499a23-70ac-11e9-9208-08002774f818"

  - `categoryGuid` (string)
    product category - only the products added to specific category will
be included. Optional.
    Example: "5c499a23-70ac-11e9-9208-08002774f818"

  - `flag` (string)
    product flag - only products with selected flag will be included
    Example: "action"

  - `supplierGuid` (string)
    supplier GUID - only products with selected supplier will be
included
    Example: "16a67ec6-d957-11e0-b04f-57a43310b768"

  - `changeTimeFrom` (string)
    date of product last update, lower limit. Optional.
    Example: "2017-02-28T17:04:47+0100"

  - `changeTimeTo` (string)
    date of product last update, upper limit. Optional.
    Example: "2028-02-28T17:04:47+0100"

## Header parameters:

  - `Content-Type` (string, required)

## Response 202 fields (application/json):

  - `data` (object)

  - `data.jobId` (string, required)
    token of job

  - `errors` (array,null)

  - `errors.errorCode` (string, required)
    Short text error identification

  - `errors.message` (string, required)
    Descriptive error message

  - `errors.instance` (string, required)
    Identification of the entity referenced

## Response 400 fields (application/json):

  - `data` (object,null)

  - `errors` (array,null)

  - `errors.errorCode` (string, required)
    Short text error identification

  - `errors.message` (string, required)
    Descriptive error message

  - `errors.instance` (string, required)
    Identification of the entity referenced

## Response 403 fields (application/json):

  - `data` (object,null)

  - `errors` (array,null)

  - `errors.errorCode` (string, required)
    Short text error identification

  - `errors.message` (string, required)
    Descriptive error message

  - `errors.instance` (string, required)
    Identification of the entity referenced