The identity and technical contract details declared by the specification.
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
The full machine-readable OpenAPI contract behind this narrative.