Catalog Items

List all items for a catalog

get

Returns a list of items within a specific catalog with advanced filtering and search.

Authorizations

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Your unique account identifier.

CatalogIdstringRequired

Unique identifier for the catalog.

Query parameters

KeywordstringOptional

QuerystringOptional

Complex query string (e.g., CurrentPrice > 10.00 AND Manufacturer = 'Acme'). Eligible fields: CatalogItemId, Name, Description, Labels, Manufacturer, CurrentPrice, StockAvailability, Gtin, Category, DiscountPercentage, Gender, Color, Size.

PromotionIdsstringOptional

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

SortBystringOptional

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

Responses

200

A list of items.

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 list of items.

{
  "Items": [
    {
      "CatalogItemId": "ABC123",
      "Name": "Acme Tennis Balls (One Dozen)",
      "Description": "High-performance tennis balls.",
      "CurrentPrice": 29.99,
      "OriginalPrice": 39.99,
      "Currency": "USD",
      "StockAvailability": "InStock",
      "Manufacturer": "text",
      "Url": "text",
      "ImageUrl": "text",
      "Category": "Sports",
      "Condition": "text",
      "Inventory": 1,
      "Uri": "/Advertisers/<AccountSID>/Catalogs/<CatalogId>/Items/<CatalogItemId>"
    }
  ]
}

Create an item for a catalog

post

Creates a new catalog item. Google Merchant Formatting is highly recommended.

Authorizations

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Your unique account identifier.

CatalogIdstringRequired

Unique identifier for the catalog.

Body

CatalogItemIdstringRequiredExample: ABC123

NamestringRequiredExample: Acme Tennis Balls (One Dozen)

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

DescriptionstringOptionalExample: High-performance tennis balls.

CurrentPricenumberOptionalExample: 29.99

StockAvailabilitystring · enumOptionalExample: InStockPossible values:

Responses

200

Item created.

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

Item created.

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

Retrieve an item from a catalog

get

Retrieves details of a specific item within a catalog.

Authorizations

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Your unique account identifier.

CatalogIdstringRequired

Unique identifier for the catalog.

CatalogItemIdstringRequired

Unique identifier for the catalog item.

Responses

200

Catalog item details.

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.

CurrentPricenumberOptional

Current consumer price of the item.

Example: 29.99

OriginalPricenumberOptional

Original consumer price of the item.

Example: 39.99

CurrencystringOptional

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

Example: USD

StockAvailabilitystring · enumOptional

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

Possible values:

ManufacturerstringOptional

The person or group that makes the item.

UrlstringOptional

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

ImageUrlstringOptional

URL that leads to the item's image.

CategorystringOptional

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

Example: Sports

ConditionstringOptional

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

InventoryintegerOptional

Item's inventory count.

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

Catalog item details.

{
  "CatalogItemId": "ABC123",
  "Name": "Acme Tennis Balls (One Dozen)",
  "Description": "High-performance tennis balls.",
  "CurrentPrice": 29.99,
  "OriginalPrice": 39.99,
  "Currency": "USD",
  "StockAvailability": "InStock",
  "Manufacturer": "text",
  "Url": "text",
  "ImageUrl": "text",
  "Category": "Sports",
  "Condition": "text",
  "Inventory": 1,
  "Uri": "/Advertisers/<AccountSID>/Catalogs/<CatalogId>/Items/<CatalogItemId>"
}

Update a catalog item

put

Update specific fields of an existing catalog item.

Authorizations

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Your unique account identifier.

CatalogIdstringRequired

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.

CurrentPricenumberOptional

Current consumer price of the item.

Example: 29.99

OriginalPricenumberOptional

Original consumer price of the item.

Example: 39.99

CurrencystringOptional

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

Example: USD

StockAvailabilitystring · enumOptional

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

Possible values:

ManufacturerstringOptional

The person or group that makes the item.

UrlstringOptional

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

ImageUrlstringOptional

URL that leads to the item's image.

CategorystringOptional

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

Example: Sports

ConditionstringOptional

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

InventoryintegerOptional

Item's inventory count.

Uristring · uri-referenceOptional

URI that points directly to this catalog item.

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

Responses

200

Item updated.

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

200

Item updated.

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

Delete an item for a catalog

delete

Permanently deletes a catalog item.

Authorizations

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Your unique account identifier.

CatalogIdstringRequired

Unique identifier for the catalog.

CatalogItemIdstringRequired

Unique identifier for the catalog item.

Responses

200

Item 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

Item deleted.

{
  "Status": "DELETED"
}

Bulk update items for a catalog

put

Update up to 500 products at once using a JSON array.

Authorizations

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Your unique account identifier.

CatalogIdstringRequired

Unique identifier for the catalog.

Bodyobject · CatalogItem[]

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.

CurrentPricenumberOptional

Current consumer price of the item.

Example: 29.99

OriginalPricenumberOptional

Original consumer price of the item.

Example: 39.99

CurrencystringOptional

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

Example: USD

StockAvailabilitystring · enumOptional

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

Possible values:

ManufacturerstringOptional

The person or group that makes the item.

UrlstringOptional

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

ImageUrlstringOptional

URL that leads to the item's image.

CategorystringOptional

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

Example: Sports

ConditionstringOptional

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

InventoryintegerOptional

Item's inventory count.

Uristring · uri-referenceOptional

URI that points directly to this catalog item.

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

Responses

200

Bulk update processed.

application/json

StatusstringOptionalExample: OK

UristringOptional

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

Bulk update processed.

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