Skip to main content
Every cloudcart.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.
New to Corsair? See API access, authentication, and error handling.

​
Blogs

​
createBlogCategory

blogs.createBlogCategory Create blog category Risk: write
Input
Output

​
createBlogPost

blogs.createBlogPost Create blog post Risk: write
Input
Output

​
createBlogTag

blogs.createBlogTag Create blog tag Risk: write
Input
Output

​
deleteBlogCategory

blogs.deleteBlogCategory Delete blog category Risk: destructive
Input
Output: object

​
deleteBlogPost

blogs.deleteBlogPost Delete blog post Risk: destructive
Input
Output: object

​
deleteBlogTag

blogs.deleteBlogTag Delete blog tag Risk: destructive
Input
Output: object

​
getBlogAuthor

blogs.getBlogAuthor Get blog author Risk: read
Input
Output

​
getBlogCategory

blogs.getBlogCategory Get blog category Risk: read
Input
Output

​
getBlogPost

blogs.getBlogPost Get blog post Risk: read
Input
Output

​
getBlogTag

blogs.getBlogTag Get blog tag Risk: read
Input
Output

​
listBlogCategories

blogs.listBlogCategories List blog categories Risk: read
Input
Output

​
listBlogPosts

blogs.listBlogPosts List blog posts Risk: read
Input
Output

​
listBlogTags

blogs.listBlogTags List blog tags Risk: read
Input
Output

​
updateBlogCategory

blogs.updateBlogCategory Update blog category Risk: write
Input
Output

​
updateBlogPost

blogs.updateBlogPost Update blog post Risk: write
Input
Output

​
updateBlogTag

blogs.updateBlogTag Update blog tag Risk: write
Input
Output

​
Carts

​
addToCart

carts.addToCart Add to cart Risk: write
Input
Output

​
clearCart

carts.clearCart Clear cart Risk: destructive
Input
Output: object

​
getCart

carts.getCart Get cart Risk: read
Input
Output

​
removeFromCart

carts.removeFromCart Remove from cart Risk: destructive
Input
Output: object

​
updateCartItem

carts.updateCartItem Update cart item Risk: write
Input
Output

​
Categories

​
addCategoryProperties

categories.addCategoryProperties Add category properties Risk: write
Input
Output: object

​
createCategory

categories.createCategory Create category Risk: write
Input
Output

​
deleteCategory

categories.deleteCategory Delete category Risk: destructive
Input
Output: object

​
getCategory

categories.getCategory Get category Risk: read
Input
Output

​
getCategoryProperties

categories.getCategoryProperties Get category properties Risk: read
Input
Output

​
listCategories

categories.listCategories List categories Risk: read
Input
Output

​
updateCategory

categories.updateCategory Update category Risk: write
Input
Output

​
Customers

​
createCustomer

customers.createCustomer Create customer Risk: write
Input
Output

​
createCustomerBillingAddress

customers.createCustomerBillingAddress Create customer billing address Risk: write
Input
Output

​
createCustomerGroup

customers.createCustomerGroup Create customer group Risk: write
Input
Output

​
createCustomerShippingAddress

customers.createCustomerShippingAddress Create customer shipping address Risk: write
Input
Output

​
createCustomerTag

customers.createCustomerTag Create customer tag Risk: write
Input
Output

​
deleteCustomer

customers.deleteCustomer Delete customer Risk: destructive
Input
Output: object

​
deleteCustomerBillingAddress

customers.deleteCustomerBillingAddress Delete customer billing address Risk: destructive
Input
Output: object

​
deleteCustomerGroup

customers.deleteCustomerGroup Delete customer group Risk: destructive
Input
Output: object

​
deleteCustomerShippingAddress

customers.deleteCustomerShippingAddress Delete customer shipping address Risk: destructive
Input
Output: object

​
deleteCustomerTag

customers.deleteCustomerTag Delete customer tag Risk: destructive
Input
Output: object

​
getCustomer

customers.getCustomer Get customer Risk: read
Input
Output

​
getCustomerBillingAddress

customers.getCustomerBillingAddress Get customer billing address Risk: read
Input
Output

​
getCustomerGroup

customers.getCustomerGroup Get customer group Risk: read
Input
Output

​
getCustomerGroupsCustomers

customers.getCustomerGroupsCustomers Get customer group customers Risk: read
Input
Output

​
getCustomerShippingAddress

customers.getCustomerShippingAddress Get customer shipping address Risk: read
Input
Output

​
getCustomerTag

customers.getCustomerTag Get customer tag Risk: read
Input
Output

​
listCustomerBillingAddresses

customers.listCustomerBillingAddresses List customer billing addresses Risk: read
Input
Output

​
listCustomerGroups

customers.listCustomerGroups List customer groups Risk: read
Input
Output

​
listCustomers

customers.listCustomers List customers Risk: read
Input
Output

​
listCustomerShippingAddresses

customers.listCustomerShippingAddresses List customer shipping addresses Risk: read
Input
Output

​
listCustomerTags

customers.listCustomerTags List customer tags Risk: read
Input
Output

​
updateCustomer

customers.updateCustomer Update customer Risk: write
Input
Output

​
updateCustomerBillingAddress

customers.updateCustomerBillingAddress Update customer billing address Risk: write
Input
Output

​
updateCustomerGroup

customers.updateCustomerGroup Update customer group Risk: write
Input
Output

​
updateCustomerShippingAddress

customers.updateCustomerShippingAddress Update customer shipping address Risk: write
Input
Output

​
updateCustomerTag

customers.updateCustomerTag Update customer tag Risk: write
Input
Output

​
Discounts

​
createDiscount

discounts.createDiscount Create discount Risk: write
Input
Output

​
createDiscountCode

discounts.createDiscountCode Create discount code Risk: write
Input
Output

​
createProductToDiscount

discounts.createProductToDiscount Create product to discount Risk: write
Input
Output

​
deleteDiscount

discounts.deleteDiscount Delete discount Risk: destructive
Input
Output: object

​
deleteDiscountCode

discounts.deleteDiscountCode Delete discount code Risk: destructive
Input
Output: object

​
deleteProductToDiscount

discounts.deleteProductToDiscount Delete product to discount Risk: destructive
Input
Output: object

​
generateDiscountCodes

discounts.generateDiscountCodes Generate discount codes Risk: write
Input
Output

​
listDiscountCodes

discounts.listDiscountCodes List discount codes Risk: read
Input
Output

​
updateDiscountCode

discounts.updateDiscountCode Update discount code Risk: write
Input
Output

​
Misc

​
createRedirect

misc.createRedirect Create redirect Risk: write
Input
Output

​
createVendor

misc.createVendor Create vendor Risk: write
Input
Output

​
deleteRedirect

misc.deleteRedirect Delete redirect Risk: destructive
Input
Output: object

​
deleteVendor

misc.deleteVendor Delete vendor Risk: destructive
Input
Output: object

​
getPaymentMethods

misc.getPaymentMethods Get payment methods Risk: read
Input
Output

​
getShippingMethods

misc.getShippingMethods Get shipping methods Risk: read
Input
Output

​
getVendor

misc.getVendor Get vendor Risk: read
Input
Output

​
listPaymentProviders

misc.listPaymentProviders List payment providers Risk: read
Input
Output

​
listRedirects

misc.listRedirects List redirects Risk: read
Input
Output

​
listShippingProviders

misc.listShippingProviders List shipping providers Risk: read
Input
Output

​
listVendors

misc.listVendors List vendors Risk: read
Input
Output

​
updateVendor

misc.updateVendor Update vendor Risk: write
Input
Output

​
Orders

​
createOrder

orders.createOrder Create order Risk: write
Input
Output

​
deleteOrder

orders.deleteOrder Delete order Risk: destructive
Input
Output: object

​
getOrder

orders.getOrder Get order Risk: read
Input
Output

​
listOrderBillingAddresses

orders.listOrderBillingAddresses List order billing addresses Risk: read
Input
Output

​
listOrderPayments

orders.listOrderPayments List order payments Risk: read
Input
Output

​
listOrderProducts

orders.listOrderProducts List order products Risk: read
Input
Output

​
listOrderProductsOptions

orders.listOrderProductsOptions List order products options Risk: read
Input
Output

​
listOrders

orders.listOrders List orders Risk: read
Input
Output

​
listOrderShipping

orders.listOrderShipping List order shipping Risk: read
Input
Output

​
listOrderShippingAddresses

orders.listOrderShippingAddresses List order shipping addresses Risk: read
Input
Output

​
listOrderStatus

orders.listOrderStatus List order statuses Risk: read
Input
Output

​
updateOrder

orders.updateOrder Update order Risk: write
Input
Output

​
Products

​
createImage

products.createImage Create image Risk: write
Input
Output

​
createLinkedProducts

products.createLinkedProducts Create linked products Risk: write
Input
Output: object

​
createProduct

products.createProduct Create product Risk: write
Input
Output

​
deleteImage

products.deleteImage Delete image Risk: destructive
Input
Output: object

​
deleteLinkedProducts

products.deleteLinkedProducts Delete linked products Risk: destructive
Input
Output: object

​
deleteProduct

products.deleteProduct Delete product Risk: destructive
Input
Output: object

​
getImage

products.getImage Get image Risk: read
Input
Output

​
getProduct

products.getProduct Get product Risk: read
Input
Output

​
getProductsLinkedProduct

products.getProductsLinkedProduct Get product linked product Risk: read
Input
Output

​
getProductsLinkedProducts

products.getProductsLinkedProducts Get products linked products Risk: read
Input
Output

​
getProductWithRelations

products.getProductWithRelations Get product with relations. Pass documented include params (e.g. include=category) to sideload related resources. Risk: read
Input
Output

​
listImages

products.listImages List images Risk: read
Input
Output

​
listProducts

products.listProducts List products Risk: read
Input
Output

​
updateLinkedProduct

products.updateLinkedProduct Update linked product Risk: write
Input
Output: object

​
updateProduct

products.updateProduct Update product Risk: write
Input
Output

​
Properties

​
createProductsPropertyOptions

properties.createProductsPropertyOptions Create product property options Risk: write
Input
Output: object

​
createProperty

properties.createProperty Create property Risk: write
Input
Output

​
createPropertyOption

properties.createPropertyOption Create property option Risk: write
Input
Output

​
deleteProperty

properties.deleteProperty Delete property Risk: destructive
Input
Output: object

​
deletePropertyOption

properties.deletePropertyOption Delete property option Risk: destructive
Input
Output: object

​
getProperty

properties.getProperty Get property Risk: read
Input
Output

​
getPropertyOption

properties.getPropertyOption Get property option Risk: read
Input
Output

​
getPropertyOptionsRelationship

properties.getPropertyOptionsRelationship Get property options relationship Risk: read
Input
Output

​
listProperties

properties.listProperties List properties Risk: read
Input
Output

​
listPropertyOptions

properties.listPropertyOptions List property options Risk: read
Input
Output

​
updateProperty

properties.updateProperty Update property Risk: write
Input
Output

​
updatePropertyOption

properties.updatePropertyOption Update property option Risk: write
Input
Output

​
Subscribers

​
createSubscriber

subscribers.createSubscriber Create subscriber Risk: write
Input
Output

​
createSubscriberChannel

subscribers.createSubscriberChannel Create subscriber channel Risk: write
Input
Output

​
createSubscriberTag

subscribers.createSubscriberTag Create subscriber tag Risk: write
Input
Output

​
deleteSubscriber

subscribers.deleteSubscriber Delete subscriber Risk: destructive
Input
Output: object

​
deleteSubscribersChannel

subscribers.deleteSubscribersChannel Delete subscriber channel Risk: destructive
Input
Output: object

​
deleteSubscriberTag

subscribers.deleteSubscriberTag Delete subscriber tag Risk: destructive
Input
Output: object

​
getSubscriber

subscribers.getSubscriber Get subscriber Risk: read
Input
Output

​
getSubscribersChannel

subscribers.getSubscribersChannel Get subscriber channel Risk: read
Input
Output

​
getSubscriberTag

subscribers.getSubscriberTag Get subscriber tag Risk: read
Input
Output

​
listSubscribers

subscribers.listSubscribers List subscribers Risk: read
Input
Output

​
listSubscribersChannels

subscribers.listSubscribersChannels List subscriber channels Risk: read
Input
Output

​
listSubscribersTags

subscribers.listSubscribersTags List subscriber tags Risk: read
Input
Output

​
updateSubscriber

subscribers.updateSubscriber Update subscriber Risk: write
Input
Output

​
updateSubscribersChannel

subscribers.updateSubscribersChannel Update subscriber channel Risk: write
Input
Output

​
updateSubscriberTag

subscribers.updateSubscriberTag Update subscriber tag Risk: write
Input
Output

​
Variants

​
createVariant

variants.createVariant Create variant Risk: write
Input
Output

​
createVariantOption

variants.createVariantOption Create variant option Risk: write
Input
Output

​
createVariantOptions

variants.createVariantOptions Create variant options Risk: write
Input
Output

​
createVariantParameter

variants.createVariantParameter Create variant parameter Risk: write
Input
Output

​
createVariantParameterForVariant

variants.createVariantParameterForVariant Create variant parameter for variant Risk: write
Input
Output

​
deleteVariant

variants.deleteVariant Delete variant Risk: destructive
Input
Output: object

​
deleteVariantOption

variants.deleteVariantOption Delete variant option Risk: destructive
Input
Output: object

​
deleteVariantParameter

variants.deleteVariantParameter Delete variant parameter Risk: destructive
Input
Output: object

​
getVariant

variants.getVariant Get variant Risk: read
Input
Output

​
getVariantOption

variants.getVariantOption Get variant option Risk: read
Input
Output

​
getVariantParameter

variants.getVariantParameter Get variant parameter Risk: read
Input
Output

​
listVariantOptions

variants.listVariantOptions List variant options Risk: read
Input
Output

​
listVariantParameters

variants.listVariantParameters List variant parameters Risk: read
Input
Output

​
listVariants

variants.listVariants List variants Risk: read
Input
Output

​
updateVariant

variants.updateVariant Update variant Risk: write
Input
Output

​
updateVariantOption

variants.updateVariantOption Update variant option Risk: write
Input
Output

​
updateVariantParameter

variants.updateVariantParameter Update variant parameter Risk: write
Input
Output

​
Webhooks

​
createWebhook

webhooks.createWebhook Create webhook Risk: write
Input
Output

​
deleteWebhook

webhooks.deleteWebhook Delete webhook Risk: destructive
Input
Output: object

​
getWebhook

webhooks.getWebhook Get webhook Risk: read
Input
Output

​
listWebhooks

webhooks.listWebhooks List webhooks Risk: read
Input
Output

​
updateWebhook

webhooks.updateWebhook Update webhook Risk: write
Input
Output