> 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/stores/stores.md).

# Stores

Endpoints for browsing partner storefronts, their groups, and the catalog items inside them.

## List all stores

> Returns a list of all stores available to your partner account.

```json
{"openapi":"3.1.0","info":{"title":"Partner Stores API","version":"16"},"tags":[{"name":"Stores","description":"Endpoints for browsing partner storefronts, their groups, and the catalog items inside them."}],"servers":[{"url":"https://api.impact.com","description":"Production server"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"Store":{"type":"object","properties":{"Id":{"type":"string","description":"Unique identifier for the store (also the brand's Campaign ID)."},"Name":{"type":"string","description":"Display name of the store as shown on the brand's storefront."},"NumberOfGroups":{"type":"string","description":"Number of curated groups in this store."},"DateLastUpdated":{"type":"string","format":"date-time","description":"Date and time the store was last updated (ISO 8601)."},"StoreUri":{"type":"string","description":"Web URL to view this store in the impact.com interface."},"StoreAvatar":{"type":"string","description":"Public CDN URL of the brand's logo for this store. May be empty."},"StoreBanner":{"type":"string","description":"Public CDN URL of the storefront banner image. May be empty."},"Uri":{"type":"string","description":"API resource path for this store."},"Groups":{"type":"array","description":"The curated groups contained in this store.","items":{"$ref":"#/components/schemas/StoreGroup"}}}},"StoreGroup":{"type":"object","properties":{"Id":{"type":"string","description":"Unique identifier for the group within the store."},"Name":{"type":"string","description":"Display name of the group."},"NumberOfProducts":{"type":"string","description":"Number of products in this group."},"DateLastUpdated":{"type":"string","format":"date-time","description":"Date and time the group was last updated (ISO 8601)."},"StartDate":{"type":"string","format":"date-time","description":"Date and time from which this group is active (ISO 8601). Empty for groups with no scheduled start."},"EndDate":{"type":"string","format":"date-time","description":"Date and time at which this group ends (ISO 8601). Empty for groups with no scheduled end."},"Status":{"type":"string","enum":["ACTIVE","DISABLED"],"description":"Current state of the group."},"CatalogId":{"type":"string","description":"Unique identifier for the brand catalog that contains the items in this group."},"Uri":{"type":"string","description":"Web URL to view the products in this group in the impact.com interface."},"ItemsUri":{"type":"string","description":"API resource path to list the items in this group."},"GroupProductPreview":{"type":"string","description":"Optional preview image representing the group's products. May be empty."}}}}},"paths":{"/Mediapartners/{AccountSID}/Stores":{"get":{"summary":"List all stores","description":"Returns a list of all stores available to your partner account.","operationId":"listStores","tags":["Stores"],"parameters":[{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"},"description":"Unique identifier for the partner account."}],"responses":{"200":{"description":"An array of stores.","content":{"application/json":{"schema":{"type":"object","properties":{"Stores":{"type":"array","items":{"$ref":"#/components/schemas/Store"}}}}}}}}}}}}
```

## Retrieve a store

> Retrieves a store's details, including its curated groups.

```json
{"openapi":"3.1.0","info":{"title":"Partner Stores API","version":"16"},"tags":[{"name":"Stores","description":"Endpoints for browsing partner storefronts, their groups, and the catalog items inside them."}],"servers":[{"url":"https://api.impact.com","description":"Production server"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"Store":{"type":"object","properties":{"Id":{"type":"string","description":"Unique identifier for the store (also the brand's Campaign ID)."},"Name":{"type":"string","description":"Display name of the store as shown on the brand's storefront."},"NumberOfGroups":{"type":"string","description":"Number of curated groups in this store."},"DateLastUpdated":{"type":"string","format":"date-time","description":"Date and time the store was last updated (ISO 8601)."},"StoreUri":{"type":"string","description":"Web URL to view this store in the impact.com interface."},"StoreAvatar":{"type":"string","description":"Public CDN URL of the brand's logo for this store. May be empty."},"StoreBanner":{"type":"string","description":"Public CDN URL of the storefront banner image. May be empty."},"Uri":{"type":"string","description":"API resource path for this store."},"Groups":{"type":"array","description":"The curated groups contained in this store.","items":{"$ref":"#/components/schemas/StoreGroup"}}}},"StoreGroup":{"type":"object","properties":{"Id":{"type":"string","description":"Unique identifier for the group within the store."},"Name":{"type":"string","description":"Display name of the group."},"NumberOfProducts":{"type":"string","description":"Number of products in this group."},"DateLastUpdated":{"type":"string","format":"date-time","description":"Date and time the group was last updated (ISO 8601)."},"StartDate":{"type":"string","format":"date-time","description":"Date and time from which this group is active (ISO 8601). Empty for groups with no scheduled start."},"EndDate":{"type":"string","format":"date-time","description":"Date and time at which this group ends (ISO 8601). Empty for groups with no scheduled end."},"Status":{"type":"string","enum":["ACTIVE","DISABLED"],"description":"Current state of the group."},"CatalogId":{"type":"string","description":"Unique identifier for the brand catalog that contains the items in this group."},"Uri":{"type":"string","description":"Web URL to view the products in this group in the impact.com interface."},"ItemsUri":{"type":"string","description":"API resource path to list the items in this group."},"GroupProductPreview":{"type":"string","description":"Optional preview image representing the group's products. May be empty."}}}}},"paths":{"/Mediapartners/{AccountSID}/Stores/{Id}":{"get":{"summary":"Retrieve a store","description":"Retrieves a store's details, including its curated groups.","operationId":"retrieveStore","tags":["Stores"],"parameters":[{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"},"description":"Unique identifier for the partner account."},{"name":"Id","in":"path","required":true,"description":"Unique identifier for the store.","schema":{"type":"string"}},{"name":"ShowAutoCreatedGroups","in":"query","required":false,"description":"When `TRUE` (the default), the response includes groups that impact.com auto-generated for the storefront. Set to `FALSE` to return only brand-curated groups.","schema":{"type":"string","enum":["TRUE","FALSE"],"default":"TRUE"}}],"responses":{"200":{"description":"A store object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store"}}}},"404":{"description":"No store exists with the supplied Id."}}}}}}
```

## List items in a store group

> Returns the catalog items belonging to the given store and group, sorted by most recently created.

```json
{"openapi":"3.1.0","info":{"title":"Partner Stores API","version":"16"},"tags":[{"name":"Stores","description":"Endpoints for browsing partner storefronts, their groups, and the catalog items inside them."}],"servers":[{"url":"https://api.impact.com","description":"Production server"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"CatalogItem":{"type":"object","description":"A product within a store group. For richer item operations and full-catalog search, see the Partner Catalogs API at `Uri`.","properties":{"Id":{"type":"string","description":"Unique identifier for this catalog item. Composed of the catalog ID and the brand's `CatalogItemId`."},"CatalogId":{"type":"string","description":"Unique identifier for the brand catalog that contains this item."},"CampaignId":{"type":"string","description":"Unique identifier for the brand's program (campaign)."},"CampaignName":{"type":"string","description":"Display name of the brand's program."},"CatalogItemId":{"type":"string","description":"The brand's own SKU or product identifier for this item."},"Name":{"type":"string","description":"Product name."},"Description":{"type":"string","description":"Product description supplied by the brand."},"MultiPack":{"type":"string","description":"Multi-pack quantity if the item is sold in packs. Empty for single-unit products."},"Bullets":{"type":"array","description":"Short bullet points highlighting product features.","items":{"type":"string"}},"Labels":{"type":"array","description":"Tags or labels applied to the product (e.g., \"Bestseller\", \"New Arrival\").","items":{"type":"string"}},"Manufacturer":{"type":"string","description":"Name of the manufacturer."},"Url":{"type":"string","description":"Tracking URL to the product's landing page. Clicks through this URL are attributed to your partner account."},"MobileUrl":{"type":"string","description":"Optional mobile-specific tracking URL."},"ImageUrl":{"type":"string","description":"Primary product image URL."},"ProductBid":{"type":"string","description":"Brand's bid for this product, used in product-bidding programs. Empty if not applicable."},"AdditionalImageUrls":{"type":"array","description":"Additional product image URLs beyond the primary `ImageUrl`.","items":{"type":"string"}},"Promotions":{"type":"array","description":"Active promotions that apply to this product. See the Partner Promotions API for details.","items":{"type":"string"}},"CurrentPrice":{"type":"string","description":"Current selling price as a decimal string."},"OriginalPrice":{"type":"string","description":"Original (pre-discount) price as a decimal string."},"DiscountPercentage":{"type":"string","description":"Discount applied as a percentage. Empty when no discount is active."},"Currency":{"type":"string","description":"Three-letter ISO 4217 currency code for prices."},"StockAvailability":{"type":"string","enum":["InStock","OutofStock","BackOrder","PreOrder","LimitedAvailability"],"description":"Current stock status of the product."},"EstimatedShipDate":{"type":"string","description":"Estimated ship date for backorder/preorder items (ISO 8601). Empty when not applicable."},"LaunchDate":{"type":"string","description":"Date the product became available (ISO 8601). Empty when not specified."},"ExpirationDate":{"type":"string","description":"Date the product is no longer available (ISO 8601). Empty when not specified."},"Gtin":{"type":"string","description":"Global Trade Item Number for the product."},"GtinType":{"type":"string","description":"Type of GTIN (e.g., `EAN`, `UPC`, `ISBN`)."},"Asin":{"type":"string","description":"Amazon Standard Identification Number, if applicable."},"Mpn":{"type":"string","description":"Manufacturer Part Number."},"ShippingRate":{"type":"string","description":"Shipping rate for the product. Empty when shipping is calculated separately."},"ShippingWeight":{"type":"string","description":"Shipping weight value."},"ShippingWeightUnit":{"type":"string","enum":["lb","oz","g","kg","mg"],"description":"Unit for `ShippingWeight`."},"ShippingLength":{"type":"string","description":"Shipping package length."},"ShippingWidth":{"type":"string","description":"Shipping package width."},"ShippingHeight":{"type":"string","description":"Shipping package height."},"ShippingLengthUnit":{"type":"string","description":"Unit for shipping dimensions."},"ShippingLabel":{"type":"string","description":"Custom shipping label or category."},"Category":{"type":"string","description":"Standardised Google product category path."},"SubCategory":{"type":"string","description":"Optional brand-defined sub-category."},"AdvertiserFormatCategories":{"type":"array","description":"Brand-formatted category paths for the item.","items":{"type":"string"}},"OriginalFormatCategory":{"type":"string","description":"Original category path as supplied by the brand."},"OriginalFormatCategoryId":{"type":"string","description":"Original category identifier as supplied by the brand."},"ParentName":{"type":"string","description":"Display name of the parent product (for variant items)."},"ParentSku":{"type":"string","description":"SKU of the parent product (for variant items)."},"IsParent":{"type":"boolean","description":"Indicates whether this item is itself a parent product with child variants."},"ItemGroupId":{"type":"string","description":"Identifier grouping product variants under a common parent."},"Colors":{"type":"array","description":"Available colors for this product.","items":{"type":"string"}},"Material":{"type":"string","description":"Material the product is made of."},"Pattern":{"type":"string","description":"Pattern or print on the product."},"Size":{"type":"string","description":"Product size."},"SizeUnit":{"type":"string","description":"Unit for `Size`."},"Weight":{"type":"string","description":"Product weight value."},"WeightUnit":{"type":"string","description":"Unit for `Weight`."},"Condition":{"type":"string","enum":["New","Used","Refurbished","OEM","OpenBox"],"description":"Product condition."},"AgeGroup":{"type":"string","description":"Intended age group for the product."},"AgeRangeMin":{"type":"string","description":"Minimum age in the intended age range."},"AgeRangeMax":{"type":"string","description":"Maximum age in the intended age range."},"AgeRangeUnit":{"type":"string","description":"Unit for the age range."},"Gender":{"type":"string","enum":["Male","Female","Unisex",""],"description":"Intended gender for the product."},"Adult":{"type":"string","description":"Indicates whether the product is adult-only. Empty when not flagged."},"Text1":{"type":"string","description":"Brand-defined custom text attribute slot 1."},"Text2":{"type":"string","description":"Brand-defined custom text attribute slot 2."},"Text3":{"type":"string","description":"Brand-defined custom text attribute slot 3."},"Numeric1":{"type":"string","description":"Brand-defined custom numeric attribute slot 1."},"Numeric2":{"type":"string","description":"Brand-defined custom numeric attribute slot 2."},"Numeric3":{"type":"string","description":"Brand-defined custom numeric attribute slot 3."},"Money1":{"type":"string","description":"Brand-defined custom money attribute slot 1."},"Money2":{"type":"string","description":"Brand-defined custom money attribute slot 2."},"Money3":{"type":"string","description":"Brand-defined custom money attribute slot 3."},"Uri":{"type":"string","description":"API resource path to this item in the Partner Catalogs API."}}}}},"paths":{"/Mediapartners/{AccountSID}/Stores/{Id}/Group/{GroupId}/Items":{"get":{"summary":"List items in a store group","description":"Returns the catalog items belonging to the given store and group, sorted by most recently created.","operationId":"listStoreItems","tags":["Stores"],"parameters":[{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"},"description":"Unique identifier for the partner account."},{"name":"Id","in":"path","required":true,"description":"Unique identifier for the store containing the group.","schema":{"type":"string"}},{"name":"GroupId","in":"path","required":true,"description":"Unique identifier for the group whose items you want to list.","schema":{"type":"string"}},{"name":"Query","in":"query","required":false,"description":"Narrows the list by attribute (e.g., `CurrentPrice > 10.00`).","schema":{"type":"string"}}],"responses":{"200":{"description":"An array of catalog item objects.","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/CatalogItem"}}}}}}},"404":{"description":"No store or group exists with the supplied Ids."}}}}}}
```


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.