Catalog Items

List Catalog Items

get

Returns a list of items for a specific catalog, with support for keyword search, filtering, and sorting. This endpoint has a paging limit of 20,000 total records.

Authorizations

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

Search for a word or phrase across all item attributes.

PromotionIdsstringOptional

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

QuerystringOptional

Advanced search query using operators like '>', '<', '=', '!=', '~', 'AND', 'OR', 'IN'. Eligible fields: CatalogItemId, Name, Description, Labels, Manufacturer, CurrentPrice, StockAvailability, Gtin, Category, DiscountPercentage, Gender, Color, Size.

SortBystringOptional

Sort results by a specific attribute (e.g., 'CurrentPrice'). Use SortOrder for direction. Eligible fields: CatalogItemId, Name, Description, Labels, Manufacturer, CurrentPrice, StockAvailability, Gtin, Category, DiscountPercentage, Gender, Color, Size.

Responses

200

A paginated list 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

A paginated list 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-06-10",
      "LaunchDate": "2026-06-10T11:08:32.014Z",
      "ExpirationDate": "2026-06-10T11:08:32.014Z",
      "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": "text",
      "OriginalFormatCategory": "text",
      "OriginalFormatCategoryId": "text",
      "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 a Catalog Item

post

Creates a new item within a specified catalog.

Authorizations

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

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

CatalogItemIdstringRequired

Unique identifier for the catalog item.

Example: ABC123

NamestringRequired

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.

MultipackstringOptional

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

Example: 1

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

Urlstring · uriRequired

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

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

MobileUrlstring · uriOptional

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

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

ImageUrlstring · uriOptional

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

Global Trade Item Number.

GtinTypestring · enumOptional

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

Possible values:

AsinstringOptional

Item's Amazon Standard Identification Number.

MpnstringOptional

Manufacturing Part Number.

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.

OriginalFormatCategorystringOptional

Category breadcrumb used to locate the item.

OriginalFormatCategoryIdstringOptional

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.

Uristring · uri-referenceOptional

URI that points directly to this catalog item.

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

Responses

200

The request was successful.

application/json

StatusstringOptional

Indicates whether the operation was successful (e.g., OK).

Example: OK

Uristring · uri-referenceOptional

URI of the affected resource.

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/x-www-form-urlencoded' \
  --header 'Accept: */*'

200

The request was successful.

{
  "Status": "OK",
  "Uri": "../folder"
}

Get Catalog Item Details

get

Retrieves the details of an existing catalog item by its unique ID.

Authorizations

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 single 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.

MultipackstringOptional

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

Example: 1

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

Urlstring · uriOptional

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

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

MobileUrlstring · uriOptional

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

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

ImageUrlstring · uriOptional

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

Global Trade Item Number.

GtinTypestring · enumOptional

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

Possible values:

AsinstringOptional

Item's Amazon Standard Identification Number.

MpnstringOptional

Manufacturing Part Number.

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.

OriginalFormatCategorystringOptional

Category breadcrumb used to locate the item.

OriginalFormatCategoryIdstringOptional

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.

Uristring · uri-referenceOptional

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 single 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-06-10",
  "LaunchDate": "2026-06-10T11:08:32.014Z",
  "ExpirationDate": "2026-06-10T11:08:32.014Z",
  "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": "text",
  "OriginalFormatCategory": "text",
  "OriginalFormatCategoryId": "text",
  "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 Single Catalog Item

put

Updates a single specified catalog item by setting the values of the parameters passed.

Authorizations

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

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.

MultipackstringOptional

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

Example: 1

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

Urlstring · uriOptional

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

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

MobileUrlstring · uriOptional

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

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

ImageUrlstring · uriOptional

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

Global Trade Item Number.

GtinTypestring · enumOptional

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

Possible values:

AsinstringOptional

Item's Amazon Standard Identification Number.

MpnstringOptional

Manufacturing Part Number.

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.

OriginalFormatCategorystringOptional

Category breadcrumb used to locate the item.

OriginalFormatCategoryIdstringOptional

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.

Uristring · uri-referenceOptional

URI that points directly to this catalog item.

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

Responses

200

The request was successful.

application/json

StatusstringOptional

Indicates whether the operation was successful (e.g., OK).

Example: OK

Uristring · uri-referenceOptional

URI of the affected resource.

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/json' \
  --header 'Accept: */*'

200

The request was successful.

{
  "Status": "OK",
  "Uri": "../folder"
}

Delete a Catalog Item

delete

Permanently deletes a catalog item. This cannot be undone.

Authorizations

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 deleted successfully.

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 deleted successfully.

{
  "Status": "DELETED"
}

Bulk Update Catalog Items

put

Updates multiple catalog items in a single request. The request body must be a JSON array of item objects, with each object containing its CatalogItemId. A maximum of 500 products can be updated per call.

Authorizations

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[]

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.

MultipackstringOptional

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

Example: 1

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

Urlstring · uriOptional

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

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

MobileUrlstring · uriOptional

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

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

ImageUrlstring · uriOptional

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

Global Trade Item Number.

GtinTypestring · enumOptional

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

Possible values:

AsinstringOptional

Item's Amazon Standard Identification Number.

MpnstringOptional

Manufacturing Part Number.

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.

OriginalFormatCategorystringOptional

Category breadcrumb used to locate the item.

OriginalFormatCategoryIdstringOptional

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.

Uristring · uri-referenceOptional

URI that points directly to this catalog item.

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

Responses

200

The request was successful.

application/json

StatusstringOptional

Indicates whether the operation was successful (e.g., OK).

Example: OK

Uristring · uri-referenceOptional

URI of the affected resource.

put

/Advertisers/{AccountSID}/Catalogs/{CatalogId}/BulkUpdate

cURL

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

200

The request was successful.

{
  "Status": "OK",
  "Uri": "../folder"
}

PreviousCatalogs NextModels

Last updated 5 days ago