![](\"https://www.mzv.cz/public/fe/30/dd/3705578_2234497__867990_sm.png\")
\n\nThis documentation provides information about the interface for developers who would like to gain access to Shoptet\ne-shops. For more information about Shoptet, see https://www.shoptet.cz/.\n\nThe API is available in two access modes:\n\n- for \"Shoptet partner” developers who create the interconnection with the services and extend the Shoptet system's\n functions for public usage. For more information about API and conditions, under which\n it can be used, see https://developers.shoptet.com/addons/.\n- direct private access to eshop data for eshop owner - available only for [Premium Members](https://www.shoptetpremium.cz/).\n See https://developers.shoptet.com/premium for more information about API access.\n# Basic principles\n\n## How to call API\n\nAPI supports communication in JSON format. The URL for calling API requests is https://api.myshoptet.com. The API calls\n(endpoints and message formats) are common for private as well as addons access, it however uses different authentication\nand authorization principles.\n\n### For Addons\n\nAPI is made to create the supplements for the Shoptet system and uses OAuth2 authorization principles.\nTo access the API it is necessary to implement a web service at your side, which will communicate with our OAuth server.\n\nIn 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.\nHere, you will find your clientID and addresses, from where you can call our OAuth server.\n\nThe 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.)\nIn 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.\nAt 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).\nThe `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`.\nSuch a request shall follow within the same script that received the `code`.\nDo 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.\nThe address for you to call, and an example of implementation, can be found in e-shop administration in the `Access to API` section.\n\nAs 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\nfor communication between the servers and for gaining the temporary token for access to API.\n\nIf you have successfully received an OAuth access token, your script must end with the HTTP status code “200”.\n\nNow 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.\n\nFrom your server, call `https://
+
+
+ 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](https://www.shoptetpremium.cz/).
+ 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://` endpoint.\n\n**Please note following rules**\n\n- `code` .. maxLength 10 characters\n\n- `email` .. maxLength 100 characters\n\n- `phone` .. maxLength 32 characters\n\n- `externalCode` .. maxLength 255 characters\n\n- `billingAddress.company` .. maxLength 100 characters\n\n- `billingAddress.fullName` .. maxLength 100 characters\n\n- `billingAddress.street` .. maxLength 100 characters\n\n- `billingAddress.houseNumber` .. maxLength 16 characters\n\n- `billingAddress.city` .. maxLength 100 characters\n\n- `billingAddress.district` .. maxLength 64 characters\n\n- `billingAddress.additional` .. maxLength 64 characters\n\n- `billingAddress.zip` .. maxLength 100 characters\n\n- `billingAddress.regionName` .. maxLength 128 characters\n\n- `billingAddress.regionShortcut` .. maxLength 16 characters\n\n- `billingAddress.companyId` .. maxLength 18 characters\n\n- `billingAddress.vatId` .. maxLength 16 characters\n\n- `billingAddress.taxId` .. maxLength 16 characters\n\n- `deliveryAddress.company` .. maxLength 255 characters\n\n- `deliveryAddress.fullName` .. maxLength 64 characters\n\n- `deliveryAddress.street` .. maxLength 100 characters\n\n- `deliveryAddress.houseNumber` .. maxLength 16 characters\n\n- `deliveryAddress.city` .. maxLength 100 characters\n\n- `deliveryAddress.district` .. maxLength 64 characters\n\n- `deliveryAddress.additional` .. maxLength 64 characters\n\n- `deliveryAddress.zip` .. maxLength 100 characters\n\n- `deliveryAddress.regionName` .. maxLength 128 characters\n\n- `deliveryAddress.regionShortcut` .. maxLength 16 characters\n\n- `notes.trackingNumber` .. maxLength 32 characters\n\n- `items.name` .. maxLength 250 characters\n\n- `items.variantName` .. maxLength 128 characters\n\n- `items.brand` .. maxLength 64 characters\n\n- `items.supplierName` .. maxLength 255 characters\n\n- `items.code` .. maxLength 64 characters\n\n- `items.additionalField` .. maxLength 255 characters\n\n- `items.amountUnit` .. maxLength 16 characters"
+ description: |-
+ This endpoint enables insert the order into Shoptet, which was created
+ in other system. You can use it for an import
+
+ from an older e-shop solution, or to transfer orders from external sales
+ channels.
+
+ A large amount of info can be set, but for regular usage only a few
+ attributes are needed. Values of other
+
+ attributes are added as per their default values. The detailed
+ information can be found in the right pane, after
+
+ clicking on title "Order insertion" above (search for "Request" and
+ "Attributes” sections).
+
+
+ Request is sent in JSON format in its body. Simple example (detailed
+ example can be found in call example in right pane):
+
+
+ ```
+
+ {
+ "data": {
+ "email": "foo@bar.cz",
+ "externalCode": "123",
+ "paymentMethodGuid": "6f2c8e36-3faf-11e2-a723-705ab6a2ba75",
+ "shippingGuid": "8921cdc1-051b-11e5-a8d3-ac162d8a2454",
+ "billingAddress": {
+ "fullName": "Jan Novák",
+ "street": "Rovná",
+ "city": "Rovina",
+ "zip": "12300"
+ },
+ "currency": {
+ "code": "CZK"
+ },
+ "items": [
+ {
+ "itemType": "product",
+ "code": "32/ZEL",
+ "vatRate": "21.00",
+ "itemPriceWithVat": "121.00"
+ },
+ {
+ "itemType": "billing",
+ "name": "Platba převodem",
+ "vatRate": "21.00",
+ "itemPriceWithVat": "0"
+ },
+ {
+ "itemType": "shipping",
+ "name": "PPL",
+ "vatRate": "21.00",
+ "itemPriceWithVat": "59.00"
+ }
+ ]
+ }
+ }
+
+ ```
+
+
+ Whether the field is mandatory, apart from the basic definition, also
+ depends on whether the order was created via the cash desk
+
+ (`cashDeskOrder: true`) or via e-shop. Some fields from invoicing,
+ delivery and contact data
+
+ are mandatory or optional, as per e-shop settings (see also e-shop
+ administration `Settings > Customers > Mandatory fields`).
+
+
+ When the order is created, it is checked, whether the e-shop includes
+ products with the respective code (can be suppressed with
+
+ GET parameter `suppressProductChecking=true`),
+
+ the products from the order are deducted from the stock (can be
+ suppressed with the GET parameter `suppressStockMovements=true`),
+ documentation is created for the order (can be suppressed with the GET parameter `suppressDocumentGeneration=true`),
+ a confirmation e-mail is sent (can be suppressed with the GET parameter
+ `suppressEmailSending=true`) and a webhook is executed for the new
+ order.
+
+ **Parameters `suppressProductChecking=true` and
+ `suppressStockMovements=true` are to be used only for orders that will
+ not be changed or deleted in the future.
+
+ Editing or deleting such an order can damage the consistency of
+ warehousing.**
+
+
+ Parameter `suppressHistoricalMandatoryFields=true` can be used to
+ disable mandatory fields checks, but only for "historical"
+
+ orders (`creationTime` is older than 24 hours). Keep in mind even
+ historical orders should be kept consistent and complete
+
+ as much as possible to allow their processing for statistics, volume
+ calculations etc.
+
+
+ Setting the mandatory items for invoicing and the delivery address can
+ be different between individual e-shops. The mandatory items corresponds
+ to the settings
+
+ for ordering from the basket.
+
+
+ Parameters `suppressHistoricalPaymentChecking` and
+ `suppressHistoricalShippingChecking` allow corresponding field
+ (`paymentMethodGuid` and/or `shippingGuid`)
+
+ to be `null`. In that case, if an billing/shipping item is provided in
+ `items` list, `name` field must be filled in that item.
+
+
+ To remove products from the stock, the shop (or product) setting as to
+ whether the inventory can be negative or not is respected.
+
+ If a negative value is not permitted for shopping and the order cannot
+ be covered from the current inventory, the order is not created and the
+ API
+
+ returns an error message in the `errors` field.
+
+
+ The order's minimum size or maximum number of items as per the settings
+ of e-shop are not checked.
+
+
+ The endpoint only checks the same parameters as the order detail.
+
+
+ The order can be inserted while using currencies setup in the eshop (see
+ `/api/eshop`). The exchange rate related to the
+
+ eshop default currency is optional. If not provided, the current eshop
+ exchange rate will be used.
+
+ For historical orders the exchange rate should be provided using the
+ historical value of the order's creation date.
+
+ Shoptet eshops do not store historical exchange rates.
+
+ Warning: for SK and CZ different exchange rate format is used. You
+ should use the same form as you get from the endpoint
+
+ `/api/eshop`. We will internally convert it to the correct format to be
+ compatible with eshop statistics calculations.
+
+ Because of the conversion, the value of `exchangeRate` in the response
+ will be different (inverse) to the one you had sent.
+
+
+ When entering the order, the initial welcome e-mail is always sent. Even
+ though the order status is set differently to the initial value,
+
+ the e-mail associated with a status change is not sent, but the system
+ welcome e-mail is (to e-shop operator and customer).
+
+
+ When creating the receipt (invoice, proforma invoice, delivery note) the
+ receipt is created with the current date and the 14 days due date, even
+ though
+
+ `creationTime` is given from the past.
+
+
+ Examples of how to work with the order and items statuses, and how to
+ ensure the correct insertion of a discount, can be found in a
+
+ separate [article at
+ developers.shoptet.com](https://developers.shoptet.com/api/documentation/creating-order/)
+
+
+ After the order is successfully created, you will receive a response
+ with a 201 code and a response structure matching the order detail,
+
+ which is returned by `/api/orders/` endpoint.
+
+
+ **Please note following rules**
+
+
+ - `code` .. maxLength 10 characters
+
+
+ - `email` .. maxLength 100 characters
+
+
+ - `phone` .. maxLength 32 characters
+
+
+ - `externalCode` .. maxLength 255 characters
+
+
+ - `billingAddress.company` .. maxLength 100 characters
+
+
+ - `billingAddress.fullName` .. maxLength 100 characters
+
+
+ - `billingAddress.street` .. maxLength 100 characters
+
+
+ - `billingAddress.houseNumber` .. maxLength 16 characters
+
+
+ - `billingAddress.city` .. maxLength 100 characters
+
+
+ - `billingAddress.district` .. maxLength 64 characters
+
+
+ - `billingAddress.additional` .. maxLength 64 characters
+
+
+ - `billingAddress.zip` .. maxLength 100 characters
+
+
+ - `billingAddress.regionName` .. maxLength 128 characters
+
+
+ - `billingAddress.regionShortcut` .. maxLength 16 characters
+
+
+ - `billingAddress.companyId` .. maxLength 18 characters
+
+
+ - `billingAddress.vatId` .. maxLength 16 characters
+
+
+ - `billingAddress.taxId` .. maxLength 16 characters
+
+
+ - `deliveryAddress.company` .. maxLength 255 characters
+
+
+ - `deliveryAddress.fullName` .. maxLength 64 characters
+
+
+ - `deliveryAddress.street` .. maxLength 100 characters
+
+
+ - `deliveryAddress.houseNumber` .. maxLength 16 characters
+
+
+ - `deliveryAddress.city` .. maxLength 100 characters
+
+
+ - `deliveryAddress.district` .. maxLength 64 characters
+
+
+ - `deliveryAddress.additional` .. maxLength 64 characters
+
+
+ - `deliveryAddress.zip` .. maxLength 100 characters
+
+
+ - `deliveryAddress.regionName` .. maxLength 128 characters
+
+
+ - `deliveryAddress.regionShortcut` .. maxLength 16 characters
+
+
+ - `notes.trackingNumber` .. maxLength 32 characters
+
+
+ - `items.name` .. maxLength 250 characters
+
+
+ - `items.variantName` .. maxLength 128 characters
+
+
+ - `items.brand` .. maxLength 64 characters
+
+
+ - `items.supplierName` .. maxLength 255 characters
+
+
+ - `items.code` .. maxLength 64 characters
+
+
+ - `items.additionalField` .. maxLength 255 characters
+
+
+ - `items.amountUnit` .. maxLength 16 characters
tags:
- Orders
parameters:
@@ -11593,14 +14079,50 @@ paths:
$ref: '#/components/schemas/Errors'
summary: 'List of all orders'
operationId: getListOfAllOrders
- description: "Using this endpoint, you can get list of all orders with detailed info of each order (like in Order Detail endpoint) asynchronously. See how [Asynchronous requests](https://developers.shoptet.com/asynchronous-requests/) work on our developer's portal.\n\nThe list may be filtered by date of creation and order code. The code is the order identifier. Although this is usually a number, it is necessary to take into account that this might also include letters, dash, etc.\n\nResponse will be in [jsonlines](https://jsonlines.org/) format with each order taking one line of output file. One order in response has the same format as order detail response (in `data` attribute)\n\nThis endpoint has several sections, which are exported only when requested in the `include` parameter (see [Requested sections](#section/basic-principles-of-working-with-api/Section-on-demand)).\n\nInclude parameter | Meaning\n--- | ---\n`notes` | Order remarks, including up to six additional fields, which can be freely used by e-shop for its individual needs. The field names can be defined in administration and this section returns their names.\n`images` | Order images\n`shippingDetails` | Transport details\n`stockLocation` | Position in the stock\n`surchargeParameters` | Item surcharge parameters\n`productFlags` | Item product flags\nResult file is compressed using GZIP."
+ description: |-
+ Using this endpoint, you can get list of all orders with detailed info of each order (like in Order Detail endpoint)
+ asynchronously. See how [Asynchronous requests](https://developers.shoptet.com/asynchronous-requests/) work on our
+ developer's portal.
+
+
+ The list may be filtered by date of creation and order code. The code is the order identifier. Although this is usually
+ a number, it is necessary to take into account that this might also include letters, dash, etc.
+
+
+ Response will be in [jsonlines](https://jsonlines.org/) format with each order taking one line of output file.
+ One order in response has the same format as order detail response (in `data` attribute)
+
+
+ This endpoint has several sections, which are exported only when requested in the `include` parameter (see
+ [Requested sections](#section/basic-principles-of-working-with-api/Section-on-demand)).
+
+
+ Include parameter | Meaning
+
+ --- | ---
+
+ `notes` | Order remarks, including up to six additional fields, which can be freely used by e-shop for its individual needs. The field names can be defined in administration and this section returns their names.
+
+ `images` | Order images
+
+ `shippingDetails` | Transport details
+
+ `stockLocation` | Position in the stock
+
+ `surchargeParameters` | Item surcharge parameters
+
+ `productFlags` | Item product flags
+
+ Result file is compressed using GZIP.
tags:
- Orders
parameters:
-
name: include
in: query
- description: 'Optional parts of response. Available values are `notes,images,shippingDetails,stockLocation,surchargeParameters`.'
+ description: |-
+ Optional parts of response. Available values are
+ `notes,images,shippingDetails,stockLocation,surchargeParameters`.
schema:
type: string
-
@@ -11618,7 +14140,9 @@ paths:
-
name: shippingCompanyCode
in: query
- description: 'Purchase order filtering, according to forwarder [company code](#tag/shipping-methods/getlistofshippingmethods).'
+ description: |-
+ Purchase order filtering, according to forwarder [company
+ code](#tag/shipping-methods/getlistofshippingmethods).
schema:
type: string
-
@@ -11630,13 +14154,17 @@ paths:
-
name: creationTimeFrom
in: query
- description: 'Purchase order filtering, according to date of creation. ISO 8601 format ("2017-12-12T22:08:01+0100").'
+ description: |-
+ Purchase order filtering, according to date of creation. ISO 8601
+ format ("2017-12-12T22:08:01+0100").
schema:
type: string
-
name: creationTimeTo
in: query
- description: 'Purchase order filtering, according to date of creation. ISO 8601 format ("2017-12-12T22:08:01+0100").'
+ description: |-
+ Purchase order filtering, according to date of creation. ISO 8601
+ format ("2017-12-12T22:08:01+0100").
schema:
type: string
-
@@ -11660,13 +14188,17 @@ paths:
-
name: email
in: query
- description: 'Purchase order filtering, according to customer e-mail. The accurate match is searched for, regardless of capitalization.'
+ description: |-
+ Purchase order filtering, according to customer e-mail. The accurate
+ match is searched for, regardless of capitalization.
schema:
type: string
-
name: phone
in: query
- description: 'Purchase order filtering, according to customer phone. International format only (+420123456789)'
+ description: |-
+ Purchase order filtering, according to customer phone. International
+ format only (+420123456789)
schema:
type: string
-
@@ -11678,19 +14210,25 @@ paths:
-
name: changeTimeFrom
in: query
- description: 'Purchase order filtering, according to date of last update. ISO 8601 format ("2017-12-12T22:08:01+0100").'
+ description: |-
+ Purchase order filtering, according to date of last update. ISO 8601
+ format ("2017-12-12T22:08:01+0100").
schema:
type: string
-
name: changeTimeTo
in: query
- description: 'Purchase order filtering, according to date of last update. ISO 8601 format ("2017-12-12T22:08:01+0100").'
+ description: |-
+ Purchase order filtering, according to date of last update. ISO 8601
+ format ("2017-12-12T22:08:01+0100").
schema:
type: string
-
name: sourceId
in: query
- description: 'Order source filtering according to source id. For more information, see List of order sources endpoint.'
+ description: |-
+ Order source filtering according to source id. For more information,
+ see List of order sources endpoint.
schema:
type: string
-
@@ -12175,7 +14713,105 @@ paths:
additionalProperties: false
summary: 'Order detail'
operationId: getOrderDetail
- description: "This endpoint has several sections, which are only sent when requested in the `include` parameter (see\n[Requested sections](#section/basic-principles-of-working-with-api/Section-on-demand)).\n\nValue | Section\n--------|------\n`notes` | Order remarks, including up to six additional fields, which can be freely used by e-shop for its individual needs. The field names can be defined in administration and this section returns their names.\n`images`| Order images\n`shippingDetails`| Transport details\n`stockLocation`| Position in the stock\n`surchargeParameters`| Item surcharge parameters\n`productFlags`| Item product flags\n\nReturns the detail for one order. In the `items` field, the individual items of the order, including transport and payment methods.\n\nThe product name and variants, weight, manufacturer and similar items are copied into the order items when the order is made.\n Even though the products are changed later in the shop, the orders are not affected. `productGuid` item contains\nGUID of purchased product. If this is changed or deleted, the order is not affected. You have to take into account that\n\n`productGuid` does not have to refer to an existing product. The same goes for the `code` item, containing the identification of a purchased\n\nvariant or product. You have to take into account that when deleting the product or changing the `code` of the product, the reference from the order\n\nis lost. In other words, you have to take into account the fact that the `code` or `productGuid` do not have to refer to one of the currently existing\n\nproducts (variant). They may also be `null`.\n\nIn most cases the items in the response are the same as you can see in the administration of PDF printout of an order.\n\nThere are however some advanced cases (in case of coupon discount with absolute value or in case of\n\na volume discount and products with multiple VAT rates in the order), in which case they are different:\n\n- Administration and PDF will show multiple rows for the discount – for each VAT rate one row and the price field split evenly.\n\n- The API response will return only one row indicating the total price of the discount.\n\nThe difference is based on how data is internally stored and presented. The API is bases more on internal storage principle,\n\nthere is however also an array `displayPrices`, which contains the presentation (printout) version of each item.\n\nIf you state the `include=images` parameter within the URL, the information about the main image for all products in the order\n will also be part of the response. For more information about access to images go to [Product images](#section/Product-images).\n\nIn the `shippingDetails` section, there is an information about shipping the order. `branchId` is used for the identification of the carrier's branch and\n\nnext fields are used for the detail of the branch (name, address, etc.). `carrierId` is used for the numeral identification of the carrier. Nowadays this field\n\nis used for Zasilkovna only and the value can be `null` for Czech Zasilkovna or integer for Zasilkovna in the other countries."
+ description: |-
+ This endpoint has several sections, which are only sent when requested
+ in the `include` parameter (see
+
+ [Requested sections](#section/basic-principles-of-working-with-api/Section-on-demand)).
+
+
+ Value | Section
+
+ --------|------
+
+ `notes` | Order remarks, including up to six additional fields, which
+ can be freely used by e-shop for its individual needs. The field names
+ can be defined in administration and this section returns their names.
+
+ `images`| Order images
+
+ `shippingDetails`| Transport details
+
+ `stockLocation`| Position in the stock
+
+ `surchargeParameters`| Item surcharge parameters
+
+ `productFlags`| Item product flags
+
+
+ Returns the detail for one order. In the `items` field, the individual
+ items of the order, including transport and payment methods.
+
+
+ The product name and variants, weight, manufacturer and similar items
+ are copied into the order items when the order is made.
+ Even though the products are changed later in the shop, the orders are not affected. `productGuid` item contains
+ GUID of purchased product. If this is changed or deleted, the order is
+ not affected. You have to take into account that
+
+
+ `productGuid` does not have to refer to an existing product. The same
+ goes for the `code` item, containing the identification of a purchased
+
+
+ variant or product. You have to take into account that when deleting the
+ product or changing the `code` of the product, the reference from the
+ order
+
+
+ is lost. In other words, you have to take into account the fact that the
+ `code` or `productGuid` do not have to refer to one of the currently
+ existing
+
+
+ products (variant). They may also be `null`.
+
+
+ In most cases the items in the response are the same as you can see in
+ the administration of PDF printout of an order.
+
+
+ There are however some advanced cases (in case of coupon discount with
+ absolute value or in case of
+
+
+ a volume discount and products with multiple VAT rates in the order), in
+ which case they are different:
+
+
+ - Administration and PDF will show multiple rows for the discount – for
+ each VAT rate one row and the price field split evenly.
+
+
+ - The API response will return only one row indicating the total price
+ of the discount.
+
+
+ The difference is based on how data is internally stored and presented.
+ The API is bases more on internal storage principle,
+
+
+ there is however also an array `displayPrices`, which contains the
+ presentation (printout) version of each item.
+
+
+ If you state the `include=images` parameter within the URL, the
+ information about the main image for all products in the order
+ will also be part of the response. For more information about access to images go to [Product images](#section/Product-images).
+
+
+ In the `shippingDetails` section, there is an information about shipping
+ the order. `branchId` is used for the identification of the carrier's
+ branch and
+
+
+ next fields are used for the detail of the branch (name, address, etc.).
+ `carrierId` is used for the numeral identification of the carrier.
+ Nowadays this field
+
+
+ is used for Zasilkovna only and the value can be `null` for Czech
+ Zasilkovna or integer for Zasilkovna in the other countries.
tags:
- Orders
parameters:
@@ -12728,7 +15364,60 @@ paths:
additionalProperties: false
summary: 'Order head change'
operationId: updateOrderHead
- description: "You can change basic info (head) of order with this method.\n\n**Please note following rules**\n\n- `email` .. maxLength 100 characters\n\n- `phone` .. maxLength 32 characters\n\n- `billingAddress.company` .. maxLength 100 characters\n\n- `billingAddress.fullName` .. maxLength 100 characters\n\n- `billingAddress.street` .. maxLength 100 characters\n\n- `billingAddress.houseNumber` .. maxLength 16 characters\n\n- `billingAddress.city` .. maxLength 100 characters\n\n- `billingAddress.district` .. maxLength 64 characters\n\n- `billingAddress.additional` .. maxLength 64 characters\n\n- `billingAddress.zip` .. maxLength 100 characters\n\n- `billingAddress.regionName` .. maxLength 128 characters\n\n- `billingAddress.regionShortcut` .. maxLength 16 characters\n\n- `billingAddress.companyId` .. maxLength 18 characters\n\n- `billingAddress.vatId` .. maxLength 16 characters\n\n- `billingAddress.taxId` .. maxLength 16 characters\n\n- `deliveryAddress.company` .. maxLength 255 characters\n\n- `deliveryAddress.fullName` .. maxLength 64 characters\n\n- `deliveryAddress.street` .. maxLength 100 characters\n\n- `deliveryAddress.houseNumber` .. maxLength 16 characters\n\n- `deliveryAddress.city` .. maxLength 100 characters\n\n- `deliveryAddress.district` .. maxLength 64 characters\n\n- `deliveryAddress.additional` .. maxLength 64 characters\n\n- `deliveryAddress.zip` .. maxLength 100 characters\n\n- `deliveryAddress.regionName` .. maxLength 128 characters\n\n- `deliveryAddress.regionShortcut` .. maxLength 16 characters"
+ description: |-
+ You can change basic info (head) of order with this method.
+
+ **Please note following rules**
+
+ - `email` .. maxLength 100 characters
+
+ - `phone` .. maxLength 32 characters
+
+ - `billingAddress.company` .. maxLength 100 characters
+
+ - `billingAddress.fullName` .. maxLength 100 characters
+
+ - `billingAddress.street` .. maxLength 100 characters
+
+ - `billingAddress.houseNumber` .. maxLength 16 characters
+
+ - `billingAddress.city` .. maxLength 100 characters
+
+ - `billingAddress.district` .. maxLength 64 characters
+
+ - `billingAddress.additional` .. maxLength 64 characters
+
+ - `billingAddress.zip` .. maxLength 100 characters
+
+ - `billingAddress.regionName` .. maxLength 128 characters
+
+ - `billingAddress.regionShortcut` .. maxLength 16 characters
+
+ - `billingAddress.companyId` .. maxLength 18 characters
+
+ - `billingAddress.vatId` .. maxLength 16 characters
+
+ - `billingAddress.taxId` .. maxLength 16 characters
+
+ - `deliveryAddress.company` .. maxLength 255 characters
+
+ - `deliveryAddress.fullName` .. maxLength 64 characters
+
+ - `deliveryAddress.street` .. maxLength 100 characters
+
+ - `deliveryAddress.houseNumber` .. maxLength 16 characters
+
+ - `deliveryAddress.city` .. maxLength 100 characters
+
+ - `deliveryAddress.district` .. maxLength 64 characters
+
+ - `deliveryAddress.additional` .. maxLength 64 characters
+
+ - `deliveryAddress.zip` .. maxLength 100 characters
+
+ - `deliveryAddress.regionName` .. maxLength 128 characters
+
+ - `deliveryAddress.regionShortcut` .. maxLength 16 characters
tags:
- Orders
parameters:
@@ -13748,7 +16437,9 @@ paths:
-
name: id
in: path
- description: 'order item id. Can be found in field `data.order.items.itemId` in Order detail. (number)'
+ description: |-
+ order item id. Can be found in field `data.order.items.itemId` in
+ Order detail. (number)
required: true
example: '198'
schema:
@@ -13960,7 +16651,9 @@ paths:
-
name: id
in: path
- description: 'order item id. Can be found in field `data.order.items.itemId` in Order detail. (number)'
+ description: |-
+ order item id. Can be found in field `data.order.items.itemId` in
+ Order detail. (number)
required: true
example: '198'
schema:
@@ -14447,7 +17140,33 @@ paths:
additionalProperties: false
summary: 'Order item surcharge parameters insertion'
operationId: createOrderItemSurchargeParameters
- description: "There is possibility to edit surcharge parameters related to order item. For that purpose, there is in get order item detail endpoint attribute `specificSurchargeParameters` which returned adjusted surcharge parameters data (see order item detail [endpoint](#tag/orders/getorderdetail))\n\nThis mean that `surchargeParameters` attribute in order detail is persistent and any adjustment in surcharge parameters appears in `specificSurchargeParameters`\n\nThis endpoint purpose is to add surcharge parameter in relation within order item.\nYou have to send one of attributes `parameterCode` with `valueIndex` or `name`. Cant send this attributes together.\nIf you post `parameterCode` and `valueIndex`, there will be validation, if surcharge parameter exits and if can be related\nto order item's product and price (if not send) will be added from surcharge parameter itself.\n\nOtherwise you can send attribute `name` instead, which could have any form, but has to be unique. If price is not send,\nthan it will be set to `0.00`."
+ description: |-
+ There is possibility to edit surcharge parameters related to order item. For that purpose, there is in
+ get order item detail endpoint attribute `specificSurchargeParameters` which returned adjusted surcharge
+ parameters data (see order item detail [endpoint](#tag/orders/getorderdetail))
+
+
+ This mean that `surchargeParameters` attribute in order detail is persistent and any adjustment in
+ surcharge parameters appears in `specificSurchargeParameters`
+
+
+ This endpoint purpose is to add surcharge parameter in relation within
+ order item.
+
+ You have to send one of attributes `parameterCode` with `valueIndex` or
+ `name`. Cant send this attributes together.
+
+ If you post `parameterCode` and `valueIndex`, there will be validation,
+ if surcharge parameter exits and if can be related
+
+ to order item's product and price (if not send) will be added from
+ surcharge parameter itself.
+
+
+ Otherwise you can send attribute `name` instead, which could have any
+ form, but has to be unique. If price is not send,
+
+ than it will be set to `0.00`.
tags:
- Orders
parameters:
@@ -14535,7 +17254,9 @@ paths:
additionalProperties: false
summary: 'Order item surcharge parameters deletion'
operationId: deleteOrderItemSurchargeParameters
- description: 'You have to provide dynamically generated `relationId` which identify which surcharge parameter related to order item you want to delete.'
+ description: |-
+ You have to provide dynamically generated `relationId` which identify
+ which surcharge parameter related to order item you want to delete.
tags:
- Orders
parameters:
@@ -14558,7 +17279,9 @@ paths:
-
name: relationId
in: path
- description: 'key to identify, which surcharge parameter in relation to order item, should be delete'
+ description: |-
+ key to identify, which surcharge parameter in relation to order
+ item, should be delete
required: true
example: '04e876'
schema:
@@ -15864,11 +18587,18 @@ paths:
errors:
-
errorCode: document-not-generated
- message: 'Error while getting document type "order" with code "2018000004".'
+ message: |-
+ Error while getting document type "order" with code
+ "2018000004".
instance: '2018000004'
summary: 'Download order as PDF'
operationId: downloadOrderAsPdf
- description: "You can request the order as PDF file, response will be as application/octet-stream. You can download pdf documents\nonly one-by-one for every e-shop. Parallel requests end with `423 Locked` error."
+ description: |-
+ You can request the order as PDF file, response will be as
+ application/octet-stream. You can download pdf documents
+
+ only one-by-one for every e-shop. Parallel requests end with `423
+ Locked` error.
tags:
- Orders
parameters:
@@ -15960,7 +18690,18 @@ paths:
additionalProperties: false
summary: 'List of remarks for the order'
operationId: getListOfRemarksForOrder
- description: "The endpoint shows the order history which is displayed in Shoptet administration in the\n“History” tab, in the order detail. Thus they are the most important system actions that have affected the order (they cannot be\nchanged by the user) and then the notes added by the e-shop, primarily intended as messages between several employees,\nwhich may be needed to coordinate the order processing (these can be entered and deleted by the user)."
+ description: |-
+ The endpoint shows the order history which is displayed in Shoptet
+ administration in the
+
+ “History” tab, in the order detail. Thus they are the most important
+ system actions that have affected the order (they cannot be
+
+ changed by the user) and then the notes added by the e-shop, primarily
+ intended as messages between several employees,
+
+ which may be needed to coordinate the order processing (these can be
+ entered and deleted by the user).
tags:
- Orders
parameters:
@@ -16021,7 +18762,7 @@ paths:
-
errorCode: order-history-item-exceeded-limit
message: 'Order history item count limit exceeded (100) for order "2018000012".'
- instance: 2018000012
+ instance: '2018000012'
404:
description: 'Not Found'
content:
@@ -16042,7 +18783,19 @@ paths:
instance: '2018000012'
summary: 'Insertion of remark to order'
operationId: createOrderRemark
- description: "This endpoint may be used to add the user remark into the order history.\nFor example the payment gateway may give the payment identification at its side, or\nadd the remarks during the process of payment or order processing. The remarks\nare displayed in administration, in the “History” tab, in the order detail,\ntogether with main system changes of the order."
+ description: |-
+ This endpoint may be used to add the user remark into the order history.
+
+ For example the payment gateway may give the payment identification at
+ its side, or
+
+ add the remarks during the process of payment or order processing. The
+ remarks
+
+ are displayed in administration, in the “History” tab, in the order
+ detail,
+
+ together with main system changes of the order.
tags:
- Orders
parameters:
@@ -16114,7 +18867,7 @@ paths:
-
errorCode: order-history-deletion-failed
message: 'Cannot delete order history item "2073".'
- instance: 2073
+ instance: '2073'
summary: 'Delete order history item'
operationId: deleteOrderHistoryItem
description: 'Delete order history item by primary key.'
@@ -16181,7 +18934,38 @@ paths:
instance: '2018000012'
summary: 'Update remarks for the order'
operationId: updateRemarksForOrder
- description: "The endpoint enables the remarks and additional fields (index 1 - 6) to be updated for the order. Within a call, the update\nof more data can be called for.\n\nThe individual data object keys are not optional. Only the key values, which are included in the data object, will be updated.\n\nIf \"customerRemark\", \"trackingNumber\", \"eshopRemark\" have a value of NULL, the originally saved value will be deleted.\n\nFor additional fields (\"additionalFields” key) only the fields included in this field are updated.\n\nIf the key value is \"text\" for NULL additional field, the originally saved text in this field will be deleted.\n\nIf the non-existing key is entered, or the call is erroneous in another way, no item is updated.\n\n**Please note that `trackingNumber` cannot be longer than 32 characters.**\n**Please note that `additionalField` with index 1, 2 & 3 cannot be longer than 255 characters.**"
+ description: |-
+ The endpoint enables the remarks and additional fields (index 1 - 6) to
+ be updated for the order. Within a call, the update
+
+ of more data can be called for.
+
+
+ The individual data object keys are not optional. Only the key values,
+ which are included in the data object, will be updated.
+
+
+ If "customerRemark", "trackingNumber", "eshopRemark" have a value of
+ NULL, the originally saved value will be deleted.
+
+
+ For additional fields ("additionalFields” key) only the fields included
+ in this field are updated.
+
+
+ If the key value is "text" for NULL additional field, the originally
+ saved text in this field will be deleted.
+
+
+ If the non-existing key is entered, or the call is erroneous in another
+ way, no item is updated.
+
+
+ **Please note that `trackingNumber` cannot be longer than 32
+ characters.**
+
+ **Please note that `additionalField` with index 1, 2 & 3 cannot be
+ longer than 255 characters.**
tags:
- Orders
parameters:
@@ -16720,7 +19504,72 @@ paths:
instance: '2018000012'
summary: 'Update of order status'
operationId: updateOrderStatus
- description: "The endpoint enables the order status, “paid” flag and payment method to be updated. This data must be set during a call.\nAll the fields to be updated are optional, but at least one has to be specified.\n\nIf the key value is \"text\" for NULL additional field, the originally saved text in this field will be deleted.\n\nIf a non-existing key is entered, or the call is erroneous in another way, no item is updated.\n\nIf you call the status setting within your request, which has \"set the order as paid\" in the definition, and at the same time you required\na change of `paid` to `false`, the order status will be carried out and the `paid` value set to `false`.\n\nIf the status definition includes sending an e-mail, such an e-mail will be sent. If not required, sending an e-mail can be suppressed with the\n`?suppressEmailSending=true` parameter. Similarly, sending information SMS messages when the order is changed (if set) can be suppressed\n with the `?suppressSmsSending=true` parameter. In analogy, if the status includes document generation (for example a proforma invoice),\nthe document will be generated (if not existent). The generation can be suppressed with the `?suppressDocumentGeneration=true` parameter.\n\nThis endpoint tries not to unnecessarily change the order status. If you try to set the status that the order already has, no change is done and no document is generated.\nWhen calling the same requests in parallel, there is the risk that there may be concurrence and related actions may be executed twice. Therefore we recommend calling this request from one source only, in a serial manner.\n\nOrder status change might imply automatic documents (e. g. invoice) generation. In exceptional cases the generation might fail,\nalthough the order status itself gets actually changed. In such case the API return status code 200 (OK), but in the `data` field\nyou can find the order details and in the `errors` array eventually details about the failed documents generation. The error\ncode is `document-not-generated`. Example of an error message:\n\n```\n\"errors\": [\n {\n \"errorCode\": \"document-not-generated\",\n \"message\": \"Delivery note belonging to order \\\"2020000149\\\" was not created. Generating document code failed.\",\n \"instance\": \"2020000149\"\n }\n]\n```"
+ description: |-
+ The endpoint enables the order status, “paid” flag and payment method to
+ be updated. This data must be set during a call.
+
+ All the fields to be updated are optional, but at least one has to be
+ specified.
+
+
+ If the key value is "text" for NULL additional field, the originally
+ saved text in this field will be deleted.
+
+
+ If a non-existing key is entered, or the call is erroneous in another
+ way, no item is updated.
+
+
+ If you call the status setting within your request, which has "set the
+ order as paid" in the definition, and at the same time you required
+
+ a change of `paid` to `false`, the order status will be carried out and
+ the `paid` value set to `false`.
+
+
+ If the status definition includes sending an e-mail, such an e-mail will
+ be sent. If not required, sending an e-mail can be suppressed with the
+
+ `?suppressEmailSending=true` parameter. Similarly, sending information
+ SMS messages when the order is changed (if set) can be suppressed
+ with the `?suppressSmsSending=true` parameter. In analogy, if the status includes document generation (for example a proforma invoice),
+ the document will be generated (if not existent). The generation can be
+ suppressed with the `?suppressDocumentGeneration=true` parameter.
+
+
+ This endpoint tries not to unnecessarily change the order status. If you
+ try to set the status that the order already has, no change is done and
+ no document is generated.
+
+ When calling the same requests in parallel, there is the risk that there
+ may be concurrence and related actions may be executed twice. Therefore
+ we recommend calling this request from one source only, in a serial
+ manner.
+
+
+ Order status change might imply automatic documents (e. g. invoice)
+ generation. In exceptional cases the generation might fail,
+
+ although the order status itself gets actually changed. In such case the
+ API return status code 200 (OK), but in the `data` field
+
+ you can find the order details and in the `errors` array eventually
+ details about the failed documents generation. The error
+
+ code is `document-not-generated`. Example of an error message:
+
+
+ ```
+
+ "errors": [
+ {
+ "errorCode": "document-not-generated",
+ "message": "Delivery note belonging to order \"2020000149\" was not created. Generating document code failed.",
+ "instance": "2020000149"
+ }
+ ]
+
+ ```
tags:
- Orders
parameters:
@@ -17015,7 +19864,19 @@ paths:
additionalProperties: false
summary: 'Last order changes'
operationId: getLastOrderChanges
- description: "The Endpoint is intended to determine the changes after you have loaded the complete list of orders and you need to know, if any of these has been changed (or deleted). Guaranteed history is 30 days, the older data are deleted progressively.\n\nEach order in the log is only mentioned with its last change. For example, if the order was modified and then deleted, the log will only show information about its deletion.\n\nCreation is considered as `edit` action. So, when there is a new item created, it will be displayed like `edit` action.\n\nEndpoint supports [pagination](#section/basic-principles-of-working-with-api/Paging)."
+ description: |-
+ The Endpoint is intended to determine the changes after you have loaded the complete list of orders and you need to know,
+ if any of these has been changed (or deleted). Guaranteed history is 30 days, the older data are deleted progressively.
+
+
+ Each order in the log is only mentioned with its last change. For example, if the order was modified and then deleted,
+ the log will only show 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](#section/basic-principles-of-working-with-api/Paging).
tags:
- Orders
parameters:
@@ -17057,7 +19918,9 @@ paths:
additionalProperties: false
summary: 'Get order gifts list'
operationId: getOrderGiftsList
- description: 'This endpoint allow get, add or delete order related gifts. Gifts is relation to product variant by its `code` identifier and is ordered by `priority` field'
+ description: |-
+ This endpoint allow get, add or delete order related gifts. Gifts is relation to product variant by its
+ `code` identifier and is ordered by `priority` field
tags:
- Orders
parameters:
@@ -17090,7 +19953,11 @@ paths:
additionalProperties: false
summary: 'Add order gift at the end of the list'
operationId: addOrderGift
- description: "Add order gift (product variant) at the end of the order gift list. Gift is defined by `code`.\n`code`, `orderPrice` and `currencyCode` is required."
+ description: |-
+ Add order gift (product variant) at the end of the order gift list. Gift
+ is defined by `code`.
+
+ `code`, `orderPrice` and `currencyCode` is required.
tags:
- Orders
requestBody:
@@ -17211,7 +20078,12 @@ paths:
additionalProperties: false
summary: 'Get order gift settings'
operationId: getOrderGiftSettings
- description: "There are order gift setting, which influence general behaviour.\n- The behavior of the gifts - set if gifts are dependent on each product or whole order (stock dependent/independent) - Offer to wholesale customers - define if customer with wholesale module have gifts offer available - Gift to whole order or each product"
+ description: |-
+ There are order gift setting, which influence general behaviour.
+
+ - The behavior of the gifts - set if gifts are dependent on each product or whole order (stock dependent/independent)
+ - Offer to wholesale customers - define if customer with wholesale module have gifts offer available
+ - Gift to whole order or each product
tags:
- Orders
parameters:
@@ -17257,7 +20129,9 @@ paths:
additionalProperties: false
summary: 'Update order gift settings'
operationId: updateOrderGiftSettings
- description: 'Method updates order gift settings. Every item in request body is optional, but at least one setting is required.'
+ description: |-
+ Method updates order gift settings. Every item in request body is
+ optional, but at least one setting is required.
tags:
- Orders
requestBody:
@@ -17396,7 +20270,14 @@ paths:
additionalProperties: false
summary: 'List of invoices'
operationId: getListOfInvoices
- description: "Returns the list of invoices with basic information. The list of invoices supports [paging](#section/basic-principles-of-working-with-api/Paging)\n\nThe code (`code`) is the invoice identifier. Although this is usually a number, it is necessary to take into account that this might also include letters, a dash, etc. Filtering uses string comparison with >=, <= operators."
+ description: |-
+ Returns the list of invoices with basic information.
+ The list of invoices supports [paging](#section/basic-principles-of-working-with-api/Paging)
+
+
+ The code (`code`) is the invoice identifier. Although this is usually a number,
+ it is necessary to take into account that this might also include
+ letters, a dash, etc. Filtering uses string comparison with >=, <= operators.
tags:
- Invoices
parameters:
@@ -17479,7 +20360,28 @@ paths:
type: string
summary: 'List of all invoices'
operationId: getListOfAllInvoices
- description: "Using this endpoint, you can get list of all invoices with detailed info of each invoice (like in Invoice Detail endpoint) asynchronously. See how [Asynchronous requests](https://developers.shoptet.com/asynchronous-requests/) work on our developer's portal.\n\nResponse will be in [jsonlines](https://jsonlines.org/) format with each product taking one line of output file. One invoice in response has the same format as invoice detail response.\n\nResult file is compressed using GZIP.\n\nThis endpoint has several sections, which are only sent when requested in the `include` parameter (see [Requested sections](#section/basic-principles-of-working-with-api/Section-on-demand)).\n\nValue | Section\n--------|------\n`surchargeParameters`| Item surcharge parameters"
+ description: |-
+ Using this endpoint, you can get list of all invoices with detailed info of each invoice (like in Invoice Detail endpoint)
+ asynchronously. See how [Asynchronous requests](https://developers.shoptet.com/asynchronous-requests/) work on our
+ developer's portal.
+
+
+ Response will be in [jsonlines](https://jsonlines.org/) format with each product taking one line of output file.
+ One invoice in response has the same format as invoice detail response.
+
+
+ Result file is compressed using GZIP.
+
+
+ This endpoint has several sections, which are only sent when requested in the `include` parameter (see
+ [Requested sections](#section/basic-principles-of-working-with-api/Section-on-demand)).
+
+
+ Value | Section
+
+ --------|------
+
+ `surchargeParameters`| Item surcharge parameters
tags:
- Invoices
parameters:
@@ -17830,7 +20732,31 @@ paths:
instance: '000000000633'
summary: 'Invoice detail'
operationId: getInvoiceDetail
- description: "Detailed information about one invoice.\n\nIn most cases the items in the response are the same as you can see in the administration of PDF printout of an invoice. There are however some advanced cases (in case of coupon discount with absolute value or in case of a volume discount and products with multiple VAT rates in the invoice), in which case they are different:\n\n- Administration and PDF will show multiple rows for the discount – for each VAT rate one row and the price field split evenly. - API response will return only one row indication the total discount price.\n\nThe difference is based on how data is internally stored and presented. The API is bases more on internal storage principle, there is however also an array `displayPrices`, which contains the presentation (printout) form of each item.\n\nThis endpoint has several sections, which are only sent when requested in the `include` parameter (see [Requested sections](#section/basic-principles-of-working-with-api/Section-on-demand)).\nValue | Section\n--------|------\n`surchargeParameters`| Item surcharge parameters"
+ description: |-
+ Detailed information about one invoice.
+
+
+ In most cases the items in the response are the same as you can see in the administration of PDF printout of an invoice.
+ There are however some advanced cases (in case of coupon discount with absolute value or in case of
+ a volume discount and products with multiple VAT rates in the invoice), in which case they are different:
+
+
+ - Administration and PDF will show multiple rows for the discount – for each VAT rate one row and the price field split evenly.
+ - API response will return only one row indication the total discount price.
+
+
+ The difference is based on how data is internally stored and presented. The API is bases more on internal storage principle,
+ there is however also an array `displayPrices`, which contains the presentation (printout) form of each item.
+
+
+ This endpoint has several sections, which are only sent when requested in the `include` parameter (see
+ [Requested sections](#section/basic-principles-of-working-with-api/Section-on-demand)).
+
+ Value | Section
+
+ --------|------
+
+ `surchargeParameters`| Item surcharge parameters
tags:
- Invoices
parameters:
@@ -18039,7 +20965,9 @@ paths:
-
name: suppressExistenceCheck
in: query
- description: 'suppress checking of existing invoices per order (allows multiple invoices per order)'
+ description: |-
+ suppress checking of existing invoices per order (allows multiple
+ invoices per order)
example: 'true'
schema:
type: string
@@ -18310,11 +21238,15 @@ paths:
errors:
-
errorCode: proof-payments-already-linked-to-invoice
- message: 'Proof payment with code "O-2017000017-01" is already linked to the invoice "%s".'
+ message: |-
+ Proof payment with code "O-2017000017-01" is already linked
+ to the invoice "%s".
instance: data.proofPaymentCodes
-
errorCode: proof-payments-closed
- message: 'Proof payment with code "O-2017000044-01" is closed. Unlock proof payment first.'
+ message: |-
+ Proof payment with code "O-2017000044-01" is closed. Unlock
+ proof payment first.
instance: O-2017000044-01
schema:
type: object
@@ -18332,11 +21264,15 @@ paths:
errors:
-
errorCode: proof-payments-not-related-to-order
- message: 'Proof payment with code "O-2017000017-01" is not related to the order with code "2017000044".'
+ message: |-
+ Proof payment with code "O-2017000017-01" is not related to
+ the order with code "2017000044".
instance: data.proofPaymentCodes
-
errorCode: proof-payments-and-invoice-has-different-currency
- message: 'Proof payment with code "O-2017000017-01" is not in the same currency as the invoice "2017100013".'
+ message: |-
+ Proof payment with code "O-2017000017-01" is not in the same
+ currency as the invoice "2017100013".
instance: data.proofPaymentCodes
-
errorCode: proof-payments-invalid
@@ -18351,7 +21287,19 @@ paths:
$ref: '#/components/schemas/Errors'
summary: 'Invoice link proof payments'
operationId: invoiceLinkProofPayments
- description: "Linking proof payments to invoice. Proof payments must be related to the order, must be in same currency as the order, must be valid and cannot be linked to another invoice.\n\nThis endpoint has several sections, which are only sent when requested in the `include` parameter (see [Requested sections](#section/basic-principles-of-working-with-api/Section-on-demand)).\nValue | Section\n--------|------\n`surchargeParameters`| Item surcharge parameters"
+ description: |-
+ Linking proof payments to invoice. Proof payments must be related to the order, must be in same currency
+ as the order, must be valid and cannot be linked to another invoice.
+
+
+ This endpoint has several sections, which are only sent when requested in the `include` parameter (see
+ [Requested sections](#section/basic-principles-of-working-with-api/Section-on-demand)).
+
+ Value | Section
+
+ --------|------
+
+ `surchargeParameters`| Item surcharge parameters
tags:
- Invoices
parameters:
@@ -18437,11 +21385,17 @@ paths:
errors:
-
errorCode: document-not-generated
- message: 'Error while getting document type "invoice" with code "2018000004".'
+ message: |-
+ Error while getting document type "invoice" with code
+ "2018000004".
instance: '2018000004'
summary: 'Download invoice as PDF'
operationId: downloadInvoiceAsPdf
- description: 'You can request the invoice as PDF file, response will be as application/octet-stream. You can download pdf documents only one-by-one for every e-shop. Parallel requests end with `423 Locked` error.'
+ description: |-
+ You can request the invoice as PDF file, response will be as
+ application/octet-stream. You can download pdf documents
+ only one-by-one for every e-shop. Parallel requests end with `423
+ Locked` error.
tags:
- Invoices
parameters:
@@ -18492,11 +21446,17 @@ paths:
errors:
-
errorCode: document-not-generated
- message: 'Error while getting document type "invoice" with code "2018000004".'
+ message: |-
+ Error while getting document type "invoice" with code
+ "2018000004".
instance: '2018000004'
summary: 'Download invoice as ISDOC'
operationId: downloadInvoiceAsIsdoc
- description: 'You can request the invoice as ISDOC file, response will be as application/octet-stream. You can download pdf documents only one-by-one for every e-shop. Parallel requests end with `423 Locked` error.'
+ description: |-
+ You can request the invoice as ISDOC file, response will be as
+ application/octet-stream. You can download pdf documents
+ only one-by-one for every e-shop. Parallel requests end with `423
+ Locked` error.
tags:
- Invoices
parameters:
@@ -18560,7 +21520,20 @@ paths:
additionalProperties: false
summary: 'Last invoice changes'
operationId: getLastInvoiceChanges
- description: "Returns the list of invoices, which were changed (added/changed or deleted). Endpoint is intended to determine the changes after you have loaded the complete list of invoices and you need to know if any of these was been changed (or deleted). Guaranteed history is 30 days, the older data are deleted progressively.\n\nEach invoice in the log is only mentioned with its last change. For example, if the invoice was modified and then deleted, the log will only show information about its deletion.\n\nCreation is considered as `edit` action. So, when there is a new item created, it will be displayed like `edit` action.\n\nEndpoint supports [pagination](#section/basic-principles-of-working-with-api/Paging)."
+ description: |-
+ Returns the list of invoices, which were changed (added/changed or deleted). Endpoint is intended to determine
+ the changes after you have loaded the complete list of invoices and you need to know if any of these was been changed (or
+ deleted). Guaranteed history is 30 days, the older data are deleted progressively.
+
+
+ Each invoice in the log is only mentioned with its last change. For example, if the invoice was modified and then deleted,
+ the log will only show 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](#section/basic-principles-of-working-with-api/Paging).
tags:
- Invoices
parameters:
@@ -18663,7 +21636,9 @@ paths:
additionalProperties: false
summary: 'List of proforma invoices'
operationId: getListOfProformaInvoices
- description: 'Returns the list of proforma invoices. Supports the [pagination](#section/basic-principles-of-working-with-api/Paging).'
+ description: |-
+ Returns the list of proforma invoices. Supports the
+ [pagination](#section/basic-principles-of-working-with-api/Paging).
tags:
- 'Proforma invoices'
parameters:
@@ -18682,13 +21657,17 @@ paths:
-
name: creationTimeFrom
in: query
- description: 'filtering items created after or same as requested datetime. ISO 8601 format ("2017-12-12T22:08:01+0100").'
+ description: |-
+ filtering items created after or same as requested datetime. ISO
+ 8601 format ("2017-12-12T22:08:01+0100").
schema:
type: string
-
name: creationTimeTo
in: query
- description: 'filtering items created before or same as requested datetime. ISO 8601 format ("2017-12-12T22:08:01+0100")'
+ description: |-
+ filtering items created before or same as requested datetime. ISO
+ 8601 format ("2017-12-12T22:08:01+0100")
schema:
type: string
-
@@ -18890,7 +21869,17 @@ paths:
instance: '000000000633'
summary: 'Proforma invoice detail'
operationId: getProformaInvoiceDetail
- description: "Additional information about one proforma invoice.\nThis endpoint has several sections, which are only sent when requested in the `include` parameter (see [Requested sections](#section/basic-principles-of-working-with-api/Section-on-demand)).\nValue | Section\n--------|------\n`surchargeParameters`| Item surcharge parameters"
+ description: |-
+ Additional information about one proforma invoice.
+
+ This endpoint has several sections, which are only sent when requested in the `include` parameter (see
+ [Requested sections](#section/basic-principles-of-working-with-api/Section-on-demand)).
+
+ Value | Section
+
+ --------|------
+
+ `surchargeParameters`| Item surcharge parameters
tags:
- 'Proforma invoices'
parameters:
@@ -18951,11 +21940,18 @@ paths:
errors:
-
errorCode: document-not-generated
- message: 'Error while getting document type "proformaInvoice" with code "2018000035".'
+ message: |-
+ Error while getting document type "proformaInvoice" with
+ code "2018000035".
instance: '2018000035'
summary: 'Download proforma invoice as PDF'
operationId: downloadProformaInvoicePdf
- description: "You can request the proforma invoice as PDF file, response will be as application/octet-stream. You can download pdf documents\nonly one-by-one for every e-shop. Parallel requests end with `423 Locked` error."
+ description: |-
+ You can request the proforma invoice as PDF file, response will be as
+ application/octet-stream. You can download pdf documents
+
+ only one-by-one for every e-shop. Parallel requests end with `423
+ Locked` error.
tags:
- 'Proforma invoices'
parameters:
@@ -19120,7 +22116,9 @@ paths:
-
name: issueDate
in: query
- description: 'filtering according to date on which was proof payment issued. In ISO 8601 format. Optional.'
+ description: |-
+ filtering according to date on which was proof payment issued. In
+ ISO 8601 format. Optional.
required: false
example: '2024-12-24T15:22:02+0200'
schema:
@@ -19409,7 +22407,9 @@ paths:
errors:
-
errorCode: proof-payments-closed
- message: 'Proof payment with code "P--0000000000-1" is closed. Unlock proof payment first.'
+ message: |-
+ Proof payment with code "P--0000000000-1" is closed. Unlock
+ proof payment first.
instance: P--0000000000-1
schema:
type: object
@@ -19420,7 +22420,15 @@ paths:
$ref: '#/components/schemas/Errors'
summary: 'Proof payment update'
operationId: updateProofPayment
- description: "If the proof payment is closed, response code `409` is returned and the document cannot be updated. Proof payment is closed if:\n\n- proof payment is/was linked to the invoice or\n\n- there is a manual lock of proof payment."
+ description: |-
+ If the proof payment is closed, response code `409` is returned and the
+ document cannot be updated. Proof payment is closed if:
+
+
+ - proof payment is/was linked to the invoice or
+
+
+ - there is a manual lock of proof payment.
tags:
- 'Proof payments'
parameters:
@@ -19581,7 +22589,9 @@ paths:
errors:
-
errorCode: proof-payments-closed
- message: 'Proof payment with code "P--0000000000-1" is closed. Unlock proof payment first.'
+ message: |-
+ Proof payment with code "P--0000000000-1" is closed. Unlock
+ proof payment first.
instance: P--0000000000-1
schema:
type: object
@@ -19592,7 +22602,15 @@ paths:
$ref: '#/components/schemas/Errors'
summary: 'Proof payment deletion'
operationId: deleteProofPayment
- description: "If the proof payment is closed, response code `409` is returned and the document cannot be deleted. Proof payment is closed if:\n\n- proof payment is/was linked to the invoice or\n\n- there is a manual lock of proof payment."
+ description: |-
+ If the proof payment is closed, response code `409` is returned and the
+ document cannot be deleted. Proof payment is closed if:
+
+
+ - proof payment is/was linked to the invoice or
+
+
+ - there is a manual lock of proof payment.
tags:
- 'Proof payments'
parameters:
@@ -19758,7 +22776,9 @@ paths:
errors:
-
errorCode: proof-payments-not-found
- message: 'Proof payment with proforma invoice code "2015000170" not found.'
+ message: |-
+ Proof payment with proforma invoice code "2015000170" not
+ found.
instance: '2015000170'
schema:
type: object
@@ -19891,23 +22911,33 @@ paths:
errors:
-
errorCode: proof-payments-unable-to-open
- message: 'Unable to open proof payment with code "P--0000000000-1". Document is linked to invoice.'
+ message: |-
+ Unable to open proof payment with code "P--0000000000-1".
+ Document is linked to invoice.
instance: P--0000000000-1
-
errorCode: proof-payments-unable-to-close
- message: 'Unable to close proof payment with code "P--0000000000-1". Document is not valid.'
+ message: |-
+ Unable to close proof payment with code "P--0000000000-1".
+ Document is not valid.
instance: P--0000000000-1
-
errorCode: proof-payments-unable-to-close
- message: 'Unable to close proof payment with code "P--0000000000-1". Document is linked to invoice.'
+ message: |-
+ Unable to close proof payment with code "P--0000000000-1".
+ Document is linked to invoice.
instance: P--0000000000-1
-
errorCode: proof-payments-unable-to-unlink
- message: 'Unable to unlink proof payment with code "P--0000000000-1". Document is not linked to invoice.'
+ message: |-
+ Unable to unlink proof payment with code "P--0000000000-1".
+ Document is not linked to invoice.
instance: P--0000000000-1
-
errorCode: invalid-request-data
- message: 'Unable to update proof payment with code "P--0000000000-1". An exception occurred.'
+ message: |-
+ Unable to update proof payment with code "P--0000000000-1".
+ An exception occurred.
instance: P--0000000000-1
schema:
type: object
@@ -19918,7 +22948,26 @@ paths:
$ref: '#/components/schemas/Errors'
summary: 'Proof payment document settings'
operationId: proofPaymentDocumentSettings
- description: "Using this endpoint, you can unlink an invoice from a proof of payment. After successfully unlinking the invoice, the price of the linked\ninvoice will be recalculated and increased by the price of the proof of payment.\nLinking of the invoice to the proof of payment is not possible at this endpoint.\n\nYou can also close a proof of payment with this endpoint. You can open a proof of payment if it is not linked to any invoice.\nOtherwise, a response code 409 is returned and the document cannot be closed.\n\nImportant note: If the document is closed, the invoice or proof of payment may have already been sent to the customer!"
+ description: |-
+ Using this endpoint, you can unlink an invoice from a proof of payment.
+ After successfully unlinking the invoice, the price of the linked
+
+ invoice will be recalculated and increased by the price of the proof of
+ payment.
+
+ Linking of the invoice to the proof of payment is not possible at this
+ endpoint.
+
+
+ You can also close a proof of payment with this endpoint. You can open a
+ proof of payment if it is not linked to any invoice.
+
+ Otherwise, a response code 409 is returned and the document cannot be
+ closed.
+
+
+ Important note: If the document is closed, the invoice or proof of
+ payment may have already been sent to the customer!
tags:
- 'Proof payments'
parameters:
@@ -19987,7 +23036,12 @@ paths:
instance: P-2014000004-01
summary: 'Download proof of payment as PDF'
operationId: downloadProofOfPaymentPdf
- description: "You can request the proof of payment as PDF file, response will be as application/octet-stream. You can download pdf documents\nonly one-by-one for every e-shop. Parallel requests end with `423 Locked` error."
+ description: |-
+ You can request the proof of payment as PDF file, response will be as
+ application/octet-stream. You can download pdf documents
+
+ only one-by-one for every e-shop. Parallel requests end with `423
+ Locked` error.
tags:
- 'Proof payments'
parameters:
@@ -20039,13 +23093,20 @@ paths:
properties:
changeType:
type: string
- description: 'type of event that happened with the document. Possible values are following: `add`, `edit`, `delete`.'
+ description: |-
+ type of event that happened with the document.
+ Possible values are following: `add`, `edit`,
+ `delete`.
changeTime:
type: string
- description: 'date and time when the event happened. ISO 8601 format ("2017-12-12T22:08:01+0100").'
+ description: |-
+ date and time when the event happened. ISO 8601
+ format ("2017-12-12T22:08:01+0100").
code:
type: string
- description: 'identifier (number) of the document, which can be used to query about the details.'
+ description: |-
+ identifier (number) of the document, which can be
+ used to query about the details.
required:
- changeType
- changeTime
@@ -20088,7 +23149,19 @@ paths:
additionalProperties: false
summary: 'Last proof payments changes'
operationId: getLastProofPaymentsChanges
- description: "Returns the list of proof payments, which were changed. The Endpoint is intended to determine the changes after you have loaded the list of proof payments and you need to know the changes. The guaranteed history of changes is 30 days.\n\nEach proof payment is only given in the listing with its last change. For example, if the proof payment was modified and then deleted, the listing will only show information about its deletion.\n\nCreation is considered as `edit` action. So, when there is a new item created, it will be displayed like `edit` action.\n\nEndpoint supports [paging](#section/basic-principles-of-working-with-api/Paging)"
+ description: |-
+ Returns the list of proof payments, which were changed. The Endpoint is intended to determine
+ the changes after you have loaded the list of proof payments and you need to know the changes. The guaranteed history of changes is 30 days.
+
+
+ Each proof payment is only given in the listing with its last change. For example, if the proof payment was modified and then deleted,
+ the listing will only show 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 [paging](#section/basic-principles-of-working-with-api/Paging)
tags:
- 'Proof payments'
parameters:
@@ -20224,14 +23297,18 @@ paths:
-
name: creationTimeFrom
in: query
- description: 'date of credit note creation, in ISO 8601 format, lower limit. Optional.'
+ description: |-
+ date of credit note creation, in ISO 8601 format, lower limit.
+ Optional.
example: '2017-02-28T17:04:47+0100'
schema:
type: string
-
name: creationTimeTo
in: query
- description: 'date of credit note creation, in ISO 8601 format, upper limit. Optional.'
+ description: |-
+ date of credit note creation, in ISO 8601 format, upper limit.
+ Optional.
example: '2028-02-28T17:04:47+0100'
schema:
type: string
@@ -20274,7 +23351,17 @@ paths:
$ref: '#/components/schemas/Errors'
summary: 'List of all credit notes'
operationId: getListOfAllCreditNotes
- description: "Additional information about one credit notes.\nThis endpoint has several sections, which are only sent when requested in the `include` parameter (see [Requested sections](#section/basic-principles-of-working-with-api/Section-on-demand)).\nValue | Section\n--------|------\n`surchargeParameters`| Item surcharge parameters"
+ description: |-
+ Additional information about one credit notes.
+
+ This endpoint has several sections, which are only sent when requested in the `include` parameter (see
+ [Requested sections](#section/basic-principles-of-working-with-api/Section-on-demand)).
+
+ Value | Section
+
+ --------|------
+
+ `surchargeParameters`| Item surcharge parameters
tags:
- 'Credit notes'
parameters:
@@ -20635,7 +23722,17 @@ paths:
instance: '000000000633'
summary: 'Credit note detail'
operationId: getCreditNoteDetail
- description: "Additional information about one credit note.\nThis endpoint has several sections, which are only sent when requested in the `include` parameter (see [Requested sections](#section/basic-principles-of-working-with-api/Section-on-demand)).\nValue | Section\n--------|------\n`surchargeParameters`| Item surcharge parameters"
+ description: |-
+ Additional information about one credit note.
+
+ This endpoint has several sections, which are only sent when requested in the `include` parameter (see
+ [Requested sections](#section/basic-principles-of-working-with-api/Section-on-demand)).
+
+ Value | Section
+
+ --------|------
+
+ `surchargeParameters`| Item surcharge parameters
tags:
- 'Credit notes'
parameters:
@@ -21247,7 +24344,15 @@ paths:
additionalProperties: false
summary: 'Credit note from invoice creation'
operationId: createCreditNoteFromInvoice
- description: "Creating credit note from existing invoice.\n\nIt will create a credit note from the given invoice. It will automatically take all invoice items and add them to the credit note. If you want to add just some items from the invoice or different amount, use the parameter `items`. This parameter will allow you to generate credit note only with provided items."
+ description: |-
+ Creating credit note from existing invoice.
+
+
+ It will create a credit note from the given invoice. It will
+ automatically take all invoice items and add them to the credit note. If
+ you want to add just some items from the invoice or different amount,
+ use the parameter `items`. This parameter will allow you to generate
+ credit note only with provided items.
tags:
- 'Credit notes'
parameters:
@@ -21360,6 +24465,7 @@ paths:
- isValid
- invoiceCode
- orderCode
+ - proofPaymentCode
- creationTime
- changeTime
- dueDate
@@ -21393,8 +24499,10 @@ paths:
examples:
- true
invoiceCode:
- type: string
- description: 'invoice number. Caution! This does not have to be just a number, it can also contain letters, a dash, etc.'
+ type:
+ - string
+ - 'null'
+ description: 'invoice number (can be `null`). Caution! This does not have to be just a number, it can also contain letters, a dash, etc.'
examples:
- '2017200011'
orderCode:
@@ -21404,6 +24512,13 @@ paths:
description: 'purchase order number (can be `null`). Caution! This does not have to be just a number, it can also contain letters, a dash, etc.'
examples:
- '2017000017'
+ proofPaymentCode:
+ type:
+ - string
+ - 'null'
+ description: 'proof payment code (can be `null`). Caution! This does not have to be just a number, it can also contain letters, a dash, etc.'
+ examples:
+ - P--2017200011-1
creationTime:
$ref: '#/components/schemas/typeDateTime'
description: 'date of issue, in ISO 8601 format'
@@ -21515,8 +24630,6 @@ paths:
description: 'VAT mode, can be null, possible values: `Normal`, `One Stop Shop`, `Mini One Stop Shop`, `Reverse charge`, `Outside the EU`'
examples:
- Normal
- amountRefunded:
- $ref: '#/components/schemas/typePrice'
errors:
$ref: '#/components/schemas/Errors'
required:
@@ -21550,7 +24663,11 @@ paths:
instance: P-2014000004-01
summary: 'Credit note from proof of payment'
operationId: createCreditNoteFromProofOfPayment
- description: "Creating credit note from existing proof of payment.\nIt will create a credit note from the given proof of payment. It will automatically take all proof of payment items and add them to the credit note."
+ description: |-
+ Creating credit note from existing proof of payment.
+
+ It will create a credit note from the given proof of payment. It will
+ automatically take all proof of payment items and add them to the credit note.
tags:
- 'Credit notes'
- 'Proof payments'
@@ -21567,7 +24684,7 @@ paths:
$ref: '#/components/parameters/DefaultContentType'
requestBody:
content:
- application/vnd.shoptet.v1.0:
+ application/vnd.shoptet.v1.0+json:
schema:
type: object
required:
@@ -21942,7 +25059,10 @@ paths:
additionalProperties: false
summary: 'Update of credit note item'
operationId: updateCreditNoteItem
- description: "Updates credit note item. It's not possible to change `productType` property and it's not possible to update credit note item of another type then `product` or `product-set`."
+ description: |-
+ Updates credit note item. It's not possible to change `productType`
+ property and it's not possible to update credit note item of another
+ type then `product` or `product-set`.
tags:
- 'Credit notes'
parameters:
@@ -21957,7 +25077,9 @@ paths:
-
name: id
in: path
- description: 'credit note item id. Can be found in field `data.creditNote.items.itemId` in Credit note detail. (number)'
+ description: |-
+ credit note item id. Can be found in field
+ `data.creditNote.items.itemId` in Credit note detail. (number)
required: true
example: '198'
schema:
@@ -22084,7 +25206,9 @@ paths:
instance: integration-call
summary: 'Deletion of credit note item'
operationId: deleteCreditNoteItem
- description: "Deletes credit note item. It's not possible to delete credit note item of another type then `product` or `product-set`."
+ description: |-
+ Deletes credit note item. It's not possible to delete credit note item
+ of another type then `product` or `product-set`.
tags:
- 'Credit notes'
parameters:
@@ -22099,7 +25223,9 @@ paths:
-
name: id
in: path
- description: 'credit note item id. Can be found in field `data.creditNote.items.itemId` in Credit note detail. (number)'
+ description: |-
+ credit note item id. Can be found in field
+ `data.creditNote.items.itemId` in Credit note detail. (number)
required: true
example: '198'
schema:
@@ -22145,11 +25271,18 @@ paths:
errors:
-
errorCode: document-not-generated
- message: 'Error while getting document type "creditNote" with code "0000000002".'
+ message: |-
+ Error while getting document type "creditNote" with code
+ "0000000002".
instance: '0000000002'
summary: 'Download credit note as PDF'
operationId: downloadCreditNotePdf
- description: "You can request the credit note as PDF file, response will be as application/octet-stream. You can download pdf documents\nonly one-by-one for every e-shop. Parallel requests end with `423 Locked` error."
+ description: |-
+ You can request the credit note as PDF file, response will be as
+ application/octet-stream. You can download pdf documents
+
+ only one-by-one for every e-shop. Parallel requests end with `423
+ Locked` error.
tags:
- 'Credit notes'
parameters:
@@ -22213,7 +25346,21 @@ paths:
additionalProperties: false
summary: 'Last credit note changes'
operationId: getLastCreditNoteChanges
- description: "Returns the list of credit notes, which were changed. The Endpoint is intended to determine the changes after you have loaded the list of credit notes and you need to know the changes. The guaranteed history of changes is 30 days.\n\nEach credit note is only given in the listing with its last change. For example, if the credit note was modified and then deleted, the listing will only show information about its deletion.\n\nCreation is considered as `edit` action. So, when there is a new item created, it will be displayed like `edit` action.\n\nEndpoint supports [pagination](#section/basic-principles-of-working-with-api/Paging)."
+ description: |-
+ Returns the list of credit notes, which were changed. The Endpoint is intended to determine
+ the changes after you have loaded the list of credit notes and you need to know the changes.
+ The guaranteed history of changes is 30 days.
+
+
+ Each credit note is only given in the listing with its last change. For example, if the credit note was
+ modified and then deleted, the listing will only show 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](#section/basic-principles-of-working-with-api/Paging).
tags:
- 'Credit notes'
parameters:
@@ -22352,7 +25499,15 @@ paths:
instance: instance
summary: 'List of all delivery notes'
operationId: getListOfAllDeliveryNotes
- description: "Using this endpoint, you can get list of all delivery notes with detailed info of each delivery note (like in delivery Note Detail endpoint) asynchronously. See how [Asynchronous requests](https://developers.shoptet.com/asynchronous-requests/) work on our developer's portal.\n\nResponse will be in [jsonlines](https://jsonlines.org/) format with each product taking one line of output file. One delivery note in response has the same format as delivery note detail response."
+ description: |-
+ Using this endpoint, you can get list of all delivery notes with detailed info of each delivery note
+ (like in delivery Note Detail endpoint) asynchronously.
+ See how [Asynchronous requests](https://developers.shoptet.com/asynchronous-requests/) work on our
+ developer's portal.
+
+
+ Response will be in [jsonlines](https://jsonlines.org/) format with each product taking one line of output file.
+ One delivery note in response has the same format as delivery note detail response.
tags:
- 'Delivery notes'
parameters:
@@ -22538,7 +25693,17 @@ paths:
instance: '000000000633'
summary: 'Detail of delivery note'
operationId: getDetailOfDeliveryNote
- description: "Additional information about one delivery note.\nThis endpoint has several sections, which are only sent when requested in the `include` parameter (see [Requested sections](#section/basic-principles-of-working-with-api/Section-on-demand)).\nValue | Section\n--------|------\n`surchargeParameters`| Item surcharge parameters"
+ description: |-
+ Additional information about one delivery note.
+
+ This endpoint has several sections, which are only sent when requested in the `include` parameter (see
+ [Requested sections](#section/basic-principles-of-working-with-api/Section-on-demand)).
+
+ Value | Section
+
+ --------|------
+
+ `surchargeParameters`| Item surcharge parameters
tags:
- 'Delivery notes'
parameters:
@@ -22598,11 +25763,18 @@ paths:
errors:
-
errorCode: document-not-generated
- message: 'Error while getting document type "deliveryNote" with code "0000000001".'
+ message: |-
+ Error while getting document type "deliveryNote" with code
+ "0000000001".
instance: '0000000001'
summary: 'Download delivery note as PDF'
operationId: downloadDeliveryNoteAsPdf
- description: "You can request the delivery note as PDF file, response will be as application/octet-stream. You can download pdf documents\nonly one-by-one for every e-shop. Parallel requests end with `423 Locked` error."
+ description: |-
+ You can request the delivery note as PDF file, response will be as
+ application/octet-stream. You can download pdf documents
+
+ only one-by-one for every e-shop. Parallel requests end with `423
+ Locked` error.
tags:
- 'Delivery notes'
parameters:
@@ -22647,7 +25819,9 @@ paths:
additionalProperties: false
summary: 'List of stocks'
operationId: getListOfStocks
- description: 'Returns the list of stocks. There are usually not many stocks, therefore the endpoint returns all of them without [paging](#section/basic-principles-of-working-with-api/Paging).'
+ description: |-
+ Returns the list of stocks. There are usually not many stocks, therefore the endpoint returns all of
+ them without [paging](#section/basic-principles-of-working-with-api/Paging).
tags:
- Stocks
parameters:
@@ -22747,7 +25921,12 @@ paths:
type:
- string
- 'null'
- description: "Can have the following values: \n - `admin` if the change was invoked by the e-shop administrator \n - `customer` if the change was invoked by the e-shop customer \n - e-mail or `null` for all other cases. \n Upon a change invoked by a REST API request, the form of the e-mail is generated as per template `api.service-{service-id}@{e-shop-domain}."
+ description: |-
+ Can have the following values:
+ - `admin` if the change was invoked by the e-shop administrator
+ - `customer` if the change was invoked by the e-shop customer
+ - e-mail or `null` for all other cases.
+ Upon a change invoked by a REST API request, the form of the e-mail is generated as per template `api.service-{service-id}@{e-shop-domain}.
examples:
- novak@shoptet.cz
changeTime:
@@ -22786,7 +25965,14 @@ paths:
additionalProperties: false
summary: 'Stock movements'
operationId: getStockMovements
- description: "It returns the list of changes in product quantity, which were done within one stock. Supports the [paging](#section/basic-principles-of-working-with-api/Paging) `movements`.\nThis endpoint supports optional parts using the `include` parameter (see [Requested sections](#section/basic-principles-of-working-with-api/Section-on-demand)). Please note that there is some performance penalty associated with the usage of \"orderCode\" `include` and/or query `parameter`."
+ description: |-
+ It returns the list of changes in product quantity, which were done
+ within one stock. Supports the [paging](#section/basic-principles-of-working-with-api/Paging) `movements`.
+
+ This endpoint supports optional parts using the `include` parameter (see
+ [Requested sections](#section/basic-principles-of-working-with-api/Section-on-demand)). Please note that there is some
+ performance penalty associated with the usage of "orderCode" `include`
+ and/or query `parameter`.
tags:
- Stocks
parameters:
@@ -22801,14 +25987,18 @@ paths:
-
name: lastId
in: query
- description: 'ID of last transfered record. If missing, the older records are sent.'
+ description: |-
+ ID of last transfered record. If missing, the older records are
+ sent.
example: '45'
schema:
type: number
-
name: changeTimeFrom
in: query
- description: 'Date of move, in ISO 8601 format, lower limit. It is not possible to use it as break poit, it is not unique value. Optional.'
+ description: |-
+ Date of move, in ISO 8601 format, lower limit. It is not possible to
+ use it as break poit, it is not unique value. Optional.
example: '2021-03-01T00:00:00+0100'
schema:
type: string
@@ -22885,11 +26075,59 @@ paths:
errors:
-
errorCode: stock-change-not-allowed
- message: 'Stock change not allowed for product set "82". Skipped.'
+ message: |-
+ Stock change not allowed for product set "82".
+ Skipped.
instance: '82'
summary: 'Update quantity in stock'
operationId: updateQuantityInStock
- description: "Endpoint enables the quantity of product in stock (relative and absolute) to be changed. Within a call, the update\nof multiple products at once can be requested (max. 100 products/variants).\n\nIn case an error occurs for one of the records, the correct records will be updated, the response will be `200 OK`\nand there will be records in the `errors` array for each failed record. If all records are incorrect, the response\ncode will be `400 BAD REQUEST` instead.\n\nItem `productCode` is mandatory. Then one of the three items has to be provided:\n\n- `amountChange` to increase or decrease amount available for ordering/physically on stock (relative change)\n\n- `quantity` to set amount available for ordering (absolute amount)\n\n- `realStock` to set amount physically stored in a warehouse (absolute amount)\n\nThe difference between `quantity` and `realStock` is amount of goods requested by the pending orders (so called \"claim\").\n\n`amount for ordering` = `realStock` - `claim`\n\nThe claim cannot be changed explicitly, it is updated when a new order is submitted or an order is sent out. Please note,\nthat the stock amount cannot be changed for product sets, where the amount is calculated dynamically from the individual\nproducts in the set. Trying to change the amount of product set will result in an error."
+ description: |-
+ Endpoint enables the quantity of product in stock (relative and
+ absolute) to be changed. Within a call, the update
+
+ of multiple products at once can be requested (max. 100
+ products/variants).
+
+
+ In case an error occurs for one of the records, the correct records will
+ be updated, the response will be `200 OK`
+
+ and there will be records in the `errors` array for each failed record.
+ If all records are incorrect, the response
+
+ code will be `400 BAD REQUEST` instead.
+
+
+ Item `productCode` is mandatory. Then one of the three items has to be
+ provided:
+
+
+ - `amountChange` to increase or decrease amount available for
+ ordering/physically on stock (relative change)
+
+
+ - `quantity` to set amount available for ordering (absolute amount)
+
+
+ - `realStock` to set amount physically stored in a warehouse (absolute
+ amount)
+
+
+ The difference between `quantity` and `realStock` is amount of goods
+ requested by the pending orders (so called "claim").
+
+
+ `amount for ordering` = `realStock` - `claim`
+
+
+ The claim cannot be changed explicitly, it is updated when a new order
+ is submitted or an order is sent out. Please note,
+
+ that the stock amount cannot be changed for product sets, where the
+ amount is calculated dynamically from the individual
+
+ products in the set. Trying to change the amount of product set will
+ result in an error.
tags:
- Stocks
parameters:
@@ -23091,7 +26329,20 @@ paths:
additionalProperties: false
summary: 'Product supplies in stock'
operationId: getProductSuppliesInStock
- description: "Returns the product supplies in stock for all products in a specific stock, contains GUID, code and quantity in stock for a specific product variant. It is possible to filter the specific GUID of a product, possibly a variant code. The endpoint supports [paging](#section/basic-principles-of-working-with-api/Paging), in case of filtering, the amount of items per page increases.\n\nThis endpoint supports optional parts using the `include` parameter (see [Requested sections](#section/basic-principles-of-working-with-api/Section-on-demand)). The `changeTime` item is always temporarily returned, however as of 16. 3. 2019 only upon using the `include` parameter.\n\nIf you defined the `include=changeTime` parameter within the URL, the response will also contain the time when the last quantity in stock was changed."
+ description: |-
+ Returns the product supplies in stock for all products in a specific stock, contains GUID, code and quantity
+ in stock for a specific product variant. It is possible to filter the specific GUID of a product, possibly
+ a variant code. The endpoint supports [paging](#section/basic-principles-of-working-with-api/Paging),
+ in case of filtering, the amount of items per page increases.
+
+
+ This endpoint supports optional parts using the `include` parameter (see
+ [Requested sections](#section/basic-principles-of-working-with-api/Section-on-demand)). The `changeTime` item
+ is always temporarily returned, however as of 16. 3. 2019 only upon using the `include` parameter.
+
+
+ If you defined the `include=changeTime` parameter within the URL, the response will also contain the time
+ when the last quantity in stock was changed.
tags:
- Stocks
parameters:
@@ -23120,13 +26371,19 @@ paths:
-
name: onlyWithClaim
in: query
- description: 'whether only products with claim greater than 0 should be returned. Defaults to `false`'
+ description: |-
+ whether only products with claim greater than 0 should be returned.
+ Defaults to `false`
schema:
type: boolean
-
name: changedFrom
in: query
- description: "return only product supplies, which amount has been changed since date value of this parameter.\n\n \nIt support maximum of 30 days in history. (optional, string). ISO 8601 format (\"2017-12-12T22:08:01+0100\"). Optional.\n"
+ description: |
+ return only product supplies, which amount has been changed since date value of this parameter.
+
+
+ It support maximum of 30 days in history. (optional, string). ISO 8601 format ("2017-12-12T22:08:01+0100"). Optional.
schema:
type: string
-
@@ -23513,7 +26770,9 @@ paths:
errors:
-
errorCode: brand-used-by-products
- message: 'Brand "1e3f3f3f-3f3f-63ca-b93f-02423f1f0005" cannot be deleted, because some products are assigned to it.'
+ message: |-
+ Brand "1e3f3f3f-3f3f-63ca-b93f-02423f1f0005" cannot be
+ deleted, because some products are assigned to it.
instance: 1e3f3f3f-3f3f-63ca-b93f-02423f1f0005
schema:
type: object
@@ -23524,7 +26783,12 @@ paths:
$ref: '#/components/schemas/Errors'
summary: 'Deletion of brand'
operationId: deleteBrand
- description: "If the brand cannot be deleted, because it is used by some product, a 409 code is returned.\nOptional parameter `deleteUsed` with `true` value allows deletion of brand used by products."
+ description: |-
+ If the brand cannot be deleted, because it is used by some product, a
+ 409 code is returned.
+
+ Optional parameter `deleteUsed` with `true` value allows deletion of
+ brand used by products.
tags:
- Brands
parameters:
@@ -23576,7 +26840,32 @@ paths:
additionalProperties: false
summary: 'BATCH creation of brands'
operationId: createBrandBatch
- description: "This endpoint allows you to create multiple brands at once. Batch creation is processed asynchronously in same way as for example products snapshot,\nbut it does not have `resultUrl` in response. Instead, you can check attribute `log` which contains successfully created brands and errors.\n\nSee how [Asynchronous requests](https://developers.shoptet.com/asynchronous-requests/) work on our developer's portal.\n\nFile with data for update must be in JSONL ([jsonlines](https://jsonlines.org/)) format. Each line must contain one brand in JSON format. Maximum size of file is 100MB.\nStructure of JSON row is same as structure of JSON for single brand creation above.\n\nAsynchronous 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)."
+ description: |-
+ This endpoint allows you to create multiple brands at once. Batch
+ creation is processed asynchronously in same way as for example products
+ snapshot,
+
+ but it does not have `resultUrl` in response. Instead, you can check
+ attribute `log` which contains successfully created brands and errors.
+
+
+ See how [Asynchronous
+ requests](https://developers.shoptet.com/asynchronous-requests/) work on
+ our developer's portal.
+
+
+ File with data for update must be in JSONL
+ ([jsonlines](https://jsonlines.org/)) format. Each line must contain one
+ brand in JSON format. Maximum size of file is 100MB.
+
+ Structure of JSON row is same as structure of JSON for single brand
+ creation above.
+
+
+ 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).
tags:
- Brands
requestBody:
@@ -23671,7 +26960,9 @@ paths:
-
name: email
in: query
- description: 'filtering as per customer’s e-mails. An accurate match is searched for, regardless of capitalization.'
+ description: |-
+ filtering as per customer’s e-mails. An accurate match is searched
+ for, regardless of capitalization.
schema:
type: string
-
@@ -23878,7 +27169,13 @@ paths:
-
name: suppressMandatoryFieldsCheck
in: query
- description: 'suppress checking if new customer has filled all mandatory fields from eshop settings `Settings -> Customers -> Mandatory fields`. Suppressing this check can cause worse customer experience in order process for customers without all mandatory fields! However this can be useful for migration customers from older system without all necessary fields.'
+ description: |-
+ suppress checking if new customer has filled all mandatory fields
+ from eshop settings `Settings -> Customers -> Mandatory fields`.
+ Suppressing this check can cause worse customer experience in order
+ process for customers without all mandatory fields! However this can
+ be useful for migration customers from older system without all
+ necessary fields.
example: 'false'
schema:
type: string
@@ -24005,7 +27302,17 @@ paths:
$ref: '#/components/schemas/Errors'
summary: 'List of all customers'
operationId: getListOfAllCustomers
- description: "Using this endpoint, you can get list of all customers with detailed info of each customer (like in Customer Detail endpoint) asynchronously. See how [Asynchronous requests](https://developers.shoptet.com/asynchronous-requests/) work on our developer's portal.\n\nResponse will be in [jsonlines](https://jsonlines.org/) format with each product taking one line of output file. One product in response has the same format as product detail response (in `data.customer` attribute)\n\nResult file is compressed using GZIP."
+ description: |-
+ Using this endpoint, you can get list of all customers with detailed info of each customer (like in Customer Detail endpoint)
+ asynchronously. See how [Asynchronous requests](https://developers.shoptet.com/asynchronous-requests/) work on our
+ developer's portal.
+
+
+ Response will be in [jsonlines](https://jsonlines.org/) format with each product taking one line of output file.
+ One product in response has the same format as product detail response (in `data.customer` attribute)
+
+
+ Result file is compressed using GZIP.
tags:
- Customers
parameters:
@@ -24229,7 +27536,7 @@ paths:
404:
description: 'Not Found'
content:
- application/json:
+ 'application/vnd.shoptet.v1.0+json; charset=utf-8':
schema:
type: object
properties:
@@ -24242,7 +27549,9 @@ paths:
errors:
-
errorCode: customer-not-found
- message: 'Customer with guid "157e7215-9035-11e4-a769-ac162d8a2454" not found.'
+ message: |-
+ Customer with guid "157e7215-9035-11e4-a769-ac162d8a2454"
+ not found.
instance: 157e7215-9035-11e4-a769-ac162d8a2454
summary: 'Customer detail'
operationId: getCustomerDetail
@@ -25905,7 +29214,21 @@ paths:
additionalProperties: false
summary: 'Last customer changes'
operationId: getLastCustomerChanges
- description: "Returns the list of customers who have been changed (added/changed or deleted). The Endpoint is intended to determine the changes after you have loaded the complete list of customers and you need to know, if any of these has been changed (or added or deleted). Guaranteed history is 30 days, the older data are deleted progressively.\n\nEach customer in the log is only mentioned with their last change. For example, if the customer was modified and then deleted, the log will only show information about the deletion.\nCreation is considered as `edit` action. So, when there is a new item created, it will be displayed like `edit` action.\n\nEndpoint supports [paging](#section/basic-principles-of-working-with-api/Paging)."
+ description: |-
+ Returns the list of customers who have been changed (added/changed or deleted). The Endpoint is intended
+ to determine the changes after you have loaded the complete list of customers and you need to know, if
+ any of these has been changed (or added or deleted). Guaranteed history is 30 days, the older data are
+ deleted progressively.
+
+
+ Each customer in the log is only mentioned with their last change. For example, if the customer was modified
+ and then deleted, the log will only show information about the deletion.
+
+ Creation is considered as `edit` action. So, when there is a new item created, it will be displayed like
+ `edit` action.
+
+
+ Endpoint supports [paging](#section/basic-principles-of-working-with-api/Paging).
tags:
- Customers
parameters:
@@ -26155,7 +29478,10 @@ paths:
additionalProperties: false
summary: 'Listing of codes'
operationId: getListingOfHtmlCodes
- description: "This lists currently defined HTML codes for this addon, in all possible locations. Each addon sees only “its own” codes,\n it cannot see other codes of other addons, not even from the same developer. Also, it does not see the code inserted within the administration."
+ description: |-
+ This lists currently defined HTML codes for this addon, in all possible
+ locations. Each addon sees only “its own” codes,
+ it cannot see other codes of other addons, not even from the same developer. Also, it does not see the code inserted within the administration.
tags:
- Templates
parameters:
@@ -26221,11 +29547,22 @@ paths:
errors:
-
errorCode: template-include-location-invalid
- message: 'Invalid location code: does-not-exist. Possible values: common-header, common-footer, order-confirmed'
+ message: |-
+ Invalid location code: does-not-exist. Possible values:
+ common-header, common-footer, order-confirmed
instance: location
summary: 'Inserting and editing codes'
operationId: createAndEditHtmlCodes
- description: "This adds new or changes the current (if exists) HTML code. It is possible to enter 1-3 changes at a time (typically\n3 possible locations). If the value already exists, it is simply overwritten. The limit for HTML code is 8192 characters. In case that any\nof the requirements fail, the detailed information is returned in the`errors` field."
+ description: |-
+ This adds new or changes the current (if exists) HTML code. It is
+ possible to enter 1-3 changes at a time (typically
+
+ 3 possible locations). If the value already exists, it is simply
+ overwritten. The limit for HTML code is 8192 characters. In case that
+ any
+
+ of the requirements fail, the detailed information is returned in
+ the`errors` field.
tags:
- Templates
requestBody:
@@ -26287,14 +29624,21 @@ paths:
additionalProperties: false
summary: 'Removal of code'
operationId: deleteHtmlCode
- description: "This call can be used to delete the existing code from the given location. if the code for the given `location` (position) does not exist, the\nAPI returns `404 NOT FOUND`"
+ description: |-
+ This call can be used to delete the existing code from the given
+ location. if the code for the given `location` (position) does not
+ exist, the
+
+ API returns `404 NOT FOUND`
tags:
- Templates
parameters:
-
name: location
in: path
- description: 'supported values: `common-header`, `common-footer`, `order-confirmed`'
+ description: |-
+ supported values: `common-header`, `common-footer`,
+ `order-confirmed`
required: true
example: common-header
schema:
@@ -26336,14 +29680,18 @@ paths:
additionalProperties: false
summary: 'Gaining the information about payment'
operationId: getInformationAboutPayment
- description: 'Returns the URL, at which the payment gateway shall redirect the users after completion of operation and order number.'
+ description: |-
+ Returns the URL, at which the payment gateway shall redirect the users
+ after completion of operation and order number.
tags:
- 'Payment gateways'
parameters:
-
name: paymentCode
in: path
- description: "the payment code identifies the payment of a single order,\nit is generated when the order is completed and received by the payment gateway upon redirection from the e-shop to the payment gateway.\n"
+ description: |
+ the payment code identifies the payment of a single order,
+ it is generated when the order is completed and received by the payment gateway upon redirection from the e-shop to the payment gateway.
required: true
example: os8FtURz7PpO46Z87euEAoBAn9RClB2d
schema:
@@ -26416,18 +29764,27 @@ paths:
errors:
-
errorCode: invalid-request-data
- message: 'Does not have a value in the enumeration ["FAILED","OK","PENDING"]'
+ message: |-
+ Does not have a value in the enumeration
+ ["FAILED","OK","PENDING"]
instance: data.status
summary: 'Payment status update'
operationId: updatePaymentStatus
- description: "Payment status update via the payment gateway. The `paymentCode` is the identifier. Payment status can be updated when the payment has been successfully recorded.\n**Please note that `message` can not be longer than 255 characters.**"
+ description: |-
+ Payment status update via the payment gateway. The `paymentCode` is the
+ identifier. Payment status can be updated when the payment has been
+ successfully recorded.
+
+ **Please note that `message` can not be longer than 255 characters.**
tags:
- 'Payment gateways'
parameters:
-
name: paymentCode
in: path
- description: "payment code identifies the payment of a single order,\nit is generated when the order is completed and received by the payment gateway upon redirection from e-shop to the payment gateway.\n"
+ description: |
+ payment code identifies the payment of a single order,
+ it is generated when the order is completed and received by the payment gateway upon redirection from e-shop to the payment gateway.
required: true
example: os8FtURz7PpO46Z87euEAoBAn9RClB2d
schema:
@@ -26497,7 +29854,12 @@ paths:
additionalProperties: false
summary: 'Overview of registered webhooks'
operationId: getOverviewOfRegisteredWebhooks
- description: "Returns the list of webhooks, registered by the specific addon for a single e-shop. It is therefore bound to the specific installation.\nThe addon does not have any access to another addon (not even for the same e-shop, or two addons from the same developer)."
+ description: |-
+ Returns the list of webhooks, registered by the specific addon for a
+ single e-shop. It is therefore bound to the specific installation.
+
+ The addon does not have any access to another addon (not even for the
+ same e-shop, or two addons from the same developer).
tags:
- Webhooks
parameters:
@@ -26530,7 +29892,26 @@ paths:
additionalProperties: false
summary: 'Registration of new webhook'
operationId: registerNewWebhook
- description: "Registers the webhook. For a single event (`event`, for example `order:create`) **ONLY ONE** URL can be registered.\nIf you try to enter the webhook for an `event` that already exists, you will\n receive error `422` with message `Webhook already exists for this event`. Successful creation (registration) of webhook is signaled by code `201`. The endpoint returns the info\non the created webhook. One of the items is `id`, which is assigned to the webhook and is used for its identification\nupon change or deletion.\n\nThe supported event can be found in code list Webhook event types.\n\nIt is possible to enter up to 50 webhooks using a single call.\n**Please note that `url` cannot be longer than 2000 characters.**"
+ description: |-
+ Registers the webhook. For a single event (`event`, for example
+ `order:create`) **ONLY ONE** URL can be registered.
+
+ If you try to enter the webhook for an `event` that already exists, you
+ will
+ receive error `422` with message `Webhook already exists for this event`. Successful creation (registration) of webhook is signaled by code `201`. The endpoint returns the info
+ on the created webhook. One of the items is `id`, which is assigned to
+ the webhook and is used for its identification
+
+ upon change or deletion.
+
+
+ The supported event can be found in code list Webhook event types.
+
+
+ It is possible to enter up to 50 webhooks using a single call.
+
+ **Please note that `url` cannot be longer than 2000 characters.**
tags:
- Webhooks
requestBody:
@@ -26672,7 +30053,12 @@ paths:
instance: '999'
summary: 'Update of existing webhook'
operationId: updateExistingWebhook
- description: "Modification of the existing webhook. The `id` of the webhook serves as the identifier. Using just one call, only one webhook can be modified.\n\n**Please note that `url` cannot be longer than 2000 characters.**"
+ description: |-
+ Modification of the existing webhook. The `id` of the webhook serves as
+ the identifier. Using just one call, only one webhook can be modified.
+
+
+ **Please note that `url` cannot be longer than 2000 characters.**
tags:
- Webhooks
parameters:
@@ -26786,7 +30172,15 @@ paths:
additionalProperties: false
summary: 'Generating of signature key'
operationId: generateWebhookSignatureKey
- description: "The endpoint call does not require any body. The endpoint always generates a new signature key\nfor calculating the digest mentioned in the HTTP header of the notification – `Shoptet-Webhook-Signature`. The same key\nis to be used during check after the receipt of notification. For more information see https://developers.shoptet.com/webhooks/#signature"
+ description: |-
+ The endpoint call does not require any body. The endpoint always
+ generates a new signature key
+
+ for calculating the digest mentioned in the HTTP header of the
+ notification – `Shoptet-Webhook-Signature`. The same key
+
+ is to be used during check after the receipt of notification. For more
+ information see https://developers.shoptet.com/webhooks/#signature
tags:
- Webhooks
parameters:
@@ -26823,7 +30217,14 @@ paths:
additionalProperties: false
summary: 'Webhook notification'
operationId: getWebhookNotification
- description: "Returns the notification (invoking) list of webhooks and provides information about these. If you do not have a registered webhook, and the given event happens (for example creation of an order), the registered URLs are called. A notification about a call contains information about the webhook that requested the call, the URL called, the time, delivery status, number of delivery attempts and other information.\n\nIt is possible to request 7 days history of notification."
+ description: |-
+ Returns the notification (invoking) list of webhooks and provides information about these. If you do not have
+ a registered webhook, and the given event happens (for example creation of an order), the registered URLs are
+ called. A notification about a call contains information about the webhook that requested the call, the URL
+ called, the time, delivery status, number of delivery attempts and other information.
+
+
+ It is possible to request 7 days history of notification.
tags:
- Webhooks
parameters:
@@ -26844,14 +30245,19 @@ paths:
-
name: active
in: query
- description: 'flag that the notification was not delivered yet, and the number of attempts did not reach the maximum amount. The notification will be resent to the target URL'
+ description: |-
+ flag that the notification was not delivered yet, and the number of
+ attempts did not reach the maximum amount. The notification will be
+ resent to the target URL
example: 'true'
schema:
type: boolean
-
name: from
in: query
- description: 'DateTime for the log, up to the present, which we are interested in. `+` in the time zone designation, html shall be coded as `%2B`.'
+ description: |-
+ DateTime for the log, up to the present, which we are interested in.
+ `+` in the time zone designation, html shall be coded as `%2B`.
example: '2018-05-28T14:17:00+02:00'
schema:
type: string
@@ -26989,7 +30395,11 @@ paths:
additionalProperties: false
summary: 'List of shipping methods'
operationId: getListOfShippingMethods
- description: "Endpoint returns a list of all available shipping methods and details of their settings. Does not use paging,\nit always returns all methods at once."
+ description: |-
+ Endpoint returns a list of all available shipping methods and details of
+ their settings. Does not use paging,
+
+ it always returns all methods at once.
tags:
- 'Shipping methods'
parameters:
@@ -27079,7 +30489,42 @@ paths:
additionalProperties: false
summary: 'Adding a shipping method'
operationId: createShippingMethod
- description: "Adds a new shipping method for the specific e-shop.\nShould you wish to implement an addon implementing a shipping method, contact our partner support and request the creation\nof a new \"shipping company code\" identifier.\n\nThe request body includes the mandatory attributes `name` and `shippingMethodCode` (or deprecated `shippingCompanyCode`). The other parameters are not\nmandatory and their default values will be used:\n\n- `description` - `null`\n\n- `visibility` - `false`\n\n- `wholesale` - `false`\n\n- `logo` - `null`\n\n- `minimalShippingPrice` - `0.00`\n\nSend the logo of the shipping method as the file content, encoded with base64, in `data.logo.content` request item.\n\n**Please note that `name` cannot be longer than 255 characters.**"
+ description: |-
+ Adds a new shipping method for the specific e-shop.
+
+ Should you wish to implement an addon implementing a shipping method,
+ contact our partner support and request the creation
+
+ of a new "shipping company code" identifier.
+
+
+ The request body includes the mandatory attributes `name` and
+ `shippingMethodCode` (or deprecated `shippingCompanyCode`). The other
+ parameters are not
+
+ mandatory and their default values will be used:
+
+
+ - `description` - `null`
+
+
+ - `visibility` - `false`
+
+
+ - `wholesale` - `false`
+
+
+ - `logo` - `null`
+
+
+ - `minimalShippingPrice` - `0.00`
+
+
+ Send the logo of the shipping method as the file content, encoded with
+ base64, in `data.logo.content` request item.
+
+
+ **Please note that `name` cannot be longer than 255 characters.**
tags:
- 'Shipping methods'
requestBody:
@@ -27304,7 +30749,10 @@ paths:
errors:
-
errorCode: shipping-request-not-found
- message: 'Unknown shippingGuid "97a4b2da-6f2e-11e4-877e-ac162d8a2455" or shippingRequestCode "5ee3b74071f72c460757155cb0ae0aaa".'
+ message: |-
+ Unknown shippingGuid
+ "97a4b2da-6f2e-11e4-877e-ac162d8a2455" or
+ shippingRequestCode "5ee3b74071f72c460757155cb0ae0aaa".
instance: 'shippingGuid, shippingRequestCode'
408:
description: 'Request Timeout'
@@ -27322,7 +30770,9 @@ paths:
errors:
-
errorCode: cart-data-missing
- message: 'Cart data of "10c50b2f9dde1e9b1050623586547d9f" from CMS is missing'
+ message: |-
+ Cart data of "10c50b2f9dde1e9b1050623586547d9f" from CMS
+ is missing
instance: shippingRequest
summary: 'Shipping request for getting cart details'
operationId: getShippingRequestForCartDetails
@@ -27390,7 +30840,10 @@ paths:
errors:
-
errorCode: shipping-request-not-found
- message: 'Unknown shippingGuid "97a4b2da-6f2e-11e4-877e-ac162d8a2455" or shippingRequestCode "5ee3b74071f72c460757155cb0ae0aaa".'
+ message: |-
+ Unknown shippingGuid
+ "97a4b2da-6f2e-11e4-877e-ac162d8a2455" or
+ shippingRequestCode "5ee3b74071f72c460757155cb0ae0aaa".
instance: 'shippingGuid, shippingRequestCode'
408:
description: 'Request Timeout'
@@ -27408,7 +30861,9 @@ paths:
errors:
-
errorCode: cart-data-missing
- message: 'Cart data of "10c50b2f9dde1e9b1050623586547d9f" from CMS is missing'
+ message: |-
+ Cart data of "10c50b2f9dde1e9b1050623586547d9f" from CMS
+ is missing
instance: shippingRequest
summary: 'Update shipping price & data'
operationId: updateShippingData
@@ -27686,11 +31141,16 @@ paths:
errors:
-
errorCode: shipping-request-not-found
- message: 'Unknown shippingGuid "97a4b2da-6f2e-11e4-877e-ac162d8a2455" or shippingRequestCode "5ee3b74071f72c460757155cb0ae0aaa".'
+ message: |-
+ Unknown shippingGuid
+ "97a4b2da-6f2e-11e4-877e-ac162d8a2455" or
+ shippingRequestCode "5ee3b74071f72c460757155cb0ae0aaa".
instance: 'shippingGuid, shippingRequestCode'
summary: 'Shipping request for getting status of order'
operationId: getShippingRequestForGettingOrderStatus
- description: 'Endpoint returns status of order related to `shippingRequestCode` & `shippingGuid`'
+ description: |-
+ Endpoint returns status of order related to `shippingRequestCode` &
+ `shippingGuid`
tags:
- 'Shipping requests'
parameters:
@@ -27841,7 +31301,10 @@ paths:
additionalProperties: false
summary: 'Listing of payment methods'
operationId: getListingOfPaymentMethods
- description: 'The endpoint returns the listing of all available payment methods and details about their settings. Paging is not used, it always returns all methods at once.'
+ description: |-
+ The endpoint returns the listing of all available payment methods and
+ details about their settings. Paging is not used, it always returns all
+ methods at once.
tags:
- 'Payment methods'
parameters:
@@ -27940,7 +31403,38 @@ paths:
additionalProperties: false
summary: 'Adding the payment methods'
operationId: createPaymentMethod
- description: "Adds the new payment method for the specific e-shop.\n\n**If you are a Premium client, contact your Account or Onboarding manager and request the creation of a new gateway identifier. New payment gateway has to be approved by Shoptet and client needs to be familiar with the terms of payment in advance.**\n\nThe request body includes the mandatory attributes `name` and `paymentType`. The other parameters are not mandatory and their default values will be used:\n\n- `description` - `null`\n\n- `visibility` - `false`\n\n- `wholesale` - `false`\n\n- `logo` - `null`\n\nSend the logo of the payment gateway as the file content, encoded with base64, in `data.logo.content` request item.\n\n**Please note that `name` cannot be longer than 255 characters.**"
+ description: |-
+ Adds the new payment method for the specific e-shop.
+
+
+ **If you are a Premium client, contact your Account or Onboarding
+ manager and request the creation of a new gateway identifier. New
+ payment gateway has to be approved by Shoptet and client needs to be
+ familiar with the terms of payment in advance.**
+
+
+ The request body includes the mandatory attributes `name` and
+ `paymentType`. The other parameters are not mandatory and their default
+ values will be used:
+
+
+ - `description` - `null`
+
+
+ - `visibility` - `false`
+
+
+ - `wholesale` - `false`
+
+
+ - `logo` - `null`
+
+
+ Send the logo of the payment gateway as the file content, encoded with
+ base64, in `data.logo.content` request item.
+
+
+ **Please note that `name` cannot be longer than 255 characters.**
tags:
- 'Payment methods'
requestBody:
@@ -28035,7 +31529,9 @@ paths:
additionalProperties: false
summary: 'Payment method deletion'
operationId: deletePaymentMethod
- description: "Deletes payment method by guid. Only payment methods related to your addon may be deleted. Private API tokens aren't currently supported."
+ description: |-
+ Deletes payment method by guid. Only payment methods related to your
+ addon may be deleted. Private API tokens aren't currently supported.
tags:
- 'Payment methods'
parameters:
@@ -28219,7 +31715,10 @@ paths:
additionalProperties: false
summary: 'Listing of e-mail distribution lists'
operationId: getListingOfEmailDistributionLists
- description: 'The e-mail distribution list named "newsletters" is the system one and is always available (if the e-shop has the module installed). This e-mail distribution list includes the e-mails of all customers who agreed to receiving e-mails.'
+ description: |-
+ The e-mail distribution list named "newsletters" is the system one and is always available
+ (if the e-shop has the module installed). This e-mail distribution list includes the e-mails
+ of all customers who agreed to receiving e-mails.
tags:
- 'E-mail distribution lists'
parameters:
@@ -28343,7 +31842,15 @@ paths:
additionalProperties: false
summary: 'Detail of e-mail distribution list'
operationId: getDetailOfEmailDistributionList
- description: "This endpoint returns a list of e-mail addresses of the distribution list.\n\nUpon initial call, it returns up to 500 e-mail addresses; using the `?itemsPerPage=20` parameter, you can requests any number of records per page, up to 500 items limit.\n\nEndpoint supports [paging](#section/basic-principles-of-working-with-api/Paging)."
+ description: |-
+ This endpoint returns a list of e-mail addresses of the distribution list.
+
+
+ Upon initial call, it returns up to 500 e-mail addresses; using the `?itemsPerPage=20` parameter, you can
+ requests any number of records per page, up to 500 items limit.
+
+
+ Endpoint supports [paging](#section/basic-principles-of-working-with-api/Paging).
tags:
- 'E-mail distribution lists'
parameters:
@@ -28403,7 +31910,21 @@ paths:
additionalProperties: false
summary: 'Distribution list e-mails insertion'
operationId: createEmailsDistributionList
- description: "This endpoint allows you to add new e-mail addresses to the distribution list identified by its `code`. In the response you will receive structured info about the result of the insertion. In the `emailsInserted`\nkey there will be a list of e-mails successfully inserted, in the `emailsExisting` key, there will be a list of skipped e-mails, because there were already in the list. In the\n`emailsInvalid` key, there will be a list of invalid e-mails (wrong format or non-existing MX domain record) and finally in the `errorMessages` key, there will be a list of error messages\ngenerated for invalid e-mails."
+ description: |-
+ This endpoint allows you to add new e-mail addresses to the distribution
+ list identified by its `code`. In the response you will receive
+ structured info about the result of the insertion. In the
+ `emailsInserted`
+
+ key there will be a list of e-mails successfully inserted, in the
+ `emailsExisting` key, there will be a list of skipped e-mails, because
+ there were already in the list. In the
+
+ `emailsInvalid` key, there will be a list of invalid e-mails (wrong
+ format or non-existing MX domain record) and finally in the
+ `errorMessages` key, there will be a list of error messages
+
+ generated for invalid e-mails.
tags:
- 'E-mail distribution lists'
parameters:
@@ -28486,7 +32007,22 @@ paths:
additionalProperties: false
summary: 'Last changes in distribution list'
operationId: getLastChangesInDistributionList
- description: "Endpoint is intended to determine the changes after you load the complete e-mail list and you need to know if any of these e-mails were added or removed. Guaranteed history is 30 days, the older data are deleted progressively.\n\nEach e-mail on single e-mail list is only mentioned with its last change, within the log. For example, if the e-mail is deleted and then added again, the log will only show information about its addition. The e-mail lists are not dependant on each other (removing an e-mail from one list does not cause any change in another list, unless the e-mail was originally included in both).\n\n**For \"created\" action, we use `edit` change type.**\n\nEndpoint supports [paging](#section/basic-principles-of-working-with-api/Paging)."
+ description: |-
+ Endpoint is intended to determine the changes after you load the complete e-mail list and you need to know
+ if any of these e-mails were added or removed. Guaranteed history is 30 days, the older data are deleted
+ progressively.
+
+
+ Each e-mail on single e-mail list is only mentioned with its last change, within the log. For example,
+ if the e-mail is deleted and then added again, the log will only show information about its addition.
+ The e-mail lists are not dependant on each other (removing an e-mail from one list does not cause any
+ change in another list, unless the e-mail was originally included in both).
+
+
+ **For "created" action, we use `edit` change type.**
+
+
+ Endpoint supports [paging](#section/basic-principles-of-working-with-api/Paging).
tags:
- 'E-mail distribution lists'
parameters:
@@ -28539,7 +32075,21 @@ paths:
additionalProperties: false
summary: 'List of discount coupons'
operationId: getListOfDiscountCoupons
- description: "List of discount coupons within the e-shop. The list is paged at 1000 coupons. The discount coupons can be filtered according to the date of creation, validity, repeatability of usage or their template.\n\nIf absolute price is used, the amount is interpreted with the default VAT rate of the eshop (in administration:\n\nSettings » Basic Settings » Tax Classes). It can be retrieved using endpoint Eshop Info, array `taxClasses`.\n\nThe same is valid for minimum price."
+ description: |-
+ List of discount coupons within the e-shop. The list is paged at 1000 coupons.
+ The discount coupons can be filtered according to the date of creation, validity,
+ repeatability of usage or their template.
+
+
+ If absolute price is used, the amount is interpreted with the default
+ VAT rate of the eshop (in administration:
+
+
+ Settings » Basic Settings » Tax Classes). It can be retrieved using
+ endpoint Eshop Info, array `taxClasses`.
+
+
+ The same is valid for minimum price.
tags:
- 'Discount coupons'
parameters:
@@ -28709,7 +32259,14 @@ paths:
additionalProperties: false
summary: 'Discount coupons insertion'
operationId: createDiscountCoupons
- description: "This endpoint allows you to insert specific discount coupons into Shoptet. Request is sent in JSON format in its body.\n\nIt is good to compare count of requested coupons with count of cooupons in response as it can be different. It is because of request validation, where it ignores invalid coupons."
+ description: |-
+ This endpoint allows you to insert specific discount coupons into
+ Shoptet. Request is sent in JSON format in its body.
+
+
+ It is good to compare count of requested coupons with count of cooupons
+ in response as it can be different. It is because of request validation,
+ where it ignores invalid coupons.
tags:
- 'Discount coupons'
requestBody:
@@ -28854,7 +32411,17 @@ paths:
$ref: '#/components/schemas/Errors'
summary: 'List of all discount coupons'
operationId: getListOfAllDiscountCoupons
- description: "Using this endpoint, you can get list of all discount coupons with detailed info of each discount coupon asynchronously. See how [Asynchronous requests](https://developers.shoptet.com/asynchronous-requests/) work on our developer's portal.\n\nResponse will be in [jsonlines](https://jsonlines.org/) format with each product taking one line of output file. One discount coupon in response has the same format as one discount coupon item form list response.\n\nResult file is compressed using GZIP."
+ description: |-
+ Using this endpoint, you can get list of all discount coupons with detailed info of each discount coupon
+ asynchronously. See how [Asynchronous requests](https://developers.shoptet.com/asynchronous-requests/)
+ work on our developer's portal.
+
+
+ Response will be in [jsonlines](https://jsonlines.org/) format with each product taking one line of output file.
+ One discount coupon in response has the same format as one discount coupon item form list response.
+
+
+ Result file is compressed using GZIP.
tags:
- 'Discount coupons'
parameters:
@@ -28932,7 +32499,10 @@ paths:
-
name: shippingPrice
in: query
- description: 'How the transport prices are calculated: according to the cart before discounts (beforeDiscount), according to the displayed value of the cart (cart), or free (free)'
+ description: |-
+ How the transport prices are calculated: according to the cart
+ before discounts (beforeDiscount), according to the displayed value
+ of the cart (cart), or free (free)
required: true
example: cart
schema:
@@ -29034,7 +32604,12 @@ paths:
instance: AB12345
summary: 'Discount coupon deletion'
operationId: deleteDiscountCoupon
- description: "Deletes discount coupon as per entered `code`. If successful, returns the code 200.\nIf the discount coupon does not exist within the e-shop, a 404 code is returned."
+ description: |-
+ Deletes discount coupon as per entered `code`. If successful, returns
+ the code 200.
+
+ If the discount coupon does not exist within the e-shop, a 404 code is
+ returned.
tags:
- 'Discount coupons'
parameters:
@@ -29171,7 +32746,10 @@ paths:
additionalProperties: false
summary: 'Discount coupons set creation'
operationId: createDiscountCouponsSet
- description: 'This endpoint allows you to create set of discount coupons for Shoptet.It is good to compare count of requested coupons with count of cooupons in response as it can be different. It is because of request validation, where it ignores invalid coupons.'
+ description: |-
+ This endpoint allows you to create set of discount coupons for Shoptet.It is good to compare count of requested
+ coupons with count of cooupons in response as it can be different. It is because of request validation,
+ where it ignores invalid coupons.
tags:
- 'Discount coupons'
requestBody:
@@ -29506,7 +33084,9 @@ paths:
additionalProperties: false
summary: 'Templates of discount coupons'
operationId: getTemplatesOfDiscountCoupons
- description: 'Templates of discount coupons within the e-shop. All templates are listed at a time. Without possibility of paging or filtering.'
+ description: |-
+ Templates of discount coupons within the e-shop. All templates are listed at a time. Without possibility of
+ paging or filtering.
tags:
- 'Discount coupons'
parameters:
@@ -29730,7 +33310,9 @@ paths:
errors:
-
errorCode: discount-coupon-template-not-found
- message: 'Discount coupon template "bffa3b98-d968-11e0-b04f-57a43310b768" was not found.'
+ message: |-
+ Discount coupon template
+ "bffa3b98-d968-11e0-b04f-57a43310b768" was not found.
instance: bffa3b98-d968-11e0-b04f-57a43310b768
409:
description: Conflict
@@ -29748,11 +33330,22 @@ paths:
errors:
-
errorCode: discount-coupon-template-used
- message: 'Discount coupon template "bffa3b98-d968-11e0-b04f-57a43310b768" cannot be deleted because it is used.'
+ message: |-
+ Discount coupon template
+ "bffa3b98-d968-11e0-b04f-57a43310b768" cannot be deleted
+ because it is used.
instance: bffa3b98-d968-11e0-b04f-57a43310b768
summary: 'Discount coupons template deletion'
operationId: deleteDiscountCouponsTemplate
- description: "Deletes discount coupon template as per entered `guid`. If successful, returns the code 200.\nIf the discount coupon template does not exist within the e-shop, a 404 code is returned.\nIf the discount coupon template cannot be deleted, because it is used as template of discount coupon, a 409 code is returned."
+ description: |-
+ Deletes discount coupon template as per entered `guid`. If successful,
+ returns the code 200.
+
+ If the discount coupon template does not exist within the e-shop, a 404
+ code is returned.
+
+ If the discount coupon template cannot be deleted, because it is used as
+ template of discount coupon, a 409 code is returned.
tags:
- 'Discount coupons'
parameters:
@@ -29875,7 +33468,9 @@ paths:
-
name: customerGroupCode
in: query
- description: 'customer group code, possible values can be get by customer group list endpoint'
+ description: |-
+ customer group code, possible values can be get by customer group
+ list endpoint
example: retail
schema:
type: string
@@ -30371,7 +33966,9 @@ paths:
additionalProperties: false
summary: 'X + Y discounts settings'
operationId: getXYDiscountsSettings
- description: 'Lists & updates settings of X + Y discounts. Please note, that `enableInCashdesk` setting is not supported on HU projects.'
+ description: |-
+ Lists & updates settings of X + Y discounts.
+ Please note, that `enableInCashdesk` setting is not supported on HU projects.
tags:
- 'X + Y discounts'
parameters:
@@ -30439,7 +34036,9 @@ paths:
errors:
-
errorCode: invalid-request-data
- message: 'Does not have a value in the enumeration ["all-categories","primary-category",null]'
+ message: |-
+ Does not have a value in the enumeration
+ ["all-categories","primary-category",null]
instance: data.categoryTargeting
schema:
type: object
@@ -30453,11 +34052,28 @@ paths:
errors:
-
errorCode: invalid-request-data
- message: 'Does not have a value in the enumeration ["all-categories","primary-category",null]'
+ message: |-
+ Does not have a value in the enumeration
+ ["all-categories","primary-category",null]
instance: data.categoryTargeting
summary: 'X + Y discount settings update'
operationId: updateXYDiscountSettings
- description: "Updates settings for X + Y discounts. All settings are optional, but at least one should be present.\nPlease note, that updating \"enableInCashdesk\" setting on HU projects will throw an exception.\n\nIf you're targeting a discount to a specific category, right now, we only include products that have\nthat category as their primary one. If you want to include all products in that category in the discount,\nnot just the ones in the primary category, please use `categoryTargeting` attribute with `all-categories` value."
+ description: |-
+ Updates settings for X + Y discounts. All settings are optional, but at
+ least one should be present.
+
+ Please note, that updating "enableInCashdesk" setting on HU projects
+ will throw an exception.
+
+
+ If you're targeting a discount to a specific category, right now, we
+ only include products that have
+
+ that category as their primary one. If you want to include all products
+ in that category in the discount,
+
+ not just the ones in the primary category, please use
+ `categoryTargeting` attribute with `all-categories` value.
tags:
- 'X + Y discounts'
requestBody:
@@ -30539,7 +34155,9 @@ paths:
additionalProperties: false
summary: 'List of articles'
operationId: getListOfArticles
- description: 'Returns a list of articles with basic info. Supports [paging](#section/basic-principles-of-working-with-api/Paging)'
+ description: |-
+ Returns a list of articles with basic info.
+ Supports [paging](#section/basic-principles-of-working-with-api/Paging)
tags:
- Articles
parameters:
@@ -30591,7 +34209,7 @@ paths:
instance:
type: string
example:
- data: 'null'
+ data: null
errors:
-
errorCode: invalid-request-data
@@ -30748,7 +34366,18 @@ paths:
$ref: '#/components/schemas/Errors'
summary: 'List of all articles'
operationId: getListAllArticles
- description: "Using this endpoint, you can get list of all articles with detailed info of each article (like in Detail of article endpoint) asynchronously. See how [Asynchronous requests](https://developers.shoptet.com/asynchronous-requests/) work on our developer's portal.\n\nResponse will be in [jsonlines](https://jsonlines.org/) format with each product taking one line of output file. One article in response has the same format as article detail response.\n\nResult file is compressed using GZIP."
+ description: |-
+ Using this endpoint, you can get list of all articles with detailed info of each article
+ (like in Detail of article endpoint) asynchronously.
+ See how [Asynchronous requests](https://developers.shoptet.com/asynchronous-requests/) work on our
+ developer's portal.
+
+
+ Response will be in [jsonlines](https://jsonlines.org/) format with each product taking one line of output file.
+ One article in response has the same format as article detail response.
+
+
+ Result file is compressed using GZIP.
tags:
- Articles
parameters:
@@ -30896,7 +34525,7 @@ paths:
instance:
type: string
example:
- data: 'null'
+ data: null
errors:
-
errorCode: invalid-request-data
@@ -31137,7 +34766,7 @@ paths:
instance:
type: string
example:
- data: 'null'
+ data: null
errors:
-
errorCode: invalid-request-data
@@ -31154,7 +34783,7 @@ paths:
- Articles
requestBody:
content:
- application/vnd.shoptet.v1.0:
+ application/vnd.shoptet.v1.0+json:
schema:
type: object
required:
@@ -31324,9 +34953,10 @@ paths:
example:
data: null
errors:
- errorCode: article-section-not-found
- message: 'Article section with ID "123" not found.'
- instance: 123
+ -
+ errorCode: article-section-not-found
+ message: 'Article section with ID "123" not found.'
+ instance: '123'
summary: 'Detail of article section'
operationId: getDetailOfArticleSection
description: 'Returns a detail of the article section.'
@@ -31380,9 +35010,10 @@ paths:
example:
data: null
errors:
- errorCode: article-section-not-found
- message: 'Article section with ID "123" not found.'
- instance: 123
+ -
+ errorCode: article-section-not-found
+ message: 'Article section with ID "123" not found.'
+ instance: '123'
summary: 'Update of article section'
operationId: updateArticleSection
description: 'Updates the article section.'
@@ -31401,7 +35032,7 @@ paths:
- Articles
requestBody:
content:
- application/vnd.shoptet.v1.0:
+ application/vnd.shoptet.v1.0+json:
schema:
type: object
required:
@@ -31521,6 +35152,90 @@ paths:
description: "flag indicating, whether the article section can be viewed by everyone (value of the flag is: `all`), by logged in users only ('logged-in'), or by logged out users only ('logged-out')"
examples:
- logged-in
+ delete:
+ responses:
+ 200:
+ description: OK
+ content:
+ 'application/vnd.shoptet.v1.0+json; charset=utf-8':
+ schema:
+ type: object
+ properties:
+ data:
+ type: 'null'
+ additionalProperties: false
+ errors:
+ $ref: '#/components/schemas/Errors'
+ required:
+ - data
+ - errors
+ additionalProperties: false
+ 404:
+ description: 'Not Found'
+ content:
+ 'application/vnd.shoptet.v1.0+json; charset=utf-8':
+ example:
+ data: null
+ errors:
+ -
+ errorCode: article-section-not-found
+ message: 'Article section with ID "123" not found.'
+ instance: '123'
+ schema:
+ type: object
+ properties:
+ data:
+ type: 'null'
+ errors:
+ $ref: '#/components/schemas/Errors'
+ 409:
+ description: Conflict
+ content:
+ 'application/vnd.shoptet.v1.0+json; charset=utf-8':
+ example:
+ data: null
+ errors:
+ -
+ errorCode: article-section-contains-articles
+ message: 'Article section "683" cannot be deleted, because it contains 4 article(s) that would be deleted.'
+ instance: '683'
+ schema:
+ type: object
+ properties:
+ data:
+ type: 'null'
+ errors:
+ $ref: '#/components/schemas/Errors'
+ summary: 'Deletion of article section'
+ operationId: deleteArticleSection
+ description: |-
+ If the article section cannot be deleted, because it contains article(s), a
+ 409 code is returned.
+
+ Optional parameter `force` with `true` value allows deletion of article section including permanent deletion of
+ article(s) having this section set as default.
+ tags:
+ - Articles
+ parameters:
+ -
+ name: articleSectionId
+ in: path
+ description: 'article section ID'
+ required: true
+ example: '1'
+ schema:
+ type: number
+ -
+ name: force
+ in: query
+ description: 'allows deletion of article section that contains article(s) if set to `true`'
+ required: false
+ example: 'true'
+ schema:
+ type: boolean
+ default: 'false'
+ -
+ $ref: '#/components/parameters/DefaultContentType'
/api/pages:
get:
responses:
@@ -31740,14 +35455,18 @@ paths:
additionalProperties: false
summary: 'List of jobs'
operationId: getListOfJobs
- description: 'List of jobs in queue. Using the "status" parameter to filter by completed|pending|running|failed|expired|killed. Without this filter it will show all statuses. Also you can filter results depends on time of creation and completion.'
+ description: |-
+ List of jobs in queue. Using the "status" parameter to filter by completed|pending|running|failed|expired|killed.
+ Without this filter it will show all statuses. Also you can filter results depends on time of creation and completion.
tags:
- 'Job endpoints'
parameters:
-
name: status
in: query
- description: 'supported values: `completed`, `pending`, `running`, `failed`, `expired`, `killed`'
+ description: |-
+ supported values: `completed`, `pending`, `running`, `failed`,
+ `expired`, `killed`
example: completed
schema:
type: string
@@ -31877,7 +35596,10 @@ paths:
errors:
-
errorCode: job-detail-try-counter-exceeded-limit
- message: 'You have exceeded the limit of job detail request for unprocessed job "1xv8s4c". Please wait for job:finished event after job is completed!'
+ message: |-
+ You have exceeded the limit of job detail request for
+ unprocessed job "1xv8s4c". Please wait for job:finished
+ event after job is completed!
instance: 1xv8s4c
404:
description: 'Not Found'
@@ -31899,7 +35621,15 @@ paths:
instance: 1xv8s4c
summary: 'Job detail'
operationId: getJobDetail
- description: "Returns information about job. If job is completed, it will contain additional information about job result.\n\nReturns 404 if job does not exist.\nReturns 403 response if job detail of unprocessed job is requested more than 10 times."
+ description: |-
+ Returns information about job. If job is completed, it will contain
+ additional information about job result.
+
+
+ Returns 404 if job does not exist.
+
+ Returns 403 response if job detail of unprocessed job is requested more
+ than 10 times.
tags:
- 'Job endpoints'
parameters:
@@ -31951,7 +35681,9 @@ paths:
additionalProperties: false
summary: 'List of uploaded files'
operationId: getListOfUploadedFiles
- description: 'Retrieves your uploaded files that can be copied in supported endpoints to entities within e-shop.'
+ description: |-
+ Retrieves your uploaded files that can be copied in supported endpoints
+ to entities within e-shop.
tags:
- Files
parameters:
@@ -31985,7 +35717,69 @@ paths:
additionalProperties: false
summary: 'File upload'
operationId: uploadFile
- description: "Performes file upload asynchronously.\nPlease note that order of files matter (result of job respects the order of images in request).\n\nIn case of specifying filename, keep in mind that extension is checked whether it respects file type.\n\nThe result can be found in job detail in `resultUrl`. The result is formed as normal API response:\n\n```\n{\n \"data\": {\n \"images\":[\n {\n \"index\": 0,\n \"md5\": \"072c1a2005e17dcd3a3cca3d2c769264\",\n \"name\": \"kocka.png\",\n \"created\": \"2023-01-16T13:19:32+0100\",\n \"sourceUrl\": \"https://example.com/image.png\"\n }\n ]\n },\n \"errors\": [\n {\n \"errorCode\": \"file-upload-extension-mismatch\",\n \"message\": \"File extension png mismatch mime type image\\/jpeg of uploaded file (correct should be jpg).\",\n \"instance\": \"data[1]\"\n }\n ]\n}\n```\n\nIn the result's `images` section, there are successfully uploaded images with their info and with `index` field which is order of the image in the request (0-based indexing).\n\nIn the result's `errors` section, there are errors which occured during some images upload and with number in brackets in `data[0]` in `instance`, which is order of the image in the request (0-based indexing).\n\nSee more about file upload in the [files section of documentation](#section/Basic-principles-of-working-with-API/Files)\n\nSee how [Asynchronous requests](https://developers.shoptet.com/asynchronous-requests/) work on our developer's portal.\n\nCurrently maximum of 50 files can be uploaded in one request. Current filesize limit per file is 2MB."
+ description: |-
+ Performes file upload asynchronously.
+
+ Please note that order of files matter (result of job respects the order
+ of images in request).
+
+
+ In case of specifying filename, keep in mind that extension is checked
+ whether it respects file type.
+
+
+ The result can be found in job detail in `resultUrl`. The result is
+ formed as normal API response:
+
+
+ ```
+
+ {
+ "data": {
+ "images":[
+ {
+ "index": 0,
+ "md5": "072c1a2005e17dcd3a3cca3d2c769264",
+ "name": "kocka.png",
+ "created": "2023-01-16T13:19:32+0100",
+ "sourceUrl": "https://example.com/image.png"
+ }
+ ]
+ },
+ "errors": [
+ {
+ "errorCode": "file-upload-extension-mismatch",
+ "message": "File extension png mismatch mime type image\/jpeg of uploaded file (correct should be jpg).",
+ "instance": "data[1]"
+ }
+ ]
+ }
+
+ ```
+
+
+ In the result's `images` section, there are successfully uploaded images
+ with their info and with `index` field which is order of the image in
+ the request (0-based indexing).
+
+
+ In the result's `errors` section, there are errors which occured during
+ some images upload and with number in brackets in `data[0]` in
+ `instance`, which is order of the image in the request (0-based
+ indexing).
+
+
+ See more about file upload in the [files section of
+ documentation](#section/Basic-principles-of-working-with-API/Files)
+
+
+ See how [Asynchronous
+ requests](https://developers.shoptet.com/asynchronous-requests/) work on
+ our developer's portal.
+
+
+ Currently maximum of 50 files can be uploaded in one request. Current
+ filesize limit per file is 2MB.
tags:
- Files
requestBody:
@@ -32104,7 +35898,10 @@ paths:
additionalProperties: false
summary: 'List of available endpoints'
operationId: getListOfAvailableEndpoints
- description: 'List of endpoints available within the systems. Using the "status" parameter, you can list the approved endpoints, or endpoints pending approval. In default state, without the parameter, the endpoint returns the approved endpoints.'
+ description: |-
+ List of endpoints available within the systems. Using the "status" parameter, you can list the approved
+ endpoints, or endpoints pending approval. In default state, without the parameter, the endpoint returns
+ the approved endpoints.
tags:
- 'System endpoints'
parameters:
@@ -34387,7 +38184,13 @@ components:
- 'null'
description: 'product description. May contain html.'
examples:
- - "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.
\n\n\n\t- Body - 60% Nylon, 40% wool
\n- Inside - 100% Polyester
\n
"
+ - |-
+ 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.
+
+
+ - Body - 60% Nylon, 40% wool
+ - Inside - 100% Polyester
+
metaDescription:
type:
- string
@@ -37615,96 +41418,3 @@ components:
description: 'remark for the discount coupon.'
examples:
- 'Note: This is a test discount coupon'
-security:
- -
- shoptetAccessToken: []
- -
- shoptetPrivateApiToken: []
-tags:
- -
- name: Eshop
- description: 'This endpoint is used for general information about the e-shop settings.'
- -
- name: Products
- description: 'Product endpoints are used for managing products in the e-shop and also for its related modules.'
- -
- name: 'Price lists'
- description: 'Price lists are used for setting up different prices for products for different customer groups.'
- -
- name: Orders
- description: 'Order endpoints are used for managing orders in the e-shop.'
- -
- name: Invoices
- description: 'Invoice endpoints are used for managing invoices in the e-shop.'
- -
- name: 'Proforma invoices'
- description: "Proforma invoice endpoints are used for managing proforma invoices in the e-shop.\n\nThe 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\nletters, a dash, etc."
- -
- name: 'Credit notes'
- description: "Credit note endpoints are used for managing credit notes in the e-shop.\nThe 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\nletters, a dash, etc."
- -
- name: 'Delivery notes'
- description: "Delivery note endpoints are used for managing delivery notes in the e-shop.\n\nThe 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\nletters, a dash, etc."
- -
- name: 'Proof payments'
- description: '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.'
- -
- name: Stocks
- description: 'Stock endpoints are used for managing stocks in the e-shop.'
- -
- name: Suppliers
- description: 'Supplier endpoints are used for managing suppliers in the e-shop.'
- -
- name: Brands
- description: "Brand endpoints are used for managing brands in the e-shop.\n\n**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."
- -
- name: Customers
- description: 'Customer endpoints are used for managing customers in the e-shop.'
- -
- name: Templates
- description: "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\ninto previously defined places. This enables the code or link to a file containing additional CSS styles or JavaScript codes to be entered.\nThe same functionality is now included within the e-shop administration (`/admin/html-kody/`, `HTML code` tab).\n\nThere are 3 possible locations, where HTML codes can be inserted:\n\n* `common-header` - the code will be inserted into each e-shop page header (``)\n\n* `common-footer` - the code will be inserted into each e-shop page foot (before end ``)\n\n* `order-confirmed` - the code will be inserted in the page confirming the order (the \"thank you page\")\n\nThe inserted codes may come from 3 sources, and they are included in the following order:\n1. 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.\n2. 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.\n3. The code entered in the administration GUI (`/admin/html-kody/`, `HTML code` tab)."
- -
- name: 'Payment gateways'
- description: "API endpoints for integration of payment gateways.\n\n**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**."
- -
- name: Webhooks
- description: "API endpoints for webhook servicing. It offers the possibility to read, add, change and delete the registered webhooks. Furthermore, it offers\na list of notifications about invoked webhooks and their status.\n\nThe webhooks are HTTP calls, which send HTTPs calls to registered subscribers if a specific event happens,\nfor example creating an order. Then the information, in JSON format, is delivered to the defined URL.\n\n```javascript\n{\n \"eshopId\": 222651,\n \"event\": \"order:create\",\n \"eventCreated\": \"2019-01-08T15:13:39+0100\",\n \"eventInstance\": \"2018000057\"\n}\n```\n\nThe meaning of individual items:\n\n* `eshopId` - number of the e-shop, where the event happened\n\n* `event` - event which invoked the call (see code list Webhook event types)\n\n* `eventCreated` - accurate time, when the event happened\n\n* `eventInstance` - reference to a specified entity - according to the context, order number, invoice number, product GUID, etc.\n\nFor more information about the function of webhooks, see https://developers.shoptet.com/webhooks/."
- -
- name: 'Shipping methods'
- description: 'Shipping methods endpoints are used for managing shipping methods in the e-shop.'
- -
- name: 'Shipping requests'
- description: 'Shipping requests endpoints are used for managing shipping requests in the e-shop.'
- -
- name: 'Payment methods'
- description: 'Payment methods endpoints are used for managing payment methods in the e-shop.'
- -
- name: 'Unsubscribed emails'
- description: '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.'
- -
- name: 'E-mail distribution lists'
- description: 'The functionality is subject to module activation [Mass e-mailing](https://doplnky.shoptet.cz/hromadne-rozesilani-emailu) within the e-shop. The addon using this endpoint must therefore have this module defined as dependency.'
- -
- name: 'Discount coupons'
- description: 'Discount coupons endpoints are used for managing discount coupons in the e-shop.'
- -
- name: 'X + Y discounts'
- description: 'X + Y discounts endpoints are used for managing X + Y discounts in the e-shop.'
- -
- name: Articles
- description: 'Article endpoints are used for managing articles in the e-shop.'
- -
- name: Pages
- description: 'Page endpoints are used for managing pages in the e-shop.'
- -
- name: Discussions
- description: 'Discussion endpoints are used for managing discussions in the e-shop.'
- -
- name: 'Job endpoints'
- description: 'Job endpoints are used for managing asynchronous jobs in the e-shop.'
- -
- name: Files
- description: 'File endpoints are used for managing files in the e-shop.'
- -
- name: 'System endpoints'
- description: 'This endpoints are used for obtaining information for endpoints in API.'
diff --git a/openapi/redocly.yaml b/openapi/redocly.yaml
index 9e1a3fd..882fe70 100644
--- a/openapi/redocly.yaml
+++ b/openapi/redocly.yaml
@@ -7,6 +7,7 @@ extends:
rules:
no-ambiguous-paths: off # Disable this rule because it needs rework our full API routing
operation-4xx-response: off # Disable this rule we have a lot of missing 4xx responses
+ info-license: off
rule/tag-description:
subject:
type: Tag
@@ -15,6 +16,17 @@ rules:
defined: true
pattern: /^[A-Z0-9*].*\.$/s
message: Tag description is missing or not start with a capital letter and end with a full stop.
+ request-mime-type:
+ severity: error
+ allowedValues:
+ - application/vnd.shoptet.v1.0+json
+ response-mime-type:
+ severity: error
+ allowedValues:
+ - application/vnd.shoptet.v1.0+json; charset=utf-8
+ - application/vnd.shoptet.v1.0+json
+ no-invalid-media-type-examples:
+ severity: error
mockServer:
- off: true
+ off: true # Disable the mock server - currently not working with our vendor content-types