Skip to main content

Kibo API

Kibo Commerce is a comprehensive e-commerce platform that provides unified commerce solutions for retailers and brands, enabling seamless omnichannel experiences through advanced order management, inventory optimization, and customer engagement tools across all sales channels.

Kibo API icon

Power end-to-end data operations for your Kibo API API with Nexla. Our bi-directional Kibo API connector is purpose-built for Kibo API, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Kibo API or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Kibo API workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Kibo API credential, you need to obtain OAuth2 credentials (Client ID and Client Secret) from your Kibo Commerce account. The OAuth2 credentials are required for 2-legged OAuth2 authentication with the Kibo Commerce API.

To obtain your OAuth2 credentials, you need to have a Kibo Commerce account and access to the Kibo Commerce developer portal or account settings. Once you have access, you can create an application or obtain OAuth2 credentials from your account settings. The Client ID and Client Secret are used for 2-legged OAuth2 authentication, which uses the client credentials flow to obtain an access token. This authentication method is suitable for server-to-server communication where user interaction is not required. The access token is then sent in the Authorization header with the Bearer prefix for all API requests to the Kibo Commerce API. The Kibo Commerce API provides access to e-commerce data including products, orders, carts, customers, and inventory information. For detailed information about OAuth2 credential setup, authentication flows, and available API endpoints, refer to the Kibo Commerce API documentation and Kibo Commerce API authentication guide.

Authenticate

Credentials required

FieldRequiredSecretDescription
Client IDYesNoKibo API Client ID
Client SecretYesYesKibo API Client Secret

Create a credential in Nexla

  1. To create a new Kibo API credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Kibo API

KiboCred.png
  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

Kibo Commerce API uses 2-legged OAuth2 authentication with the client credentials flow. This authentication method is designed for server-to-server communication where user interaction is not required. The Client ID and Client Secret are used to obtain an access token, which is then used to authenticate API requests to the Kibo Commerce API.

  1. Enter your Kibo API Client ID in the Client ID field. This is the Client ID you obtained from your Kibo Commerce account settings or developer portal. The Client ID is a unique identifier for your application and is used along with the Client Secret to obtain an access token for API authentication. The Client ID is not sensitive and can be shared, but it should be kept secure to prevent unauthorized use.

  2. Enter your Kibo API Client Secret in the Client Secret field. This is the Client Secret you obtained from your Kibo Commerce account settings or developer portal. The Client Secret is used along with the Client ID to obtain an access token for API authentication. The Client Secret is sensitive information and must be kept confidential.

    Keep your Client Secret secure and do not share it publicly. The Client Secret provides access to your Kibo Commerce account data and should be treated as sensitive information. If your Client Secret is compromised, you should immediately regenerate it in your Kibo Commerce account settings. Your Kibo API Client Secret can be found in your Kibo Commerce account settings or developer portal where you manage your application credentials. The Client Secret is used along with the Client ID to obtain an access token using the 2-legged OAuth2 client credentials flow. The access token is obtained from the /api/platform/applications/authtickets/oauth endpoint. Nexla automatically obtains and refreshes the access token as needed. The access token does not expire automatically, but you can regenerate credentials if needed. For detailed information about finding your Client Secret, setting up OAuth2 credentials, and managing access tokens, see the Kibo Commerce API documentation.

  3. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Kibo API connector tile, then select the credential that will be used to connect to the Kibo Commerce account, and click Next; or, create a new Kibo API credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Kibo Commerce API endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

Get Cart Summary

Retrieves the number of items in the active cart, total cost of items in the cart and the cart expiration.

  • Optionally, enter the Tenant ID in the Tenant Id field. This is the unique identifier for your Kibo Commerce tenant. The Tenant ID is used to construct the API endpoint URL for your specific tenant instance.
  • Optionally, enter the Site ID in the Site Id field. This is the unique identifier for a specific site within your Kibo Commerce tenant. The Site ID is used to construct the API endpoint URL for your specific site.
  • Optionally, enter the Environment in the Environment field. This specifies the Kibo Commerce environment (e.g., sandbox, production) to use. The environment is used to construct the API endpoint URL.
  • The endpoint uses GET requests to https://t{tenantId}-s{siteId}.{env}.mozu.com/api/commerce/carts/summary where {tenantId}, {siteId}, and {env} are the values you configured. The endpoint URL is automatically constructed based on the values you specify.
  • The endpoint does not use pagination (iteration.type: static.url) and returns a single response. The response data path is $, which extracts the entire response object.
  • The date format is yyyy-MM-dd with a time unit of dd (days), which is used for incremental data extraction based on record dates.

This endpoint retrieves cart summary information from your Kibo Commerce account. The endpoint requires 2-legged OAuth2 authentication via the Authorization: Bearer {token} header, which is handled automatically by your credential configuration. The access token is obtained using the OAuth2 client credentials flow with your Client ID and Client Secret. The endpoint URL is dynamically constructed based on your tenant ID, site ID, and environment settings. The cart summary includes information about the number of items in the cart, total cost, and cart expiration time. For detailed information about cart summaries, API endpoints, and response formats, see the Kibo Commerce API documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Kibo Commerce API data sources can be manually configured to ingest data from any valid Kibo Commerce API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations, such as sources that use custom query parameters, different HTTP methods, or custom data transformations.

Select the format in which the data from the Kibo Commerce API will be received from the Content Format pulldown menu; the Kibo Commerce API typically returns data in JSON format. Then enter the URL of the Kibo Commerce API endpoint from which this source will fetch data in the Set API URL field. Kibo Commerce API endpoints typically follow the pattern https://t{tenantId}-s{siteId}.{env}.mozu.com/api/{endpoint_path}, using your tenant ID, site ID, and environment. Follow the instructions in Connect to Any API to configure the remaining settings, including date/time and lookup macros, path to data, metadata, and request headers.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires 2-legged OAuth2 authentication via the Authorization: Bearer {token} header, which is handled automatically by your credential configuration. The access token is obtained using the OAuth2 client credentials flow with your Client ID and Client Secret. The endpoint URL may need to include your tenant ID, site ID, and environment in the domain structure. For detailed information about Kibo Commerce API endpoints, authentication, and available APIs, see the Kibo Commerce API documentation.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Kibo API data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.