> For the complete documentation index, see [llms.txt](https://integrations.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integrations.impact.com/partner-api-reference/reference/marketplace/models.md).

# Models

## The MarketplaceSearchResult object

```json
{"openapi":"3.1.0","info":{"title":"Partner Marketplace API","version":"16"},"components":{"schemas":{"MarketplaceSearchResult":{"type":"object","properties":{"Results":{"type":"array","description":"Products that match the search.","items":{"$ref":"#/components/schemas/MarketplaceProduct"}},"Facets":{"type":"array","description":"Facets you can apply to narrow the results. Not returned when `IncludeFacets` is `false`.","items":{"$ref":"#/components/schemas/Facet"}},"Total":{"type":"string","description":"Total number of products that match the search terms and applied filters. This can exceed the number of products you can page through (see `MaximumScrollableTotal`)."},"Uri":{"type":"string","description":"Unique reference to this search request in the impact.com API."},"QueryTime":{"type":"string","description":"Time the search query took to run, in milliseconds."},"FacetActive":{"type":"boolean","description":"Whether any facet other than Program Relationship is applied to the results."},"MaximumScrollableTotal":{"type":"string","description":"Maximum number of products you can retrieve for this search."}}},"MarketplaceProduct":{"type":"object","description":"A product in the Product Marketplace, grouping the offers from every brand program that sells it.","properties":{"Id":{"type":"string","description":"Unique identifier for the marketplace product."},"GlobalIdentifiers":{"type":"array","description":"Global identifiers for the product, such as GTINs or manufacturer part numbers.","items":{"type":"string"}},"Name":{"type":"string","description":"Product name."},"ImageUrl":{"type":"string","format":"uri","description":"URL to the primary product image."},"Category":{"$ref":"#/components/schemas/Category"},"Labels":{"type":"array","description":"All labels applied to any of the product's offers.","items":{"type":"string"}},"Manufacturer":{"$ref":"#/components/schemas/Manufacturer"},"ContainsOfferInStock":{"type":"boolean","description":"Whether at least one offer is in stock."},"ContainsOfferOnSale":{"type":"boolean","description":"Whether at least one offer has a current price lower than its original price."},"ContainsOfferOnPromotion":{"type":"boolean","description":"Whether at least one offer has an active promotion."},"ContainsOfferPreQualified":{"type":"boolean","description":"Whether at least one offer is from a brand you're pre-qualified to work with."},"BestPrice":{"type":"string","description":"Lowest current price across all of the product's offers."},"Currency":{"type":"string","description":"ISO 4217 currency code for `BestPrice`."},"BestCommissionPercentage":{"type":"string","description":"Highest commission percentage across all of the product's offers."},"BestEarningsPerClick":{"type":"string","description":"Highest earnings per click (EPC) across all of the product's offers."},"TotalCommission":{"type":"string","description":"Total commission paid across all of the product's offers."},"TotalSales":{"type":"string","description":"Total sales amount across all of the product's offers."},"TotalSalesVolume":{"type":"string","description":"Total number of sales across all of the product's offers."},"Offers":{"type":"array","description":"Offers for this product from each brand program that sells it.","items":{"$ref":"#/components/schemas/Offer"}},"Uri":{"type":"string","description":"Unique reference to this product in the impact.com API."},"Score":{"type":"string","description":"Relevance score of the product against the search terms. Returns `0.0` when no keyword terms are provided."}}},"Category":{"type":"object","description":"Product category, based on the Google product taxonomy where available.","properties":{"Path":{"type":"string","description":"Full category path."},"Name":{"type":"string","description":"Name of the most specific category in the path."},"SearchUri":{"type":"string","description":"Marketplace search that returns other products in this category."}}},"Manufacturer":{"type":"object","description":"The product's manufacturer.","properties":{"Name":{"type":"string","description":"Name of the manufacturer."},"SearchUri":{"type":"string","description":"Marketplace search that returns other products from this manufacturer."}}},"Offer":{"type":"object","description":"A brand program's offer for a marketplace product.","properties":{"RelationshipIndicator":{"type":"string","description":"Whether you're partnered with the brand that makes this offer.","enum":["JOINED","NOT_JOINED"]},"Program":{"$ref":"#/components/schemas/Program"},"CatalogId":{"type":"string","description":"Unique identifier for the catalog this offer comes from."},"CatalogName":{"type":"string","description":"Display name of the catalog this offer comes from."},"CatalogItemId":{"type":"string","description":"Unique identifier for the offer, combining the catalog ID and the brand's SKU."},"Sku":{"type":"string","description":"The brand's SKU for the product."},"LastUpdated":{"type":"string","format":"date-time","description":"Date and time the offer was last updated (ISO 8601)."},"Url":{"type":"string","format":"uri","description":"Tracking link to the product page. Contains the brand's original product URL when `GenerateTrackingLink` is `false`."},"OriginalUrl":{"type":"string","format":"uri","description":"The brand's product page URL, as supplied in its catalog. Product URL searches match against this value."},"RelationshipStatusUri":{"type":"string","description":"Endpoint that returns your relationship status with the brand, such as invited, applied, pre-qualified, or declined."},"ContractApplyUri":{"type":"string","description":"Endpoint to apply to the brand's program. Replace `{InsertionOrderId}` with the public insertion order ID returned by `RelationshipStatusUri`."},"AcceptContractUri":{"type":"string","description":"Endpoint to accept a pending contract from the brand. Replace `{PendingContractId}` with the pending contract ID returned by `RelationshipStatusUri`."},"GenerateShortUrlUri":{"type":"string","description":"Endpoint that generates a vanity (short) tracking link for this offer."},"Name":{"type":"string","description":"Product name, as supplied by the brand."},"Description":{"type":"string","description":"Product description, as supplied by the brand."},"Labels":{"type":"array","description":"Labels the brand applied to this offer.","items":{"type":"string"}},"ImageUrl":{"type":"string","format":"uri","description":"URL to the brand's primary product image."},"AdditionalImageUrls":{"type":"array","description":"Additional product image URLs.","items":{"type":"string","format":"uri"}},"CurrentPrice":{"type":"string","description":"Current selling price of the offer."},"OriginalPrice":{"type":"string","description":"Original price before any discounts."},"Currency":{"type":"string","description":"ISO 4217 currency code for the offer's pricing."},"MinCommissionPercentage":{"type":"string","description":"Minimum commission percentage payable on this offer."},"MaxCommissionPercentage":{"type":"string","description":"Maximum commission percentage payable on this offer."},"ProgramConversionRatePercentage":{"type":"string","description":"Conversion rate of the brand's program, as a percentage."},"ProgramEarningsPerClick":{"type":"string","description":"Earnings per click (EPC) for the brand's program."},"TotalCommission":{"type":"string","description":"Total commission paid on this offer."},"TotalSales":{"type":"string","description":"Total sales amount for this offer."},"TotalSalesVolume":{"type":"string","description":"Total number of sales for this offer."},"StockAvailability":{"type":"string","description":"Current inventory status of the offer.","enum":["InStock","OutOfStock","LimitedAvailability","PreOrder","BackOrder"]},"Promotions":{"type":"array","description":"Promotions that apply to this offer.","items":{"$ref":"#/components/schemas/Promotion"}},"Condition":{"type":"string","description":"Condition the product is sold in.","enum":["New","Used","Refurbished","OEM","OpenBox"]}}},"Program":{"type":"object","description":"The brand program that makes the offer.","properties":{"Id":{"type":"string","description":"Unique identifier for the program."},"Name":{"type":"string","description":"Display name of the program."},"LogoUri":{"type":"string","format":"uri","description":"URL to the program's logo. The URL is generated from a template, so the image may not exist if the brand hasn't uploaded a logo."},"SearchUri":{"type":"string","description":"Marketplace search that returns other products from this program."},"AdvertiserId":{"type":"string","description":"Unique identifier for the brand's account."}}},"Promotion":{"type":"object","description":"A promotion that applies to an offer.","properties":{"Id":{"type":"string","description":"Unique identifier for the promotion."},"Title":{"type":"string","description":"Promotion headline."},"StartDate":{"type":"string","description":"Date the promotion starts, if applicable."},"EndDate":{"type":"string","description":"Date the promotion ends, if applicable."},"RedemptionCode":{"type":"string","description":"Promo code customers apply at checkout, if applicable."}}},"Facet":{"type":"object","description":"A set of filter options for narrowing the search results.","properties":{"Label":{"type":"string","description":"Display label for the facet."},"Type":{"type":"string","description":"How the facet's options can be selected. `MutuallyInclusiveSet` allows several options at once. `DrillDownFacet` is a parent-child hierarchy, such as categories.","enum":["MutuallyInclusiveSet","DrillDownFacet"]},"Results":{"type":"array","description":"The facet's options.","items":{"$ref":"#/components/schemas/FacetResult"}},"DeselectUri":{"type":"string","description":"Marketplace search with this facet removed. Returned for `DrillDownFacet` facets."},"ShowingAll":{"type":"boolean","description":"Whether all of the facet's options are included in `Results`. Returned for `DrillDownFacet` facets."}}},"FacetResult":{"type":"object","description":"A single facet option.","properties":{"Label":{"type":"string","description":"Display label for the option."},"Active":{"type":"boolean","description":"Whether this option is currently applied to the results."},"Uri":{"type":"string","description":"Marketplace search that applies this option, or removes it when `Active` is `true`."},"Children":{"type":"array","description":"Child options of a `DrillDownFacet` option. Populated when the parent option is selected.","items":{"type":"object"}}}}}}}
```

## The MarketplaceProduct object

```json
{"openapi":"3.1.0","info":{"title":"Partner Marketplace API","version":"16"},"components":{"schemas":{"MarketplaceProduct":{"type":"object","description":"A product in the Product Marketplace, grouping the offers from every brand program that sells it.","properties":{"Id":{"type":"string","description":"Unique identifier for the marketplace product."},"GlobalIdentifiers":{"type":"array","description":"Global identifiers for the product, such as GTINs or manufacturer part numbers.","items":{"type":"string"}},"Name":{"type":"string","description":"Product name."},"ImageUrl":{"type":"string","format":"uri","description":"URL to the primary product image."},"Category":{"$ref":"#/components/schemas/Category"},"Labels":{"type":"array","description":"All labels applied to any of the product's offers.","items":{"type":"string"}},"Manufacturer":{"$ref":"#/components/schemas/Manufacturer"},"ContainsOfferInStock":{"type":"boolean","description":"Whether at least one offer is in stock."},"ContainsOfferOnSale":{"type":"boolean","description":"Whether at least one offer has a current price lower than its original price."},"ContainsOfferOnPromotion":{"type":"boolean","description":"Whether at least one offer has an active promotion."},"ContainsOfferPreQualified":{"type":"boolean","description":"Whether at least one offer is from a brand you're pre-qualified to work with."},"BestPrice":{"type":"string","description":"Lowest current price across all of the product's offers."},"Currency":{"type":"string","description":"ISO 4217 currency code for `BestPrice`."},"BestCommissionPercentage":{"type":"string","description":"Highest commission percentage across all of the product's offers."},"BestEarningsPerClick":{"type":"string","description":"Highest earnings per click (EPC) across all of the product's offers."},"TotalCommission":{"type":"string","description":"Total commission paid across all of the product's offers."},"TotalSales":{"type":"string","description":"Total sales amount across all of the product's offers."},"TotalSalesVolume":{"type":"string","description":"Total number of sales across all of the product's offers."},"Offers":{"type":"array","description":"Offers for this product from each brand program that sells it.","items":{"$ref":"#/components/schemas/Offer"}},"Uri":{"type":"string","description":"Unique reference to this product in the impact.com API."},"Score":{"type":"string","description":"Relevance score of the product against the search terms. Returns `0.0` when no keyword terms are provided."}}},"Category":{"type":"object","description":"Product category, based on the Google product taxonomy where available.","properties":{"Path":{"type":"string","description":"Full category path."},"Name":{"type":"string","description":"Name of the most specific category in the path."},"SearchUri":{"type":"string","description":"Marketplace search that returns other products in this category."}}},"Manufacturer":{"type":"object","description":"The product's manufacturer.","properties":{"Name":{"type":"string","description":"Name of the manufacturer."},"SearchUri":{"type":"string","description":"Marketplace search that returns other products from this manufacturer."}}},"Offer":{"type":"object","description":"A brand program's offer for a marketplace product.","properties":{"RelationshipIndicator":{"type":"string","description":"Whether you're partnered with the brand that makes this offer.","enum":["JOINED","NOT_JOINED"]},"Program":{"$ref":"#/components/schemas/Program"},"CatalogId":{"type":"string","description":"Unique identifier for the catalog this offer comes from."},"CatalogName":{"type":"string","description":"Display name of the catalog this offer comes from."},"CatalogItemId":{"type":"string","description":"Unique identifier for the offer, combining the catalog ID and the brand's SKU."},"Sku":{"type":"string","description":"The brand's SKU for the product."},"LastUpdated":{"type":"string","format":"date-time","description":"Date and time the offer was last updated (ISO 8601)."},"Url":{"type":"string","format":"uri","description":"Tracking link to the product page. Contains the brand's original product URL when `GenerateTrackingLink` is `false`."},"OriginalUrl":{"type":"string","format":"uri","description":"The brand's product page URL, as supplied in its catalog. Product URL searches match against this value."},"RelationshipStatusUri":{"type":"string","description":"Endpoint that returns your relationship status with the brand, such as invited, applied, pre-qualified, or declined."},"ContractApplyUri":{"type":"string","description":"Endpoint to apply to the brand's program. Replace `{InsertionOrderId}` with the public insertion order ID returned by `RelationshipStatusUri`."},"AcceptContractUri":{"type":"string","description":"Endpoint to accept a pending contract from the brand. Replace `{PendingContractId}` with the pending contract ID returned by `RelationshipStatusUri`."},"GenerateShortUrlUri":{"type":"string","description":"Endpoint that generates a vanity (short) tracking link for this offer."},"Name":{"type":"string","description":"Product name, as supplied by the brand."},"Description":{"type":"string","description":"Product description, as supplied by the brand."},"Labels":{"type":"array","description":"Labels the brand applied to this offer.","items":{"type":"string"}},"ImageUrl":{"type":"string","format":"uri","description":"URL to the brand's primary product image."},"AdditionalImageUrls":{"type":"array","description":"Additional product image URLs.","items":{"type":"string","format":"uri"}},"CurrentPrice":{"type":"string","description":"Current selling price of the offer."},"OriginalPrice":{"type":"string","description":"Original price before any discounts."},"Currency":{"type":"string","description":"ISO 4217 currency code for the offer's pricing."},"MinCommissionPercentage":{"type":"string","description":"Minimum commission percentage payable on this offer."},"MaxCommissionPercentage":{"type":"string","description":"Maximum commission percentage payable on this offer."},"ProgramConversionRatePercentage":{"type":"string","description":"Conversion rate of the brand's program, as a percentage."},"ProgramEarningsPerClick":{"type":"string","description":"Earnings per click (EPC) for the brand's program."},"TotalCommission":{"type":"string","description":"Total commission paid on this offer."},"TotalSales":{"type":"string","description":"Total sales amount for this offer."},"TotalSalesVolume":{"type":"string","description":"Total number of sales for this offer."},"StockAvailability":{"type":"string","description":"Current inventory status of the offer.","enum":["InStock","OutOfStock","LimitedAvailability","PreOrder","BackOrder"]},"Promotions":{"type":"array","description":"Promotions that apply to this offer.","items":{"$ref":"#/components/schemas/Promotion"}},"Condition":{"type":"string","description":"Condition the product is sold in.","enum":["New","Used","Refurbished","OEM","OpenBox"]}}},"Program":{"type":"object","description":"The brand program that makes the offer.","properties":{"Id":{"type":"string","description":"Unique identifier for the program."},"Name":{"type":"string","description":"Display name of the program."},"LogoUri":{"type":"string","format":"uri","description":"URL to the program's logo. The URL is generated from a template, so the image may not exist if the brand hasn't uploaded a logo."},"SearchUri":{"type":"string","description":"Marketplace search that returns other products from this program."},"AdvertiserId":{"type":"string","description":"Unique identifier for the brand's account."}}},"Promotion":{"type":"object","description":"A promotion that applies to an offer.","properties":{"Id":{"type":"string","description":"Unique identifier for the promotion."},"Title":{"type":"string","description":"Promotion headline."},"StartDate":{"type":"string","description":"Date the promotion starts, if applicable."},"EndDate":{"type":"string","description":"Date the promotion ends, if applicable."},"RedemptionCode":{"type":"string","description":"Promo code customers apply at checkout, if applicable."}}}}}}
```

## The Offer object

```json
{"openapi":"3.1.0","info":{"title":"Partner Marketplace API","version":"16"},"components":{"schemas":{"Offer":{"type":"object","description":"A brand program's offer for a marketplace product.","properties":{"RelationshipIndicator":{"type":"string","description":"Whether you're partnered with the brand that makes this offer.","enum":["JOINED","NOT_JOINED"]},"Program":{"$ref":"#/components/schemas/Program"},"CatalogId":{"type":"string","description":"Unique identifier for the catalog this offer comes from."},"CatalogName":{"type":"string","description":"Display name of the catalog this offer comes from."},"CatalogItemId":{"type":"string","description":"Unique identifier for the offer, combining the catalog ID and the brand's SKU."},"Sku":{"type":"string","description":"The brand's SKU for the product."},"LastUpdated":{"type":"string","format":"date-time","description":"Date and time the offer was last updated (ISO 8601)."},"Url":{"type":"string","format":"uri","description":"Tracking link to the product page. Contains the brand's original product URL when `GenerateTrackingLink` is `false`."},"OriginalUrl":{"type":"string","format":"uri","description":"The brand's product page URL, as supplied in its catalog. Product URL searches match against this value."},"RelationshipStatusUri":{"type":"string","description":"Endpoint that returns your relationship status with the brand, such as invited, applied, pre-qualified, or declined."},"ContractApplyUri":{"type":"string","description":"Endpoint to apply to the brand's program. Replace `{InsertionOrderId}` with the public insertion order ID returned by `RelationshipStatusUri`."},"AcceptContractUri":{"type":"string","description":"Endpoint to accept a pending contract from the brand. Replace `{PendingContractId}` with the pending contract ID returned by `RelationshipStatusUri`."},"GenerateShortUrlUri":{"type":"string","description":"Endpoint that generates a vanity (short) tracking link for this offer."},"Name":{"type":"string","description":"Product name, as supplied by the brand."},"Description":{"type":"string","description":"Product description, as supplied by the brand."},"Labels":{"type":"array","description":"Labels the brand applied to this offer.","items":{"type":"string"}},"ImageUrl":{"type":"string","format":"uri","description":"URL to the brand's primary product image."},"AdditionalImageUrls":{"type":"array","description":"Additional product image URLs.","items":{"type":"string","format":"uri"}},"CurrentPrice":{"type":"string","description":"Current selling price of the offer."},"OriginalPrice":{"type":"string","description":"Original price before any discounts."},"Currency":{"type":"string","description":"ISO 4217 currency code for the offer's pricing."},"MinCommissionPercentage":{"type":"string","description":"Minimum commission percentage payable on this offer."},"MaxCommissionPercentage":{"type":"string","description":"Maximum commission percentage payable on this offer."},"ProgramConversionRatePercentage":{"type":"string","description":"Conversion rate of the brand's program, as a percentage."},"ProgramEarningsPerClick":{"type":"string","description":"Earnings per click (EPC) for the brand's program."},"TotalCommission":{"type":"string","description":"Total commission paid on this offer."},"TotalSales":{"type":"string","description":"Total sales amount for this offer."},"TotalSalesVolume":{"type":"string","description":"Total number of sales for this offer."},"StockAvailability":{"type":"string","description":"Current inventory status of the offer.","enum":["InStock","OutOfStock","LimitedAvailability","PreOrder","BackOrder"]},"Promotions":{"type":"array","description":"Promotions that apply to this offer.","items":{"$ref":"#/components/schemas/Promotion"}},"Condition":{"type":"string","description":"Condition the product is sold in.","enum":["New","Used","Refurbished","OEM","OpenBox"]}}},"Program":{"type":"object","description":"The brand program that makes the offer.","properties":{"Id":{"type":"string","description":"Unique identifier for the program."},"Name":{"type":"string","description":"Display name of the program."},"LogoUri":{"type":"string","format":"uri","description":"URL to the program's logo. The URL is generated from a template, so the image may not exist if the brand hasn't uploaded a logo."},"SearchUri":{"type":"string","description":"Marketplace search that returns other products from this program."},"AdvertiserId":{"type":"string","description":"Unique identifier for the brand's account."}}},"Promotion":{"type":"object","description":"A promotion that applies to an offer.","properties":{"Id":{"type":"string","description":"Unique identifier for the promotion."},"Title":{"type":"string","description":"Promotion headline."},"StartDate":{"type":"string","description":"Date the promotion starts, if applicable."},"EndDate":{"type":"string","description":"Date the promotion ends, if applicable."},"RedemptionCode":{"type":"string","description":"Promo code customers apply at checkout, if applicable."}}}}}}
```

## The Program object

```json
{"openapi":"3.1.0","info":{"title":"Partner Marketplace API","version":"16"},"components":{"schemas":{"Program":{"type":"object","description":"The brand program that makes the offer.","properties":{"Id":{"type":"string","description":"Unique identifier for the program."},"Name":{"type":"string","description":"Display name of the program."},"LogoUri":{"type":"string","format":"uri","description":"URL to the program's logo. The URL is generated from a template, so the image may not exist if the brand hasn't uploaded a logo."},"SearchUri":{"type":"string","description":"Marketplace search that returns other products from this program."},"AdvertiserId":{"type":"string","description":"Unique identifier for the brand's account."}}}}}}
```

## The Category object

```json
{"openapi":"3.1.0","info":{"title":"Partner Marketplace API","version":"16"},"components":{"schemas":{"Category":{"type":"object","description":"Product category, based on the Google product taxonomy where available.","properties":{"Path":{"type":"string","description":"Full category path."},"Name":{"type":"string","description":"Name of the most specific category in the path."},"SearchUri":{"type":"string","description":"Marketplace search that returns other products in this category."}}}}}}
```

## The Manufacturer object

```json
{"openapi":"3.1.0","info":{"title":"Partner Marketplace API","version":"16"},"components":{"schemas":{"Manufacturer":{"type":"object","description":"The product's manufacturer.","properties":{"Name":{"type":"string","description":"Name of the manufacturer."},"SearchUri":{"type":"string","description":"Marketplace search that returns other products from this manufacturer."}}}}}}
```

## The Promotion object

```json
{"openapi":"3.1.0","info":{"title":"Partner Marketplace API","version":"16"},"components":{"schemas":{"Promotion":{"type":"object","description":"A promotion that applies to an offer.","properties":{"Id":{"type":"string","description":"Unique identifier for the promotion."},"Title":{"type":"string","description":"Promotion headline."},"StartDate":{"type":"string","description":"Date the promotion starts, if applicable."},"EndDate":{"type":"string","description":"Date the promotion ends, if applicable."},"RedemptionCode":{"type":"string","description":"Promo code customers apply at checkout, if applicable."}}}}}}
```

## The Facet object

```json
{"openapi":"3.1.0","info":{"title":"Partner Marketplace API","version":"16"},"components":{"schemas":{"Facet":{"type":"object","description":"A set of filter options for narrowing the search results.","properties":{"Label":{"type":"string","description":"Display label for the facet."},"Type":{"type":"string","description":"How the facet's options can be selected. `MutuallyInclusiveSet` allows several options at once. `DrillDownFacet` is a parent-child hierarchy, such as categories.","enum":["MutuallyInclusiveSet","DrillDownFacet"]},"Results":{"type":"array","description":"The facet's options.","items":{"$ref":"#/components/schemas/FacetResult"}},"DeselectUri":{"type":"string","description":"Marketplace search with this facet removed. Returned for `DrillDownFacet` facets."},"ShowingAll":{"type":"boolean","description":"Whether all of the facet's options are included in `Results`. Returned for `DrillDownFacet` facets."}}},"FacetResult":{"type":"object","description":"A single facet option.","properties":{"Label":{"type":"string","description":"Display label for the option."},"Active":{"type":"boolean","description":"Whether this option is currently applied to the results."},"Uri":{"type":"string","description":"Marketplace search that applies this option, or removes it when `Active` is `true`."},"Children":{"type":"array","description":"Child options of a `DrillDownFacet` option. Populated when the parent option is selected.","items":{"type":"object"}}}}}}}
```

## The FacetResult object

```json
{"openapi":"3.1.0","info":{"title":"Partner Marketplace API","version":"16"},"components":{"schemas":{"FacetResult":{"type":"object","description":"A single facet option.","properties":{"Label":{"type":"string","description":"Display label for the option."},"Active":{"type":"boolean","description":"Whether this option is currently applied to the results."},"Uri":{"type":"string","description":"Marketplace search that applies this option, or removes it when `Active` is `true`."},"Children":{"type":"array","description":"Child options of a `DrillDownFacet` option. Populated when the parent option is selected.","items":{"type":"object"}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://integrations.impact.com/partner-api-reference/reference/marketplace/models.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
