Skip to content

List of products

Request

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 include parameter (see Section on demand.

If you state the include=images 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 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.

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
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
includestring

optional parts of response

Example:include=images
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
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
itemsPerPageinteger

Returned items per page. Default value is 20. Max value is 1000.

Example:itemsPerPage=50
pageinteger

Page number to return. Default value is 1.

Example:page=3
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/products?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&include=images&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&supplierGuid=16a67ec6-d957-11e0-b04f-57a43310b768&changeTimeFrom=2017-02-28T17%3A04%3A47%2B0100&changeTimeTo=2028-02-28T17%3A04%3A47%2B0100&itemsPerPage=50&page=3' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

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