commerce/settings/applications

Use the Applications resource to update site-specific settings for installed applications.

JSON Example

Application Properties

Property Description
appId

type: string

Unique identifier of an app available in your Kibo eCommerce tenant or within Kibo eCommerce Dev Center. This ID is unique across all apps installed, initialized, and enabled in the Admin and those in development through the Dev Center Console.

appKey

type: string

Unique identifier of an app or theme available in your Kibo eCommerce tenant or within Kibo eCommerce Dev Center. An appKey is composed of Developer Account namespace, app/theme ID, version, and package (e.g., devAccount.helloWorld.1.0.0.Release).

capabilities

type: list of capability

List of capabilities installed in a tenant.

capability.activeCreditTypes

type: list of string

Array list of credit types active for the capability.

capability.activeShippingCountries

type: list of activeShippingCountry

Array list of the countries (by country code) to which this capability can actively ship. The entered shipping country is validated against a list of supported shipping countries. Messages return if the country code is not supported or duplicated. Supported carriers are also checked per country code.

capability.activeShippingCountry.activeCarriers

type: list of string

Array list of the active shipping carriers for the country.

capability.activeShippingCountry.countryCode

type: string

The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US.

capability.activeShoppingCountries

type: list of string

Array list of the countries (by country code) for which this capability can actively shop. All active shopping countries must be in the supported shopping country list. Validation rules determine the supported validity of the entered country against the list.

capability.capabilityMode

type: string

The enablement mode of the capability, typically read only.

capability.capabilityType

type: string

The capability type installed in the tenant.

capability.enabled

type: bool

Indicates if a capability, function tied to an Arc.js action, application, or price list is enabled for the tenant/site. If true, the capability/application/function/price list is enabled for the tenant. System-supplied and read-only with the exception of functions tied to an Arc.js action and price lists.

capability.id

type: string

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

capability.initialized

type: bool

Indicates if an app is initialized and capable of being enabled in the tenant and site. Apps will need to be installed and configured to become initialized, such as validating credentials and/or API keys with a third-party service. If true, the app is initialized and can be enabled for usage.

capability.operationUrls

type: list of operationUrl

Array list of URL endpoints for the operations associated with this capability.

capability.operationUrl.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

capability.operationUrl.url

type: string

The URL endpoint address.

capability.scopeId

type: int

The unique identifier of the scope. For example, if your scope type is site, then this value would be the site id.

capability.scopeType

type: string

The type of scope associated with the documentList. For example, if the documentList is pageTemplateContent, the scopeType is Site.

Valid values are: "Tenant", "MasterCatalog", and "Site".

capability.supportedCreditTypes

type: list of initializablePropertyValue

List of credit types this capability supports.

capability.initializablePropertyValue.initialized

type: bool

Indicates if an app is initialized and capable of being enabled in the tenant and site. Apps will need to be installed and configured to become initialized, such as validating credentials and/or API keys with a third-party service. If true, the app is initialized and can be enabled for usage.

capability.initializablePropertyValue.value

type: string

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

capability.supportedShippingCountries

type: list of initializableShippingCountryPropertyValue

Array list of countries this capability supports for shipping.

capability.initializableShippingCountryPropertyValue.child

type: list of initializablePropertyValue

Child value in a hierarchy of shipping country properties.

capability.initializableShippingCountryPropertyValue.initializablePropertyValue.initialized

type: bool

Indicates if an app is initialized and capable of being enabled in the tenant and site. Apps will need to be installed and configured to become initialized, such as validating credentials and/or API keys with a third-party service. If true, the app is initialized and can be enabled for usage.

capability.initializableShippingCountryPropertyValue.initializablePropertyValue.value

type: string

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

capability.initializableShippingCountryPropertyValue.initialized

type: bool

Indicates if an app is initialized and capable of being enabled in the tenant and site. Apps will need to be installed and configured to become initialized, such as validating credentials and/or API keys with a third-party service. If true, the app is initialized and can be enabled for usage.

capability.initializableShippingCountryPropertyValue.value

type: string

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

capability.supportedShoppingCountries

type: list of initializablePropertyValue

List of countries this capability supports for shopping.

capability.initializablePropertyValue.initialized

type: bool

Indicates if an app is initialized and capable of being enabled in the tenant and site. Apps will need to be installed and configured to become initialized, such as validating credentials and/or API keys with a third-party service. If true, the app is initialized and can be enabled for usage.

capability.initializablePropertyValue.value

type: string

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

enabled

type: bool

Indicates if a capability, function tied to an Arc.js action, application, or price list is enabled for the tenant/site. If true, the capability/application/function/price list is enabled for the tenant. System-supplied and read-only with the exception of functions tied to an Arc.js action and price lists.

initialized

type: bool

Indicates if an app is initialized and capable of being enabled in the tenant and site. Apps will need to be installed and configured to become initialized, such as validating credentials and/or API keys with a third-party service. If true, the app is initialized and can be enabled for usage.

isExtension

type: bool

Indicates if the installed application is of type extension. An extension is an application that extends upon the Kibo eCommerce infrastructure. Examples of extensions include Arc.js applications and applications that integrate third-party services.

isExtensionCertified

type: bool

Indicates if an Arc.js application is certified to run on tenants that lack a full installation of the Arc.js framework.

uiConfigurationUrl

type: string

The URL defined for the application that represents the configuration website for the capability. This value is used by installed applications or the site.

Operations

Operation Name Request URI Description
ThirdPartyGetApplication GET %3fresponseFields%3d%7bresponseFields%7d

Retrieve the settings of a third-party application.

ThirdPartyUpdateApplication PUT %3fresponseFields%3d%7bresponseFields%7d

Initializes an application with the necessary configured settings.