# Models

## The Catalog object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Product Catalogs","version":"v12"},"components":{"schemas":{"Catalog":{"type":"object","properties":{"Id":{"type":"string","description":"Unique identifier for the catalog (the impact.com Catalog Id)."},"Name":{"type":"string","description":"Name of the catalog."},"Filename":{"type":"string","description":"Name of the file that contains the catalog."},"AdvertiserId":{"type":"integer","description":"Id of the brand (formerly known as advertiser) that owns the catalog."},"CampaignId":{"type":"integer","description":"Id of the program (formerly known as campaign) to which the catalog belongs."},"Status":{"type":"string","enum":["ACTIVE","CLOSED","DEACTIVATED","PENDING"],"description":"State of use the catalog is in (e.g., `ACTIVE`, `CLOSED`, `DEACTIVATED`, `PENDING`)."},"NumberOfItems":{"type":"integer","description":"Number of items in the catalog."},"DateLastUpdated":{"type":"string","format":"date-time","description":"Date and time the catalog was last updated (ISO 8601)."},"Currency":{"type":"string","description":"Currency in which the items' prices are listed. See ISO 4217."},"ServiceAreas":{"type":"array","items":{"type":"string"},"description":"List of geographical areas targeted by the catalog."},"UploadMethod":{"type":"string","enum":["DIRECT_UPLOAD","IMPACT_RADIUS_FTP_SERVER","IR_SFTP","PULL_FROM_URL","SHOPPING_CART_PULL"],"description":"How the catalog was uploaded (e.g., `DIRECT_UPLOAD`, `IR_SFTP`, `SHOPPING_CART_PULL`)."},"ShoppingCart":{"type":"object","properties":{"ShoppingCartType":{"type":"string","enum":["SHOPIFY","MAGENTO","BIGCOMMERCE","WOOCOMMERCE","SHOPLAZZA"]},"BaseUrl":{"type":"string"},"CollectionIds":{"type":"array","items":{"type":"string"}},"CollectionTitles":{"type":"array","items":{"type":"string"}}},"description":"Shopping-cart connection details. Only returned when `UploadMethod` is `SHOPPING_CART_PULL`."},"ItemsUri":{"type":"string","description":"URI to view this catalog's items."},"Uri":{"type":"string","description":"Direct URI to this catalog."}}}}}}
```

## The CatalogItem object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Product Catalogs","version":"v12"},"components":{"schemas":{"CatalogItem":{"type":"object","properties":{"CatalogItemId":{"type":"string","description":"Unique identifier for the catalog item."},"Name":{"type":"string","description":"Name of the item."},"Description":{"type":"string","description":"Description of the item — information about what it is or what it does."},"Multipack":{"type":"string","enum":[true,false],"description":"Whether the item represents a merchant-defined multi-pack (`YES`/`NO`)."},"Bullets":{"type":"array","items":{"type":"string"},"description":"Short bullet descriptions of the product."},"Labels":{"type":"array","items":{"type":"string"},"description":"Key terms to help partners find the item."},"Manufacturer":{"type":"string","description":"The person or group that makes the item."},"Url":{"type":"string","description":"URL that leads to the item's online store listing."},"MobileUrl":{"type":"string","description":"URI that points directly to the item's mobile listing."},"ImageUrl":{"type":"string","description":"URL that leads to the item's image."},"AdditionalImageUrls":{"type":"array","items":{"type":"string"},"description":"List of additional image URLs for the product."},"PromotionIds":{"type":"array","items":{"type":"string"},"description":"List of promotion Ids that identify the item as part of a promotion."},"CurrentPrice":{"type":"number","format":"decimal","description":"Current consumer price of the item."},"OriginalPrice":{"type":"number","format":"decimal","description":"Original consumer price of the item."},"DiscountPercentage":{"type":"integer","description":"Percent discount a consumer can get when they purchase the product."},"ManufacturingCost":{"type":"number","format":"decimal","description":"Cost to produce the item."},"Currency":{"type":"string","description":"Currency in which the item's price is listed (ISO 4217)."},"StockAvailability":{"type":"string","enum":["InStock","OutOfStock","BackOrder","PreOrder","LimitedAvailability"],"description":"Status of the product's backstock (`InStock`, `OutOfStock`, `BackOrder`, `PreOrder`, `LimitedAvailability`)."},"EstimatedShipDate":{"type":"string","format":"date","description":"Date the item will begin shipping (ISO 8601)."},"LaunchDate":{"type":"string","format":"date-time","description":"Date the item becomes (or became) available (ISO 8601)."},"ExpirationDate":{"type":"string","format":"date-time","description":"Date the item will be removed from the catalog (ISO 8601)."},"Gtin":{"type":"string"},"GtinType":{"type":"string","enum":["EAN","UPC","ISBN","JAN"],"description":"Type of GTIN number the item uses (`EAN`, `UPC`, `ISBN`, `JAN`)."},"Asin":{"type":"string","description":"Item's Amazon Standard Identification Number."},"Mpn":{"type":"string"},"ShippingRate":{"type":"number","format":"decimal","description":"Standard rate to ship the item."},"ShippingWeight":{"type":"number","format":"decimal","description":"Weight of the shipping parcel."},"ShippingWeightUnit":{"type":"string","enum":["lb","oz","g","kg","mg"],"description":"Unit for the shipping parcel's weight (`lb`, `oz`, `g`, `kg`, `mg`)."},"ShippingLength":{"type":"number","format":"decimal","description":"Length of the shipping parcel."},"ShippingWidth":{"type":"number","format":"decimal","description":"Width of the shipping parcel."},"ShippingHeight":{"type":"number","format":"decimal","description":"Height of the shipping parcel."},"ShippingLengthUnit":{"type":"string","enum":["in","cm"],"description":"Unit for the shipping parcel's dimensions (`in`, `cm`)."},"ShippingLabel":{"type":"string","description":"Label of the shipping parcel."},"Category":{"type":"string","description":"Group or kind of products with which the item is associated."},"OriginalFormatCategory":{"type":"string","description":"Category breadcrumb used to locate the item."},"OriginalFormatCategoryId":{"type":"integer","description":"Id of the category the item is in."},"ParentName":{"type":"string","description":"If the item has a parent item, the parent item's name."},"ParentSku":{"type":"string","description":"If the item has a parent item, the parent item's SKU."},"IsParent":{"type":"boolean","description":"Whether this item represents a bundle of items."},"ItemGroupId":{"type":"string","description":"Groups product variants that only differ by attributes like size, color, pattern, age group, or gender."},"Colors":{"type":"array","items":{"type":"string"},"description":"Primary colors of the item."},"Material":{"type":"string","description":"Primary material of the item."},"Pattern":{"type":"string","description":"Pattern of the item."},"Size":{"type":"string","description":"Numerical size of the item."},"SizeUnit":{"type":"string","description":"Item's size unit of measurement (e.g., `Inches`, `Centimeters`, `Pounds`, `Kilograms`)."},"Weight":{"type":"number","format":"decimal","description":"Weight of the item."},"WeightUnit":{"type":"string","enum":["lb","oz","g","kg","mg"],"description":"Item's weight unit of measurement (`lb`, `oz`, `g`, `kg`, `mg`)."},"Condition":{"type":"string","enum":["New","Used","Refurbished","OEM","OpenBox"],"description":"Condition the item is in when sold (`New`, `Used`, `Refurbished`, `OEM`, `OpenBox`)."},"AgeGroup":{"type":"string","enum":["Newborn","Infant","Toddler","Kids","Adult"],"description":"Age group the item targets (`Newborn`, `Infant`, `Toddler`, `Kids`, `Adult`)."},"AgeRangeMin":{"type":"integer","description":"Minimum age for whom the item is intended."},"AgeRangeMax":{"type":"integer","description":"Maximum age for whom the item is intended."},"AgeRangeUnit":{"type":"string","enum":["Months","Years"],"description":"Unit of the age range (`Months`, `Years`)."},"Gender":{"type":"string","enum":["Male","Female","Unisex"],"description":"Gender for whom the item is intended (`Male`, `Female`, `Unisex`)."},"Adult":{"type":"boolean","description":"Whether the item is only intended for adults."},"ProductBid":{"type":"string","description":"How much the partner will be paid for driving a conversion on the product."},"Inventory":{"type":"integer","description":"Item's inventory count."},"Text1":{"type":"string","description":"General text field that accepts any text data you want to send. Appears in your reports."},"Text2":{"type":"string","description":"General text field that accepts any text data you want to send. Appears in your reports."},"Text3":{"type":"string","description":"General text field that accepts any text data you want to send. Appears in your reports."},"Numeric1":{"type":"number","format":"decimal","description":"General numeral field that accepts any numeric data you want to send. Appears in your reports."},"Numeric2":{"type":"number","format":"decimal","description":"General numeral field that accepts any numeric data you want to send. Appears in your reports."},"Numeric3":{"type":"number","format":"decimal","description":"General numeral field that accepts any numeric data you want to send. Appears in your reports."},"Money1":{"type":"string","description":"General numeral field that accepts any money or financial data you want to send. Appears in your reports."},"Money2":{"type":"string","description":"General numeral field that accepts any money or financial data you want to send. Appears in your reports."},"Money3":{"type":"string","description":"General numeral field that accepts any money or financial data you want to send. Appears in your reports."},"Uri":{"type":"string","description":"URI that points directly to this catalog item."}}}}}}
```

## The CatalogItemUpdate object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Product Catalogs","version":"v12"},"components":{"schemas":{"CatalogItemUpdate":{"type":"object","properties":{"CatalogItemId":{"type":"string","description":"Unique identifier for the catalog item."},"Name":{"type":"string","description":"Name of the item."},"Description":{"type":"string","description":"Description of the item — information about what it is or what it does."},"Url":{"type":"string","description":"URL that leads to the item's online store listing."},"CurrentPrice":{"type":"number","format":"decimal","description":"Current consumer price of the item."},"StockAvailability":{"type":"string","enum":["InStock","OutOfStock","BackOrder","PreOrder","LimitedAvailability"],"description":"Status of the product's backstock (`InStock`, `OutOfStock`, `BackOrder`, `PreOrder`, `LimitedAvailability`)."}}}}}}
```


---

# 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/brand-api-reference/brand-api-reference-v12/reference/catalogs/models.md?ask=<question>
```

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.