{"items":[{"type":"group","label":"Shoptet API","items":[{"type":"link","label":"Shoptet API","link":"/shoptet-api/openapi","routeSlug":"/shoptet-api/openapi"},{"type":"group","label":"Basic principles","link":"/shoptet-api/openapi/section/basic-principles","routeSlug":"/shoptet-api/openapi/section/basic-principles","items":[{"type":"link","label":"How to call API","link":"/shoptet-api/openapi/section/basic-principles/how-to-call-api","routeSlug":"/shoptet-api/openapi/section/basic-principles/how-to-call-api"},{"type":"link","label":"For Addons","link":"/shoptet-api/openapi/section/basic-principles/for-addons","routeSlug":"/shoptet-api/openapi/section/basic-principles/for-addons"},{"type":"link","label":"For private API access (Premium)","link":"/shoptet-api/openapi/section/basic-principles/for-private-api-access-(premium)","routeSlug":"/shoptet-api/openapi/section/basic-principles/for-private-api-access-(premium)"},{"type":"link","label":"Rate limiting","link":"/shoptet-api/openapi/section/basic-principles/rate-limiting","routeSlug":"/shoptet-api/openapi/section/basic-principles/rate-limiting"},{"type":"link","label":"Leaky bucket","link":"/shoptet-api/openapi/section/basic-principles/leaky-bucket","routeSlug":"/shoptet-api/openapi/section/basic-principles/leaky-bucket"},{"type":"link","label":"Locks","link":"/shoptet-api/openapi/section/basic-principles/locks","routeSlug":"/shoptet-api/openapi/section/basic-principles/locks"},{"type":"link","label":"Server response format","link":"/shoptet-api/openapi/section/basic-principles/server-response-format","routeSlug":"/shoptet-api/openapi/section/basic-principles/server-response-format"},{"type":"link","label":"Deprecated header + Sunset","link":"/shoptet-api/openapi/section/basic-principles/deprecated-header-+-sunset","routeSlug":"/shoptet-api/openapi/section/basic-principles/deprecated-header-+-sunset"},{"type":"link","label":"Status codes","link":"/shoptet-api/openapi/section/basic-principles/status-codes","routeSlug":"/shoptet-api/openapi/section/basic-principles/status-codes"},{"type":"link","label":"Paging","link":"/shoptet-api/openapi/section/basic-principles/paging","routeSlug":"/shoptet-api/openapi/section/basic-principles/paging"},{"type":"link","label":"Section on demand","link":"/shoptet-api/openapi/section/basic-principles/section-on-demand","routeSlug":"/shoptet-api/openapi/section/basic-principles/section-on-demand"},{"type":"link","label":"Translations","link":"/shoptet-api/openapi/section/basic-principles/translations","routeSlug":"/shoptet-api/openapi/section/basic-principles/translations"},{"type":"link","label":"Files upload","link":"/shoptet-api/openapi/section/basic-principles/files-upload","routeSlug":"/shoptet-api/openapi/section/basic-principles/files-upload"}]},{"type":"link","label":"Product images","link":"/shoptet-api/openapi/section/product-images","routeSlug":"/shoptet-api/openapi/section/product-images"},{"type":"group","label":"Code lists","link":"/shoptet-api/openapi/section/code-lists","routeSlug":"/shoptet-api/openapi/section/code-lists","items":[{"type":"link","label":"Image cuts","link":"/shoptet-api/openapi/section/code-lists/image-cuts","routeSlug":"/shoptet-api/openapi/section/code-lists/image-cuts"},{"type":"link","label":"Product visibility","link":"/shoptet-api/openapi/section/code-lists/product-visibility","routeSlug":"/shoptet-api/openapi/section/code-lists/product-visibility"},{"type":"link","label":"Product types","link":"/shoptet-api/openapi/section/code-lists/product-types","routeSlug":"/shoptet-api/openapi/section/code-lists/product-types"},{"type":"link","label":"Types of order items","link":"/shoptet-api/openapi/section/code-lists/types-of-order-items","routeSlug":"/shoptet-api/openapi/section/code-lists/types-of-order-items"},{"type":"link","label":"Sorting of products in category","link":"/shoptet-api/openapi/section/code-lists/sorting-of-products-in-category","routeSlug":"/shoptet-api/openapi/section/code-lists/sorting-of-products-in-category"},{"type":"link","label":"Webhook event types","link":"/shoptet-api/openapi/section/code-lists/webhook-event-types","routeSlug":"/shoptet-api/openapi/section/code-lists/webhook-event-types"},{"type":"link","label":"Mass Webhooks","link":"/shoptet-api/openapi/section/code-lists/mass-webhooks","routeSlug":"/shoptet-api/openapi/section/code-lists/mass-webhooks"},{"type":"link","label":"System Webhooks","link":"/shoptet-api/openapi/section/code-lists/system-webhooks","routeSlug":"/shoptet-api/openapi/section/code-lists/system-webhooks"},{"type":"link","label":"URL address from endpoint Eshop info","link":"/shoptet-api/openapi/section/code-lists/url-address-from-endpoint-eshop-info","routeSlug":"/shoptet-api/openapi/section/code-lists/url-address-from-endpoint-eshop-info"},{"type":"link","label":"List of product catalogues","link":"/shoptet-api/openapi/section/code-lists/list-of-product-catalogues","routeSlug":"/shoptet-api/openapi/section/code-lists/list-of-product-catalogues"},{"type":"link","label":"Invoice billing methods","link":"/shoptet-api/openapi/section/code-lists/invoice-billing-methods","routeSlug":"/shoptet-api/openapi/section/code-lists/invoice-billing-methods"},{"type":"link","label":"VAT modes","link":"/shoptet-api/openapi/section/code-lists/vat-modes","routeSlug":"/shoptet-api/openapi/section/code-lists/vat-modes"},{"type":"link","label":"Shipment carrier types","link":"/shoptet-api/openapi/section/code-lists/shipment-carrier-types","routeSlug":"/shoptet-api/openapi/section/code-lists/shipment-carrier-types"},{"type":"link","label":"Shipment statuses","link":"/shoptet-api/openapi/section/code-lists/shipment-statuses","routeSlug":"/shoptet-api/openapi/section/code-lists/shipment-statuses"}]},{"type":"group","label":"Postman collection","link":"/shoptet-api/openapi/section/postman-collection","routeSlug":"/shoptet-api/openapi/section/postman-collection","items":[{"type":"link","label":"Fork Shoptet API Collection from Shoptet Public API Workspace (recommended)","link":"/shoptet-api/openapi/section/postman-collection/fork-shoptet-api-collection-from-shoptet-public-api-workspace-(recommended)","routeSlug":"/shoptet-api/openapi/section/postman-collection/fork-shoptet-api-collection-from-shoptet-public-api-workspace-(recommended)"},{"type":"link","label":"Step 1: Navigate to Shoptet Public API Workspace","link":"/shoptet-api/openapi/section/postman-collection/step-1:-navigate-to-shoptet-public-api-workspace","routeSlug":"/shoptet-api/openapi/section/postman-collection/step-1:-navigate-to-shoptet-public-api-workspace"},{"type":"link","label":"Step 2: Locate the Shoptet API Collection","link":"/shoptet-api/openapi/section/postman-collection/step-2:-locate-the-shoptet-api-collection","routeSlug":"/shoptet-api/openapi/section/postman-collection/step-2:-locate-the-shoptet-api-collection"},{"type":"link","label":"Step 3: Fork the Collection","link":"/shoptet-api/openapi/section/postman-collection/step-3:-fork-the-collection","routeSlug":"/shoptet-api/openapi/section/postman-collection/step-3:-fork-the-collection"},{"type":"link","label":"Step 4: Access Your Forked Collection","link":"/shoptet-api/openapi/section/postman-collection/step-4:-access-your-forked-collection","routeSlug":"/shoptet-api/openapi/section/postman-collection/step-4:-access-your-forked-collection"},{"type":"link","label":"Import openapi.yaml into Postman as a Collection","link":"/shoptet-api/openapi/section/postman-collection/import-openapi.yaml-into-postman-as-a-collection","routeSlug":"/shoptet-api/openapi/section/postman-collection/import-openapi.yaml-into-postman-as-a-collection"},{"type":"link","label":"Step 1: Upload the ","link":"/shoptet-api/openapi/section/postman-collection/step-1:-upload-the","routeSlug":"/shoptet-api/openapi/section/postman-collection/step-1:-upload-the"},{"type":"link","label":"Step 2: Verify OpenAPI Import","link":"/shoptet-api/openapi/section/postman-collection/step-2:-verify-openapi-import","routeSlug":"/shoptet-api/openapi/section/postman-collection/step-2:-verify-openapi-import"},{"type":"link","label":"Step 3: Import as Collection","link":"/shoptet-api/openapi/section/postman-collection/step-3:-import-as-collection","routeSlug":"/shoptet-api/openapi/section/postman-collection/step-3:-import-as-collection"},{"type":"link","label":"Step 4: Access the Imported Collection","link":"/shoptet-api/openapi/section/postman-collection/step-4:-access-the-imported-collection","routeSlug":"/shoptet-api/openapi/section/postman-collection/step-4:-access-the-imported-collection"},{"type":"link","label":"Collection settings","link":"/shoptet-api/openapi/section/postman-collection/collection-settings","routeSlug":"/shoptet-api/openapi/section/postman-collection/collection-settings"}]},{"type":"group","label":"SDK","link":"/shoptet-api/openapi/section/sdk","routeSlug":"/shoptet-api/openapi/section/sdk","items":[{"type":"link","label":"Requirements","link":"/shoptet-api/openapi/section/sdk/requirements","routeSlug":"/shoptet-api/openapi/section/sdk/requirements"},{"type":"link","label":"Dependencies","link":"/shoptet-api/openapi/section/sdk/dependencies","routeSlug":"/shoptet-api/openapi/section/sdk/dependencies"},{"type":"link","label":"Installation","link":"/shoptet-api/openapi/section/sdk/installation","routeSlug":"/shoptet-api/openapi/section/sdk/installation"},{"type":"link","label":"Composer","link":"/shoptet-api/openapi/section/sdk/composer","routeSlug":"/shoptet-api/openapi/section/sdk/composer"},{"type":"link","label":"Manual","link":"/shoptet-api/openapi/section/sdk/manual","routeSlug":"/shoptet-api/openapi/section/sdk/manual"},{"type":"link","label":"Getting Started","link":"/shoptet-api/openapi/section/sdk/getting-started","routeSlug":"/shoptet-api/openapi/section/sdk/getting-started"},{"type":"link","label":"Simple usage","link":"/shoptet-api/openapi/section/sdk/simple-usage","routeSlug":"/shoptet-api/openapi/section/sdk/simple-usage"},{"type":"link","label":"Webhooks","link":"/shoptet-api/openapi/section/sdk/webhooks","routeSlug":"/shoptet-api/openapi/section/sdk/webhooks"},{"type":"link","label":"Custom header","link":"/shoptet-api/openapi/section/sdk/custom-header","routeSlug":"/shoptet-api/openapi/section/sdk/custom-header"},{"type":"link","label":"Custom request timeouts","link":"/shoptet-api/openapi/section/sdk/custom-request-timeouts","routeSlug":"/shoptet-api/openapi/section/sdk/custom-request-timeouts"},{"type":"link","label":"Handling Rate Limits","link":"/shoptet-api/openapi/section/sdk/handling-rate-limits","routeSlug":"/shoptet-api/openapi/section/sdk/handling-rate-limits"},{"type":"link","label":"Custom cURL options","link":"/shoptet-api/openapi/section/sdk/custom-curl-options","routeSlug":"/shoptet-api/openapi/section/sdk/custom-curl-options"},{"type":"link","label":"Response body type","link":"/shoptet-api/openapi/section/sdk/response-body-type","routeSlug":"/shoptet-api/openapi/section/sdk/response-body-type"},{"type":"link","label":"Custom HttpClient","link":"/shoptet-api/openapi/section/sdk/custom-httpclient","routeSlug":"/shoptet-api/openapi/section/sdk/custom-httpclient"},{"type":"link","label":"Logger","link":"/shoptet-api/openapi/section/sdk/logger","routeSlug":"/shoptet-api/openapi/section/sdk/logger"},{"type":"link","label":"Handeling snapshot endpoints result","link":"/shoptet-api/openapi/section/sdk/handeling-snapshot-endpoints-result","routeSlug":"/shoptet-api/openapi/section/sdk/handeling-snapshot-endpoints-result"},{"type":"link","label":"Exceptions","link":"/shoptet-api/openapi/section/sdk/exceptions","routeSlug":"/shoptet-api/openapi/section/sdk/exceptions"},{"type":"link","label":"Tests","link":"/shoptet-api/openapi/section/sdk/tests","routeSlug":"/shoptet-api/openapi/section/sdk/tests"}]},{"type":"link","label":"Last changes","link":"/shoptet-api/openapi/section/last-changes","routeSlug":"/shoptet-api/openapi/section/last-changes"},{"type":"separator","label":"Orders"},{"type":"group","label":"Orders","link":"/shoptet-api/openapi/orders","routeSlug":"/shoptet-api/openapi/orders","items":[{"label":"List of orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/getlistoforders","routeSlug":"/shoptet-api/openapi/orders/getlistoforders","metadata":{"seo":{"title":"List of orders","description":"List of orders in e-shop and cash desks. Endpoint supports  Paging. For default calls, it returns 50 orders,"}},"httpPath":"/api/orders"},{"label":"Order insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/createorder","routeSlug":"/shoptet-api/openapi/orders/createorder","metadata":{"seo":{"title":"Order insertion","description":"This endpoint enables insert the order into Shoptet, which was createdin other system. You can use it for an import"}},"httpPath":"/api/orders"},{"label":"List of all orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/getlistofallorders","routeSlug":"/shoptet-api/openapi/orders/getlistofallorders","metadata":{"seo":{"title":"List of all orders","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 work on our developer's portal."}},"httpPath":"/api/orders/snapshot"},{"label":"Bulk order status change","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/bulkorderstatuschange","routeSlug":"/shoptet-api/openapi/orders/bulkorderstatuschange","metadata":{"seo":{"title":"Bulk order status change","description":"The endpoint allows you to change the status for multiple order codes simultaneously."}},"httpPath":"/api/orders/status-change"},{"label":"Order detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/getorderdetail","routeSlug":"/shoptet-api/openapi/orders/getorderdetail","metadata":{"seo":{"title":"Order detail","description":"This endpoint has several sections, which are only sent when requestedin the include parameter (see Section on demand)."}},"httpPath":"/api/orders/{code}"},{"label":"Order deletion","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/deleteorder","routeSlug":"/shoptet-api/openapi/orders/deleteorder","metadata":{"seo":{"title":"Order deletion","description":"Order deletion"}},"httpPath":"/api/orders/{code}"},{"label":"Order head change","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/updateorderhead","routeSlug":"/shoptet-api/openapi/orders/updateorderhead","metadata":{"seo":{"title":"Order head change","description":"You can change basic info (head) of order with this method."}},"httpPath":"/api/orders/{code}/head"},{"label":"Download order as PDF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/downloadorderaspdf","routeSlug":"/shoptet-api/openapi/orders/downloadorderaspdf","metadata":{"seo":{"title":"Download order as PDF","description":"You can request the order as PDF file, response will be asapplication/octet-stream. You can download pdf documents"}},"httpPath":"/api/orders/{code}/pdf"},{"label":"Update remarks for the order","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/updateremarksfororder","routeSlug":"/shoptet-api/openapi/orders/updateremarksfororder","metadata":{"seo":{"title":"Update remarks for the order","description":"The endpoint enables the remarks and additional fields (index 1 - 6) tobe updated for the order. Within a call, the update"}},"httpPath":"/api/orders/{code}/notes"},{"label":"Update of order status","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/updateorderstatus","routeSlug":"/shoptet-api/openapi/orders/updateorderstatus","metadata":{"seo":{"title":"Update of order status","description":"The endpoint enables the order status, “paid” flag and payment method tobe updated. This data must be set during a call."}},"httpPath":"/api/orders/{code}/status"},{"label":"Order copy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/ordercopy","routeSlug":"/shoptet-api/openapi/orders/ordercopy","metadata":{"seo":{"title":"Order copy","description":"This endpoint allows you to copy a order identified by its code."}},"httpPath":"/api/orders/{code}/copy"},{"label":"List of order statuses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/getlistoforderstatuses","routeSlug":"/shoptet-api/openapi/orders/getlistoforderstatuses","metadata":{"seo":{"title":"List of order statuses","description":"Detailed information on order status within the e-shop."}},"httpPath":"/api/orders/statuses"},{"label":"List of order sources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/getlistofordersources","routeSlug":"/shoptet-api/openapi/orders/getlistofordersources","metadata":{"seo":{"title":"List of order sources","description":"Detailed information on current possible order sources within the e-shop."}},"httpPath":"/api/orders/sources"},{"label":"Last order changes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/getlastorderchanges","routeSlug":"/shoptet-api/openapi/orders/getlastorderchanges","metadata":{"seo":{"title":"Last order changes","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."}},"httpPath":"/api/orders/changes"},{"label":"Orders with product claims","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/getorderclaims","routeSlug":"/shoptet-api/openapi/orders/getorderclaims","metadata":{"seo":{"title":"Orders with product claims","description":"Endpoint listing all ordered products with unfulfilled claims."}},"httpPath":"/api/orders/claims"},{"label":"Order BATCH insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/orderbatchinsertion","routeSlug":"/shoptet-api/openapi/orders/orderbatchinsertion","metadata":{"seo":{"title":"Order BATCH insertion","description":"Beta/Experimental feature: This endpoint is currently in beta and may exhibit unexpected behavior.This endpoint allows you to create multiple orders at once. Batch insertion is processed asynchronously in the same way as, for example, List of all orders, but it does not have resultUrl in the response. Instead, you can check the attribute log which contains successfully created orders and errors."}},"httpPath":"/api/orders/batch"}]},{"type":"group","label":"Order gifts","link":"/shoptet-api/openapi/order-gifts","routeSlug":"/shoptet-api/openapi/order-gifts","items":[{"label":"Get order gifts list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-gifts/getordergiftslist","routeSlug":"/shoptet-api/openapi/order-gifts/getordergiftslist","metadata":{"seo":{"title":"Get order gifts list","description":"This endpoint allow get, add or delete order related gifts. Gifts is relation to product variant by itscode identifier and is ordered by priority field"}},"httpPath":"/api/orders/gifts"},{"label":"Add order gift at the end of the list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-gifts/addordergift","routeSlug":"/shoptet-api/openapi/order-gifts/addordergift","metadata":{"seo":{"title":"Add order gift at the end of the list","description":"Add order gift (product variant) at the end of the order gift list. Giftis defined by code."}},"httpPath":"/api/orders/gifts"},{"label":"Delete order gift","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-gifts/deleteordergift","routeSlug":"/shoptet-api/openapi/order-gifts/deleteordergift","metadata":{"seo":{"title":"Delete order gift","description":"Delete order gift item by primary key."}},"httpPath":"/api/orders/gifts/{id}"}]},{"type":"group","label":"Order history","link":"/shoptet-api/openapi/order-history","routeSlug":"/shoptet-api/openapi/order-history","items":[{"label":"List of all remarks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-history/getlistofallremarks","routeSlug":"/shoptet-api/openapi/order-history/getlistofallremarks","metadata":{"seo":{"title":"List of all remarks","description":"Using this endpoint, you can get list of all remarks with detailed info of each remark asynchronously."}},"httpPath":"/api/orders/history/snapshot"},{"label":"List of remarks for the order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-history/getlistofremarksfororder","routeSlug":"/shoptet-api/openapi/order-history/getlistofremarksfororder","metadata":{"seo":{"title":"List of remarks for the order","description":"The endpoint shows the order history which is displayed in Shoptetadministration in the"}},"httpPath":"/api/orders/{code}/history"},{"label":"Insertion of remark to order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-history/createorderremark","routeSlug":"/shoptet-api/openapi/order-history/createorderremark","metadata":{"seo":{"title":"Insertion of remark to order","description":"This endpoint may be used to add the user remark into the order history."}},"httpPath":"/api/orders/{code}/history"},{"label":"Delete order history item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-history/deleteorderhistoryitem","routeSlug":"/shoptet-api/openapi/order-history/deleteorderhistoryitem","metadata":{"seo":{"title":"Delete order history item","description":"Delete order history item by primary key."}},"httpPath":"/api/orders/{code}/history/{id}"}]},{"type":"group","label":"Order items","link":"/shoptet-api/openapi/order-items","routeSlug":"/shoptet-api/openapi/order-items","items":[{"label":"Order item add","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-items/createorderitem","routeSlug":"/shoptet-api/openapi/order-items/createorderitem","metadata":{"seo":{"title":"Order item add","description":"Order item add"}},"httpPath":"/api/orders/{code}/item"},{"label":"Order item change","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-items/updateorderitem","routeSlug":"/shoptet-api/openapi/order-items/updateorderitem","metadata":{"seo":{"title":"Order item change","description":"Order item change"}},"httpPath":"/api/orders/{code}/item/{id}"},{"label":"Order item delete","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-items/deleteorderitem","routeSlug":"/shoptet-api/openapi/order-items/deleteorderitem","metadata":{"seo":{"title":"Order item delete","description":"Order item delete"}},"httpPath":"/api/orders/{code}/item/{id}"},{"label":"Order item surcharge parameters insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-items/createorderitemsurchargeparameters","routeSlug":"/shoptet-api/openapi/order-items/createorderitemsurchargeparameters","metadata":{"seo":{"title":"Order item surcharge parameters insertion","description":"There is possibility to edit surcharge parameters related to order item. For that purpose, there is inget order item detail endpoint attribute specificSurchargeParameters which returned adjusted surchargeparameters data (see order item detail endpoint)"}},"httpPath":"/api/orders/{code}/item/{id}/surcharge-parameters"},{"label":"Order item surcharge parameters deletion","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-items/deleteorderitemsurchargeparameters","routeSlug":"/shoptet-api/openapi/order-items/deleteorderitemsurchargeparameters","metadata":{"seo":{"title":"Order item surcharge parameters deletion","description":"You have to provide dynamically generated relationId which identifywhich surcharge parameter related to order item you want to delete."}},"httpPath":"/api/orders/{code}/item/{id}/surcharge-parameters/{relationId}"}]},{"type":"group","label":"Order payment","link":"/shoptet-api/openapi/order-payment","routeSlug":"/shoptet-api/openapi/order-payment","items":[{"label":"Order payment add","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-payment/createorderpayment","routeSlug":"/shoptet-api/openapi/order-payment/createorderpayment","metadata":{"seo":{"title":"Order payment add","description":"Order payment add"}},"httpPath":"/api/orders/{code}/payment"},{"label":"Order payment update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-payment/updateorderpayment","routeSlug":"/shoptet-api/openapi/order-payment/updateorderpayment","metadata":{"seo":{"title":"Order payment update","description":"Order payment update"}},"httpPath":"/api/orders/{code}/payment/{id}"}]},{"type":"group","label":"Order shipping","link":"/shoptet-api/openapi/order-shipping","routeSlug":"/shoptet-api/openapi/order-shipping","items":[{"label":"Order shipping add","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-shipping/addordershipping","routeSlug":"/shoptet-api/openapi/order-shipping/addordershipping","metadata":{"seo":{"title":"Order shipping add","description":"Order shipping add"}},"httpPath":"/api/orders/{code}/shipping"},{"label":"Order shipping update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-shipping/updateordershipping","routeSlug":"/shoptet-api/openapi/order-shipping/updateordershipping","metadata":{"seo":{"title":"Order shipping update","description":"Order shipping update"}},"httpPath":"/api/orders/{code}/shipping/{id}"}]},{"type":"separator","label":"Accounting"},{"type":"group","label":"Credit notes","link":"/shoptet-api/openapi/credit-notes","routeSlug":"/shoptet-api/openapi/credit-notes","items":[{"label":"List of credit notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/getlistofcreditnotes","routeSlug":"/shoptet-api/openapi/credit-notes/getlistofcreditnotes","metadata":{"seo":{"title":"List of credit notes","description":"The list of credit notes supports Paging"}},"httpPath":"/api/credit-notes"},{"label":"List of all credit notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/getlistofallcreditnotes","routeSlug":"/shoptet-api/openapi/credit-notes/getlistofallcreditnotes","metadata":{"seo":{"title":"List of all credit notes","description":"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."}},"httpPath":"/api/credit-notes/snapshot"},{"label":"Credit note detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/getcreditnotedetail","routeSlug":"/shoptet-api/openapi/credit-notes/getcreditnotedetail","metadata":{"seo":{"title":"Credit note detail","description":"Additional information about one credit note."}},"httpPath":"/api/credit-notes/{code}"},{"label":"Credit note update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/updatecreditnote","routeSlug":"/shoptet-api/openapi/credit-notes/updatecreditnote","metadata":{"seo":{"title":"Credit note update","description":"Credit note update"}},"httpPath":"/api/credit-notes/{code}"},{"label":"Credit note deletion","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/deletecreditnote","routeSlug":"/shoptet-api/openapi/credit-notes/deletecreditnote","metadata":{"seo":{"title":"Credit note deletion","description":"Credit note deletion"}},"httpPath":"/api/credit-notes/{code}"},{"label":"Credit note restock","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/restockcreditnote","routeSlug":"/shoptet-api/openapi/credit-notes/restockcreditnote","metadata":{"seo":{"title":"Credit note restock","description":"Restock items from credit note."}},"httpPath":"/api/credit-notes/{code}/restock"},{"label":"Credit note from invoice creation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/createcreditnotefrominvoice","routeSlug":"/shoptet-api/openapi/credit-notes/createcreditnotefrominvoice","metadata":{"seo":{"title":"Credit note from invoice creation","description":"Creating credit note from existing invoice."}},"httpPath":"/api/invoices/{code}/credit-note"},{"label":"Credit note from proof of payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/createcreditnotefromproofofpayment","routeSlug":"/shoptet-api/openapi/credit-notes/createcreditnotefromproofofpayment","metadata":{"seo":{"title":"Credit note from proof of payment","description":"Creating credit note from existing proof of payment."}},"httpPath":"/api/proof-payments/{code}/credit-note"},{"label":"Creation of credit note item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/createcreditnoteitem","routeSlug":"/shoptet-api/openapi/credit-notes/createcreditnoteitem","metadata":{"seo":{"title":"Creation of credit note item","description":"Creates a new credit note item to an existing credit, only billing or shipping item types are allowed."}},"httpPath":"/api/credit-notes/{code}/item"},{"label":"Update of credit note item","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/updatecreditnoteitem","routeSlug":"/shoptet-api/openapi/credit-notes/updatecreditnoteitem","metadata":{"seo":{"title":"Update of credit note item","description":"Updates credit note item. It's not possible to change productTypeproperty and it's not possible to update credit note item of anothertype then product or product-set."}},"httpPath":"/api/credit-notes/{code}/item/{id}"},{"label":"Deletion of credit note item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/deletecreditnoteitem","routeSlug":"/shoptet-api/openapi/credit-notes/deletecreditnoteitem","metadata":{"seo":{"title":"Deletion of credit note item","description":"Deletes credit note item. It's not possible to delete credit note itemof another type then product or product-set."}},"httpPath":"/api/credit-notes/{code}/item/{id}"},{"label":"Download credit note as PDF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/downloadcreditnotepdf","routeSlug":"/shoptet-api/openapi/credit-notes/downloadcreditnotepdf","metadata":{"seo":{"title":"Download credit note as PDF","description":"You can request the credit note as PDF file, response will be asapplication/octet-stream. You can download pdf documents"}},"httpPath":"/api/credit-notes/{code}/pdf"},{"label":"Download credit note as ISDOC","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/downloadcreditnoteasisdoc","routeSlug":"/shoptet-api/openapi/credit-notes/downloadcreditnoteasisdoc","metadata":{"seo":{"title":"Download credit note as ISDOC","description":"You can request the credit note as ISDOC file, response will be asapplication/octet-stream. You can download the documentsonly one-by-one for every e-shop. Parallel requests end with 423 Locked error."}},"httpPath":"/api/credit-notes/{code}/isdoc"},{"label":"Last credit note changes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/getlastcreditnotechanges","routeSlug":"/shoptet-api/openapi/credit-notes/getlastcreditnotechanges","metadata":{"seo":{"title":"Last credit note changes","description":"Returns the list of credit notes, which were changed. The Endpoint is intended to determinethe 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."}},"httpPath":"/api/credit-notes/changes"}]},{"type":"group","label":"Delivery notes","link":"/shoptet-api/openapi/delivery-notes","routeSlug":"/shoptet-api/openapi/delivery-notes","items":[{"label":"Delivery note from Order creation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery-notes/deliverynotefromorder","routeSlug":"/shoptet-api/openapi/delivery-notes/deliverynotefromorder","metadata":{"seo":{"title":"Delivery note from Order creation","description":"Creating delivery note from existing order."}},"httpPath":"/api/orders/{code}/delivery-notes"},{"label":"List of delivery notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery-notes/getlistofdeliverynotes","routeSlug":"/shoptet-api/openapi/delivery-notes/getlistofdeliverynotes","metadata":{"seo":{"title":"List of delivery notes","description":"The list of delivery notes supports the Paging."}},"httpPath":"/api/delivery-notes"},{"label":"List of all delivery notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery-notes/getlistofalldeliverynotes","routeSlug":"/shoptet-api/openapi/delivery-notes/getlistofalldeliverynotes","metadata":{"seo":{"title":"List of all delivery notes","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."}},"httpPath":"/api/delivery-notes/snapshot"},{"label":"Detail of delivery note","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery-notes/getdetailofdeliverynote","routeSlug":"/shoptet-api/openapi/delivery-notes/getdetailofdeliverynote","metadata":{"seo":{"title":"Detail of delivery note","description":"Additional information about one delivery note."}},"httpPath":"/api/delivery-notes/{code}"},{"label":"Download delivery note as PDF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery-notes/downloaddeliverynoteaspdf","routeSlug":"/shoptet-api/openapi/delivery-notes/downloaddeliverynoteaspdf","metadata":{"seo":{"title":"Download delivery note as PDF","description":"You can request the delivery note as PDF file, response will be asapplication/octet-stream. You can download pdf documents"}},"httpPath":"/api/delivery-notes/{code}/pdf"}]},{"type":"group","label":"Invoices","link":"/shoptet-api/openapi/invoices","routeSlug":"/shoptet-api/openapi/invoices","items":[{"label":"List of invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/invoices/getlistofinvoices","routeSlug":"/shoptet-api/openapi/invoices/getlistofinvoices","metadata":{"seo":{"title":"List of invoices","description":"Returns the list of invoices with basic information.The list of invoices supports Paging"}},"httpPath":"/api/invoices"},{"label":"List of all invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/invoices/getlistofallinvoices","routeSlug":"/shoptet-api/openapi/invoices/getlistofallinvoices","metadata":{"seo":{"title":"List of all invoices","description":"Using this endpoint, you can get list of all invoices with detailed info of each invoice (like in Invoice Detail endpoint) asynchronously."}},"httpPath":"/api/invoices/snapshot"},{"label":"Invoice detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/invoices/getinvoicedetail","routeSlug":"/shoptet-api/openapi/invoices/getinvoicedetail","metadata":{"seo":{"title":"Invoice detail","description":"Detailed information about one invoice."}},"httpPath":"/api/invoices/{code}"},{"label":"Invoice from order creation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/invoices/createinvoicefromorder","routeSlug":"/shoptet-api/openapi/invoices/createinvoicefromorder","metadata":{"seo":{"title":"Invoice from order creation","description":"Creating invoice from existing order."}},"httpPath":"/api/orders/{code}/invoice"},{"label":"Invoice from proforma invoice creation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/invoices/createinvoicefromproformainvoice","routeSlug":"/shoptet-api/openapi/invoices/createinvoicefromproformainvoice","metadata":{"seo":{"title":"Invoice from proforma invoice creation","description":"Creating invoice from existing proforma invoice."}},"httpPath":"/api/proforma-invoices/{code}/invoice"},{"label":"Invoice link proforma invoices","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/invoices/invoicelinkproformainvoices","routeSlug":"/shoptet-api/openapi/invoices/invoicelinkproformainvoices","metadata":{"seo":{"title":"Invoice link proforma invoices","description":"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.This endpoint has several sections, which are only sent when requested in the include parameter (seeRequested sections)."}},"httpPath":"/api/invoices/{code}/link-proforma-invoice"},{"label":"Invoice link proof payments","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/invoices/invoicelinkproofpayments","routeSlug":"/shoptet-api/openapi/invoices/invoicelinkproofpayments","metadata":{"seo":{"title":"Invoice link proof payments","description":"Linking proof payments to invoice. Proof payments must be related to the order, must be in same currencyas the order, must be valid and cannot be linked to another invoice."}},"httpPath":"/api/invoices/{code}/link-proof-payment"},{"label":"Download invoice as PDF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/invoices/downloadinvoiceaspdf","routeSlug":"/shoptet-api/openapi/invoices/downloadinvoiceaspdf","metadata":{"seo":{"title":"Download invoice as PDF","description":"You can request the invoice as PDF file, response will be asapplication/octet-stream. You can download pdf documentsonly one-by-one for every e-shop. Parallel requests end with 423 Locked error."}},"httpPath":"/api/invoices/{code}/pdf"},{"label":"Download invoice as ISDOC","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/invoices/downloadinvoiceasisdoc","routeSlug":"/shoptet-api/openapi/invoices/downloadinvoiceasisdoc","metadata":{"seo":{"title":"Download invoice as ISDOC","description":"You can request the invoice as ISDOC file, response will be asapplication/octet-stream. You can download the documentsonly one-by-one for every e-shop. Parallel requests end with 423 Locked error."}},"httpPath":"/api/invoices/{code}/isdoc"},{"label":"Last invoice changes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/invoices/getlastinvoicechanges","routeSlug":"/shoptet-api/openapi/invoices/getlastinvoicechanges","metadata":{"seo":{"title":"Last invoice changes","description":"Returns the list of invoices, which were changed (added/changed or deleted). Endpoint is intended to determinethe changes after you have loaded the complete list of invoices and you need to know if any of these was been changed (ordeleted). Guaranteed history is 30 days, the older data are deleted progressively."}},"httpPath":"/api/invoices/changes"}]},{"type":"group","label":"Proforma invoices","link":"/shoptet-api/openapi/proforma-invoices","routeSlug":"/shoptet-api/openapi/proforma-invoices","items":[{"label":"Proforma invoice from order creation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proforma-invoices/createproformainvoicefromorder","routeSlug":"/shoptet-api/openapi/proforma-invoices/createproformainvoicefromorder","metadata":{"seo":{"title":"Proforma invoice from order creation","description":"Creating proforma invoice from existing order."}},"httpPath":"/api_orders_{code}_proforma-invoice.yaml"},{"label":"List of proforma invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proforma-invoices/getlistofproformainvoices","routeSlug":"/shoptet-api/openapi/proforma-invoices/getlistofproformainvoices","metadata":{"seo":{"title":"List of proforma invoices","description":"Returns the list of proforma invoices. Supports thePaging."}},"httpPath":"/api/proforma-invoices"},{"label":"List of all proforma invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proforma-invoices/getlistofallproformainvoices","routeSlug":"/shoptet-api/openapi/proforma-invoices/getlistofallproformainvoices","metadata":{"seo":{"title":"List of all proforma invoices","description":"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."}},"httpPath":"/api/proforma-invoices/snapshot"},{"label":"Proforma invoice detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proforma-invoices/getproformainvoicedetail","routeSlug":"/shoptet-api/openapi/proforma-invoices/getproformainvoicedetail","metadata":{"seo":{"title":"Proforma invoice detail","description":"Additional information about one proforma invoice."}},"httpPath":"/api/proforma-invoices/{code}"},{"label":"Download proforma invoice as PDF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proforma-invoices/downloadproformainvoicepdf","routeSlug":"/shoptet-api/openapi/proforma-invoices/downloadproformainvoicepdf","metadata":{"seo":{"title":"Download proforma invoice as PDF","description":"You can request the proforma invoice as PDF file, response will be asapplication/octet-stream. You can download pdf documents"}},"httpPath":"/api/proforma-invoices/{code}/pdf"},{"label":"Last proforma invoice changes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proforma-invoices/getlastproformainvoicechanges","routeSlug":"/shoptet-api/openapi/proforma-invoices/getlastproformainvoicechanges","metadata":{"seo":{"title":"Last proforma invoice changes","description":"Returns the list of proforma invoices, which were changed. The Endpoint is intended to determinethe 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."}},"httpPath":"/api/proforma-invoices/changes"}]},{"type":"group","label":"Proof payments","link":"/shoptet-api/openapi/proof-payments","routeSlug":"/shoptet-api/openapi/proof-payments","items":[{"label":"List of proof payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/getlistofproofpayments","routeSlug":"/shoptet-api/openapi/proof-payments/getlistofproofpayments","metadata":{"seo":{"title":"List of proof payments","description":"The list of proof payments supports Paging."}},"httpPath":"/api/proof-payments"},{"label":"Proof payment insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/createproofpayment","routeSlug":"/shoptet-api/openapi/proof-payments/createproofpayment","metadata":{"seo":{"title":"Proof payment insertion","description":"Proof payment insertion"}},"httpPath":"/api/proof-payments"},{"label":"Proof payment detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/getproofpaymentdetail","routeSlug":"/shoptet-api/openapi/proof-payments/getproofpaymentdetail","metadata":{"seo":{"title":"Proof payment detail","description":"Additional information about one proof payment."}},"httpPath":"/api/proof-payments/{code}"},{"label":"Proof payment update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/updateproofpayment","routeSlug":"/shoptet-api/openapi/proof-payments/updateproofpayment","metadata":{"seo":{"title":"Proof payment update","description":"If the proof payment is closed, response code 409 is returned and thedocument cannot be updated. Proof payment is closed if:"}},"httpPath":"/api/proof-payments/{code}"},{"label":"Proof payment deletion","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/deleteproofpayment","routeSlug":"/shoptet-api/openapi/proof-payments/deleteproofpayment","metadata":{"seo":{"title":"Proof payment deletion","description":"If the proof payment is closed, response code 409 is returned and thedocument cannot be deleted. Proof payment is closed if:"}},"httpPath":"/api/proof-payments/{code}"},{"label":"List of all proof payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/getlistofallproofpayments","routeSlug":"/shoptet-api/openapi/proof-payments/getlistofallproofpayments","metadata":{"seo":{"title":"List of all proof payments","description":"Using this endpoint, you can get list of all proof payments with detailed info of each proof payment (like in Proof payment Detail endpoint)."}},"httpPath":"/api/proof-payments/snapshot"},{"label":"Proof payment detail by order code","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/getproofpaymentdetailbyordercode","routeSlug":"/shoptet-api/openapi/proof-payments/getproofpaymentdetailbyordercode","metadata":{"seo":{"title":"Proof payment detail by order code","description":"Proof payment detail by order code"}},"httpPath":"/api/proof-payments/order/{code}"},{"label":"Proof payment insertion by order code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/createproofpaymentbyordercode","routeSlug":"/shoptet-api/openapi/proof-payments/createproofpaymentbyordercode","metadata":{"seo":{"title":"Proof payment insertion by order code","description":"Proof payment insertion by order code"}},"httpPath":"/api/proof-payments/order/{code}"},{"label":"Proof payment detail by proforma invoice code","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/getproofpaymentdetailbyproformainvoicecode","routeSlug":"/shoptet-api/openapi/proof-payments/getproofpaymentdetailbyproformainvoicecode","metadata":{"seo":{"title":"Proof payment detail by proforma invoice code","description":"Proof payment detail by proforma invoice code"}},"httpPath":"/api/proof-payments/proforma-invoice/{code}"},{"label":"Proof payment insertion by proforma invoice code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/createproofpaymentbyproformainvoicecode","routeSlug":"/shoptet-api/openapi/proof-payments/createproofpaymentbyproformainvoicecode","metadata":{"seo":{"title":"Proof payment insertion by proforma invoice code","description":"Proof payment insertion by proforma invoice code"}},"httpPath":"/api/proof-payments/proforma-invoice/{code}"},{"label":"Proof payment document settings","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/proofpaymentdocumentsettings","routeSlug":"/shoptet-api/openapi/proof-payments/proofpaymentdocumentsettings","metadata":{"seo":{"title":"Proof payment document settings","description":"Using this endpoint, you can unlink an invoice from a proof of payment. After successfully unlinking the invoice, the price of the linked"}},"httpPath":"/api/proof-payments/{code}/document-settings"},{"label":"Download proof of payment as PDF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/downloadproofofpaymentpdf","routeSlug":"/shoptet-api/openapi/proof-payments/downloadproofofpaymentpdf","metadata":{"seo":{"title":"Download proof of payment as PDF","description":"You can request the proof of payment as PDF file, response will be asapplication/octet-stream. You can download pdf documents"}},"httpPath":"/api/proof-payments/{code}/pdf"},{"label":"Download proof payment as ISDOC","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/downloadproofpaymentasisdoc","routeSlug":"/shoptet-api/openapi/proof-payments/downloadproofpaymentasisdoc","metadata":{"seo":{"title":"Download proof payment as ISDOC","description":"You can request the proof payment as ISDOC file, response will be asapplication/octet-stream. You can download the documentsonly one-by-one for every e-shop. Parallel requests end with 423 Locked error."}},"httpPath":"/api/proof-payments/{code}/isdoc"},{"label":"Last proof payments changes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/getlastproofpaymentschanges","routeSlug":"/shoptet-api/openapi/proof-payments/getlastproofpaymentschanges","metadata":{"seo":{"title":"Last proof payments changes","description":"Returns the list of proof payments, which were changed. The Endpoint is intended to determinethe 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."}},"httpPath":"/api/proof-payments/changes"},{"label":"Credit note from proof of payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/createcreditnotefromproofofpayment","routeSlug":"/shoptet-api/openapi/proof-payments/createcreditnotefromproofofpayment","metadata":{"seo":{"title":"Credit note from proof of payment","description":"Creating credit note from existing proof of payment."}},"httpPath":"/api/proof-payments/{code}/credit-note"}]},{"type":"separator","label":"Products"},{"type":"group","label":"Alternative products","link":"/shoptet-api/openapi/alternative-products","routeSlug":"/shoptet-api/openapi/alternative-products","items":[{"label":"List of product alternative products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/alternative-products/getlistofproductalternativeproducts","routeSlug":"/shoptet-api/openapi/alternative-products/getlistofproductalternativeproducts","metadata":{"seo":{"title":"List of product alternative products","description":"Returns list of alternative products related to product defined byguid, list is ordered by priority parameter."}},"httpPath":"/api/products/{guid}/alternativeProducts"},{"label":"Add alternative product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/alternative-products/addalternativeproduct","routeSlug":"/shoptet-api/openapi/alternative-products/addalternativeproduct","metadata":{"seo":{"title":"Add alternative product","description":"This method add given product, defined with guid at the end of thealternative product list. After product"}},"httpPath":"/api/products/{guid}/alternativeProducts"},{"label":"Set alternative products","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/alternative-products/setalternativeproducts","routeSlug":"/shoptet-api/openapi/alternative-products/setalternativeproducts","metadata":{"seo":{"title":"Set alternative products","description":"This method set given products (minimum 0, maximum 50), defined withguid to the alternative product list. After product"}},"httpPath":"/api/products/{guid}/alternativeProducts"}]},{"type":"group","label":"Brands","link":"/shoptet-api/openapi/brands","routeSlug":"/shoptet-api/openapi/brands","items":[{"label":"List of brands","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/brands/getlistofbrands","routeSlug":"/shoptet-api/openapi/brands/getlistofbrands","metadata":{"seo":{"title":"List of brands","description":"Returns the list of brands. Supports the Paging"}},"httpPath":"/api/brands"},{"label":"Creation of brand","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/brands/createbrand","routeSlug":"/shoptet-api/openapi/brands/createbrand","metadata":{"seo":{"title":"Creation of brand","description":"Creation of brand"}},"httpPath":"/api/brands"},{"label":"Detail of brand","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/brands/getdetailofbrand","routeSlug":"/shoptet-api/openapi/brands/getdetailofbrand","metadata":{"seo":{"title":"Detail of brand","description":"Detail of brand"}},"httpPath":"/api/brands/{code}"},{"label":"Update of brand","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/brands/updatebrand","routeSlug":"/shoptet-api/openapi/brands/updatebrand","metadata":{"seo":{"title":"Update of brand","description":"Update of brand"}},"httpPath":"/api/brands/{code}"},{"label":"Deletion of brand","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/brands/deletebrand","routeSlug":"/shoptet-api/openapi/brands/deletebrand","metadata":{"seo":{"title":"Deletion of brand","description":"If the brand cannot be deleted, because it is used by some product, a409 code is returned."}},"httpPath":"/api/brands/{code}"},{"label":"BATCH creation of brands","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/brands/createbrandbatch","routeSlug":"/shoptet-api/openapi/brands/createbrandbatch","metadata":{"seo":{"title":"BATCH creation of brands","description":"This endpoint allows you to create multiple brands at once. Batchcreation is processed asynchronously in same way as for example productssnapshot, but it does not have resultUrl in response. Instead, you can checkattribute log which contains successfully created brands and errors."}},"httpPath":"/api/brands/batch"}]},{"type":"group","label":"Price lists","link":"/shoptet-api/openapi/price-lists","routeSlug":"/shoptet-api/openapi/price-lists","items":[{"label":"List of price lists","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/price-lists/getlistofpricelists","routeSlug":"/shoptet-api/openapi/price-lists/getlistofpricelists","metadata":{"seo":{"title":"List of price lists","description":"Listing of all price lists set up in e-shop. Does not contain the paging, always lists all price lists."}},"httpPath":"/api/pricelists"},{"label":"Pricelist insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/price-lists/createpricelist","routeSlug":"/shoptet-api/openapi/price-lists/createpricelist","metadata":{"seo":{"title":"Pricelist insertion","description":"Pricelist insertion"}},"httpPath":"/api/pricelists"},{"label":"Pricelist detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/price-lists/getpricelistdetail","routeSlug":"/shoptet-api/openapi/price-lists/getpricelistdetail","metadata":{"seo":{"title":"Pricelist detail","description":"Price list detail with product prices (variants) and info on discounts and limitations of purchase (minimum and maximum price)"}},"httpPath":"/api/pricelists/{id}"},{"label":"Update pricelist","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/price-lists/updatepricelist","routeSlug":"/shoptet-api/openapi/price-lists/updatepricelist","metadata":{"seo":{"title":"Update pricelist","description":"This endpoint allows updating price fields and other attributes from apricelist of a product (variant)."}},"httpPath":"/api/pricelists/{id}"},{"label":"Pricelist delete","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/price-lists/deletepricelist","routeSlug":"/shoptet-api/openapi/price-lists/deletepricelist","metadata":{"seo":{"title":"Pricelist delete","description":"Deletion of pricelist can fail with error 423 in case of runningimport."}},"httpPath":"/api/pricelists/{id}"},{"label":"List of all price list details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/price-lists/getlistofallpricelistdetails","routeSlug":"/shoptet-api/openapi/price-lists/getlistofallpricelistdetails","metadata":{"seo":{"title":"List of all price list details","description":"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."}},"httpPath":"/api/pricelists/{id}/snapshot"},{"label":"Batch pricelist update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/price-lists/updatepricelistbatch","routeSlug":"/shoptet-api/openapi/price-lists/updatepricelistbatch","metadata":{"seo":{"title":"Batch pricelist update","description":"This endpoint allows updating multiple prices at once. Price fields and other attributes from a pricelist of a product (variant) can be updated. Batch update  is processed asynchronously in same way as for example products snapshot, but  it does not have resultUrl with prices to download in response. Instead, you can check attribute log which contains successfully updated prices and errors."}},"httpPath":"/api/pricelists/{id}/batch"}]},{"type":"group","label":"Products","link":"/shoptet-api/openapi/products","routeSlug":"/shoptet-api/openapi/products","items":[{"label":"List of products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/getlistofproducts","routeSlug":"/shoptet-api/openapi/products/getlistofproducts","metadata":{"seo":{"title":"List of products","description":"Returns the list of products - only basic info and GUID, using this you can determine the detailswith another API call. Endpoint supports Paging."}},"httpPath":"/api/products"},{"label":"Product insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/createproduct","routeSlug":"/shoptet-api/openapi/products/createproduct","metadata":{"seo":{"title":"Product insertion","description":"This endpoint allows you to insert products into Shoptet. You can use itfor an import from an external system."}},"httpPath":"/api/products"},{"label":"Product copy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/productcopy","routeSlug":"/shoptet-api/openapi/products/productcopy","metadata":{"seo":{"title":"Product copy","description":"This endpoint allows you to copy a product identified by a GUID."}},"httpPath":"/api/products/{guid}/copy"},{"label":"List of all products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/getlistofallproducts","routeSlug":"/shoptet-api/openapi/products/getlistofallproducts","metadata":{"seo":{"title":"List of all products","description":"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."}},"httpPath":"/api/products/snapshot"},{"label":"List of all products and pricelist prices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/getlistofallproductsandpricelistprices","routeSlug":"/shoptet-api/openapi/products/getlistofallproductsandpricelistprices","metadata":{"seo":{"title":"List of all products and pricelist prices","description":"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."}},"httpPath":"/api/products/snapshot/pricelists"},{"label":"Product detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/getproductdetail","routeSlug":"/shoptet-api/openapi/products/getproductdetail","metadata":{"seo":{"title":"Product detail","description":"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 variantwith product information."}},"httpPath":"/api/products/{guid}"},{"label":"Product update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/updateproduct","routeSlug":"/shoptet-api/openapi/products/updateproduct","metadata":{"seo":{"title":"Product update","description":"This endpoint allows you to update a product identified by its guid."}},"httpPath":"/api/products/{guid}"},{"label":"Product deletion","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/deleteproduct","routeSlug":"/shoptet-api/openapi/products/deleteproduct","metadata":{"seo":{"title":"Product deletion","description":"Deletes product as per entered guid. If successful, returns the code200."}},"httpPath":"/api/products/{guid}"},{"label":"Product BATCH delete","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/productbatchdelete","routeSlug":"/shoptet-api/openapi/products/productbatchdelete","metadata":{"seo":{"title":"Product BATCH delete","description":"This endpoint allows you to delete multiple products or product variants at once. Batchdelete is processed asynchronously."}},"httpPath":"/api/products/batch"},{"label":"Product BATCH update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/productbatchupdate","routeSlug":"/shoptet-api/openapi/products/productbatchupdate","metadata":{"seo":{"title":"Product BATCH update","description":"This endpoint allows you to update multiple products at once. Batchupdate is processed asynchronously in same way as for example productssnapshot, but it does not have resultUrl with products to download in response.Instead, you can check attribute log which contains successfully updated products and errors."}},"httpPath":"/api/products/batch"},{"label":"Product image BATCH delete","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/productimagebatchdelete","routeSlug":"/shoptet-api/openapi/products/productimagebatchdelete","metadata":{"seo":{"title":"Product image BATCH delete","description":"This endpoint allows you to delete multiple product images at once. Batch delete is processedasynchronously."}},"httpPath":"/api/products/images/batch"},{"label":"Product detail by code","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/getproductdetailbycode","routeSlug":"/shoptet-api/openapi/products/getproductdetailbycode","metadata":{"seo":{"title":"Product detail by code","description":"Retrieve details about one product. Optional sections can be requestedusing ?include= parameterThe response format is the same as for Product detail endpoint."}},"httpPath":"/api/products/code/{code}"},{"label":"Product update by code","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/updateproductbycode","routeSlug":"/shoptet-api/openapi/products/updateproductbycode","metadata":{"seo":{"title":"Product update by code","description":"This endpoint allows you to update products identified by a product codein Shoptet."}},"httpPath":"/api/products/code/{code}"},{"label":"Product variant deletion","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/deleteproductvariant","routeSlug":"/shoptet-api/openapi/products/deleteproductvariant","metadata":{"seo":{"title":"Product variant deletion","description":"Deletes product variant as per entered code. If this is the lastproduct variant, the entire product is deleted."}},"httpPath":"/api/products/code/{code}"},{"label":"Unlink all product related files","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/unlinkallproductrelatedfiles","routeSlug":"/shoptet-api/openapi/products/unlinkallproductrelatedfiles","metadata":{"seo":{"title":"Unlink all product related files","description":"Unlink all related files linked to a specific product."}},"httpPath":"/api/products/{guid}/related-files"},{"label":"Last product changes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/getlastproductchanges","routeSlug":"/shoptet-api/openapi/products/getlastproductchanges","metadata":{"seo":{"title":"Last product changes","description":"Returns the list of products, which were changed (added/edited or deleted). Endpoint is intended to determinethe changes after you have loaded the complete list of products and you need to know if any of these have been changed.Guaranteed history is 30 days, older data are deleted progressively."}},"httpPath":"/api/products/changes"}]},{"type":"group","label":"Product availabilities","link":"/shoptet-api/openapi/product-availabilities","routeSlug":"/shoptet-api/openapi/product-availabilities","items":[{"label":"List of products availabilities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-availabilities/getlistofproductsavailabilities","routeSlug":"/shoptet-api/openapi/product-availabilities/getlistofproductsavailabilities","metadata":{"seo":{"title":"List of products availabilities","description":"Returns the list of product availabilities within the e-shop and default availabilities ids."}},"httpPath":"/api/products/availabilities"},{"label":"Product availability creation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-availabilities/createproductavailability","routeSlug":"/shoptet-api/openapi/product-availabilities/createproductavailability","metadata":{"seo":{"title":"Product availability creation","description":"Creates a new product availability."}},"httpPath":"/api/products/availabilities"},{"label":"Update of product availability","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-availabilities/updateproductavailability","routeSlug":"/shoptet-api/openapi/product-availabilities/updateproductavailability","metadata":{"seo":{"title":"Update of product availability","description":"Updates a product availability."}},"httpPath":"/api/products/availabilities/{id}"},{"label":"Deletion of product availability","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-availabilities/deleteproductavailability","routeSlug":"/shoptet-api/openapi/product-availabilities/deleteproductavailability","metadata":{"seo":{"title":"Deletion of product availability","description":"Deletes a product availability."}},"httpPath":"/api/products/availabilities/{id}"}]},{"type":"group","label":"Product gifts","link":"/shoptet-api/openapi/product-gifts","routeSlug":"/shoptet-api/openapi/product-gifts","items":[{"label":"List of product gifts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-gifts/getlistofproductgifts","routeSlug":"/shoptet-api/openapi/product-gifts/getlistofproductgifts","metadata":{"seo":{"title":"List of product gifts","description":"Returns list of gifts related (product variants) to product."}},"httpPath":"/api/products/{guid}/gifts"},{"label":"Insertion gift product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-gifts/createproductgift","routeSlug":"/shoptet-api/openapi/product-gifts/createproductgift","metadata":{"seo":{"title":"Insertion gift product","description":"Insertion gift product"}},"httpPath":"/api/products/{guid}/gifts"},{"label":"Setting gifts to product","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-gifts/setgiftstoproduct","routeSlug":"/shoptet-api/openapi/product-gifts/setgiftstoproduct","metadata":{"seo":{"title":"Setting gifts to product","description":"Setting gifts to product"}},"httpPath":"/api/products/{guid}/gifts"}]},{"type":"group","label":"Product images","link":"/shoptet-api/openapi/product-images","routeSlug":"/shoptet-api/openapi/product-images","items":[{"label":"List of product images","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-images/getlistofproductimages","routeSlug":"/shoptet-api/openapi/product-images/getlistofproductimages","metadata":{"seo":{"title":"List of product images","description":"Returns list of product's images."}},"httpPath":"/api/products/{guid}/images/{gallery}"},{"label":"Delete all product images in gallery","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-images/deleteallproductimagesingallery","routeSlug":"/shoptet-api/openapi/product-images/deleteallproductimagesingallery","metadata":{"seo":{"title":"Delete all product images in gallery","description":"Deletes all product's images by gallery name. If removeReferenceparameter is not present or set to false and if image is referenced"}},"httpPath":"/api/products/{guid}/images/{gallery}"},{"label":"Product images update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-images/getproductimagesupdate","routeSlug":"/shoptet-api/openapi/product-images/getproductimagesupdate","metadata":{"seo":{"title":"Product images update","description":"Using this endpoint you can modify product images attributes, such as description and priority (order). Maximum of 100 images can be sent at once."}},"httpPath":"/api/products/{guid}/images/{gallery}"},{"label":"Product images insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-images/createproductimages","routeSlug":"/shoptet-api/openapi/product-images/createproductimages","metadata":{"seo":{"title":"Product images insertion","description":"Using this endpoint you can upload new images to a product. This is anasynchronous request,"}},"httpPath":"/api/products/{guid}/images/{gallery}"},{"label":"Product images source update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-images/updateproductimagessource","routeSlug":"/shoptet-api/openapi/product-images/updateproductimagessource","metadata":{"seo":{"title":"Product images source update","description":"Using this endpoint you can modify product image attributes and alsoupload a new image and replace the existing one."}},"httpPath":"/api/products/{guid}/images/{gallery}/source"},{"label":"Delete one product image","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-images/deleteoneproductimage","routeSlug":"/shoptet-api/openapi/product-images/deleteoneproductimage","metadata":{"seo":{"title":"Delete one product image","description":"Deletes product's image. If removeReference parameter is not presentor set to false and if image is referenced"}},"httpPath":"/api/products/{guid}/images/{gallery}/{imageName}"}]},{"type":"group","label":"Related products","link":"/shoptet-api/openapi/related-products","routeSlug":"/shoptet-api/openapi/related-products","items":[{"label":"List of product related products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/related-products/getlistofproductrelatedproducts","routeSlug":"/shoptet-api/openapi/related-products/getlistofproductrelatedproducts","metadata":{"seo":{"title":"List of product related products","description":"Returns list of related products related to product defined by guid,list is ordered by priority parameter."}},"httpPath":"/api/products/{guid}/relatedProducts"},{"label":"Add related product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/related-products/addrelatedproduct","routeSlug":"/shoptet-api/openapi/related-products/addrelatedproduct","metadata":{"seo":{"title":"Add related product","description":"This method add given product, defined with guid at the end of therelated product list. After product"}},"httpPath":"/api/products/{guid}/relatedProducts"},{"label":"Set related products","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/related-products/setrelatedproducts","routeSlug":"/shoptet-api/openapi/related-products/setrelatedproducts","metadata":{"seo":{"title":"Set related products","description":"This method set given products (minimum 0, maximum 50), defined withguid to the related product list. After product"}},"httpPath":"/api/products/{guid}/relatedProducts"}]},{"type":"group","label":"Product related files","link":"/shoptet-api/openapi/product-related-files","routeSlug":"/shoptet-api/openapi/product-related-files","items":[{"label":"Product related file link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-related-files/createrelatedfilelink","routeSlug":"/shoptet-api/openapi/product-related-files/createrelatedfilelink","metadata":{"seo":{"title":"Product related file link","description":"Linking related file from temporary storage to product."}},"httpPath":"/api/products/{guid}/related-files"},{"label":"Delete one product related file","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-related-files/deleteoneproductrelatedfile","routeSlug":"/shoptet-api/openapi/product-related-files/deleteoneproductrelatedfile","metadata":{"seo":{"title":"Delete one product related file","description":"Deletes product's related file."}},"httpPath":"/api/products/{guid}/related-files/{id}"}]},{"type":"group","label":"Product sets","link":"/shoptet-api/openapi/product-sets","routeSlug":"/shoptet-api/openapi/product-sets","items":[{"label":"Add item to product-set","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-sets/additemtoproductset","routeSlug":"/shoptet-api/openapi/product-sets/additemtoproductset","metadata":{"seo":{"title":"Add item to product-set","description":"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.It is not allowed to add a product of the product-set type to an existing product set."}},"httpPath":"/api/products/{guid}/set"},{"label":"Set product-set items","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-sets/setproductsetitems","routeSlug":"/shoptet-api/openapi/product-sets/setproductsetitems","metadata":{"seo":{"title":"Set product-set items","description":"This method set given products (minimum 0, maximum 50), defined by product variant code to the bundle of products (product-set).Product defined in url by guid, must be set as type : product-set. When successfully saved, complete list of products in the set is returned in response.It is not allowed to add a product of the product-set type to an existing product set."}},"httpPath":"/api/products/{guid}/set"}]},{"type":"separator","label":"Delivery"},{"type":"group","label":"Delivery","link":"/shoptet-api/openapi/delivery","routeSlug":"/shoptet-api/openapi/delivery","items":[{"label":"List of shipments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery/getlistofshipments","routeSlug":"/shoptet-api/openapi/delivery/getlistofshipments","metadata":{"seo":{"title":"List of shipments","description":"Returns a paginated list of shipments. Optionally filter by status or order code."}},"httpPath":"/api/shipments"},{"label":"Creation of shipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery/createshipment","routeSlug":"/shoptet-api/openapi/delivery/createshipment","metadata":{"seo":{"title":"Creation of shipment","description":"In the packages field, you can send an object containing threecombinations of child fields:"}},"httpPath":"/api/shipments"},{"label":"Detail of shipment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery/getshipmentdetail","routeSlug":"/shoptet-api/openapi/delivery/getshipmentdetail","metadata":{"seo":{"title":"Detail of shipment","description":"Returns detail of a single shipment identified by its GUID."}},"httpPath":"/api/shipments/{guid}"},{"label":"Shipment cancellation request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery/shipmentcancellationrequest","routeSlug":"/shoptet-api/openapi/delivery/shipmentcancellationrequest","metadata":{"seo":{"title":"Shipment cancellation request","description":"Requests cancellation of shipment. Cancellation request, if valid, isaccepted via API - it means we try to process this request within thecarrier. The final state of this request can be checked in the Shipmentdetail endpoint."}},"httpPath":"/api/shipments/{guid}/cancel-request"},{"label":"Shipment shipping options by order code","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery/getshipmentshippingoptionsbyordercode","routeSlug":"/shoptet-api/openapi/delivery/getshipmentshippingoptionsbyordercode","metadata":{"seo":{"title":"Shipment shipping options by order code","description":"Returns available shipping options for the given order."}},"httpPath":"/api/shipments/order/{code}/shipping-options"},{"label":"List of shipment carriers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery/getlistofshipmentcarriers","routeSlug":"/shoptet-api/openapi/delivery/getlistofshipmentcarriers","metadata":{"seo":{"title":"List of shipment carriers","description":"List of all active shipment carriers."}},"httpPath":"/api/shipments/carriers"},{"label":"Detail of shipment carrier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery/getshipmentcarrierdetail","routeSlug":"/shoptet-api/openapi/delivery/getshipmentcarrierdetail","metadata":{"seo":{"title":"Detail of shipment carrier","description":"Returns detail of a single shipment carrier identified by its numeric ID and type."}},"httpPath":"/api/shipments/carriers/{code}/{type}"},{"label":"Close carrier shipments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery/closecarriershipments","routeSlug":"/shoptet-api/openapi/delivery/closecarriershipments","metadata":{"seo":{"title":"Close carrier shipments","description":"Closes (moves to transportation stage) of all created shipments for given carrier ID."}},"httpPath":"/api/shipments/carriers/{code}/close"},{"label":"Creation of shipment by order code","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery/createshipmentbyordercode","routeSlug":"/shoptet-api/openapi/delivery/createshipmentbyordercode","metadata":{"seo":{"title":"Creation of shipment by order code","description":"[DEPRECATED] Use POST /api/shipments instead. Creates a new shipment for the order identified by its code."}},"httpPath":"/api/shipments/order/{code}"}]},{"type":"separator","label":"Customers"},{"type":"group","label":"Customers","link":"/shoptet-api/openapi/customers","routeSlug":"/shoptet-api/openapi/customers","items":[{"label":"List of customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customers/getlistofcustomers","routeSlug":"/shoptet-api/openapi/customers/getlistofcustomers","metadata":{"seo":{"title":"List of customers","description":"Listing of customers. Supports the Paging."}},"httpPath":"/api/customers"},{"label":"Creation of customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customers/createcustomer","routeSlug":"/shoptet-api/openapi/customers/createcustomer","metadata":{"seo":{"title":"Creation of customer","description":"Creation of customer"}},"httpPath":"/api/customers"},{"label":"List of all customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customers/getlistofallcustomers","routeSlug":"/shoptet-api/openapi/customers/getlistofallcustomers","metadata":{"seo":{"title":"List of all customers","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 work on our developer's portal."}},"httpPath":"/api/customers/snapshot"},{"label":"Customer detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customers/getcustomerdetail","routeSlug":"/shoptet-api/openapi/customers/getcustomerdetail","metadata":{"seo":{"title":"Customer detail","description":"Additional information about one customer."}},"httpPath":"/api/customers/{guid}"},{"label":"Update of customer","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customers/updatecustomer","routeSlug":"/shoptet-api/openapi/customers/updatecustomer","metadata":{"seo":{"title":"Update of customer","description":"Update of customer"}},"httpPath":"/api/customers/{guid}"},{"label":"Deletion of customer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customers/deletecustomer","routeSlug":"/shoptet-api/openapi/customers/deletecustomer","metadata":{"seo":{"title":"Deletion of customer","description":"Deletion of customer"}},"httpPath":"/api/customers/{guid}"},{"label":"Last customer changes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customers/getlastcustomerchanges","routeSlug":"/shoptet-api/openapi/customers/getlastcustomerchanges","metadata":{"seo":{"title":"Last customer changes","description":"Returns the list of customers who have been changed (added/changed or deleted). The Endpoint is intendedto determine the changes after you have loaded the complete list of customers and you need to know, ifany of these has been changed (or added or deleted).  Guaranteed history is 30 days, the older data aredeleted progressively."}},"httpPath":"/api/customers/changes"},{"label":"List of customer regions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customers/getlistofcustomerregions","routeSlug":"/shoptet-api/openapi/customers/getlistofcustomerregions","metadata":{"seo":{"title":"List of customer regions","description":"Returns the list of customer regions. The regions are ordered by id. The list is not paginated."}},"httpPath":"/api/customers/regions"}]},{"type":"group","label":"Customer accounts","link":"/shoptet-api/openapi/customer-accounts","routeSlug":"/shoptet-api/openapi/customer-accounts","items":[{"label":"List of customer accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-accounts/getlistofcustomeraccounts","routeSlug":"/shoptet-api/openapi/customer-accounts/getlistofcustomeraccounts","metadata":{"seo":{"title":"List of customer accounts","description":"List of customer accounts supports the Paging."}},"httpPath":"/api/customers/{guid}/accounts"},{"label":"Creation of customer account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-accounts/createcustomeraccount","routeSlug":"/shoptet-api/openapi/customer-accounts/createcustomeraccount","metadata":{"seo":{"title":"Creation of customer account","description":"Creation of customer account"}},"httpPath":"/api/customers/{guid}/accounts"},{"label":"Detail of customer account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-accounts/getdetailofcustomeraccount","routeSlug":"/shoptet-api/openapi/customer-accounts/getdetailofcustomeraccount","metadata":{"seo":{"title":"Detail of customer account","description":"Detail of customer account"}},"httpPath":"/api/customers/{guid}/accounts/{accountGuid}"},{"label":"Update of customer account","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-accounts/updatecustomeraccount","routeSlug":"/shoptet-api/openapi/customer-accounts/updatecustomeraccount","metadata":{"seo":{"title":"Update of customer account","description":"Update of customer account"}},"httpPath":"/api/customers/{guid}/accounts/{accountGuid}"},{"label":"Deletion of customer account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-accounts/deletecustomeraccount","routeSlug":"/shoptet-api/openapi/customer-accounts/deletecustomeraccount","metadata":{"seo":{"title":"Deletion of customer account","description":"Deletion of customer account"}},"httpPath":"/api/customers/{guid}/accounts/{accountGuid}"}]},{"type":"group","label":"Customer delivery addresses","link":"/shoptet-api/openapi/customer-delivery-addresses","routeSlug":"/shoptet-api/openapi/customer-delivery-addresses","items":[{"label":"List of customer delivery addresses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-delivery-addresses/gelistofcustomerdeliveryaddresses","routeSlug":"/shoptet-api/openapi/customer-delivery-addresses/gelistofcustomerdeliveryaddresses","metadata":{"seo":{"title":"List of customer delivery addresses","description":"List of customer delivery addresses, supports the Paging."}},"httpPath":"/api/customers/{guid}/delivery-addresses"},{"label":"Creation of delivery address","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-delivery-addresses/createdeliveryaddress","routeSlug":"/shoptet-api/openapi/customer-delivery-addresses/createdeliveryaddress","metadata":{"seo":{"title":"Creation of delivery address","description":"Creation of delivery address"}},"httpPath":"/api/customers/{guid}/delivery-addresses"},{"label":"Detail of customer delivery address","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-delivery-addresses/getdetailofcustomerdeliveryaddress","routeSlug":"/shoptet-api/openapi/customer-delivery-addresses/getdetailofcustomerdeliveryaddress","metadata":{"seo":{"title":"Detail of customer delivery address","description":"Detail of customer delivery address"}},"httpPath":"/api/customers/{guid}/delivery-addresses/{addressGuid}"},{"label":"Update of customer delivery address","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-delivery-addresses/updatecustomerdeliveryaddress","routeSlug":"/shoptet-api/openapi/customer-delivery-addresses/updatecustomerdeliveryaddress","metadata":{"seo":{"title":"Update of customer delivery address","description":"Update of customer delivery address"}},"httpPath":"/api/customers/{guid}/delivery-addresses/{addressGuid}"},{"label":"Deletion of customer delivery address","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-delivery-addresses/deletecustomerdeliveryaddress","routeSlug":"/shoptet-api/openapi/customer-delivery-addresses/deletecustomerdeliveryaddress","metadata":{"seo":{"title":"Deletion of customer delivery address","description":"Deletion of customer delivery address"}},"httpPath":"/api/customers/{guid}/delivery-addresses/{addressGuid}"}]},{"type":"group","label":"Customer groups","link":"/shoptet-api/openapi/customer-groups","routeSlug":"/shoptet-api/openapi/customer-groups","items":[{"label":"List of customer groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-groups/getlistofcustomergroups","routeSlug":"/shoptet-api/openapi/customer-groups/getlistofcustomergroups","metadata":{"seo":{"title":"List of customer groups","description":"Returns list of customer groups ordered by priority. List is not paginated."}},"httpPath":"/api/customers/groups"},{"label":"Creation of customer group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-groups/createcustomergroup","routeSlug":"/shoptet-api/openapi/customer-groups/createcustomergroup","metadata":{"seo":{"title":"Creation of customer group","description":"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."}},"httpPath":"/api/customers/groups"},{"label":"Deletion of customer group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-groups/deletecustomergroup","routeSlug":"/shoptet-api/openapi/customer-groups/deletecustomergroup","metadata":{"seo":{"title":"Deletion of customer group","description":"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."}},"httpPath":"/api/customers/groups/{id}"},{"label":"Update of customer group","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-groups/updatecustomergroup","routeSlug":"/shoptet-api/openapi/customer-groups/updatecustomergroup","metadata":{"seo":{"title":"Update of customer group","description":"Updates an existing customer group with specified settings. Returns the full list of customer groups including the updated one."}},"httpPath":"/api/customers/groups/{id}"}]},{"type":"group","label":"Customer remarks","link":"/shoptet-api/openapi/customer-remarks","routeSlug":"/shoptet-api/openapi/customer-remarks","items":[{"label":"List of customer remarks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-remarks/getlistofcustomerremarks","routeSlug":"/shoptet-api/openapi/customer-remarks/getlistofcustomerremarks","metadata":{"seo":{"title":"List of customer remarks","description":"List of customer remarks, supports the Paging."}},"httpPath":"/api/customers/{guid}/remarks"},{"label":"Creation of customer remark","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-remarks/createcustomerremark","routeSlug":"/shoptet-api/openapi/customer-remarks/createcustomerremark","metadata":{"seo":{"title":"Creation of customer remark","description":"Creation of customer remark"}},"httpPath":"/api/customers/{guid}/remarks"},{"label":"Detail of customer remark","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-remarks/getdetailofcustomerremark","routeSlug":"/shoptet-api/openapi/customer-remarks/getdetailofcustomerremark","metadata":{"seo":{"title":"Detail of customer remark","description":"Detail of customer remark"}},"httpPath":"/api/customers/{guid}/remarks/{id}"},{"label":"Update of customer remark","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-remarks/updatecustomerremark","routeSlug":"/shoptet-api/openapi/customer-remarks/updatecustomerremark","metadata":{"seo":{"title":"Update of customer remark","description":"Update of customer remark"}},"httpPath":"/api/customers/{guid}/remarks/{id}"},{"label":"Deletion of customer remark","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-remarks/deletecustomerremark","routeSlug":"/shoptet-api/openapi/customer-remarks/deletecustomerremark","metadata":{"seo":{"title":"Deletion of customer remark","description":"Deletion of customer remark"}},"httpPath":"/api/customers/{guid}/remarks/{id}"}]},{"type":"separator","label":"Content"},{"type":"group","label":"Articles","link":"/shoptet-api/openapi/articles","routeSlug":"/shoptet-api/openapi/articles","items":[{"label":"List of articles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/articles/getlistofarticles","routeSlug":"/shoptet-api/openapi/articles/getlistofarticles","metadata":{"seo":{"title":"List of articles","description":"Returns a list of articles with basic info. Supports Paging"}},"httpPath":"/api/articles"},{"label":"Insert of article","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/articles/createarticle","routeSlug":"/shoptet-api/openapi/articles/createarticle","metadata":{"seo":{"title":"Insert of article","description":"Creates a new article."}},"httpPath":"/api/articles"},{"label":"List of all articles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/articles/getlistallarticles","routeSlug":"/shoptet-api/openapi/articles/getlistallarticles","metadata":{"seo":{"title":"List of all articles","description":"Using this endpoint, you can get list of all articles with detailed info of each article (like in Detail of article endpoint) asynchronously."}},"httpPath":"/api/articles/snapshot"},{"label":"Detail of article","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/articles/getdetailofarticle","routeSlug":"/shoptet-api/openapi/articles/getdetailofarticle","metadata":{"seo":{"title":"Detail of article","description":"Returns a detail of the article."}},"httpPath":"/api/articles/{articleId}"},{"label":"Update of article","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/articles/updatearticle","routeSlug":"/shoptet-api/openapi/articles/updatearticle","metadata":{"seo":{"title":"Update of article","description":"Updates the article."}},"httpPath":"/api/articles/{articleId}"},{"label":"Delete of article","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/articles/deletearticle","routeSlug":"/shoptet-api/openapi/articles/deletearticle","metadata":{"seo":{"title":"Delete of article","description":"Deletes the article."}},"httpPath":"/api/articles/{articleId}"},{"label":"List of article sections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/articles/getlistofarticlesections","routeSlug":"/shoptet-api/openapi/articles/getlistofarticlesections","metadata":{"seo":{"title":"List of article sections","description":"Returns a list of article sections."}},"httpPath":"/api/articles/sections"},{"label":"Insert of article section","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/articles/createarticlesection","routeSlug":"/shoptet-api/openapi/articles/createarticlesection","metadata":{"seo":{"title":"Insert of article section","description":"Creates a new article section."}},"httpPath":"/api/articles/sections"},{"label":"Detail of article section","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/articles/getdetailofarticlesection","routeSlug":"/shoptet-api/openapi/articles/getdetailofarticlesection","metadata":{"seo":{"title":"Detail of article section","description":"Returns a detail of the article section."}},"httpPath":"/api/articles/sections/{articleSectionId}"},{"label":"Update of article section","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/articles/updatearticlesection","routeSlug":"/shoptet-api/openapi/articles/updatearticlesection","metadata":{"seo":{"title":"Update of article section","description":"Updates the article section."}},"httpPath":"/api/articles/sections/{articleSectionId}"},{"label":"Deletion of article section","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/articles/deletearticlesection","routeSlug":"/shoptet-api/openapi/articles/deletearticlesection","metadata":{"seo":{"title":"Deletion of article section","description":"If the article section cannot be deleted, because it contains article(s), a409 code is returned."}},"httpPath":"/api/articles/sections/{articleSectionId}"}]},{"type":"group","label":"Discussions","link":"/shoptet-api/openapi/discussions","routeSlug":"/shoptet-api/openapi/discussions","items":[{"label":"Discussion settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discussions/getdiscussionsettings","routeSlug":"/shoptet-api/openapi/discussions/getdiscussionsettings","metadata":{"seo":{"title":"Discussion settings","description":"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 existing posts, and the pagination limit. Requires \"discussion\" module to be active."}},"httpPath":"/api/discussions/settings"},{"label":"List of discussion posts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discussions/getlistofdiscussionposts","routeSlug":"/shoptet-api/openapi/discussions/getlistofdiscussionposts","metadata":{"seo":{"title":"List of discussion posts","description":"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."}},"httpPath":"/api/discussions-posts"},{"label":"Creation of discussion posts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discussions/creatediscussionposts","routeSlug":"/shoptet-api/openapi/discussions/creatediscussionposts","metadata":{"seo":{"title":"Creation of discussion posts","description":"Allows the creation of multiple discussion posts at once. The limit of items per request is defined to 100."}},"httpPath":"/api/discussions-posts"},{"label":"Discussion post update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discussions/updatediscussionpost","routeSlug":"/shoptet-api/openapi/discussions/updatediscussionpost","metadata":{"seo":{"title":"Discussion post update","description":"Updates discussion post's data. Requires \"discussion\" module to be active."}},"httpPath":"/api/discussions-posts/{id}"},{"label":"Removal of discussion post","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discussions/deletediscussionbyid","routeSlug":"/shoptet-api/openapi/discussions/deletediscussionbyid","metadata":{"seo":{"title":"Removal of discussion post","description":"Deletes discussion post. Requires \"discussion\" module to be active."}},"httpPath":"/api/discussions-posts/{id}"}]},{"type":"group","label":"Pages","link":"/shoptet-api/openapi/pages","routeSlug":"/shoptet-api/openapi/pages","items":[{"label":"List of pages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/pages/getlistofpages","routeSlug":"/shoptet-api/openapi/pages/getlistofpages","metadata":{"seo":{"title":"List of pages","description":"Returns a list of pages."}},"httpPath":"/api/pages"},{"label":"Insert of page","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/pages/createpage","routeSlug":"/shoptet-api/openapi/pages/createpage","metadata":{"seo":{"title":"Insert of page","description":"Creates a new page."}},"httpPath":"/api/pages"},{"label":"Detail of page","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/pages/getdetailofpage","routeSlug":"/shoptet-api/openapi/pages/getdetailofpage","metadata":{"seo":{"title":"Detail of page","description":"Returns a detail of the page."}},"httpPath":"/api/pages/{pageId}"},{"label":"Delete of page","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/pages/deletepage","routeSlug":"/shoptet-api/openapi/pages/deletepage","metadata":{"seo":{"title":"Delete of page","description":"Deletes the page."}},"httpPath":"/api/pages/{pageId}"},{"label":"Update of page","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/pages/updatepage","routeSlug":"/shoptet-api/openapi/pages/updatepage","metadata":{"seo":{"title":"Update of page","description":"Updates the page."}},"httpPath":"/api/pages/{pageId}"}]},{"type":"group","label":"Reviews","link":"/shoptet-api/openapi/reviews","routeSlug":"/shoptet-api/openapi/reviews","items":[{"label":"Reviews settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/reviews/getreviewssettings","routeSlug":"/shoptet-api/openapi/reviews/getreviewssettings","metadata":{"seo":{"title":"Reviews settings","description":"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."}},"httpPath":"/api/reviews/settings"},{"label":"List of products reviews","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/reviews/getlistofproductsreviews","routeSlug":"/shoptet-api/openapi/reviews/getlistofproductsreviews","metadata":{"seo":{"title":"List of products reviews","description":"Returns list of product's reviews."}},"httpPath":"/api/reviews/products"},{"label":"Product review insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/reviews/createproductreview","routeSlug":"/shoptet-api/openapi/reviews/createproductreview","metadata":{"seo":{"title":"Product review insertion","description":"Importing product reviews with option to backdate them"}},"httpPath":"/api/reviews/products"},{"label":"Product review update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/reviews/updateproductreview","routeSlug":"/shoptet-api/openapi/reviews/updateproductreview","metadata":{"seo":{"title":"Product review update","description":"Updates the product review. This endpoint is available only when the 'Rating' module is active."}},"httpPath":"/api/reviews/products/{reviewId}"},{"label":"List of project reviews","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/reviews/getlistofprojectreviews","routeSlug":"/shoptet-api/openapi/reviews/getlistofprojectreviews","metadata":{"seo":{"title":"List of project reviews","description":"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."}},"httpPath":"/api/reviews/project"},{"label":"Project review insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/reviews/createprojectreview","routeSlug":"/shoptet-api/openapi/reviews/createprojectreview","metadata":{"seo":{"title":"Project review insertion","description":"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."}},"httpPath":"/api/reviews/project"},{"label":"Project review update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/reviews/updateprojectreview","routeSlug":"/shoptet-api/openapi/reviews/updateprojectreview","metadata":{"seo":{"title":"Project review update","description":"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."}},"httpPath":"/api/reviews/project/{reviewId}"}]},{"type":"group","label":"Templates","link":"/shoptet-api/openapi/templates","routeSlug":"/shoptet-api/openapi/templates","items":[{"label":"Listing of codes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/templates/getlistingofhtmlcodes","routeSlug":"/shoptet-api/openapi/templates/getlistingofhtmlcodes","metadata":{"seo":{"title":"Listing of codes","description":"This lists currently defined HTML codes for this addon, in all possiblelocations. 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."}},"httpPath":"/api/template-include"},{"label":"Inserting and editing codes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/templates/createandedithtmlcodes","routeSlug":"/shoptet-api/openapi/templates/createandedithtmlcodes","metadata":{"seo":{"title":"Inserting and editing codes","description":"This adds new or changes the current (if exists) HTML code. It ispossible to enter 1-3 changes at a time (typically"}},"httpPath":"/api/template-include"},{"label":"Removal of code","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/templates/deletehtmlcode","routeSlug":"/shoptet-api/openapi/templates/deletehtmlcode","metadata":{"seo":{"title":"Removal of code","description":"This call can be used to delete the existing code from the givenlocation. if the code for the given location (position) does notexist, the"}},"httpPath":"/api/template-include/{location}"}]},{"type":"separator","label":"Marketing"},{"type":"group","label":"Abandoned carts","link":"/shoptet-api/openapi/abandoned-carts","routeSlug":"/shoptet-api/openapi/abandoned-carts","items":[{"label":"List of all abandoned carts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/abandoned-carts/getlistofallabandonedcarts","routeSlug":"/shoptet-api/openapi/abandoned-carts/getlistofallabandonedcarts","metadata":{"seo":{"title":"List of all abandoned carts","description":"Using this endpoint, you can get list of all abandoned carts asynchronously. See how Asynchronous requests work on our developer's portal."}},"httpPath":"/api/abandoned-carts/snapshot"}]},{"type":"group","label":"Discount coupons","link":"/shoptet-api/openapi/discount-coupons","routeSlug":"/shoptet-api/openapi/discount-coupons","items":[{"label":"List of discount coupons","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/getlistofdiscountcoupons","routeSlug":"/shoptet-api/openapi/discount-coupons/getlistofdiscountcoupons","metadata":{"seo":{"title":"List of discount coupons","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."}},"httpPath":"/api/discount-coupons"},{"label":"Discount coupons insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/creatediscountcoupons","routeSlug":"/shoptet-api/openapi/discount-coupons/creatediscountcoupons","metadata":{"seo":{"title":"Discount coupons insertion","description":"This endpoint allows you to insert specific discount coupons into Shoptet. Request is sent in JSON format in its body."}},"httpPath":"/api/discount-coupons"},{"label":"Bulk discount coupon update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/bulkupdatediscountcoupons","routeSlug":"/shoptet-api/openapi/discount-coupons/bulkupdatediscountcoupons","metadata":{"seo":{"title":"Bulk discount coupon update","description":"Bulk partial update of existing discount coupons. Each coupon in the requestmust include code as the identifier. All remaining fields are optional andapplied as a partial update — only provided fields are changed."}},"httpPath":"/api/discount-coupons"},{"label":"Bulk discount coupon deletion","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/bulkdeletediscountcoupons","routeSlug":"/shoptet-api/openapi/discount-coupons/bulkdeletediscountcoupons","metadata":{"seo":{"title":"Bulk discount coupon deletion","description":"Bulk deletion of discount coupons as per list of codes. If successful, returnsthe code 200."}},"httpPath":"/api/discount-coupons"},{"label":"List of all discount coupons","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/getlistofalldiscountcoupons","routeSlug":"/shoptet-api/openapi/discount-coupons/getlistofalldiscountcoupons","metadata":{"seo":{"title":"List of all discount coupons","description":"Using this endpoint, you can get list of all discount coupons with detailedinfo of each discount coupon asynchronously. See how Asynchronousrequests work on our developer's portal."}},"httpPath":"/api/discount-coupons/snapshot"},{"label":"Detail of discount coupon","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/getdetailofdiscountcoupon","routeSlug":"/shoptet-api/openapi/discount-coupons/getdetailofdiscountcoupon","metadata":{"seo":{"title":"Detail of discount coupon","description":"Detail of discount coupon within the e-shop."}},"httpPath":"/api/discount-coupons/{code}"},{"label":"Discount coupon deletion","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/deletediscountcoupon","routeSlug":"/shoptet-api/openapi/discount-coupons/deletediscountcoupon","metadata":{"seo":{"title":"Discount coupon deletion","description":"Deletes discount coupon as per entered code. If successful, returnsthe code 200."}},"httpPath":"/api/discount-coupons/{code}"},{"label":"Discount coupons set creation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/creatediscountcouponsset","routeSlug":"/shoptet-api/openapi/discount-coupons/creatediscountcouponsset","metadata":{"seo":{"title":"Discount coupons set creation","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."}},"httpPath":"/api/discount-coupons/set"},{"label":"Discount coupons usage update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/updatediscountcouponsusage","routeSlug":"/shoptet-api/openapi/discount-coupons/updatediscountcouponsusage","metadata":{"seo":{"title":"Discount coupons usage update","description":"This endpoint allows you to set usage of discount coupon."}},"httpPath":"/api/discount-coupons/use/{code}"},{"label":"Templates of discount coupons","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/gettemplatesofdiscountcoupons","routeSlug":"/shoptet-api/openapi/discount-coupons/gettemplatesofdiscountcoupons","metadata":{"seo":{"title":"Templates of discount coupons","description":"Templates of discount coupons within the e-shop. All templates are listed at a time. Without possibility of paging or filtering."}},"httpPath":"/api/discount-coupons/templates"},{"label":"Discount coupons template insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/creatediscountcouponstemplate","routeSlug":"/shoptet-api/openapi/discount-coupons/creatediscountcouponstemplate","metadata":{"seo":{"title":"Discount coupons template insertion","description":"Discount coupons template insertion"}},"httpPath":"/api/discount-coupons/templates"},{"label":"Discount coupons template detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/getdiscountcouponstemplate","routeSlug":"/shoptet-api/openapi/discount-coupons/getdiscountcouponstemplate","metadata":{"seo":{"title":"Discount coupons template detail","description":"Returns a single discount coupon template by guid, including the list ofspecific products assigned to it."}},"httpPath":"/api/discount-coupons/templates/{guid}"},{"label":"Discount coupons template deletion","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/deletediscountcouponstemplate","routeSlug":"/shoptet-api/openapi/discount-coupons/deletediscountcouponstemplate","metadata":{"seo":{"title":"Discount coupons template deletion","description":"Deletes discount coupon template as per entered guid. If successful,returns the code 200."}},"httpPath":"/api/discount-coupons/templates/{guid}"}]},{"type":"group","label":"E-mail distribution lists","link":"/shoptet-api/openapi/e-mail-distribution-lists","routeSlug":"/shoptet-api/openapi/e-mail-distribution-lists","items":[{"label":"Listing of e-mail distribution lists","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/e-mail-distribution-lists/getlistingofemaildistributionlists","routeSlug":"/shoptet-api/openapi/e-mail-distribution-lists/getlistingofemaildistributionlists","metadata":{"seo":{"title":"Listing of e-mail distribution lists","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."}},"httpPath":"/api/mailing-lists"},{"label":"Insertion of e-mail distribution list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/e-mail-distribution-lists/createemaildistributionlist","routeSlug":"/shoptet-api/openapi/e-mail-distribution-lists/createemaildistributionlist","metadata":{"seo":{"title":"Insertion of e-mail distribution list","description":"Insertion of e-mail distribution list"}},"httpPath":"/api/mailing-lists"},{"label":"Detail of e-mail distribution list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/e-mail-distribution-lists/getdetailofemaildistributionlist","routeSlug":"/shoptet-api/openapi/e-mail-distribution-lists/getdetailofemaildistributionlist","metadata":{"seo":{"title":"Detail of e-mail distribution list","description":"This endpoint returns a list of e-mail addresses of the distribution list."}},"httpPath":"/api/mailing-lists/{code}"},{"label":"Distribution list e-mails insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/e-mail-distribution-lists/createemailsdistributionlist","routeSlug":"/shoptet-api/openapi/e-mail-distribution-lists/createemailsdistributionlist","metadata":{"seo":{"title":"Distribution list e-mails insertion","description":"This endpoint allows you to add new e-mail addresses to the distributionlist identified by its code. In the response you will receivestructured info about the result of the insertion. In theemailsInserted"}},"httpPath":"/api/mailing-lists/{code}"},{"label":"Last changes in distribution list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/e-mail-distribution-lists/getlastchangesindistributionlist","routeSlug":"/shoptet-api/openapi/e-mail-distribution-lists/getlastchangesindistributionlist","metadata":{"seo":{"title":"Last changes in distribution list","description":"Endpoint is intended to determine the changes after you load the complete e-mail list and you need to knowif any of these e-mails were added or removed. Guaranteed history is 30 days, the older data are deletedprogressively."}},"httpPath":"/api/mailing-lists/{code}/changes"}]},{"type":"group","label":"Quantity discounts","link":"/shoptet-api/openapi/quantity-discounts","routeSlug":"/shoptet-api/openapi/quantity-discounts","items":[{"label":"List of quantity discounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/quantity-discounts/getlistofquantitydiscounts","routeSlug":"/shoptet-api/openapi/quantity-discounts/getlistofquantitydiscounts","metadata":{"seo":{"title":"List of quantity discounts","description":"Returns a list of quantity discounts with basic info.Supports Paging."}},"httpPath":"/api/quantity-discounts"},{"label":"Quantity discount insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/quantity-discounts/createquantitydiscount","routeSlug":"/shoptet-api/openapi/quantity-discounts/createquantitydiscount","metadata":{"seo":{"title":"Quantity discount insertion","description":"Quantity discount insertion"}},"httpPath":"/api/quantity-discounts"},{"label":"List of all quantity discounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/quantity-discounts/getlistofallquantitydiscounts","routeSlug":"/shoptet-api/openapi/quantity-discounts/getlistofallquantitydiscounts","metadata":{"seo":{"title":"List of all quantity discounts","description":"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."}},"httpPath":"/api/quantity-discounts/snapshot"},{"label":"Detail of quantity discounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/quantity-discounts/getdetailofquantitydiscounts","routeSlug":"/shoptet-api/openapi/quantity-discounts/getdetailofquantitydiscounts","metadata":{"seo":{"title":"Detail of quantity discounts","description":"Detail of quantity discounts"}},"httpPath":"/api/quantity-discounts/{id}"},{"label":"Quantity discount update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/quantity-discounts/updatequantitydiscount","routeSlug":"/shoptet-api/openapi/quantity-discounts/updatequantitydiscount","metadata":{"seo":{"title":"Quantity discount update","description":"Quantity discount update"}},"httpPath":"/api/quantity-discounts/{id}"},{"label":"Delete of quantity discount","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/quantity-discounts/deletequantitydiscount","routeSlug":"/shoptet-api/openapi/quantity-discounts/deletequantitydiscount","metadata":{"seo":{"title":"Delete of quantity discount","description":"Delete of quantity discount"}},"httpPath":"/api/quantity-discounts/{id}"}]},{"type":"group","label":"Unsubscribed emails","link":"/shoptet-api/openapi/unsubscribed-emails","routeSlug":"/shoptet-api/openapi/unsubscribed-emails","items":[{"label":"Listing of unsubscribed e-mails","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/unsubscribed-emails/getlistingofunsubscribedemails","routeSlug":"/shoptet-api/openapi/unsubscribed-emails/getlistingofunsubscribedemails","metadata":{"seo":{"title":"Listing of unsubscribed e-mails","description":"Listing of unsubscribed e-mails"}},"httpPath":"/api/unsubscribed-emails"},{"label":"Unsubscribed e-mail insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/unsubscribed-emails/createunsubscribedemail","routeSlug":"/shoptet-api/openapi/unsubscribed-emails/createunsubscribedemail","metadata":{"seo":{"title":"Unsubscribed e-mail insertion","description":"Unsubscribed e-mail insertion"}},"httpPath":"/api/unsubscribed-emails"}]},{"type":"group","label":"Volume discounts","link":"/shoptet-api/openapi/volume-discounts","routeSlug":"/shoptet-api/openapi/volume-discounts","items":[{"label":"List of volume discounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/volume-discounts/getlistofvolumediscounts","routeSlug":"/shoptet-api/openapi/volume-discounts/getlistofvolumediscounts","metadata":{"seo":{"title":"List of volume discounts","description":"List of volume discounts"}},"httpPath":"/api/volume-discounts"}]},{"type":"group","label":"XY discounts","link":"/shoptet-api/openapi/xy-discounts","routeSlug":"/shoptet-api/openapi/xy-discounts","items":[{"label":"List of X + Y discounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/xy-discounts/getlistofxydiscounts","routeSlug":"/shoptet-api/openapi/xy-discounts/getlistofxydiscounts","metadata":{"seo":{"title":"List of X + Y discounts","description":"List of X + Y discounts"}},"httpPath":"/api/xy-discounts"},{"label":"X + Y discount insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/xy-discounts/createxydiscount","routeSlug":"/shoptet-api/openapi/xy-discounts/createxydiscount","metadata":{"seo":{"title":"X + Y discount insertion","description":"X + Y discount insertion"}},"httpPath":"/api/xy-discounts"},{"label":"Detail of X + Y discounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/xy-discounts/getdetailofxydiscounts","routeSlug":"/shoptet-api/openapi/xy-discounts/getdetailofxydiscounts","metadata":{"seo":{"title":"Detail of X + Y discounts","description":"Detail of X + Y discounts"}},"httpPath":"/api/xy-discounts/{id}"},{"label":"X + Y discount update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/xy-discounts/updatexydiscount","routeSlug":"/shoptet-api/openapi/xy-discounts/updatexydiscount","metadata":{"seo":{"title":"X + Y discount update","description":"X + Y discount update"}},"httpPath":"/api/xy-discounts/{id}"},{"label":"Delete of X + Y discount","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/xy-discounts/deletexydiscount","routeSlug":"/shoptet-api/openapi/xy-discounts/deletexydiscount","metadata":{"seo":{"title":"Delete of X + Y discount","description":"Delete of X + Y discount"}},"httpPath":"/api/xy-discounts/{id}"},{"label":"X + Y discounts settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/xy-discounts/getxydiscountssettings","routeSlug":"/shoptet-api/openapi/xy-discounts/getxydiscountssettings","metadata":{"seo":{"title":"X + Y discounts settings","description":"Lists & updates settings of X + Y discounts.Please note, that enableInCashdesk setting is not supported on HU projects."}},"httpPath":"/api/xy-discounts/settings"},{"label":"X + Y discount settings update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/xy-discounts/updatexydiscountsettings","routeSlug":"/shoptet-api/openapi/xy-discounts/updatexydiscountsettings","metadata":{"seo":{"title":"X + Y discount settings update","description":"Updates settings for X + Y discounts. All settings are optional, but atleast one should be present."}},"httpPath":"/api/xy-discounts/settings"}]},{"type":"separator","label":"Categories"},{"type":"group","label":"Categories","link":"/shoptet-api/openapi/categories","routeSlug":"/shoptet-api/openapi/categories","items":[{"label":"List of product categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/categories/getlistofproductcategories","routeSlug":"/shoptet-api/openapi/categories/getlistofproductcategories","metadata":{"seo":{"title":"List of product categories","description":"Returns the list of product categories."}},"httpPath":"/api/categories"},{"label":"Product category create","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/categories/createproductcategory","routeSlug":"/shoptet-api/openapi/categories/createproductcategory","metadata":{"seo":{"title":"Product category create","description":"Creates new category"}},"httpPath":"/api/categories"},{"label":"Product category detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/categories/getproductcategorydetail","routeSlug":"/shoptet-api/openapi/categories/getproductcategorydetail","metadata":{"seo":{"title":"Product category detail","description":"Returns category info"}},"httpPath":"/api/categories/{categoryGuid}"},{"label":"Product category update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/categories/updateproductcategory","routeSlug":"/shoptet-api/openapi/categories/updateproductcategory","metadata":{"seo":{"title":"Product category update","description":"Updates existing category."}},"httpPath":"/api/categories/{categoryGuid}"},{"label":"Product category deletion","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/categories/deleteproductcategory","routeSlug":"/shoptet-api/openapi/categories/deleteproductcategory","metadata":{"seo":{"title":"Product category deletion","description":"Deletes product category as per entered categoryGuid. If successful,returns the code 200."}},"httpPath":"/api/categories/{categoryGuid}"},{"label":"Product category BATCH update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/categories/updateproductcategorybatch","routeSlug":"/shoptet-api/openapi/categories/updateproductcategorybatch","metadata":{"seo":{"title":"Product category BATCH update","description":"This endpoint allows you to update multiple categories at once. Batchupdate is processed asynchronously in same way as for example productssnapshot, but it does not have resultUrl with categories to download inresponse. Instead, you can check attribute log which containssuccessfully updated categories and errors."}},"httpPath":"/api/categories/batch"},{"label":"Category products priority BATCH update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/categories/updatecategoryproductsprioritybatch","routeSlug":"/shoptet-api/openapi/categories/updatecategoryproductsprioritybatch","metadata":{"seo":{"title":"Category products priority BATCH update","description":"This endpoint allows you to update multiple categories with product priorities at once. Batchupdate is processed asynchronously in same way as for example productssnapshot, but it does not have resultUrl in response. Instead, you can check attribute log which containssuccessfully updated categories and errors."}},"httpPath":"/api/categories/products-priority/batch"},{"label":"List of products order in category","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/categories/getlistofproductsorderincategory","routeSlug":"/shoptet-api/openapi/categories/getlistofproductsorderincategory","metadata":{"seo":{"title":"List of products order in category","description":"Retrieves products and their priorities within a category."}},"httpPath":"/api/categories/{categoryGuid}/productsPriority"},{"label":"Update product order in category","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/categories/updateproductorderincategory","routeSlug":"/shoptet-api/openapi/categories/updateproductorderincategory","metadata":{"seo":{"title":"Update product order in category","description":"Using this endpoint you can update product priority within a category."}},"httpPath":"/api/categories/{categoryGuid}/productsPriority"}]},{"type":"group","label":"Parametric categories","link":"/shoptet-api/openapi/parametric-categories","routeSlug":"/shoptet-api/openapi/parametric-categories","items":[{"label":"List of parametric categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/parametric-categories/getlistofparametriccategories","routeSlug":"/shoptet-api/openapi/parametric-categories/getlistofparametriccategories","metadata":{"seo":{"title":"List of parametric categories","description":"Returns the list of product categories."}},"httpPath":"/api/parametric-categories"},{"label":"Creation of parametric category","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/parametric-categories/createparametriccategory","routeSlug":"/shoptet-api/openapi/parametric-categories/createparametriccategory","metadata":{"seo":{"title":"Creation of parametric category","description":"Creates a new combination for a parametric category."}},"httpPath":"/api/parametric-categories"},{"label":"Parametric category detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/parametric-categories/getparametriccategorydetail","routeSlug":"/shoptet-api/openapi/parametric-categories/getparametriccategorydetail","metadata":{"seo":{"title":"Parametric category detail","description":"Returns parametric category info."}},"httpPath":"/api/parametric-categories/{categoryGuid}"},{"label":"Update of parametric category","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/parametric-categories/updateparametriccategory","routeSlug":"/shoptet-api/openapi/parametric-categories/updateparametriccategory","metadata":{"seo":{"title":"Update of parametric category","description":"Updates existing parametric category."}},"httpPath":"/api/parametric-categories/{categoryGuid}"},{"label":"Delete of parametric category","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/parametric-categories/deleteparametriccategory","routeSlug":"/shoptet-api/openapi/parametric-categories/deleteparametriccategory","metadata":{"seo":{"title":"Delete of parametric category","description":"Delete existing parametric category. The \"Advanced SEO\" module must be active to use this endpoint."}},"httpPath":"/api/parametric-categories/{categoryGuid}"},{"label":"Parametric category available parameters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/parametric-categories/getparametriccategoryavailableparameters","routeSlug":"/shoptet-api/openapi/parametric-categories/getparametriccategoryavailableparameters","metadata":{"seo":{"title":"Parametric category available parameters","description":"Returns all available parameters for a parent category that can be used when creating parametric categories and their combinations."}},"httpPath":"/api/parametric-categories-available-parameters/{categoryGuid}"},{"label":"Creation of parametric category definition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/parametric-categories/createparametriccategorydefinition","routeSlug":"/shoptet-api/openapi/parametric-categories/createparametriccategorydefinition","metadata":{"seo":{"title":"Creation of parametric category definition","description":"Creates a new parametric category definition for a given category and set of parameters."}},"httpPath":"/api/parametric-categories-definition"}]},{"type":"separator","label":"Settings"},{"type":"group","label":"Consumption taxes","link":"/shoptet-api/openapi/consumption-taxes","routeSlug":"/shoptet-api/openapi/consumption-taxes","items":[{"label":"List of product consumption taxes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/consumption-taxes/getlistofconsumptiontaxes","routeSlug":"/shoptet-api/openapi/consumption-taxes/getlistofconsumptiontaxes","metadata":{"seo":{"title":"List of product consumption taxes","description":"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."}},"httpPath":"/api/products/consumption-taxes"},{"label":"Creation of consumption tax","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/consumption-taxes/createconsumptiontax","routeSlug":"/shoptet-api/openapi/consumption-taxes/createconsumptiontax","metadata":{"seo":{"title":"Creation of consumption tax","description":"Creation of consumption tax"}},"httpPath":"/api/products/consumption-taxes"},{"label":"Update of consumption tax","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/consumption-taxes/updateconsumptiontax","routeSlug":"/shoptet-api/openapi/consumption-taxes/updateconsumptiontax","metadata":{"seo":{"title":"Update of consumption tax","description":"Update of consumption tax"}},"httpPath":"/api/products/consumption-taxes/{id}"},{"label":"Deletion of consumption tax","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/consumption-taxes/deleteconsumptiontax","routeSlug":"/shoptet-api/openapi/consumption-taxes/deleteconsumptiontax","metadata":{"seo":{"title":"Deletion of consumption tax","description":"Deletion of consumption tax"}},"httpPath":"/api/products/consumption-taxes/{id}"}]},{"type":"group","label":"Eshop","link":"/shoptet-api/openapi/eshop","routeSlug":"/shoptet-api/openapi/eshop","items":[{"label":"Eshop info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/eshop/geteshopinfo","routeSlug":"/shoptet-api/openapi/eshop/geteshopinfo","metadata":{"seo":{"title":"Eshop info","description":"Information about queried e-shop (defined by token). Returns the contact data and e-shop settings."}},"httpPath":"/api/eshop"},{"label":"E-shop design","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/eshop/geteshopdesign","routeSlug":"/shoptet-api/openapi/eshop/geteshopdesign","metadata":{"seo":{"title":"E-shop design","description":"Information about queried e-shop template setting (defined by token).backgroundImage value can internally contain the link to a transparentreference gif, in this case the API returns a NULL value."}},"httpPath":"/api/eshop/design"},{"label":"E-shop document settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/eshop/geteshopdocumentsettings","routeSlug":"/shoptet-api/openapi/eshop/geteshopdocumentsettings","metadata":{"seo":{"title":"E-shop document settings","description":"Information about financial documents settings."}},"httpPath":"/api/eshop/document-settings"},{"label":"E-shop mandatory fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/eshop/geteshopmandatoryfields","routeSlug":"/shoptet-api/openapi/eshop/geteshopmandatoryfields","metadata":{"seo":{"title":"E-shop mandatory fields","description":"Information about queried e-shop mandatory fields setting (defined by token).Returns the values, which are set by e-shop administrator inSettings -> Customers -> Mandatory fields."}},"httpPath":"/api/eshop/customer-fields"}]},{"type":"group","label":"Filtering parameters","link":"/shoptet-api/openapi/filtering-parameters","routeSlug":"/shoptet-api/openapi/filtering-parameters","items":[{"label":"List of filtering parameters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/filtering-parameters/getlistoffilteringparameters","routeSlug":"/shoptet-api/openapi/filtering-parameters/getlistoffilteringparameters","metadata":{"seo":{"title":"List of filtering parameters","description":"Returns the list of available filtering parameters with their available values within the e-shop."}},"httpPath":"/api/products/filtering-parameters"},{"label":"Creation of filtering parameter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/filtering-parameters/createfilteringparameter","routeSlug":"/shoptet-api/openapi/filtering-parameters/createfilteringparameter","metadata":{"seo":{"title":"Creation of filtering parameter","description":"Creation of filtering parameter"}},"httpPath":"/api/products/filtering-parameters"},{"label":"Detail of filtering parameter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/filtering-parameters/getdetailoffilteringparameter","routeSlug":"/shoptet-api/openapi/filtering-parameters/getdetailoffilteringparameter","metadata":{"seo":{"title":"Detail of filtering parameter","description":"Detail of filtering parameter"}},"httpPath":"/api/products/filtering-parameters/{code}"},{"label":"Update of filtering parameter","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/filtering-parameters/updatefilteringparameter","routeSlug":"/shoptet-api/openapi/filtering-parameters/updatefilteringparameter","metadata":{"seo":{"title":"Update of filtering parameter","description":"Update of filtering parameter"}},"httpPath":"/api/products/filtering-parameters/{code}"},{"label":"Creation of filtering parameter value","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/filtering-parameters/createfilteringparametervalue","routeSlug":"/shoptet-api/openapi/filtering-parameters/createfilteringparametervalue","metadata":{"seo":{"title":"Creation of filtering parameter value","description":"Creation of filtering parameter value"}},"httpPath":"/api/products/filtering-parameters/{code}"},{"label":"Removal of filtering parameter","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/filtering-parameters/deletefilteringparameter","routeSlug":"/shoptet-api/openapi/filtering-parameters/deletefilteringparameter","metadata":{"seo":{"title":"Removal of filtering parameter","description":"Removal of filtering parameter"}},"httpPath":"/api/products/filtering-parameters/{code}"},{"label":"Removal of filtering parameter value","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/filtering-parameters/deletefilteringparametervalue","routeSlug":"/shoptet-api/openapi/filtering-parameters/deletefilteringparametervalue","metadata":{"seo":{"title":"Removal of filtering parameter value","description":"Removal of filtering parameter value"}},"httpPath":"/api/products/filtering-parameters/{code}/{valueIndex}"},{"label":"Update of filtering parameter value","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/filtering-parameters/updatefilteringparametervalue","routeSlug":"/shoptet-api/openapi/filtering-parameters/updatefilteringparametervalue","metadata":{"seo":{"title":"Update of filtering parameter value","description":"Update of filtering parameter value"}},"httpPath":"/api/products/filtering-parameters/{code}/{valueIndex}"}]},{"type":"group","label":"Flags","link":"/shoptet-api/openapi/flags","routeSlug":"/shoptet-api/openapi/flags","items":[{"label":"List of products flags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/flags/getlistofproductsflags","routeSlug":"/shoptet-api/openapi/flags/getlistofproductsflags","metadata":{"seo":{"title":"List of products flags","description":"Returns the list of product flags within the e-shop."}},"httpPath":"/api/products/flags"},{"label":"Product flag insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/flags/createproductflag","routeSlug":"/shoptet-api/openapi/flags/createproductflag","metadata":{"seo":{"title":"Product flag insertion","description":"Product flag insertion"}},"httpPath":"/api/products/flags"},{"label":"Product flag update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/flags/updateproductflag","routeSlug":"/shoptet-api/openapi/flags/updateproductflag","metadata":{"seo":{"title":"Product flag update","description":"Updates the flag."}},"httpPath":"/api/products/flags/{code}"},{"label":"Product flag delete","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/flags/deleteproductflag","routeSlug":"/shoptet-api/openapi/flags/deleteproductflag","metadata":{"seo":{"title":"Product flag delete","description":"Deletes the flag. System flags cannot be deleted."}},"httpPath":"/api/products/flags/{code}"}]},{"type":"group","label":"Gifts","link":"/shoptet-api/openapi/gifts","routeSlug":"/shoptet-api/openapi/gifts","items":[{"label":"Get order gift settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/gifts/getordergiftsettings","routeSlug":"/shoptet-api/openapi/gifts/getordergiftsettings","metadata":{"seo":{"title":"Get order gift settings","description":"There are order gift setting, which influence general behaviour."}},"httpPath":"/api/orders/gifts/settings"},{"label":"Update order gift settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/gifts/updateordergiftsettings","routeSlug":"/shoptet-api/openapi/gifts/updateordergiftsettings","metadata":{"seo":{"title":"Update order gift settings","description":"Method updates order gift settings. Every item in request body is optional, but at least one setting is required."}},"httpPath":"/api/orders/gifts/settings"}]},{"type":"group","label":"Payment methods","link":"/shoptet-api/openapi/payment-methods","routeSlug":"/shoptet-api/openapi/payment-methods","items":[{"label":"Listing of payment methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/payment-methods/getlistingofpaymentmethods","routeSlug":"/shoptet-api/openapi/payment-methods/getlistingofpaymentmethods","metadata":{"seo":{"title":"Listing of payment methods","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."}},"httpPath":"/api/payment-methods"},{"label":"Adding the payment methods","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/payment-methods/createpaymentmethod","routeSlug":"/shoptet-api/openapi/payment-methods/createpaymentmethod","metadata":{"seo":{"title":"Adding the payment methods","description":"Adds the new payment method for the specific e-shop."}},"httpPath":"/api/payment-methods"},{"label":"Payment method deletion","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/payment-methods/deletepaymentmethod","routeSlug":"/shoptet-api/openapi/payment-methods/deletepaymentmethod","metadata":{"seo":{"title":"Payment method deletion","description":"Deletes payment method by guid. Only payment methods related to your addon may be deleted. Private API tokens aren't currently supported."}},"httpPath":"/api/payment-methods/{guid}"}]},{"type":"group","label":"Recycling fees","link":"/shoptet-api/openapi/recycling-fees","routeSlug":"/shoptet-api/openapi/recycling-fees","items":[{"label":"List of recycling fee categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/recycling-fees/getlistofrecyclingfeecategories","routeSlug":"/shoptet-api/openapi/recycling-fees/getlistofrecyclingfeecategories","metadata":{"seo":{"title":"List of recycling fee categories","description":"Returns the list of recycling fee categories within the e-shop."}},"httpPath":"/api/products/recycling-fee-categories"}]},{"type":"group","label":"Shipping methods","link":"/shoptet-api/openapi/shipping-methods","routeSlug":"/shoptet-api/openapi/shipping-methods","items":[{"label":"List of shipping methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/shipping-methods/getlistofshippingmethods","routeSlug":"/shoptet-api/openapi/shipping-methods/getlistofshippingmethods","metadata":{"seo":{"title":"List of shipping methods","description":"Endpoint returns a list of all available shipping methods and details of their settings. Does not use paging,"}},"httpPath":"/api/shipping-methods"},{"label":"Adding a shipping method","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/shipping-methods/createshippingmethod","routeSlug":"/shoptet-api/openapi/shipping-methods/createshippingmethod","metadata":{"seo":{"title":"Adding a shipping method","description":"Adds a new shipping method for the specific e-shop."}},"httpPath":"/api/shipping-methods"},{"label":"Shipping method detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/shipping-methods/getshippingmethoddetail","routeSlug":"/shoptet-api/openapi/shipping-methods/getshippingmethoddetail","metadata":{"seo":{"title":"Shipping method detail","description":"Endpoint returns the detail of a single shipping method identified by its GUID."}},"httpPath":"/api/shipping-methods/{guid}"}]},{"type":"group","label":"Stocks","link":"/shoptet-api/openapi/stocks","routeSlug":"/shoptet-api/openapi/stocks","items":[{"label":"List of stocks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/stocks/getlistofstocks","routeSlug":"/shoptet-api/openapi/stocks/getlistofstocks","metadata":{"seo":{"title":"List of stocks","description":"Returns the list of stocks. There are usually not many stocks, therefore the endpoint returns all of them without Paging."}},"httpPath":"/api/stocks"},{"label":"Stock detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/stocks/getstockdetail","routeSlug":"/shoptet-api/openapi/stocks/getstockdetail","metadata":{"seo":{"title":"Stock detail","description":"Returns detailed information about one stock."}},"httpPath":"/api/stocks/{stockId}"},{"label":"Stock movements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/stocks/getstockmovements","routeSlug":"/shoptet-api/openapi/stocks/getstockmovements","metadata":{"seo":{"title":"Stock movements","description":"It returns the list of changes in product quantity, which were donewithin one stock. Supports the Paging movements."}},"httpPath":"/api/stocks/{stockId}/movements"},{"label":"Update quantity in stock","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/stocks/updatequantityinstock","routeSlug":"/shoptet-api/openapi/stocks/updatequantityinstock","metadata":{"seo":{"title":"Update quantity in stock","description":"Endpoint enables the quantity of product in stock (relative andabsolute) to be changed. Within a call, the update"}},"httpPath":"/api/stocks/{stockId}/movements"},{"label":"Stock movements - Last move","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/stocks/getstockmovementslastmove","routeSlug":"/shoptet-api/openapi/stocks/getstockmovementslastmove","metadata":{"seo":{"title":"Stock movements - Last move","description":"It returns informations about last stock move."}},"httpPath":"/api/stocks/{stockId}/movements/last"},{"label":"Product supplies in stock","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/stocks/getproductsuppliesinstock","routeSlug":"/shoptet-api/openapi/stocks/getproductsuppliesinstock","metadata":{"seo":{"title":"Product supplies in stock","description":"Returns the product supplies in stock for all products in a specific stock, contains GUID, code and quantityin 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, in case of filtering, the amount of items per page increases.This endpoint supports optional parts using the include parameter (see Section on demand). The changeTime itemis always temporarily returned, however as of 16. 3. 2019 only upon using the include parameter."}},"httpPath":"/api/stocks/{stockId}/supplies"}]},{"type":"group","label":"Suppliers","link":"/shoptet-api/openapi/suppliers","routeSlug":"/shoptet-api/openapi/suppliers","items":[{"label":"List of suppliers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/suppliers/getlistofsuppliers","routeSlug":"/shoptet-api/openapi/suppliers/getlistofsuppliers","metadata":{"seo":{"title":"List of suppliers","description":"Returns the list of suppliers. Supports the Paging"}},"httpPath":"/api/suppliers"}]},{"type":"group","label":"Surcharge parameters","link":"/shoptet-api/openapi/surcharge-parameters","routeSlug":"/shoptet-api/openapi/surcharge-parameters","items":[{"label":"List of surcharge parameters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/surcharge-parameters/getlistofsurchargeparameters","routeSlug":"/shoptet-api/openapi/surcharge-parameters/getlistofsurchargeparameters","metadata":{"seo":{"title":"List of surcharge parameters","description":"Returns the list of available surcharge parameters with their available values within the e-shop."}},"httpPath":"/api/products/surcharge-parameters"},{"label":"Creation of surcharge parameter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/surcharge-parameters/createsurchargeparameter","routeSlug":"/shoptet-api/openapi/surcharge-parameters/createsurchargeparameter","metadata":{"seo":{"title":"Creation of surcharge parameter","description":"Creation of surcharge parameter"}},"httpPath":"/api/products/surcharge-parameters"},{"label":"Detail of surcharge parameter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/surcharge-parameters/getdetailofsurchargeparameter","routeSlug":"/shoptet-api/openapi/surcharge-parameters/getdetailofsurchargeparameter","metadata":{"seo":{"title":"Detail of surcharge parameter","description":"Detail of surcharge parameter"}},"httpPath":"/api/products/surcharge-parameters/{code}"},{"label":"Update of surcharge parameter","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/surcharge-parameters/updatesurchargeparameter","routeSlug":"/shoptet-api/openapi/surcharge-parameters/updatesurchargeparameter","metadata":{"seo":{"title":"Update of surcharge parameter","description":"Update of surcharge parameter"}},"httpPath":"/api/products/surcharge-parameters/{code}"},{"label":"Creation of surcharge parameter value","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/surcharge-parameters/createsurchargeparametervalue","routeSlug":"/shoptet-api/openapi/surcharge-parameters/createsurchargeparametervalue","metadata":{"seo":{"title":"Creation of surcharge parameter value","description":"Creation of surcharge parameter value"}},"httpPath":"/api/products/surcharge-parameters/{code}"},{"label":"Removal of surcharge parameter","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/surcharge-parameters/deletesurchargeparameterbyindex","routeSlug":"/shoptet-api/openapi/surcharge-parameters/deletesurchargeparameterbyindex","metadata":{"seo":{"title":"Removal of surcharge parameter","description":"Removal of surcharge parameter"}},"httpPath":"/api/products/surcharge-parameters/{code}"},{"label":"Removal of surcharge parameter value","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/surcharge-parameters/deletesurchargeparametervalue","routeSlug":"/shoptet-api/openapi/surcharge-parameters/deletesurchargeparametervalue","metadata":{"seo":{"title":"Removal of surcharge parameter value","description":"Removal of surcharge parameter value"}},"httpPath":"/api/products/surcharge-parameters/{paramIndex}/{valueIndex}"},{"label":"Update of surcharge parameter value","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/surcharge-parameters/updatesurchargeparametervalue","routeSlug":"/shoptet-api/openapi/surcharge-parameters/updatesurchargeparametervalue","metadata":{"seo":{"title":"Update of surcharge parameter value","description":"Update of surcharge parameter value"}},"httpPath":"/api/products/surcharge-parameters/{paramIndex}/{valueIndex}"}]},{"type":"group","label":"Units","link":"/shoptet-api/openapi/units","routeSlug":"/shoptet-api/openapi/units","items":[{"label":"List of product units","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/units/getlistofproductunits","routeSlug":"/shoptet-api/openapi/units/getlistofproductunits","metadata":{"seo":{"title":"List of product units","description":"List of product units"}},"httpPath":"/api/products/units"}]},{"type":"group","label":"Variant parameters","link":"/shoptet-api/openapi/variant-parameters","routeSlug":"/shoptet-api/openapi/variant-parameters","items":[{"label":"List of variant parameters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/variant-parameters/getlistofvariantparameters","routeSlug":"/shoptet-api/openapi/variant-parameters/getlistofvariantparameters","metadata":{"seo":{"title":"List of variant parameters","description":"Returns the list of available variant parameters with their available values within the e-shop."}},"httpPath":"/api/products/variant-parameters"},{"label":"Creation of variant parameter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/variant-parameters/createvariantparameter","routeSlug":"/shoptet-api/openapi/variant-parameters/createvariantparameter","metadata":{"seo":{"title":"Creation of variant parameter","description":"Creation of variant parameter"}},"httpPath":"/api/products/variant-parameters"},{"label":"Detail of variant parameter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/variant-parameters/getdetailofvariantparameter","routeSlug":"/shoptet-api/openapi/variant-parameters/getdetailofvariantparameter","metadata":{"seo":{"title":"Detail of variant parameter","description":"Detail of variant parameter"}},"httpPath":"/api/products/variant-parameters/{paramIndex}"},{"label":"Update of variant parameter","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/variant-parameters/updatevariantparameter","routeSlug":"/shoptet-api/openapi/variant-parameters/updatevariantparameter","metadata":{"seo":{"title":"Update of variant parameter","description":"Update of variant parameter"}},"httpPath":"/api/products/variant-parameters/{paramIndex}"},{"label":"Creation of variant parameter value","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/variant-parameters/createvariantparametervalue","routeSlug":"/shoptet-api/openapi/variant-parameters/createvariantparametervalue","metadata":{"seo":{"title":"Creation of variant parameter value","description":"Creation of variant parameter value"}},"httpPath":"/api/products/variant-parameters/{paramIndex}"},{"label":"Removal of variant parameter","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/variant-parameters/deletevariantparameter","routeSlug":"/shoptet-api/openapi/variant-parameters/deletevariantparameter","metadata":{"seo":{"title":"Removal of variant parameter","description":"Removal of variant parameter"}},"httpPath":"/api/products/variant-parameters/{paramIndex}"},{"label":"Removal of variant parameter value","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/variant-parameters/deletevariantparametervalue","routeSlug":"/shoptet-api/openapi/variant-parameters/deletevariantparametervalue","metadata":{"seo":{"title":"Removal of variant parameter value","description":"Removal of variant parameter value"}},"httpPath":"/api/products/variant-parameters/{paramIndex}/{rawValue}"},{"label":"Update of variant parameter value","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/variant-parameters/updatevariantparametervalue","routeSlug":"/shoptet-api/openapi/variant-parameters/updatevariantparametervalue","metadata":{"seo":{"title":"Update of variant parameter value","description":"Update of variant parameter value"}},"httpPath":"/api/products/variant-parameters/{paramIndex}/{rawValue}"}]},{"type":"group","label":"Warranties","link":"/shoptet-api/openapi/warranties","routeSlug":"/shoptet-api/openapi/warranties","items":[{"label":"List of product warranties","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/warranties/getlistofproductwarranties","routeSlug":"/shoptet-api/openapi/warranties/getlistofproductwarranties","metadata":{"seo":{"title":"List of product warranties","description":"Returns list of product warranties."}},"httpPath":"/api/products/warranties"}]},{"type":"separator","label":"Sales channels"},{"type":"group","label":"Sales channels","link":"/shoptet-api/openapi/sales-channels","routeSlug":"/shoptet-api/openapi/sales-channels","items":[{"label":"List of all sales channels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/sales-channels/getsaleschannels","routeSlug":"/shoptet-api/openapi/sales-channels/getsaleschannels","metadata":{"seo":{"title":"List of all sales channels","description":"Provides a list of all sales channels."}},"httpPath":"/api/sales-channels"},{"label":"Sales channel detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/sales-channels/getsaleschannelsdetail","routeSlug":"/shoptet-api/openapi/sales-channels/getsaleschannelsdetail","metadata":{"seo":{"title":"Sales channel detail","description":"Information about the detail of the sales channels. Module Sales Channel is required."}},"httpPath":"/api/sales-channels/{guid}"},{"label":"Sales channel detail by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/sales-channels/getsaleschannelsdetailbyid","routeSlug":"/shoptet-api/openapi/sales-channels/getsaleschannelsdetailbyid","metadata":{"seo":{"title":"Sales channel detail by ID","description":"Information about the detail of the sales channels. Module Sales Channel is required."}},"httpPath":"/api/sales-channels/id/{id}"}]},{"type":"separator","label":"System"},{"type":"group","label":"Endpoints","link":"/shoptet-api/openapi/endpoints","routeSlug":"/shoptet-api/openapi/endpoints","items":[{"label":"List of available endpoints","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/endpoints/getlistofavailableendpoints","routeSlug":"/shoptet-api/openapi/endpoints/getlistofavailableendpoints","metadata":{"seo":{"title":"List of available 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."}},"httpPath":"/api/system/endpoints"}]},{"type":"group","label":"Exports","link":"/shoptet-api/openapi/exports","routeSlug":"/shoptet-api/openapi/exports","items":[{"label":"General document export","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/exports/generaldocumentdownload","routeSlug":"/shoptet-api/openapi/exports/generaldocumentdownload","metadata":{"seo":{"title":"General document export","description":"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 Asynchronousrequests work on our developer's portal."}},"httpPath":"/api/export/{type}/{format}"}]},{"type":"group","label":"Files","link":"/shoptet-api/openapi/files","routeSlug":"/shoptet-api/openapi/files","items":[{"label":"List of uploaded files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/files/getlistofuploadedfiles","routeSlug":"/shoptet-api/openapi/files/getlistofuploadedfiles","metadata":{"seo":{"title":"List of uploaded files","description":"Retrieves your uploaded files that can be copied in supported endpoints to entities within e-shop."}},"httpPath":"/api/system/files"},{"label":"Batch files upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/files/uploadfiles","routeSlug":"/shoptet-api/openapi/files/uploadfiles","metadata":{"seo":{"title":"Batch files upload","description":"This endpoint has been only renamed from \"File upload\" after we creatednew synchronous endpoint one file upload. Url and structure is unchanged"}},"httpPath":"/api/system/files"},{"label":"File upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/files/uploadfile","routeSlug":"/shoptet-api/openapi/files/uploadfile","metadata":{"seo":{"title":"File upload","description":"This is new endpoint - older asynchronous endpoint has been only renamedto \"Batch files upload\" in documentation, url and structure is unchanged"}},"httpPath":"/api/system/file"}]},{"type":"group","label":"Jobs","link":"/shoptet-api/openapi/jobs","routeSlug":"/shoptet-api/openapi/jobs","items":[{"label":"List of jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/jobs/getlistofjobs","routeSlug":"/shoptet-api/openapi/jobs/getlistofjobs","metadata":{"seo":{"title":"List of jobs","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."}},"httpPath":"/api/system/jobs"},{"label":"Job detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/jobs/getjobdetail","routeSlug":"/shoptet-api/openapi/jobs/getjobdetail","metadata":{"seo":{"title":"Job detail","description":"Returns information about job. If job is completed, it will contain additional information about job result."}},"httpPath":"/api/system/jobs/{jobId}"}]},{"type":"group","label":"Measure units","link":"/shoptet-api/openapi/measure-units","routeSlug":"/shoptet-api/openapi/measure-units","items":[{"label":"List of products measure units","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/measure-units/getlistofproductsmeasureunits","routeSlug":"/shoptet-api/openapi/measure-units/getlistofproductsmeasureunits","metadata":{"seo":{"title":"List of products measure units","description":"Returns the list of product measure units within the e-shop."}},"httpPath":"/api/products/measure-units"}]},{"type":"group","label":"Payment gateways","link":"/shoptet-api/openapi/payment-gateways","routeSlug":"/shoptet-api/openapi/payment-gateways","items":[{"label":"Gaining the information about payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/payment-gateways/getinformationaboutpayment","routeSlug":"/shoptet-api/openapi/payment-gateways/getinformationaboutpayment","metadata":{"seo":{"title":"Gaining the information about payment","description":"Returns the URL, at which the payment gateway shall redirect the users after completion of operation and order number."}},"httpPath":"/api/payment-status/{paymentCode}"},{"label":"Payment status update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/payment-gateways/updatepaymentstatus","routeSlug":"/shoptet-api/openapi/payment-gateways/updatepaymentstatus","metadata":{"seo":{"title":"Payment status update","description":"Payment status update via the payment gateway. The paymentCode is theidentifier. Payment status can be updated when the payment has beensuccessfully recorded."}},"httpPath":"/api/payment-status/{paymentCode}"}]},{"type":"group","label":"Shipping requests","link":"/shoptet-api/openapi/shipping-requests","routeSlug":"/shoptet-api/openapi/shipping-requests","items":[{"label":"Shipping request for getting cart details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/shipping-requests/getshippingrequestforcartdetails","routeSlug":"/shoptet-api/openapi/shipping-requests/getshippingrequestforcartdetails","metadata":{"seo":{"title":"Shipping request for getting cart details","description":"Endpoint returns details of cart for shipping request"}},"httpPath":"/api/shipping-request/{shippingRequestCode}/{shippingGuid}"},{"label":"Update shipping price & data","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/shipping-requests/updateshippingdata","routeSlug":"/shoptet-api/openapi/shipping-requests/updateshippingdata","metadata":{"seo":{"title":"Update shipping price & data","description":"Endpoint to set shipping price & data"}},"httpPath":"/api/shipping-request/{shippingRequestCode}/{shippingGuid}"},{"label":"Shipping request for getting status of order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/shipping-requests/getshippingrequestforgettingorderstatus","routeSlug":"/shoptet-api/openapi/shipping-requests/getshippingrequestforgettingorderstatus","metadata":{"seo":{"title":"Shipping request for getting status of order","description":"Endpoint returns status of order related to shippingRequestCode &shippingGuid"}},"httpPath":"/api/shipping-request/{shippingRequestCode}/{shippingGuid}/status"}]},{"type":"group","label":"Webhooks","link":"/shoptet-api/openapi/webhooks","routeSlug":"/shoptet-api/openapi/webhooks","items":[{"type":"link","label":"Payload delivery","link":"/shoptet-api/openapi/webhooks/payload-delivery","routeSlug":"/shoptet-api/openapi/webhooks/payload-delivery"},{"label":"Overview of registered webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/webhooks/getoverviewofregisteredwebhooks","routeSlug":"/shoptet-api/openapi/webhooks/getoverviewofregisteredwebhooks","metadata":{"seo":{"title":"Overview of registered webhooks","description":"Returns the list of webhooks, registered by the specific addon for a single e-shop. It is therefore bound to the specific installation."}},"httpPath":"/api/webhooks"},{"label":"Registration of new webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/webhooks/registernewwebhook","routeSlug":"/shoptet-api/openapi/webhooks/registernewwebhook","metadata":{"seo":{"title":"Registration of new webhook","description":"Registers the webhook. For a single event (event, for exampleorder:create) ONLY ONE URL can be registered."}},"httpPath":"/api/webhooks"},{"label":"Detail of registered webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/webhooks/getdetailofregisteredwebhooks","routeSlug":"/shoptet-api/openapi/webhooks/getdetailofregisteredwebhooks","metadata":{"seo":{"title":"Detail of registered webhooks","description":"Shows the information about a single specific registered webhook."}},"httpPath":"/api/webhooks/{id}"},{"label":"Update of existing webhook","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/webhooks/updateexistingwebhook","routeSlug":"/shoptet-api/openapi/webhooks/updateexistingwebhook","metadata":{"seo":{"title":"Update of existing webhook","description":"Modification of the existing webhook. The id of the webhook serves asthe identifier. Using just one call, only one webhook can be modified."}},"httpPath":"/api/webhooks/{id}"},{"label":"Deletion of registered webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/webhooks/deleteregisteredwebhook","routeSlug":"/shoptet-api/openapi/webhooks/deleteregisteredwebhook","metadata":{"seo":{"title":"Deletion of registered webhook","description":"Deletes the registered webhook, identified by means of id."}},"httpPath":"/api/webhooks/{id}"},{"label":"Generating of signature key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/webhooks/generatewebhooksignaturekey","routeSlug":"/shoptet-api/openapi/webhooks/generatewebhooksignaturekey","metadata":{"seo":{"title":"Generating of signature key","description":"The endpoint call does not require any body. The endpoint alwaysgenerates a new signature key"}},"httpPath":"/api/webhooks/renew-signature-key"},{"label":"Webhook notification","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/webhooks/getwebhooknotification","routeSlug":"/shoptet-api/openapi/webhooks/getwebhooknotification","metadata":{"seo":{"title":"Webhook 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."}},"httpPath":"/api/webhooks/notifications"}]},{"type":"separator","label":"JSON lines schemas"},{"type":"group","label":"Batch","link":"/shoptet-api/openapi/batch","routeSlug":"/shoptet-api/openapi/batch","items":[{"type":"link","label":"Brand create","link":"/shoptet-api/openapi/batch/brandbatchcreate","routeSlug":"/shoptet-api/openapi/batch/brandbatchcreate","httpVerb":"schema"},{"type":"link","label":"Category update","link":"/shoptet-api/openapi/batch/categorybatchupdate","routeSlug":"/shoptet-api/openapi/batch/categorybatchupdate","httpVerb":"schema"},{"type":"link","label":"Category product priority update","link":"/shoptet-api/openapi/batch/categoryproductprioritybatchupdate","routeSlug":"/shoptet-api/openapi/batch/categoryproductprioritybatchupdate","httpVerb":"schema"},{"type":"link","label":"Order create","link":"/shoptet-api/openapi/batch/orderbatchcreate","routeSlug":"/shoptet-api/openapi/batch/orderbatchcreate","httpVerb":"schema"},{"type":"link","label":"Pricelist update","link":"/shoptet-api/openapi/batch/pricelistbatchupdate","routeSlug":"/shoptet-api/openapi/batch/pricelistbatchupdate","httpVerb":"schema"},{"type":"link","label":"Product batch delete","link":"/shoptet-api/openapi/batch/productbatchdeleteschema","routeSlug":"/shoptet-api/openapi/batch/productbatchdeleteschema","httpVerb":"schema"},{"type":"link","label":"Product update","link":"/shoptet-api/openapi/batch/productbatchupdate","routeSlug":"/shoptet-api/openapi/batch/productbatchupdate","httpVerb":"schema"}]},{"type":"group","label":"Snapshot","link":"/shoptet-api/openapi/snapshot","routeSlug":"/shoptet-api/openapi/snapshot","items":[{"type":"link","label":"Abandoned cart","link":"/shoptet-api/openapi/snapshot/abandonedcartsnapshot","routeSlug":"/shoptet-api/openapi/snapshot/abandonedcartsnapshot","httpVerb":"schema"},{"type":"link","label":"Article","link":"/shoptet-api/openapi/snapshot/articlesnapshot","routeSlug":"/shoptet-api/openapi/snapshot/articlesnapshot","httpVerb":"schema"},{"type":"link","label":"Credit note","link":"/shoptet-api/openapi/snapshot/creditnotesnapshot","routeSlug":"/shoptet-api/openapi/snapshot/creditnotesnapshot","httpVerb":"schema"},{"type":"link","label":"Customer","link":"/shoptet-api/openapi/snapshot/customersnapshot","routeSlug":"/shoptet-api/openapi/snapshot/customersnapshot","httpVerb":"schema"},{"type":"link","label":"Delivery note","link":"/shoptet-api/openapi/snapshot/deliverynotesnapshot","routeSlug":"/shoptet-api/openapi/snapshot/deliverynotesnapshot","httpVerb":"schema"},{"type":"link","label":"Discount coupon","link":"/shoptet-api/openapi/snapshot/discountcouponsnapshot","routeSlug":"/shoptet-api/openapi/snapshot/discountcouponsnapshot","httpVerb":"schema"},{"type":"link","label":"Invoice","link":"/shoptet-api/openapi/snapshot/invoicesnapshot","routeSlug":"/shoptet-api/openapi/snapshot/invoicesnapshot","httpVerb":"schema"},{"type":"link","label":"Order history","link":"/shoptet-api/openapi/snapshot/orderhistorysnapshot","routeSlug":"/shoptet-api/openapi/snapshot/orderhistorysnapshot","httpVerb":"schema"},{"type":"link","label":"Order","link":"/shoptet-api/openapi/snapshot/ordersnapshot","routeSlug":"/shoptet-api/openapi/snapshot/ordersnapshot","httpVerb":"schema"},{"type":"link","label":"Price list","link":"/shoptet-api/openapi/snapshot/pricelistsnapshot","routeSlug":"/shoptet-api/openapi/snapshot/pricelistsnapshot","httpVerb":"schema"},{"type":"link","label":"Product price list","link":"/shoptet-api/openapi/snapshot/productpricelistsnapshot","routeSlug":"/shoptet-api/openapi/snapshot/productpricelistsnapshot","httpVerb":"schema"},{"type":"link","label":"Product","link":"/shoptet-api/openapi/snapshot/productsnapshot","routeSlug":"/shoptet-api/openapi/snapshot/productsnapshot","httpVerb":"schema"},{"type":"link","label":"Proforma invoice","link":"/shoptet-api/openapi/snapshot/proformainvoicesnapshot","routeSlug":"/shoptet-api/openapi/snapshot/proformainvoicesnapshot","httpVerb":"schema"},{"type":"link","label":"Proof payment","link":"/shoptet-api/openapi/snapshot/proofpaymentsnapshot","routeSlug":"/shoptet-api/openapi/snapshot/proofpaymentsnapshot","httpVerb":"schema"},{"type":"link","label":"Quantity discount","link":"/shoptet-api/openapi/snapshot/quantitydiscountsnapshot","routeSlug":"/shoptet-api/openapi/snapshot/quantitydiscountsnapshot","httpVerb":"schema"}]}]},{"type":"group","label":"Shoptet Pay API","items":[{"type":"link","label":"Shoptet Pay API","link":"/shoptet-pay-api/openapi-public","routeSlug":"/shoptet-pay-api/openapi-public"},{"type":"link","label":"How to get your API key:","link":"/shoptet-pay-api/openapi-public/section/how-to-get-your-api-key:","routeSlug":"/shoptet-pay-api/openapi-public/section/how-to-get-your-api-key:"},{"type":"link","label":"Using the key in your application:","link":"/shoptet-pay-api/openapi-public/section/using-the-key-in-your-application:","routeSlug":"/shoptet-pay-api/openapi-public/section/using-the-key-in-your-application:"},{"type":"link","label":"Testing endpoints:","link":"/shoptet-pay-api/openapi-public/section/testing-endpoints:","routeSlug":"/shoptet-pay-api/openapi-public/section/testing-endpoints:"},{"type":"group","label":"card payments","link":"/shoptet-pay-api/openapi-public/card-payments","routeSlug":"/shoptet-pay-api/openapi-public/card-payments","items":[{"label":"CardPaymentsController_get","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-pay-api/openapi-public/card-payments/cardpaymentscontroller_get","routeSlug":"/shoptet-pay-api/openapi-public/card-payments/cardpaymentscontroller_get","metadata":{"seo":{"title":"CardPaymentsController_get"}},"httpPath":"/v1/card-payments/{id}"},{"label":"CardPaymentsController_all","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-pay-api/openapi-public/card-payments/cardpaymentscontroller_all","routeSlug":"/shoptet-pay-api/openapi-public/card-payments/cardpaymentscontroller_all","metadata":{"seo":{"title":"CardPaymentsController_all"}},"httpPath":"/v1/card-payments"},{"label":"CardPaymentsController_post","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-pay-api/openapi-public/card-payments/cardpaymentscontroller_post","routeSlug":"/shoptet-pay-api/openapi-public/card-payments/cardpaymentscontroller_post","metadata":{"seo":{"title":"CardPaymentsController_post"}},"httpPath":"/v1/card-payments"},{"label":"CardPaymentsController_revoke","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-pay-api/openapi-public/card-payments/cardpaymentscontroller_revoke","routeSlug":"/shoptet-pay-api/openapi-public/card-payments/cardpaymentscontroller_revoke","metadata":{"seo":{"title":"CardPaymentsController_revoke"}},"httpPath":"/v1/card-payments/{id}/revoke"},{"label":"CardPaymentsController_capture","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-pay-api/openapi-public/card-payments/cardpaymentscontroller_capture","routeSlug":"/shoptet-pay-api/openapi-public/card-payments/cardpaymentscontroller_capture","metadata":{"seo":{"title":"CardPaymentsController_capture"}},"httpPath":"/v1/card-payments/{id}/capture"},{"label":"CardPaymentsController_cancel","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-pay-api/openapi-public/card-payments/cardpaymentscontroller_cancel","routeSlug":"/shoptet-pay-api/openapi-public/card-payments/cardpaymentscontroller_cancel","metadata":{"seo":{"title":"CardPaymentsController_cancel"}},"httpPath":"/v1/card-payments/{id}/cancel"},{"label":"CardPaymentsController_refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-pay-api/openapi-public/card-payments/cardpaymentscontroller_refund","routeSlug":"/shoptet-pay-api/openapi-public/card-payments/cardpaymentscontroller_refund","metadata":{"seo":{"title":"CardPaymentsController_refund"}},"httpPath":"/v1/card-payments/{id}/refund"},{"label":"CardPaymentsController_events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-pay-api/openapi-public/card-payments/cardpaymentscontroller_events","routeSlug":"/shoptet-pay-api/openapi-public/card-payments/cardpaymentscontroller_events","metadata":{"seo":{"title":"CardPaymentsController_events"}},"httpPath":"/v1/card-payments/{id}/events"}]},{"type":"group","label":"payments","link":"/shoptet-pay-api/openapi-public/payments","routeSlug":"/shoptet-pay-api/openapi-public/payments","items":[{"label":"PaymentsController_findAll","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-pay-api/openapi-public/payments/paymentscontroller_findall","routeSlug":"/shoptet-pay-api/openapi-public/payments/paymentscontroller_findall","metadata":{"seo":{"title":"PaymentsController_findAll"}},"httpPath":"/v1/payments"},{"label":"PaymentsController_post","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-pay-api/openapi-public/payments/paymentscontroller_post","routeSlug":"/shoptet-pay-api/openapi-public/payments/paymentscontroller_post","metadata":{"seo":{"title":"PaymentsController_post"}},"httpPath":"/v1/payments"},{"label":"PaymentsController_findOne","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-pay-api/openapi-public/payments/paymentscontroller_findone","routeSlug":"/shoptet-pay-api/openapi-public/payments/paymentscontroller_findone","metadata":{"seo":{"title":"PaymentsController_findOne"}},"httpPath":"/v1/payments/{id}"},{"label":"PaymentsController_revoke","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-pay-api/openapi-public/payments/paymentscontroller_revoke","routeSlug":"/shoptet-pay-api/openapi-public/payments/paymentscontroller_revoke","metadata":{"seo":{"title":"PaymentsController_revoke"}},"httpPath":"/v1/payments/{id}/revoke"},{"label":"PaymentsController_capture","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-pay-api/openapi-public/payments/paymentscontroller_capture","routeSlug":"/shoptet-pay-api/openapi-public/payments/paymentscontroller_capture","metadata":{"seo":{"title":"PaymentsController_capture"}},"httpPath":"/v1/payments/{id}/capture"},{"label":"PaymentsController_cancel","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-pay-api/openapi-public/payments/paymentscontroller_cancel","routeSlug":"/shoptet-pay-api/openapi-public/payments/paymentscontroller_cancel","metadata":{"seo":{"title":"PaymentsController_cancel"}},"httpPath":"/v1/payments/{id}/cancel"},{"label":"PaymentsController_refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-pay-api/openapi-public/payments/paymentscontroller_refund","routeSlug":"/shoptet-pay-api/openapi-public/payments/paymentscontroller_refund","metadata":{"seo":{"title":"PaymentsController_refund"}},"httpPath":"/v1/payments/{id}/refund"}]},{"type":"group","label":"reports","link":"/shoptet-pay-api/openapi-public/reports","routeSlug":"/shoptet-pay-api/openapi-public/reports","items":[{"label":"PayoutReportsController_find","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-pay-api/openapi-public/reports/payoutreportscontroller_find","routeSlug":"/shoptet-pay-api/openapi-public/reports/payoutreportscontroller_find","metadata":{"seo":{"title":"PayoutReportsController_find"}},"httpPath":"/v1/reports/payout"},{"label":"PayoutReportsController_getByIdAndFormat","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-pay-api/openapi-public/reports/payoutreportscontroller_getbyidandformat","routeSlug":"/shoptet-pay-api/openapi-public/reports/payoutreportscontroller_getbyidandformat","metadata":{"seo":{"title":"PayoutReportsController_getByIdAndFormat"}},"httpPath":"/v1/reports/payout/{id}/{format}"}]},{"type":"group","label":"webhooks","link":"/shoptet-pay-api/openapi-public/webhooks","routeSlug":"/shoptet-pay-api/openapi-public/webhooks","items":[{"label":"WebhooksController_post","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-pay-api/openapi-public/webhooks/webhookscontroller_post","routeSlug":"/shoptet-pay-api/openapi-public/webhooks/webhookscontroller_post","metadata":{"seo":{"title":"WebhooksController_post"}},"httpPath":"/v1/webhooks"},{"label":"WebhooksController_all","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-pay-api/openapi-public/webhooks/webhookscontroller_all","routeSlug":"/shoptet-pay-api/openapi-public/webhooks/webhookscontroller_all","metadata":{"seo":{"title":"WebhooksController_all"}},"httpPath":"/v1/webhooks"},{"label":"WebhooksController_get","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-pay-api/openapi-public/webhooks/webhookscontroller_get","routeSlug":"/shoptet-pay-api/openapi-public/webhooks/webhookscontroller_get","metadata":{"seo":{"title":"WebhooksController_get"}},"httpPath":"/v1/webhooks/{id}"},{"label":"WebhooksController_delete","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-pay-api/openapi-public/webhooks/webhookscontroller_delete","routeSlug":"/shoptet-pay-api/openapi-public/webhooks/webhookscontroller_delete","metadata":{"seo":{"title":"WebhooksController_delete"}},"httpPath":"/v1/webhooks/{id}"}]}]}]}