How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Adobe Commerce API

Integrate with Adobe Commerce through REST and GraphQL APIs for managing products, orders, customers, and building headless commerce experiences.

This API exposes 67 operations across 59 paths, organized into 59 resource areas, and defines 132 schemas. It is described by OpenAPI 2.0, at version 2.4.6.

Requests are made against the base URL https://commerce.adobe.io.

67 operations 59 paths 132 schemas 3 DELETE22 GET36 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2.4.6
Base URL
https://commerce.adobe.io
Authentication
API Key
Resource Areas
59

Authentication & Security 1

Adobe Commerce API declares 1 security scheme for authenticating requests. An API key is passed in the header as api_key (api_key).

Paths & Operations 67

Across 59 paths, the API surfaces 67 operations — 3 DELETE, 22 GET, 36 POST, 6 PUT. They span 59 resource areas, including applepay/auth, carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}, carts/guest-carts/{cartId}/giftCards, carts/guest-carts/{cartId}/giftCards/{giftCardCode}, customers, customers/isEmailAvailable, customers/password, customers/resetPassword, and 51 more. Each is listed below with its method, path, parameters, and response codes.

applepay/auth 1
GET
/V1/applepay/auth
applepay/auth
GetV1ApplepayAuth → 200default
carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} 1
GET
/V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
GetV1CartsGuestcartsCartIdCheckGiftCardGiftCardCode 2 params → 200400500default
carts/guest-carts/{cartId}/giftCards 1
POST
/V1/carts/guest-carts/{cartId}/giftCards
carts/guest-carts/{cartId}/giftCards
PostV1CartsGuestcartsCartIdGiftCards 2 params → 200500default
carts/guest-carts/{cartId}/giftCards/{giftCardCode} 1
DELETE
/V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}
carts/guest-carts/{cartId}/giftCards/{giftCardCode}
DeleteV1CartsGuestcartsCartIdGiftCardsGiftCardCode 2 params → 200default
customers 1
POST
/V1/customers
customers
PostV1Customers 1 param → 200500default
customers/isEmailAvailable 1
POST
/V1/customers/isEmailAvailable
customers/isEmailAvailable
PostV1CustomersIsEmailAvailable 1 param → 200500default
customers/password 1
PUT
/V1/customers/password
customers/password
PutV1CustomersPassword 1 param → 200500default
customers/resetPassword 1
POST
/V1/customers/resetPassword
customers/resetPassword
PostV1CustomersResetPassword 1 param → 200500default
customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} 1
GET
/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
GetV1CustomersCustomerIdPasswordResetLinkTokenResetPasswordLinkToken 2 params → 200400500default
directory/countries 1
GET
/V1/directory/countries
directory/countries
GetV1DirectoryCountries → 200default
directory/countries/{countryId} 1
GET
/V1/directory/countries/{countryId}
directory/countries/{countryId}
GetV1DirectoryCountriesCountryId 1 param → 200400default
directory/currency 1
GET
/V1/directory/currency
directory/currency
GetV1DirectoryCurrency → 200default
guest-carts 1
POST
/V1/guest-carts
guest-carts
PostV1Guestcarts → 200400default
guest-carts/{cartId} 1
GET
/V1/guest-carts/{cartId}
guest-carts/{cartId}
GetV1GuestcartsCartId 1 param → 200400default
guest-carts/{cartId}/billing-address 2
GET
/V1/guest-carts/{cartId}/billing-address
guest-carts/{cartId}/billing-address
GetV1GuestcartsCartIdBillingaddress 1 param → 200400default
POST
/V1/guest-carts/{cartId}/billing-address
guest-carts/{cartId}/billing-address
PostV1GuestcartsCartIdBillingaddress 2 params → 200400default
guest-carts/{cartId}/collect-totals 1
PUT
/V1/guest-carts/{cartId}/collect-totals
guest-carts/{cartId}/collect-totals
PutV1GuestcartsCartIdCollecttotals 2 params → 200default
guest-carts/{cartId}/coupons 2
GET
/V1/guest-carts/{cartId}/coupons
guest-carts/{cartId}/coupons
GetV1GuestcartsCartIdCoupons 1 param → 200400default
DELETE
/V1/guest-carts/{cartId}/coupons
guest-carts/{cartId}/coupons
DeleteV1GuestcartsCartIdCoupons 1 param → 200400default
guest-carts/{cartId}/coupons/{couponCode} 1
PUT
/V1/guest-carts/{cartId}/coupons/{couponCode}
guest-carts/{cartId}/coupons/{couponCode}
PutV1GuestcartsCartIdCouponsCouponCode 2 params → 200400default
guest-carts/{cartId}/estimate-shipping-methods 1
POST
/V1/guest-carts/{cartId}/estimate-shipping-methods
guest-carts/{cartId}/estimate-shipping-methods
PostV1GuestcartsCartIdEstimateshippingmethods 2 params → 200default
guest-carts/{cartId}/gift-message 2
GET
/V1/guest-carts/{cartId}/gift-message
guest-carts/{cartId}/gift-message
GetV1GuestcartsCartIdGiftmessage 1 param → 200default
POST
/V1/guest-carts/{cartId}/gift-message
guest-carts/{cartId}/gift-message
PostV1GuestcartsCartIdGiftmessage 2 params → 200400default
guest-carts/{cartId}/gift-message/{itemId} 2
GET
/V1/guest-carts/{cartId}/gift-message/{itemId}
guest-carts/{cartId}/gift-message/{itemId}
GetV1GuestcartsCartIdGiftmessageItemId 2 params → 200400default
POST
/V1/guest-carts/{cartId}/gift-message/{itemId}
guest-carts/{cartId}/gift-message/{itemId}
PostV1GuestcartsCartIdGiftmessageItemId 3 params → 200400default
guest-carts/{cartId}/items 2
GET
/V1/guest-carts/{cartId}/items
guest-carts/{cartId}/items
GetV1GuestcartsCartIdItems 1 param → 200400default
POST
/V1/guest-carts/{cartId}/items
guest-carts/{cartId}/items
PostV1GuestcartsCartIdItems 2 params → 200400default
guest-carts/{cartId}/items/{itemId} 2
PUT
/V1/guest-carts/{cartId}/items/{itemId}
guest-carts/{cartId}/items/{itemId}
PutV1GuestcartsCartIdItemsItemId 3 params → 200400default
DELETE
/V1/guest-carts/{cartId}/items/{itemId}
guest-carts/{cartId}/items/{itemId}
DeleteV1GuestcartsCartIdItemsItemId 2 params → 200400default
guest-carts/{cartId}/order 1
PUT
/V1/guest-carts/{cartId}/order
guest-carts/{cartId}/order
PutV1GuestcartsCartIdOrder 2 params → 200400default
guest-carts/{cartId}/payment-information 2
POST
/V1/guest-carts/{cartId}/payment-information
guest-carts/{cartId}/payment-information
PostV1GuestcartsCartIdPaymentinformation 2 params → 200500default
GET
/V1/guest-carts/{cartId}/payment-information
guest-carts/{cartId}/payment-information
GetV1GuestcartsCartIdPaymentinformation 1 param → 200default
guest-carts/{cartId}/payment-methods 1
GET
/V1/guest-carts/{cartId}/payment-methods
guest-carts/{cartId}/payment-methods
GetV1GuestcartsCartIdPaymentmethods 1 param → 200400default
guest-carts/{cartId}/selected-payment-method 2
GET
/V1/guest-carts/{cartId}/selected-payment-method
guest-carts/{cartId}/selected-payment-method
GetV1GuestcartsCartIdSelectedpaymentmethod 1 param → 200400default
PUT
/V1/guest-carts/{cartId}/selected-payment-method
guest-carts/{cartId}/selected-payment-method
PutV1GuestcartsCartIdSelectedpaymentmethod 2 params → 200400default
guest-carts/{cartId}/set-payment-information 1
POST
/V1/guest-carts/{cartId}/set-payment-information
guest-carts/{cartId}/set-payment-information
PostV1GuestcartsCartIdSetpaymentinformation 2 params → 200400default
guest-carts/{cartId}/shipping-information 1
POST
/V1/guest-carts/{cartId}/shipping-information
guest-carts/{cartId}/shipping-information
PostV1GuestcartsCartIdShippinginformation 2 params → 200default
guest-carts/{cartId}/shipping-methods 1
GET
/V1/guest-carts/{cartId}/shipping-methods
guest-carts/{cartId}/shipping-methods
GetV1GuestcartsCartIdShippingmethods 1 param → 200400default
guest-carts/{cartId}/totals 1
GET
/V1/guest-carts/{cartId}/totals
guest-carts/{cartId}/totals
GetV1GuestcartsCartIdTotals 1 param → 200400default
guest-carts/{cartId}/totals-information 1
POST
/V1/guest-carts/{cartId}/totals-information
guest-carts/{cartId}/totals-information
PostV1GuestcartsCartIdTotalsinformation 2 params → 200default
guest-giftregistry/{cartId}/estimate-shipping-methods 1
POST
/V1/guest-giftregistry/{cartId}/estimate-shipping-methods
guest-giftregistry/{cartId}/estimate-shipping-methods
PostV1GuestgiftregistryCartIdEstimateshippingmethods 2 params → 200400default
integration/admin/token 1
POST
/V1/integration/admin/token
integration/admin/token
PostV1IntegrationAdminToken 1 param → 200400500default
integration/customer/token 1
POST
/V1/integration/customer/token
integration/customer/token
PostV1IntegrationCustomerToken 1 param → 200400default
inventory/in-store-pickup/pickup-locations/ 1
GET
/V1/inventory/in-store-pickup/pickup-locations/
inventory/in-store-pickup/pickup-locations/
GetV1InventoryInstorepickupPickuplocations 25 params → 200default
products-render-info 1
GET
/V1/products-render-info
products-render-info
GetV1Productsrenderinfo 9 params → 200default
quick-checkout/account-details 1
POST
/V1/quick-checkout/account-details
quick-checkout/account-details
PostV1QuickcheckoutAccountdetails → 200default
quick-checkout/has-account 1
POST
/V1/quick-checkout/has-account
quick-checkout/has-account
PostV1QuickcheckoutHasaccount 1 param → 200default
quick-checkout/storefront/has-account 1
POST
/V1/quick-checkout/storefront/has-account
quick-checkout/storefront/has-account
PostV1QuickcheckoutStorefrontHasaccount 1 param → 200500default
search 1
GET
/V1/search
search
GetV1Search 8 params → 200default
tfa/provider/authy/activate 1
POST
/V1/tfa/provider/authy/activate
tfa/provider/authy/activate
PostV1TfaProviderAuthyActivate 1 param → default
tfa/provider/authy/authenticate 1
POST
/V1/tfa/provider/authy/authenticate
tfa/provider/authy/authenticate
PostV1TfaProviderAuthyAuthenticate 1 param → 200default
tfa/provider/authy/authenticate-onetouch 1
POST
/V1/tfa/provider/authy/authenticate-onetouch
tfa/provider/authy/authenticate-onetouch
PostV1TfaProviderAuthyAuthenticateonetouch 1 param → 200default
tfa/provider/authy/configure 1
POST
/V1/tfa/provider/authy/configure
tfa/provider/authy/configure
PostV1TfaProviderAuthyConfigure 1 param → 200default
tfa/provider/authy/send-token/{via} 1
POST
/V1/tfa/provider/authy/send-token/{via}
tfa/provider/authy/send-token/{via}
PostV1TfaProviderAuthySendtokenVia 2 params → default
tfa/provider/duo_security/activate 1
POST
/V1/tfa/provider/duo_security/activate
tfa/provider/duosecurity/activate
PostV1TfaProviderDuo_securityActivate 1 param → default
tfa/provider/duo_security/authenticate 1
POST
/V1/tfa/provider/duo_security/authenticate
tfa/provider/duosecurity/authenticate
PostV1TfaProviderDuo_securityAuthenticate 1 param → 200default
tfa/provider/duo_security/configure 1
POST
/V1/tfa/provider/duo_security/configure
tfa/provider/duosecurity/configure
PostV1TfaProviderDuo_securityConfigure 1 param → 200default
tfa/provider/duo_security/get-authentication-data 1
POST
/V1/tfa/provider/duo_security/get-authentication-data
tfa/provider/duosecurity/get-authentication-data
PostV1TfaProviderDuo_securityGetauthenticationdata 1 param → 200default
tfa/provider/google/activate 1
POST
/V1/tfa/provider/google/activate
tfa/provider/google/activate
PostV1TfaProviderGoogleActivate 1 param → default
tfa/provider/google/authenticate 1
POST
/V1/tfa/provider/google/authenticate
tfa/provider/google/authenticate
PostV1TfaProviderGoogleAuthenticate 1 param → 200default
tfa/provider/google/configure 1
POST
/V1/tfa/provider/google/configure
tfa/provider/google/configure
PostV1TfaProviderGoogleConfigure 1 param → 200default
tfa/provider/u2fkey/activate 1
POST
/V1/tfa/provider/u2fkey/activate
tfa/provider/u2fkey/activate
PostV1TfaProviderU2fkeyActivate 1 param → default
tfa/provider/u2fkey/authentication-challenge 1
POST
/V1/tfa/provider/u2fkey/authentication-challenge
tfa/provider/u2fkey/authentication-challenge
PostV1TfaProviderU2fkeyAuthenticationchallenge 1 param → 200default
tfa/provider/u2fkey/configure 1
POST
/V1/tfa/provider/u2fkey/configure
tfa/provider/u2fkey/configure
PostV1TfaProviderU2fkeyConfigure 1 param → 200default
tfa/provider/u2fkey/verify 1
POST
/V1/tfa/provider/u2fkey/verify
tfa/provider/u2fkey/verify
PostV1TfaProviderU2fkeyVerify 1 param → 200default
tfa/tfat-providers-to-activate 1
GET
/V1/tfa/tfat-providers-to-activate
tfa/tfat-providers-to-activate
GetV1TfaTfatproviderstoactivate 1 param → 200default
tfa/tfat-user-providers 1
GET
/V1/tfa/tfat-user-providers
tfa/tfat-user-providers
GetV1TfaTfatuserproviders 1 param → 200default

Schemas 132

The contract defines 132 schemas that model the data the API accepts and returns. The most detailed are quote-data-totals-interface (28 properties), quote-data-total-segment-extension-interface (24 properties), quote-data-address-interface (24 properties), negotiable-quote-data-negotiable-quote-interface (23 properties). Each schema is shown below with its type and property counts.

error-response
object
5 properties 1 required
error-errors
array
Errors list
error-errors-item
object
Error details
2 properties
error-parameters
array
Error parameters list
error-parameters-item
object
Error parameters item
3 properties
directory-data-currency-information-interface
object
Currency Information interface.
7 properties 6 required
directory-data-exchange-rate-interface
object
Exchange Rate interface.
3 properties 2 required
directory-data-exchange-rate-extension-interface
object
ExtensionInterface class for @see \Magento\Directory\Api\Data\ExchangeRateInterface
directory-data-currency-information-extension-interface
object
ExtensionInterface class for @see \Magento\Directory\Api\Data\CurrencyInformationInterface
directory-data-country-information-interface
object
Country Information interface.
7 properties 5 required
directory-data-region-information-interface
object
Region Information interface.
4 properties 3 required
directory-data-region-information-extension-interface
object
ExtensionInterface class for @see \Magento\Directory\Api\Data\RegionInformationInterface
directory-data-country-information-extension-interface
object
ExtensionInterface class for @see \Magento\Directory\Api\Data\CountryInformationInterface
customer-data-customer-interface
object
Customer entity interface for API handling.
23 properties 3 required
customer-data-address-interface
object
Customer address interface.
21 properties
customer-data-region-interface
object
Customer address region interface.
4 properties 3 required
customer-data-region-extension-interface
object
ExtensionInterface class for @see \Magento\Customer\Api\Data\RegionInterface
customer-data-address-extension-interface
object
ExtensionInterface class for @see \Magento\Customer\Api\Data\AddressInterface
framework-attribute-interface
object
Interface for custom attribute value.
2 properties 2 required
customer-data-customer-extension-interface
object
ExtensionInterface class for @see \Magento\Customer\Api\Data\CustomerInterface
3 properties
company-data-company-customer-interface
object
Extended customer custom attributes interface.
6 properties
company-data-company-customer-extension-interface
object
ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyCustomerInterface
catalog-data-product-render-search-results-interface
object
Dto that holds render information about products
1 property 1 required
catalog-data-product-render-interface
object
Represents Data Object which holds enough information to render product This information is put into part as Add To Cart or Add to Compare Data or Price Data
12 properties 12 required
catalog-data-product-render-button-interface
object
Button interface. This interface represents all manner of product buttons: add to cart, add to compare, etc... The buttons describes by this interface should h…
4 properties 3 required
catalog-data-product-render-button-extension-interface
object
ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ButtonInterface
catalog-data-product-render-price-info-interface
object
Price interface.
9 properties 8 required
catalog-data-product-render-formatted-price-info-interface
object
Formatted Price interface. Aggregate formatted html with price representations. E.g.: $9.00 Consider currency, rounding and html
8 properties 7 required
catalog-data-product-render-formatted-price-info-extension-interface
object
ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\FormattedPriceInfoInterface
catalog-data-product-render-price-info-extension-interface
object
ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\PriceInfoInterface
4 properties
msrp-data-product-render-msrp-price-info-interface
object
Price interface.
6 properties 5 required
msrp-data-product-render-msrp-price-info-extension-interface
object
ExtensionInterface class for @see \Magento\Msrp\Api\Data\ProductRender\MsrpPriceInfoInterface
weee-data-product-render-weee-adjustment-attribute-interface
object
List of all weee attributes, their amounts, etc.., that product has
6 properties 6 required
weee-data-product-render-weee-adjustment-attribute-extension-interface
object
ExtensionInterface class for @see \Magento\Weee\Api\Data\ProductRender\WeeeAdjustmentAttributeInterface
catalog-data-product-render-image-interface
object
Product Render image interface. Represents physical characteristics of image, that can be used in product listing or product view
8 properties 7 required
catalog-data-product-render-image-extension-interface
object
ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ImageInterface
catalog-data-product-render-extension-interface
object
ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRenderInterface
2 properties
quote-data-cart-interface
object
Interface CartInterface
20 properties 3 required
quote-data-cart-item-interface
object
Interface CartItemInterface
9 properties 2 required
quote-data-product-option-interface
object
Product option interface
1 property
quote-data-product-option-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\ProductOptionInterface
6 properties
catalog-data-custom-option-interface
object
Interface CustomOptionInterface
3 properties 2 required
catalog-data-custom-option-extension-interface
object
ExtensionInterface class for @see \Magento\Catalog\Api\Data\CustomOptionInterface
1 property
framework-data-image-content-interface
object
Image Content data interface
3 properties 3 required
bundle-data-bundle-option-interface
object
Interface BundleOptionInterface
4 properties 3 required
bundle-data-bundle-option-extension-interface
object
ExtensionInterface class for @see \Magento\Bundle\Api\Data\BundleOptionInterface
downloadable-data-downloadable-option-interface
object
Downloadable Option
1 property 1 required
gift-card-data-gift-card-option-interface
object
Interface GiftCardOptionInterface
8 properties 5 required
gift-card-data-gift-card-option-extension-interface
object
ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftCardOptionInterface
1 property
configurable-product-data-configurable-item-option-value-interface
object
Interface ConfigurableItemOptionValueInterface
3 properties 1 required
configurable-product-data-configurable-item-option-value-extension-interface
object
ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\ConfigurableItemOptionValueInterface
grouped-product-data-grouped-options-interface
object
Represents product item id with qty of a grouped product.
3 properties
grouped-product-data-grouped-options-extension-interface
object
ExtensionInterface class for @see \Magento\GroupedProduct\Api\Data\GroupedOptionsInterface
quote-data-cart-item-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\CartItemInterface
2 properties
sales-rule-data-rule-discount-interface
object
Rule discount Interface
3 properties 3 required
sales-rule-data-discount-data-interface
object
Discount Data Interface
4 properties 4 required
negotiable-quote-data-negotiable-quote-item-interface
object
Interface CompanyQuoteConfigInterface
5 properties 4 required
negotiable-quote-data-negotiable-quote-item-extension-interface
object
ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemInterface
quote-data-address-interface
object
Interface AddressInterface
24 properties 11 required
quote-data-address-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\AddressInterface
4 properties
quote-data-currency-interface
object
Interface CurrencyInterface
9 properties
quote-data-currency-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\CurrencyInterface
quote-data-cart-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\CartInterface
2 properties
quote-data-shipping-assignment-interface
object
Interface ShippingAssignmentInterface
3 properties 2 required
quote-data-shipping-interface
object
Interface ShippingInterface
3 properties 2 required
quote-data-shipping-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingInterface
quote-data-shipping-assignment-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingAssignmentInterface
negotiable-quote-data-negotiable-quote-interface
object
Interface NegotiableQuoteInterface
23 properties 18 required
negotiable-quote-data-negotiable-quote-extension-interface
object
ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteInterface
quote-data-payment-interface
object
Interface PaymentInterface
4 properties 1 required
quote-data-payment-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\PaymentInterface
1 property
quote-data-shipping-method-interface
object
Interface ShippingMethodInterface
11 properties 8 required
quote-data-shipping-method-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingMethodInterface
quote-data-payment-method-interface
object
Interface PaymentMethodInterface
2 properties 2 required
quote-data-totals-additional-data-interface
object
Additional data for totals collection.
2 properties
quote-data-totals-additional-data-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsAdditionalDataInterface
1 property
gift-message-data-message-interface
object
Interface MessageInterface
6 properties 3 required
gift-message-data-message-extension-interface
object
ExtensionInterface class for @see \Magento\GiftMessage\Api\Data\MessageInterface
5 properties
quote-data-totals-interface
object
Interface TotalsInterface
28 properties 2 required
quote-data-totals-item-interface
object
Interface TotalsItemInterface
22 properties 9 required
quote-data-totals-item-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsItemInterface
1 property
negotiable-quote-data-negotiable-quote-item-totals-interface
object
Extension attribute for quote item totals model.
12 properties 11 required
negotiable-quote-data-negotiable-quote-item-totals-extension-interface
object
ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemTotalsInterface
quote-data-total-segment-interface
object
Interface TotalsInterface
5 properties 2 required
quote-data-total-segment-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalSegmentInterface
24 properties
tax-data-grand-total-details-interface
object
Interface GrandTotalDetailsInterface
3 properties 3 required
tax-data-grand-total-rates-interface
object
Interface GrandTotalRatesInterface
2 properties 2 required
quote-data-totals-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsInterface
7 properties
negotiable-quote-data-negotiable-quote-totals-interface
object
Extension attribute for quote totals model.
16 properties 16 required
framework-search-search-result-interface
object
Interface SearchResultInterface
4 properties 4 required
framework-search-document-interface
object
Interface Search Document
2 properties 1 required
framework-search-aggregation-interface
object
Interface Aggregation to get faceted data
2 properties 2 required
framework-search-bucket-interface
object
Interface for facet Bucket
2 properties 2 required
framework-search-aggregation-value-interface
object
Interface Aggregation Value
2 properties 2 required
framework-search-search-criteria-interface
object
Interface SearchCriteriaInterface
5 properties 2 required
framework-search-filter-group
object
Groups two or more filters together using a logical OR
1 property
framework-filter
object
Filter which can be used by any methods from service layer.
3 properties 2 required
framework-sort-order
object
Data object for sort order.
2 properties 2 required
checkout-data-shipping-information-interface
object
Interface ShippingInformationInterface
6 properties 3 required
checkout-data-shipping-information-extension-interface
object
ExtensionInterface class for @see \Magento\Checkout\Api\Data\ShippingInformationInterface
checkout-data-payment-details-interface
object
Interface PaymentDetailsInterface
3 properties 2 required
checkout-data-payment-details-extension-interface
object
ExtensionInterface class for @see \Magento\Checkout\Api\Data\PaymentDetailsInterface
checkout-data-totals-information-interface
object
Interface TotalsInformationInterface
5 properties 1 required
checkout-data-totals-information-extension-interface
object
ExtensionInterface class for @see \Magento\Checkout\Api\Data\TotalsInformationInterface
two-factor-auth-provider-interface
object
2FA provider interface
9 properties 9 required
two-factor-auth-engine-interface
object
2FA engine interface
1 property 1 required
two-factor-auth-data-google-configure-interface
object
Google configuration data interface
3 properties 2 required
two-factor-auth-data-google-configure-extension-interface
object
ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\GoogleConfigureInterface
two-factor-auth-data-authy-device-interface
object
Authy device data interface
4 properties 3 required
two-factor-auth-data-authy-device-extension-interface
object
ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\AuthyDeviceInterface
two-factor-auth-data-authy-registration-prompt-response-interface
object
Response for device registration prompt
3 properties 2 required
two-factor-auth-data-authy-registration-prompt-response-extension-interface
object
ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\AuthyRegistrationPromptResponseInterface
two-factor-auth-data-u2f-web-authn-request-interface
object
Represents a WebAuthn dataset
2 properties 1 required
two-factor-auth-data-u2f-web-authn-request-extension-interface
object
ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\U2fWebAuthnRequestInterface
two-factor-auth-data-duo-data-interface
object
Represents the data needed to use duo
3 properties 2 required
two-factor-auth-data-duo-data-extension-interface
object
ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\DuoDataInterface
gift-card-account-data-gift-card-account-interface
object
Gift Card Account data
6 properties 4 required
gift-card-account-data-gift-card-account-extension-interface
object
ExtensionInterface class for @see \Magento\GiftCardAccount\Api\Data\GiftCardAccountInterface
inventory-in-store-pickup-api-data-search-result-interface
object
Search results for providing pickup locations.
3 properties 3 required
inventory-in-store-pickup-api-data-pickup-location-interface
object
Represents sources projection on In-Store Pickup context. Realisation must follow immutable DTO concept. Partial immutability done according to restriction of…
16 properties 1 required
inventory-in-store-pickup-api-data-pickup-location-extension-interface
object
ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\PickupLocationInterface
inventory-in-store-pickup-api-data-search-request-interface
object
Endpoint used to search Pickup Locations by different parameters: - by attribute filters fields @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\…
8 properties 3 required
inventory-in-store-pickup-api-data-search-request-area-interface
object
Filter by Distance to the Address. Pickup Locations will be filtered by distance according to the geo-position of the entered address. Required fields for the…
2 properties 2 required
inventory-in-store-pickup-api-data-search-request-filters-interface
object
Filter to filter by Fields. Each field may be filtered with different condition type. Supported condition types restricted by @see \Magento\Framework\Api\Searc…
8 properties
inventory-in-store-pickup-api-data-search-request-filter-interface
object
Filter for Pickup Location search.
2 properties 2 required
inventory-in-store-pickup-api-data-search-request-extension-interface
object
ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequestInterface
1 property
inventory-in-store-pickup-api-data-search-request-product-info-interface
object
Product Info Data Transfer Object.
2 properties 1 required
inventory-in-store-pickup-api-data-search-request-product-info-extension-interface
object
ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\ProductInfoInterface
quick-checkout-data-account-interface
object
Data account interface
6 properties 6 required
quick-checkout-data-address-interface
object
Account address
14 properties 11 required
quick-checkout-data-payment-method-interface
object
Account payment
7 properties 6 required
pay-pal-braintree-data-auth-data-interface
object
Interface AuthDataInterface
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adobe-suite-commerce-rest-guest-openapi.yaml Raw ↑
Where this information came from

This is an independent, third-party profile of Adobe Commerce API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.