DescribeEntity

GET {{_.CAPI_PROD}}/DescribeEntity?catalog=AWSMarketplace&entityId={{PRODUCT_ID}}

DescribeEntity API call returns the metadata and content of the entity.

Request Params

Key	Datatype	Required	Description
`catalog`	string
`entityId`	string

RESPONSES

status: OK

{&quot;Details&quot;:&quot;{\&quot;Description\&quot;:{\&quot;ProductTitle\&quot;:null,\&quot;ProductCode\&quot;:\&quot;1111111111111111111111\&quot;,\&quot;ShortDescription\&quot;:null,\&quot;Manufacturer\&quot;:null,\&quot;LongDescription\&quot;:null,\&quot;Sku\&quot;:null,\&quot;Highlights\&quot;:null,\&quot;Categories\&quot;:null,\&quot;AssociatedProducts\&quot;:null,\&quot;SearchKeywords\&quot;:null,\&quot;Visibility\&quot;:\&quot;Draft\&quot;,\&quot;ProductState\&quot;:\&quot;Draft\&quot;},\&quot;Targeting\&quot;:{\&quot;PositiveTargeting\&quot;:{\&quot;BuyerAccounts\&quot;:[]}}}&quot;,&quot;DetailsDocument&quot;:{&quot;Description&quot;:{&quot;ProductTitle&quot;:null,&quot;ProductCode&quot;:&quot;1111111111111111111111&quot;,&quot;ShortDescription&quot;:null,&quot;Manufacturer&quot;:null,&quot;LongDescription&quot;:null,&quot;Sku&quot;:null,&quot;Highlights&quot;:null,&quot;Categories&quot;:null,&quot;AssociatedProducts&quot;:null,&quot;SearchKeywords&quot;:null,&quot;Visibility&quot;:&quot;Draft&quot;,&quot;ProductState&quot;:&quot;Draft&quot;},&quot;Targeting&quot;:{&quot;PositiveTargeting&quot;:{&quot;BuyerAccounts&quot;:[]}}},&quot;EntityArn&quot;:&quot;arn:aws:aws-marketplace:us-east-1:111111111111:AWSMarketplace/SaaSProduct/prod-1234567890&quot;,&quot;EntityIdentifier&quot;:&quot;prod-1234567890@1&quot;,&quot;EntityType&quot;:&quot;SaaSProduct@1.0&quot;,&quot;LastModifiedDate&quot;:&quot;2024-09-26T23:49:30Z&quot;}