Shoptet API (1.0.0)

Created in cooperation with the Ministry of Industry and Trade of the Czech Republic within the "The Country for the Future" programme.

This documentation provides information about the interface for developers who would like to gain access to Shoptet

e-shops. For more information about Shoptet, see https://www.shoptet.cz/.

The API is available in two access modes:

  • for "Shoptet partner” developers who create the interconnection with the services and extend the Shoptet system's functions for public usage. For more information about API and conditions, under which it can be used, see https://developers.shoptet.com/addons/.

  • direct private access to eshop data for eshop owner - available only for Premium Members. See https://developers.shoptet.com/premium for more information about API access.

Basic principles

How to call API

API supports communication in JSON format. The URL for calling API requests is https://api.myshoptet.com. The API calls

(endpoints and message formats) are common for private as well as addons access, it however uses different authentication

and authorization principles.

For Addons

API is made to create the supplements for the Shoptet system and uses OAuth2 authorization principles.

To access the API it is necessary to implement a web service at your side, which will communicate with our OAuth server.

In your e-shop administration, which you are using to work with our API, you must search in the API Partner section for the Access to API tab.

Here, you will find your clientID and addresses, from where you can call our OAuth server.

The work with API begins with e-shop addon installation. (The installation process can be tested in the addon detail in the Users section, where you can cause the installation for your e-shop.)

In your addon detail, in the Settings section, enter URL to gain a OAuth code. The URL must be linked to your server, where the script is prepared, which is able to gain an OAuth access token.

At this address, you will receive the HTTP request with a GET parameter code, when installing the addon, with unique value (a 255 character long string).

The code provided only has short-term validity and can be used only once. With this code, request our OAuth server to provide an OAuth access token.

Such a request shall follow within the same script that received the code.

Do not put off gaining the OAuth access token for a later time, and do not reply to our request with a 200 OK status, until you gain the OAuth access token.

The address for you to call, and an example of implementation, can be found in e-shop administration in the Access to API section.

As a response you will obtain a JSON with your OAuth access token. Save this token securely. Never send this token to the client computer, and use it only

for communication between the servers and for gaining the temporary token for access to API.

If you have successfully received an OAuth access token, your script must end with the HTTP status code “200”.

Now you have your OAuth access token, which links your addon with a specific e-shop, perhaps you would like to communicate with the e-shop via API.

From your server, call https://<eshop-address.tld>/action/ApiOAuthServer/getAccessToken address with HTTP header Authorization: Bearer <OAuth access token>.

As the reply, you will receive a JSON containing an API access token value and the token expiration time value. An example of calling can be found in e-shop administration in the Access to API section.

It is possible to request a maximum of 5 valid tokens.

The API access token will enable you to call an individual URL of our API, for example https://api.myshoptet.com/api/eshop. Send the API access token in each request in the HTTP headerShoptet-Access-Token.

You can have several valid API access tokens available at any one time. Should the validity of the API access token expire, you will receive a HTTP status code 401 and message about token expiration.


{
    "data": 'null',
    "errors": [
        {
            "errorCode": "expired-token",
            "message": "Token is expired. Please ask for new one.",
            "instance": "unknown"
        }
    ]
}

If your token does not have the access right for a specific endpoint, you will obtain a reply with HTTP status code 403 Forbidden.


{
    "data": 'null',
    "errors": [
        {
            "errorCode": "invalid-token-no-rights",
            "message": "Your access token \"afd..123\" has no defined rights for this resource.",
            "instance": "access-token"
        }
    ]
}

For private API access (Premium)

You can create API access tokens simply in the eshop administration. Send them in the request header Shoptet-Private-API-Token.

You can automatically access all API endpoints.

Rate limiting

Rate limiting is only at the level of server overload protection (DDoS), whereas the quantity of queries or total volume of data are unlimited.

These are therefore the limits of the maximum number of coincident active connections. A maximum of 50 from a single IP address, and a maximum of

3 connections for a single token. If the limit is exceeded, the HTTP code 429 is returned. See also Nginx configuration:

    limit_conn per_ip 50;
    limit_conn per_token 3;
    limit_conn_status 429;

Some URLs, for example for bulk operations, can have their own specific limits, which are mentioned in this documentation.

Locks

Write endpoints (DELETE, PATCH, POST, PUT methods) can take longer and may be prone to two concurrent matching requests.

To avoid problems with retrying identical write requests, we have added the locking function of these requests to the application.

If you execute the same request two times in quick succession, the second request receives error response with a 423 code.

The lock is only valid for a specific called URL, for the duration of the request processing, but no longer than 5 seconds.

API versioning

Current version of API: v1.0

The client must send a Content-Type header with value of application/vnd.shoptet.v1.0,

where v1.0 is the API version supported by the client. If there is any change in the API, then we are trying to make it

reverse compatible, therefore it is not necessary to regularly update your connection after each change in our interface.

The version is the same for all endpoints described here.

Server response format

All JSON responses from the server have the same format, as a base.

If any of the sections is not present in the response, a null value is then received.

Example of call for addons:


curl --include \
    -H 'Shoptet-Access-Token: 123456-a-123-XXXXXXXXXXXXXXXXXXXXXXXXX' \
    -H 'Content-Type: application/vnd.shoptet.v1.0' \
   'https://api.myshoptet.com/api/eshop'

Example of call for private API access:


curl --include \
    -H 'Shoptet-Private-API-Token: 123456-a-123-XXXXXXXXXXXXXXXXXXXXXXXXX' \
    -H 'Content-Type: application/vnd.shoptet.v1.0' \
   'https://api.myshoptet.com/api/eshop'

Example of response:


HTTP/2 200

date: Fri, 13 Jul 2018 15:57:29 GMT

content-type: application/vnd.shoptet.v1.0+json; charset=utf-8


{
    "data": {
        "contactInformation": {
            "eshopName": "www.domena-eshopu.cz",
            "url": "https:\/\/www.domena-eshopu.cz\/",
            "companyId": "28935675",
           ...
        }
        ...
    },
    "errors": 'null'
}

The basic structure of the response in the event of an error is as follows:


{
    "data": 'null',
    "errors": [
        {
            "errorCode": "missing-access-token",
            "message": "Missing access token. Please add `Shoptet-Access-Token` header to your request.",
            "instance": "unknown"
        }
    ]
}

Most of the endpoints are synchronous, i.e. your answer is provided immediately and contains the data requested. There

are however some endpoints, where either the request or the response processing takes longer time. These are implemented as

Asynchronous requests. Your request will be queued and you

receive only job identification in the response. You will be notified using a

webhook when the job is completed and your results

downloadable. Be aware, that registration of webhook job:finished is required to be able to run asynchronous requests.

If webhook is not registered, you will receive an error response with HTTP status code 403 and job won't be queued.

Webhook job:finished is also emitted when the job is failed so there is need to check the Detail of job to get the result of the job. If an error occurs during an asynchronous request, the job is automatically marked as failed 3 hours after its creation, and in this case, the job:finished webhook is not emitted.

Some attributes may be added to the new API version, or the sequence of attributes can be changed.

Your software, therefore, shall not rely on either of these.

If some attributes are renamed or removed, you will be informed in an additional

header - see also API versioning and Deprecated header + Sunset.

Deprecated header + Sunset

If you are calling some endpoint in a version that will not be supported in the future, you will receive a response with the header

X-Shoptet-Deprecated. If you detect this header within the response and its presence is logged,

you should be aware of the support termination for a specific endpoint in advance and thus have enough time for correction.

Furthermore, you shall also receive the response with aSunset header with the date when the support for this endpoint is to be terminated.

Status codes

When processing the response, the client shall first detect, what response status code was received.

For GET requests for responses with 200 code, it is not necessary to explore the errors part of the response.

For PATCH/PUT requests, which can process more records at the same time and some records

are not processed successfully, these end with a 200 response code and the errors key contains info on skipped rows.

The unknown record is returned with a 404 code, etc. These responses have the error field filled in, where you can

find detailed info about the error.

The following errors might be expected:

  • 400 - Some of the validations on item level have failed. There is no reason to retry, it will fail always.

  • 401 - Invalid token or the token has expired (for addons access tokens). You have to ask for another one.

  • 403 - Forbidden. The token has no rights to the endpoint called. The endpoints must be allowed for an addon and the eshop must have approved them. Valid for addons access tokens, private tokens can always access all endpoints. Can be also returned when required module for request is missing.

  • 404 - Either the endpoint is wrong; or most commonly, an entity identifier, which is part of the URL, does not exist.

  • 409 - Conflict - the action could not be completed for some consistency rules, such as duplicate data or relation, which would be broken.

  • 413 - Payload too large - update requests can sometimes contain multiple entities to be amended. There is however a limit (varying for each request), how many can be specified within one request. If you breach the limit, you will get this error and nothing will be updated.

  • 422 - Unprocessable entity - we were not able to parse the request - it does not match the expected format. Something is wrong with the request as whole, it might not be a correct JSON or it does not match the expected JSON schema. There is no reason to retry, it will always fail.

  • 423 - Locked - for update and some read request we apply locks, usually on an URL level, which should avoid consistency problems possibly occuring from parallel updates. See chapter about locks. Retry later, try to avoid parallel update requests.

  • 500 - General server error. Yes, this might happen to our software, too. Most commonly this is a temporary database issue and it might (but might not), work a few minutes later. We monitor all such errors and we try to analyze and fix them.

  • 503 - System maintenance. Most commonly we move a database to another database cluster or a database migration is pending and it will be available in a few minutes. Please try later.

Paging

Some endpoints can return larger quantity of records. Such endpoints do not return the entire result, but support pagination of results.

You can page using page (int) and itemsPerPage (int) parameters. The first page has number 1. If you require a different

quantity of items per page, use the itemsPerPage parameter. CAUTION: the number of items per page can be decreased only, the default

value is maximum. The default value can be different for each endpoint.

When paging, check the total number of items, if not altered (totalCount), then the

items on pages could be shifted and some of them could be missed or processed twice.

Section on demand

Some endpoints return the data sections as optional, on demand. The request is done by giving the section name in the

include parameter. Part of the data is returned each time, the other section only on demand. This makes the responses smaller for those, who do not need the data

, thus saving the volume of data transmitted and shortening the time to process the request.

For example, for "Eshop Info" endpoint, you will gain basic info when simply calling [GET] /api/eshop, but payment

methods and transport options only when using [GET] /api/eshop?include=paymentMethods,shippingMethods.

More values are separated by a comma, no sequencing, no upper/lower case differentiation. Other blocks are available on demand

and each endpoint informs you which identifier to request.

Translations

For proper functionality in translations you will have to get module Foreign languages (Cizí jazyky) activated on customer e-shop. Multi-language support in API is handled by query parameter language, which can be used in whole API. If parameter is not set, default shop language is used.

Read endpoints (HTTP verb GET) will return corresponding language version of texts where applicable.

For write endpoints, first use POST endpoint to create entity and then use PATCH endpoint with corresponding language query parameter to set language fields.

Please note that in some endpoints (typically surcharge/filtering/variant parameters) you must use the identifier's currently selected language variant (which is filtered in list).

Files

For files upload, there are Files endpoints.

The file is uploaded to a temporary storage which is not accessible publicly. The file is kept there for 7 days and then deleted.

After you upload a file, you may copy it to some API entities in their endpoints - you specify filename returned in response of upload job.

Please note that currently only images (png, jpg, gif) are allowed filetypes for file upload.

Product images

Shoptet saves the product images in their original size and then prepares several sizes for standardized usage (called

image cuts). These cuts are created in advance and saved on the disk, so they are readily available. The list of cuts is

the same for each e-shop, and each e-shop can theoretically have different cut sizes. In practice, their size is given

by the template and most templates use the same sizes. The list of provided cuts is given by

the Image cuts code list.

The /api/eshop?include=imageCuts endpoint returns the imageCuts field in the response, where each cut has the actual

size defined, and the URL base path. There are two base URLs (example for classic.shoptet.cz, cut detail):

  • urlPath: "https://classic.shoptet.cz/user/shop/detail/"

  • cdnPath: "https://cdn-api.myshoptet.com/usr/classic.shoptet.cz/user/shop/detail/"

Use the urlPath in case you need an up-to-date image right now. Use the url for your backend processing and you

will retrieve the images only once. Images retrieved via urlPath are not cached. You can use image name or SEO version

of the image name - see below.

Use the cdnPath in case you want to use the image url on the frontend and users of your application will display it,

e.g. if you provide an alternative frontend, mobile application etc. The images are cached and provided with lower

latency. Use cdnName retrieved from the product detail endpoint (or similar) - see below.

Once you determine the URL based on the purpose and image cut size (for example detail for product detail, or related

for product preview), just append the filename you need. The filename can be retrieved from Product detail endpoint.

Although the e-shop is behind the content delivery network (Cloudflare CDN), API still returns the same domain. Whether

the e-shop is behind the Cloudflare CDN, you can find out from response headers (CDN-Loop: cloudflare header).

The product detail endpoint /api/products/{guid}?include=images returns the image field data.images[] in the same

sequence, as these are entered in administration. The file name name (for example 100.jpg) needs to be connected

to the URL cut and then you have complete path to the image of a given cut (size), for example

https://classic.shoptet.cz/user/shop/detail/100.jpg. You can also use seoName, which also contains a description

of the image - you will be redirected to the same image. The cdnName is intended for use with the cdnUrl only.

The fields look like: (excerpt)

    "name": "106.png",
    "description": "shamrock 2115611 640",
    "seoName": "106_shamrock-2115611-640.png",
    "cdnName": "106_shamrock-2115611-640.png?5b2a41f5"

One of the images mentioned for the product can be selected as the default image for the product variant. The selected

image is in data.variants[].image item and contains the name of the image – this can be searched for in the image

list, in the name item. Should the variant have no preselected default image, the parameter image is null.

If data.variants[].isProductDefaultImage is true, then the default product image is given. If it is false, then it is the default variant image.

The item data.items[].mainImage contains the main image in order detail - this is either a default variant image,

or, if not set (or product does not have variants), the default product image is given. The structure is the same as

in product details, but not all images are given here, only the default one – representative image. The full path can

be gained by assembling the urlPath from the e-shop info and the name or seoName items, given for the order item.

Similarly, the product list gives data.products[].mainImage, which mentions the initial image for each product.

Code lists

Image cuts

Value | Description

-------- | ---------

orig | original image (in the original resolution)

big | big image (typically 1024x768 px)

detail |image detail (typically 360x270 px)

category | size for listing in category (typically 216x105 px)

Product visibility

Value | Description

-------- | ---------

hidden | Hide product

visible | Show product

blocked | Cannot be ordered

show-registered | Show only to logged-in users

block-unregistered | Do not allow order to logged-out users

cash-desk-only | Show only in cash desk

detail-only | Do not show e-shop navigation

Product types

Value | Description

-------- | ---------

product | Product

bazar | Second-hand product

service | Service

gift-certificate | Gift (deprecated)

product-set | Product set

Types of order items

Value | Description

-------- | ---------

product | Product

bazar | Second-hand product

service | Service

shipping | Transportation

billing | Payment method

discount-coupon | Discount coupon

volume-discount | Volume discount

gift | Gift

gift-certificate | Gift certificate

generic-item | Non-specific item

product-set | Product set

product-set-item | Product set item

deposit | Deposit

Sorting of products in category

Value | Description

-------- | ---------

default | Default

most-selling | Most selling first

cheapest | Cheapest first

most-expensive | Most expensive first

oldest | Oldest first

newest | Newest first

alphabetically | Alphabetically

alphabetically-desc | Alphabetically, descending

product-code | Per product code

product-code-desc | Per product code, descending

category-priority | Category priority

category-priority-desc | Category priority, descending

Webhook event types

Value | Description | Identifier meaning

-------- | --------- | ---------

brand:create | Brand creation event | String (code) - brand unique code

brand:update | Brand change event | String (code) - brand unique code

brand:delete | Brand deleting event | String (code) - brand unique code

creditNote:create | Credit note creation event | Number (code) of credit note

creditNote:delete | Credit note deleting event | Number (code) of credit note

creditNote:update | Credit note change event | Number (code) of credit note

customer:create | New customer was created | Customer GUID

customer:update | Customer was updated. Throws 409 Conflict when try to register simultaneously with customer:disableOrders or customer:enableOrders | Customer GUID

customer:disableOrders | An event disabled the customer, and his future orders will be automatically cancelled. Throws 409 Conflict when try to register simultaneously with customer:update | Customer GUID

customer:enableOrders | An event enabled the customer's future orders. Throws 409 Conflict when try to register simultaneously with customer:update | Customer GUID

customer:import | Import of 1 and more customers was executed | Fixed string "customers"

customer:delete | Customer was deleted | Customer GUID

deliveryNote:create | Delivery note creation event | Number (code) of delivery note

deliveryNote:delete | Delivery note deleting event | Number (code) of delivery note

deliveryNote:update | Delivery note change event | Number (code) of delivery note

eshop:currencies | Currencies settings change event | ID of eshop

eshop:billingInformation | Billing information (i.e. eshop billing address) change event | ID of eshop

eshop:design | Design settings (template, colors, fonts, layout) | ID of eshop

eshop:mandatoryFields | Mandatory fields of customer were updated | ID of eshop

eshop:projectDomain | Domain of eshop was changed | ID of eshop

invoice:create | Invoice creation event | Number (code) of invoice

invoice:delete | Invoice deleting event | Number (code) of invoice

invoice:update | Invoice change event | Number (code) of invoice

job:finished | The asynchronous request was finished | Job id

mailingListEmail:create | E-mail addition event into the e-mail distribution list | Name (code) of e-mail distribution list

mailingListEmail:delete | E-mail deleting event from the e-mail distribution list | Name (code) of e-mail distribution

order:cancel | Order cancel event. Webhook is emitted when order status is set to canceled. Throws 409 Conflict when try to register simultaneously with order:update | Number (code) of order

order:create | Order creation event | Number (code) of order

order:delete | Order deleting event | Number (code) of order

order:update | Order change event. Throws 409 Conflict when try to register simultaneously with order:cancel | Number (code) of order

orderStatusesList:change | Order status list change event. Emitted when order status is created, updated or deleted | Order status ID

paymentMethod:change | Payment method change event | Payment method GUID

proformaInvoice:create | Proforma invoice creation event | Number (code) of proforma invoice

proformaInvoice:delete | Proforma invoice deleting event | Number (code) of proforma invoice

proformaInvoice:update | Proforma invoice change event | Number (code) of proforma invoice

proofPayment:create | Proof of payment creation event | Number (code) of proof payment

proofPayment:delete | Proof of payment deleting event | Number (code) of proof payment

proofPayment:update | Proof of payment change event | Number (code) of proof payment

shippingMethod:change | Shipping method change event | Shipping method GUID

shippingRequest:cancelled | Shipping request was not chosen for order delivery | shippingRequestCode associated with the cart

shippingRequest:confirmed | Shipping request was chosen for order delivery | shippingRequestCode associated with the cart

stock:movement | Stock change event | Stock ID

stock:inStock (*) | Stock change event - sum across all of the stocks raised above 0 (beta, see below) | Number (code) of product

stock:soldOut (*) | Stock change event - sum across all of the stocks reached 0 (beta, see below) | Number (code) of product

stock:minStockSupplyReached (*) | Stock change event - sum across all of the stocks reached minimum stock supply value, if this limit is set for product (beta, see below) | Number (code) of product

(*) These webhooks are considered beta/experimental, for more information, please visit the X-url

Mass Webhooks

These webhooks are sent when a mass change of entities is performed. The payload contains a json serialized list of IDs of changed entities.

Purpose of these webhooks is to downgrade number of requests, while i.e. administrator performs mass change of orders status at once etc.

So instead of emitting one event for every order, we emit one event for all of them.

For now, if some mass event is performed, we also sent "single" webhook event for every updated entity as usual, but it will be changed in future, so please watch release changes for more info

Value | Description | Identifier meaning

-------- | --------- | ---------

invoice:massUpdate | Mass change of invoices event | Json serialized list of number (code) of invoices

order:massUpdate | Mass change of orders event | Json serialized list of number (code) of orders

System Webhooks

These webhooks cannot be registered via API, they are setup in Partners' Addon administration section instead.

Value | Description

----- | -----------

addon:suspend | The addon was suspended by the eshop or by Shoptet operations staff

addon:approve | The addon was approved (resumed) after it was suspended

addon:terminate | The addon was terminated by the eshop or by Shoptet operations staff

addon:uninstall | The addon was uninstalled by the eshop admin or the eshop was terminated

URL address from endpoint Eshop info

See endpoint Eshop info

Ident | Description

------| -----

admin-orders-list | Listing of orders in administration

admin-customers-list | List of customers in administration

oauth | OAuth server address, used for e-shop user verification

List of product catalogues

Provider (identification) | Description

------| -----

glami | Glami

google | Google

heureka | Heuréka

zbozi | Zboží.cz

Invoice Billing Methods

id | Description

------| -----

1 | COD (cz: Dobírka)

2 | Wire transfer (cz: Převodem)

3 | Cash (cz: Hotově)

4 | Card (cz: Kartou)

VAT modes

Value |

------|

Normal |

One Stop Shop |

Mini One Stop Shop |

Reverse charge |

Outside the EU |

Postman collection

If you use Postman as an API platform for building and using APIs, we provide you a complex collection of Shoptet API.

You have 2 options how to import our postman collection (created from openApi schema - openapi.yaml ) into your postman client

Fork Shoptet API Collection from Shoptet Public API Workspace (recommended)

See Shoptet Public API Workspace.

Also check postman documentation for more details: Fork a collection.

Step 1: Navigate to Shoptet Public API Workspace

  • Launch Postman on your desktop or in the browser.

  • In the search bar in the top header of app, type Shoptet Public API and select collection from Shoptet public API Workspace.

Step 2: Locate the Shoptet API Collection

  • Once inside the Shoptet Public API Workspace, go to the Collections tab.

  • Find the Shoptet API collection.

Step 3: Fork the Collection

  • Click on the Shoptet API collection to open it.

  • In the collection view, click the Fork button in the top-right corner.

  • In the fork dialog, choose a name for your forked collection.

  • Select the workspace where you want to save the forked collection.

  • It’s recommended to check watch original collection to get notified about changes in the original collection.

  • Click Fork Collection.

Step 4: Access Your Forked Collection

  • Navigate to the workspace where you saved the forked collection.

  • You’ll now find the forked Shoptet API collection under the Collections tab, ready for you to use and modify.

Now you have your own copy of the Shoptet API collection! If you want to add changes from the original collection, you can do so by click on pull changes in collection settings.

Import openapi.yaml into Postman as a Collection

Step 1: Upload the openapi.yaml File

  • Download the openapi.yaml file from our developers repository.

  • Launch Postman on your desktop or in the browser.

  • In the top-left corner of Postman, click the Import button.

  • A pop-up window will appear.

  • Drag and drop your openapi.yaml file into the window, or click Upload Files and browse to the file's location.

Step 2: Verify OpenAPI Import

  • Postman will automatically recognize the OpenAPI schema.

  • It will display a preview of the API schema.

Step 3: Import as Collection

  • Once the file is recognized, click Import.

  • Postman will convert the OpenAPI schema into a collection of requests, based on the defined endpoints in the openapi.yaml file.

Step 4: Access the Imported Collection

  • After the import is successful, go to the Collections tab.

  • You’ll find your new collection, named after the OpenAPI schema, containing all the API requests generated from the file.

Now you can explore the API endpoints and use them directly within Postman!

Collection settings

  1. Click the Shoptet API collection name.

  2. Go to Authorization tab.

  3. Set your access token into the value of Shoptet-Access-Token key.

  4. Go to Variables tab.

  5. You can set baseUrl variable here.

Last changes

Last API changes are published on the [API news] page (https://developers.shoptet.com/category/api/).

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://api.myshoptet.com/

Eshop

This endpoint is used for general information about the e-shop settings.

Operations

Products

Product endpoints are used for managing products in the e-shop and also for its related modules.

Operations

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 Requested sections.

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.

Query
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
Example: visibility=visible
typestring
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
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/vnd.shoptet.v1.0
curl -i -X GET \
  'https://api.myshoptet.com/api/products?brandCode=string&brandName=string&categoryGuid=string&changeTimeFrom=string&changeTimeTo=string&creationTimeFrom=string&creationTimeTo=string&defaultCategoryGuid=string&flag=string&include=string&supplierGuid=string&type=string&visibility=string' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​productsArray of objectsrequired
data.​products[].​guidstring(typeGuidUnlimited)<= 36 charactersrequired

unique product indicator

data.​products[].​namestringrequired

product name

data.​products[].​typestringrequired
data.​products[].​urlstring or nullrequired
data.​products[].​visibilitystringrequired
data.​products[].​creationTimestring or null(typeDateTime)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

date and time of product creation (date in ISO 8601 format)

data.​products[].​changeTimestring or null(typeDateTime)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

date and time of last product change (date in ISO 8601 format)

data.​products[].​brandobject(brandNamed)required

product brand (or manufacturer, possibly)

data.​products[].​brand.​codestringrequired

unique brand code

data.​products[].​brand.​namestringrequired

brand name

data.​products[].​supplierobject(supplier)required

product supplier

data.​products[].​supplier.​guidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$required

supplier unique ID

data.​products[].​supplier.​namestringrequired

supplier name

data.​products[].​defaultCategoryobjectrequired

default product category

data.​products[].​defaultCategory.​guidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$required

category unique identifier (can be null)

data.​products[].​defaultCategory.​namestring or nullrequired

category description

data.​products[].​defaultCategory.​visibleboolean or nullrequired

whether the parameter is visible

data.​products[].​mainImageobject or null

image information (filled in only on request. if include=images parameter is defined)

data.​products[].​voteAverageScorestring or null(typeAmount)^(-)?[0-9]+\.[0-9]{3}$

Average score of product reviews

data.​products[].​voteCountinteger or null

Count of product reviews

data.​paginatorobject(paginator)required
data.​paginator.​totalCountintegerrequired

total number of available records

data.​paginator.​pageintegerrequired

current page

data.​paginator.​pageCountintegerrequired

total available of pages

data.​paginator.​itemsOnPageintegerrequired

number of currently returned records

data.​paginator.​itemsPerPageintegerrequired

required number of records per page

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "products": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ]
}

Product insertion

Request

This endpoint allows you to insert products into Shoptet. You can use it for an import from an external system.

Request is sent in JSON format in its body. For detailed description of items, which can be provided, see the right-most

pane, section "Request" » "Attributes".

Currently it is possible to insert only a basic product attributes

When creating product without variants, add one variant to variants array and it will be created as product without variants,

but with values specified in the variant.

When creating product with multiple variants, you must specify parameters which are different in each variant (variant A with

color black and size XXL and variant B with color yellow and size XXL is correct, but two variants with color black and size XXL is not correct).

Also, nameIndex must be unique in a variant (variant A with color black and color white is not correct).

Query
includestring

Optional parts of response

Example: include=images,variantParameters,allCategories,flags,descriptiveParameters,measureUnit,surchargeParameters,setItems,filteringParameters,recyclingFee,warranty,sortVariants,relatedVideos,perPricelistPrices
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectrequired
data.​guidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Product GUID. Must be unique if set.

data.​typestring

Product type. Optional, default value 'product'. Please note that 'product-set' requires 'sets' module to be enabled. Enum - see Product type code list

Enum"product""bazar""service""product-set"
data.​visibilitystring
Enum"hidden""visible""blocked""show-registered""block-unregistered""cash-desk-only""detail-only"
data.​namestring[ 1 .. 250 ] charactersrequired

Product's name. Mandatory. Maximal length of 250 characters.

data.​adultboolean

Whether the product is for adults only. Optional, default value false.

data.​shortDescriptionstring or null

Product's short description.

data.​descriptionstring or null

Product's full description.

data.​metaTitlestring or null[ 1 .. 255 ] characters

Product's seo title. Maximal length of 255 characters.

data.​metaDescriptionstring or null

Product's full description.

data.​conditionGradestring or nullnon-empty

Grade condition of second-hand product. Allowed only for bazar type.

data.​conditionDescriptionstring or nullnon-empty

Condition description of second-hand product. Allowed only for bazar type.

data.​defaultCategoryGuidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$required

Product's default category's GUID. Mandatory.

data.​brandCodestringnon-empty

Product's brand. Must exist if set.

data.​internalNotestringnon-empty

Product internal note.

data.​supplierGuidstring(typeGuid)[ 1 .. 36 ] characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Supplier GUID. Must exist if set.

data.​categoryGuidsArray of strings(typeGuid)non-empty
data.​warrantyIdinteger or null

Warranty ID.

data.​flagsArray of objectsnon-empty

Must exist if set.

data.​descriptiveParametersArray of objectsnon-empty

Product descriptive parameters.

data.​filteringParametersArray of objectsnon-empty
data.​surchargeParametersArray of objects(productRequestSurchargeParameter)non-empty

Product surcharge parameters. Not allowed for products with multiple tax classes.

data.​variantsArray of objectsnon-emptyrequired

Product's variants

data.​variants[].​codestring[ 1 .. 64 ] characters

Variant's code. Must be unique if set. Generated automatically if not set.

data.​variants[].​eanstring or null<= 255 characters

Variant's ean.

data.​variants[].​unitIdinteger

Variant's unit id. Optional

data.​variants[].​weightstring(typeWeightRequest)^[0-9]{1,5}\.[0-9]{3}$

Variant's weight in kilograms. 3 decimal places, and maximum value of 99999.999.

data.​variants[].​widthstring(typeDimension)^[0-9]{1,4}\.[0-9]{1}$

width of the product in cm. 1 decimal place, maximum 9999.9.

data.​variants[].​heightstring(typeDimension)^[0-9]{1,4}\.[0-9]{1}$

height of the product in cm. 1 decimal place, maximum 9999.9.

data.​variants[].​depthstring(typeDimension)^[0-9]{1,4}\.[0-9]{1}$

depth of the product in cm. 1 decimal place, maximum 9999.9.

data.​variants[].​visibleboolean

Is variant visible?

data.​variants[].​pricestring or null(typePrice)^(-)?[0-9]+\.[0-9]{2}$

Product price.

data.​variants[].​currencyCodestring(typeCurrencyCode)^[a-zA-Z]{3}$

currency code. List of available currencies within the e-shop can be found in endpoint GET /api/eshop.

data.​variants[].​manufacturerCodestring or null<= 32 characters

Variant's manufacturer code.

data.​variants[].​pluCodestring or null<= 16 characters

Variant's plu.

data.​variants[].​isbnstring or null<= 32 characters

Variant's ISBN.

data.​variants[].​serialNostring or null<= 32 characters

Variant's serial number.

data.​variants[].​mpnstring or null<= 32 characters

Variant's MPN.

data.​variants[].​availabilityIdnumber or null

Product availability id

data.​variants[].​availabilityWhenSoldOutIdnumber or null

Product availability id when not stocked

data.​variants[].​parametersArray of objects

Variant's parameters

data.​variants[].​minStockSupplystring or null(typePositiveAmount)^[0-9]+\.[0-9]{3}$

Minimum stock supply.

data.​variants[].​stocksLocationsArray of objects

Locations and amounts in stocks.

data.​variants[].​negativeStockAllowedboolean

Product stock can be in negative numbers

data.​variants[].​measureUnitobject(measureUnit)

Product variant measure and packaging units.

data.​variants[].​recyclingFeeIdinteger or null

Product recycling fee id

data.​variants[].​amountDecimalPlacesinteger

Amount of product variant decimal places.

Enum0123
data.​variants[].​atypicalBillingboolean

Has atypical billing?

data.​variants[].​atypicalShippingboolean

Has atypical shipping?

data.​indexNamestringnon-empty

String which defines product url. Value is sanitized to fits url needs. If value is not present, indexName is created from product name.

data.​relatedVideosArray of objects

Product related videos.

curl -i -X POST \
  'https://api.myshoptet.com/api/products?include=string' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
      "type": "product",
      "visibility": "hidden",
      "name": "Velká čokoláda",
      "adult": true,
      "shortDescription": "Velice kvalitní a dobrá čokoláda.",
      "description": "<p>Velice kvalitní a dobrá čokoláda. Chutná vždy dobře. <b>Neobsahuje arašídy.</b></p>",
      "metaTitle": "Velice kvalitní a dobrá čokoláda.",
      "metaDescription": "Velice kvalitní a dobrá čokoláda. Chutná vždy dobře. Neobsahuje arašídy.",
      "conditionGrade": "used",
      "conditionDescription": "Without original package.",
      "defaultCategoryGuid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
      "brandCode": "milka",
      "internalNote": "Internal note for product manager.",
      "supplierGuid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
      "categoryGuids": [
        "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"
      ],
      "warrantyId": 1,
      "flags": [
        {
          "code": "new",
          "dateFrom": "2017-04-04",
          "dateTo": "2017-04-04"
        }
      ],
      "descriptiveParameters": [
        {
          "name": "Material",
          "value": "Cotton",
          "description": "Material the shirt is made of",
          "priority": 1
        }
      ],
      "filteringParameters": [
        {
          "code": "action",
          "values": []
        }
      ],
      "surchargeParameters": [
        {
          "code": "pp-1",
          "values": [
            {
              "valueIndex": "hodnota-01",
              "price": "21.00",
              "visible": true
            }
          ]
        }
      ],
      "variants": [
        {
          "code": "0035",
          "ean": "8594001234567",
          "unitId": -1,
          "weight": "15.500",
          "width": "10.0",
          "height": "10.0",
          "depth": "10.0",
          "visible": true,
          "price": "21.00",
          "currencyCode": "CZK",
          "manufacturerCode": "OKI",
          "pluCode": "0828",
          "isbn": "978-80-251-0000-0",
          "serialNo": "B412",
          "mpn": "H3T5-87",
          "availabilityId": -1,
          "availabilityWhenSoldOutId": -3,
          "parameters": [
            {
              "nameIndex": "color",
              "valueIndex": "red"
            }
          ],
          "minStockSupply": "1.000",
          "stocksLocations": [
            {
              "stockId": 1,
              "amount": "1.000",
              "location": "H6/M11/R13"
            }
          ],
          "negativeStockAllowed": true,
          "measureUnit": {
            "packagingUnitId": 22,
            "packagingAmount": "1.000",
            "measureUnitId": 1,
            "measureAmount": "1.000"
          },
          "recyclingFeeId": 123,
          "amountDecimalPlaces": 2,
          "atypicalBilling": true,
          "atypicalShipping": true
        }
      ],
      "indexName": "baleriny-modre-s-puntiky",
      "relatedVideos": [
        {
          "code": "zpvmPA3me7o",
          "title": "Test video",
          "type": "youtube"
        }
      ]
    }
  }'

Responses

Created

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​productobject(product)required
data.​product.​guidstring(typeGuidUnlimited)<= 36 charactersrequired

unique product indicator

data.​product.​typestringrequired
data.​product.​namestring or null

product name

data.​product.​brandobject(brandNamed)required

product brand (or manufacturer, possibly)

data.​product.​brand.​codestringrequired

unique brand code

data.​product.​brand.​namestringrequired

brand name

data.​product.​supplierobject(supplier)required

product supplier

data.​product.​supplier.​guidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$required

supplier unique ID

data.​product.​supplier.​namestringrequired

supplier name

data.​product.​visibilitystringrequired
data.​product.​creationTimestring or null(typeDateTime)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

date and time of product creation (date in ISO 8601 format)

data.​product.​changeTimestring or null(typeDateTime)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

date and time of last product change (date in ISO 8601 format)

data.​product.​shortDescriptionstring or nullrequired

short product description

data.​product.​descriptionstring or nullrequired

product description. May contain html.

data.​product.​metaDescriptionstring or nullrequired

product label from meta tag.

data.​product.​urlstring or nullrequired

URL of the product in the e-shop

data.​product.​conditionGradestring or null

Grade condition of second-hand product. It contains value only for bazar type, otherwise, it is null.

data.​product.​conditionDescriptionstring or null

Condition description of second-hand product. It contains value only for bazar type, otherwise, it is null.

data.​product.​internalNotestring or nullrequired

product internal note

data.​product.​defaultCategoryobjectrequired

default product category

data.​product.​defaultCategory.​guidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$required

category unique identifier (can be null)

data.​product.​defaultCategory.​namestring or nullrequired

category description

data.​product.​defaultCategory.​visibleboolean or nullrequired

whether the parameter is visible

data.​product.​categoriesArray of objects

information about available product categories

data.​product.​descriptiveParametersArray of objects

product description parameters

data.​product.​additionalNamestring or null

Additional part of product name

data.​product.​xmlFeedNamestring or null

Name of xml feed

data.​product.​metaTitlestring

Meta (seo) title

data.​product.​adultboolean

Flag, whether the product is for adults only

data.​product.​atypicalBillingboolean

DEPRECATED (moved to variant) - Has atypical billing?

data.​product.​atypicalShippingboolean

DEPRECATED (moved to variant) - Has atypical shipping?

data.​product.​allowIPlatbaboolean

Is Cofidis payment allowed?

data.​product.​allowOnlinePaymentsboolean

Are online Payments allowed?

data.​product.​sizeIdNamestring or null

Name for sizeid.com

data.​product.​voteAverageScorestring or null(typeAmount)^(-)?[0-9]+\.[0-9]{3}$

Average score of product reviews

data.​product.​voteCountinteger or null

Count of product reviews

data.​product.​isVariantboolean

define if product has multiple variants.

data.​product.​variantsArray of objectsrequired

information about available product variants. For a product without variants, this field contains just one element with product details.

data.​product.​variants[].​codestringrequired

unique identification of the product variant

data.​product.​variants[].​eanstring or nullrequired

product variant bar code

data.​product.​variants[].​stockstring or null(typeAmount)^(-)?[0-9]+\.[0-9]{3}$required

quantity of goods in stock

data.​product.​variants[].​unitstring or nullrequired

unit of goods quantity

data.​product.​variants[].​weightstring(typeWeight)^[0-9]{1,6}\.[0-9]{3}$required

weight in kg, unpacked (can be null). 3 decimal places. Maximum value 999999.

data.​product.​variants[].​widthstring(typeDimension)^[0-9]{1,4}\.[0-9]{1}$required

width of the product in cm

data.​product.​variants[].​heightstring(typeDimension)^[0-9]{1,4}\.[0-9]{1}$required

height of the product in cm

data.​product.​variants[].​depthstring(typeDimension)^[0-9]{1,4}\.[0-9]{1}$required

depth of the product in cm

data.​product.​variants[].​visiblebooleanrequired

flag, whether the variant is visible

data.​product.​variants[].​pricestring or null(typePrice)^(-)?[0-9]+\.[0-9]{2}$required

price

data.​product.​variants[].​commonPricestring or null(typePrice)^(-)?[0-9]+\.[0-9]{2}$required

standard price

data.​product.​variants[].​manufacturerCodestring or nullrequired

manufacturer code

data.​product.​variants[].​pluCodestring or nullrequired

PLU code

data.​product.​variants[].​isbnstring or nullrequired

ISBN code

data.​product.​variants[].​serialNostring or nullrequired

serial number

data.​product.​variants[].​mpnstring or nullrequired

manufacturer part number

data.​product.​variants[].​includingVatbooleanrequired

flag, whether the price is including VAT

data.​product.​variants[].​vatRatestringrequired

VAT rate in percent

data.​product.​variants[].​currencyCodestringrequired

currency code

data.​product.​variants[].​minStockSupplystring or null(typeAmount)^(-)?[0-9]+\.[0-9]{3}$required

minimum stock supply

data.​product.​variants[].​actionPriceobject(actionPrice)required

special discounted price.

data.​product.​variants[].​actionPrice.​pricestring or null(typePrice)^(-)?[0-9]+\.[0-9]{2}$required

special discounted price. It is only used if set and if the validity date is set too, form (fromDate) to (toData).

data.​product.​variants[].​actionPrice.​fromDatestring or null(typeDate)^[0-9]{4}-[0-9]{2}-[0-9]{2}$required

date from which the special discounted price is valid.

data.​product.​variants[].​actionPrice.​toDatestring or null(typeDate)^[0-9]{4}-[0-9]{2}-[0-9]{2}$required

date to which the special discounted price is valid.

data.​product.​variants[].​imagestring or null

main image of variant (if set, otherwise the product's main image is to be used).

data.​product.​variants[].​isProductDefaultImageboolean

Determines whether the default product image is given (true) or the product variant image (false).

data.​product.​variants[].​namestring or null

name composed of the variant parameters, as seen in the e-shop. For products without variants this is null. Requires include=variantParameters parameter.

data.​product.​variants[].​amountDecimalPlacesintegerrequired

Number of decimal places for amount

data.​product.​variants[].​parametersArray of objects or null
data.​product.​variants[].​measureUnitobject or null

product measure unit

data.​product.​variants[].​availabilityobject(availabilityShort)

product availability

data.​product.​variants[].​availabilityWhenSoldOutobject(availabilityShort)

product availability when not stocked

data.​product.​variants[].​negativeStockAllowedstringrequired

is negative stock buying allowed? Possible values yes-global - yes, set globally, no-global - no, yes - globally no, but per this variant yes.

Enum"yes-global""no-global""yes"
data.​product.​variants[].​recyclingFeeobject(recyclingFeeCategory)

recycling fee including category and fee

data.​product.​variants[].​heurekaCPCstring or null

Heureka cost per click

data.​product.​variants[].​zboziCZobject

Information from zbozi.cz

data.​product.​variants[].​atypicalBillingboolean

Has atypical billing?

data.​product.​variants[].​atypicalShippingboolean

Has atypical shipping?

data.​product.​variants[].​perStockAmountsArray of objects or null

Variant amounts/claims per individual stocks.

data.​product.​variants[].​perPricelistPricesArray of objects or null

Variant prices per individual pricelists.

data.​product.​variants[].​urlstring or null

If product has multiple variants, URL of the variant is provided.

data.​product.​imagesArray of objects

information about images.

data.​product.​flagsArray of objects

product flags

data.​product.​surchargeParametersArray of objects(productSurchargeParameter)

product surcharge parameters

data.​product.​setItemsArray of objects or null

information about items, products, in set

data.​product.​filteringParametersArray of objects

product filtering parameters

data.​product.​warrantyobject or null

product warranty

data.​product.​giftsArray of objects(productGifts)

Gifts related to product

data.​product.​alternativeProductsArray of objects or null(relatedProduct)
data.​product.​relatedProductsArray of objects or null(relatedProduct)
data.​product.​relatedFilesArray of objects

files related to product

data.​product.​relatedVideosArray of objects

Videos related to product

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "product": { … }
  },
  "errors": [
    { … }
  ]
}

Product copy

Request

This endpoint allows you to copy a product identified by a GUID.

The new product will have the same attributes as the original product. Many settings can be copied from the original product,but some settings require an active module. See the details below.

By default, all parameters are copied and set to true unless specified otherwise. If you only want to copy certain parameters, select those you want to copy and set the others to false. If you wish to copy all parameters, you don't need to include them in the request list at all.

Important note: If you previously had any active modules (such as Heureka, Seznam, GlobalSaleVat) that are no longer active, the resulting data may differ slightly because data requiring an active module will not be copied in this case.

Path
guidstringrequired

Product guid

Example: 93bc0dbe-7481-11e8-8216-002590dad85e
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectnon-emptyrequired
data.​namestring[ 1 .. 250 ] charactersrequired

Product`s name. Maximal length of 250 characters. Mandatory.

data.​isVisibleboolean

Determine whether the copied product will be visible or hidden. This is optional; if not set, the visibility will be inherited from the source product.

data.​copyPropertiesobjectnon-empty

Properties to copy. All properties are optional; if not set, the default value is true.

curl -i -X POST \
  'https://api.myshoptet.com/api/products/{guid}/copy' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "name": "Velká čokoláda",
      "isVisible": true,
      "copyProperties": {
        "generalData": true,
        "images": true,
        "images360": true,
        "pricelist": true,
        "categories": true,
        "properties": true,
        "related": true,
        "advanced": true,
        "stocks": true,
        "globalSaleVat": true,
        "zboziCzSettings": true,
        "heurekaSettings": true,
        "categoryPairing": true
      }
    }
  }'

Responses

Created

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobject(product)required
data.​guidstring(typeGuidUnlimited)<= 36 charactersrequired

unique product indicator

data.​typestringrequired
data.​namestring or null

product name

data.​brandobject(brandNamed)required

product brand (or manufacturer, possibly)

data.​brand.​codestringrequired

unique brand code

data.​brand.​namestringrequired

brand name

data.​supplierobject(supplier)required

product supplier

data.​supplier.​guidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$required

supplier unique ID

data.​supplier.​namestringrequired

supplier name

data.​visibilitystringrequired
data.​creationTimestring or null(typeDateTime)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

date and time of product creation (date in ISO 8601 format)

data.​changeTimestring or null(typeDateTime)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

date and time of last product change (date in ISO 8601 format)

data.​shortDescriptionstring or nullrequired

short product description

data.​descriptionstring or nullrequired

product description. May contain html.

data.​metaDescriptionstring or nullrequired

product label from meta tag.

data.​urlstring or nullrequired

URL of the product in the e-shop

data.​conditionGradestring or null

Grade condition of second-hand product. It contains value only for bazar type, otherwise, it is null.

data.​conditionDescriptionstring or null

Condition description of second-hand product. It contains value only for bazar type, otherwise, it is null.

data.​internalNotestring or nullrequired

product internal note

data.​defaultCategoryobjectrequired

default product category

data.​defaultCategory.​guidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$required

category unique identifier (can be null)

data.​defaultCategory.​namestring or nullrequired

category description

data.​defaultCategory.​visibleboolean or nullrequired

whether the parameter is visible

data.​categoriesArray of objects

information about available product categories

data.​descriptiveParametersArray of objects

product description parameters

data.​additionalNamestring or null

Additional part of product name

data.​xmlFeedNamestring or null

Name of xml feed

data.​metaTitlestring

Meta (seo) title

data.​adultboolean

Flag, whether the product is for adults only

data.​atypicalBillingboolean

DEPRECATED (moved to variant) - Has atypical billing?

data.​atypicalShippingboolean

DEPRECATED (moved to variant) - Has atypical shipping?

data.​allowIPlatbaboolean

Is Cofidis payment allowed?

data.​allowOnlinePaymentsboolean

Are online Payments allowed?

data.​sizeIdNamestring or null

Name for sizeid.com

data.​voteAverageScorestring or null(typeAmount)^(-)?[0-9]+\.[0-9]{3}$

Average score of product reviews

data.​voteCountinteger or null

Count of product reviews

data.​isVariantboolean

define if product has multiple variants.

data.​variantsArray of objectsrequired

information about available product variants. For a product without variants, this field contains just one element with product details.

data.​variants[].​codestringrequired

unique identification of the product variant

data.​variants[].​eanstring or nullrequired

product variant bar code

data.​variants[].​stockstring or null(typeAmount)^(-)?[0-9]+\.[0-9]{3}$required

quantity of goods in stock

data.​variants[].​unitstring or nullrequired

unit of goods quantity

data.​variants[].​weightstring(typeWeight)^[0-9]{1,6}\.[0-9]{3}$required

weight in kg, unpacked (can be null). 3 decimal places. Maximum value 999999.

data.​variants[].​widthstring(typeDimension)^[0-9]{1,4}\.[0-9]{1}$required

width of the product in cm

data.​variants[].​heightstring(typeDimension)^[0-9]{1,4}\.[0-9]{1}$required

height of the product in cm

data.​variants[].​depthstring(typeDimension)^[0-9]{1,4}\.[0-9]{1}$required

depth of the product in cm

data.​variants[].​visiblebooleanrequired

flag, whether the variant is visible

data.​variants[].​pricestring or null(typePrice)^(-)?[0-9]+\.[0-9]{2}$required

price

data.​variants[].​commonPricestring or null(typePrice)^(-)?[0-9]+\.[0-9]{2}$required

standard price

data.​variants[].​manufacturerCodestring or nullrequired

manufacturer code

data.​variants[].​pluCodestring or nullrequired

PLU code

data.​variants[].​isbnstring or nullrequired

ISBN code

data.​variants[].​serialNostring or nullrequired

serial number

data.​variants[].​mpnstring or nullrequired

manufacturer part number

data.​variants[].​includingVatbooleanrequired

flag, whether the price is including VAT

data.​variants[].​vatRatestringrequired

VAT rate in percent

data.​variants[].​currencyCodestringrequired

currency code

data.​variants[].​minStockSupplystring or null(typeAmount)^(-)?[0-9]+\.[0-9]{3}$required

minimum stock supply

data.​variants[].​actionPriceobject(actionPrice)required

special discounted price.

data.​variants[].​actionPrice.​pricestring or null(typePrice)^(-)?[0-9]+\.[0-9]{2}$required

special discounted price. It is only used if set and if the validity date is set too, form (fromDate) to (toData).

data.​variants[].​actionPrice.​fromDatestring or null(typeDate)^[0-9]{4}-[0-9]{2}-[0-9]{2}$required

date from which the special discounted price is valid.

data.​variants[].​actionPrice.​toDatestring or null(typeDate)^[0-9]{4}-[0-9]{2}-[0-9]{2}$required

date to which the special discounted price is valid.

data.​variants[].​imagestring or null

main image of variant (if set, otherwise the product's main image is to be used).

data.​variants[].​isProductDefaultImageboolean

Determines whether the default product image is given (true) or the product variant image (false).

data.​variants[].​namestring or null

name composed of the variant parameters, as seen in the e-shop. For products without variants this is null. Requires include=variantParameters parameter.

data.​variants[].​amountDecimalPlacesintegerrequired

Number of decimal places for amount

data.​variants[].​parametersArray of objects or null
data.​variants[].​measureUnitobject or null

product measure unit

data.​variants[].​availabilityobject(availabilityShort)

product availability

data.​variants[].​availabilityWhenSoldOutobject(availabilityShort)

product availability when not stocked

data.​variants[].​negativeStockAllowedstringrequired

is negative stock buying allowed? Possible values yes-global - yes, set globally, no-global - no, yes - globally no, but per this variant yes.

Enum"yes-global""no-global""yes"
data.​variants[].​recyclingFeeobject(recyclingFeeCategory)

recycling fee including category and fee

data.​variants[].​heurekaCPCstring or null

Heureka cost per click

data.​variants[].​zboziCZobject

Information from zbozi.cz

data.​variants[].​atypicalBillingboolean

Has atypical billing?

data.​variants[].​atypicalShippingboolean

Has atypical shipping?

data.​variants[].​perStockAmountsArray of objects or null

Variant amounts/claims per individual stocks.

data.​variants[].​perPricelistPricesArray of objects or null

Variant prices per individual pricelists.

data.​variants[].​urlstring or null

If product has multiple variants, URL of the variant is provided.

data.​imagesArray of objects

information about images.

data.​flagsArray of objects

product flags

data.​surchargeParametersArray of objects(productSurchargeParameter)

product surcharge parameters

data.​setItemsArray of objects or null

information about items, products, in set

data.​filteringParametersArray of objects

product filtering parameters

data.​warrantyobject or null

product warranty

data.​giftsArray of objects(productGifts)

Gifts related to product

data.​alternativeProductsArray of objects or null(relatedProduct)
data.​relatedProductsArray of objects or null(relatedProduct)
data.​relatedFilesArray of objects

files related to product

data.​relatedVideosArray of objects

Videos related to product

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
    "type": "product",
    "name": "Pelle 1978",
    "brand": { … },
    "supplier": { … },
    "visibility": "normal",
    "creationTime": "2018-05-29T09:02:27+0200",
    "changeTime": "2018-05-29T09:02:27+0200",
    "shortDescription": "A high quality jacket, although its fairly bold design is not to everyone's taste, it has its fans, so you can find it in our offer too. For kids, why not.",
    "description": "<p>As it is often the case with jackets for kids, the emphasis is primarily on durability and quality workmanship. It is clear that it will be put through its paces, which the manufacturer has borne in mind. As previously stated, the manufacturer could also afford a less conservative design for a kids product, combining bold colors with a company logo on the front and back.</p>\n\n<ul>\n\t<li>Body - 60% Nylon, 40% wool</li>\n<li>Inside - 100% Polyester</li>\n</ul>",
    "metaDescription": "Pelle 1978. A high quality jacket, although its fairly bold design is not to everyone's taste .... ",
    "url": "https://www.domena-eshopu.cz/hodinky/citizen-chronograph-eco-drive/",
    "conditionGrade": "used",
    "conditionDescription": "Without original package",
    "internalNote": "This product is not in stock, but it is possible to order it.",
    "defaultCategory": { … },
    "categories": [ … ],
    "descriptiveParameters": [ … ],
    "additionalName": "+ free gift",
    "xmlFeedName": "our-feed.xml",
    "metaTitle": "Nice product title",
    "adult": true,
    "atypicalBilling": true,
    "atypicalShipping": true,
    "allowIPlatba": true,
    "allowOnlinePayments": true,
    "sizeIdName": "adidas - man - shoes (ID 142)",
    "voteAverageScore": "1.000",
    "voteCount": 16,
    "isVariant": true,
    "variants": [ … ],
    "images": [ … ],
    "flags": [ … ],
    "surchargeParameters": [ … ],
    "setItems": [ … ],
    "filteringParameters": [ … ],
    "warranty": { … },
    "gifts": [ … ],
    "alternativeProducts": [ … ],
    "relatedProducts": [ … ],
    "relatedFiles": [ … ],
    "relatedVideos": [ … ]
  },
  "errors": [
    { … }
  ]
}

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

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

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.

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.

perPricelistPrices | The response will also contain prices per individual price lists.

Result file is compressed using GZIP.

Query
includestring

Optional parts of response

Example: include=images,variantParameters,allCategories,flags,descriptiveParameters,measureUnit,surchargeParameters,setItems,filteringParameters,gifts,alternativeProducts,relatedProducts,relatedVideos,relatedFiles,perStockAmounts,perPricelistPrices
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
Example: visibility=visible
typestring
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/vnd.shoptet.v1.0
curl -i -X GET \
  'https://api.myshoptet.com/api/products/snapshot?brandCode=string&brandName=string&categoryGuid=string&changeTimeFrom=string&changeTimeTo=string&creationTimeFrom=string&creationTimeTo=string&defaultCategoryGuid=string&flag=string&include=string&supplierGuid=string&type=string&visibility=string' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobject
errorsArray of objects or null(Errors)
Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "jobId": "ad24xod"
  },
  "errors": [
    { … }
  ]
}

Product detail

Request

Returns detailed information about one product. The product includes the variant field. In case the product comes in variants, the field contains all the available variants. If the product does not have any variants, it contains only one variant with product information.

This endpoint has several sections, which are sent only when requested in the include parameter (see Requested sections).

Include parameter | Meaning

--- | ---

images | The response will also contain the list of all product images. For more information about the chapter Product images.

variantParameters | The response will also contain a field of variant parameters and a variant description, as they are visible to customers.

allCategories | The response will also contain information on all the categories that the product was assigned into

flags | Details on product designation

descriptiveParameters | The response will also contain descriptive parameters of the product

measureUnit | The response will also contain measure unit info of every variant.

surchargeParameters | The response will also contain surcharge parameters of the product.

setItems | The response will also contain items, products, in set.

filteringParameters | The response will also contain filtering parameters of the product.

warranty | The response will also contain product warranty.

sortVariants | Product variants will be sorted as in administration.

gifts | Product gifts, will be sorted as in administration

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.

perPricelistPrices | The response will also contain prices per individual price lists.

Path
guidstringrequired

Product guid

Example: 93bc0dbe-7481-11e8-8216-002590dad85e
Query
includestring

Optional parts of response

Example: include=images,variantParameters,allCategories,flags,descriptiveParameters,measureUnit,surchargeParameters,setItems,filteringParameters,recyclingFee,warranty,gifts,alternativeProducts,relatedProducts,relatedVideos,relatedFiles,perStockAmounts,perPricelistPrices
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  'https://api.myshoptet.com/api/products/{guid}?include=string' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobject(product)
errorsArray of objects or null(Errors)
Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
    "type": "product",
    "name": "Pelle 1978",
    "brand": { … },
    "supplier": { … },
    "visibility": "normal",
    "creationTime": "2018-05-29T09:02:27+0200",
    "changeTime": "2018-05-29T09:02:27+0200",
    "shortDescription": "A high quality jacket, although its fairly bold design is not to everyone's taste, it has its fans, so you can find it in our offer too. For kids, why not.",
    "description": "<p>As it is often the case with jackets for kids, the emphasis is primarily on durability and quality workmanship. It is clear that it will be put through its paces, which the manufacturer has borne in mind. As previously stated, the manufacturer could also afford a less conservative design for a kids product, combining bold colors with a company logo on the front and back.</p>\n\n<ul>\n\t<li>Body - 60% Nylon, 40% wool</li>\n<li>Inside - 100% Polyester</li>\n</ul>",
    "metaDescription": "Pelle 1978. A high quality jacket, although its fairly bold design is not to everyone's taste .... ",
    "url": "https://www.domena-eshopu.cz/hodinky/citizen-chronograph-eco-drive/",
    "conditionGrade": "used",
    "conditionDescription": "Without original package",
    "internalNote": "This product is not in stock, but it is possible to order it.",
    "defaultCategory": { … },
    "categories": [ … ],
    "descriptiveParameters": [ … ],
    "additionalName": "+ free gift",
    "xmlFeedName": "our-feed.xml",
    "metaTitle": "Nice product title",
    "adult": true,
    "atypicalBilling": true,
    "atypicalShipping": true,
    "allowIPlatba": true,
    "allowOnlinePayments": true,
    "sizeIdName": "adidas - man - shoes (ID 142)",
    "voteAverageScore": "1.000",
    "voteCount": 16,
    "isVariant": true,
    "variants": [ … ],
    "images": [ … ],
    "flags": [ … ],
    "surchargeParameters": [ … ],
    "setItems": [ … ],
    "filteringParameters": [ … ],
    "warranty": { … },
    "gifts": [ … ],
    "alternativeProducts": [ … ],
    "relatedProducts": [ … ],
    "relatedFiles": [ … ],
    "relatedVideos": [ … ]
  },
  "errors": [
    { … }
  ]
}

Product update

Request

Allows you to change a product, which is identified by the guid.

This endpoint allows you to update products in Shoptet.

Request is sent in JSON format in its body. For detailed description of items, which can be updated and their format,

check the right-most pane, section "Request" » "Attributes"

Product variant can be updated by specifying its code. When code is not specified or not existing, new variant will be created.

If you want to change code of variant, use code to specify variant to be changed and newCode for specifying new code.

Field parameters should contain ALL parameters that the edited variant should contain.

That means, if you have for example "color:black" in variant and you specify only new parameter "size", parameter color will be deleted.

Path
guidstringrequired

Product guid

Example: bffa3b98-d968-11e0-b04f-57a43310b768
Query
includestring

Optional parts of response

Example: include=images,variantParameters,allCategories,flags,descriptiveParameters,measureUnit,surchargeParameters,setItems,filteringParameters
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectnon-emptyrequired
data.​guidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Product GUID. Must be unique if set.

data.​typestring

Product type. Please note that 'product-set' requires 'sets' module to be enabled. Enum - see Product type code list

Enum"product""bazar""service""product-set"
data.​visibilitystring
Enum"hidden""visible""blocked""show-registered""block-unregistered""cash-desk-only""detail-only"
data.​namestring[ 1 .. 250 ] characters

Product's name. Mandatory. Maximal length of 250 characters.

data.​adultboolean or null

Whether the product is for adults only. Optional, default value false.

data.​shortDescriptionstring or null

Product's short description.

data.​descriptionstring or null

Product's full description.

data.​metaTitlestring or null[ 1 .. 255 ] characters

Product's seo title. Maximal length of 255 characters.

data.​metaDescriptionstring or null

Product's full description.

data.​conditionGradestring or nullnon-empty

Grade condition of second-hand product. Allowed only for bazar type.

data.​conditionDescriptionstring or nullnon-empty

Condition description of second-hand product. Allowed only for bazar type.

data.​defaultCategoryGuidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Product's default category's GUID. Mandatory.

data.​brandCodestring or nullnon-empty

Product's brand. Must exist if set.

data.​internalNotestring or nullnon-empty

Product internal note.

data.​supplierGuidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Supplier GUID. Must exist if set.

data.​categoryGuidsArray of strings(typeGuid)non-empty
data.​warrantyIdinteger or null

Warranty ID.

data.​flagsArray of objects or null

Must exist if set.

data.​descriptiveParametersArray of objects

Product descriptive parameters.

data.​filteringParametersArray of objects or null
data.​surchargeParametersArray of objects(productRequestSurchargeParameter)

Product surcharge parameters. Not allowed for products with multiple tax classes.

data.​variantsArray of objectsnon-empty
data.​indexNamestringnon-empty

String which defines product url. Value is sanitized to fits url needs. If value is not present, indexName is created from product name.

data.​relatedVideosArray of objects

Product related videos.

curl -i -X PATCH \
  'https://api.myshoptet.com/api/products/{guid}?include=string' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
      "type": "product",
      "visibility": "hidden",
      "name": "Velká čokoláda",
      "adult": true,
      "shortDescription": "Velice kvalitní a dobrá čokoláda.",
      "description": "<p>Velice kvalitní a dobrá čokoláda. Chutná vždy dobře. <b>Neobsahuje arašídy.</b></p>",
      "metaTitle": "Velice kvalitní a dobrá čokoláda.",
      "metaDescription": "Velice kvalitní a dobrá čokoláda. Chutná vždy dobře. Neobsahuje arašídy.",
      "conditionGrade": "used",
      "conditionDescription": "Without original package.",
      "defaultCategoryGuid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
      "brandCode": "milka",
      "internalNote": "Internal note for product manager.",
      "supplierGuid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
      "categoryGuids": [
        "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"
      ],
      "warrantyId": 1,
      "flags": [
        {
          "code": "new",
          "dateFrom": "2017-04-04",
          "dateTo": "2017-04-04"
        }
      ],
      "descriptiveParameters": [
        {
          "name": "Material",
          "value": "Cotton",
          "description": "Material the shirt is made of",
          "priority": 1
        }
      ],
      "filteringParameters": [
        {
          "code": "action",
          "values": []
        }
      ],
      "surchargeParameters": [
        {
          "code": "pp-1",
          "values": [
            {
              "valueIndex": "hodnota-01",
              "price": "21.00",
              "visible": true
            }
          ]
        }
      ],
      "variants": [
        {
          "code": "0035",
          "newCode": "0036",
          "ean": "8594001234567",
          "unitId": -1,
          "weight": "15.500",
          "width": "10.0",
          "height": "10.0",
          "depth": "10.0",
          "visible": true,
          "manufacturerCode": "OKI",
          "pluCode": "0828",
          "isbn": "978-80-251-0000-0",
          "serialNo": "B412",
          "mpn": "H3T5-87",
          "availabilityId": -1,
          "availabilityWhenSoldOutId": -3,
          "image": "106.jpg",
          "parameters": [
            {
              "nameIndex": "color",
              "valueIndex": "red"
            }
          ],
          "minStockSupply": "1.000",
          "stocksLocations": [
            {
              "stockId": 1,
              "location": "H6/M11/R13"
            }
          ],
          "negativeStockAllowed": true,
          "measureUnit": {
            "packagingUnitId": 22,
            "packagingAmount": "1.000",
            "measureUnitId": 1,
            "measureAmount": "1.000"
          },
          "recyclingFeeId": 123,
          "amountDecimalPlaces": 2,
          "atypicalBilling": true,
          "atypicalShipping": true
        }
      ],
      "indexName": "baleriny-modre-s-puntiky",
      "relatedVideos": [
        {
          "code": "zpvmPA3me7o",
          "title": "Test video",
          "type": "youtube"
        }
      ]
    }
  }'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobject(product)required
data.​guidstring(typeGuidUnlimited)<= 36 charactersrequired

unique product indicator

data.​typestringrequired
data.​namestring or null

product name

data.​brandobject(brandNamed)required

product brand (or manufacturer, possibly)

data.​brand.​codestringrequired

unique brand code

data.​brand.​namestringrequired

brand name

data.​supplierobject(supplier)required

product supplier

data.​supplier.​guidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$required

supplier unique ID

data.​supplier.​namestringrequired

supplier name

data.​visibilitystringrequired
data.​creationTimestring or null(typeDateTime)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

date and time of product creation (date in ISO 8601 format)

data.​changeTimestring or null(typeDateTime)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

date and time of last product change (date in ISO 8601 format)

data.​shortDescriptionstring or nullrequired

short product description

data.​descriptionstring or nullrequired

product description. May contain html.

data.​metaDescriptionstring or nullrequired

product label from meta tag.

data.​urlstring or nullrequired

URL of the product in the e-shop

data.​conditionGradestring or null

Grade condition of second-hand product. It contains value only for bazar type, otherwise, it is null.

data.​conditionDescriptionstring or null

Condition description of second-hand product. It contains value only for bazar type, otherwise, it is null.

data.​internalNotestring or nullrequired

product internal note

data.​defaultCategoryobjectrequired

default product category

data.​defaultCategory.​guidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$required

category unique identifier (can be null)

data.​defaultCategory.​namestring or nullrequired

category description

data.​defaultCategory.​visibleboolean or nullrequired

whether the parameter is visible

data.​categoriesArray of objects

information about available product categories

data.​descriptiveParametersArray of objects

product description parameters

data.​additionalNamestring or null

Additional part of product name

data.​xmlFeedNamestring or null

Name of xml feed

data.​metaTitlestring

Meta (seo) title

data.​adultboolean

Flag, whether the product is for adults only

data.​atypicalBillingboolean

DEPRECATED (moved to variant) - Has atypical billing?

data.​atypicalShippingboolean

DEPRECATED (moved to variant) - Has atypical shipping?

data.​allowIPlatbaboolean

Is Cofidis payment allowed?

data.​allowOnlinePaymentsboolean

Are online Payments allowed?

data.​sizeIdNamestring or null

Name for sizeid.com

data.​voteAverageScorestring or null(typeAmount)^(-)?[0-9]+\.[0-9]{3}$

Average score of product reviews

data.​voteCountinteger or null

Count of product reviews

data.​isVariantboolean

define if product has multiple variants.

data.​variantsArray of objectsrequired

information about available product variants. For a product without variants, this field contains just one element with product details.

data.​variants[].​codestringrequired

unique identification of the product variant

data.​variants[].​eanstring or nullrequired

product variant bar code

data.​variants[].​stockstring or null(typeAmount)^(-)?[0-9]+\.[0-9]{3}$required

quantity of goods in stock

data.​variants[].​unitstring or nullrequired

unit of goods quantity

data.​variants[].​weightstring(typeWeight)^[0-9]{1,6}\.[0-9]{3}$required

weight in kg, unpacked (can be null). 3 decimal places. Maximum value 999999.

data.​variants[].​widthstring(typeDimension)^[0-9]{1,4}\.[0-9]{1}$required

width of the product in cm

data.​variants[].​heightstring(typeDimension)^[0-9]{1,4}\.[0-9]{1}$required

height of the product in cm

data.​variants[].​depthstring(typeDimension)^[0-9]{1,4}\.[0-9]{1}$required

depth of the product in cm

data.​variants[].​visiblebooleanrequired

flag, whether the variant is visible

data.​variants[].​pricestring or null(typePrice)^(-)?[0-9]+\.[0-9]{2}$required

price

data.​variants[].​commonPricestring or null(typePrice)^(-)?[0-9]+\.[0-9]{2}$required

standard price

data.​variants[].​manufacturerCodestring or nullrequired

manufacturer code

data.​variants[].​pluCodestring or nullrequired

PLU code

data.​variants[].​isbnstring or nullrequired

ISBN code

data.​variants[].​serialNostring or nullrequired

serial number

data.​variants[].​mpnstring or nullrequired

manufacturer part number

data.​variants[].​includingVatbooleanrequired

flag, whether the price is including VAT

data.​variants[].​vatRatestringrequired

VAT rate in percent

data.​variants[].​currencyCodestringrequired

currency code

data.​variants[].​minStockSupplystring or null(typeAmount)^(-)?[0-9]+\.[0-9]{3}$required

minimum stock supply

data.​variants[].​actionPriceobject(actionPrice)required

special discounted price.

data.​variants[].​actionPrice.​pricestring or null(typePrice)^(-)?[0-9]+\.[0-9]{2}$required

special discounted price. It is only used if set and if the validity date is set too, form (fromDate) to (toData).

data.​variants[].​actionPrice.​fromDatestring or null(typeDate)^[0-9]{4}-[0-9]{2}-[0-9]{2}$required

date from which the special discounted price is valid.

data.​variants[].​actionPrice.​toDatestring or null(typeDate)^[0-9]{4}-[0-9]{2}-[0-9]{2}$required

date to which the special discounted price is valid.

data.​variants[].​imagestring or null

main image of variant (if set, otherwise the product's main image is to be used).

data.​variants[].​isProductDefaultImageboolean

Determines whether the default product image is given (true) or the product variant image (false).

data.​variants[].​namestring or null

name composed of the variant parameters, as seen in the e-shop. For products without variants this is null. Requires include=variantParameters parameter.

data.​variants[].​amountDecimalPlacesintegerrequired

Number of decimal places for amount

data.​variants[].​parametersArray of objects or null
data.​variants[].​measureUnitobject or null

product measure unit

data.​variants[].​availabilityobject(availabilityShort)

product availability

data.​variants[].​availabilityWhenSoldOutobject(availabilityShort)

product availability when not stocked

data.​variants[].​negativeStockAllowedstringrequired

is negative stock buying allowed? Possible values yes-global - yes, set globally, no-global - no, yes - globally no, but per this variant yes.

Enum"yes-global""no-global""yes"
data.​variants[].​recyclingFeeobject(recyclingFeeCategory)

recycling fee including category and fee

data.​variants[].​heurekaCPCstring or null

Heureka cost per click

data.​variants[].​zboziCZobject

Information from zbozi.cz

data.​variants[].​atypicalBillingboolean

Has atypical billing?

data.​variants[].​atypicalShippingboolean

Has atypical shipping?

data.​variants[].​perStockAmountsArray of objects or null

Variant amounts/claims per individual stocks.

data.​variants[].​perPricelistPricesArray of objects or null

Variant prices per individual pricelists.

data.​variants[].​urlstring or null

If product has multiple variants, URL of the variant is provided.

data.​imagesArray of objects

information about images.

data.​flagsArray of objects

product flags

data.​surchargeParametersArray of objects(productSurchargeParameter)

product surcharge parameters

data.​setItemsArray of objects or null

information about items, products, in set

data.​filteringParametersArray of objects

product filtering parameters

data.​warrantyobject or null

product warranty

data.​giftsArray of objects(productGifts)

Gifts related to product

data.​alternativeProductsArray of objects or null(relatedProduct)
data.​relatedProductsArray of objects or null(relatedProduct)
data.​relatedFilesArray of objects

files related to product

data.​relatedVideosArray of objects

Videos related to product

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
    "type": "product",
    "name": "Pelle 1978",
    "brand": { … },
    "supplier": { … },
    "visibility": "normal",
    "creationTime": "2018-05-29T09:02:27+0200",
    "changeTime": "2018-05-29T09:02:27+0200",
    "shortDescription": "A high quality jacket, although its fairly bold design is not to everyone's taste, it has its fans, so you can find it in our offer too. For kids, why not.",
    "description": "<p>As it is often the case with jackets for kids, the emphasis is primarily on durability and quality workmanship. It is clear that it will be put through its paces, which the manufacturer has borne in mind. As previously stated, the manufacturer could also afford a less conservative design for a kids product, combining bold colors with a company logo on the front and back.</p>\n\n<ul>\n\t<li>Body - 60% Nylon, 40% wool</li>\n<li>Inside - 100% Polyester</li>\n</ul>",
    "metaDescription": "Pelle 1978. A high quality jacket, although its fairly bold design is not to everyone's taste .... ",
    "url": "https://www.domena-eshopu.cz/hodinky/citizen-chronograph-eco-drive/",
    "conditionGrade": "used",
    "conditionDescription": "Without original package",
    "internalNote": "This product is not in stock, but it is possible to order it.",
    "defaultCategory": { … },
    "categories": [ … ],
    "descriptiveParameters": [ … ],
    "additionalName": "+ free gift",
    "xmlFeedName": "our-feed.xml",
    "metaTitle": "Nice product title",
    "adult": true,
    "atypicalBilling": true,
    "atypicalShipping": true,
    "allowIPlatba": true,
    "allowOnlinePayments": true,
    "sizeIdName": "adidas - man - shoes (ID 142)",
    "voteAverageScore": "1.000",
    "voteCount": 16,
    "isVariant": true,
    "variants": [ … ],
    "images": [ … ],
    "flags": [ … ],
    "surchargeParameters": [ … ],
    "setItems": [ … ],
    "filteringParameters": [ … ],
    "warranty": { … },
    "gifts": [ … ],
    "alternativeProducts": [ … ],
    "relatedProducts": [ … ],
    "relatedFiles": [ … ],
    "relatedVideos": [ … ]
  },
  "errors": [
    { … }
  ]
}

Product deletion

Request

Deletes product as per entered guid. If successful, returns the code 200.

If the product does not exist within the e-shop, a 404 code is returned.

If the product cannot be deleted, because it is part of set or used as a gift to some product, a 409 code is returned.

Path
guidstringrequired

Product guid

Example: 93bc0dbe-7481-11e8-8216-002590dad85e
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X DELETE \
  'https://api.myshoptet.com/api/products/{guid}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
datanullrequired
errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": null,
  "errors": [
    { … }
  ]
}

Product BATCH update

Request

This endpoint allows you to update multiple products at once. Batch update is processed asynchronously in same way as for example products snapshot,

but it does not have resultUrl with products to download in response. Instead, you can check attribute log which contains successfully updated products and errors.

See how Asynchronous requests work on our developer's portal.

File with data for update must be in JSONL (jsonlines) format. Each line must contain one product in JSON format. Maximum size of file is 100MB.

Structure of JSON row is same as structure of JSON for single product update above. You can add one extra optional attribute

"language" which defines language of updating product, so you are able to update multiple language attributes (i.e. "name", "description" etc.) of one product in one batch file.

If language is not defined, default language of shop is used.

Asynchronous job process jsonl file row by row and try to validate and save data. If there is any error, row is skipped and error is logged, but it does not stop processing of other rows.

In Log, every product is identified by its position in file (starting from 1).

Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
batchFileUrlPathstringrequired

Url to batch file with products data. File must be in JSONL format.

curl -i -X PATCH \
  https://api.myshoptet.com/api/products/batch \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "batchFileUrlPath": "https://cdn.myshoptet.com/batch-products-update.jsonl"
  }'

Responses

Accepted

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​jobIdstringrequired

token of job

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "jobId": "ad24xod"
  },
  "errors": [
    { … }
  ]
}

Product detail by code

Request

Retrieve details about one product. Optional sections can be requested using ?include= parameter The response format is the same as for Product detail endpoint.

Path
codestringrequired

product or variant code.

Example: 133
Query
includestring

Optional parts of response

Example: include=images,variantParameters,allCategories,flags,descriptiveParameters,measureUnit,surchargeParameters,setItems,filteringParameters,perStockAmounts,sortVariants,perPricelistPrices
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  'https://api.myshoptet.com/api/products/code/{code}?include=string' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobject(product)
errorsArray of objects or null(Errors)
Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
    "type": "product",
    "name": "Pelle 1978",
    "brand": { … },
    "supplier": { … },
    "visibility": "normal",
    "creationTime": "2018-05-29T09:02:27+0200",
    "changeTime": "2018-05-29T09:02:27+0200",
    "shortDescription": "A high quality jacket, although its fairly bold design is not to everyone's taste, it has its fans, so you can find it in our offer too. For kids, why not.",
    "description": "<p>As it is often the case with jackets for kids, the emphasis is primarily on durability and quality workmanship. It is clear that it will be put through its paces, which the manufacturer has borne in mind. As previously stated, the manufacturer could also afford a less conservative design for a kids product, combining bold colors with a company logo on the front and back.</p>\n\n<ul>\n\t<li>Body - 60% Nylon, 40% wool</li>\n<li>Inside - 100% Polyester</li>\n</ul>",
    "metaDescription": "Pelle 1978. A high quality jacket, although its fairly bold design is not to everyone's taste .... ",
    "url": "https://www.domena-eshopu.cz/hodinky/citizen-chronograph-eco-drive/",
    "conditionGrade": "used",
    "conditionDescription": "Without original package",
    "internalNote": "This product is not in stock, but it is possible to order it.",
    "defaultCategory": { … },
    "categories": [ … ],
    "descriptiveParameters": [ … ],
    "additionalName": "+ free gift",
    "xmlFeedName": "our-feed.xml",
    "metaTitle": "Nice product title",
    "adult": true,
    "atypicalBilling": true,
    "atypicalShipping": true,
    "allowIPlatba": true,
    "allowOnlinePayments": true,
    "sizeIdName": "adidas - man - shoes (ID 142)",
    "voteAverageScore": "1.000",
    "voteCount": 16,
    "isVariant": true,
    "variants": [ … ],
    "images": [ … ],
    "flags": [ … ],
    "surchargeParameters": [ … ],
    "setItems": [ … ],
    "filteringParameters": [ … ],
    "warranty": { … },
    "gifts": [ … ],
    "alternativeProducts": [ … ],
    "relatedProducts": [ … ],
    "relatedFiles": [ … ],
    "relatedVideos": [ … ]
  },
  "errors": [
    { … }
  ]
}

Product update by code

Request

This endpoint allows you to update products identified by a product code in Shoptet.

Request is sent in JSON format in its body. For detailed description of items, which can be updated and their format,

check the right-most pane, section "Request" » "Attributes".

Product variant can be updated by specifying its code. When code is not specified or not existing, new variant will be created.

If you want to change code of variant, use code to specify variant to be changed and newCode for specifying new code.

Field parameters should contain ALL parameters that the edited variant should contain.

That means, if you have for example "color:black" in variant and you specify only new parameter "velikost", parameter color will be deleted.

Please note that any product's variant can be edited by this endpoint, not only the one in url

Path
codestringrequired

Product or variant code

Example: 00351
Query
includestring

Optional parts of response

Example: include=images,variantParameters,allCategories,flags,descriptiveParameters,measureUnit,surchargeParameters,setItems,filteringParameters,perStockAmounts
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectnon-emptyrequired
data.​guidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Product GUID. Must be unique if set.

data.​typestring

Product type. Please note that 'product-set' requires 'sets' module to be enabled. Enum - see Product type code list

Enum"product""bazar""service""product-set"
data.​visibilitystring
Enum"hidden""visible""blocked""show-registered""block-unregistered""cash-desk-only""detail-only"
data.​namestring[ 1 .. 250 ] characters

Product's name. Mandatory. Maximal length of 250 characters.

data.​adultboolean or null

Whether the product is for adults only. Optional, default value false.

data.​shortDescriptionstring or null

Product's short description.

data.​descriptionstring or null

Product's full description.

data.​metaTitlestring or null[ 1 .. 255 ] characters

Product's seo title. Maximal length of 255 characters.

data.​metaDescriptionstring or null

Product's full description.

data.​conditionGradestring or nullnon-empty

Grade condition of second-hand product. Allowed only for bazar type.

data.​conditionDescriptionstring or nullnon-empty

Condition description of second-hand product. Allowed only for bazar type.

data.​defaultCategoryGuidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Product's default category's GUID. Mandatory.

data.​brandCodestring or nullnon-empty

Product's brand. Must exist if set.

data.​internalNotestring or nullnon-empty

Product internal note.

data.​supplierGuidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Supplier GUID. Must exist if set.

data.​categoryGuidsArray of strings(typeGuid)non-empty
data.​warrantyIdinteger or null

Warranty ID.

data.​flagsArray of objects or null

Must exist if set.

data.​descriptiveParametersArray of objects

Product descriptive parameters.

data.​filteringParametersArray of objects or null
data.​surchargeParametersArray of objects(productRequestSurchargeParameter)

Product surcharge parameters. Not allowed for products with multiple tax classes.

data.​variantsArray of objectsnon-empty
data.​indexNamestringnon-empty

String which defines product url. Value is sanitized to fits url needs. If value is not present, indexName is created from product name.

data.​relatedVideosArray of objects

Product related videos.

curl -i -X PATCH \
  'https://api.myshoptet.com/api/products/code/{code}?include=string' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
      "type": "product",
      "visibility": "hidden",
      "name": "Velká čokoláda",
      "adult": true,
      "shortDescription": "Velice kvalitní a dobrá čokoláda.",
      "description": "<p>Velice kvalitní a dobrá čokoláda. Chutná vždy dobře. <b>Neobsahuje arašídy.</b></p>",
      "metaTitle": "Velice kvalitní a dobrá čokoláda.",
      "metaDescription": "Velice kvalitní a dobrá čokoláda. Chutná vždy dobře. Neobsahuje arašídy.",
      "conditionGrade": "used",
      "conditionDescription": "Without original package.",
      "defaultCategoryGuid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
      "brandCode": "milka",
      "internalNote": "Internal note for product manager.",
      "supplierGuid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
      "categoryGuids": [
        "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"
      ],
      "warrantyId": 1,
      "flags": [
        {
          "code": "new",
          "dateFrom": "2017-04-04",
          "dateTo": "2017-04-04"
        }
      ],
      "descriptiveParameters": [
        {
          "name": "Material",
          "value": "Cotton",
          "description": "Material the shirt is made of",
          "priority": 1
        }
      ],
      "filteringParameters": [
        {
          "code": "action",
          "values": []
        }
      ],
      "surchargeParameters": [
        {
          "code": "pp-1",
          "values": [
            {
              "valueIndex": "hodnota-01",
              "price": "21.00",
              "visible": true
            }
          ]
        }
      ],
      "variants": [
        {
          "code": "0035",
          "newCode": "0036",
          "ean": "8594001234567",
          "unitId": -1,
          "weight": "15.500",
          "width": "10.0",
          "height": "10.0",
          "depth": "10.0",
          "visible": true,
          "manufacturerCode": "OKI",
          "pluCode": "0828",
          "isbn": "978-80-251-0000-0",
          "serialNo": "B412",
          "mpn": "H3T5-87",
          "availabilityId": -1,
          "availabilityWhenSoldOutId": -3,
          "image": "106.jpg",
          "parameters": [
            {
              "nameIndex": "color",
              "valueIndex": "red"
            }
          ],
          "minStockSupply": "1.000",
          "stocksLocations": [
            {
              "stockId": 1,
              "location": "H6/M11/R13"
            }
          ],
          "negativeStockAllowed": true,
          "measureUnit": {
            "packagingUnitId": 22,
            "packagingAmount": "1.000",
            "measureUnitId": 1,
            "measureAmount": "1.000"
          },
          "recyclingFeeId": 123,
          "amountDecimalPlaces": 2,
          "atypicalBilling": true,
          "atypicalShipping": true
        }
      ],
      "indexName": "baleriny-modre-s-puntiky",
      "relatedVideos": [
        {
          "code": "zpvmPA3me7o",
          "title": "Test video",
          "type": "youtube"
        }
      ]
    }
  }'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobject(product)required
data.​guidstring(typeGuidUnlimited)<= 36 charactersrequired

unique product indicator

data.​typestringrequired
data.​namestring or null

product name

data.​brandobject(brandNamed)required

product brand (or manufacturer, possibly)

data.​brand.​codestringrequired

unique brand code

data.​brand.​namestringrequired

brand name

data.​supplierobject(supplier)required

product supplier

data.​supplier.​guidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$required

supplier unique ID

data.​supplier.​namestringrequired

supplier name

data.​visibilitystringrequired
data.​creationTimestring or null(typeDateTime)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

date and time of product creation (date in ISO 8601 format)

data.​changeTimestring or null(typeDateTime)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

date and time of last product change (date in ISO 8601 format)

data.​shortDescriptionstring or nullrequired

short product description

data.​descriptionstring or nullrequired

product description. May contain html.

data.​metaDescriptionstring or nullrequired

product label from meta tag.

data.​urlstring or nullrequired

URL of the product in the e-shop

data.​conditionGradestring or null

Grade condition of second-hand product. It contains value only for bazar type, otherwise, it is null.

data.​conditionDescriptionstring or null

Condition description of second-hand product. It contains value only for bazar type, otherwise, it is null.

data.​internalNotestring or nullrequired

product internal note

data.​defaultCategoryobjectrequired

default product category

data.​defaultCategory.​guidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$required

category unique identifier (can be null)

data.​defaultCategory.​namestring or nullrequired

category description

data.​defaultCategory.​visibleboolean or nullrequired

whether the parameter is visible

data.​categoriesArray of objects

information about available product categories

data.​descriptiveParametersArray of objects

product description parameters

data.​additionalNamestring or null

Additional part of product name

data.​xmlFeedNamestring or null

Name of xml feed

data.​metaTitlestring

Meta (seo) title

data.​adultboolean

Flag, whether the product is for adults only

data.​atypicalBillingboolean

DEPRECATED (moved to variant) - Has atypical billing?

data.​atypicalShippingboolean

DEPRECATED (moved to variant) - Has atypical shipping?

data.​allowIPlatbaboolean

Is Cofidis payment allowed?

data.​allowOnlinePaymentsboolean

Are online Payments allowed?

data.​sizeIdNamestring or null

Name for sizeid.com

data.​voteAverageScorestring or null(typeAmount)^(-)?[0-9]+\.[0-9]{3}$

Average score of product reviews

data.​voteCountinteger or null

Count of product reviews

data.​isVariantboolean

define if product has multiple variants.

data.​variantsArray of objectsrequired

information about available product variants. For a product without variants, this field contains just one element with product details.

data.​variants[].​codestringrequired

unique identification of the product variant

data.​variants[].​eanstring or nullrequired

product variant bar code

data.​variants[].​stockstring or null(typeAmount)^(-)?[0-9]+\.[0-9]{3}$required

quantity of goods in stock

data.​variants[].​unitstring or nullrequired

unit of goods quantity

data.​variants[].​weightstring(typeWeight)^[0-9]{1,6}\.[0-9]{3}$required

weight in kg, unpacked (can be null). 3 decimal places. Maximum value 999999.

data.​variants[].​widthstring(typeDimension)^[0-9]{1,4}\.[0-9]{1}$required

width of the product in cm

data.​variants[].​heightstring(typeDimension)^[0-9]{1,4}\.[0-9]{1}$required

height of the product in cm

data.​variants[].​depthstring(typeDimension)^[0-9]{1,4}\.[0-9]{1}$required

depth of the product in cm

data.​variants[].​visiblebooleanrequired

flag, whether the variant is visible

data.​variants[].​pricestring or null(typePrice)^(-)?[0-9]+\.[0-9]{2}$required

price

data.​variants[].​commonPricestring or null(typePrice)^(-)?[0-9]+\.[0-9]{2}$required

standard price

data.​variants[].​manufacturerCodestring or nullrequired

manufacturer code

data.​variants[].​pluCodestring or nullrequired

PLU code

data.​variants[].​isbnstring or nullrequired

ISBN code

data.​variants[].​serialNostring or nullrequired

serial number

data.​variants[].​mpnstring or nullrequired

manufacturer part number

data.​variants[].​includingVatbooleanrequired

flag, whether the price is including VAT

data.​variants[].​vatRatestringrequired

VAT rate in percent

data.​variants[].​currencyCodestringrequired

currency code

data.​variants[].​minStockSupplystring or null(typeAmount)^(-)?[0-9]+\.[0-9]{3}$required

minimum stock supply

data.​variants[].​actionPriceobject(actionPrice)required

special discounted price.

data.​variants[].​actionPrice.​pricestring or null(typePrice)^(-)?[0-9]+\.[0-9]{2}$required

special discounted price. It is only used if set and if the validity date is set too, form (fromDate) to (toData).

data.​variants[].​actionPrice.​fromDatestring or null(typeDate)^[0-9]{4}-[0-9]{2}-[0-9]{2}$required

date from which the special discounted price is valid.

data.​variants[].​actionPrice.​toDatestring or null(typeDate)^[0-9]{4}-[0-9]{2}-[0-9]{2}$required

date to which the special discounted price is valid.

data.​variants[].​imagestring or null

main image of variant (if set, otherwise the product's main image is to be used).

data.​variants[].​isProductDefaultImageboolean

Determines whether the default product image is given (true) or the product variant image (false).

data.​variants[].​namestring or null

name composed of the variant parameters, as seen in the e-shop. For products without variants this is null. Requires include=variantParameters parameter.

data.​variants[].​amountDecimalPlacesintegerrequired

Number of decimal places for amount

data.​variants[].​parametersArray of objects or null
data.​variants[].​measureUnitobject or null

product measure unit

data.​variants[].​availabilityobject(availabilityShort)

product availability

data.​variants[].​availabilityWhenSoldOutobject(availabilityShort)

product availability when not stocked

data.​variants[].​negativeStockAllowedstringrequired

is negative stock buying allowed? Possible values yes-global - yes, set globally, no-global - no, yes - globally no, but per this variant yes.

Enum"yes-global""no-global""yes"
data.​variants[].​recyclingFeeobject(recyclingFeeCategory)

recycling fee including category and fee

data.​variants[].​heurekaCPCstring or null

Heureka cost per click

data.​variants[].​zboziCZobject

Information from zbozi.cz

data.​variants[].​atypicalBillingboolean

Has atypical billing?

data.​variants[].​atypicalShippingboolean

Has atypical shipping?

data.​variants[].​perStockAmountsArray of objects or null

Variant amounts/claims per individual stocks.

data.​variants[].​perPricelistPricesArray of objects or null

Variant prices per individual pricelists.

data.​variants[].​urlstring or null

If product has multiple variants, URL of the variant is provided.

data.​imagesArray of objects

information about images.

data.​flagsArray of objects

product flags

data.​surchargeParametersArray of objects(productSurchargeParameter)

product surcharge parameters

data.​setItemsArray of objects or null

information about items, products, in set

data.​filteringParametersArray of objects

product filtering parameters

data.​warrantyobject or null

product warranty

data.​giftsArray of objects(productGifts)

Gifts related to product

data.​alternativeProductsArray of objects or null(relatedProduct)
data.​relatedProductsArray of objects or null(relatedProduct)
data.​relatedFilesArray of objects

files related to product

data.​relatedVideosArray of objects

Videos related to product

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
    "type": "product",
    "name": "Pelle 1978",
    "brand": { … },
    "supplier": { … },
    "visibility": "normal",
    "creationTime": "2018-05-29T09:02:27+0200",
    "changeTime": "2018-05-29T09:02:27+0200",
    "shortDescription": "A high quality jacket, although its fairly bold design is not to everyone's taste, it has its fans, so you can find it in our offer too. For kids, why not.",
    "description": "<p>As it is often the case with jackets for kids, the emphasis is primarily on durability and quality workmanship. It is clear that it will be put through its paces, which the manufacturer has borne in mind. As previously stated, the manufacturer could also afford a less conservative design for a kids product, combining bold colors with a company logo on the front and back.</p>\n\n<ul>\n\t<li>Body - 60% Nylon, 40% wool</li>\n<li>Inside - 100% Polyester</li>\n</ul>",
    "metaDescription": "Pelle 1978. A high quality jacket, although its fairly bold design is not to everyone's taste .... ",
    "url": "https://www.domena-eshopu.cz/hodinky/citizen-chronograph-eco-drive/",
    "conditionGrade": "used",
    "conditionDescription": "Without original package",
    "internalNote": "This product is not in stock, but it is possible to order it.",
    "defaultCategory": { … },
    "categories": [ … ],
    "descriptiveParameters": [ … ],
    "additionalName": "+ free gift",
    "xmlFeedName": "our-feed.xml",
    "metaTitle": "Nice product title",
    "adult": true,
    "atypicalBilling": true,
    "atypicalShipping": true,
    "allowIPlatba": true,
    "allowOnlinePayments": true,
    "sizeIdName": "adidas - man - shoes (ID 142)",
    "voteAverageScore": "1.000",
    "voteCount": 16,
    "isVariant": true,
    "variants": [ … ],
    "images": [ … ],
    "flags": [ … ],
    "surchargeParameters": [ … ],
    "setItems": [ … ],
    "filteringParameters": [ … ],
    "warranty": { … },
    "gifts": [ … ],
    "alternativeProducts": [ … ],
    "relatedProducts": [ … ],
    "relatedFiles": [ … ],
    "relatedVideos": [ … ]
  },
  "errors": [
    { … }
  ]
}

Product variant deletion

Request

Deletes product variant as per entered code. If this is the last product variant, the entire product is deleted.

If successful, returns the code 200.

If the product variant does not exist within the e-shop, a 404 code is returned.

If the product variant cannot be deleted, because it is part of set or used as a gift to some product, a 409 code is returned.

Path
codestringrequired

product variant code.

Example: 112
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X DELETE \
  'https://api.myshoptet.com/api/products/code/{code}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
datanullrequired
errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": null,
  "errors": [
    { … }
  ]
}

List of product images

Request

Returns list of product's images.

Data from this endpoint and from product's detail endpoint (list named images when using ?include=images parameter) are the same.

Use this endpoint when working only with product images to save time.

Path
guidstringrequired

Product's guid

Example: 92ca3575-7481-11e8-8216-002590dad85e
gallerystringrequired

Gallery identifier - use shop for normal and shop360 for 360 photos

Example: shop
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  'https://api.myshoptet.com/api/products/{guid}/images/{gallery}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​imagesArray of objectsrequired
data.​images[].​namestringrequired

image file name, also serves as an identifier for the image of the product. To assemble complete URL, it is added to the urlPath obtained from the endpoint e-shop info /api/eshop?include=imageCuts.

data.​images[].​priorityinteger or nullrequired

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. (can be null)

data.​images[].​descriptionstring or nullrequired

image label (can be null)

data.​images[].​changeTimestring or null(typeDateTime)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...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. (can be null)

data.​images[].​seoNamestringrequired

file name modified for SEO - a short label is attached.

data.​images[].​cdnNamestringrequired

same as seoName with attached hashed last image change time. name, seoName and cdnName can be entered in the URL - redirect will deliver the same image.

data.​images[].​isMainImagebooleanrequired
errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "images": [ … ]
  },
  "errors": [
    { … }
  ]
}

Delete all product images in gallery

Request

Deletes all product's images by gallery name. If removeReference parameter is not present or set to false and if image is referenced

as variant image, then image will be skipped and present in errors in response.

If removeReference is set to true, then this reference will be removed with the image.

Returns 200 status code. If any image deletion failed, it will be noted in errors section in response.

Path
guidstringrequired

Product's guid

Example: 94fe7ffc-7481-11e8-8216-002590dad85e
gallerystringrequired

Gallery name (shop or shop360)

Example: shop
Query
removeReferenceboolean

If product's variant image reference should be removed. Default false.

Example: removeReference=true
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X DELETE \
  'https://api.myshoptet.com/api/products/{guid}/images/{gallery}?removeReference=true' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
datanullrequired
errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": null,
  "errors": [
    { … }
  ]
}

Product images update

Request

Using this endpoint you can modify product images attributes, such as description and priority (order). Maximum of 100 images can be sent at once.

Path
guidstringrequired

Product's guid

Example: 95b84d4b-7481-11e8-8216-002590dad85e
gallerystringrequired

Gallery identifier - use shop for normal and shop360 for 360 photos

Example: shop
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectrequired
data.​imagesArray of objects[ 1 .. 100 ] itemsrequired
data.​images[].​namestringnon-emptyrequired

Name of image.

data.​images[].​priorityinteger[ 1 .. 99999 ]

Image priority.

data.​images[].​descriptionstring

Image description.

curl -i -X PATCH \
  'https://api.myshoptet.com/api/products/{guid}/images/{gallery}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "images": [
        {
          "name": "127.png",
          "priority": 100,
          "description": "Dobrá čokoláda"
        }
      ]
    }
  }'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​imagesArray of objectsrequired
data.​images[].​namestringrequired

image file name, also serves as an identifier for the image of the product. To assemble complete URL, it is added to the urlPath obtained from the endpoint e-shop info /api/eshop?include=imageCuts.

data.​images[].​priorityinteger or nullrequired

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. (can be null)

data.​images[].​descriptionstring or nullrequired

image label (can be null)

data.​images[].​changeTimestring or null(typeDateTime)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...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. (can be null)

data.​images[].​seoNamestringrequired

file name modified for SEO - a short label is attached.

data.​images[].​cdnNamestringrequired

same as seoName with attached hashed last image change time. name, seoName and cdnName can be entered in the URL - redirect will deliver the same image.

data.​images[].​isMainImagebooleanrequired
errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "images": [ … ]
  },
  "errors": [
    { … }
  ]
}

Product images insertion

Request

Using this endpoint you can upload new images to a product. This is an asynchronous request,

see how Asynchronous requests work on our

developer's portal. Maximum of 100 images can be sent at once.

Path
guidstringrequired

Product's guid

Example: 95b84d4b-7481-11e8-8216-002590dad85e
gallerystringrequired

Gallery identifier - use shop for normal and shop360 for 360 photos

Example: shop
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectrequired
data.​imagesArray of objects[ 1 .. 100 ] itemsrequired
data.​images[].​sourceUrlstring[ 1 .. 255 ] charactersrequired

Image url.

data.​images[].​priorityinteger[ 1 .. 99999 ]

Image priority.

data.​images[].​descriptionstring

Image description.

curl -i -X POST \
  'https://api.myshoptet.com/api/products/{guid}/images/{gallery}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "images": [
        {
          "sourceUrl": "https://cdn.myshoptet.com/cokolada.jpg",
          "priority": 100,
          "description": "Dobrá čokoláda"
        }
      ]
    }
  }'

Responses

Accepted

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​jobIdstringrequired

token of job

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "jobId": "ad24xod"
  },
  "errors": [
    { … }
  ]
}

Product images source update

Request

Using this endpoint you can modify product image attributes and also upload a new image and replace the existing one.

This is an asynchronous request, see how [Asynchronous requests](https://developers.shoptet.com/asynchronous-requests/

work on our developer's portal.

Path
guidstringrequired

Product's guid

Example: 95b84d4b-7481-11e8-8216-002590dad85e
gallerystringrequired

Gallery identifier - use shop for normal and shop360 for 360 photos

Example: shop
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectrequired
data.​imagesArray of objectsnon-emptyrequired
data.​images[].​namestringnon-emptyrequired

Name of the image

data.​images[].​sourceUrlstring[ 1 .. 255 ] charactersrequired

URL of the image

data.​images[].​priorityinteger[ 1 .. 99999 ]

Priority of the image

data.​images[].​descriptionstring

Description of the image

curl -i -X PATCH \
  'https://api.myshoptet.com/api/products/{guid}/images/{gallery}/source' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "images": [
        {
          "name": "127.png",
          "sourceUrl": "https://cdn.myshoptet.com/cokolada.jpg",
          "priority": 1,
          "description": "Dobrá čokoláda"
        }
      ]
    }
  }'

Responses

Accepted

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​jobIdstringrequired

token of job

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "jobId": "ad24xod"
  },
  "errors": [
    { … }
  ]
}

Delete one product image

Request

Deletes product's image. If removeReference parameter is not present or set to false and if image is referenced

as variant image, then image won't be deleted and response will have status code 409 Conflict.

If removeReference is set to true, then this reference will be removed with the image.

Path
guidstringrequired

Product's guid

Example: 92d77e60-7481-11e8-8216-002590dad85e
gallerystringrequired

Gallery name (shop or shop360)

Example: shop
imageNamestringrequired

Filename

Example: 52.png
Query
removeReferenceboolean

If product's variant image reference should be removed. Default false.

Example: removeReference=true
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X DELETE \
  'https://api.myshoptet.com/api/products/{guid}/images/{gallery}/{imageName}?removeReference=true' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
datanullrequired
errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": null,
  "errors": [
    { … }
  ]
}

Last product changes

Request

Returns the list of products, which were changed (added/edited or deleted). Endpoint is intended to determine the changes after you have loaded the complete list of products and you need to know if any of these have been changed. Guaranteed history is 30 days, older data are deleted progressively.

Each product in the log is mentioned only with its last change. For example, if the product was modified and then deleted, the log will show only information about its deletion.

Creation is considered as edit action. So, when there is a new item created, it will be displayed like edit action.

Endpoint supports pagination.

Description of object attributes with information about changes:

|Field |Causes product change|Notes. |

|--------------------------------------|---------------------|---------------------------------------|

|guid |Yes | |

|type |Yes | |

|visibility |Yes | |

|creationTime |Yes | |

|changeTime |Yes | |

|shortDescription |Yes | |

|description |Yes | |

|metaDescription |Yes | |

|name |Yes | |

|internalNote |Yes | |

|defaultCategory |Yes |Only category - product relation change|

|defaultCategory.guid |No | |

|defaultCategory.name |No | |

|supplier |Yes |Only supplier - product relation change|

|supplier.guid |No | |

|supplier.name |No | |

|brand |Yes |Only brand - product relation change |

|brand.code |No | |

|brand.name |No | |

|categories |Yes |Only product - category relation |

|categories.guid |No | |

|categories.parentGuid |No | |

|categories.name |No | |

|url |Yes |Only for relative url. Domain change no|

|flags |Yes | |

|flags.code |No | |

|flags.title |No | |

|flags.dateFrom |Yes | |

|flags.dateTo |Yes | |

|variants |Yes | |

|variants.code |Yes | |

|variants.ean |Yes | |

|variants.stock |no | |

|variants.unit |yes | |

|variants.weight |yes | |

|variants.visible |yes | |

|variants.minStockSupply |yes | |

|variants.negativeStockAllowed |yes | |

|variants.amountDecimalPlaces |yes | |

|variants.price |yes | |

|variants.includingVat |yes | |

|variants.vatRate |yes | |

|variants.currencyCode |yes | |

|variants.actionPrice |yes | |

|variants.commonPrice |yes | |

|variants.manufacturerCode |yes | |

|variants.pluCode |yes | |

|variants.isbn |yes | |

|variants.serialNo |yes | |

|variants.mpn |yes | |

|variants.availability |yes | |

|variants.availabilityWhenSoldOut |yes | |

|variants.image |yes | |

|variants.parameters |yes | |

|variants.name |yes | |

|variants.measureUnit |yes | |

|variants.measureUnit.measureAmount |yes | |

|variants.measureUnit.measureUnitId |yes | |

|variants.measureUnit.packagingAmount |yes | |

|variants.measureUnit.packagingUnitId |yes | |

|variants.measureUnit.measureUnitName |yes | |

|variants.measureUnit.packagingUnitName|yes | |

|variants.measureUnit.measurePrice |yes | |

|variants.recyclingFee |yes | |

|images |yes | |

|images.name |yes | |

|images.priority |yes | |

|images.description |yes | |

|images.changeTime |yes | |

|images.seoName |yes | |

|images.cdnName |yes | |

|descriptiveParameters |yes | |

|descriptiveParameters.name |yes | |

|descriptiveParameters.value |yes | |

|descriptiveParameters.description |yes | |

|descriptiveParameters.priority |yes | |

|surchargeParameters |no | |

|surchargeParameters.code |no | |

|surchargeParameters.name |no | |

|surchargeParameters.displayName |no | |

|surchargeParameters.description |no | |

|surchargeParameters.priority |no | |

|surchargeParameters.required |no | |

|surchargeParameters.currency |no | |

|surchargeParameters.includingVat |no | |

|surchargeParameters.values |no | |

|surchargeParameters.values.valueIndex |no | |

|surchargeParameters.values.description|no | |

|surchargeParameters.values.price |no | |

|surchargeParameters.values.priority |no | |

|surchargeParameters.values.visible |no | |

|setItems |yes | |

|setItems.guid |no | |

|setItems.code |no | |

|setItems.amount |no | |

|filteringParameters |yes |Only relation |

|filteringParameters.code |no | |

|filteringParameters.name |no | |

|filteringParameters.displayName |no | |

|filteringParameters.description |no | |

|filteringParameters.priority |yes | |

|filteringParameters.googleMapping |no | |

|filteringParameters.values |yes |Only relation |

|filteringParameters.values.valueIndex |no | |

|filteringParameters.values.name |no | |

|filteringParameters.values.priority |no | |

|filteringParameters.values.color |no | |

|filteringParameters.values.image |no | |

|warranty |yes |only relation |

|warranty.inMonths |no | |

|warranty.description |no | |

Query
fromstringrequired
Example: from=2018-01-01T01:01:01+02:00
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  'https://api.myshoptet.com/api/products/changes?from=string' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​changesArray of objectsrequired
data.​changes[].​guidstring(typeGuidUnlimited)<= 36 charactersrequired

product identifier that can be used to query about the customer''s details.

data.​changes[].​changeTimestring or null(typeDateTime)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

date and time, when the event happened. ISO 8601 format (2017-12-12T22:08:01+0100).

data.​changes[].​changeTypestringrequired

type of event that happened with the entity. Possible values are following: add, edit, delete.

data.​paginatorobject(paginator)required
data.​paginator.​totalCountintegerrequired

total number of available records

data.​paginator.​pageintegerrequired

current page

data.​paginator.​pageCountintegerrequired

total available of pages

data.​paginator.​itemsOnPageintegerrequired

number of currently returned records

data.​paginator.​itemsPerPageintegerrequired

required number of records per page

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "changes": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ]
}

List of product categories

Request

Returns the list of product categories.

Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  https://api.myshoptet.com/api/categories \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​categoriesArray of objects(category)required
data.​categories[].​guidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$required

unique category identificator

data.​categories[].​namestringrequired

category name

data.​categories[].​imagestring or nullrequired

header image (can be null)

data.​categories[].​descriptionstring or nullrequired

top category description (can be null)

data.​categories[].​secondDescriptionstring or nullrequired

bottom category description (can be null)

data.​categories[].​indexNamestringrequired

ending part of category URL

data.​categories[].​urlstringrequired

category URL in the e-shop

data.​categories[].​parentGuidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$required

unique identifier of the parent category (null, if there is no parent category)

data.​categories[].​prioritynumber or nullrequired

priority (specifies the order of categories)

data.​categories[].​menuTitlestring or nullrequired

category name in the e-shop menu

data.​categories[].​titlestring or nullrequired

HTML title element in the HTML header of the category page

data.​categories[].​metaTagDescriptionstring or nullrequired

HTML META header Description in category page

data.​categories[].​visiblebooleanrequired

flag, whether the category is visible

data.​categories[].​similarProductsCategorystring or nullrequired

GUID category, in which the products are similar to this category (can be null)

data.​categories[].​relatedProductsCategorystring or nullrequired

GUID category, in which the products are related to this category (can be null)

data.​categories[].​customerVisibilitystring or nullrequired

defines, which users of the e-shop have the category shown - all = all, registered = registered users, unregistered = non-registered users

data.​categories[].​productOrderingstring or nullrequired
data.​categories[].​catalogueMappingArray of objectsrequired

pairing to search engines such as Zboží, Heuréka, Google, etc. (can be null)

data.​categories[].​catalogueMapping[].​providerstringrequired

heureka

data.​categories[].​catalogueMapping[].​categorystringrequired

Clothing | Women's T-Shirts

data.​paginatorobject(paginator)required
data.​paginator.​totalCountintegerrequired

total number of available records

data.​paginator.​pageintegerrequired

current page

data.​paginator.​pageCountintegerrequired

total available of pages

data.​paginator.​itemsOnPageintegerrequired

number of currently returned records

data.​paginator.​itemsPerPageintegerrequired

required number of records per page

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "categories": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ]
}

Product category create

Request

Creates new category

Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectrequired
data.​guidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Category GUID. Must be unique if set. Optional.

data.​namestring[ 1 .. 255 ] charactersrequired

Category name

data.​parentGuidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Parent category GUID. Category must exist if set. Optional.

data.​descriptionstring or null

Category description. Max length 65535 bytes. Optional.

data.​secondDescriptionstring or null

Bottom category description. Max length 65535 bytes. Optional.

data.​imageNamestring or null

DEPRECATED (use sourceImageName). Category image. File must exist on the server. Optional.

data.​sourceImageNamestring(typeFilename)[ 1 .. 255 ] characters^[0-9a-zA-Z\-.]+$
data.​sortBeforestring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Guid of category before which you want to move the category from the request. Not possible to use with sortAfter. Optional.

data.​sortAfterstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Guid of category after which you want to move the category from the request. Not possible to use with sortBefore. Optional.

data.​indexNamestringnon-empty

Last part of url. Optional, generated from name if not set.

data.​menuTitlestring or null[ 1 .. 255 ] characters

Label for menu. Optional.

data.​titlestring or null[ 1 .. 255 ] characters

Meta tag title. Optional.

data.​metaTagDescriptionstring or null

Meta tag description. Optional.

data.​visibleboolean

Whether the category is visible. Optional, default true.

data.​customerVisibilitystring

defines users of the e-shop who can see the category - all = all (default), registered = registered users, unregistered = non-registered users. Optional.

Enum"all""registered""unregistered"
data.​productOrderingstring
Enum"default""most-selling""cheapest""most-expensive""oldest""newest""alphabetically""alphabetically-desc""product-code""product-code-desc"
data.​similarProductsCategorystring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Similar category guid. Optional.

data.​relatedProductsCategorystring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Related category guid. Optional.

curl -i -X POST \
  https://api.myshoptet.com/api/categories \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
      "name": "Watches",
      "parentGuid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
      "description": "<p>Top category description</p>",
      "secondDescription": "<p>Bottom category description</p>",
      "imageName": "watches-category-image.jpg",
      "sourceImageName": "string",
      "sortBefore": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
      "sortAfter": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
      "indexName": "watches",
      "menuTitle": "Watches",
      "title": "Watches",
      "metaTagDescription": "Watches, Apple watch, black, white, garmin",
      "visible": true,
      "customerVisibility": "all",
      "productOrdering": "alphabetically",
      "similarProductsCategory": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
      "relatedProductsCategory": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"
    }
  }'

Responses

Created

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobject(category)required
data.​guidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$required

unique category identificator

data.​namestringrequired

category name

data.​imagestring or nullrequired

header image (can be null)

data.​descriptionstring or nullrequired

top category description (can be null)

data.​secondDescriptionstring or nullrequired

bottom category description (can be null)

data.​indexNamestringrequired

ending part of category URL

data.​urlstringrequired

category URL in the e-shop

data.​parentGuidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$required

unique identifier of the parent category (null, if there is no parent category)

data.​prioritynumber or nullrequired

priority (specifies the order of categories)

data.​menuTitlestring or nullrequired

category name in the e-shop menu

data.​titlestring or nullrequired

HTML title element in the HTML header of the category page

data.​metaTagDescriptionstring or nullrequired

HTML META header Description in category page

data.​visiblebooleanrequired

flag, whether the category is visible

data.​similarProductsCategorystring or nullrequired

GUID category, in which the products are similar to this category (can be null)

data.​relatedProductsCategorystring or nullrequired

GUID category, in which the products are related to this category (can be null)

data.​customerVisibilitystring or nullrequired

defines, which users of the e-shop have the category shown - all = all, registered = registered users, unregistered = non-registered users

data.​productOrderingstring or nullrequired
data.​catalogueMappingArray of objectsrequired

pairing to search engines such as Zboží, Heuréka, Google, etc. (can be null)

data.​catalogueMapping[].​providerstringrequired

heureka

data.​catalogueMapping[].​categorystringrequired

Clothing | Women's T-Shirts

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
    "name": "Category name",
    "image": "https://beta.shoptet.cz/user/categories/thumb/supreme-plush-santa-hat.jpg",
    "description": "<p>Horní popis kategorie</p>",
    "secondDescription": "<p>Dolní popis kategorie</p>",
    "indexName": "sport-a-relax",
    "url": "https://beta.shoptet.cz/sport-a-relax",
    "parentGuid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
    "priority": 1,
    "menuTitle": "Watches",
    "title": "Purple M size T-shirts - cotton",
    "metaTagDescription": "T-shirts, cotton, M size, purple, pink, wine red",
    "visible": true,
    "similarProductsCategory": "07f7a4c1-d7b1-11e0-9a5c-feab5ed617ed",
    "relatedProductsCategory": "07f7a4c1-d7b1-11e0-9a5c-feab5ed617ed",
    "customerVisibility": "all",
    "productOrdering": "alphabetically",
    "catalogueMapping": [ … ]
  },
  "errors": [
    { … }
  ]
}

Product category detail

Request

Returns category info

Path
categoryGuidstringrequired

Product category.

Example: 5c498fb7-70ac-11e9-9208-08002774f818
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  'https://api.myshoptet.com/api/categories/{categoryGuid}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobject(category)required
data.​guidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$required

unique category identificator

data.​namestringrequired

category name

data.​imagestring or nullrequired

header image (can be null)

data.​descriptionstring or nullrequired

top category description (can be null)

data.​secondDescriptionstring or nullrequired

bottom category description (can be null)

data.​indexNamestringrequired

ending part of category URL

data.​urlstringrequired

category URL in the e-shop

data.​parentGuidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$required

unique identifier of the parent category (null, if there is no parent category)

data.​prioritynumber or nullrequired

priority (specifies the order of categories)

data.​menuTitlestring or nullrequired

category name in the e-shop menu

data.​titlestring or nullrequired

HTML title element in the HTML header of the category page

data.​metaTagDescriptionstring or nullrequired

HTML META header Description in category page

data.​visiblebooleanrequired

flag, whether the category is visible

data.​similarProductsCategorystring or nullrequired

GUID category, in which the products are similar to this category (can be null)

data.​relatedProductsCategorystring or nullrequired

GUID category, in which the products are related to this category (can be null)

data.​customerVisibilitystring or nullrequired

defines, which users of the e-shop have the category shown - all = all, registered = registered users, unregistered = non-registered users

data.​productOrderingstring or nullrequired
data.​catalogueMappingArray of objectsrequired

pairing to search engines such as Zboží, Heuréka, Google, etc. (can be null)

data.​catalogueMapping[].​providerstringrequired

heureka

data.​catalogueMapping[].​categorystringrequired

Clothing | Women's T-Shirts

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
    "name": "Category name",
    "image": "https://beta.shoptet.cz/user/categories/thumb/supreme-plush-santa-hat.jpg",
    "description": "<p>Horní popis kategorie</p>",
    "secondDescription": "<p>Dolní popis kategorie</p>",
    "indexName": "sport-a-relax",
    "url": "https://beta.shoptet.cz/sport-a-relax",
    "parentGuid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
    "priority": 1,
    "menuTitle": "Watches",
    "title": "Purple M size T-shirts - cotton",
    "metaTagDescription": "T-shirts, cotton, M size, purple, pink, wine red",
    "visible": true,
    "similarProductsCategory": "07f7a4c1-d7b1-11e0-9a5c-feab5ed617ed",
    "relatedProductsCategory": "07f7a4c1-d7b1-11e0-9a5c-feab5ed617ed",
    "customerVisibility": "all",
    "productOrdering": "alphabetically",
    "catalogueMapping": [ … ]
  },
  "errors": [
    { … }
  ]
}

Product category update

Request

Updates existing category.

Path
categoryGuidstringrequired

Category's guid

Example: bffa3b98-d968-11e0-b04f-57a43310b728
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectnon-emptyrequired
data.​guidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Category GUID. Must be unique if set. Optional.

data.​namestring[ 1 .. 255 ] characters

Category name. Optional.

data.​parentGuidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Parent category GUID. Category must exist if set. Optional.

data.​descriptionstring or null

Category description. Max length 65535 bytes. Optional.

data.​secondDescriptionstring or null

Bottom category description. Max length 65535 bytes. Optional.

data.​imageNamestring or null

DEPRECATED (use sourceImageName). Category image. File must exist on the server. Optional.

data.​sourceImageNamestring(typeFilename)[ 1 .. 255 ] characters^[0-9a-zA-Z\-.]+$
data.​sortBeforestring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Guid of category before which you want to move the category from the request. Not possible to use with sortAfter. Optional.

data.​sortAfterstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Guid of category after which you want to move the category from the request. Not possible to use with sortBefore. Optional.

data.​indexNamestringnon-empty

Last part of url. Optional, generated from name if not set.

data.​menuTitlestring or null[ 1 .. 255 ] characters

Label for menu. Optional.

data.​titlestring or null[ 1 .. 255 ] characters

Meta tag title. Optional.

data.​metaTagDescriptionstring or null

Meta tag description. Optional.

data.​visibleboolean

Whether the category is visible. Optional, default true.

data.​customerVisibilitystring

defines users of the e-shop who can see the category - all = all (default), registered = registered users, unregistered = non-registered users. Optional.

Enum"all""registered""unregistered"
data.​productOrderingstring
Enum"default""most-selling""cheapest""most-expensive""oldest""newest""alphabetically""alphabetically-desc""product-code""product-code-desc"
data.​similarProductsCategorystring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Similar category guid. Optional.

data.​relatedProductsCategorystring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Related category guid. Optional.

curl -i -X PATCH \
  'https://api.myshoptet.com/api/categories/{categoryGuid}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
      "name": "Watches",
      "parentGuid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
      "description": "<p>Top category description</p>",
      "secondDescription": "<p>Bottom category description</p>",
      "imageName": "watches-category-image.jpg",
      "sourceImageName": "string",
      "sortBefore": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
      "sortAfter": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
      "indexName": "watches",
      "menuTitle": "Watches",
      "title": "Watches",
      "metaTagDescription": "Watches, Apple watch, black, white, garmin",
      "visible": true,
      "customerVisibility": "all",
      "productOrdering": "alphabetically",
      "similarProductsCategory": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
      "relatedProductsCategory": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"
    }
  }'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobject(category)required
data.​guidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$required

unique category identificator

data.​namestringrequired

category name

data.​imagestring or nullrequired

header image (can be null)

data.​descriptionstring or nullrequired

top category description (can be null)

data.​secondDescriptionstring or nullrequired

bottom category description (can be null)

data.​indexNamestringrequired

ending part of category URL

data.​urlstringrequired

category URL in the e-shop

data.​parentGuidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$required

unique identifier of the parent category (null, if there is no parent category)

data.​prioritynumber or nullrequired

priority (specifies the order of categories)

data.​menuTitlestring or nullrequired

category name in the e-shop menu

data.​titlestring or nullrequired

HTML title element in the HTML header of the category page

data.​metaTagDescriptionstring or nullrequired

HTML META header Description in category page

data.​visiblebooleanrequired

flag, whether the category is visible

data.​similarProductsCategorystring or nullrequired

GUID category, in which the products are similar to this category (can be null)

data.​relatedProductsCategorystring or nullrequired

GUID category, in which the products are related to this category (can be null)

data.​customerVisibilitystring or nullrequired

defines, which users of the e-shop have the category shown - all = all, registered = registered users, unregistered = non-registered users

data.​productOrderingstring or nullrequired
data.​catalogueMappingArray of objectsrequired

pairing to search engines such as Zboží, Heuréka, Google, etc. (can be null)

data.​catalogueMapping[].​providerstringrequired

heureka

data.​catalogueMapping[].​categorystringrequired

Clothing | Women's T-Shirts

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
    "name": "Category name",
    "image": "https://beta.shoptet.cz/user/categories/thumb/supreme-plush-santa-hat.jpg",
    "description": "<p>Horní popis kategorie</p>",
    "secondDescription": "<p>Dolní popis kategorie</p>",
    "indexName": "sport-a-relax",
    "url": "https://beta.shoptet.cz/sport-a-relax",
    "parentGuid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
    "priority": 1,
    "menuTitle": "Watches",
    "title": "Purple M size T-shirts - cotton",
    "metaTagDescription": "T-shirts, cotton, M size, purple, pink, wine red",
    "visible": true,
    "similarProductsCategory": "07f7a4c1-d7b1-11e0-9a5c-feab5ed617ed",
    "relatedProductsCategory": "07f7a4c1-d7b1-11e0-9a5c-feab5ed617ed",
    "customerVisibility": "all",
    "productOrdering": "alphabetically",
    "catalogueMapping": [ … ]
  },
  "errors": [
    { … }
  ]
}

Product category deletion

Request

Deletes product category as per entered categoryGuid. If successful, returns the code 200.

If the category does not exist within the e-shop, a 404 code is returned.

If the category cannot be deleted, because it is used by some product or has children, a 409 code is returned.

Optional parameter deleteUsed allows deleting categories used by products. The products are marked as changed.

Optional parameter deleteChildren allows deleting categories with child categories. The children are deleted too.

Path
categoryGuidstringrequired

Category guid

Example: 5c499200-70ac-11e9-9208-08002774f818
Query
deleteUsedboolean

Allows deleting categories used by products if set to true

Example: deleteUsed=true
deleteChildrenboolean

Allows deleting categories with children if set to true

Example: deleteChildren=true
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X DELETE \
  'https://api.myshoptet.com/api/categories/{categoryGuid}?deleteChildren=true&deleteUsed=true' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
datanullrequired
errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": null,
  "errors": [
    { … }
  ]
}

Product category BATCH update

Request

This endpoint allows you to update multiple categories at once. Batch update is processed asynchronously in same way as for example products snapshot,

but it does not have resultUrl with categories to download in response. Instead, you can check attribute log which contains successfully updated categories and errors.

See how Asynchronous requests work on our developer's portal.

File with data for update must be in JSONL (jsonlines) format. Each line must contain one category in JSON format. Maximum size of file is 100MB.

Structure of JSON row is same as structure of JSON for single category update above. You can add one extra optional attribute

"language" which defines language of updating category, so you are able to update multiple language attributes (i.e. "name", "description" etc.) of one category in one batch file.

If language is not defined, default language of shop is used.

Asynchronous job process jsonl file row by row and try to validate and save data. If there is any error, row is skipped and error is logged, but it does not stop processing of other rows.

In Log, every product is identified by its position in file (starting from 1).

Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
batchFileUrlPathstringrequired

Url to batch file with products data. File must be in JSONL format.

curl -i -X PATCH \
  https://api.myshoptet.com/api/categories/batch \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "batchFileUrlPath": "https://cdn.myshoptet.com/batch-products-update.jsonl"
  }'

Responses

Accepted

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​jobIdstringrequired

token of job

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "jobId": "ad24xod"
  },
  "errors": [
    { … }
  ]
}

List of products order in category

Request

Retrieves products and their priorities within a category.

Path
categoryGuidstringrequired

Product category.

Example: 5c498fb7-70ac-11e9-9208-08002774f818
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  'https://api.myshoptet.com/api/categories/{categoryGuid}/productsPriority' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​categoryProductsArray of objectsrequired
data.​categoryProducts[].​productGuidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$required

Global unique permanent product identifier.

data.​categoryProducts[].​prioritynumber or nullrequired

Order in the list

data.​paginatorobject(paginator)required
data.​paginator.​totalCountintegerrequired

total number of available records

data.​paginator.​pageintegerrequired

current page

data.​paginator.​pageCountintegerrequired

total available of pages

data.​paginator.​itemsOnPageintegerrequired

number of currently returned records

data.​paginator.​itemsPerPageintegerrequired

required number of records per page

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "categoryProducts": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ]
}

Update product order in category

Request

Using this endpoint you can update product priority within a category.

You can request multiple updates at once; the maximum is 200 updates per request.

In case of a partial failure, the response code will be 200 OK and the errorneous items will be

listed in the errors array. In case of a complete failure, response code will be 400 BAD REQUEST.

Minimum priority is 0, maximum priority is 65535.

Path
categoryGuidstringrequired

Product category.

Example: 5c498fb7-70ac-11e9-9208-08002774f818
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataArray of objectsrequired
data[].​productGuidstring(typeGuidUnlimited)<= 36 charactersrequired

GUID of the product

data[].​prioritynumber or null[ 0 .. 65535 ]required

Priority of the product

curl -i -X PATCH \
  'https://api.myshoptet.com/api/categories/{categoryGuid}/productsPriority' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": [
      {
        "productGuid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
        "priority": "100"
      }
    ]
  }'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​dataobject or nullrequired
errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "data": "null"
  },
  "errors": [
    { … }
  ]
}

List of parametric categories

Request

Returns the list of product categories.

Query
includestring

Include additional data in response. Possible values: parameters.

Example: include=parameters
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  'https://api.myshoptet.com/api/parametric-categories?include=string' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​parametricCategoriesArray of objectsrequired
data.​parametricCategories[].​guidstringrequired

unique identifier of the category

data.​parametricCategories[].​namestringrequired

category name

data.​parametricCategories[].​indexNamestringrequired

ending part of category URL

data.​parametricCategories[].​urlstringrequired

category URL in the e-shop

data.​parametricCategories[].​descriptionstring or nullrequired

top category description

data.​parametricCategories[].​secondDescriptionstring or nullrequired

bottom category description

data.​parametricCategories[].​imagestring or nullrequired

header image

data.​parametricCategories[].​titlestring or nullrequired

HTML title element in the HTML header of the category page

data.​parametricCategories[].​metaTagDescriptionstring or nullrequired

HTML META header Description in category page

data.​parametricCategories[].​originalCategoryGuidstring or nullrequired

unique identifier of the original category (from which was the parametric category created)

data.​parametricCategories[].​showInListbooleanrequired

flag, whether the category is visible in product list

data.​parametricCategories[].​showInDetailbooleanrequired

flag, whether the category is visible in product detail

data.​parametricCategories[].​parametersArray of objects(parameterValueCombinations)

parameters of the parametric category (requires parameters include in request url)

data.​paginatorobject(paginator)
errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "parametricCategories": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ]
}

Parametric category detail

Request

Returns parametric category info.

Path
categoryGuidstringrequired

Guid of parametric category.

Example: 5c498fb7-70ac-11e9-9208-08002774f818
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  'https://api.myshoptet.com/api/parametric-categories/{categoryGuid}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​parametricCategoryobjectrequired
data.​parametricCategory.​guidstringrequired

unique identifier of the category

data.​parametricCategory.​namestringrequired

category name

data.​parametricCategory.​indexNamestringrequired

ending part of category URL

data.​parametricCategory.​urlstringrequired

category URL in the e-shop

data.​parametricCategory.​descriptionstring or nullrequired

top category description

data.​parametricCategory.​secondDescriptionstring or nullrequired

bottom category description

data.​parametricCategory.​imagestring or nullrequired

header image

data.​parametricCategory.​titlestring or nullrequired

HTML title element in the HTML header of the category page

data.​parametricCategory.​metaTagDescriptionstring or nullrequired

HTML META header Description in category page

data.​parametricCategory.​originalCategoryGuidstring or nullrequired

unique identifier of the original category (from which was the parametric category created)

data.​parametricCategory.​showInListbooleanrequired

flag, whether the category is visible in product list

data.​parametricCategory.​showInDetailbooleanrequired

flag, whether the category is visible in product detail

data.​parametricCategory.​parametersArray of objects(parameterValueCombinations)

parameters of the parametric category (requires parameters include in request url)

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "parametricCategory": { … }
  },
  "errors": [
    { … }
  ]
}

List of products flags

Request

Returns the list of product flags within the e-shop.

Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  https://api.myshoptet.com/api/products/flags \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​flagsArray of objectsrequired
data.​flags[].​codestringrequired

Unique code of the flag

data.​flags[].​titlestringrequired

flag name. This text is displayed to customers in the e-shop.

data.​flags[].​systembooleanrequired

Is it a system flag common for all e-shops?

data.​flags[].​colorstring or nullrequired

color of the product flag displayed in the e-shop.

data.​flags[].​showInDetailbooleanrequired

Should the flag be displayed in the product detail?

data.​flags[].​showInCategorybooleanrequired

Should the flag be displayed in the category product list?

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "flags": [ … ]
  },
  "errors": [
    { … }
  ]
}

Product flag insertion

Request

Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectrequired
data.​titlestring[ 1 .. 255 ] charactersrequired

Name of flag.

data.​colorstring(typeColor)^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$

Color of the parameter in hex format. NULL forces default color.

curl -i -X POST \
  https://api.myshoptet.com/api/products/flags \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "title": "Sale",
      "color": "FF00FF"
    }
  }'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​flagsArray of objectsrequired
data.​flags[].​codestringrequired

Unique code of the flag

data.​flags[].​titlestringrequired

flag name. This text is displayed to customers in the e-shop.

data.​flags[].​systembooleanrequired

Is it a system flag common for all e-shops?

data.​flags[].​colorstring or nullrequired

color of the product flag displayed in the e-shop.

data.​flags[].​showInDetailbooleanrequired

Should the flag be displayed in the product detail?

data.​flags[].​showInCategorybooleanrequired

Should the flag be displayed in the category product list?

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "flags": [ … ]
  },
  "errors": [
    { … }
  ]
}

Product flag update

Request

Updates the flag.

Path
codestringrequired
Example: action
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectnon-emptyrequired
data.​titlestring[ 1 .. 255 ] characters

Name of flag.

data.​colorstring(typeColor)^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$

Color of the parameter in hex format. NULL forces default color.

curl -i -X PATCH \
  'https://api.myshoptet.com/api/products/flags/{code}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "title": "Sale",
      "color": "FF00FF"
    }
  }'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​flagsArray of objectsrequired
data.​flags[].​codestringrequired

Unique code of the flag

data.​flags[].​titlestringrequired

flag name. This text is displayed to customers in the e-shop.

data.​flags[].​systembooleanrequired

Is it a system flag common for all e-shops?

data.​flags[].​colorstring or nullrequired

color of the product flag displayed in the e-shop.

data.​flags[].​showInDetailbooleanrequired

Should the flag be displayed in the product detail?

data.​flags[].​showInCategorybooleanrequired

Should the flag be displayed in the category product list?

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "flags": [ … ]
  },
  "errors": [
    { … }
  ]
}

Product flag delete

Request

Deletes the flag. System flags cannot be deleted.

Path
codestringrequired
Example: action
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X DELETE \
  'https://api.myshoptet.com/api/products/flags/{code}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
datanullrequired
errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": null,
  "errors": [
    { … }
  ]
}

List of products measure units

Request

Returns the list of product measure units within the e-shop.

Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  https://api.myshoptet.com/api/products/measure-units \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​measureUnitsArray of objectsrequired
data.​measureUnits[].​idintegerrequired

Measure unit ID

data.​measureUnits[].​unitNamestringrequired

Measure unit name

data.​measureUnits[].​priorityinteger or nullrequired

Unit priority specifies the order of measure units.

data.​measureUnits[].​ratiosArray of objectsrequired

List of other units which are convertible to this one.

data.​measureUnits[].​ratios[].​unitIdintegerrequired

Unit ID

data.​measureUnits[].​ratios[].​ratiostring(typeUnitRatio)^[0-9]+\.[0-9]{9}$required

Unit ratio

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "measureUnits": [ … ]
  },
  "errors": [
    { … }
  ]
}

List of products availabilities

Request

Returns the list of product availabilities within the e-shop and default availabilities ids.

Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  https://api.myshoptet.com/api/products/availabilities \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​availabilitiesArray of objectsrequired
data.​availabilities[].​idintegerrequired

ID of the availability

data.​availabilities[].​namestringrequired

Name of the availability

data.​availabilities[].​descriptionstring or nullrequired

Description of the availability

data.​availabilities[].​colorstring or nullrequired

Color of the availability

data.​availabilities[].​systembooleanrequired

Is availability default (system) and not user made?

data.​availabilities[].​onStockInHoursinteger or nullrequired

When will a product be on stock. (in hours)

data.​availabilities[].​deliveryInHoursinteger or nullrequired

When will a product be delivered. (in hours)

data.​availabilities[].​googleAvailabilityobject or nullrequired

Google availability info

data.​availabilities[].​googleAvailability.​idintegerrequired

ID of the google availability

data.​availabilities[].​googleAvailability.​namestringrequired

Name of the google availability

data.​defaultAvailabilitiesobjectrequired
data.​defaultAvailabilities.​onStockinteger or nullrequired

ID of default availability when product is on stock

data.​defaultAvailabilities.​soldOutNegativeStockAllowedinteger or nullrequired

ID of default availability when sold out and buying sold out products is allowed

data.​defaultAvailabilities.​soldOutNegativeStockForbiddeninteger or nullrequired

ID of default availability when sold out and buying sold out products is forbidden

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "availabilities": [ … ],
    "defaultAvailabilities": { … }
  },
  "errors": [
    { … }
  ]
}

List of surcharge parameters

Request

Returns the list of available surcharge parameters with their available values within the e-shop.

Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  https://api.myshoptet.com/api/products/surcharge-parameters \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​surchargeParametersArray of objectsrequired
data.​surchargeParameters[].​idintegerrequired

Id of surcharge parameter. This identifier is used on eshop frontend.

data.​surchargeParameters[].​codestringrequired

Parameter code (identifier).

data.​surchargeParameters[].​namestringrequired

Name of surcharge parameter.

data.​surchargeParameters[].​displayNamestring or nullrequired

Parameter display name.

data.​surchargeParameters[].​descriptionstring or nullrequired

Description of surcharge parameter.

data.​surchargeParameters[].​priorityinteger or nullrequired

Priority of surcharge parameter.

data.​surchargeParameters[].​requiredbooleanrequired

If surcharge parameter is required.

data.​surchargeParameters[].​currencystringrequired

Currency of surcharge parameter.

data.​surchargeParameters[].​includingVatbooleanrequired

Is price of parameter's values including VAT.

data.​surchargeParameters[].​googleMappingobject or null(googleMappingType)required

Possible parameter mapping with google

data.​surchargeParameters[].​googleMapping.​valuestring

Code (identifier) of google mapping parameter

data.​surchargeParameters[].​googleMapping.​descriptionstring or null

Description (name) of google mapping parameter

data.​surchargeParameters[].​valuesArray of objects(surchargeParameterValue)required

Possible parameter's values.

data.​surchargeParameters[].​values[].​idintegerrequired

Id of surcharge parameter value. This identifier is used on eshop frontend.

data.​surchargeParameters[].​values[].​valueIndexstringrequired

Code (identifier) of parameter's value

data.​surchargeParameters[].​values[].​descriptionstringrequired

Description (name) of parameter's value

data.​surchargeParameters[].​values[].​pricestring or null(typePrice)^(-)?[0-9]+\.[0-9]{2}$required

Price of parameter's value

data.​surchargeParameters[].​values[].​priorityinteger or nullrequired

Priority of parameter's value

data.​paginatorobject(paginator)required
data.​paginator.​totalCountintegerrequired

total number of available records

data.​paginator.​pageintegerrequired

current page

data.​paginator.​pageCountintegerrequired

total available of pages

data.​paginator.​itemsOnPageintegerrequired

number of currently returned records

data.​paginator.​itemsPerPageintegerrequired

required number of records per page

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "surchargeParameters": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ]
}

Creation of surcharge parameter

Request

Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectrequired
data.​currencystring(typeCurrencyCode)^[a-zA-Z]{3}$

currency code. List of available currencies within the e-shop can be found in endpoint GET /api/eshop.

data.​displayNamestring or nullnon-empty

Name of surcharge parameter.

data.​namestring[ 1 .. 255 ] charactersrequired

Name of surcharge parameter.

data.​codestring[ 1 .. 255 ] characters^[a-zA-Z0-9\-]*$

Url friendly name of parameter. If is not set, code is generated from name. When changed, you must use the new code in the next API calls.

data.​descriptionstring or nullnon-empty

Description of surcharge parameter.

data.​requiredboolean

default value is false.

data.​includingVatboolean

default value is true.

data.​priorityinteger or null>= 1

Parameter priority

data.​googleMappingstring or null[ 1 .. 255 ] characters

Mapping for google.

data.​valuesArray of objectsnon-emptyrequired

Values of parameter.

data.​values[].​namestring[ 1 .. 128 ] charactersrequired

Name of parameter value

data.​values[].​pricestring or null(typePrice)^(-)?[0-9]+\.[0-9]{2}$required

Additional price of surcharge parameter.

data.​values[].​valueIndexstring or null[ 1 .. 255 ] characters^[a-zA-Z0-9\-]*$

Url friendly name of parameter value. Maximal length of 255 characters. If is not set, code is generated from name.

data.​values[].​priorityinteger or null>= 1

Priority of parameter value.

curl -i -X POST \
  https://api.myshoptet.com/api/products/surcharge-parameters \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "currency": "CZK",
      "displayName": "Povinny",
      "name": "Povinný",
      "code": "povinny",
      "description": "Popisek",
      "required": true,
      "includingVat": true,
      "priority": 1,
      "googleMapping": "google:gender",
      "values": [
        {
          "name": "Modrý",
          "price": "21.00",
          "valueIndex": "modry",
          "priority": 1
        }
      ]
    }
  }'

Responses

Created

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​surchargeParameterobjectrequired
data.​surchargeParameter.​idintegerrequired

Id of surcharge parameter. This identifier is used on eshop frontend.

data.​surchargeParameter.​codestringrequired

Parameter code (identifier).

data.​surchargeParameter.​namestringrequired

Name of surcharge parameter.

data.​surchargeParameter.​displayNamestring or nullrequired

Parameter display name.

data.​surchargeParameter.​descriptionstring or nullrequired

Description of surcharge parameter.

data.​surchargeParameter.​priorityinteger or nullrequired

Priority of surcharge parameter.

data.​surchargeParameter.​requiredbooleanrequired

If surcharge parameter is required.

data.​surchargeParameter.​currencystringrequired

Currency of surcharge parameter.

data.​surchargeParameter.​includingVatbooleanrequired

Is price of parameter's values including VAT.

data.​surchargeParameter.​googleMappingobject or null(googleMappingType)required

Possible parameter mapping with google

data.​surchargeParameter.​googleMapping.​valuestring

Code (identifier) of google mapping parameter

data.​surchargeParameter.​googleMapping.​descriptionstring or null

Description (name) of google mapping parameter

data.​surchargeParameter.​valuesArray of objects(surchargeParameterValue)required

Possible parameter's values.

data.​surchargeParameter.​values[].​idintegerrequired

Id of surcharge parameter value. This identifier is used on eshop frontend.

data.​surchargeParameter.​values[].​valueIndexstringrequired

Code (identifier) of parameter's value

data.​surchargeParameter.​values[].​descriptionstringrequired

Description (name) of parameter's value

data.​surchargeParameter.​values[].​pricestring or null(typePrice)^(-)?[0-9]+\.[0-9]{2}$required

Price of parameter's value

data.​surchargeParameter.​values[].​priorityinteger or nullrequired

Priority of parameter's value

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "surchargeParameter": { … }
  },
  "errors": [
    { … }
  ]
}

Detail of surcharge parameter

Request

Path
codestringrequired
Example: povinny
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  'https://api.myshoptet.com/api/products/surcharge-parameters/{code}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​surchargeParameterobjectrequired
data.​surchargeParameter.​idintegerrequired

Id of surcharge parameter. This identifier is used on eshop frontend.

data.​surchargeParameter.​codestringrequired

Parameter code (identifier).

data.​surchargeParameter.​namestringrequired

Name of surcharge parameter.

data.​surchargeParameter.​displayNamestring or nullrequired

Parameter display name.

data.​surchargeParameter.​descriptionstring or nullrequired

Description of surcharge parameter.

data.​surchargeParameter.​priorityinteger or nullrequired

Priority of surcharge parameter.

data.​surchargeParameter.​requiredbooleanrequired

If surcharge parameter is required.

data.​surchargeParameter.​currencystringrequired

Currency of surcharge parameter.

data.​surchargeParameter.​includingVatbooleanrequired

Is price of parameter's values including VAT.

data.​surchargeParameter.​googleMappingobject or null(googleMappingType)required

Possible parameter mapping with google

data.​surchargeParameter.​googleMapping.​valuestring

Code (identifier) of google mapping parameter

data.​surchargeParameter.​googleMapping.​descriptionstring or null

Description (name) of google mapping parameter

data.​surchargeParameter.​valuesArray of objects(surchargeParameterValue)required

Possible parameter's values.

data.​surchargeParameter.​values[].​idintegerrequired

Id of surcharge parameter value. This identifier is used on eshop frontend.

data.​surchargeParameter.​values[].​valueIndexstringrequired

Code (identifier) of parameter's value

data.​surchargeParameter.​values[].​descriptionstringrequired

Description (name) of parameter's value

data.​surchargeParameter.​values[].​pricestring or null(typePrice)^(-)?[0-9]+\.[0-9]{2}$required

Price of parameter's value

data.​surchargeParameter.​values[].​priorityinteger or nullrequired

Priority of parameter's value

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "surchargeParameter": { … }
  },
  "errors": [
    { … }
  ]
}

Update of surcharge parameter

Request

Path
codestringrequired
Example: povinny
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectnon-emptyrequired
data.​namestring[ 1 .. 255 ] characters

Name of surcharge parameter.

data.​codestring[ 1 .. 255 ] characters^[a-zA-Z0-9\-]*$

Url friendly name of parameter. If is not set, code is generated from name. When changed, you must use the new code in the next API calls.

data.​displayNamestring or nullnon-empty

Name of surcharge parameter.

data.​descriptionstring or nullnon-empty

Description of surcharge parameter.

data.​priorityinteger or null>= 1

Parameter priority

data.​googleMappingstring or null[ 1 .. 255 ] characters

Mapping for google.

data.​currencystring(typeCurrencyCode)^[a-zA-Z]{3}$

currency code. List of available currencies within the e-shop can be found in endpoint GET /api/eshop.

data.​requiredboolean

default value is false.

data.​includingVatboolean

default value is true.

curl -i -X PATCH \
  'https://api.myshoptet.com/api/products/surcharge-parameters/{code}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "name": "Povinný",
      "code": "povinny",
      "displayName": "Povinny",
      "description": "Popisek",
      "priority": 1,
      "googleMapping": "google:gender",
      "currency": "CZK",
      "required": true,
      "includingVat": true
    }
  }'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​surchargeParameterobjectrequired
data.​surchargeParameter.​idintegerrequired

Id of surcharge parameter. This identifier is used on eshop frontend.

data.​surchargeParameter.​codestringrequired

Parameter code (identifier).

data.​surchargeParameter.​namestringrequired

Name of surcharge parameter.

data.​surchargeParameter.​displayNamestring or nullrequired

Parameter display name.

data.​surchargeParameter.​descriptionstring or nullrequired

Description of surcharge parameter.

data.​surchargeParameter.​priorityinteger or nullrequired

Priority of surcharge parameter.

data.​surchargeParameter.​requiredbooleanrequired

If surcharge parameter is required.

data.​surchargeParameter.​currencystringrequired

Currency of surcharge parameter.

data.​surchargeParameter.​includingVatbooleanrequired

Is price of parameter's values including VAT.

data.​surchargeParameter.​googleMappingobject or null(googleMappingType)required

Possible parameter mapping with google

data.​surchargeParameter.​googleMapping.​valuestring

Code (identifier) of google mapping parameter

data.​surchargeParameter.​googleMapping.​descriptionstring or null

Description (name) of google mapping parameter

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "surchargeParameter": { … }
  },
  "errors": [
    { … }
  ]
}

Creation of surcharge parameter value

Request

Path
codestringrequired
Example: povinny
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectrequired
data.​paramValuesArray of objectsnon-emptyrequired
data.​paramValues[].​namestring[ 1 .. 128 ] charactersrequired

Name of parameter value.

data.​paramValues[].​pricestring or null(typePrice)^(-)?[0-9]+\.[0-9]{2}$required

Additional price of surcharge parameter.

data.​paramValues[].​valueIndexstring or null[ 1 .. 255 ] characters^[a-zA-Z0-9\-]*$

Url friendly name of parameter value. Maximal length of 255 characters. If is not set, code is generated from name.

data.​paramValues[].​priorityinteger or null>= 1

Parameter value priority

curl -i -X POST \
  'https://api.myshoptet.com/api/products/surcharge-parameters/{code}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "paramValues": [
        {
          "name": "Modrý",
          "price": "21.00",
          "valueIndex": "modry",
          "priority": 1
        }
      ]
    }
  }'

Responses

Created

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​surchargeParameterobjectrequired
data.​surchargeParameter.​idintegerrequired

Id of surcharge parameter. This identifier is used on eshop frontend.

data.​surchargeParameter.​codestringrequired

Parameter code (identifier).

data.​surchargeParameter.​namestringrequired

Name of surcharge parameter.

data.​surchargeParameter.​displayNamestring or nullrequired

Parameter display name.

data.​surchargeParameter.​descriptionstring or nullrequired

Description of surcharge parameter.

data.​surchargeParameter.​priorityinteger or nullrequired

Priority of surcharge parameter.

data.​surchargeParameter.​requiredbooleanrequired

If surcharge parameter is required.

data.​surchargeParameter.​currencystringrequired

Currency of surcharge parameter.

data.​surchargeParameter.​includingVatbooleanrequired

Is price of parameter's values including VAT.

data.​surchargeParameter.​googleMappingobject or null(googleMappingType)required

Possible parameter mapping with google

data.​surchargeParameter.​googleMapping.​valuestring

Code (identifier) of google mapping parameter

data.​surchargeParameter.​googleMapping.​descriptionstring or null

Description (name) of google mapping parameter

data.​surchargeParameter.​valuesArray of objects(surchargeParameterValue)required

Possible parameter's values.

data.​surchargeParameter.​values[].​idintegerrequired

Id of surcharge parameter value. This identifier is used on eshop frontend.

data.​surchargeParameter.​values[].​valueIndexstringrequired

Code (identifier) of parameter's value

data.​surchargeParameter.​values[].​descriptionstringrequired

Description (name) of parameter's value

data.​surchargeParameter.​values[].​pricestring or null(typePrice)^(-)?[0-9]+\.[0-9]{2}$required

Price of parameter's value

data.​surchargeParameter.​values[].​priorityinteger or nullrequired

Priority of parameter's value

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "surchargeParameter": { … }
  },
  "errors": [
    { … }
  ]
}

Removal of surcharge parameter

Request

Path
codestringrequired
Example: povinny
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X DELETE \
  'https://api.myshoptet.com/api/products/surcharge-parameters/{code}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
datanullrequired
errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": null,
  "errors": [
    { … }
  ]
}

Removal of surcharge parameter value

Request

Path
paramIndexstringrequired
Example: povinny
valueIndexstringrequired
Example: modry
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X DELETE \
  'https://api.myshoptet.com/api/products/surcharge-parameters/{paramIndex}/{valueIndex}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
datanullrequired
errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": null,
  "errors": [
    { … }
  ]
}

Update of surcharge parameter value

Request

Path
paramIndexstringrequired
Example: povinny
valueIndexstringrequired
Example: modry
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectnon-emptyrequired
data.​namestring[ 1 .. 128 ] characters

Name of the parameter value

data.​valueIndexstring or null[ 1 .. 255 ] characters^[a-zA-Z0-9\-]*$

Url friendly name of parameter value. If is not set, code is generated from name. When changed, you must use the new valueIndex in the next API calls.

data.​priorityinteger or null>= 1

Parameter value priority.

data.​pricestring or null(typePrice)^(-)?[0-9]+\.[0-9]{2}$

Additional price of surcharge parameter.

curl -i -X PATCH \
  'https://api.myshoptet.com/api/products/surcharge-parameters/{paramIndex}/{valueIndex}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "name": "Modrý",
      "valueIndex": "modry",
      "priority": 1,
      "price": "21.00"
    }
  }'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​surchargeParameterobjectrequired
data.​surchargeParameter.​idintegerrequired

Id of surcharge parameter. This identifier is used on eshop frontend.

data.​surchargeParameter.​codestringrequired

Parameter code (identifier).

data.​surchargeParameter.​namestringrequired

Name of surcharge parameter.

data.​surchargeParameter.​displayNamestring or nullrequired

Parameter display name.

data.​surchargeParameter.​descriptionstring or nullrequired

Description of surcharge parameter.

data.​surchargeParameter.​priorityinteger or nullrequired

Priority of surcharge parameter.

data.​surchargeParameter.​requiredbooleanrequired

If surcharge parameter is required.

data.​surchargeParameter.​currencystringrequired

Currency of surcharge parameter.

data.​surchargeParameter.​includingVatbooleanrequired

Is price of parameter's values including VAT.

data.​surchargeParameter.​googleMappingobject or null(googleMappingType)required

Possible parameter mapping with google

data.​surchargeParameter.​googleMapping.​valuestring

Code (identifier) of google mapping parameter

data.​surchargeParameter.​googleMapping.​descriptionstring or null

Description (name) of google mapping parameter

data.​surchargeParameter.​valuesArray of objects(surchargeParameterValue)required

Possible parameter's values.

data.​surchargeParameter.​values[].​idintegerrequired

Id of surcharge parameter value. This identifier is used on eshop frontend.

data.​surchargeParameter.​values[].​valueIndexstringrequired

Code (identifier) of parameter's value

data.​surchargeParameter.​values[].​descriptionstringrequired

Description (name) of parameter's value

data.​surchargeParameter.​values[].​pricestring or null(typePrice)^(-)?[0-9]+\.[0-9]{2}$required

Price of parameter's value

data.​surchargeParameter.​values[].​priorityinteger or nullrequired

Priority of parameter's value

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "surchargeParameter": { … }
  },
  "errors": [
    { … }
  ]
}

List of filtering parameters

Request

Returns the list of available filtering parameters with their available values within the e-shop.

Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  https://api.myshoptet.com/api/products/filtering-parameters \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​filteringParametersArray of objectsrequired
data.​filteringParameters[].​idintegerrequired

Parameter id

data.​filteringParameters[].​codestringrequired

Parameter code

data.​filteringParameters[].​namestringrequired

Parameter name

data.​filteringParameters[].​displayNamestring or nullrequired

Parameter display name

data.​filteringParameters[].​descriptionstring or nullrequired

Parameter description

data.​filteringParameters[].​priorityinteger or nullrequired

Parameter priority

data.​filteringParameters[].​googleMappingobject or null(googleMappingType)required

Possible parameter mapping with google

data.​filteringParameters[].​googleMapping.​valuestring

Code (identifier) of google mapping parameter

data.​filteringParameters[].​googleMapping.​descriptionstring or null

Description (name) of google mapping parameter

data.​filteringParameters[].​valuesArray of objects(productFilteringParameterValue)required
data.​filteringParameters[].​values[].​idintegerrequired

Parameter value id

data.​filteringParameters[].​values[].​valueIndexstring or nullrequired

Code (identifier) of parameter's value

data.​filteringParameters[].​values[].​namestringrequired

Description (name) of parameter's value

data.​filteringParameters[].​values[].​priorityinteger or nullrequired

Parameter value priority

data.​filteringParameters[].​values[].​colorstring or nullrequired

Hex code of color

data.​filteringParameters[].​values[].​imagestring or nullrequired

Url of image

data.​paginatorobject(paginator)required
data.​paginator.​totalCountintegerrequired

total number of available records

data.​paginator.​pageintegerrequired

current page

data.​paginator.​pageCountintegerrequired

total available of pages

data.​paginator.​itemsOnPageintegerrequired

number of currently returned records

data.​paginator.​itemsPerPageintegerrequired

required number of records per page

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "filteringParameters": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ]
}

Creation of filtering parameter

Request

Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectrequired
data.​namestring[ 1 .. 255 ] charactersrequired

Parameter name

data.​codestring[ 1 .. 255 ] characters^[a-zA-Z0-9\-]*$

Url friendly name of parameter. When changed, in next API call you must use the new parameter code.

data.​displayNamestring or null[ 1 .. 255 ] characters

Parameter display name

data.​descriptionstring or nullnon-empty

Parameter description

data.​priorityinteger or null>= 1

Parameter priority

data.​googleMappingstring or null[ 1 .. 255 ] characters

Mapping for google.

data.​valuesArray of objects(productFilteringParameterValues)non-emptyrequired
data.​values[].​namestring[ 1 .. 128 ] charactersrequired

Name of parameter value.

data.​values[].​valueIndexstring or null[ 1 .. 255 ] characters^[a-zA-Z0-9\-]*$

Url friendly name of parameter value.

data.​values[].​priorityinteger or null>= 1

Parameter value priority.

data.​values[].​colorstring(typeColor)^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$

Color hex code.

data.​values[].​imagestring or null[ 1 .. 255 ] characters

Image name. Image needs to exist in your file folder.

curl -i -X POST \
  https://api.myshoptet.com/api/products/filtering-parameters \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "name": "Materiál",
      "code": "material",
      "displayName": "Materiál",
      "description": "Popisek",
      "priority": 1,
      "googleMapping": "google:color",
      "values": [
        {
          "name": "Bavlna",
          "valueIndex": "bavlna",
          "priority": 1,
          "color": "FF00FF",
          "image": "car-001.jpg"
        }
      ]
    }
  }'

Responses

Created

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​idintegerrequired

Parameter id

data.​codestringrequired

Parameter code

data.​namestringrequired

Parameter name

data.​displayNamestring or nullrequired

Parameter display name

data.​descriptionstring or nullrequired

Parameter description

data.​priorityinteger or nullrequired

Parameter priority

data.​googleMappingobject or null(googleMappingType)required

Possible parameter mapping with google

data.​googleMapping.​valuestring

Code (identifier) of google mapping parameter

data.​googleMapping.​descriptionstring or null

Description (name) of google mapping parameter

data.​valuesArray of objects(productFilteringParameterValue)
errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "id": 1,
    "code": "material",
    "name": "Material",
    "displayName": "Material of product",
    "description": "Material of product",
    "priority": 1,
    "googleMapping": { … },
    "values": [ … ]
  },
  "errors": [
    { … }
  ]
}

Detail of filtering parameter

Request

Path
codestringrequired
Example: material
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  'https://api.myshoptet.com/api/products/filtering-parameters/{code}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​idintegerrequired

Parameter id

data.​codestringrequired

Parameter code

data.​namestringrequired

Parameter name

data.​displayNamestring or nullrequired

Parameter display name

data.​descriptionstring or nullrequired

Parameter description

data.​priorityinteger or nullrequired

Parameter priority

data.​googleMappingobject or null(googleMappingType)required

Possible parameter mapping with google

data.​googleMapping.​valuestring

Code (identifier) of google mapping parameter

data.​googleMapping.​descriptionstring or null

Description (name) of google mapping parameter

data.​valuesArray of objects(productFilteringParameterValue)
errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "id": 1,
    "code": "material",
    "name": "Material",
    "displayName": "Material of product",
    "description": "Material of product",
    "priority": 1,
    "googleMapping": { … },
    "values": [ … ]
  },
  "errors": [
    { … }
  ]
}

Update of filtering parameter

Request

Path
codestringrequired
Example: material
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectnon-emptyrequired
data.​namestring[ 1 .. 255 ] characters

Parameter name

data.​codestring[ 1 .. 255 ] characters^[a-zA-Z0-9\-]*$

Url friendly name of parameter. When changed, in next API call you must use the new parameter code.

data.​displayNamestring or null[ 1 .. 255 ] characters

Parameter display name

data.​descriptionstring or nullnon-empty

Parameter description

data.​priorityinteger or null>= 1

Parameter priority

data.​googleMappingstring or null[ 1 .. 255 ] characters

Mapping for google.

curl -i -X PATCH \
  'https://api.myshoptet.com/api/products/filtering-parameters/{code}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "name": "Materiál",
      "code": "material",
      "displayName": "Materiál",
      "description": "Popisek",
      "priority": 1,
      "googleMapping": "google:color"
    }
  }'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​idintegerrequired

Parameter id

data.​codestringrequired

Parameter code

data.​namestringrequired

Parameter name

data.​displayNamestring or nullrequired

Parameter display name

data.​descriptionstring or nullrequired

Parameter description

data.​priorityinteger or nullrequired

Parameter priority

data.​googleMappingobject or null(googleMappingType)required

Possible parameter mapping with google

data.​googleMapping.​valuestring

Code (identifier) of google mapping parameter

data.​googleMapping.​descriptionstring or null

Description (name) of google mapping parameter

data.​valuesArray of objects(productFilteringParameterValue)
errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "id": 1,
    "code": "material",
    "name": "Material",
    "displayName": "Material of product",
    "description": "Material of product",
    "priority": 1,
    "googleMapping": { … },
    "values": [ … ]
  },
  "errors": [
    { … }
  ]
}

Creation of filtering parameter value

Request

Path
codestringrequired
Example: material
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectrequired
data.​paramValuesArray of objects(productFilteringParameterValues)non-emptyrequired
data.​paramValues[].​namestring[ 1 .. 128 ] charactersrequired

Name of parameter value.

data.​paramValues[].​valueIndexstring or null[ 1 .. 255 ] characters^[a-zA-Z0-9\-]*$

Url friendly name of parameter value.

data.​paramValues[].​priorityinteger or null>= 1

Parameter value priority.

data.​paramValues[].​colorstring(typeColor)^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$

Color hex code.

data.​paramValues[].​imagestring or null[ 1 .. 255 ] characters

Image name. Image needs to exist in your file folder.

curl -i -X POST \
  'https://api.myshoptet.com/api/products/filtering-parameters/{code}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "paramValues": [
        {
          "name": "Bavlna",
          "valueIndex": "bavlna",
          "priority": 1,
          "color": "FF00FF",
          "image": "car-001.jpg"
        }
      ]
    }
  }'

Responses

Created

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​idintegerrequired

Parameter id

data.​codestringrequired

Parameter code

data.​namestringrequired

Parameter name

data.​displayNamestring or nullrequired

Parameter display name

data.​descriptionstring or nullrequired

Parameter description

data.​priorityinteger or nullrequired

Parameter priority

data.​googleMappingobject or null(googleMappingType)required

Possible parameter mapping with google

data.​googleMapping.​valuestring

Code (identifier) of google mapping parameter

data.​googleMapping.​descriptionstring or null

Description (name) of google mapping parameter

data.​valuesArray of objects(productFilteringParameterValue)
errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "id": 1,
    "code": "material",
    "name": "Material",
    "displayName": "Material of product",
    "description": "Material of product",
    "priority": 1,
    "googleMapping": { … },
    "values": [ … ]
  },
  "errors": [
    { … }
  ]
}

Removal of filtering parameter

Request

Path
codestringrequired
Example: strih-2
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X DELETE \
  'https://api.myshoptet.com/api/products/filtering-parameters/{code}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
datanullrequired
errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": null,
  "errors": [
    { … }
  ]
}

Removal of filtering parameter value

Request

Path
codestringrequired
Example: pohlavi
valueIndexstringrequired
Example: muz
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X DELETE \
  'https://api.myshoptet.com/api/products/filtering-parameters/{code}/{valueIndex}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
datanullrequired
errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": null,
  "errors": [
    { … }
  ]
}

Update of filtering parameter value

Request

Path
codestringrequired
Example: material
valueIndexstringrequired
Example: bavlna
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectnon-emptyrequired
data.​namestring[ 1 .. 128 ] characters

Name of parameter value.

data.​valueIndexstring or null[ 1 .. 255 ] characters^[a-zA-Z0-9\-]*$

Url friendly name of parameter value.

data.​priorityinteger or null>= 1

Parameter value priority.

data.​colorstring(typeColor)^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$

Color hex code.

data.​imagestring or null[ 1 .. 255 ] characters

Image name. Image needs to exist in your file folder.

curl -i -X PATCH \
  'https://api.myshoptet.com/api/products/filtering-parameters/{code}/{valueIndex}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "name": "Bavlna",
      "valueIndex": "bavlna",
      "priority": 1,
      "color": "FF00FF",
      "image": "car-001.jpg"
    }
  }'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​idintegerrequired

Parameter id

data.​codestringrequired

Parameter code

data.​namestringrequired

Parameter name

data.​displayNamestring or nullrequired

Parameter display name

data.​descriptionstring or nullrequired

Parameter description

data.​priorityinteger or nullrequired

Parameter priority

data.​googleMappingobject or null(googleMappingType)required

Possible parameter mapping with google

data.​googleMapping.​valuestring

Code (identifier) of google mapping parameter

data.​googleMapping.​descriptionstring or null

Description (name) of google mapping parameter

data.​valuesArray of objects(productFilteringParameterValue)
errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "id": 1,
    "code": "material",
    "name": "Material",
    "displayName": "Material of product",
    "description": "Material of product",
    "priority": 1,
    "googleMapping": { … },
    "values": [ … ]
  },
  "errors": [
    { … }
  ]
}

List of variant parameters

Request

Returns the list of available variant parameters with their available values within the e-shop.

List of variant parameters endpoint has section, which is only sent when requested in the include parameter.

Value | Section

--------|------

values | Variant parameter values

Query
includestring

Optional parts of response

Example: include=values
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  'https://api.myshoptet.com/api/products/variant-parameters?include=string' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​parametersArray of objectsrequired
data.​parameters[].​idintegerrequired

ID of the parameter

data.​parameters[].​paramNamestring or nullrequired

name of the parameter

data.​parameters[].​paramIndexstringrequired

index of the parameter (identifier)

data.​parameters[].​priorityinteger or nullrequired

priority of the parameter

data.​parameters[].​valuesArray of objects(productVariantParameterValue)

Possible parameter values

data.​paginatorobject(paginator)required
data.​paginator.​totalCountintegerrequired

total number of available records

data.​paginator.​pageintegerrequired

current page

data.​paginator.​pageCountintegerrequired

total available of pages

data.​paginator.​itemsOnPageintegerrequired

number of currently returned records

data.​paginator.​itemsPerPageintegerrequired

required number of records per page

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "parameters": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ]
}

Creation of variant parameter

Request

Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectrequired
data.​paramNamestring[ 1 .. 255 ] charactersrequired

Name of parameter. Maximal length of 255 characters

data.​paramIndexstring or null[ 1 .. 255 ] characters^[a-zA-Z0-9\-]*$

Url friendly name of parameter. Maximal length of 255 characters.

data.​priorityinteger or null>= 1

Priority of parameter

data.​valuesArray of objects(productVariantParameterValues)
curl -i -X POST \
  https://api.myshoptet.com/api/products/variant-parameters \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "paramName": "Barevné spektrum",
      "paramIndex": "barevne-spektrum",
      "priority": 20,
      "values": [
        {
          "paramValue": "Red",
          "rawValue": "red",
          "color": "FF00FF",
          "image": "car-001.jpg",
          "valuePriority": 1
        }
      ]
    }
  }'

Responses

Created

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​idintegerrequired

ID of the parameter

data.​paramNamestring or nullrequired

name of the parameter

data.​paramIndexstringrequired

index of the parameter (identifier)

data.​priorityinteger or nullrequired

priority of the parameter

data.​valuesArray of objects(productVariantParameterValue)

Possible parameter values

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "id": 1,
    "paramName": "Color",
    "paramIndex": "color",
    "priority": 1,
    "values": [ … ]
  },
  "errors": [
    { … }
  ]
}

Detail of variant parameter

Request

Path
paramIndexstringrequired
Example: barva
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  'https://api.myshoptet.com/api/products/variant-parameters/{paramIndex}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​idintegerrequired

ID of the parameter

data.​paramNamestring or nullrequired

name of the parameter

data.​paramIndexstringrequired

index of the parameter (identifier)

data.​priorityinteger or nullrequired

priority of the parameter

data.​valuesArray of objects(productVariantParameterValue)

Possible parameter values

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "id": 1,
    "paramName": "Color",
    "paramIndex": "color",
    "priority": 1,
    "values": [ … ]
  },
  "errors": [
    { … }
  ]
}

Update of variant parameter

Request

Path
paramIndexstringrequired
Example: barva
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectnon-emptyrequired
data.​paramNamestring[ 1 .. 255 ] characters

Name of parameter value. Maximal length of 255 characters.

data.​paramIndexstring[ 1 .. 255 ] characters^[a-zA-Z0-9\-]*$

Url friendly name of parameter value. Maximal length of 255 characters. When changed, you must use the new paramIndex in the next API calls.

data.​priorityinteger>= 1

Parameter value priority.

curl -i -X PATCH \
  'https://api.myshoptet.com/api/products/variant-parameters/{paramIndex}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "paramName": "Color",
      "paramIndex": "color",
      "priority": 1
    }
  }'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​idintegerrequired

ID of the parameter

data.​paramNamestring or nullrequired

name of the parameter

data.​paramIndexstringrequired

index of the parameter (identifier)

data.​priorityinteger or nullrequired

priority of the parameter

data.​valuesArray of objects(productVariantParameterValue)

Possible parameter values

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "id": 1,
    "paramName": "Color",
    "paramIndex": "color",
    "priority": 1,
    "values": [ … ]
  },
  "errors": [
    { … }
  ]
}

Creation of variant parameter value

Request

Path
paramIndexstringrequired
Example: barevne-spektrum
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectrequired
data.​paramValuesArray of objects(productVariantParameterValues)non-emptyrequired
data.​paramValues[].​paramValuestring[ 1 .. 128 ] charactersrequired

Name of parameter value. Maximal length of 255 characters.

data.​paramValues[].​rawValuestring or null[ 1 .. 255 ] characters^[a-zA-Z0-9\-]*$

Url friendly name of parameter value. Maximal length of 255 characters.

data.​paramValues[].​colorstring(typeColor)^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$

Color hex code. Minimal length of 1 character. Maximal length of 8 characters.

data.​paramValues[].​imagestring or null[ 1 .. 255 ] characters

Image name. Image needs to exist in your file folder.

data.​paramValues[].​valuePriorityinteger or null>= 1

Parameter value priority.

curl -i -X POST \
  'https://api.myshoptet.com/api/products/variant-parameters/{paramIndex}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "paramValues": [
        {
          "paramValue": "Red",
          "rawValue": "red",
          "color": "FF00FF",
          "image": "car-001.jpg",
          "valuePriority": 1
        }
      ]
    }
  }'

Responses

Created

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​idintegerrequired

ID of the parameter

data.​paramNamestring or nullrequired

name of the parameter

data.​paramIndexstringrequired

index of the parameter (identifier)

data.​priorityinteger or nullrequired

priority of the parameter

data.​valuesArray of objects(productVariantParameterValue)

Possible parameter values

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "id": 1,
    "paramName": "Color",
    "paramIndex": "color",
    "priority": 1,
    "values": [ … ]
  },
  "errors": [
    { … }
  ]
}

Removal of variant parameter

Request

Path
paramIndexstringrequired
Example: strih
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X DELETE \
  'https://api.myshoptet.com/api/products/variant-parameters/{paramIndex}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
datanullrequired
errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": null,
  "errors": [
    { … }
  ]
}

Removal of variant parameter value

Request

Path
paramIndexstringrequired
Example: strih
rawValuestringrequired
Example: raminka
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X DELETE \
  'https://api.myshoptet.com/api/products/variant-parameters/{paramIndex}/{rawValue}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
datanullrequired
errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": null,
  "errors": [
    { … }
  ]
}

Update of variant parameter value

Request

Path
paramIndexstringrequired
Example: barva
rawValuestringrequired
Example: fialova
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectnon-emptyrequired
data.​paramValuestring[ 1 .. 128 ] characters

Name of parameter value. Maximal length of 255 characters.

data.​rawValuestring[ 1 .. 255 ] characters^[a-zA-Z0-9\-]*$

Url friendly name of parameter value. Maximal length of 255 characters. When changed, you must use the new rawValue in the next API calls.

data.​colorstring(typeColor)^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$

Color hex code. Minimal length of 1 character. Maximal length of 8 characters.

data.​imagestring or null[ 1 .. 255 ] characters

Image name. Image needs to exist in your file folder.

data.​valuePriorityinteger>= 1

Parameter value priority.

curl -i -X PATCH \
  'https://api.myshoptet.com/api/products/variant-parameters/{paramIndex}/{rawValue}' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "paramValue": "Červená",
      "rawValue": "cervena",
      "color": "FF00FF",
      "image": "car-001.jpg",
      "valuePriority": 1
    }
  }'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​idintegerrequired

ID of the parameter

data.​paramNamestring or nullrequired

name of the parameter

data.​paramIndexstringrequired

index of the parameter (identifier)

data.​priorityinteger or nullrequired

priority of the parameter

data.​valuesArray of objects(productVariantParameterValue)

Possible parameter values

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "id": 1,
    "paramName": "Color",
    "paramIndex": "color",
    "priority": 1,
    "values": [ … ]
  },
  "errors": [
    { … }
  ]
}

List of recycling fee categories

Request

Returns the list of recycling fee categories within the e-shop.

Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  https://api.myshoptet.com/api/products/recycling-fee-categories \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​recyclingFeeCategoriesArray of objects(recyclingFeeCategory)required
data.​recyclingFeeCategories[].​idintegerrequired

Recycling fee category id.

data.​recyclingFeeCategories[].​categorystringrequired

Recycling fee category name.

data.​recyclingFeeCategories[].​feestring or null(typePrice)^(-)?[0-9]+\.[0-9]{2}$required

Recycling fee amount.

data.​recyclingFeeCategories[].​unitanyrequired

Recycling fee unit.

Enum"pcs""kg"
data.​recyclingFeeCategories[].​currencystringrequired

Currency code of recycling fee.

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "recyclingFeeCategories": [ … ]
  },
  "errors": [
    { … }
  ]
}

List of product warranties

Request

Returns list of product warranties.

Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  https://api.myshoptet.com/api/products/warranties \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​warrantiesArray of objectsrequired
data.​warranties[].​idintegerrequired

Warranty id. Negative number indicates system warranties. Positive numbers are defined by customer.

data.​warranties[].​inMonthsinteger or nullrequired

Warranty length in months (can be null). Negative number (-1) means infinite (lifetime) warranty.

data.​warranties[].​descriptionstringrequired

Warranty description.

data.​warranties[].​systembooleanrequired

true- system warranties,false` - custom warranties.

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "warranties": [ … ]
  },
  "errors": [
    { … }
  ]
}

List of product alternative products

Request

Returns list of alternative products related to product defined by guid, list is ordered by priority parameter.

If Pair reciprocally option (Settings > Product > Related and Alternative products) is enabled, list of

items will be enriched by items that has called product in own alternative table.

Path
guidstringrequired

Product guid

Example: 93bc0dbe-7481-11e8-8216-002590dad85e
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  'https://api.myshoptet.com/api/products/{guid}/alternativeProducts' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​itemsArray of objects(relatedProduct)required
data.​items[].​guidstring(typeGuidUnlimited)<= 36 charactersrequired

related product identifier

data.​items[].​priorityintegerrequired

Priority of product in related products list

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "items": [ … ]
  },
  "errors": [
    { … }
  ]
}

Add alternative product

Request

This method add given product, defined with guid at the end of the alternative product list. After product

is successfully saved, complete list of alternative product is returned in response.

Path
guidstringrequired

Product guid

Example: 93bc0dbe-7481-11e8-8216-002590dad85e
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectrequired
data.​alternativeProductobjectrequired
data.​alternativeProduct.​guidstring(typeGuidUnlimited)<= 36 charactersrequired

GUID of new the alternative product

curl -i -X POST \
  'https://api.myshoptet.com/api/products/{guid}/alternativeProducts' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "alternativeProduct": {
        "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"
      }
    }
  }'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​itemsArray of objects(relatedProduct)required
data.​items[].​guidstring(typeGuidUnlimited)<= 36 charactersrequired

related product identifier

data.​items[].​priorityintegerrequired

Priority of product in related products list

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "items": [ … ]
  },
  "errors": [
    { … }
  ]
}

Set alternative products

Request

This method set given products (minimum 0, maximum 50), defined with guid to the alternative product list. After product

is successfully saved, complete list of alternative product is returned in response.

Path
guidstringrequired

Product guid

Example: 93bc0dbe-7481-11e8-8216-002590dad85e
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectrequired
data.​alternativeProductsArray of objects[ 0 .. 50 ] itemsrequired

Array of new alternative products, minimum 0 item, maximum 50 items on request

data.​alternativeProducts[].​guidstring(typeGuidUnlimited)<= 36 charactersrequired
curl -i -X PUT \
  'https://api.myshoptet.com/api/products/{guid}/alternativeProducts' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "alternativeProducts": [
        {
          "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"
        }
      ]
    }
  }'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​itemsArray of objects(relatedProduct)required
data.​items[].​guidstring(typeGuidUnlimited)<= 36 charactersrequired

related product identifier

data.​items[].​priorityintegerrequired

Priority of product in related products list

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "items": [ … ]
  },
  "errors": [
    { … }
  ]
}

List of product related products

Request

Returns list of related products related to product defined by guid, list is ordered by priority parameter.

If Pair reciprocally option (Settings > Product > Related and Alternative products) is enabled, list of

items will be enriched by items that has called product in own related table.

Path
guidstringrequired

Product guid

Example: 93bc0dbe-7481-11e8-8216-002590dad85e
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  'https://api.myshoptet.com/api/products/{guid}/relatedProducts' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​itemsArray of objects(relatedProduct)required
data.​items[].​guidstring(typeGuidUnlimited)<= 36 charactersrequired

related product identifier

data.​items[].​priorityintegerrequired

Priority of product in related products list

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "items": [ … ]
  },
  "errors": [
    { … }
  ]
}

Add related product

Request

This method add given product, defined with guid at the end of the related product list. After product

is successfully saved, complete list of related product is returned in response.

Path
guidstringrequired

Product guid

Example: 93bc0dbe-7481-11e8-8216-002590dad85e
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectrequired
data.​relatedProductobjectrequired
data.​relatedProduct.​guidstring(typeGuidUnlimited)<= 36 charactersrequired

Guid of new related product

curl -i -X POST \
  'https://api.myshoptet.com/api/products/{guid}/relatedProducts' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "relatedProduct": {
        "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"
      }
    }
  }'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​itemsArray of objects(relatedProduct)required
data.​items[].​guidstring(typeGuidUnlimited)<= 36 charactersrequired

related product identifier

data.​items[].​priorityintegerrequired

Priority of product in related products list

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "items": [ … ]
  },
  "errors": [
    { … }
  ]
}

Set related products

Request

This method set given products (minimum 0, maximum 50), defined with guid to the related product list. After product

is successfully saved, complete list of related product is returned in response.

Path
guidstringrequired

Product guid

Example: 93bc0dbe-7481-11e8-8216-002590dad85e
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectrequired
data.​relatedProductsArray of objects[ 0 .. 50 ] itemsrequired

Array of new related products, minimum 0 item, maximum 50 items on request

data.​relatedProducts[].​guidstring(typeGuidUnlimited)<= 36 charactersrequired

Guid of new related product

curl -i -X PUT \
  'https://api.myshoptet.com/api/products/{guid}/relatedProducts' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "relatedProducts": [
        {
          "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"
        }
      ]
    }
  }'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​itemsArray of objects(relatedProduct)required
data.​items[].​guidstring(typeGuidUnlimited)<= 36 charactersrequired

related product identifier

data.​items[].​priorityintegerrequired

Priority of product in related products list

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "items": [ … ]
  },
  "errors": [
    { … }
  ]
}

Add item to product-set

Request

This method adding product defined by product variant code to the bundle (product set). Product defined in url by guid, must be set as type : product-set. When successfully saved, complete list of products in the set is returned in response.

Path
guidstringrequired

Product guid - Must be product-set type.

Example: 93bc0dbe-7481-11e8-8216-002590dad85e
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectrequired
data.​setItemobjectrequired
data.​setItem.​codestringrequired

product variant identifier

data.​setItem.​amountstring or null(typePositiveAmount)^[0-9]+\.[0-9]{3}$required
curl -i -X POST \
  'https://api.myshoptet.com/api/products/{guid}/set' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "setItem": {
        "code": "0008",
        "amount": "1.000"
      }
    }
  }'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​itemsArray of arrays or null or null(productSet)required
errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "items": []
  },
  "errors": [
    { … }
  ]
}

Set product-set items

Request

This method set given products (minimum 0, maximum 50), defined by product variant code to the bundle of products (product-set). Product defined in url by guid, must be set as type : product-set. When successfully saved, complete list of products in the set is returned in response.

Path
guidstringrequired

Product guid - Must be product-set type.

Example: 93bc0dbe-7481-11e8-8216-002590dad85e
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectrequired
data.​setItemsArray of objects[ 0 .. 50 ] itemsrequired

Array of new products assigned to set, minimum 0 item, maximum 50 items on request

data.​setItems[].​codestringrequired

product variant identifier

data.​setItems[].​amountstring or null(typePositiveAmount)^[0-9]+\.[0-9]{3}$required
curl -i -X PUT \
  'https://api.myshoptet.com/api/products/{guid}/set' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "setItems": [
        {
          "code": "0008",
          "amount": "1.000"
        }
      ]
    }
  }'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​itemsArray of arrays or null or null(productSet)required
errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "items": []
  },
  "errors": [
    { … }
  ]
}

List of product units

Request

Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  https://api.myshoptet.com/api/products/units \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​unitsArray of objectsrequired
data.​units[].​idintegerrequired

Unit id. Negative number indicates system units. Positive numbers are defined by customer.

data.​units[].​namestringrequired

Unit name

data.​units[].​systembooleanrequired

true - system units, false - custom units.

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "units": [ … ]
  },
  "errors": [
    { … }
  ]
}

List of product gifts

Request

Returns list of gifts related (product variants) to product.

Path
guidstringrequired

Product guid

Example: 93bc0dbe-7481-11e8-8216-002590dad85e
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  'https://api.myshoptet.com/api/products/{guid}/gifts' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​itemsArray of objects(productGifts)required
data.​items[].​codestringrequired

product variant identifier

data.​items[].​priorityintegerrequired

variant priority

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "items": [ … ]
  },
  "errors": [
    { … }
  ]
}

Insertion gift product

Request

Path
guidstringrequired

Product guid

Example: 93bc0dbe-7481-11e8-8216-002590dad85e
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectrequired
data.​giftCodestringrequired

Code of product variant.

curl -i -X POST \
  'https://api.myshoptet.com/api/products/{guid}/gifts' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "giftCode": "0006"
    }
  }'

Responses

Created

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​itemsArray of objects(productGifts)required
data.​items[].​codestringrequired

product variant identifier

data.​items[].​priorityintegerrequired

variant priority

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "items": [ … ]
  },
  "errors": [
    { … }
  ]
}

Setting gifts to product

Request

Path
guidstringrequired

Product guid

Example: 93bc0dbe-7481-11e8-8216-002590dad85e
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
Bodyapplication/vnd.shoptet.v1.0+json
dataobjectrequired
data.​giftCodesArray of objects[ 1 .. 50 ] itemsrequired

array of gift codes.

data.​giftCodes[].​codestringrequired

Code of product variant.

curl -i -X PUT \
  'https://api.myshoptet.com/api/products/{guid}/gifts' \
  -H 'Content-Type: application/vnd.shoptet.v1.0+json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "giftCodes": [
        {
          "code": "0006"
        }
      ]
    }
  }'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​itemsArray of objects(productGifts)required
data.​items[].​codestringrequired

product variant identifier

data.​items[].​priorityintegerrequired

variant priority

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "items": [ … ]
  },
  "errors": [
    { … }
  ]
}

List of products reviews

Request

Returns list of product's reviews.

Query
dateFromstringrequired

Filter reviews with creation date after date

Example: dateFrom=2019-09-05T00:00:00%2B0000
dateTostringrequired

Filter reviews with creation date before date

Example: dateTo=2019-09-05T00:00:00%2B0000
changeTimeFromstringrequired

Filter reviews changed after this date (included)

Example: changeTimeFrom=2019-09-05T00:00:00%2B0000
productGuidstringrequired

Product identifier to filter reviews by.

Example: productGuid=91670fd3-5b3d-11e7-819d-002590dc5efc
orderCodestringrequired

Order identifier to filter reviews by.

Example: orderCode=2011000002
Headers
Content-Typestringrequired
Default application/vnd.shoptet.v1.0
curl -i -X GET \
  'https://api.myshoptet.com/api/products/reviews?changeTimeFrom=string&dateFrom=string&dateTo=string&orderCode=string&productGuid=string' \
  -H 'Content-Type: application/vnd.shoptet.v1.0' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/vnd.shoptet.v1.0+json; charset=utf-8
dataobjectrequired
data.​reviewsArray of objectsrequired
data.​reviews[].​guidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$required
data.​reviews[].​datestring or null(typeDateTime)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

review creation date.

data.​reviews[].​orderCodenull or stringrequired

Order code related to review. Can be null.

data.​reviews[].​ratingnumberrequired

Number from 1 to 5 representing starts of review's rating.

data.​reviews[].​productNamestringrequired

Product name related to review.

data.​reviews[].​productGuidstring(typeGuid)<= 36 characters^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$required

Product guid related to review.

data.​reviews[].​descriptionnull or stringrequired
data.​reviews[].​fullNamenull or stringrequired

Fullname of review's author. Can be null.

data.​reviews[].​emailnull or stringrequired

Email of the review author. If it's a registered customer and the review email is empty, it's filled with the customer's main account email. Can be null.

data.​reviews[].​customerGuidnull or stringrequired

Customer guid related to review. Can be null.

data.​reviews[].​authorizedbooleanrequired
data.​reviews[].​visiblebooleanrequired
data.​reviews[].​reactionobjectrequired
data.​reviews[].​reaction.​reactionCreatedstring or null(typeDateTime)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

Date of creation of reaction. Can be null.

data.​reviews[].​reaction.​reactionFullNamenull or stringrequired
data.​reviews[].​reaction.​reactionEmailnull or stringrequired
data.​reviews[].​reaction.​reactionTextnull or stringrequired
data.​reviews[].​updatedstring or null(typeDateTime)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

Timestamp whenever the rating is changed

data.​paginatorobject(paginator)required
data.​paginator.​totalCountintegerrequired

total number of available records

data.​paginator.​pageintegerrequired

current page

data.​paginator.​pageCountintegerrequired

total available of pages

data.​paginator.​itemsOnPageintegerrequired

number of currently returned records

data.​paginator.​itemsPerPageintegerrequired

required number of records per page

errorsArray of objects or null(Errors)required
errors[].​errorCodestringrequired

Short text error identification

errors[].​messagestringrequired

Descriptive error message

errors[].​instancestringrequired

Identification of the entity referenced

Response
application/vnd.shoptet.v1.0+json; charset=utf-8
{
  "data": {
    "reviews": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ]
}

Price lists

Price lists are used for setting up different prices for products for different customer groups.

Operations

Orders

Order endpoints are used for managing orders in the e-shop.

Operations

Invoices

Invoice endpoints are used for managing invoices in the e-shop.

Operations

Proforma invoices

Proforma invoice endpoints are used for managing proforma invoices in the e-shop.

The code (code) is the proforma invoice identifier. Although this is usually a number, it is necessary to take into account that this might also include

letters, a dash, etc.

Operations

Credit notes

Credit note endpoints are used for managing credit notes in the e-shop.

The code (code) is the credit note identifier. Although this is usually a number, it is necessary to take into account that this might also include

letters, a dash, etc.

Operations

Delivery notes

Delivery note endpoints are used for managing delivery notes in the e-shop.

The code (code) is the credit notes identifier. Although this is usually a number, it is necessary to take into account that this might also include

letters, a dash, etc.

Operations

Proof payments

The code (code) is the proof payments identifier. Although this is usually a number, it is necessary to take into account that this might also include letters, a dash, etc.

Operations

Stocks

Stock endpoints are used for managing stocks in the e-shop.

Operations

Suppliers

Supplier endpoints are used for managing suppliers in the e-shop.

Operations

Brands

Brand endpoints are used for managing brands in the e-shop.

Please note, the field code is deprecated - use indexName instead. Parameter code accepts both: guid string style, e.g. d467bfbe-4334-11ef-ad70-0242ac1f0005, and index name string style, e.g. willy-wonka. The index name string style is deprecated - use guid style.

Operations

Customers

Customer endpoints are used for managing customers in the e-shop.

Operations

Templates

In the last Shoptet version, it is not possible to change the e-shop design via API. However, it is possible to include HTML codes

into previously defined places. This enables the code or link to a file containing additional CSS styles or JavaScript codes to be entered.

The same functionality is now included within the e-shop administration (/admin/html-kody/, HTML code tab).

There are 3 possible locations, where HTML codes can be inserted:

  • common-header - the code will be inserted into each e-shop page header (<HEAD>)

  • common-footer - the code will be inserted into each e-shop page foot (before end </BODY>)

  • order-confirmed - the code will be inserted in the page confirming the order (the "thank you page")

The inserted codes may come from 3 sources, and they are included in the following order:

  1. Codes from addons (the addon defines HTML codes to be inserted for anybody, who installs the addon). If there are more of these, they are inserted progressively, the order cannot be relied upon.

  2. Codes entered via API. Each addon can insert only one code into each location. If there are more of these addons, the codes will be inserted progressively, one after another, the order cannot be relied upon.

  3. The code entered in the administration GUI (/admin/html-kody/, HTML code tab).

Operations

Payment gateways

API endpoints for integration of payment gateways.

If you are a Premium client, contact your Account or Onboarding manager. New payment gateway has to be approved by Shoptet and client needs to be familiar with the terms of payment in advance.

Operations

Webhooks

API endpoints for webhook servicing. It offers the possibility to read, add, change and delete the registered webhooks. Furthermore, it offers

a list of notifications about invoked webhooks and their status.

The webhooks are HTTP calls, which send HTTPs calls to registered subscribers if a specific event happens,

for example creating an order. Then the information, in JSON format, is delivered to the defined URL.


{
    "eshopId": 222651,
    "event": "order:create",
    "eventCreated": "2019-01-08T15:13:39+0100",
    "eventInstance": "2018000057"
}

The meaning of individual items:

  • eshopId - number of the e-shop, where the event happened

  • event - event which invoked the call (see code list Webhook event types)

  • eventCreated - accurate time, when the event happened

  • eventInstance - reference to a specified entity - according to the context, order number, invoice number, product GUID, etc.

For more information about the function of webhooks, see https://developers.shoptet.com/webhooks/.

Operations

Shipping methods

Shipping methods endpoints are used for managing shipping methods in the e-shop.

Operations

Shipping requests

Shipping requests endpoints are used for managing shipping requests in the e-shop.

Operations

Payment methods

Payment methods endpoints are used for managing payment methods in the e-shop.

Operations

Unsubscribed emails

This functionality allows you to manage a list of email addresses that opted out of receiving marketing communications in compliance with legal requirements, including the possibility of comparing any further mailings with this list to exclude opt-out contacts.

Operations

E-mail distribution lists

The functionality is subject to module activation Mass e-mailing within the e-shop. The addon using this endpoint must therefore have this module defined as dependency.

Operations

Discount coupons

Discount coupons endpoints are used for managing discount coupons in the e-shop.

Operations

X + Y discounts

X + Y discounts endpoints are used for managing X + Y discounts in the e-shop.

Operations

Articles

Article endpoints are used for managing articles in the e-shop.

Operations

Pages

Page endpoints are used for managing pages in the e-shop.

Operations

Discussions

Discussion endpoints are used for managing discussions in the e-shop.

Operations

Job endpoints

Job endpoints are used for managing asynchronous jobs in the e-shop.

Operations

Files

File endpoints are used for managing files in the e-shop.

Operations

System endpoints

This endpoints are used for obtaining information for endpoints in API.

Operations