Virto Commerce

Virto Commerce Shopping Cart API

Shopping cart / checkout functionality

GitHub OpenAPI
Business capability
Cart & Checkout AE-140.20

Operations 24

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

GET /api/carts/{storeId}/{customerId}/{cartName}/{currency}/{cultureName}/current Get a shopper's current cart · Cart module get cart #
Ask an LLM
“How do I load the active cart for a customer in a given store, currency and language?”
“Can a customer have separately named carts, like a wishlist, per store?”
Tell an agent
Get the current {cartName} cart for customer {customerId} in store {storeId} using {currency} and {cultureName}.
Load customer {customerId}'s default cart in store {storeId}, {currency}, {cultureName}.
GET /api/carts/{cartId}/itemscount Count the items in a cart · Cart module get cart items count #
Ask an LLM
“How many items are in a shopping cart right now?”
“Can I get just the item count for a mini-cart badge without loading the whole cart?”
Tell an agent
Count the items in cart {cartId}.
Tell me how many products are in cart {cartId}.
POST /api/carts/{cartId}/items Add a product to a cart · Cart module add item to cart #
Ask an LLM
“How do I add a product to a customer's shopping cart?”
“Can I add an item by SKU with a specific quantity?”
Tell an agent
Add product {productId} to cart {cartId}.
Put {quantity} of SKU {sku} into cart {cartId}.
PUT /api/carts/{cartId}/items Change a cart line item's quantity · Cart module change cart item #
Ask an LLM
“How do I change the quantity of a product already in the cart?”
“Can I set a line item to a new quantity by its line item ID?”
Tell an agent
Set line item {lineItemId} in cart {cartId} to quantity {quantity}.
Change the quantity of an item in cart {cartId}.
DELETE /api/carts/{cartId}/items Empty a cart · Cart module clear cart #
Ask an LLM
“How do I remove every item from a cart at once?”
“Is there a way to clear a shopping cart without deleting the cart itself?”
Tell an agent destructive · confirm first
Clear all items from cart {cartId}.
Empty shopping cart {cartId}.
DELETE /api/carts/{cartId}/items/{lineItemId} Remove one item from a cart · Cart module remove cart item #
Ask an LLM
“How do I take a single product out of a cart?”
“Can I delete one line item while leaving the rest of the cart intact?”
Tell an agent destructive · confirm first
Remove line item {lineItemId} from cart {cartId}.
Delete item {lineItemId} from shopping cart {cartId}.
PATCH /api/carts/{cartId} Merge another cart into a cart · Cart module merge with cart #
Ask an LLM
“How do I combine an anonymous shopper's cart with their account cart after login?”
“Can the items from one cart be merged into another?”
Tell an agent
Merge this cart into cart {cartId}.
Combine the anonymous cart for customer {customerId} into cart {cartId}.
GET /api/carts/{cartId} Get a cart by ID · Get shopping cart by id #
Ask an LLM
“What does a shopping cart contain when I fetch it by ID?”
“Where can I read a specific cart if I know its ID?”
Tell an agent
Get cart {cartId}.
Show the contents of shopping cart {cartId}.
GET /api/carts/{cartId}/availshippingrates List shipping rates for a saved cart · Cart module get available shipping rates #
Ask an LLM
“What shipping options and prices are available for a saved cart?”
“Which delivery methods can this cart ID use?”
Tell an agent
List shipping rates available for cart {cartId}.
Show delivery options and prices for saved cart {cartId}.
POST /api/carts/availshippingrates Quote shipping rates for an unsaved cart · Cart module get available shipping rates by context #
Ask an LLM
“Can I get shipping rates by sending a cart object instead of a saved cart ID?”
“What would shipping cost for this cart contents in a specific currency?”
Tell an agent
Quote shipping rates in {currency} for this cart object.
Estimate shipping for cart contents {shoppingCart}.
GET /api/carts/{cartId}/availpaymentmethods List payment methods for a cart · Cart module get available payment methods #
Ask an LLM
“Which payment methods can a shopper choose for this cart?”
“What payment options are offered at checkout for a given cart?”
Tell an agent
List payment methods available for cart {cartId}.
Show the checkout payment options for cart {cartId}.
POST /api/carts/{cartId}/coupons/{couponCode} Apply a coupon to a cart · Cart module add cart coupon #
Ask an LLM
“How do I apply a discount coupon code to a shopping cart?”
“Can a shopper redeem a promo code on their cart?”
Tell an agent
Apply coupon {couponCode} to cart {cartId}.
Redeem promo code {couponCode} on shopping cart {cartId}.
DELETE /api/carts/{cartId}/coupons/{couponCode} Remove a coupon from a cart · Cart module remove cart coupon #
Ask an LLM
“How do I take a coupon code off a cart?”
“Can a shopper drop a promo code they already applied?”
Tell an agent destructive · confirm first
Remove coupon {couponCode} from cart {cartId}.
Drop promo code {couponCode} from shopping cart {cartId}.
POST /api/carts/{cartId}/shipments Set the shipping method on a cart · Cart module add or update cart shipment #
Ask an LLM
“How do I choose a shipping method for a cart at checkout?”
“Can I set which fulfillment center ships a cart?”
Tell an agent
Set shipping method {shipmentMethodCode} on cart {cartId}.
Ship cart {cartId} from fulfillment center {fulfillmentCenterId} with option {shipmentMethodOption}.
POST /api/carts/{cartId}/payments Set the payment method on a cart · Cart module add or update cart payment #
Ask an LLM
“How do I attach a payment method to a cart before checkout?”
“Can I set the payment amount and billing address on a cart's payment?”
Tell an agent
Set payment gateway {paymentGatewayCode} on cart {cartId}.
Add a cart payment of {amount} to cart {cartId}.
POST /api/carts/search Search shopping carts · Search shopping carts by given criteria #
Ask an LLM
“Which carts has a given customer created in my store?”
“Can I find abandoned carts that still have line items?”
Tell an agent
Search carts for customer {customerId} in store {storeId}.
Find carts with status {status} modified after {modifiedStartDate}.
POST /api/carts Create a shopping cart · Create shopping cart #
Ask an LLM
“How do I start a new cart for a customer in a store?”
“Can I create a named cart in a specific currency?”
Tell an agent
Create a cart for customer {customerId} in store {storeId}.
Create a new cart named {name} in {currency}.
PUT /api/carts Update a shopping cart · Update shopping cart #
Ask an LLM
“How do I save changes to an entire shopping cart record?”
“Can I add a comment to an existing cart by replacing it?”
Tell an agent
Update existing cart {id} with comment {comment}.
Save the full updated record for cart {id}.
DELETE /api/carts Delete shopping carts · Delete shopping carts by ids #
Ask an LLM
“How do I delete carts I no longer need?”
“Can I remove several shopping carts at once by ID?”
Tell an agent destructive · confirm first
Delete carts {ids}.
Remove the shopping carts with IDs {ids}.
POST /api/carts/recalculate Recalculate cart totals · Calculates totals for cart #
Ask an LLM
“Can I compute a cart's totals, taxes and discounts without saving it?”
“What would this cart come to after my edits?”
Tell an agent
Recalculate totals for this cart.
Compute the totals for cart {id} as sent.
PATCH /api/carts/patch/{id} Partially update a cart · Partial update for the specified ShoppingCart by id #
Ask an LLM
“Can I change a single field on a cart without sending the full cart?”
“What is the way to JSON-patch a shopping cart?”
Tell an agent
Patch cart {id} with only the changed fields.
Apply a partial update to shopping cart {id}.
PATCH /api/carts/patch/{cartId}/items/{lineItemId} Partially update a cart line item · Partial update for the specified ShoppingCart LineItem by id #
Ask an LLM
“Can I patch just one field, like a note, on a cart line item?”
“How do I apply a JSON patch to a single item in a cart?”
Tell an agent
Patch line item {lineItemId} in cart {cartId}.
Apply a partial update to item {lineItemId} of cart {cartId}.
PATCH /api/carts/patch/{cartId}/shipments/{shipmentId} Partially update a cart shipment · Partial update for the specified ShoppingCart Shipment by id #
Ask an LLM
“Can I patch a single field on a cart's shipment?”
“How do I JSON-patch the shipment attached to a cart?”
Tell an agent
Patch shipment {shipmentId} in cart {cartId}.
Apply a partial update to cart {cartId} shipment {shipmentId}.
PATCH /api/carts/patch/{cartId}/payments/{paymentId} Partially update a cart payment · Partial update for the specified ShoppingCart Payment by id #
Ask an LLM
“Can I patch a single field on a cart's payment?”
“How do I JSON-patch the payment attached to a cart?”
Tell an agent
Patch payment {paymentId} in cart {cartId}.
Apply a partial update to cart {cartId} payment {paymentId}.

Documentation

📖
Documentation
https://docs.virtocommerce.org/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/virto-commerce/openapi/virto-commerce-shopping-cart-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-catalog
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-pricing
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-inventory
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-order
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-x-cart
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-customer
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-marketing
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-quote
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-store
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-platform

Other Resources

🔗
Overlay
https://artifacts.apis.io/virto-commerce/overlays/virto-commerce-shopping-cart-api-overlay.yaml
🔗
GraphQL
https://artifacts.apis.io/virto-commerce/graphql/virto-commerce-graphql.md

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/virto-commerce:virto-commerce-shopping-cart-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

virto-commerce-shopping-cart-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: VirtoCommerce.Cart Shopping Cart API
  version: v1
  description: Shopping cart / checkout functionality
tags:


# --- truncated at 32 KB (64 KB total) ---
# Full source: https://artifacts.apis.io/virto-commerce/openapi/virto-commerce-shopping-cart-api-openapi.yml