Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetListing

Provides details about a listing, such as descriptions, badges, categories, pricing model summaries, reviews, and associated products and offers.

Request Syntax


POST /2026-02-05/getListing HTTP/1.1
Content-type: application/json

{
   "listingId": "string",
   "locale": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

listingId

The unique identifier of the listing to retrieve.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\w\-]+

Required: Yes

locale

A BCP 47 language tag or comma-separated priority list specifying the preferred locale for response content. See Locale for supported values, constraints, fallback behavior, and the default locale. If omitted, the service returns content in the default locale.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [^;,]+(\s*,\s*[^;,]+){0,1}

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "associatedEntities": [ 
      { 
         "offer": { 
            "offerId": "string",
            "offerName": "string",
            "sellerOfRecord": { 
               "displayName": "string",
               "sellerProfileId": "string"
            }
         },
         "product": { 
            "manufacturer": { 
               "displayName": "string",
               "sellerProfileId": "string"
            },
            "productId": "string",
            "productName": "string"
         }
      }
   ],
   "badges": [ 
      { 
         "badgeType": "string",
         "displayName": "string"
      }
   ],
   "catalog": "string",
   "categories": [ 
      { 
         "categoryId": "string",
         "displayName": "string"
      }
   ],
   "fulfillmentOptionSummaries": [ 
      { 
         "displayName": "string",
         "fulfillmentOptionType": "string"
      }
   ],
   "highlights": [ "string" ],
   "integrationGuide": "string",
   "listingId": "string",
   "listingName": "string",
   "locale": "string",
   "logoThumbnailUrl": "string",
   "longDescription": "string",
   "pricingModels": [ 
      { 
         "displayName": "string",
         "pricingModelType": "string"
      }
   ],
   "pricingUnits": [ 
      { 
         "displayName": "string",
         "pricingUnitType": "string"
      }
   ],
   "promotionalMedia": [ 
      { ... }
   ],
   "publisher": { 
      "displayName": "string",
      "sellerProfileId": "string"
   },
   "resources": [ 
      { 
         "contentType": "string",
         "displayName": "string",
         "resourceType": "string",
         "value": "string"
      }
   ],
   "reviewSummary": { 
      "reviewSourceSummaries": [ 
         { 
            "averageRating": "string",
            "sourceId": "string",
            "sourceName": "string",
            "sourceUrl": "string",
            "totalReviews": number
         }
      ]
   },
   "sellerEngagements": [ 
      { 
         "contentType": "string",
         "engagementType": "string",
         "value": "string"
      }
   ],
   "shortDescription": "string",
   "useCases": [ 
      { 
         "useCase": { 
            "description": "string",
            "displayName": "string",
            "value": "string"
         }
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

associatedEntities

The products and offers associated with this listing. Each entity contains product and offer information.

Type: Array of ListingAssociatedEntity objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

badges

Badges indicating special attributes of the listing, such as free tier eligibility, free trial availability, or Quick Launch support.

Type: Array of ListingBadge objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

catalog

The name of the catalog that the listing belongs to.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\w\-]+

categories

The categories used to classify this listing into logical groups.

Type: Array of Category objects

Array Members: Minimum number of 0 items. Maximum number of 30 items.

fulfillmentOptionSummaries

A summary of fulfillment options available for deploying or accessing the listing, such as AMI, SaaS, or Container.

Type: Array of FulfillmentOptionSummary objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

highlights

A list of key features that the listing offers to customers.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .*\S.*

listingId

The unique identifier of the listing.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\w\-]+

listingName

The human-readable display name of the listing.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .*\S.*

logoThumbnailUrl

The URL of the logo thumbnail image for the listing.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: https?://.*

longDescription

A detailed description of what the listing offers, in paragraph format.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 32768.

Pattern: .*\S.*

pricingModels

The pricing models for offers associated with this listing, such as usage-based, contract, BYOL, or free.

Type: Array of PricingModel objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

pricingUnits

The pricing units that define the billing dimensions for offers associated with this listing, such as users, hosts, or data.

Type: Array of PricingUnit objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

promotionalMedia

Embedded promotional media provided by the creator of the product, such as images and videos.

Type: Array of PromotionalMedia objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

publisher

The entity who created and published the listing.

Type: SellerInformation object

resources

Resources that provide further information about using the product or requesting support, such as documentation links, support contacts, and usage instructions.

Type: Array of Resource objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

sellerEngagements

Engagement options available to potential buyers, such as requesting a private offer or requesting a demo.

Type: Array of SellerEngagement objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

shortDescription

A 1–3 sentence summary describing the key aspects of the listing.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .*\S.*

useCases

Use cases associated with the listing, describing scenarios where the product can be applied.

Type: Array of UseCaseEntry objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

integrationGuide

Optional guidance explaining how to use data in this listing. Primarily defines how to integrate with a multi-product listing.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

locale

The locale of the returned content. Indicates whether the response contains content in the requested locale, or fell back to the default locale. See Locale for details.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [^;,]+(\s*,\s*[^;,]+){0,1}

reviewSummary

A summary of customer reviews available for the listing, including average rating and total review count by source.

Type: ReviewSummary object

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You don't have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

Unexpected error during processing of the request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource doesn't exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service.

reason: The reason that the input fails to satisfy the constraints specified by the service.

HTTP Status Code: 400