Operations 55
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“What products are in my Klaviyo catalog right now?”
“Can I sort my catalog items by when they were created?”
Tell an agent
List catalog items matching {filter}.
Show catalog items sorted by {sort}, including their variants.
Ask an LLM
“How do I add a single new product to my catalog?”
“Can I create one catalog item with its title, price and URL?”
Tell an agent
Create a catalog item from {item}.
Add this product to the catalog as a new item: {item}.
Ask an LLM
“What are the details of a specific product in my catalog?”
“Can I fetch one catalog item along with its variants?”
Tell an agent
Get catalog item {item_id}.
Show the details and variants of catalog item {item_id}.
Ask an LLM
“How do I change the price or title of an existing catalog product?”
“Can I edit one catalog item that's already in my catalog?”
Tell an agent
Update catalog item {item_id} with {changes}.
Change the details of existing product {item_id} to {changes}.
Ask an LLM
“Can I remove a single product from my catalog?”
“What happens when I delete one catalog item by its ID?”
Tell an agent destructive · confirm first
Delete catalog item {item_id}.
Remove product {item_id} from the catalog.
Ask an LLM
“What product variants exist across my whole catalog?”
“Can I filter all catalog variants in the account by SKU or ID?”
Tell an agent
List all catalog variants matching {filter}.
Show every variant across all items in my catalog.
Ask an LLM
“How do I add a size or color variant to a catalog product?”
“Can I create one variant for an existing catalog item?”
Tell an agent
Create catalog variant {variant}.
Add this new variant to its catalog item: {variant}.
Ask an LLM
“What are the details of a specific product variant?”
“Can I look up a single variant's price and inventory?”
Tell an agent
Get catalog variant {variant_id}.
Show the inventory and price for variant {variant_id}.
Ask an LLM
“How do I update the inventory quantity of one variant?”
“Can I change the price of an existing variant?”
Tell an agent
Update catalog variant {variant_id} with {changes}.
Set new inventory and price on variant {variant_id}: {changes}.
Ask an LLM
“Can I delete a single variant without deleting its product?”
“What happens to a product when one of its variants is removed?”
Tell an agent destructive · confirm first
Delete catalog variant {variant_id}.
Remove variant {variant_id} from its catalog item.
Ask an LLM
“What categories are set up in my product catalog?”
“Can I find catalog categories by name?”
Tell an agent
List catalog categories matching {filter}.
Show all the categories in my catalog.
Ask an LLM
“How do I create a new product category in my catalog?”
“Can I add one category like 'Summer Sale' to the catalog?”
Tell an agent
Create catalog category {category}.
Add a new category to the catalog: {category}.
Ask an LLM
“What are the details of a single catalog category?”
“Can I look up a category by its ID?”
Tell an agent
Get catalog category {category_id}.
Show the name and details of category {category_id}.
Ask an LLM
“How do I rename an existing catalog category?”
“Can I edit the details of one category?”
Tell an agent
Update catalog category {category_id} with {changes}.
Rename category {category_id} using {changes}.
Ask an LLM
“Can I delete one category from my catalog?”
“What happens when I remove a catalog category by ID?”
Tell an agent destructive · confirm first
Delete catalog category {category_id}.
Remove category {category_id} from the catalog.
GET
/api/catalog-item-bulk-create-jobs
List bulk item-create jobs · Get Bulk Create Catalog Items Jobs
#
Ask an LLM
“Which bulk catalog item create jobs have I run?”
“Can I see only the item-create jobs that are still processing?”
Tell an agent
List bulk catalog item create jobs with status {filter}.
Show my past bulk jobs that created catalog items.
POST
/api/catalog-item-bulk-create-jobs
Create many catalog items in one job · Bulk Create Catalog Items
#
Ask an LLM
“How do I import up to 100 products into my catalog at once?”
“What's the payload limit for a bulk catalog item create job?”
Tell an agent
Start a bulk job creating these catalog items: {items}.
Bulk import products {items} into the catalog.
GET
/api/catalog-item-bulk-create-jobs/{job_id}
Check a bulk item-create job · Get Bulk Create Catalog Items Job
#
Ask an LLM
“Did my bulk catalog item import job finish?”
“Can I see which items a bulk create job produced?”
Tell an agent
Get the status of bulk item create job {job_id}.
Show the items created by bulk create job {job_id}.
GET
/api/catalog-item-bulk-update-jobs
List bulk item-update jobs · Get Bulk Update Catalog Items Jobs
#
Ask an LLM
“Which bulk catalog item update jobs have run in my account?”
“Can I filter item-update jobs by status?”
Tell an agent
List bulk catalog item update jobs with status {filter}.
Show my past bulk jobs that updated catalog items.
POST
/api/catalog-item-bulk-update-jobs
Update many catalog items in one job · Bulk Update Catalog Items
#
Ask an LLM
“How do I update prices on a batch of catalog items at once?”
“How many catalog items can one bulk update job change?”
Tell an agent
Start a bulk job updating these catalog items: {items}.
Bulk update existing products with {items}.
GET
/api/catalog-item-bulk-update-jobs/{job_id}
Check a bulk item-update job · Get Bulk Update Catalog Items Job
#
Ask an LLM
“Has my bulk catalog item update job completed?”
“Can I see which items a bulk update job changed?”
Tell an agent
Get the status of bulk item update job {job_id}.
Show the items touched by bulk update job {job_id}.
GET
/api/catalog-item-bulk-delete-jobs
List bulk item-delete jobs · Get Bulk Delete Catalog Items Jobs
#
Ask an LLM
“Which bulk catalog item delete jobs have I run?”
“Can I list only the failed item-delete jobs?”
Tell an agent
List bulk catalog item delete jobs with status {filter}.
Show my past bulk jobs that deleted catalog items.
POST
/api/catalog-item-bulk-delete-jobs
Delete many catalog items in one job · Bulk Delete Catalog Items
#
Ask an LLM
“How do I remove a batch of discontinued products from my catalog?”
“How many catalog items can a single bulk delete job remove?”
Tell an agent destructive · confirm first
Start a bulk job deleting these catalog items: {items}.
Bulk delete products {items} from the catalog.
GET
/api/catalog-item-bulk-delete-jobs/{job_id}
Check a bulk item-delete job · Get Bulk Delete Catalog Items Job
#
Ask an LLM
“Did my bulk catalog item delete job succeed?”
“What's the status of a specific item-delete job?”
Tell an agent
Get the status of bulk item delete job {job_id}.
Check whether item delete job {job_id} has finished.
GET
/api/catalog-variant-bulk-create-jobs
List bulk variant-create jobs · Get Bulk Create Variants Jobs
#
Ask an LLM
“Which bulk variant create jobs have run in my catalog?”
“Can I filter variant-create jobs by their status?”
Tell an agent
List bulk variant create jobs with status {filter}.
Show my past bulk jobs that created catalog variants.
POST
/api/catalog-variant-bulk-create-jobs
Create many catalog variants in one job · Bulk Create Catalog Variants
#
Ask an LLM
“How do I add up to 100 variants to my catalog in one request?”
“Is there a size limit on a bulk variant create job?”
Tell an agent
Start a bulk job creating these variants: {variants}.
Bulk add catalog variants {variants}.
GET
/api/catalog-variant-bulk-create-jobs/{job_id}
Check a bulk variant-create job · Get Bulk Create Variants Job
#
Ask an LLM
“Has my bulk variant create job finished?”
“Can I see the variants a bulk create job added?”
Tell an agent
Get the status of bulk variant create job {job_id}.
Show the variants created by job {job_id}.
GET
/api/catalog-variant-bulk-update-jobs
List bulk variant-update jobs · Get Bulk Update Variants Jobs
#
Ask an LLM
“Which bulk variant update jobs have I run?”
“Can I see only the variant-update jobs that completed?”
Tell an agent
List bulk variant update jobs with status {filter}.
Show my past bulk jobs that updated catalog variants.
POST
/api/catalog-variant-bulk-update-jobs
Update many catalog variants in one job · Bulk Update Catalog Variants
#
Ask an LLM
“How do I refresh inventory counts on a batch of variants at once?”
“How many variants can one bulk update job modify?”
Tell an agent
Start a bulk job updating these variants: {variants}.
Bulk update variant inventory and prices with {variants}.
GET
/api/catalog-variant-bulk-update-jobs/{job_id}
Check a bulk variant-update job · Get Bulk Update Variants Job
#
Ask an LLM
“Did my bulk variant update job complete?”
“Can I see which variants a bulk update job changed?”
Tell an agent
Get the status of bulk variant update job {job_id}.
Show the variants modified by update job {job_id}.
GET
/api/catalog-variant-bulk-delete-jobs
List bulk variant-delete jobs · Get Bulk Delete Variants Jobs
#
Ask an LLM
“Which bulk variant delete jobs exist in my account?”
“Can I filter variant-delete jobs by status?”
Tell an agent
List bulk variant delete jobs with status {filter}.
Show my past bulk jobs that deleted catalog variants.
POST
/api/catalog-variant-bulk-delete-jobs
Delete many catalog variants in one job · Bulk Delete Catalog Variants
#
Ask an LLM
“How do I delete a batch of sold-out variants at once?”
“What's the maximum number of variants one bulk delete job can remove?”
Tell an agent destructive · confirm first
Start a bulk job deleting these variants: {variants}.
Bulk remove catalog variants {variants}.
GET
/api/catalog-variant-bulk-delete-jobs/{job_id}
Check a bulk variant-delete job · Get Bulk Delete Variants Job
#
Ask an LLM
“Has my bulk variant delete job finished?”
“What's the status of a particular variant-delete job?”
Tell an agent
Get the status of bulk variant delete job {job_id}.
Check whether variant delete job {job_id} is done.
GET
/api/catalog-category-bulk-create-jobs
List bulk category-create jobs · Get Bulk Create Categories Jobs
#
Ask an LLM
“Which bulk category create jobs have I run?”
“Can I filter category-create jobs by status?”
Tell an agent
List bulk category create jobs with status {filter}.
Show my past bulk jobs that created catalog categories.
POST
/api/catalog-category-bulk-create-jobs
Create many catalog categories in one job · Bulk Create Catalog Categories
#
Ask an LLM
“How do I set up a batch of catalog categories in one request?”
“How many categories can a bulk create job accept?”
Tell an agent
Start a bulk job creating these categories: {categories}.
Bulk add catalog categories {categories}.
GET
/api/catalog-category-bulk-create-jobs/{job_id}
Check a bulk category-create job · Get Bulk Create Categories Job
#
Ask an LLM
“Did my bulk category create job finish?”
“Can I see the categories a bulk create job made?”
Tell an agent
Get the status of bulk category create job {job_id}.
Show the categories created by job {job_id}.
GET
/api/catalog-category-bulk-update-jobs
List bulk category-update jobs · Get Bulk Update Categories Jobs
#
Ask an LLM
“Which bulk category update jobs have run?”
“Can I list only the category-update jobs still in progress?”
Tell an agent
List bulk category update jobs with status {filter}.
Show my past bulk jobs that updated catalog categories.
POST
/api/catalog-category-bulk-update-jobs
Update many catalog categories in one job · Bulk Update Catalog Categories
#
Ask an LLM
“How do I rename a batch of catalog categories at once?”
“Is there a limit on categories per bulk update job?”
Tell an agent
Start a bulk job updating these categories: {categories}.
Bulk update catalog categories with {categories}.
GET
/api/catalog-category-bulk-update-jobs/{job_id}
Check a bulk category-update job · Get Bulk Update Categories Job
#
Ask an LLM
“Has my bulk category update job completed?”
“Can I see which categories a bulk update job changed?”
Tell an agent
Get the status of bulk category update job {job_id}.
Show the categories modified by update job {job_id}.
GET
/api/catalog-category-bulk-delete-jobs
List bulk category-delete jobs · Get Bulk Delete Categories Jobs
#
Ask an LLM
“Which bulk category delete jobs have I run?”
“Can I filter category-delete jobs by status?”
Tell an agent
List bulk category delete jobs with status {filter}.
Show my past bulk jobs that deleted catalog categories.
POST
/api/catalog-category-bulk-delete-jobs
Delete many catalog categories in one job · Bulk Delete Catalog Categories
#
Ask an LLM
“How do I remove several old catalog categories in one go?”
“How many categories can a single bulk delete job remove?”
Tell an agent destructive · confirm first
Start a bulk job deleting these categories: {categories}.
Bulk remove catalog categories {categories}.
GET
/api/catalog-category-bulk-delete-jobs/{job_id}
Check a bulk category-delete job · Get Bulk Delete Categories Job
#
Ask an LLM
“Did my bulk category delete job succeed?”
“What's the status of one category-delete job?”
Tell an agent
Get the status of bulk category delete job {job_id}.
Check whether category delete job {job_id} is complete.
POST
/api/back-in-stock-subscriptions
Subscribe a shopper to back-in-stock alerts · Create Back In Stock Subscription
#
Ask an LLM
“How do I notify a customer when an out-of-stock variant is available again?”
“Can my server sign a profile up for back in stock notifications?”
Tell an agent
Subscribe {subscription} to back in stock alerts from my server.
Create a server-side back in stock subscription: {subscription}.
GET
/api/catalog-categories/{id}/items
List the items in a catalog category · Get Items for Catalog Category
#
Ask an LLM
“Which products are in a particular catalog category?”
“Can I get the full item details for everything in one category?”
Tell an agent
List the catalog items in category {category_id}.
Show full product details for items in category {category_id}, sorted by {sort}.
GET
/api/catalog-categories/{id}/relationships/items
List item IDs in a catalog category · Get Item IDs for Catalog Category
#
Ask an LLM
“Can I get just the IDs of the items in a category?”
“What item IDs belong to one catalog category?”
Tell an agent
Get only the item IDs in category {category_id}.
Return the item ID list for category {category_id}.
POST
/api/catalog-categories/{id}/relationships/items
Add items to a catalog category · Add Items to Catalog Category
#
Ask an LLM
“How do I put existing products into a category?”
“Can I add several items to one category at once?”
Tell an agent
Add items {items} to category {category_id}.
Put products {items} into catalog category {category_id}.
PATCH
/api/catalog-categories/{id}/relationships/items
Replace the item set of a catalog category · Update Items for Catalog Category
#
Ask an LLM
“Can I overwrite a category's item membership with a new list?”
“How do I reset which items are in a category?”
Tell an agent
Replace the items in category {category_id} with {items}.
Set category {category_id} to contain exactly {items}.
DELETE
/api/catalog-categories/{id}/relationships/items
Remove items from a catalog category · Remove Items from Catalog Category
#
Ask an LLM
“How do I take products out of a category without deleting them?”
“Can I unlink several items from one category?”
Tell an agent destructive · confirm first
Remove items {items} from category {category_id}.
Take products {items} out of catalog category {category_id}.
GET
/api/catalog-items/{id}/variants
List the variants of a catalog item · Get Variants for Catalog Item
#
Ask an LLM
“What variants does a particular product have?”
“Can I see full variant details for one catalog item?”
Tell an agent
List the variants of catalog item {item_id}.
Show every size and color variant for product {item_id}.
GET
/api/catalog-items/{id}/relationships/variants
List variant IDs for a catalog item · Get Variant IDs for Catalog Item
#
Ask an LLM
“Can I get only the variant IDs for one product?”
“Which variant IDs are attached to a catalog item?”
Tell an agent
Get only the variant IDs of catalog item {item_id}.
Return the variant ID list for product {item_id}.
GET
/api/catalog-items/{id}/categories
List the categories an item belongs to · Get Categories for Catalog Item
#
Ask an LLM
“Which categories is a specific product in?”
“Can I see full category details for one catalog item?”
Tell an agent
List the categories that catalog item {item_id} is in.
Show category details for product {item_id}.
GET
/api/catalog-items/{id}/relationships/categories
List category IDs for a catalog item · Get Category IDs for Catalog Item
#
Ask an LLM
“Can I get just the category IDs for one product?”
“What category IDs is a catalog item linked to?”
Tell an agent
Get only the category IDs for catalog item {item_id}.
Return the category ID list for product {item_id}.
POST
/api/catalog-items/{id}/relationships/categories
Add a catalog item to categories · Add Categories to Catalog Item
#
Ask an LLM
“How do I place one product into additional categories?”
“Can I link a catalog item to several categories at once?”
Tell an agent
Add catalog item {item_id} to categories {categories}.
Link product {item_id} to categories {categories}.
PATCH
/api/catalog-items/{id}/relationships/categories
Replace a catalog item's categories · Update Categories for Catalog Item
#
Ask an LLM
“Can I overwrite all the categories a product belongs to?”
“How do I reset one item's category assignments?”
Tell an agent
Replace the categories of catalog item {item_id} with {categories}.
Set product {item_id} to belong only to {categories}.
DELETE
/api/catalog-items/{id}/relationships/categories
Remove a catalog item from categories · Remove Categories from Catalog Item
#
Ask an LLM
“How do I take one product out of some of its categories?”
“Can I unlink a catalog item from several categories?”
Tell an agent destructive · confirm first
Remove catalog item {item_id} from categories {categories}.
Unlink product {item_id} from categories {categories}.
Documentation
📖
Documentation
https://developers.klaviyo.com/
📖
Authentication
https://developers.klaviyo.com/en/docs/authenticate_
📖
RateLimits
https://developers.klaviyo.com/en/docs/rate_limits_and_error_handling
Specifications
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/klaviyo/refs/heads/main/openapi/klaviyo-catalogs-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/klaviyo/refs/heads/main/asyncapi/klaviyo-webhooks-asyncapi.yaml
Other Resources
🔗
Reference
https://developers.klaviyo.com/en/reference/api_overview
🔗
Versioning
https://developers.klaviyo.com/en/docs/api_versioning_and_deprecation_policy
🔗
ChangeLog
https://developers.klaviyo.com/en/docs/changelog_
🔗
SDKs
https://developers.klaviyo.com/en/docs/sdk_overview
🔗
GitHub
https://github.com/klaviyo/openapi
🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/klaviyo/refs/heads/main/overlays/klaviyo-catalogs-api-overlay.yaml