Catalog Items

List Catalog Items

get

Returns a list of items for a specific catalog.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Your unique account identifier.

CatalogIdintegerRequired

Unique identifier for the catalog.

Query parameters

KeywordstringOptional

Searches for the specified word or phrase across all item attributes.

PromotionIdsstringOptional

Use 'null' to get items with no promotions, or '!=null' for items with promotions.

QuerystringOptional

Advanced query to filter items using operators. Eligible fields: CatalogItemId, Name, Description, Labels, Manufacturer, CurrentPrice, StockAvailability, Gtin, Category, DiscountPercentage, Gender, Color, Size.

SortBystringOptional

Attribute to sort the results by. Eligible fields: CatalogItemId, Name, Description, Labels, Manufacturer, CurrentPrice, StockAvailability, Gtin, Category, DiscountPercentage, Gender, Color, Size.

Responses

200

An array of catalog item objects.

application/json

get/Advertisers/{AccountSID}/Catalogs/{CatalogId}/Items

cURL

curl -L \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/Catalogs/{CatalogId}/Items' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

200

An array of catalog item objects.

{
  "Items": [
    {
      "CatalogItemId": "ABC123",
      "Name": "Acme Tennis Balls (One Dozen)",
      "Description": "High-performance tennis balls.",
      "Multipack": "1",
      "Bullets": [
        "text"
      ],
      "Labels": [
        "text"
      ],
      "Manufacturer": "Acme",
      "Url": "https://acme.example.com/product/12345",
      "MobileUrl": "https://m.acme.example.com/product/12345",
      "ImageUrl": "https://acme.example.com/images/12345.jpg",
      "AdditionalImageUrls": [
        "text"
      ],
      "PromotionIds": [
        "text"
      ],
      "CurrentPrice": 29.99,
      "OriginalPrice": 39.99,
      "DiscountPercentage": 25,
      "ManufacturingCost": 1,
      "Currency": "text",
      "StockAvailability": "InStock",
      "EstimatedShipDate": "2026-07-11",
      "LaunchDate": "2026-07-11T13:11:36.913Z",
      "ExpirationDate": "2026-07-11T13:11:36.913Z",
      "Gtin": "text",
      "GtinType": "EAN",
      "Asin": "text",
      "Mpn": "text",
      "ShippingRate": 1,
      "ShippingWeight": 1,
      "ShippingWeightUnit": "lb",
      "ShippingLength": 1,
      "ShippingWidth": 1,
      "ShippingHeight": 1,
      "ShippingLengthUnit": "in",
      "ShippingLabel": "text",
      "Category": "Sports",
      "OriginalFormatCategory": "text",
      "OriginalFormatCategoryId": 1,
      "ParentName": "text",
      "ParentSku": "text",
      "IsParent": true,
      "ItemGroupId": "text",
      "Colors": [
        "text"
      ],
      "Material": "text",
      "Pattern": "text",
      "Size": "text",
      "SizeUnit": "text",
      "Weight": 1,
      "WeightUnit": "lb",
      "Condition": "New",
      "AgeGroup": "Newborn",
      "AgeRangeMin": 1,
      "AgeRangeMax": 1,
      "AgeRangeUnit": "Months",
      "Gender": "Male",
      "Adult": true,
      "ProductBid": "text",
      "Inventory": 1,
      "Text1": "text",
      "Text2": "text",
      "Text3": "text",
      "Numeric1": 1,
      "Numeric2": 1,
      "Numeric3": 1,
      "Money1": "text",
      "Money2": "text",
      "Money3": "text",
      "Uri": "/Advertisers/<AccountSID>/Catalogs/<CatalogId>/Items/<CatalogItemId>"
    }
  ]
}

Create Catalog Item

post

Creates a new item within a specified catalog.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Your unique account identifier.

CatalogIdintegerRequired

Unique identifier for the catalog.

Body

application/json

Request body for creating a new catalog item. CatalogItemId, Name, and Url are required.

CatalogItemIdstringRequired

Unique identifier for the catalog item.

NamestringRequired

Name of the item.

DescriptionstringOptional

Description of the item — information about what it is or what it does.

UrlstringRequired

URL that leads to the item's online store listing.

CurrentPricenumber · decimalOptional

Current consumer price of the item.

StockAvailabilitystring · enumOptional

Status of the product's backstock (InStock, OutOfStock, BackOrder, PreOrder, LimitedAvailability).

Possible values:

Responses

200

Successfully created catalog item.

application/json

StatusstringOptionalExample: OK

UristringOptional

post/Advertisers/{AccountSID}/Catalogs/{CatalogId}/Items

cURL

curl -L \
  --request POST \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/Catalogs/{CatalogId}/Items' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Content-Type: application/json' \
  --header 'Accept: */*'

200

Successfully created catalog item.

{
  "Status": "OK",
  "Uri": "text"
}

Bulk Update Catalog Items

put

Performs a bulk update of up to 500 items in a catalog.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Your unique account identifier.

CatalogIdintegerRequired

Unique identifier for the catalog.

Bodyobject · CatalogItemUpdate[]

application/json

CatalogItemIdstringOptional

Unique identifier for the catalog item.

NamestringOptional

Name of the item.

DescriptionstringOptional

Description of the item — information about what it is or what it does.

UrlstringOptional

URL that leads to the item's online store listing.

CurrentPricenumber · decimalOptional

Current consumer price of the item.

StockAvailabilitystring · enumOptional

Status of the product's backstock (InStock, OutOfStock, BackOrder, PreOrder, LimitedAvailability).

Possible values:

Responses

200

Successfully queued bulk update.

application/json

StatusstringOptionalExample: OK

UristringOptional

put/Advertisers/{AccountSID}/Catalogs/{CatalogId}/Items

cURL

curl -L \
  --request PUT \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/Catalogs/{CatalogId}/Items' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Content-Type: application/json' \
  --header 'Accept: */*'

200

Successfully queued bulk update.

{
  "Status": "OK",
  "Uri": "text"
}

Retrieve a Catalog Item

get

Retrieves the details of an existing catalog item.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Your unique account identifier.

CatalogIdintegerRequired

Unique identifier for the catalog.

CatalogItemIdstringRequired

Unique identifier for the catalog item.

Responses

200

A catalog item object.

application/json

CatalogItemIdstringOptional

Unique identifier for the catalog item.

Example: ABC123

NamestringOptional

Name of the item.

Example: Acme Tennis Balls (One Dozen)

DescriptionstringOptional

Description of the item — information about what it is or what it does.

Example: High-performance tennis balls.

Multipackstring · enumOptional

Whether the item represents a merchant-defined multi-pack (YES/NO).

Example: 1Possible values:

Bulletsstring[]Optional

Short bullet descriptions of the product.

Labelsstring[]Optional

Key terms to help partners find the item.

ManufacturerstringOptional

The person or group that makes the item.

Example: Acme

UrlstringOptional

URL that leads to the item's online store listing.

Example: https://acme.example.com/product/12345

MobileUrlstringOptional

URI that points directly to the item's mobile listing.

Example: https://m.acme.example.com/product/12345

ImageUrlstringOptional

URL that leads to the item's image.

Example: https://acme.example.com/images/12345.jpg

AdditionalImageUrlsstring[]Optional

List of additional image URLs for the product.

PromotionIdsstring[]Optional

List of promotion Ids that identify the item as part of a promotion.

CurrentPricenumber · decimalOptional

Current consumer price of the item.

Example: 29.99

OriginalPricenumber · decimalOptional

Original consumer price of the item.

Example: 39.99

DiscountPercentageintegerOptional

Percent discount a consumer can get when they purchase the product.

Example: 25

ManufacturingCostnumber · decimalOptional

Cost to produce the item.

CurrencystringOptional

Currency in which the item's price is listed (ISO 4217).

StockAvailabilitystring · enumOptional

Status of the product's backstock (InStock, OutOfStock, BackOrder, PreOrder, LimitedAvailability).

Possible values:

EstimatedShipDatestring · dateOptional

Date the item will begin shipping (ISO 8601).

LaunchDatestring · date-timeOptional

Date the item becomes (or became) available (ISO 8601).

ExpirationDatestring · date-timeOptional

Date the item will be removed from the catalog (ISO 8601).

GtinstringOptional

GtinTypestring · enumOptional

Type of GTIN number the item uses (EAN, UPC, ISBN, JAN).

Possible values:

AsinstringOptional

Item's Amazon Standard Identification Number.

MpnstringOptional

ShippingRatenumber · decimalOptional

Standard rate to ship the item.

ShippingWeightnumber · decimalOptional

Weight of the shipping parcel.

ShippingWeightUnitstring · enumOptional

Unit for the shipping parcel's weight (lb, oz, g, kg, mg).

Possible values:

ShippingLengthnumber · decimalOptional

Length of the shipping parcel.

ShippingWidthnumber · decimalOptional

Width of the shipping parcel.

ShippingHeightnumber · decimalOptional

Height of the shipping parcel.

ShippingLengthUnitstring · enumOptional

Unit for the shipping parcel's dimensions (in, cm).

Possible values:

ShippingLabelstringOptional

Label of the shipping parcel.

CategorystringOptional

Group or kind of products with which the item is associated.

Example: Sports

OriginalFormatCategorystringOptional

Category breadcrumb used to locate the item.

OriginalFormatCategoryIdintegerOptional

Id of the category the item is in.

ParentNamestringOptional

If the item has a parent item, the parent item's name.

ParentSkustringOptional

If the item has a parent item, the parent item's SKU.

IsParentbooleanOptional

Whether this item represents a bundle of items.

ItemGroupIdstringOptional

Groups product variants that only differ by attributes like size, color, pattern, age group, or gender.

Colorsstring[]Optional

Primary colors of the item.

MaterialstringOptional

Primary material of the item.

PatternstringOptional

Pattern of the item.

SizestringOptional

Numerical size of the item.

SizeUnitstringOptional

Item's size unit of measurement (e.g., Inches, Centimeters, Pounds, Kilograms).

Weightnumber · decimalOptional

Weight of the item.

WeightUnitstring · enumOptional

Item's weight unit of measurement (lb, oz, g, kg, mg).

Possible values:

Conditionstring · enumOptional

Condition the item is in when sold (New, Used, Refurbished, OEM, OpenBox).

Possible values:

AgeGroupstring · enumOptional

Age group the item targets (Newborn, Infant, Toddler, Kids, Adult).

Possible values:

AgeRangeMinintegerOptional

Minimum age for whom the item is intended.

AgeRangeMaxintegerOptional

Maximum age for whom the item is intended.

AgeRangeUnitstring · enumOptional

Unit of the age range (Months, Years).

Possible values:

Genderstring · enumOptional

Gender for whom the item is intended (Male, Female, Unisex).

Possible values:

AdultbooleanOptional

Whether the item is only intended for adults.

ProductBidstringOptional

How much the partner will be paid for driving a conversion on the product.

InventoryintegerOptional

Item's inventory count.

Text1stringOptional

General text field that accepts any text data you want to send. Appears in your reports.

Text2stringOptional

General text field that accepts any text data you want to send. Appears in your reports.

Text3stringOptional

General text field that accepts any text data you want to send. Appears in your reports.

Numeric1number · decimalOptional

General numeral field that accepts any numeric data you want to send. Appears in your reports.

Numeric2number · decimalOptional

General numeral field that accepts any numeric data you want to send. Appears in your reports.

Numeric3number · decimalOptional

General numeral field that accepts any numeric data you want to send. Appears in your reports.

Money1stringOptional

General numeral field that accepts any money or financial data you want to send. Appears in your reports.

Money2stringOptional

General numeral field that accepts any money or financial data you want to send. Appears in your reports.

Money3stringOptional

General numeral field that accepts any money or financial data you want to send. Appears in your reports.

UristringOptional

URI that points directly to this catalog item.

Example: /Advertisers/<AccountSID>/Catalogs/<CatalogId>/Items/<CatalogItemId>

get/Advertisers/{AccountSID}/Catalogs/{CatalogId}/Items/{CatalogItemId}

cURL

curl -L \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/Catalogs/{CatalogId}/Items/{CatalogItemId}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

200

A catalog item object.

{
  "CatalogItemId": "ABC123",
  "Name": "Acme Tennis Balls (One Dozen)",
  "Description": "High-performance tennis balls.",
  "Multipack": "1",
  "Bullets": [
    "text"
  ],
  "Labels": [
    "text"
  ],
  "Manufacturer": "Acme",
  "Url": "https://acme.example.com/product/12345",
  "MobileUrl": "https://m.acme.example.com/product/12345",
  "ImageUrl": "https://acme.example.com/images/12345.jpg",
  "AdditionalImageUrls": [
    "text"
  ],
  "PromotionIds": [
    "text"
  ],
  "CurrentPrice": 29.99,
  "OriginalPrice": 39.99,
  "DiscountPercentage": 25,
  "ManufacturingCost": 1,
  "Currency": "text",
  "StockAvailability": "InStock",
  "EstimatedShipDate": "2026-07-11",
  "LaunchDate": "2026-07-11T13:11:36.913Z",
  "ExpirationDate": "2026-07-11T13:11:36.913Z",
  "Gtin": "text",
  "GtinType": "EAN",
  "Asin": "text",
  "Mpn": "text",
  "ShippingRate": 1,
  "ShippingWeight": 1,
  "ShippingWeightUnit": "lb",
  "ShippingLength": 1,
  "ShippingWidth": 1,
  "ShippingHeight": 1,
  "ShippingLengthUnit": "in",
  "ShippingLabel": "text",
  "Category": "Sports",
  "OriginalFormatCategory": "text",
  "OriginalFormatCategoryId": 1,
  "ParentName": "text",
  "ParentSku": "text",
  "IsParent": true,
  "ItemGroupId": "text",
  "Colors": [
    "text"
  ],
  "Material": "text",
  "Pattern": "text",
  "Size": "text",
  "SizeUnit": "text",
  "Weight": 1,
  "WeightUnit": "lb",
  "Condition": "New",
  "AgeGroup": "Newborn",
  "AgeRangeMin": 1,
  "AgeRangeMax": 1,
  "AgeRangeUnit": "Months",
  "Gender": "Male",
  "Adult": true,
  "ProductBid": "text",
  "Inventory": 1,
  "Text1": "text",
  "Text2": "text",
  "Text3": "text",
  "Numeric1": 1,
  "Numeric2": 1,
  "Numeric3": 1,
  "Money1": "text",
  "Money2": "text",
  "Money3": "text",
  "Uri": "/Advertisers/<AccountSID>/Catalogs/<CatalogId>/Items/<CatalogItemId>"
}

Update a Catalog Item

put

Updates a single specified catalog item.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Your unique account identifier.

CatalogIdintegerRequired

Unique identifier for the catalog.

CatalogItemIdstringRequired

Unique identifier for the catalog item.

Body

application/x-www-form-urlencoded

CatalogItemIdstringOptional

Unique identifier for the catalog item.

NamestringOptional

Name of the item.

DescriptionstringOptional

Description of the item — information about what it is or what it does.

UrlstringOptional

URL that leads to the item's online store listing.

CurrentPricenumber · decimalOptional

Current consumer price of the item.

StockAvailabilitystring · enumOptional

Status of the product's backstock (InStock, OutOfStock, BackOrder, PreOrder, LimitedAvailability).

Possible values:

Responses

200

Successfully updated catalog item.

application/json

StatusstringOptionalExample: OK

UristringOptional

put/Advertisers/{AccountSID}/Catalogs/{CatalogId}/Items/{CatalogItemId}

cURL

curl -L \
  --request PUT \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/Catalogs/{CatalogId}/Items/{CatalogItemId}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'Accept: */*'

200

Successfully updated catalog item.

{
  "Status": "OK",
  "Uri": "text"
}

Delete a Catalog Item

delete

Permanently deletes a catalog item. This cannot be undone.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Your unique account identifier.

CatalogIdintegerRequired

Unique identifier for the catalog.

CatalogItemIdstringRequired

Unique identifier for the catalog item.

Responses

200

The item was successfully deleted.

application/json

StatusstringOptionalExample: DELETED

delete/Advertisers/{AccountSID}/Catalogs/{CatalogId}/Items/{CatalogItemId}

cURL

curl -L \
  --request DELETE \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/Catalogs/{CatalogId}/Items/{CatalogItemId}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

200

The item was successfully deleted.

{
  "Status": "DELETED"
}