### App Development: Get Applications Source: https://api-docs.kibocommerce.com/reference/accountrankingrule Retrieves a list of installed applications, potentially with filtering or sorting options. ```REST GET /api/app/installs ``` -------------------------------- ### Install Application Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Installs an application. This operation is part of the Applications module and can be used to install applications to production tenants. ```REST POST /api/v2/applications/install ``` ```REST POST /api/v2/applications/installtoproductiontenant ``` -------------------------------- ### App Development Installation API Endpoints Source: https://api-docs.kibocommerce.com/reference/applicationinstalled This section outlines the API endpoints for managing application installations and entitlements in Kibo Commerce. It covers installing applications, retrieving application lists, installing apps to production tenants, and fetching entitlements. ```REST POST /applications/install GET /applications POST /applications/install/production GET /applications/{applicationId} GET /applications/{applicationId}/entitlements GET /applications/{applicationId}/tenants/{tenantId}/entitlements ``` -------------------------------- ### Install Application Source: https://api-docs.kibocommerce.com/reference/applicationupgraded Installs an application. This operation is part of the Applications module and can be used to install applications to production tenants. ```REST POST /api/v2/applications/install ``` ```REST POST /api/v2/applications/installtoproductiontenant ``` -------------------------------- ### App Development: Get Applications Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Retrieves a list of installed applications, potentially with filtering or sorting options. ```REST GET /api/app/installs ``` -------------------------------- ### App Development Installation API Endpoints Source: https://api-docs.kibocommerce.com/reference/attributecreated This section outlines the API endpoints for managing application installations and entitlements in Kibo Commerce. It covers installing applications, retrieving application lists, installing apps to production tenants, and fetching entitlements. ```REST POST /applications/install GET /applications POST /applications/install/production GET /applications/{applicationId} GET /applications/{applicationId}/entitlements GET /applications/{applicationId}/tenants/{tenantId}/entitlements ``` -------------------------------- ### Install Application Source: https://api-docs.kibocommerce.com/reference/attributecreated Installs a new application. This is a POST request. ```REST POST /api/v2/applications ``` -------------------------------- ### App Development: Get Applications Source: https://api-docs.kibocommerce.com/reference/applicationupgraded Retrieves a list of installed applications, potentially with filtering or sorting options. ```REST GET /api/app/installs ``` -------------------------------- ### App Development: Get Application Source: https://api-docs.kibocommerce.com/reference/accountrankingrule Retrieves details of a specific installed application by its ID. ```REST GET /api/app/installs/{applicationId} ``` -------------------------------- ### Get or Create Cart Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Retrieves an existing cart or creates a new one if none exists for the current user or session. This is a common starting point for shopping. ```REST GET /api/commerce/carts/current POST /api/commerce/carts/current ``` -------------------------------- ### App Development: Get Application Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Retrieves details of a specific installed application by its ID. ```REST GET /api/app/installs/{applicationId} ``` -------------------------------- ### Install App to Production Tenant Source: https://api-docs.kibocommerce.com/reference/attributecreated Installs an application to a production tenant. This is a POST request. ```REST POST /api/v2/tenants/{tenantId}/applications/{applicationId}/install ``` -------------------------------- ### Get or Create Cart Source: https://api-docs.kibocommerce.com/reference/applicationupgraded Retrieves an existing cart or creates a new one if none exists for the current user or session. This is a common starting point for shopping. ```REST GET /api/commerce/carts/current POST /api/commerce/carts/current ``` -------------------------------- ### Get Product Suggest Settings Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Retrieves the product suggest settings. This is a GET request. ```REST GET /search/productsuggestsettings ``` -------------------------------- ### Get or Create Cart Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Retrieves an existing cart or creates a new one if none exists for the current user or session. This is a common starting point for shopping. ```REST GET /api/commerce/carts/current POST /api/commerce/carts/current ``` -------------------------------- ### Get Applications Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves a list of all applications. This is a GET request. ```REST GET /api/v2/applications ``` -------------------------------- ### Get Product Rules Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Retrieves a list of all product rules. This is a GET request. ```REST GET /productrule ``` -------------------------------- ### Install Application to Production Tenant Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Installs an application to a production tenant. This action deploys the application to a live production environment. ```shell POST /api/v2/applications/{applicationId}/production ``` -------------------------------- ### App Development: Install App To Production Tenant Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Installs an application to a production tenant. Requires application details and tenant context. ```REST POST /api/app/installs/production ``` -------------------------------- ### App Development: Get Application Source: https://api-docs.kibocommerce.com/reference/applicationupgraded Retrieves details of a specific installed application by its ID. ```REST GET /api/app/installs/{applicationId} ``` -------------------------------- ### Get Synonym Definitions Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Retrieves a list of all synonym definitions. This is a GET request. ```REST GET /search/synonym ``` -------------------------------- ### App Development: Install App To Production Tenant Source: https://api-docs.kibocommerce.com/reference/accountrankingrule Installs an application to a production tenant. Requires application details and tenant context. ```REST POST /api/app/installs/production ``` -------------------------------- ### App Development: Install Application Source: https://api-docs.kibocommerce.com/reference/accountrankingrule Installs an application. This operation typically involves providing application package details. ```REST POST /api/app/installs ``` -------------------------------- ### Get Return Rules Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Retrieves a list of all return rules. This is a GET request. ```REST GET /returnrule ``` -------------------------------- ### App Development: Install Application Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Installs an application. This operation typically involves providing application package details. ```REST POST /api/app/installs ``` -------------------------------- ### Get Inventory Fetch Configuration Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves the current configuration for fetching inventory data. This provides details on the setup for inventory data retrieval. ```REST GET /websites/api-docs_kibocommerce_reference/inventory/fetch/config ``` -------------------------------- ### Get File - GET Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Retrieves a specific file by its identifier. -------------------------------- ### Get Product Type Options Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Retrieves all options for a product type. This is a GET request. ```REST GET /producttype/{productTypeCode}/option ``` -------------------------------- ### Get Product Types Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Retrieves a list of all product types. This is a GET request. ```REST GET /producttype ``` -------------------------------- ### App Development: Install App To Production Tenant Source: https://api-docs.kibocommerce.com/reference/applicationupgraded Installs an application to a production tenant. Requires application details and tenant context. ```REST POST /api/app/installs/production ``` -------------------------------- ### Install Application Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Installs an application to a tenant. This operation is typically used to deploy an application within a specific tenant environment. ```shell POST /api/v2/applications/install ``` -------------------------------- ### Get Inventory (GET) Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Retrieves inventory information using a GET request. This is typically used for simple inventory lookups. ```http GET /websites/api-docs_kibocommerce_reference/inventory ``` -------------------------------- ### Get Inventory (GET) Source: https://api-docs.kibocommerce.com/reference/applicationupgraded Retrieves inventory information using a GET request. This endpoint is used for querying inventory levels or details. ```http GET /api/v2/inventory ``` -------------------------------- ### App Development: Install Application Source: https://api-docs.kibocommerce.com/reference/applicationupgraded Installs an application. This operation typically involves providing application package details. ```REST POST /api/app/installs ``` -------------------------------- ### Get Resolved Price List API (GET) Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Retrieves a resolved price list using a GET request from the Kibo Commerce API. This endpoint is used to get pricing information. ```GraphQL { resolvedPriceList(priceListId: "someId") { -- fields to retrieve } } ``` -------------------------------- ### Get Resolved Price List - GraphQL (GET) Source: https://api-docs.kibocommerce.com/reference/applicationupgraded Retrieves a resolved price list based on specified criteria using a GET request in GraphQL. Used to get pricing information for products. ```GraphQL query GetResolvedPriceList($priceListId: Int!) { resolvedPriceList(priceListId: $priceListId) { id name currency { code } priceEntries { productId price } } } ``` -------------------------------- ### Manage App Installations and Entitlements Source: https://api-docs.kibocommerce.com/reference/accountrankingrule Endpoints for installing apps to production tenants, retrieving application details, and fetching entitlements by application or tenant. ```REST GET /websites/api/v2/applications/entitlements/application GET /websites/api/v2/applications/entitlements/tenant GET /websites/api/v2/applications POST /websites/api/v2/tenants/{tenantId}/apps/production POST /websites/api/v2/applications/install ``` -------------------------------- ### Get Inventory (GET) Source: https://api-docs.kibocommerce.com/reference/accountrankingrule Retrieves inventory data using a GET request. This endpoint is part of the Inventory API. ```REST GET /api/commerce/inventory ``` -------------------------------- ### POST Application Installed Event Source: https://api-docs.kibocommerce.com/reference/applicationinstalled This snippet demonstrates how to send an 'Application Installed' event to the Kibo Commerce API using cURL. It includes the necessary endpoint, headers, and body parameters to register the event. ```curl curl --request POST \ --url https://example.com/ApplicationEvents/ApplicationInstalled \ --header 'content-type: application/json' \ --header 'x-vol-catalog: 1' \ --header 'x-vol-correlation: ' \ --header 'x-vol-currency: USD' \ --header 'x-vol-locale: en-US' \ --header 'x-vol-master-catalog: 1' \ --header 'x-vol-site: ' \ --header 'x-vol-tenant: ' ``` -------------------------------- ### Get Location Details Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Retrieves details for a specific location. Use this to get information about a particular location. ```http GET /websites/api-docs_kibocommerce_reference/location/admin/location/{id} ``` -------------------------------- ### Get Location Group Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Retrieves details for a specific location group. Use this to get information about a particular group. ```http GET /websites/api-docs_kibocommerce_reference/location/group ``` -------------------------------- ### Preview Product Rule - GraphQL Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Allows previewing a product rule by sending a POST request to the Kibo Commerce API. This is useful for testing rule configurations. ```GraphQL mutation PreviewProductRule($ruleData: ProductRuleInput!) { previewProductRule(rule: $ruleData) { isValid messages } } ``` -------------------------------- ### Get WS-Fed Challenge URL - GET Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Retrieves the URL for initiating a WS-Federation challenge. -------------------------------- ### Get Inventory Tag Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Retrieves details for a specific inventory tag. Use this to get information about a particular tag. ```http GET /websites/api-docs_kibocommerce_reference/inventory/tag ``` -------------------------------- ### Create User - POST Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Creates a new admin user. ```json { "firstName": "string", "lastName": "string", "email": "string", "password": "string" } ``` -------------------------------- ### Get WS-Fed Challenge URL - GET Source: https://api-docs.kibocommerce.com/reference/accountrankingrule Retrieves the URL for initiating a WS-Federation challenge. -------------------------------- ### Untitled Source: https://api-docs.kibocommerce.com/reference/applicationinstalled No description -------------------------------- ### Create Product Rule Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Creates a new product rule. This is a POST request. ```REST POST /productrule ``` -------------------------------- ### Get Location Attribute Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Retrieves details for a specific location attribute definition. Use this to get information about a particular attribute. ```http GET /websites/api-docs_kibocommerce_reference/location/attributedeinitions/attribute ``` -------------------------------- ### Preview Product Rule API Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Allows previewing a product rule configuration using a POST request to the Kibo Commerce API. This helps in testing rule logic before applying it. ```GraphQL mutation { previewProductRule(input: { ... }) { -- fields to retrieve } } ``` -------------------------------- ### Create Import Job - POST Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Initiates a new import job. Requires specifying the file and import type. ```json { "file": "string", "importType": "string" } ``` -------------------------------- ### Get Fetch Configuration Source: https://api-docs.kibocommerce.com/reference/applicationupgraded Retrieves the current fetch configuration. This endpoint is used to get details about data fetching settings. ```http GET /api/v2/inventory/fetch/config ``` -------------------------------- ### Create Discount Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Creates a new discount. ```REST POST /api/catalog/v1/discounts ``` -------------------------------- ### Get Inventory Tag Category Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Retrieves details for a specific inventory tag category. Use this to get information about a particular category. ```http GET /websites/api-docs_kibocommerce_reference/inventory/tag/category ``` -------------------------------- ### Get Specific Inventory Job Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Retrieves details for a specific inventory job. Use this to get information about a particular inventory task. ```http GET /websites/api-docs_kibocommerce_reference/inventory/job/{id} ``` -------------------------------- ### Get Product for Indexing - GraphQL Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Fetches product data specifically for indexing purposes from the Kibo Commerce API via a GET request. ```GraphQL query GetProductForIndexing($productId: Int!) { product(id: $productId) { id name sku attributes { attributeFQN value } } } ``` -------------------------------- ### Site Search Preview - GraphQL Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Allows previewing site search results by sending a POST request to the Kibo Commerce API. ```GraphQL mutation SiteSearchPreview($query: String!, $previewData: SearchPreviewInput!) { siteSearchPreview(query: $query, preview: $previewData) { results } } ``` -------------------------------- ### Get Inventory (GET) Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves inventory information using a GET request. This provides a way to query current inventory levels and details. ```REST GET /websites/api-docs_kibocommerce_reference/inventory ``` -------------------------------- ### App Development: Create New Core Package Source: https://api-docs.kibocommerce.com/reference/accountrankingrule Creates a new core application package. Requires package details in the request body. ```REST POST /api/app/packages/core ``` -------------------------------- ### Inventory: Get Inventory (GET) Source: https://api-docs.kibocommerce.com/reference/accountrankingrule Retrieves inventory levels for specified items using a GET request. Typically used for single item lookups. ```REST GET /api/v1/inventory/{itemId} ``` -------------------------------- ### Get Product Rule Usages Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Retrieves the usage details for product rules. This is a GET request. ```REST GET /productrule/usages ``` -------------------------------- ### Get Cutoff Time Override by ID Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Retrieves a specific cutoff time override by its ID. Use this to get details of a particular override. ```http GET /websites/api-docs_kibocommerce_reference/location/admin/cutofftime/override/{id} ``` -------------------------------- ### Manage Site Suggest Files Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Allows downloading and uploading suggest files for a Kibo Commerce site. These files are typically used for search indexing and optimization. ```REST GET /api/platform/sites/{siteId}/suggestfile PUT /api/platform/sites/{siteId}/suggestfile ``` -------------------------------- ### Inventory: Get Inventory (GET) Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves inventory levels for specified items using a GET request. Typically used for single item lookups. ```REST GET /api/v1/inventory/{itemId} ``` -------------------------------- ### Inventory Export: Create Settings (FTP) Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Creates new export settings for inventory data using FTP. Requires FTP server details and credentials. ```REST POST /api/v1/inventory/export/settings/ftp ``` -------------------------------- ### Inventory: Get Inventory (GET) Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Retrieves inventory levels for specified items using a GET request. Typically used for single item lookups. ```REST GET /api/v1/inventory/{itemId} ``` -------------------------------- ### Return Settings Management Source: https://api-docs.kibocommerce.com/reference/accountrankingrule Retrieve, create, and update return settings for the site. ```HTTP GET /api/v2/sitesettings/return POST /api/v2/sitesettings/return PUT /api/v2/sitesettings/return ``` -------------------------------- ### Get Batch Job Summaries - GET Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Retrieves summaries for multiple batch jobs. -------------------------------- ### Run Inventory Export Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Endpoint to initiate an inventory export process. ```bash POST /api/inventory/export/run ``` -------------------------------- ### Inventory: Get Inventory (GET) Source: https://api-docs.kibocommerce.com/reference/applicationupgraded Retrieves inventory levels for specified items using a GET request. Typically used for single item lookups. ```REST GET /api/v1/inventory/{itemId} ``` -------------------------------- ### Inventory Export: Create Settings (FTP) Source: https://api-docs.kibocommerce.com/reference/accountrankingrule Creates new export settings for transferring inventory data via FTP. Requires FTP server details and credentials. ```REST POST /api/v1/inventory/export/settings/ftp ``` -------------------------------- ### Get Resolved Price List (GET) - HTTP Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves a resolved price list using a GET request. This endpoint is part of the Catalog Storefront API. ```HTTP GET /api/commerce/storefront/pricelists/{priceListId}/resolved ``` -------------------------------- ### Get Site Search Settings Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Retrieves the site search settings. This is a GET request. ```REST GET /search/settings/sitesearch ``` -------------------------------- ### Inventory: Get Inventory (GET) Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Retrieves inventory information using a GET request. Typically used for fetching specific inventory items or a list of items. ```REST GET /api/v1/inventory ``` -------------------------------- ### Add Account And Login (POST) Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Adds an account and its associated login details. This endpoint creates a new account and user login simultaneously. ```HTTP POST /api/commerce/customer-account/account-login ``` -------------------------------- ### Get Product Type Properties Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Retrieves all properties for a product type. This is a GET request. ```REST GET /producttype/{productTypeCode}/property ``` -------------------------------- ### Get Resolved Price List (GraphQL - GET) Source: https://api-docs.kibocommerce.com/reference/accountrankingrule Retrieves the resolved price list for a given product or context using a GET request. This endpoint provides the final applicable prices. ```GraphQL query GetResolvedPriceList($productId: Int!) { resolvedPriceList(productId: $productId) { price currency priceListId } } ``` -------------------------------- ### Get Resolved Price List (GET) - GraphQL Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Retrieves a resolved price list using a GET request to the Kibo Commerce API. This is useful for fetching price list details. ```GraphQL query GetResolvedPriceList($priceListId: Int!) { priceList(id: $priceListId) { id name currency { code } priceEntries { price product { name } } } } ``` -------------------------------- ### Return Settings Management Source: https://api-docs.kibocommerce.com/reference/applicationupgraded Retrieve, create, and update return settings for the site. ```HTTP GET /api/v2/sitesettings/return POST /api/v2/sitesettings/return PUT /api/v2/sitesettings/return ``` -------------------------------- ### Get File Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves a file. This is a GET request. ```REST GET /api/v2/files/{fileId} ``` -------------------------------- ### Inventory Export: Create Settings (FTP) Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Creates new export settings for transferring inventory data via FTP. Requires FTP server details and credentials. ```REST POST /api/v1/inventory/export/settings/ftp ``` -------------------------------- ### Get File - GET Source: https://api-docs.kibocommerce.com/reference/accountrankingrule Retrieves a specific file by its identifier. -------------------------------- ### Add Facet Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Creates a new facet. ```REST POST /api/catalog/v1/facets ``` -------------------------------- ### Get Packages Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves a list of packages. This is a GET request. ```REST GET /api/v2/packages ``` -------------------------------- ### Inventory: Create Bin Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Creates a new inventory bin. Requires bin details as input. ```REST POST /api/v1/inventory/bin ``` -------------------------------- ### Manage Product Options (KiboCommerce API) Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Provides endpoints for managing product options, such as size, color, or material. This includes creating, updating, deleting, and retrieving product options. ```REST DELETE /productoption PUT /productoption GET /productoption POST /productoption GET /productoptions ``` -------------------------------- ### Get File - GET Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves a specific file by its identifier. -------------------------------- ### Get Application Build Information Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Retrieves build logs, jobs, or runtime logs for an application. These operations are part of the Applications module. ```REST GET /api/v2/applications/{applicationId}/build/logs ``` ```REST GET /api/v2/applications/{applicationId}/build/jobs ``` ```REST GET /api/v2/applications/{applicationId}/runtime/logs ``` -------------------------------- ### Get WS-Fed Challenge URL - GET Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Retrieves the URL for initiating a WS-Federation challenge. -------------------------------- ### Site Search Preview - GraphQL Source: https://api-docs.kibocommerce.com/reference/applicationupgraded Allows previewing site search results for a given query without executing a live search. Useful for testing search configurations. ```GraphQL mutation SiteSearchPreview($query: String!) { siteSearchPreview(query: $query) { results { title url description } } } ``` -------------------------------- ### Get Tenant Scope - GET Source: https://api-docs.kibocommerce.com/reference/accountrankingrule Retrieves the scope of the current tenant. -------------------------------- ### Create Package - REST Source: https://api-docs.kibocommerce.com/reference/accountrankingrule Creates a new package. The details of the package to be created should be included in the request body. ```REST POST /packages ``` -------------------------------- ### Manage Suggestion Settings and Files Source: https://api-docs.kibocommerce.com/reference/applicationupgraded Manages suggestion settings and files for Kibo Commerce sites. Includes downloading suggest files, uploading suggest files, and retrieving/updating suggester settings. ```REST GET /websites/{websiteId}/suggest PUT /websites/{websiteId}/suggest GET /websites/{websiteId}/suggest/settings PUT /websites/{websiteId}/suggest/settings ``` -------------------------------- ### Get File - GET Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Retrieves a specific file by its identifier. -------------------------------- ### Get Carriers Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves a list of shipping carriers. This is a GET request. ```REST GET /api/commerce/shipping/carriers ``` -------------------------------- ### Create User - POST Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Creates a new admin user. ```json { "firstName": "string", "lastName": "string", "email": "string", "password": "string" } ``` -------------------------------- ### Get Application Build Log Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves the build log for a specific application. This is a GET request. ```REST GET /api/v2/applications/{applicationId}/builds/{buildId}/log ``` -------------------------------- ### Search Preview - GraphQL Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Provides a preview of search results using a POST request to the Kibo Commerce API. ```GraphQL mutation SearchPreview($query: String!, $previewData: SearchPreviewInput!) { searchPreview(query: $query, preview: $previewData) { results } } ``` -------------------------------- ### Get Package Metadata Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves the metadata for a package. This is a GET request. ```REST GET /api/v2/packages/{packageId}/metadata ``` -------------------------------- ### Get App Versions Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves the versions of an application. This is a GET request. ```REST GET /api/v2/applications/{applicationId}/versions ``` -------------------------------- ### Package Management Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Manages application packages, including creating, updating, cloning, and retrieving package details and files. These operations are part of the Applications module. ```REST POST /api/v2/packages ``` ```REST PUT /api/v2/packages/{packageId} ``` ```REST POST /api/v2/packages/clone ``` ```REST GET /api/v2/packages ``` ```REST GET /api/v2/packages/{packageId} ``` ```REST GET /api/v2/packages/{packageId}/files ``` ```REST GET /api/v2/packages/{packageId}/metadata ``` ```REST GET /api/v2/packages/{packageId}/filemetadata ``` ```REST POST /api/v2/packages/{packageId}/files/rename ``` ```REST DELETE /api/v2/packages/{packageId}/files/{fileId} ``` ```REST POST /api/v2/packages/{packageId}/files/upsert ``` ```REST POST /api/v2/packages/{packageId}/behaviors ``` ```REST GET /api/v2/packages/{packageId}/behaviors ``` -------------------------------- ### Get Package Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves details of a specific package. This is a GET request. ```REST GET /api/v2/packages/{packageId} ``` -------------------------------- ### Inventory Fetch File Config: Test Connection Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Tests the connection settings for an inventory fetch configuration. Verifies that the system can connect to the data source. ```REST GET /api/v1/inventory/fetchfileconfig/testconnection ``` -------------------------------- ### Get Package Behaviors Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves the behaviors of a package. This is a GET request. ```REST GET /api/v2/packages/{packageId}/behaviors ``` -------------------------------- ### Create Export Settings FTP Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Creates new export settings for FTP. This operation establishes new FTP export configurations. ```http POST /websites/api-docs_kibocommerce_reference/export/settings/ftp ``` -------------------------------- ### Get Application Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves details of a specific application. This is a GET request. ```REST GET /api/v2/applications/{applicationId} ``` -------------------------------- ### Get System Default Search Settings Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Retrieves the system default search settings. This is a GET request. ```REST GET /search/settings/systemdefault ``` -------------------------------- ### Get Tenant Scope - GET Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves the scope of the current tenant. -------------------------------- ### Create Application Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Creates a new application. This involves registering a new application with its associated details. ```shell POST /api/v2/applications ``` -------------------------------- ### Get Roles - GET Source: https://api-docs.kibocommerce.com/reference/accountrankingrule Retrieves a list of available roles within the system. -------------------------------- ### Perform Batch Action - POST Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Performs an action on a batch job, such as starting or cancelling. ```json { "action": "string" } ``` -------------------------------- ### Inventory Export: Run Export Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Initiates an inventory export process based on the configured settings. This triggers the data transfer. ```REST POST /api/v1/inventory/export/run ``` -------------------------------- ### Get Tenant Scope - GET Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Retrieves the scope of the current tenant. -------------------------------- ### Get Tenant Scope - GET Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Retrieves the scope of the current tenant. -------------------------------- ### Upload Files - POST Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Uploads files to the KiboCommerce system for processing. -------------------------------- ### Get Batch Jobs Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves a list of batch jobs. This is a GET request. ```REST GET /api/commerce/importexport/batchjobs ``` -------------------------------- ### Get Products - GraphQL Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Fetches a list of products from the Kibo Commerce API using a GET request. Supports filtering and pagination. ```GraphQL query GetProducts($pageSize: Int, $startIndex: Int) { products(pageSize: $pageSize, startIndex: $startIndex) { items { id name sku } totalCount } } ``` -------------------------------- ### Get Target Rules Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves a list of target rules. This is a GET request. ```REST GET /api/commerce/admin/shipping/targetrules ``` -------------------------------- ### Get Product Substitutions - GraphQL Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Retrieves product substitution information from the Kibo Commerce API using a GET request. ```GraphQL query GetProductSubstitutions($productId: Int!) { productSubstitutions(productId: $productId) { items { productId substitutionId type } } } ``` -------------------------------- ### Get Target Rule Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves a specific target rule. This is a GET request. ```REST GET /api/commerce/admin/shipping/targetrules/{ruleId} ``` -------------------------------- ### App Development: Create Package Source: https://api-docs.kibocommerce.com/reference/accountrankingrule Creates a new application package. Requires package details in the request body. ```REST POST /api/app/packages ``` -------------------------------- ### Get Shipping Profiles Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves a list of shipping profiles. This is a GET request. ```REST GET /api/commerce/admin/shipping/profiles ``` -------------------------------- ### Create Import Job - POST Source: https://api-docs.kibocommerce.com/reference/accountrankingrule Initiates a new import job. Requires specifying the file and import type. ```json { "file": "string", "importType": "string" } ``` -------------------------------- ### Get Carrier Definition Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves a specific carrier definition. This is a GET request. ```REST GET /api/commerce/admin/shipping/carrierdefinitions/{carrierDefinitionId} ``` -------------------------------- ### Inventory: Create Bin Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Creates a new inventory bin. Requires bin details such as name, location, and type. ```REST POST /api/v1/inventory/bin ``` -------------------------------- ### Get Carrier Definitions Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves a list of carrier definitions. This is a GET request. ```REST GET /api/commerce/admin/shipping/carrierdefinitions ``` -------------------------------- ### Get Carrier Credentials Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves a list of carrier credentials. This is a GET request. ```REST GET /api/commerce/admin/shipping/credentials ``` -------------------------------- ### Create Package Source: https://api-docs.kibocommerce.com/reference/attributecreated Creates a new package. This is a POST request. ```REST POST /api/v2/packages ``` -------------------------------- ### Get Signature Options Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves all available signature options. This is a GET request. ```REST GET /api/commerce/admin/shipping/signatureoptions ``` -------------------------------- ### Create Export Job - POST Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Initiates a new export job. Requires specifying the entity and properties to export. ```json { "entity": "string", "properties": [ "string" ], "filter": "string" } ``` -------------------------------- ### Get Carrier Configurations Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves a list of all carrier configurations. This is a GET request. ```REST GET /api/commerce/admin/shipping/carriers/configurations ``` -------------------------------- ### Add User (POST) Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Adds a new user. This endpoint creates a new user account. ```HTTP POST /api/commerce/b2baccounts/users ``` -------------------------------- ### Get Runtime Logs Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves runtime logs for an application. This is a GET request. ```REST GET /api/v2/applications/{applicationId}/runtime/logs ``` -------------------------------- ### Get Roles - GET Source: https://api-docs.kibocommerce.com/reference/attributecreated Retrieves a list of available roles within the system. -------------------------------- ### Create Import Job - POST Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Initiates a new import job. Requires specifying the file and import type. ```json { "file": "string", "importType": "string" } ``` -------------------------------- ### Get User Roles - GET Source: https://api-docs.kibocommerce.com/reference/accountrankingrule Retrieves the roles assigned to a specific admin user. -------------------------------- ### Get Users - GET Source: https://api-docs.kibocommerce.com/reference/accountrankingrule Retrieves a list of admin users. Supports filtering and pagination. ```json { "startIndex": 0, "pageSize": 0, "sortBy": "string", "filter": "string" } ``` -------------------------------- ### Create New Core Package Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Creates a new core package. Core packages are fundamental components of the system. ```shell POST /api/v2/packages/core ``` -------------------------------- ### Preview Product Rule - GraphQL Source: https://api-docs.kibocommerce.com/reference/applicationupgraded Allows previewing the outcome of a product rule based on provided criteria using a POST request in GraphQL. Useful for testing rule logic. ```GraphQL mutation PreviewProductRule($ruleInput: ProductRuleInput!) { previewProductRule(input: $ruleInput) { productId ruleId outcome } } ``` -------------------------------- ### Get WS-Fed Sign Out URL - GET Source: https://api-docs.kibocommerce.com/reference/accountrankingrule Retrieves the URL for signing out via WS-Federation. -------------------------------- ### Get List of Applications Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Retrieves a list of all available applications. This endpoint provides an overview of the applications registered in the system. ```shell GET /api/v2/applications ``` -------------------------------- ### Get Batch Job Summaries - GET Source: https://api-docs.kibocommerce.com/reference/accountrankingrule Retrieves summaries for multiple batch jobs. -------------------------------- ### Get Batch Job Summary - GET Source: https://api-docs.kibocommerce.com/reference/accountrankingrule Retrieves a summary of a specific batch job. -------------------------------- ### Get Product Substitutions API Source: https://api-docs.kibocommerce.com/reference/applicationuninstalled Fetches product substitution information from the Kibo Commerce API. This helps in suggesting alternative products. ```GraphQL { productSubstitutions(productId: "someProductId") { -- fields to retrieve } } ``` -------------------------------- ### Get Credits (GET) Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Retrieves credits. This endpoint fetches a list of all credits. ```HTTP GET /api/commerce/credits ``` -------------------------------- ### Create User - POST Source: https://api-docs.kibocommerce.com/reference/accountrankingrule Creates a new admin user. ```json { "firstName": "string", "lastName": "string", "email": "string", "password": "string" } ``` -------------------------------- ### Get Search Redirects Source: https://api-docs.kibocommerce.com/reference/applicationinstalled Retrieves a list of all search redirects. This is a GET request. ```REST GET /search/redirect ```