platform/tenants

Use the tenants resource to manage information about a Kibo eCommerce tenant.

JSON Example

Tenant Properties

Property Description
attributes

type: list of tenantAttribute

Collection of attributes that may be paged list or a list, depending on the usage per object and API type.

tenantAttribute.createBy

type: string

Identifier of the user that created the object. System created and read only.

tenantAttribute.createDate

type: DateTime

The date and time in UTC format set when the object was created.

tenantAttribute.name

type: string

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

tenantAttribute.updateBy

type: string

Identifier of the user that updated the entity most recently.

tenantAttribute.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

tenantAttribute.value

type: object

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.

createDate

type: DateTime

The date and time in UTC format set when the object was created.

deleteDate

type: DateTime

The date and time the object was deleted.

devAccountId

type: int

Numeric identifier of the developer account.

domain

type: domain

Properties of the domain that the tenant is associated with such as the domain name, the zone string, audit information (system-supplied and read-only), assignment data, and whether or not the domain is primary or requires a SSL for authentication.

domain.cName

type: string

The alias record that redirects IP addresses for a tenant domain.

domain.createDate

type: DateTime

The date and time in UTC format set when the object was created.

domain.domainName

type: string

The domain name of the tenant.

domain.ipAddress

type: string

A captured and stored IP address. IP addresses are stored for the origin location of submitted orders and the tenant domain.

domain.isDomainManaged

type: bool

Indicates if the domain is managed.

domain.isInfrastructureRecord

type: bool

Indicates if this is an infrastructure record for the domain.

domain.isPrimary

type: bool

Indicates if the object is primary, used to indicate primary contacts and entities within a tenant. If true, this marker indicates that the object is the primary in a set.

domain.isSystemAssigned

type: bool

If true, the entity is assigned by the system.

domain.siteId

type: int

Unique identifier for the site. This ID is used at all levels of a store, catalog, and tenant to associate objects to a site.

domain.tenantId

type: int

Unique identifier for the tenant.

domain.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

domain.zone

type: string

The zone string for the tenant domain.

id

type: int

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

isDeleted

type: bool

Indicates if the object is deleted. If true, the object has been deleted. This may affect associated child members and objects. For example, a deleted master catalog affects all associated catalogs.

isDevTenant

type: bool

Indicates if the tenant is a development tenant. If true, the tenant represents a collection of master catalogs and catalogs for a development tenant, used by a developer account to test applications and themes.

masterCatalogs

type: list of masterCatalog

Collection of master catalogs associated with the tenant.

masterCatalog.catalogs

type: list of catalog

Collection of product catalogs that use product definitions from the master catalog.

masterCatalog.catalog.createDate

type: DateTime

The date and time in UTC format set when the object was created.

masterCatalog.catalog.defaultCurrencyCode

type: string

The default three-letter ISO currency code for monetary amounts. Currently, only "USD" is supported for U.S. Dollar.

masterCatalog.catalog.defaultLocaleCode

type: string

The two-letter default locale code for setting the localized text content. Currently, only "en-US" is supported for U.S. English.

masterCatalog.catalog.deleteDate

type: DateTime

The date and time the object was deleted.

masterCatalog.catalog.id

type: int

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

masterCatalog.catalog.isDeleted

type: bool

Indicates if the object is deleted. If true, the object has been deleted. This may affect associated child members and objects. For example, a deleted master catalog affects all associated catalogs.

masterCatalog.catalog.masterCatalogId

type: int

Unique identifier for the master catalog.

masterCatalog.catalog.name

type: string

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

masterCatalog.catalog.status

type: string

The current status of the object.

This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive".

masterCatalog.catalog.tenantId

type: int

Unique identifier for the tenant.

masterCatalog.catalog.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

masterCatalog.createDate

type: DateTime

The date and time in UTC format set when the object was created.

masterCatalog.defaultCurrencyCode

type: string

The default three-letter ISO currency code for monetary amounts. Currently, only "USD" is supported for U.S. Dollar.

masterCatalog.defaultLocaleCode

type: string

The two-letter default locale code for setting the localized text content. Currently, only "en-US" is supported for U.S. English.

masterCatalog.deleteDate

type: DateTime

The date and time the object was deleted.

masterCatalog.id

type: int

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

masterCatalog.isDeleted

type: bool

Indicates if the object is deleted. If true, the object has been deleted. This may affect associated child members and objects. For example, a deleted master catalog affects all associated catalogs.

masterCatalog.name

type: string

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

masterCatalog.status

type: string

The current status of the object.

This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive".

masterCatalog.tenantId

type: int

Unique identifier for the tenant.

masterCatalog.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

mozuInstanceId

type: string

Unique identifier of the Kibo eCommerce instance.

name

type: string

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

omsMerchantId

type: int

omsMerchantId ApiType DOCUMENT_HERE

routingTargetInfo

type: string

Properties for setting domain routing to specific targets for tenants and sites.

scaleUnitId

type: string

Identifier of the ZuKeeper scale unit this tenant belongs to.

sites

type: list of site

Collection of sites associated with the tenant.

site.attributes

type: list of tenantAttribute

Collection of attributes that may be paged list or a list, depending on the usage per object and API type.

site.tenantAttribute.createBy

type: string

Identifier of the user that created the object. System created and read only.

site.tenantAttribute.createDate

type: DateTime

The date and time in UTC format set when the object was created.

site.tenantAttribute.name

type: string

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

site.tenantAttribute.updateBy

type: string

Identifier of the user that updated the entity most recently.

site.tenantAttribute.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

site.tenantAttribute.value

type: object

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.

site.catalogId

type: int

The unique identifier for the product catalog. Catalogs are part of a master catalog.

site.countryCode

type: string

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

site.createDate

type: DateTime

The date and time in UTC format set when the object was created.

site.defaultCurrencyCode

type: string

The default three-letter ISO currency code for monetary amounts. Currently, only "USD" is supported for U.S. Dollar.

site.defaultLocaleCode

type: string

The two-letter default locale code for setting the localized text content. Currently, only "en-US" is supported for U.S. English.

site.deleteDate

type: DateTime

The date and time the object was deleted.

site.domains

type: list of domain

A list of domains associated with the site.

site.domain.cName

type: string

The alias record that redirects IP addresses for a tenant domain.

site.domain.createDate

type: DateTime

The date and time in UTC format set when the object was created.

site.domain.domainName

type: string

The domain name of the tenant.

site.domain.ipAddress

type: string

A captured and stored IP address. IP addresses are stored for the origin location of submitted orders and the tenant domain.

site.domain.isDomainManaged

type: bool

Indicates if the domain is managed.

site.domain.isInfrastructureRecord

type: bool

Indicates if this is an infrastructure record for the domain.

site.domain.isPrimary

type: bool

Indicates if the object is primary, used to indicate primary contacts and entities within a tenant. If true, this marker indicates that the object is the primary in a set.

site.domain.isSystemAssigned

type: bool

If true, the entity is assigned by the system.

site.domain.siteId

type: int

Unique identifier for the site. This ID is used at all levels of a store, catalog, and tenant to associate objects to a site.

site.domain.tenantId

type: int

Unique identifier for the tenant.

site.domain.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

site.domain.zone

type: string

The zone string for the tenant domain.

site.id

type: int

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

site.isDeleted

type: bool

Indicates if the object is deleted. If true, the object has been deleted. This may affect associated child members and objects. For example, a deleted master catalog affects all associated catalogs.

site.isMozuRendered

type: bool

If true, the site represents a Kibo eCommerce-hosted storefront website.

site.masterCatalogId

type: int

Unique identifier for the master catalog.

site.name

type: string

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

site.omsCatalogId

type: int

omsCatalogId ApiType DOCUMENT_HERE

site.routingTargetInfo

type: string

Properties for setting domain routing to specific targets for tenants and sites.

site.status

type: string

The current status of the object.

This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive".

site.tenantId

type: int

Unique identifier for the tenant.

site.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

status

type: string

The current status of the object.

This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive".

supportsCustomExtensions

type: bool

Whether this tenant supports custom extensions.

updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

Operations

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

Retrieve details about a specific tenant by providing the tenant ID.