---
title: Shoptet API Integration on Truto
slug: shoptet
category: E-Commerce
canonical: "https://truto.one/integrations/detail/shoptet/"
---

# Shoptet API Integration on Truto



**Category:** E-Commerce  
**Status:** Beta

## MCP-ready AI tools

Truto exposes 344 tools for Shoptet that AI agents can call directly.

- **shoptet_abandoned_carts_bulk_snapshot** — List of all abandoned carts. Using this endpoint, you can get list of all abandoned carts asynchronously. See how Asynchronous requests work on our developer's portal. Response will be in jsonlines format with each abandoned cart taking one line of output file. Asynchronous: returns a job ID; the result file is announced by the job:finished webhook (see system_jobs.get).
- **create_a_shoptet_api_access_token** — Swap the add-on's OAuth access token for a 30-minute API access token (GET https://<eshop>/action/ApiOAuthServer/getAccessToken). The connector calls this on connect and every 20 minutes for add-on connections; you rarely need it directly. Not used with a Private API token.
- **list_all_shoptet_article_sections** — List of article sections. Returns a list of article sections.
- **create_a_shoptet_article_section** — Insert of article section. Creates a new article section. Required: data.
- **get_single_shoptet_article_section_by_id** — Detail of article section. Returns a detail of the article section. Required: id.
- **update_a_shoptet_article_section_by_id** — Update of article section. Updates the article section. Required: id, data.
- **delete_a_shoptet_article_section_by_id** — Deletion of article section. 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. Required: id.
- **list_all_shoptet_articles** — List of articles. Returns a list of articles with basic info. Supports Paging. The connector pages through all results (up to 10 per page).
- **create_a_shoptet_article** — Insert of article. Creates a new article. Required: data.
- **shoptet_articles_bulk_snapshot** — List of all articles. 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 work on our developer's portal. Asynchronous: returns a job ID; the result file is announced by the job:finished webhook (see system_jobs.get).
- **get_single_shoptet_article_by_id** — Detail of article. Returns a detail of the article. Required: id.
- **update_a_shoptet_article_by_id** — Update of article. Updates the article. Required: id, data.
- **delete_a_shoptet_article_by_id** — Delete of article. Deletes the article. Required: id.
- **list_all_shoptet_brands** — List of brands. Returns the list of brands. Supports the Paging. The connector pages through all results (up to 1000 per page).
- **create_a_shoptet_brand** — Creation of brand. Required: data.
- **get_single_shoptet_brand_by_id** — Detail of brand. Required: id.
- **update_a_shoptet_brand_by_id** — Update of brand. Required: id, data.
- **delete_a_shoptet_brand_by_id** — Deletion of brand. 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. Required: id.
- **shoptet_brands_bulk_create** — BATCH creation of brands. 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. Required: batchFileUrlPath.
- **list_all_shoptet_categories** — List of product categories. Returns the list of product categories. The connector pages through all results (up to 1000 per page).
- **create_a_shoptet_category** — Product category create. Creates new category. Required: data.
- **get_single_shoptet_category_by_id** — Product category detail. Returns category info. Required: id.
- **update_a_shoptet_category_by_id** — Product category update. Updates existing category. Required: id, data.
- **delete_a_shoptet_category_by_id** — Product category deletion. Deletes product category as per entered categoryGuid. If successful, returns the code 200. If the category does not exist within the e-shop, a 404 code is returned. If the category cannot be deleted, because it is used by some product or has children, a 409 code is returned. Required: id.
- **shoptet_categories_bulk_update** — Product category BATCH update. This endpoint allows you to update multiple categories at once. Batch update is processed asynchronously in same way as for example products snapshot, but it does not have resultUrl with categories to download in response. Required: batchFileUrlPath.
- **shoptet_categories_bulk_update_products_priority** — Category products priority BATCH update. This endpoint allows you to update multiple categories with product priorities at once. Batch update is processed asynchronously in same way as for example products snapshot, but it does not have resultUrl in response. Required: batchFileUrlPath.
- **list_all_shoptet_category_products_priorities** — List of products order in category. Retrieves products and their priorities within a category. Required: category_guid. The connector pages through all results (up to 2000 per page).
- **shoptet_category_products_priorities_bulk_update** — Update product order in category. Using this endpoint you can update product priority within a category. You can request multiple updates at once; the maximum is 300 updates per request. Each item must identify the product by either productGuid or productCode (exactly one must be provided per item). Required: category_guid, data.
- **list_all_shoptet_credit_note_changes** — Last credit note changes. 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. Required: from. The connector pages through all results (up to 20 per page).
- **list_all_shoptet_credit_note_isdocs** — Download credit note as ISDOC. You can request the credit note as ISDOC file, response will be as application/octet-stream. You can download the documents only one-by-one for every e-shop. Parallel requests end with 423 Locked error. Required: credit_note_code.
- **create_a_shoptet_credit_note_item** — Creation of credit note item. Creates a new credit note item to an existing credit, only billing or shipping item types are allowed. Required: credit_note_code, data.
- **update_a_shoptet_credit_note_item_by_id** — Update of credit note item. 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. Required: id, credit_note_code, data.
- **delete_a_shoptet_credit_note_item_by_id** — Deletion of credit note item. Deletes credit note item. It's not possible to delete credit note item of another type then product or product-set. Required: id, credit_note_code.
- **list_all_shoptet_credit_note_pdfs** — Download credit note as PDF. 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. Required: credit_note_code.
- **create_a_shoptet_credit_note_restock** — Credit note restock. Restock items from credit note. Required: credit_note_code.
- **list_all_shoptet_credit_notes** — List of credit notes. The list of credit notes supports Paging. The connector pages through all results (up to 20 per page).
- **shoptet_credit_notes_bulk_snapshot** — List of all credit notes. Using this endpoint, you can get list of all credit notes with detailed info of each credit note (like in Credit note detail endpoint) asynchronously. See how Asynchronous requests work on our developer's portal. Asynchronous: returns a job ID; the result file is announced by the job:finished webhook (see system_jobs.get).
- **get_single_shoptet_credit_note_by_id** — Credit note detail. Additional information about one credit note. This endpoint has several sections, which are only sent when requested in the include parameter (see Section on demand). Value | Section --------|------ surchargeParameters| Item surcharge parameters. Required: id.
- **update_a_shoptet_credit_note_by_id** — Credit note update. Required: id, data.
- **delete_a_shoptet_credit_note_by_id** — Credit note deletion. Required: id.
- **list_all_shoptet_customer_accounts** — List of customer accounts. List of customer accounts supports the Paging. Required: customer_guid. The connector pages through all results (up to 1000 per page).
- **create_a_shoptet_customer_account** — Creation of customer account. Required: customer_guid, data.
- **get_single_shoptet_customer_account_by_id** — Detail of customer account. Required: id, customer_guid.
- **update_a_shoptet_customer_account_by_id** — Update of customer account. Required: id, customer_guid, data.
- **delete_a_shoptet_customer_account_by_id** — Deletion of customer account. Required: id, customer_guid.
- **list_all_shoptet_customer_changes** — Last customer changes. 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). Required: from. The connector pages through all results (up to 20 per page).
- **list_all_shoptet_customer_delivery_addresses** — List of customer delivery addresses. List of customer delivery addresses, supports the Paging. Required: customer_guid. The connector pages through all results (up to 1000 per page).
- **create_a_shoptet_customer_delivery_address** — Creation of delivery address. Required: customer_guid, data.
- **get_single_shoptet_customer_delivery_address_by_id** — Detail of customer delivery address. Required: id, customer_guid.
- **update_a_shoptet_customer_delivery_address_by_id** — Update of customer delivery address. Required: id, customer_guid, data.
- **delete_a_shoptet_customer_delivery_address_by_id** — Deletion of customer delivery address. Required: id, customer_guid.
- **list_all_shoptet_customer_groups** — List of customer groups. Returns list of customer groups ordered by priority. List is not paginated.
- **create_a_shoptet_customer_group** — Creation of customer group. Creates a new customer group with specified settings. The customer group name must be unique. Returns the full list of customer groups including the newly created one. Required: data.
- **delete_a_shoptet_customer_group_by_id** — Deletion of customer group. Is not possible to delete default customer group. Deletion of customer group will not delete customers assigned to this group, but they will be assigned to default customer group. Required: id.
- **update_a_shoptet_customer_group_by_id** — Update of customer group. Updates an existing customer group with specified settings. Returns the full list of customer groups including the updated one. Required: id, data.
- **list_all_shoptet_customer_regions** — List of customer regions. Returns the list of customer regions. The regions are ordered by id. The list is not paginated.
- **list_all_shoptet_customer_remarks** — List of customer remarks. List of customer remarks, supports the Paging. Required: customer_guid. The connector pages through all results (up to 1000 per page).
- **create_a_shoptet_customer_remark** — Creation of customer remark. Required: customer_guid.
- **get_single_shoptet_customer_remark_by_id** — Detail of customer remark. Required: id, customer_guid.
- **update_a_shoptet_customer_remark_by_id** — Update of customer remark. Required: id, customer_guid, data.
- **delete_a_shoptet_customer_remark_by_id** — Deletion of customer remark. Required: id, customer_guid.
- **list_all_shoptet_customers** — List of customers. Listing of customers. Supports the Paging. The connector pages through all results (up to 1000 per page).
- **create_a_shoptet_customer** — Creation of customer. Required: data.
- **shoptet_customers_bulk_create** — Customer BATCH creation. This endpoint allows you to create multiple customers at once. Batch creation is processed asynchronously in same way as for example products snapshot, but it does not have resultUrl in response. Required: batchFileUrlPath.
- **shoptet_customers_bulk_snapshot** — List of all customers. 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 work on our developer's portal. Asynchronous: returns a job ID; the result file is announced by the job:finished webhook (see system_jobs.get).
- **get_single_shoptet_customer_by_id** — Customer detail. Additional information about one customer. Required: id.
- **update_a_shoptet_customer_by_id** — Update of customer. Required: id, data.
- **delete_a_shoptet_customer_by_id** — Deletion of customer. Required: id.
- **list_all_shoptet_delivery_note_pdfs** — Download delivery note as PDF. 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. Required: delivery_note_code.
- **list_all_shoptet_delivery_notes** — List of delivery notes. The list of delivery notes supports the Paging. The connector pages through all results (up to 100 per page).
- **shoptet_delivery_notes_bulk_snapshot** — List of all delivery notes. 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 work on our developer's portal. Asynchronous: returns a job ID; the result file is announced by the job:finished webhook (see system_jobs.get).
- **get_single_shoptet_delivery_note_by_id** — Detail of delivery note. Additional information about one delivery note. This endpoint has several sections, which are only sent when requested in the include parameter (see Section on demand). Value | Section --------|------ surchargeParameters| Item surcharge parameters. Required: id.
- **create_a_shoptet_discount_coupon_set** — Discount coupons set creation. 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. Required: data.
- **shoptet_discount_coupon_template_products_bulk_update** — Discount coupons template products update. Replaces the list of specific products assigned to the discount coupon template as per entered guid, and switches its productSelectionMode to specificProducts. An empty productGuids array clears the list, so the coupon matches no products. Required: template_guid, data.
- **list_all_shoptet_discount_coupon_templates** — Templates of discount coupons. Templates of discount coupons within the e-shop. All templates are listed at a time. Without possibility of paging or filtering.
- **create_a_shoptet_discount_coupon_template** — Discount coupons template insertion. Required: data.
- **get_single_shoptet_discount_coupon_template_by_id** — Discount coupons template detail. Returns a single discount coupon template by guid, including the list of specific products assigned to it. Required: id.
- **delete_a_shoptet_discount_coupon_template_by_id** — Discount coupons template deletion. 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. Required: id.
- **update_a_shoptet_discount_coupon_us_by_id** — Discount coupons usage update. This endpoint allows you to set usage of discount coupon. Required: id, data.
- **list_all_shoptet_discount_coupons** — List of discount coupons. 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. The connector pages through all results (up to 1000 per page).
- **create_a_shoptet_discount_coupon** — Discount coupons insertion. 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. Required: data.
- **shoptet_discount_coupons_bulk_update** — Bulk discount coupon update. Bulk partial update of existing discount coupons. Each coupon in the request must include code as the identifier. All remaining fields are optional and applied as a partial update — only provided fields are changed. When discountType is percentual, amount must not be provided. Required: data.
- **shoptet_discount_coupons_bulk_delete** — Bulk discount coupon deletion. Bulk deletion of discount coupons as per list of codes. If successful, returns the code 200. If some discount coupons does not exist within the e-shop, a 422 code is returned. Required: data.
- **shoptet_discount_coupons_bulk_snapshot** — List of all discount coupons. Using this endpoint, you can get list of all discount coupons with detailed info of each discount coupon asynchronously. See how Asynchronous requests work on our developer's portal. Response will be in jsonlines format with each discount coupon taking one line of output file. Required: template, shippingPrice. Asynchronous: returns a job ID; the result file is announced by the job:finished webhook (see system_jobs.get).
- **get_single_shoptet_discount_coupon_by_id** — Detail of discount coupon. Detail of discount coupon within the e-shop. Required: id.
- **delete_a_shoptet_discount_coupon_by_id** — Discount coupon deletion. 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. Required: id.
- **list_all_shoptet_discussion_posts** — List of discussion posts. List of discussion posts, filterable by product GUID, article ID, page ID, customer GUID, author's e-mail, and creation date. Requires "discussion" module to be active. The connector pages through all results (up to 100 per page).
- **create_a_shoptet_discussion_post** — Creation of discussion posts. Allows the creation of multiple discussion posts at once. The limit of items per request is defined to 100. Discussions can be created for: products, articles, and pages. Requires "discussion" module to be active. Request is processing all the items. Required: data.
- **update_a_shoptet_discussion_post_by_id** — Discussion post update. Updates discussion post's data. Requires "discussion" module to be active. Required: id, data.
- **delete_a_shoptet_discussion_post_by_id** — Removal of discussion post. Deletes discussion post. Requires "discussion" module to be active. Required: id.
- **list_all_shoptet_discussion_settings** — Discussion settings. Discussion settings configured in the administration for each discussion context (product, article, section article): whether discussions are enabled, whether posts require authorization before publishing, whether only registered users may post, whether customers can reply to exi.
- **list_all_shoptet_eshop** — Eshop info. Information about queried e-shop (defined by token). Returns the contact data and e-shop settings. This endpoint has several sections, which are only sent when requested in the include parameter (see Section on demand.
- **list_all_shoptet_eshop_customer_fields** — E-shop mandatory fields. Information about queried e-shop mandatory fields setting (defined by token). Returns the values, which are set by e-shop administrator in Settings -> Customers -> Mandatory fields.
- **list_all_shoptet_eshop_design** — E-shop design. Information about queried e-shop template setting (defined by token). backgroundImage value can internally contain the link to a transparent reference gif, in this case the API returns a NULL value.
- **list_all_shoptet_eshop_document_settings** — E-shop document settings. Information about financial documents settings.
- **list_all_shoptet_exports** — General document export. You can request documents of several types in several formats in combination with settings as includes. See tables bellow for possibilities and settings. Export is processed asynchronously. See how Asynchronous requests work on our developer's portal. Required: type, format.
- **list_all_shoptet_invoice_changes** — Last invoice changes. 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). Required: from. The connector pages through all results (up to 20 per page).
- **create_a_shoptet_invoice_credit_note** — Credit note from invoice creation. Creating credit note from existing invoice. This endpoint has several sections, which are only sent when requested in the include parameter (see Section on demand). Required: invoice_code, data.
- **list_all_shoptet_invoice_isdocs** — Download invoice as ISDOC. You can request the invoice as ISDOC file, response will be as application/octet-stream. You can download the documents only one-by-one for every e-shop. Parallel requests end with 423 Locked error. Required: invoice_code.
- **shoptet_invoice_link_proforma_invoices_bulk_update** — Invoice link proforma invoices. Linking proforma invoices to invoice. Proforma invoices must be related to the order, must be in same currency as the order, must be valid and cannot be linked to another invoice. Multiple proforma invoices are allowed to link to the invoice. Required: invoice_code, data.
- **shoptet_invoice_link_proof_payments_bulk_update** — Invoice link proof payments. 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. Required: invoice_code, data.
- **list_all_shoptet_invoice_pdfs** — Download invoice as PDF. 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. Required: invoice_code.
- **list_all_shoptet_invoices** — List of invoices. Returns the list of invoices with basic information. The list of invoices supports 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. The connector pages through all results (up to 1000 per page).
- **shoptet_invoices_bulk_snapshot** — List of all invoices. 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 work on our developer's portal. Asynchronous: returns a job ID; the result file is announced by the job:finished webhook (see system_jobs.get).
- **get_single_shoptet_invoice_by_id** — Invoice detail. 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. Required: id.
- **list_all_shoptet_mailing_list_changes** — Last changes in distribution list. 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. Required: from, mailing_list_code. The connector pages through all results (up to 500 per page).
- **create_a_shoptet_mailing_list_value** — Distribution list e-mails insertion. 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. Required: mailing_list_code, data.
- **list_all_shoptet_mailing_lists** — Listing of e-mail distribution lists. 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.
- **create_a_shoptet_mailing_list** — Insertion of e-mail distribution list. Required: data.
- **get_single_shoptet_mailing_list_by_id** — Detail of e-mail distribution list. 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. Required: id.
- **list_all_shoptet_order_changes** — Last order changes. 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. Required: from. The connector pages through all results (up to 1000 per page).
- **list_all_shoptet_order_claims** — Orders with product claims. Endpoint listing all ordered products with unfulfilled claims. Endpoint supports Paging. The connector pages through all results (up to 250 per page).
- **create_a_shoptet_order_delivery_note** — Delivery note from Order creation. Creating delivery note from existing order. Required: order_code, data.
- **list_all_shoptet_order_gift_settings** — Get order gift settings. There are order gift setting, which influence general behaviour.
- **shoptet_order_gift_settings_bulk_update** — Update order gift settings. Method updates order gift settings. Every item in request body is optional, but at least one setting is required. Required: data.
- **list_all_shoptet_order_gifts** — Get order gifts list. 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.
- **create_a_shoptet_order_gift** — Add order gift at the end of the list. Add order gift (product variant) at the end of the order gift list. Gift is defined by code. code, orderPrice and currencyCode is required. Required: data.
- **delete_a_shoptet_order_gift_by_id** — Delete order gift. Delete order gift item by primary key. Required: id.
- **shoptet_order_heads_bulk_update** — Order head change. 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 255 characters - billingAddress.fullName .. Required: order_code, data.
- **shoptet_order_history_bulk_snapshot** — List of all remarks. Using this endpoint, you can get list of all remarks with detailed info of each remark asynchronously. See how Asynchronous requests work on our developer's portal. Response will be in jsonlines format with each remark taking one line of output file. Asynchronous: returns a job ID; the result file is announced by the job:finished webhook (see system_jobs.get).
- **list_all_shoptet_order_history** — List of remarks for the order. The endpoint shows the order history which is displayed in Shoptet administration in the “History” tab, in the order detail. Required: order_code.
- **create_a_shoptet_order_history** — Insertion of remark to order. 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. Required: order_code, data.
- **delete_a_shoptet_order_history_by_id** — Delete order history item. Delete order history item by primary key. Required: id, order_code.
- **create_a_shoptet_order_invoice** — Invoice from order creation. Creating invoice from existing order. Required: order_code, data.
- **create_a_shoptet_order_item_surcharge_parameter** — Order item surcharge parameters insertion. There is possibility to edit surcharge parameters related to order item. Required: order_code, item_id, data.
- **delete_a_shoptet_order_item_surcharge_parameter_by_id** — Order item surcharge parameters deletion. You have to provide dynamically generated relationId which identify which surcharge parameter related to order item you want to delete. Required: id, order_code, item_id.
- **create_a_shoptet_order_item** — Order item add. Required: order_code, data.
- **update_a_shoptet_order_item_by_id** — Order item change. Required: id, order_code, data.
- **delete_a_shoptet_order_item_by_id** — Order item delete. Required: id, order_code.
- **shoptet_order_notes_bulk_update** — Update remarks for the order. 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. Required: order_code, data.
- **create_a_shoptet_order_payment** — Order payment add. Required: order_code, data.
- **update_a_shoptet_order_payment_by_id** — Order payment update. Required: id, order_code, data.
- **list_all_shoptet_order_pdfs** — Download order as PDF. 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. Required: order_code.
- **create_a_shoptet_order_proforma_invoice** — Proforma invoice from order creation. Creating proforma invoice from existing order. Required: order_code, data.
- **create_a_shoptet_order_shipping** — Order shipping add. Required: order_code, data.
- **update_a_shoptet_order_shipping_by_id** — Order shipping update. Required: id, order_code, data.
- **list_all_shoptet_order_sources** — List of order sources. Detailed information on current possible order sources within the e-shop.
- **shoptet_order_status_bulk_update** — Update of order status. 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. Required: order_code, data.
- **shoptet_order_status_changes_bulk_update** — Bulk order status change. The endpoint allows you to change the status for multiple order codes simultaneously. Non-existing order codes are skipped and summarized in response errors. The request process continues even if some order codes are skipped. Required: data.
- **list_all_shoptet_order_statuses** — List of order statuses. Detailed information on order status within the e-shop.
- **list_all_shoptet_orders** — List of orders. List of orders in e-shop and cash desks. Endpoint supports Paging. For default calls, it returns 50 orders, using the parameter ?itemsPerPage=100, you can request up to 100 orders at a time. Temporarily disabled, only 50 orders per page is supported. The connector pages through all results (up to 50 per page).
- **create_a_shoptet_order** — Order insertion. 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. Required: data.
- **shoptet_orders_bulk_snapshot** — List of all orders. 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 work on our developer's portal. The list may be filtered by date of creation and order code. Asynchronous: returns a job ID; the result file is announced by the job:finished webhook (see system_jobs.get).
- **get_single_shoptet_order_by_id** — Order detail. This endpoint has several sections, which are only sent when requested in the include parameter (see 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. Required: id.
- **delete_a_shoptet_order_by_id** — Order deletion. Required: id.
- **shoptet_orders_clone** — Order copy. This endpoint allows you to copy a order identified by its code. You can choose scope in which will be the order copied. Required: order_code, data.
- **shoptet_orders_bulk_create** — Order BATCH insertion. **Beta/Experimental feature: This endpoint is currently in beta and may exhibit unexpected behavior.** This endpoint allows you to create multiple orders at once. Required: batchFileUrlPath.
- **list_all_shoptet_pages** — List of pages. Returns a list of pages. The connector pages through all results (up to 20 per page).
- **create_a_shoptet_page** — Insert of page. Creates a new page. Required: data.
- **get_single_shoptet_page_by_id** — Detail of page. Returns a detail of the page. Required: id.
- **delete_a_shoptet_page_by_id** — Delete of page. Deletes the page. Required: id.
- **update_a_shoptet_page_by_id** — Update of page. Updates the page. Required: id, data.
- **list_all_shoptet_parametric_categories** — List of parametric categories. Returns the list of product categories. The connector pages through all results (up to 100 per page).
- **create_a_shoptet_parametric_category** — Creation of parametric category. Creates a new combination for a parametric category. **Prerequisites:** Before creating a combination, a parametric category definition for the selected parameterCodes and the given category must exist. Create one via POST /parametric-categories-definition. Required: data.
- **get_single_shoptet_parametric_category_by_id** — Parametric category detail. Returns parametric category info. Required: id.
- **update_a_shoptet_parametric_category_by_id** — Update of parametric category. Updates existing parametric category. The "Advanced SEO" module must be active to use this endpoint. This endpoint is language dependent. While active module "Foreign languages" you can use language query parameter to specify the language of updated parametric category. Required: id, data.
- **delete_a_shoptet_parametric_category_by_id** — Delete of parametric category. Delete existing parametric category. The "Advanced SEO" module must be active to use this endpoint. Required: id.
- **get_single_shoptet_parametric_category_available_parameter_by_id** — Parametric category available parameters. Returns all available parameters for a parent category that can be used when creating parametric categories and their combinations. The "Advanced SEO" module must be active to use this endpoint. Required: id.
- **create_a_shoptet_parametric_category_definition** — Creation of parametric category definition. Creates a new parametric category definition for a given category and set of parameters. The definition specifies which parameters are used to generate parametric category pages for the specified category. You can specify 1 to 4 parameters. Required: data.
- **list_all_shoptet_payment_methods** — Listing of payment methods. 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.
- **create_a_shoptet_payment_method** — Adding the payment methods. 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. Required: data.
- **delete_a_shoptet_payment_method_by_id** — Payment method deletion. Deletes payment method by guid. Only payment methods related to your addon may be deleted. Private API tokens aren't currently supported. Required: id.
- **get_single_shoptet_payment_status_by_id** — Gaining the information about payment. Returns the URL, at which the payment gateway shall redirect the users after completion of operation and order number. Required: id.
- **update_a_shoptet_payment_status_by_id** — Payment status update. 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.**. Required: id, data.
- **list_all_shoptet_price_list_prices** — Price list prices. Prices of every product (variant) in the given price list, with info on discounts and limitations of purchase (minimum and maximum amount). Required: price_list_id. The connector pages through all results (up to 100 per page).
- **shoptet_price_list_prices_bulk_update** — Update price list prices. This endpoint allows updating price fields and other attributes of the prices in a price list, per product (variant). You can request multiple updates at once; the maximum is 300 updates per request. Required: price_list_id, data.
- **shoptet_price_list_prices_bulk_update_async** — Batch price list prices update. This endpoint allows updating multiple prices at once. Price fields and other attributes of the prices in a price list, per product (variant), can be updated. Required: price_list_id, batchFileUrlPath.
- **shoptet_price_list_prices_bulk_snapshot** — Snapshot of all prices in a price list. Using this endpoint, you can get all prices in the given price list asynchronously, with the same information per price as the Price list prices endpoint. See how Asynchronous requests work on our developer’s portal. Required: price_list_id. Asynchronous: returns a job ID; the result file is announced by the job:finished webhook (see system_jobs.get).
- **list_all_shoptet_price_lists** — List of price lists. Listing of all price lists set up in e-shop. Does not contain the paging, always lists all price lists.
- **create_a_shoptet_price_list** — Price list insertion. currency is optional. Omit it, or send null, to create the price list without one, in which case the e-shop default currency applies. A code the e-shop does not know answers 422 invalid-request-data. Required: data.
- **get_single_shoptet_price_list_by_id** — Price list detail. The price list itself, not the prices in it. For those use /api/price-lists/{id}/prices. isDefault marks the e-shop default price list, which is the only one where buyPrice is writable. Required: id.
- **update_a_shoptet_price_list_by_id** — Price list update. Updates the price list itself, not the prices in it. For those use PATCH /api/price-lists/{id}/prices. Every field is optional and send only what changes; a field left out is left as it is. The response is the whole entity, in the same shape GET returns it. Required: id, data.
- **delete_a_shoptet_price_list_by_id** — Price list delete. Deletion of a price list can fail with error 423 in case of running import. To delete prices inside a price list rather than the price list itself, use /api/price-lists/{id}/prices. Required: id.
- **shoptet_price_lists_bulk_snapshot_prices** — Snapshot of all prices across all price lists. Using this endpoint, you can get list of all products with basic data such as product guid, id, code and its prices across all price lists. Response will be in jsonlines format with each product taking one line of output file. Asynchronous: returns a job ID; the result file is announced by the job:finished webhook (see system_jobs.get).
- **shoptet_pricelist_prices_bulk_update** — Batch pricelist update. This endpoint allows updating multiple prices at once. Price fields and other attributes from a pricelist of a product (variant) can be updated. Required: pricelist_id, batchFileUrlPath.
- **list_all_shoptet_pricelists** — List of price lists. Listing of all price lists set up in e-shop. Does not contain the paging, always lists all price lists.
- **create_a_shoptet_pricelist** — Pricelist insertion. Required: data.
- **get_single_shoptet_pricelist_by_id** — Pricelist detail. Price list detail with product prices (variants) and info on discounts and limitations of purchase (minimum and maximum price). Required: id.
- **update_a_shoptet_pricelist_by_id** — Update pricelist. This endpoint allows updating price fields and other attributes from a pricelist of a product (variant). You can request multiple updates at once; the maximum is 300 updates per request. Required: id, data.
- **delete_a_shoptet_pricelist_by_id** — Pricelist delete. Deletion of pricelist can fail with error 423 in case of running import. Required: id.
- **shoptet_pricelists_bulk_snapshot** — List of all price list details. Using this endpoint, you can get list of all price list details with information on each price (like in Price list Detail endpoint) asynchronously. See how Asynchronous requests work on our developer’s portal. Required: pricelist_id. Asynchronous: returns a job ID; the result file is announced by the job:finished webhook (see system_jobs.get).
- **list_all_shoptet_product_alternative_products** — List of product alternative products. Returns list of alternative products related to product defined by guid, list is ordered by priority parameter. Required: product_guid.
- **create_a_shoptet_product_alternative_product** — Add alternative product. This method add given product, defined with guid at the end of the alternative product list. After product is successfully saved, complete list of alternative product is returned in response. Required: product_guid, data.
- **shoptet_product_alternative_products_bulk_update** — Set alternative products. This method set given products (minimum 0, maximum 50), defined with guid to the alternative product list. After product is successfully saved, complete list of alternative product is returned in response. Required: product_guid, data.
- **list_all_shoptet_product_availabilities** — List of products availabilities. Returns the list of product availabilities within the e-shop and default availabilities ids.
- **create_a_shoptet_product_availability** — Product availability creation. Creates a new product availability. Required: data.
- **update_a_shoptet_product_availability_by_id** — Update of product availability. Updates a product availability. Required: id, data.
- **delete_a_shoptet_product_availability_by_id** — Deletion of product availability. Deletes a product availability. Required: id.
- **list_all_shoptet_product_changes** — Last product changes. Returns the list of products, which were changed (added/edited or deleted). Endpoint is intended to determine the changes after you have loaded the complete list of products and you need to know if any of these have been changed. Required: from. The connector pages through all results (up to 1000 per page).
- **list_all_shoptet_product_consumption_taxes** — List of product consumption taxes. Returns the list of consumption taxes within the e-shop. In order to list consuption taxes, you will need to have the Consumption tax module activated on the customer's e-shop.
- **create_a_shoptet_product_consumption_tax** — Creation of consumption tax. Required: data.
- **update_a_shoptet_product_consumption_tax_by_id** — Update of consumption tax. Required: id, data.
- **delete_a_shoptet_product_consumption_tax_by_id** — Deletion of consumption tax. Required: id.
- **create_a_shoptet_product_filtering_parameter_value** — Creation of filtering parameter value. Required: filtering_parameter_code, data.
- **delete_a_shoptet_product_filtering_parameter_value_by_id** — Removal of filtering parameter value. Required: id, filtering_parameter_code.
- **update_a_shoptet_product_filtering_parameter_value_by_id** — Update of filtering parameter value. Required: id, filtering_parameter_code, data.
- **list_all_shoptet_product_filtering_parameters** — List of filtering parameters. Returns the list of available filtering parameters with their available values within the e-shop. The connector pages through all results (up to 100 per page).
- **create_a_shoptet_product_filtering_parameter** — Creation of filtering parameter. Required: data.
- **get_single_shoptet_product_filtering_parameter_by_id** — Detail of filtering parameter. Required: id.
- **update_a_shoptet_product_filtering_parameter_by_id** — Update of filtering parameter. Required: id, data.
- **delete_a_shoptet_product_filtering_parameter_by_id** — Removal of filtering parameter. Required: id.
- **list_all_shoptet_product_flags** — List of products flags. Returns the list of product flags within the e-shop.
- **create_a_shoptet_product_flag** — Product flag insertion. Required: data.
- **update_a_shoptet_product_flag_by_id** — Product flag update. Updates the flag. Required: id, data.
- **delete_a_shoptet_product_flag_by_id** — Product flag delete. Deletes the flag. System flags cannot be deleted. Required: id.
- **list_all_shoptet_product_gifts** — List of product gifts. Returns list of gifts related (product variants) to product. Required: product_guid.
- **create_a_shoptet_product_gift** — Insertion gift product. Required: product_guid, data.
- **shoptet_product_gifts_bulk_update** — Setting gifts to product. Required: product_guid, data.
- **shoptet_product_image_sources_bulk_update** — Product images source update. Using this endpoint you can modify product image attributes and also upload a new image and replace the existing one. This is an asynchronous request, see how Asynchronous requests work on our developer's portal. Required: product_guid, gallery, data.
- **shoptet_product_images_bulk_remove** — Product image BATCH delete. This endpoint allows you to delete multiple product images at once. Batch delete is processed asynchronously. See how Asynchronous requests work on our developer's portal. File with data must be in JSONL (jsonlines) format. Each line must contain one item in JSON format. Required: batchFileUrlPath.
- **shoptet_product_images_bulk_insert** — Product image BATCH insert. This endpoint allows you to insert multiple product images to multiple product/galleries at once. Batch is processed asynchronously. See how Asynchronous requests work on our developer's portal. File with data must be in JSONL (jsonlines) format. Required: batchFileUrlPath.
- **list_all_shoptet_product_images** — List of product images. Returns list of product's images. Data from this endpoint and from product's detail endpoint (list named images when using ?include=images parameter) are the same. Use this endpoint when working only with product images to save time. Required: product_guid, gallery.
- **shoptet_product_images_bulk_delete** — Delete all product images in gallery. Deletes all product's images by gallery name. If removeReference parameter is not present or set to false and if image is referenced as variant image, then image will be skipped and present in errors in response. Required: product_guid, gallery.
- **shoptet_product_images_bulk_update** — Product images update. Using this endpoint you can modify product images attributes, such as description and priority (order). Maximum of 100 images can be sent at once. Required: product_guid, gallery, data.
- **create_a_shoptet_product_image** — Product images insertion. Using this endpoint you can upload new images to a product. This is an asynchronous request, see how Asynchronous requests work on our developer's portal. Maximum of 100 images can be sent at once. Required: product_guid, gallery, data.
- **delete_a_shoptet_product_image_by_id** — Delete one product image. Deletes product's image. If removeReference parameter is not present or set to false and if image is referenced as variant image, then image won't be deleted and response will have status code 409 Conflict. Required: id, product_guid, gallery.
- **list_all_shoptet_product_measure_units** — List of products measure units. Returns the list of product measure units within the e-shop.
- **list_all_shoptet_product_recycling_fee_categories** — List of recycling fee categories. Returns the list of recycling fee categories within the e-shop.
- **create_a_shoptet_product_related_file** — Product related file link. Linking related file from temporary storage to product. Required: product_guid, data.
- **shoptet_product_related_files_bulk_delete** — Unlink all product related files. Unlink all related files linked to a specific product. Required: product_guid.
- **delete_a_shoptet_product_related_file_by_id** — Delete one product related file. Deletes product's related file. Required: id, product_guid.
- **list_all_shoptet_product_related_products** — List of product related products. Returns list of related products related to product defined by guid, list is ordered by priority parameter. Required: product_guid.
- **create_a_shoptet_product_related_product** — Add related product. This method add given product, defined with guid at the end of the related product list. After product is successfully saved, complete list of related product is returned in response. Required: product_guid, data.
- **shoptet_product_related_products_bulk_update** — Set related products. This method set given products (minimum 0, maximum 50), defined with guid to the related product list. After product is successfully saved, complete list of related product is returned in response. Required: product_guid, data.
- **list_all_shoptet_product_reviews** — List of products reviews. Returns list of product's reviews. The connector pages through all results (up to 20 per page).
- **create_a_shoptet_product_review** — Product review insertion. Importing product reviews with option to backdate them. Required: data.
- **update_a_shoptet_product_review_by_id** — Product review update. Updates the product review. This endpoint is available only when the 'Rating' module is active. Required: id, data.
- **create_a_shoptet_product_set** — Add item to product-set. This method adding product defined by product variant code to the bundle (product set). Product defined in url by guid, must be set as type : product-set. When successfully saved, complete list of products in the set is returned in response. Required: product_guid, data.
- **shoptet_product_sets_bulk_update** — Set product-set items. This method set given products (minimum 0, maximum 50), defined by product variant code to the bundle of products (product-set). Product defined in url by guid, must be set as type : product-set. Required: product_guid, data.
- **create_a_shoptet_product_surcharge_parameter_value** — Creation of surcharge parameter value. Required: surcharge_parameter_code, data.
- **delete_a_shoptet_product_surcharge_parameter_value_by_id** — Removal of surcharge parameter value. Required: id, param_index.
- **update_a_shoptet_product_surcharge_parameter_value_by_id** — Update of surcharge parameter value. Required: id, param_index, data.
- **list_all_shoptet_product_surcharge_parameters** — List of surcharge parameters. Returns the list of available surcharge parameters with their available values within the e-shop. The connector pages through all results (up to 500 per page).
- **create_a_shoptet_product_surcharge_parameter** — Creation of surcharge parameter. Required: data.
- **get_single_shoptet_product_surcharge_parameter_by_id** — Detail of surcharge parameter. Required: id.
- **update_a_shoptet_product_surcharge_parameter_by_id** — Update of surcharge parameter. Required: id, data.
- **delete_a_shoptet_product_surcharge_parameter_by_id** — Removal of surcharge parameter. Required: id.
- **list_all_shoptet_product_units** — List of product units.
- **create_a_shoptet_product_variant_parameter_value** — Creation of variant parameter value. Required: param_index, data.
- **delete_a_shoptet_product_variant_parameter_value_by_id** — Removal of variant parameter value. Required: id, param_index.
- **update_a_shoptet_product_variant_parameter_value_by_id** — Update of variant parameter value. Required: id, param_index, data.
- **list_all_shoptet_product_variant_parameters** — List of variant parameters. Returns the list of available variant parameters with their available values within the e-shop. List of variant parameters endpoint has section, which is only sent when requested in the include parameter. Value | Section --------|------ values | Variant parameter values. The connector pages through all results (up to 100 per page).
- **create_a_shoptet_product_variant_parameter** — Creation of variant parameter. Required: data.
- **get_single_shoptet_product_variant_parameter_by_id** — Detail of variant parameter. Required: id.
- **update_a_shoptet_product_variant_parameter_by_id** — Update of variant parameter. Required: id, data.
- **delete_a_shoptet_product_variant_parameter_by_id** — Removal of variant parameter. Required: id.
- **list_all_shoptet_product_warranties** — List of product warranties. Returns list of product warranties.
- **list_all_shoptet_products** — List of products. Returns the list of products - only basic info and GUID, using this you can determine the details with another API call. Endpoint supports Paging. This endpoint has several sections, which are sent only when requested in the include parameter (see Section on demand. The connector pages through all results (up to 1000 per page).
- **create_a_shoptet_product** — Product insertion. This endpoint allows you to insert products into Shoptet. You can use it for an import from an external system. Request is sent in JSON format in its body. For detailed description of items, which can be provided, see the right-most pane, section "Request" » "Attributes". Required: data.
- **shoptet_products_clone** — Product copy. This endpoint allows you to copy a product identified by a GUID. The new product will have the same attributes as the original product. Many settings can be copied from the original product,but some settings require an active module. See the details below. Required: product_guid, data.
- **shoptet_products_bulk_snapshot** — List of all products. Using this endpoint, you can get list of all products with detailed info of each product (like in Product Detail endpoint) asynchronously. See how Asynchronous requests work on our developer's portal. Asynchronous: returns a job ID; the result file is announced by the job:finished webhook (see system_jobs.get).
- **shoptet_products_bulk_snapshot_pricelists** — List of all products and pricelist prices. Using this endpoint, you can get list of all products with basic data such as product guid, id, code and its prices across all pricelists. Response will be in jsonlines format with each product taking one line of output file. Asynchronous: returns a job ID; the result file is announced by the job:finished webhook (see system_jobs.get).
- **get_single_shoptet_product_by_id** — Product detail. Returns detailed information about one product. The product includes the variant field. In case the product comes in variants, the field contains all the available variants. If the product does not have any variants, it contains only one variant with product information. Required: id.
- **update_a_shoptet_product_by_id** — Product update. This endpoint allows you to update a product identified by its guid. Request is sent in JSON format in its body. For detailed description of items which can be updated and their format, check the right-most pane, section "Request" » "Attributes". Required: id, data.
- **delete_a_shoptet_product_by_id** — Product deletion. Deletes product as per entered guid. If successful, returns the code 200. If the product does not exist within the e-shop, a 404 code is returned. If the product cannot be deleted, because it is part of set or used as a gift to some product, a 409 code is returned. Required: id.
- **shoptet_products_bulk_delete** — Product BATCH delete. This endpoint allows you to delete multiple products or product variants at once. Batch delete is processed asynchronously. See how Asynchronous requests work on our developer's portal. File with data must be in JSONL (jsonlines) format. Required: batchFileUrlPath.
- **shoptet_products_bulk_update** — Product BATCH update. This endpoint allows you to update multiple products at once. Batch update is processed asynchronously in same way as for example products snapshot, but it does not have resultUrl with products to download in response. Required: batchFileUrlPath.
- **get_single_shoptet_products_by_code_by_id** — Product detail by code. Retrieve details about one product. Optional sections can be requested using ?include= parameter The response format is the same as for Product detail endpoint. Required: id.
- **update_a_shoptet_products_by_code_by_id** — Product update by code. This endpoint allows you to update products identified by a product code in Shoptet. Request is sent in JSON format in its body. For detailed description of items, which can be updated and their format, check the right-most pane, section "Request" » "Attributes". Required: id, data.
- **delete_a_shoptet_products_by_code_by_id** — Product variant deletion. Deletes product variant as per entered code. If this is the last product variant, the entire product is deleted. If successful, returns the code 200. If the product variant does not exist within the e-shop, a 404 code is returned. Required: id.
- **list_all_shoptet_proforma_invoice_changes** — Last proforma invoice changes. Returns the list of proforma invoices, which were changed. The Endpoint is intended to determine the changes after you have loaded the list of proforma invoices and you need to know the changes. The guaranteed history of changes is 30 days. Required: from. The connector pages through all results (up to 20 per page).
- **create_a_shoptet_proforma_invoice_invoice** — Invoice from proforma invoice creation. Creating invoice from existing proforma invoice. Required: proforma_invoice_code, data.
- **list_all_shoptet_proforma_invoice_pdfs** — Download proforma invoice as PDF. 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. Required: proforma_invoice_code.
- **list_all_shoptet_proforma_invoices** — List of proforma invoices. Returns the list of proforma invoices. Supports the Paging. The connector pages through all results (up to 100 per page).
- **shoptet_proforma_invoices_bulk_snapshot** — List of all proforma invoices. Using this endpoint, you can get list of all proforma invoices with detailed info of each proforma invoice (like in Proforma invoice detail endpoint) asynchronously. See how Asynchronous requests work on our developer's portal. Asynchronous: returns a job ID; the result file is announced by the job:finished webhook (see system_jobs.get).
- **get_single_shoptet_proforma_invoice_by_id** — Proforma invoice detail. Additional information about one proforma invoice. This endpoint has several sections, which are only sent when requested in the include parameter (see Section on demand). Value | Section --------|------ surchargeParameters| Item surcharge parameters. Required: id.
- **list_all_shoptet_project_reviews** — List of project reviews. Returns a list of the project reviews. This endpoint is available only when the 'Rating' module is active. Also, the project must have store ratings enabled in the administration settings. The endpoint supports Paging. The connector pages through all results (up to 200 per page).
- **create_a_shoptet_project_review** — Project review insertion. Creates a new project review. This endpoint is available only when the 'Rating' module is active. Also, the e-shop must have store ratings enabled in the administration settings. Required: data.
- **shoptet_project_reviews_bulk_snapshot** — List of all project reviews. Using this endpoint, you can get list of all project reviews in the same format as the List of project reviews endpoint returns them. This endpoint is available only when the 'Rating' module is active. Asynchronous: returns a job ID; the result file is announced by the job:finished webhook (see system_jobs.get).
- **update_a_shoptet_project_review_by_id** — Project review update. Updates the project review. This endpoint is available only when the 'Rating' module is active. Also, the project must have store ratings enabled in the administration settings. Required: id, data.
- **list_all_shoptet_proof_payment_changes** — Last proof payments changes. 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. Required: from. The connector pages through all results (up to 20 per page).
- **create_a_shoptet_proof_payment_credit_note** — Credit note from proof of payment. 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. Required: proof_payment_code, data.
- **create_a_shoptet_proof_payment_document_setting** — Proof payment document settings. 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. Required: proof_payment_code, data.
- **list_all_shoptet_proof_payment_isdocs** — Download proof payment as ISDOC. You can request the proof payment as ISDOC file, response will be as application/octet-stream. You can download the documents only one-by-one for every e-shop. Parallel requests end with 423 Locked error. Required: proof_payment_code.
- **list_all_shoptet_proof_payment_pdfs** — Download proof of payment as PDF. 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. Required: proof_payment_code.
- **list_all_shoptet_proof_payments** — List of proof payments. The list of proof payments supports Paging. The connector pages through all results (up to 100 per page).
- **create_a_shoptet_proof_payment** — Proof payment insertion. Required: data.
- **get_single_shoptet_proof_payment_by_id** — Proof payment detail. Additional information about one proof payment. Required: id.
- **update_a_shoptet_proof_payment_by_id** — Proof payment update. 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. Required: id, data.
- **delete_a_shoptet_proof_payment_by_id** — Proof payment deletion. 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. Required: id.
- **shoptet_proof_payments_bulk_snapshot** — List of all proof payments. Using this endpoint, you can get list of all proof payments with detailed info of each proof payment (like in Proof payment Detail endpoint). Response will be in jsonlines format with each proof payment taking one line of output file. Asynchronous: returns a job ID; the result file is announced by the job:finished webhook (see system_jobs.get).
- **get_single_shoptet_proof_payments_by_order_by_id** — Proof payment detail by order code. Required: id.
- **create_a_shoptet_proof_payments_by_order** — Proof payment insertion by order code. Required: order_code.
- **get_single_shoptet_proof_payments_by_proforma_invoice_by_id** — Proof payment detail by proforma invoice code. Required: id.
- **create_a_shoptet_proof_payments_by_proforma_invoice** — Proof payment insertion by proforma invoice code. Required: proforma_invoice_code.
- **list_all_shoptet_quantity_discounts** — List of quantity discounts. Returns a list of quantity discounts with basic info. Supports Paging. The connector pages through all results (up to 20 per page).
- **create_a_shoptet_quantity_discount** — Quantity discount insertion. Required: data.
- **shoptet_quantity_discounts_bulk_snapshot** — List of all quantity discounts. Using this endpoint, you can get list of all quantity discounts with detailed info of each article (like in Detail of quantity discount endpoint) asynchronously. See how Asynchronous requests work on our developer's portal. Asynchronous: returns a job ID; the result file is announced by the job:finished webhook (see system_jobs.get).
- **get_single_shoptet_quantity_discount_by_id** — Detail of quantity discounts. Required: id.
- **update_a_shoptet_quantity_discount_by_id** — Quantity discount update. Required: id, data.
- **delete_a_shoptet_quantity_discount_by_id** — Delete of quantity discount. Required: id.
- **list_all_shoptet_review_settings** — Reviews settings. Returns the reviews settings configured in the administration Rating Settings page, covering both product reviews and store rating. This endpoint is available only when the 'Rating' module is active. The endpoint is read-only.
- **list_all_shoptet_sales_channels** — List of all sales channels. Provides a list of all sales channels.
- **get_single_shoptet_sales_channel_by_id** — Sales channel detail. Information about the detail of the sales channels. Required: id.
- **get_single_shoptet_sales_channels_by_id_by_id** — Sales channel detail by ID. Information about the detail of the sales channels. Required: id.
- **list_all_shoptet_shipment_carriers** — List of shipment carriers. List of all active shipment carriers. The list can be filtered according to carrier type (branch).
- **get_single_shoptet_shipment_carrier_by_id** — Detail of shipment carrier. Returns detail of a single shipment carrier identified by its numeric ID and type. Required: id, carrier_code.
- **shoptet_shipment_carriers_close** — Close carrier shipments. Closes (moves to transportation stage) of all created shipments for given carrier ID. Required: carrier_code.
- **list_all_shoptet_shipment_order_shipping_options** — Shipment shipping options by order code. Returns available shipping options for the given order. Required: order_code.
- **list_all_shoptet_shipments** — List of shipments. Returns a paginated list of shipments. Optionally filter by status or order code.
- **create_a_shoptet_shipment** — Creation of shipment. In the packages field, you can send an object containing three combinations of child fields: - orderPackagingId only, - packaging and weight, - width, height, depth, and weight. Required: data.
- **get_single_shoptet_shipment_by_id** — Detail of shipment. Returns detail of a single shipment identified by its GUID. Required: id.
- **shoptet_shipments_cancel** — Shipment cancellation request. Requests cancellation of shipment. Cancellation request, if valid, is accepted via API - it means we try to process this request within the carrier. The final state of this request can be checked in the Shipment detail endpoint. Required: shipment_guid.
- **list_all_shoptet_shipping_methods** — List of shipping methods. 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.
- **create_a_shoptet_shipping_method** — Adding a shipping method. Adds a new shipping method for the specific e-shop, including its complete configuration — pricing, allowed payment methods, sales-channel bindings and listing position. A method created with a full request body needs no follow-up setup in the administration. Required: data.
- **get_single_shoptet_shipping_method_by_id** — Shipping method detail. Endpoint returns the detail of a single shipping method identified by its GUID. Pricing and pricelist settings (price tiers by weight/price, per-country/region pricing and paired payment methods) are returned only when requested via the include=priceList query parameter. Required: id.
- **update_a_shoptet_shipping_method_by_id** — Updating a shipping method. Updates an existing shipping method, including its pricelist, so that shipping costs can be kept in sync from an ERP or a carrier integration without any follow-up work in the administration. The update is partial. Required: id, data.
- **delete_a_shoptet_shipping_method_by_id** — Shipping method deletion. Removes an existing shipping method, so that an addon can clean up the methods it provisioned instead of leaving the merchant to delete them by hand in the administration. Required: id.
- **list_all_shoptet_shipping_request_statuses** — Shipping request for getting status of order. Endpoint returns status of order related to shippingRequestCode & shippingGuid. Required: shipping_request_code, shipping_guid.
- **get_single_shoptet_shipping_request_by_id** — Shipping request for getting cart details. Endpoint returns details of cart for shipping request. Required: id, shipping_request_code.
- **update_a_shoptet_shipping_request_by_id** — Update shipping price & data. Endpoint to set shipping price & data. Required: id, shipping_request_code, data.
- **list_all_shoptet_stock_last_movements** — Stock movements - Last move. It returns informations about last stock move. Required: stock_id.
- **list_all_shoptet_stock_movements** — Stock movements. It returns the list of changes in product quantity, which were done within one stock. Supports the Paging movements. This endpoint supports optional parts using the include parameter (see Section on demand). Required: stock_id. The connector pages through all results (up to 1000 per page).
- **shoptet_stock_movements_bulk_update** — Update quantity in stock. 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. 300 products/variants). Required: stock_id, data.
- **list_all_shoptet_stock_supplies** — Product supplies in stock. 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. Required: stock_id. The connector pages through all results (up to 1000 per page).
- **list_all_shoptet_stocks** — List of stocks. Returns the list of stocks. There are usually not many stocks, therefore the endpoint returns all of them without Paging.
- **get_single_shoptet_stock_by_id** — Stock detail. Returns detailed information about one stock. Required: id.
- **list_all_shoptet_suppliers** — List of suppliers. Returns the list of suppliers. Supports the Paging. The connector pages through all results (up to 500 per page).
- **list_all_shoptet_system_endpoints** — List of available endpoints. 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.
- **list_all_shoptet_system_files** — List of uploaded files. Retrieves your uploaded files that can be copied in supported endpoints to entities within e-shop.
- **shoptet_system_files_bulk_create** — Batch files upload. **This endpoint has been only renamed from "File upload" after we created new synchronous endpoint one file upload. Url and structure is unchanged** Performs file upload asynchronously. Required: data.
- **create_a_shoptet_system_file** — File upload. **This is new endpoint - older asynchronous endpoint has been only renamed to "Batch files upload" in documentation, url and structure is unchanged** **Please, do not use this endpoint for batch file upload!** Performs one file upload synchronously in same way as asynchronous fil. Required: data.
- **list_all_shoptet_system_jobs** — List of jobs. 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. The connector pages through all results (up to 500 per page).
- **get_single_shoptet_system_job_by_id** — Job detail. 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. Required: id.
- **list_all_shoptet_template_includes** — Listing of codes. 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.
- **create_a_shoptet_template_include** — Inserting and editing codes. 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. Required: data.
- **delete_a_shoptet_template_include_by_id** — Removal of code. 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. Required: id.
- **list_all_shoptet_unsubscribed_emails** — Listing of unsubscribed e-mails. The connector pages through all results (up to 1000 per page).
- **create_a_shoptet_unsubscribed_email** — Unsubscribed e-mail insertion. Required: data.
- **list_all_shoptet_volume_discounts** — List of volume discounts. The connector pages through all results (up to 20 per page).
- **list_all_shoptet_webhook_notifications** — Webhook notification. 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. The connector pages through all results (up to 500 per page).
- **create_a_shoptet_webhook_signature_key** — Generating of signature key. 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.
- **list_all_shoptet_webhooks** — Overview of registered webhooks. 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). The connector pages through all results (up to 500 per page).
- **create_a_shoptet_webhook** — Registration of new webhook. Registers the webhook. For a single event (event, for example order:create) **ONLY ONE** URL can be registered. Successful creation (registration) of webhook is signaled by code 201. The endpoint returns the info on the created webhook. Required: data.
- **get_single_shoptet_webhook_by_id** — Detail of registered webhooks. Shows the information about a single specific registered webhook. Required: id.
- **update_a_shoptet_webhook_by_id** — Update of existing webhook. Modification of the existing webhook. The id of the webhook serves as the identifier. Using just one call, only one webhook can be modified. Setting sendPayload for an event that does not support it fails with 400 and the webhook-send-payload-not-supported error. Required: id, data.
- **delete_a_shoptet_webhook_by_id** — Deletion of registered webhook. Deletes the registered webhook, identified by means of id. Required: id.
- **list_all_shoptet_xy_discount_settings** — X + Y discounts settings. Lists & updates settings of X + Y discounts. Please note, that enableInCashdesk is only present when the cashDesk or cashRegister module is active.
- **shoptet_xy_discount_settings_bulk_update** — X + Y discount settings update. Updates settings for X + Y discounts. All settings are optional, but at least one should be present. Please note, that updating "enableInCashdesk" will throw an exception unless the cashDesk or cashRegister module is active. Required: data.
- **list_all_shoptet_xy_discounts** — List of X + Y discounts. The connector pages through all results (up to 20 per page).
- **create_a_shoptet_xy_discount** — X + Y discount insertion. Required: data.
- **get_single_shoptet_xy_discount_by_id** — Detail of X + Y discounts. Required: id.
- **update_a_shoptet_xy_discount_by_id** — X + Y discount update. Required: id, data.
- **delete_a_shoptet_xy_discount_by_id** — Delete of X + Y discount. Required: id.

## How it works

1. **Link your customer's Shoptet account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app.
2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request.
3. **Call Truto's API to reach Shoptet.** The Proxy API is a 1-to-1 mapping of the Shoptet API.
4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field.

## Use cases

- **Launch native Shoptet integration for CEE expansion** — If your SaaS targets the Czech, Slovak, or Hungarian e-commerce market, Shoptet powers 40,000+ stores and is table stakes. Truto lets you ship a production-ready integration without learning Shoptet's async bulk patterns or ISDOC document formats.
- **Power marketing automation and CDP workflows** — Sync historical catalog, orders, and customer data via async bulk snapshots, then subscribe to real-time webhooks for order and customer events. Push segmented audiences back as customer groups and generate personalized discount coupons on the fly.
- **Automate 3PL and warehouse fulfillment** — Pull unfulfilled orders in bulk, push shipment tracking back to the storefront, and keep inventory accurate with bulk stock movement updates. Prevents overselling and eliminates manual order status entry for merchants.
- **Enable accounting and ERP reconciliation** — Track invoice, proforma, credit note, and proof-of-payment changes to automate ledger entries. Pull native ISDOC XML files for machine-readable Czech/Slovak tax compliance without building a parser per document type.
- **Deliver on-site conversion widgets without merchant code edits** — Programmatically inject chatbot, review, or analytics widgets into Shoptet storefronts via template includes. Merchants connect their store once and your product renders instantly — no theme editing or developer handoff required.

## What you can build

- **Async historical catalog and order backfill** — Trigger bulk snapshot jobs for products, orders, customers, and price lists, and ingest the resulting JSONL output when the job-finished webhook fires.
- **Real-time order and customer webhook pipeline** — Register webhooks for order, customer, product, invoice, and proof-of-payment events to drive live automations in your SaaS.
- **Dynamic discount coupon generator** — Create one-off or templated discount coupons, quantity discounts, volume discounts, and X+Y promotions tied to campaigns or customer segments.
- **Inventory and stock movement sync** — Read current stock levels and push bulk stock movements to keep Shoptet storefront inventory in lockstep with your WMS or ERP.
- **Fulfillment and shipment tracking** — Update order statuses in bulk and create shipments with carrier tracking numbers that flow back to the merchant's customer-facing order history.
- **Localized document retrieval for finance tools** — Download PDF and ISDOC versions of invoices, proforma invoices, credit notes, and delivery notes for CEE-compliant accounting reconciliation.
- **Storefront widget injection** — Insert HTML/JS snippets into specific storefront zones via template includes so your widgets go live the moment a merchant connects.
- **Customer segmentation and VIP pricing** — Assign customers to groups and map them to specific price lists to deliver logged-in VIP pricing driven by your segmentation logic.

## FAQs

### How does authentication to Shoptet work through Truto?

Shoptet uses OAuth-style API access tokens issued per merchant store. Truto handles the token issuance flow and refresh lifecycle so your end users just click Connect — you never see or store credentials.

### How do I handle Shoptet's asynchronous bulk endpoints?

Heavy objects like products, orders, customers, and price lists use async bulk snapshot and update endpoints that return a Job ID and emit a job-finished webhook with a JSONL payload. Truto exposes these as standard tool calls and lets you subscribe to the completion webhook to ingest results.

### Can I sync historical data for a newly connected store?

Yes. Use the bulk snapshot tools (products, orders, customers, abandoned carts, credit notes, proforma invoices, price lists) to extract the full historical dataset asynchronously, then switch to webhooks and change-feed endpoints for incremental updates.

### Does the integration support localized financial documents like ISDOC?

Yes. You can list and retrieve ISDOC XML files and PDFs for invoices, proforma invoices, credit notes, and proof-of-payments — the native formats required for Czech and Slovak tax compliance.

### How do I keep data fresh without polling everything?

Register webhooks via create_a_shoptet_webhook for entity events, and use the change-feed endpoints (invoice changes, order changes, customer changes, product changes, proforma invoice changes, proof-of-payment changes, mailing list changes) to pull only deltas since your last sync.

### Can my product modify the merchant's storefront without them editing code?

Yes. The template includes endpoints let you programmatically inject HTML into designated storefront zones, so widgets, tags, or chat UIs activate automatically after the merchant connects.

### What write operations are supported for orders and fulfillment?

You can create and clone orders, bulk-update order status and notes, add order items, payments, shipping, proforma invoices, invoices, delivery notes, and shipments with tracking — covering the full fulfillment lifecycle.
