# List of products

Returns the list of products - only basic info and GUID, using this you can determine the details 
with another API call. Endpoint supports Paging.


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


If you state the  parameter within the URL, then information about main product image will 
also be part of the response. For more information about the chapter Product images.


Please note it is better to use List of all products endpoint for getting all products from eshop.

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.

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

## Query parameters:

  - `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"

  - `include` (string)
    optional parts of response
    Example: "images"

  - `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"

  - `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 200 fields (application/json):

  - `data` (object, required)

  - `data.products` (array, required)

  - `data.products.guid` (string, required)
    unique product indicator

  - `data.products.name` (string, required)
    product name

  - `data.products.type` (string, required)
    product type (, ...) - see also [Product types](#section/code-lists/product-types) code list

  - `data.products.url` (string,null, required)

  - `data.products.visibility` (string, required)
    visibility of product (,  ...) - see also [Product visibility](#section/code-lists/product-visibility) code list

  - `data.products.creationTime` (string,null, required)
    date and time of product creation (date in ISO 8601 format)

  - `data.products.changeTime` (string,null, required)
    date and time of last product change (date in ISO 8601 format)

  - `data.products.brand` (any, required)
    product brand (or manufacturer, possibly)

  - `data.products.supplier` (any, required)
    product supplier

  - `data.products.defaultCategory` (object, required)
    default product category

  - `data.products.defaultCategory.guid` (string,null, required)
    category unique identifier (can be )

  - `data.products.defaultCategory.name` (string,null, required)
    category description

  - `data.products.defaultCategory.visible` (boolean,null, required)
    whether the parameter is visible

  - `data.products.mainImage` (object,null)
    image information (filled in only on request. if  parameter is defined)

  - `data.products.mainImage.name` (string, required)
    image file name, also serves as an identifier for the image of the product. To assemble complete URL, it is added to the  obtained from the endpoint e-shop info .

  - `data.products.mainImage.seoName` (string, required)
    file name modified for SEO - a short label is attached.

  - `data.products.mainImage.cdnName` (string, required)
    same as  with attached hashed last image change time.

  - `data.products.mainImage.priority` (number, required)
    the key for the sequence of images matching the sequence in administration - it's not necessarily from the first, and the series may contain gaps.

  - `data.products.mainImage.description` (string,null, required)
    image label

  - `data.products.mainImage.changeTime` (string,null, required)
    last image change time If you are saving images together, you can use this timestamp to indicate if you need to reload the image.

  - `data.products.voteAverageScore` (string,null)
    Average score of product reviews

  - `data.products.voteCount` (integer,null)
    Count of product reviews

  - `data.products.preauthorizationRequired` (boolean)
    whether the preauthorization is required; available only if shoptet pay module is enabled

  - `data.paginator` (object, required)

  - `data.paginator.totalCount` (integer, required)
    total number of available records

  - `data.paginator.page` (integer, required)
    current page

  - `data.paginator.pageCount` (integer, required)
    total available of pages

  - `data.paginator.itemsOnPage` (integer, required)
    number of currently returned records

  - `data.paginator.itemsPerPage` (integer, required)
    required number of records per page

  - `errors` (array,null, required)

  - `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