Products

ActiveCampaign can store product catalog data from your ecommerce store.

Base Products and Variants

ActiveCampaign stores product variants as separate products. For example, some systems may show a product with variants in the following JSON:

{
   "name": "Shoes",
   "variants": [
     {
       "variantName": "Red Shoes",
       "sku": "abc123"
     },
     {
       "variantName": "Blue Shoes",
       "sku": "xyz890"
     }  
  ]
}

This would be stored in the ActiveCampaign model as two products in this GraphQL request:

mutation {
  bulkUpsertProducts(
    products: [
    {
	 	 	baseProductName: "Shoes",
   		variantName: "Red Shoes",
   		variantSku: "abc123"
    }
    {
       baseProductName: "Shoes",
       variantName: "Blue Shoes",
       variantSku: "xyz890"
    }
	])
	{
    id
	}
}

Note that for both of these, the baseProductNameis the same. All fields in the Product data model prefixed with baseProduct will be duplicated across all variants of that base product.

Connection Identifiers

Various product objects in the API use legacyConnectionId to identify which integration products they are associated with. legacyConnectionId is an integer identifier that matches the id field of the V3 Connection API. Aside from being able to retrieve this identifier from the connection API, you can find this identifier on your integrations page. If you click into the details of any integration, you will see a URL such as https://youraccount.activehosted.com/app/settings/integrations/9. The number at the end of this URL (in this case: 9) is your legacyConnectionId.

Primary Product Identifiers

A product is identified based on two pieces of data: legacyConnectionId and storePrimaryId. Within any given connection (that is, within a legacyConnectionId), only one product may exist with a given storePrimaryId.

If API users attempt to create a duplicate product with the same storePrimaryId/legacyConnectionId combination using the createProductApi, a validation error will be returned.

When the bulkUpsertProducts API is used, any writes that use an already existing storePrimaryId/legacyConnectionId combination will update the existing product. If no product with a storePrimaryId exists under a legacyConnectionId, then a new product will be inserted.

For the bulkUpsertProducts operation, if two or more products in the request body have the same storePrimaryId and legacyConnectionId, a validation error will not be returned. The API will deduplicate the entries. It will retain one instance and exclude the others from execution.

Patch-Style operations

All updates and upserts on the Product API are patch-style operations. In other words, if you send this product:

mutation {
  bulkUpsertProducts(
    products: [
    {
      storePrimaryId: "shoezy"
      legacyConnectionId: 5
	 	 	baseProductName: "Shoes"
   		variantName: "Red Shoes"
   		variantSku: "abc123"
    }
	])
	{
    id
	}
}

Then the fields baseProductName variantName, and variantSku will all be updated for the product with storePrimaryId shoezy in the store with legacyConnectionId 5. No other fields on the product will be updated.

To set a field (for example, baseProductName) to null, simply pass a null value for that field:

mutation {
  bulkUpsertProducts(
    products: [
    {
      storePrimaryId: "shoezy"
      legacyConnectionId: 5
	 	 	baseProductName: null
    }
	])
	{
    id
	}
}

Queries

productById

Type: Product

Arguments for productById

searchProduct

For information on how filters and search requests work, see: Searches.

Type: Product

Arguments for searchProduct

Mutations

createProduct

Input fields for createProduct

product (ProductInput)

Return fields for createProduct

updateProduct

Input fields for updateProduct

id (String)

product (ProductInput)

Return fields for updateProduct

deleteProduct

Input fields for deleteProduct

id (String)

bulkUpsertProducts

Input fields for bulkUpsertProducts

products (ProductInput)

Return fields for bulkUpsertProducts

Objects

Base Product Fields

ActiveCampaign stores product variants as separate products. For example, some systems may show a product with variants in the following JSON:

{
   "name": "Shoes",
   "variants": [
     {
       "variantName": "Red Shoes",
       "sku": "abc123"
     },
     {
       "variantName": "Blue Shoes",
       "sku": "xyz890"
     }  
  ]
}

This would be stored in the ActiveCampaign model as two products in this GraphQL request:

mutation {
  bulkUpsertProducts(
    products: [
    {
	 	 	baseProductName: "Shoes",
   		variantName: "Red Shoes",
   		variantSku: "abc123"
    }
    {
       baseProductName: "Shoes",
       variantName: "Blue Shoes",
       variantSku: "xyz890"
    }
	])
	{
    id
	}
}

Note that for both of these, the baseProductNameis the same. All fields in the Product data model prefixed with baseProduct will be duplicated across all variants of that base product.

If two or more products are contain duplicates using same legacyConnectionId and storePrimaryIdthe API will deduplicate the entries. It will retain one instance and exclude the others from execution.

Example:

Request:

mutation {
  bulkUpsertProducts(
    products: [
    {
    	legacyConnectionId: 1,
    	storePrimaryId: "123",
	 	 	baseProductName: "Shoes",
   		variantName: "Red Shoes",
   		variantSku: "abc123"
    }
    {
      legacyConnectionId: 1,
    	storePrimaryId: "123",
      baseProductName: "Shoes",
      variantName: "Blue Shoes",
      variantSku: "xyz890"
    }
	])
	{
    legacyConnectionId
    storeBaseProductId
    baseProductName
    variantName
    variantSku
	}
}

Response:

{
    "data": {
        "bulkUpsertProducts": [
            {
                "legacyConnectionId": 1,
                "baseProductName": "Shoes",
                "variantName": "Red Shoes",
                "variantSku": "abc123"
            }
        ]
    }
}

Product Input

Product Filter

Product Input

Product Filter

PhysicalDimensions

ImageData