Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

magento Carts API

Shopping cart and quote management for admin, customer, and guest users, including item management, coupon codes, shipping estimation, and payment information collection.

magento Carts API is one of 16 APIs that magento publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Carts. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 2.4.

Requests are made against a single base URL, https://{store_domain}/rest/{store_code}.

3 operations 3 paths 3 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.4
Base URL
https://your-store.example.com/rest
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

magento Carts API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token obtained from the /V1/integration/admin/token or /V1/integration/customer/token endpoint. Include in the Authorization header as "Bearer {token}".

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.

Carts 3

Shopping cart and quote management for admin, customer, and guest users, including item management, coupon codes, shipping estimation, and payment information collection.

POST
/V1/carts/mine
Create a cart for the authenticated customer
createCustomerCart → 200401
POST
/V1/carts/mine/items
Add item to customer cart
addItemToCart body → 200400401
POST
/V1/guest-carts
Create a guest cart
createGuestCart → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are CartItem (7 properties), Error (2 properties), CartItemRequest (1 property). Each schema is shown below with its type and property counts.

CartItemRequest
object
Request body for adding an item to a shopping cart.
1 property 1 required
CartItem
object
A product line item in a shopping cart (quote).
7 properties
Error
object
Standard error response returned for 4xx and 5xx responses.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

magento-carts-api-openapi.yml Raw ↑

Other APIs magento publishes across the network.

Magento GraphQL API
Magento SOAP API
Adobe Commerce Webhooks
Adobe Commerce Admin UI SDK
Adobe Commerce Eventing
magento Authentication API
magento Categories API
magento Customers API
magento Inventory API
magento Invoices API
magento Orders API
magento Products API