platform/entitylists/EntityContainers
Entity containers provide all properties and data for entities within a site/tenant. This data encapsulates all associated IDs including entity lists, entity views, site, tenant, entities, and more.
JSON Example
EntityContainer Properties
| Property | Description |
|---|---|
| catalogId |
type: int The unique identifier for the product catalog. Catalogs are part of a master catalog. |
| createBy |
type: string Identifier of the user that created the object. System created and read only. |
| createDate |
type: DateTime The date and time in UTC format set when the object was created. |
| 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 For email templates, the ID must be one of the following values:
|
| item |
type: Mozu.Core.Api.Contracts.Json The entity in JSON format. |
| listFullName |
type: string The nameSpace and name for the EntityList in the format name@nameSpace. |
| localeCode |
type: string The two character locale code, per the country code provided. This code determines the localized content to use and display. |
| masterCatalogId |
type: int Unique identifier for the master catalog. |
| 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. |
| tenantId |
type: int Unique identifier for the tenant. |
| updateBy |
type: string Identifier of the user that updated the entity most recently. |
| updateDate |
type: DateTime The date and time in UTC format the object was updated most recently. |
| userId |
type: string Unique identifier of the customer account (shopper or system user). System-supplied and read-only. If the shopper user is anonymous, the user ID represents a system-generated user ID string. |
Operations
| Operation Name | Request URI | Description |
|---|---|---|
| GetEntityContainer | GET %7bentityListFullName%7d%2fentityContainers%2f%7bid%7d%3fresponseFields%3d%7bresponseFields%7d |
Retrieves an entity container, providing all schema and rules and associated IDs for entities. |
| GetEntityContainers | GET %7bentityListFullName%7d%2fentityContainers%3fpageSize%3d%7bpageSize%7d%26startIndex%3d%7bstartIndex%7d%26filter%3d%7bfilter%7d%26sortBy%3d%7bsortBy%7d%26responseFields%3d%7bresponseFields%7d |
Retrieves a collection of entity containers. Each container holds a set of entities per ID. |