HomeGuidesAPI ReferenceAPI Changelog
Log In
API Reference
Start typing to search…

The catalog object

The catalog object holds information for the product catalogs in your program, but not the items within a specific product catalog. You can retrieve a product catalog's information object and list all product catalog information objects.

Attributes

Id integer

Unique identifier for the object referred to as the impact.com Catalog Id.

Name string

Name of the catalog.

Filename string

Name of the file that contains the catalog.

AdvertiserId integer

Id of the brand (formerly known as advertiser) that owns the catalog.

CampaignId integer

Id of the program (formerly known as campaign) to which the catalog belongs.

Status enum

What state of use the catalog is in.

View possible enum values
ACTIVELive catalogs that partners can view.
CLOSEDProduct catalogs that are closed.
DEACTIVATEDProduct catalogs that were deactivated by an account user.
PENDINGProduct catalogs that are still pending activation.

NumberOfItems integer

Amount of items in the catalog.

DateLastUpdated string

Date and time the catalog was last updated. See ISO 8601.

Currency string

The currency in which the item's price is listed. See ISO 4217.

ServiceAreas array

A list of the geographical areas targeted by the product catalog. Contains individual ServiceAreas for the catalog, which are strings.

UploadMethod enum

How the catalog was uploaded to impact.com.

View possible enum values
DIRECT_UPLOADThe catalog was uploaded directly to impact.com.
IMPACT_RADIUS_FTP_SERVERimpact.com retrieved the catalog using an FTP server call.
IR_SFTPimpact.com retrieved the catalog using a secure FTP server call.
PULL_FROM_URLimpact.com retrieved the catalog from a provided URL.
SHOPPING_CART_PULLimpact.com retrieved the catalog from a shopping cart integration.

ShoppingCart object

An object returned from the Retrieve a catalog and List all catalogs endpoints. This object will only be returned for catalogs with UploadMethod set to SHOPPING_CART_PULL.

"ShoppingCart": {
    "ShoppingCartType": "SHOPIFY",
    "BaseUrl": "https://example.myshopify.com",
    "CollectionIds": [
        "123456789123",
        "987654321987"
    ],
    "CollectionTitles": [
        "Example Collection 1",
        "Example Collection 2"
    ]
}

Field

Definition

ShoppingCartType

An enum with one of the following values:
SHOPIFY / MAGENTO / BIGCOMMERCE / WOOCOMMERCE / SHOPLAZZA

BaseUrl

The URL of the store from where the products are imported.\

CollectionIds

Returns any Collection Ids if they were specified when connecting your Shopify or Shoplazza catalogs.

CollectionTitles

Returns any Collection Titles if they were specified when connecting your Shopify or Shoplazza catalogs.

ItemsUri string

Catalog's item's direct URI to view one set of catalog items.

Uri string

Catalog's direct URI.

Field list

{
  "Id": "1234",
  "Name": "ACME Catalog",
  "Filename": "anvils.xml",
  "AdvertiserId": "7777777",
  "CampaignId": "1000",
  "Status": "PENDING",
  "NumberOfItems": "25",
  "DateLastUpdated": "",
  "Currency": "USD",
  "ServiceAreas": [
    "United States",
    "United Kingdom",
    "Canada",
  ],
  "UploadMethod": "IMPACT_RADIUS_FTP_SERVER",
  "ItemsUri": "/Advertisers/<AccoutnSID>/Catalogs/1234/Items",
  "Uri": "/Advertisers/<AccountSID>/Catalogs/1234"
}