Skip to main content
GET
/
platform
/
entitylists
/
{entityListFullName}
/
views
/
{viewName}
/
entityContainers
/
{entityId}
Error
A valid request URL is required to generate request examples
{
  "tenantId": 123,
  "siteId": 123,
  "masterCatalogId": 123,
  "catalogId": 123,
  "localeCode": "<string>",
  "listFullName": "<string>",
  "userId": "<string>",
  "id": "<string>",
  "item": {},
  "createBy": "<string>",
  "createDate": "2023-11-07T05:31:56Z",
  "updateBy": "<string>",
  "updateDate": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
entityListFullName
string
required

The full name of the EntityList including namespace in name@nameSpace format

​
viewName
string
required

The name of the ListView

​
entityId
string
required

The unique Entity id

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Response

Success

The metadata and Entity contents for an entity persisted in an EntityList in MZDB. The Item property contains the json representation of the Entity

​
tenantId
integer<int32>
​
siteId
integer<int32> | null
​
masterCatalogId
integer<int32> | null
​
catalogId
integer<int32> | null
​
localeCode
string | null

The localeCode for the Entity. This will only be populated for EntityLists that are created with IsLocaleSpecific set to true.

​
listFullName
string | null

The nameSpace and name for the EntityList in the format name@nameSpace.

​
userId
string | null

The userId of the shopper account associated with this Entity. This will only be populated for EntityLists that are creaetd with IsShopperSpecific set to true.

​
id
string | null

The unique identifier for the Entity.

​
item
object

The entity in json format.

​
createBy
string | null
​
createDate
string<date-time>
​
updateBy
string | null
​
updateDate
string<date-time>