# Models ## The Catalog object ```json {"openapi":"3.1.0","info":{"title":"Partner Catalogs API","version":"16"},"components":{"schemas":{"Catalog":{"type":"object","properties":{"Id":{"type":"string","description":"Unique identifier for the catalog."},"Name":{"type":"string","description":"Display name of the catalog."},"Language":{"type":"string","description":"Language of the catalog content."},"AdvertiserId":{"type":"string","description":"Unique identifier for the brand's advertiser account."},"AdvertiserName":{"type":"string","description":"Display name of the brand."},"AdvertiserLocation":{"type":"string","description":"Geographic location of the advertiser."},"CampaignId":{"type":"string","description":"Unique identifier for the campaign (brand program) associated with the catalog."},"CampaignName":{"type":"string","description":"Display name of the campaign associated with the catalog."},"NumberOfItems":{"type":"string","description":"The number of items currently in the catalog."},"DateLastUpdated":{"type":"string","format":"date-time","description":"The date and time the catalog was last updated (ISO 8601)."},"Locations":{"type":"array","description":"Download paths for catalog files.","items":{"type":"string"}},"Currency":{"type":"string","description":"ISO 4217 currency code for the catalog's pricing."},"ServiceAreas":{"type":"string","description":"Geographic regions the catalog serves."},"FTPLocations":{"type":"array","description":"FTP access paths for catalog files. Includes authentication credentials — handle securely.","items":{"type":"string"}},"ItemsUri":{"type":"string","description":"API resource path for the catalog's items."},"Uri":{"type":"string","description":"Unique reference to the catalog object in the impact.com API."}}}}}} ``` ## The Item object ```json {"openapi":"3.1.0","info":{"title":"Partner Catalogs API","version":"16"},"components":{"schemas":{"Item":{"type":"object","properties":{"Id":{"type":"string","description":"Unique identifier for the catalog item, combining the catalog ID and the brand's item ID."},"CatalogId":{"type":"string","description":"Unique identifier for the catalog this item belongs to."},"CampaignId":{"type":"string","description":"Unique identifier for the campaign associated with this item."},"CampaignName":{"type":"string","description":"Display name of the campaign associated with this item."},"CatalogItemId":{"type":"string","description":"The brand's own identifier for this item within the catalog."},"Name":{"type":"string","description":"Product name."},"Description":{"type":"string","description":"Product description."},"MultiPack":{"type":"string","description":"Indicates if this is a multi-pack product and the quantity included."},"Bullets":{"type":"array","description":"Bullet-point product highlights.","items":{"type":"string"}},"Labels":{"type":"array","description":"Labels assigned to the item.","items":{"type":"string"}},"Manufacturer":{"type":"string","description":"The manufacturer of the product."},"Url":{"type":"string","format":"uri","description":"Tracking URL for the product page, unique to your partner account."},"MobileUrl":{"type":"string","format":"uri","description":"Mobile-optimized tracking URL for the product page."},"ImageUrl":{"type":"string","format":"uri","description":"URL to the primary product image."},"ProductBid":{"type":"string","description":"Bid value for the product in automated campaigns."},"AdditionalImageUrls":{"type":"array","description":"Additional product image URLs.","items":{"type":"string","format":"uri"}},"Promotions":{"type":"array","description":"Promotions that apply to this item. Each entry is a summary of a promotion from the Partner Promotions API.","items":{"type":"object","properties":{"AdvertiserId":{"type":"string","description":"Unique identifier of the brand offering the promotion."},"AdvertiserName":{"type":"string","description":"Name of the brand offering the promotion."},"PromotionFileId":{"type":"string","description":"Unique identifier of the promotion file (upload batch) that this promotion was loaded from."},"PromotionIds":{"type":"string","description":"Unique identifier for the promotion. Despite the plural name, this is a single ID — use it as the path `Id` in the Partner Promotions API."},"PromotionTitle":{"type":"string","description":"Marketing headline for the promotion."},"GenericRedemptionCode":{"type":"string","description":"Promo code that customers apply at checkout to redeem the promotion. Empty when the promotion has no code or is auto-applied."},"PromotionEffectiveDates":{"type":"string","description":"Date range during which the promotion is active, in ISO 8601 interval format `/`."},"Uri":{"type":"string","description":"Unique reference to this promotion in the Partner Promotions API."}}}},"CurrentPrice":{"type":"string","description":"Current selling price of the item."},"OriginalPrice":{"type":"string","description":"Original price before any discounts."},"DiscountPercentage":{"type":"string","description":"Discount percentage applied to the item."},"Currency":{"type":"string","description":"ISO 4217 currency code for the item's pricing."},"StockAvailability":{"type":"string","description":"Current inventory status of the item (e.g., InStock, OutOfStock, PreOrder)."},"EstimatedShipDate":{"type":"string","format":"date-time","description":"Estimated shipping date for the item."},"LaunchDate":{"type":"string","format":"date-time","description":"Date the product was launched."},"ExpirationDate":{"type":"string","format":"date-time","description":"Date the product listing expires."},"Gtin":{"type":"string","description":"Global Trade Item Number (barcode) for the product."},"GtinType":{"type":"string","description":"The type of GTIN provided (e.g., EAN, UPC, ISBN, JAN)."},"Asin":{"type":"string","description":"Amazon Standard Identification Number."},"Mpn":{"type":"string","description":"Manufacturer Part Number."},"ShippingRate":{"type":"string","description":"Shipping cost for the item."},"ShippingWeight":{"type":"string","description":"Weight of the packaged item for shipping."},"ShippingWeightUnit":{"type":"string","description":"Unit of measurement for the shipping weight (e.g., kg, lb)."},"ShippingLength":{"type":"string","description":"Length of the packaged item for shipping."},"ShippingWidth":{"type":"string","description":"Width of the packaged item for shipping."},"ShippingHeight":{"type":"string","description":"Height of the packaged item for shipping."},"ShippingLengthUnit":{"type":"string","description":"Unit of measurement for shipping dimensions (e.g., cm, in)."},"ShippingLabel":{"type":"string","description":"Shipping label or carrier information."},"Category":{"type":"string","description":"Product category hierarchy."},"SubCategory":{"type":"string","description":"Product subcategory."},"AdvertiserFormatCategories":{"type":"array","description":"Categories in the advertiser's own taxonomy format.","items":{"type":"string"}},"OriginalFormatCategory":{"type":"string","description":"Category as provided in the original catalog feed format."},"OriginalFormatCategoryId":{"type":"string","description":"Identifier for the original format category."},"ParentName":{"type":"string","description":"Name of the parent product if this item is a variant."},"ParentSku":{"type":"string","description":"SKU of the parent product if this item is a variant."},"IsParent":{"type":"boolean","description":"Whether this item is a parent product that has variants."},"ItemGroupId":{"type":"string","description":"Identifier grouping this item with its variants."},"Colors":{"type":"array","description":"Available colors for the item.","items":{"type":"string"}},"Material":{"type":"string","description":"Material the item is made of."},"Pattern":{"type":"string","description":"Pattern or design of the item."},"Size":{"type":"string","description":"Size of the item."},"SizeUnit":{"type":"string","description":"Unit of measurement for the item's size."},"Weight":{"type":"string","description":"Weight of the item."},"WeightUnit":{"type":"string","description":"Unit of measurement for the item's weight (e.g., kg, lb)."},"Condition":{"type":"string","description":"Condition of the item (e.g., New, Used, Refurbished)."},"AgeGroup":{"type":"string","description":"Target age group for the item (e.g., Adult, Kids, Infant)."},"AgeRangeMin":{"type":"string","description":"Minimum age in the target age range."},"AgeRangeMax":{"type":"string","description":"Maximum age in the target age range."},"AgeRangeUnit":{"type":"string","description":"Unit for the age range values (e.g., years, months)."},"Gender":{"type":"string","description":"Target gender for the item (e.g., Male, Female, Unisex)."},"Adult":{"type":"string","description":"Whether the item is intended for adults only."},"Text1":{"type":"string","description":"Custom text field 1, defined by the brand."},"Text2":{"type":"string","description":"Custom text field 2, defined by the brand."},"Text3":{"type":"string","description":"Custom text field 3, defined by the brand."},"Numeric1":{"type":"string","description":"Custom numeric field 1, defined by the brand."},"Numeric2":{"type":"string","description":"Custom numeric field 2, defined by the brand."},"Numeric3":{"type":"string","description":"Custom numeric field 3, defined by the brand."},"Money1":{"type":"string","description":"Custom monetary field 1, defined by the brand."},"Money2":{"type":"string","description":"Custom monetary field 2, defined by the brand."},"Money3":{"type":"string","description":"Custom monetary field 3, defined by the brand."},"Uri":{"type":"string","description":"Unique reference to the catalog item in the impact.com API."}}}}}} ``` --- # Agent Instructions: 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: ``` GET https://integrations.impact.com/partner-api-reference/reference/catalogs/models.md?ask= ``` The question should be specific, self-contained, and written in natural language. 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.