MageSmith
443 endpoints · 37 modules · Magento 2.4.9

Magento 2 REST API Explorer

Every Magento 2 REST endpoint grouped by module, with HTTP method, path, path/query/body parameters, return types, ACL resources, and copy-paste headers, body, cURL, and JS fetch.

195 result(s) in GET · Clear

GET

/V1/adobestock/asset/:id

Get asset by id

AdobeStockAsset · Magento\AdobeStockAssetApi\Api\AssetRepositoryInterface::getById

GET

/V1/adobestock/asset/list

Search for images based on search criteria

AdobeStockAsset · Magento\AdobeStockAssetApi\Api\GetAssetListInterface::execute

GET

/V1/adobestock/asset/search

Get a list of assets

AdobeStockAsset · Magento\AdobeStockAssetApi\Api\AssetRepositoryInterface::getList

GET

/V1/adobestock/search

Search for images based on search criteria

AdobeStockImage · Magento\AdobeStockImageApi\Api\GetImageListInterface::execute

GET

/V1/analytics/link

Retrieve link

Analytics · Magento\Analytics\Api\LinkProviderInterface::get

GET

/V1/bulk

Lists the bulk operation items that match specified search criteria.

AsynchronousOperations · Magento\AsynchronousOperations\Api\OperationRepositoryInterface::getList

GET

/V1/bulk/:bulkUuid/detailed-status

Get Bulk summary data with list of operations items full data.

AsynchronousOperations · Magento\AsynchronousOperations\Api\BulkStatusInterface::getBulkDetailedStatus

GET

/V1/bulk/:bulkUuid/operation-status/:status

AsynchronousOperations · Magento\AsynchronousOperations\Api\BulkStatusInterface::getOperationsCountByBulkIdAndStatus

GET

/V1/bulk/:bulkUuid/status

Get Bulk summary data with list of operations items short data.

AsynchronousOperations · Magento\AsynchronousOperations\Api\BulkStatusInterface::getBulkShortStatus

GET

/V1/modules

Returns an array of enabled modules

Backend · Magento\Backend\Service\V1\ModuleServiceInterface::getModules

GET

/V1/applepay/auth

Anonymous

BraintreeCore · PayPal\Braintree\Api\AuthInterface::get

GET

/V1/bundle-products/:productSku/children

Get all children for Bundle product

Bundle · Magento\Bundle\Api\ProductLinkManagementInterface::getChildren

GET

/V1/bundle-products/:sku/options/:optionId

Get option for bundle product

Bundle · Magento\Bundle\Api\ProductOptionRepositoryInterface::get

GET

/V1/bundle-products/:sku/options/all

Get all options for bundle product

Bundle · Magento\Bundle\Api\ProductOptionRepositoryInterface::getList

GET

/V1/bundle-products/options/types

Get all types for options for bundle products

Bundle · Magento\Bundle\Api\ProductOptionTypeListInterface::getItems

GET

/V1/categories

Retrieve list of categories

Catalog · Magento\Catalog\Api\CategoryManagementInterface::getTree

GET

/V1/categories/:categoryId

Get info about category by category id

Catalog · Magento\Catalog\Api\CategoryRepositoryInterface::get

GET

/V1/categories/:categoryId/products

Get products assigned to category

Catalog · Magento\Catalog\Api\CategoryLinkManagementInterface::getAssignedProducts

GET

/V1/categories/attributes

Retrieve all attributes for entity type

Catalog · Magento\Catalog\Api\CategoryAttributeRepositoryInterface::getList

GET

/V1/categories/attributes/:attributeCode

Retrieve specific attribute

Catalog · Magento\Catalog\Api\CategoryAttributeRepositoryInterface::get

GET

/V1/categories/attributes/:attributeCode/options

Retrieve list of attribute options

Catalog · Magento\Catalog\Api\CategoryAttributeOptionManagementInterface::getItems

GET

/V1/categories/list

Get category list

Catalog · Magento\Catalog\Api\CategoryListInterface::getList

GET

/V1/products

Get product list

Catalog · Magento\Catalog\Api\ProductRepositoryInterface::getList

GET

/V1/products-render-info

Anonymous

Collect and retrieve the list of product render info.

Catalog · Magento\Catalog\Api\ProductRenderListInterface::getList

GET

/V1/products/:sku

Get info about product by product SKU

Catalog · Magento\Catalog\Api\ProductRepositoryInterface::get

GET

/V1/products/:sku/group-prices/:customerGroupId/tiers

Get tier price of product

Catalog · Magento\Catalog\Api\ProductTierPriceManagementInterface::getList

GET

/V1/products/:sku/links/:type

Provide the list of links for a specific product

Catalog · Magento\Catalog\Api\ProductLinkManagementInterface::getLinkedItemsByType

GET

/V1/products/:sku/media

Retrieve the list of gallery entries associated with given product

Catalog · Magento\Catalog\Api\ProductAttributeMediaGalleryManagementInterface::getList

GET

/V1/products/:sku/media/:entryId

Return information about gallery entry

Catalog · Magento\Catalog\Api\ProductAttributeMediaGalleryManagementInterface::get

GET

/V1/products/:sku/options

Get the list of custom options for a specific product

Catalog · Magento\Catalog\Api\ProductCustomOptionRepositoryInterface::getList

GET

/V1/products/:sku/options/:optionId

Get custom option for a specific product

Catalog · Magento\Catalog\Api\ProductCustomOptionRepositoryInterface::get

GET

/V1/products/attribute-sets/:attributeSetId

Retrieve attribute set information based on given ID

Catalog · Magento\Catalog\Api\AttributeSetRepositoryInterface::get

GET

/V1/products/attribute-sets/:attributeSetId/attributes

Retrieve related attributes based on given attribute set ID

Catalog · Magento\Catalog\Api\ProductAttributeManagementInterface::getAttributes

GET

/V1/products/attribute-sets/groups/list

Retrieve list of attribute groups

Catalog · Magento\Catalog\Api\ProductAttributeGroupRepositoryInterface::getList

GET

/V1/products/attribute-sets/sets/list

Retrieve list of Attribute Sets

Catalog · Magento\Catalog\Api\AttributeSetRepositoryInterface::getList

GET

/V1/products/attributes

Retrieve all attributes for entity type

Catalog · Magento\Catalog\Api\ProductAttributeRepositoryInterface::getList

GET

/V1/products/attributes/:attributeCode

Retrieve specific attribute

Catalog · Magento\Catalog\Api\ProductAttributeRepositoryInterface::get

GET

/V1/products/attributes/:attributeCode/is-filterable

Retrieve 'is_filterable' property for specific attribute as integer

Catalog · Magento\Catalog\Api\ProductAttributeIsFilterableManagementInterface::get

GET

/V1/products/attributes/:attributeCode/options

Retrieve list of attribute options

Catalog · Magento\Catalog\Api\ProductAttributeOptionManagementInterface::getItems

GET

/V1/products/attributes/types

Retrieve list of product attribute types

Catalog · Magento\Catalog\Api\ProductAttributeTypesListInterface::getItems

GET

/V1/products/links/:type/attributes

Provide a list of the product link type attributes

Catalog · Magento\Catalog\Api\ProductLinkTypeListInterface::getItemAttributes

GET

/V1/products/links/types

Retrieve information about available product link types

Catalog · Magento\Catalog\Api\ProductLinkTypeListInterface::getItems

GET

/V1/products/media/types/:attributeSetName

Retrieve the list of media attributes (fronted input type is media_image) assigned to the given attribute set.

Catalog · Magento\Catalog\Api\ProductMediaAttributeManagementInterface::getList

GET

/V1/products/options/types

Get custom option types

Catalog · Magento\Catalog\Api\ProductCustomOptionTypeListInterface::getItems

GET

/V1/products/types

Retrieve available product types

Catalog · Magento\Catalog\Api\ProductTypeListInterface::getProductTypes

GET

/V1/stockItems/:productSku

CatalogInventory · Magento\CatalogInventory\Api\StockRegistryInterface::getStockItemBySku

GET

/V1/stockItems/lowStock/

Retrieves a list of SKU's with low inventory qty

CatalogInventory · Magento\CatalogInventory\Api\StockRegistryInterface::getLowStockItems

GET

/V1/stockStatuses/:productSku

CatalogInventory · Magento\CatalogInventory\Api\StockRegistryInterface::getStockStatusBySku

GET

/V1/carts/mine/payment-information

Self

Get payment information

Checkout · Magento\Checkout\Api\PaymentInformationManagementInterface::getPaymentInformation

GET

/V1/guest-carts/:cartId/payment-information

Anonymous

Get payment information

Checkout · Magento\Checkout\Api\GuestPaymentInformationManagementInterface::getPaymentInformation

GET

/V1/carts/licence

Lists active checkout agreements.

CheckoutAgreements · Magento\CheckoutAgreements\Api\CheckoutAgreementsRepositoryInterface::getList

GET

/V1/carts/licence/list

List of checkout agreements.

CheckoutAgreements · Magento\CheckoutAgreements\Api\CheckoutAgreementsListInterface::getList

GET

/V1/cmsBlock/:blockId

Retrieve block.

Cms · Magento\Cms\Api\BlockRepositoryInterface::getById

GET

/V1/cmsBlock/search

Retrieve blocks matching the specified criteria.

Cms · Magento\Cms\Api\BlockRepositoryInterface::getList

GET

/V1/cmsPage/:pageId

Retrieve page.

Cms · Magento\Cms\Api\PageRepositoryInterface::getById

GET

/V1/cmsPage/search

Retrieve pages matching the specified criteria.

Cms · Magento\Cms\Api\PageRepositoryInterface::getList

GET

/V1/configurable-products/:sku/children

Get all children for Configurable product

ConfigurableProduct · Magento\ConfigurableProduct\Api\LinkManagementInterface::getChildren

GET

/V1/configurable-products/:sku/options/:id

Get option for configurable product

ConfigurableProduct · Magento\ConfigurableProduct\Api\OptionRepositoryInterface::get

GET

/V1/configurable-products/:sku/options/all

Get all options for configurable product

ConfigurableProduct · Magento\ConfigurableProduct\Api\OptionRepositoryInterface::getList

GET

/V1/attributeMetadata/customer

Customer · Magento\Customer\Api\CustomerMetadataInterface::getAllAttributesMetadata

GET

/V1/attributeMetadata/customer/attribute/:attributeCode

Customer · Magento\Customer\Api\CustomerMetadataInterface::getAttributeMetadata

GET

/V1/attributeMetadata/customer/custom

Customer · Magento\Customer\Api\CustomerMetadataInterface::getCustomAttributesMetadata

GET

/V1/attributeMetadata/customer/form/:formCode

Customer · Magento\Customer\Api\CustomerMetadataInterface::getAttributes

GET

/V1/attributeMetadata/customerAddress

Customer · Magento\Customer\Api\AddressMetadataInterface::getAllAttributesMetadata

GET

/V1/attributeMetadata/customerAddress/attribute/:attributeCode

Customer · Magento\Customer\Api\AddressMetadataInterface::getAttributeMetadata

GET

/V1/attributeMetadata/customerAddress/custom

Customer · Magento\Customer\Api\AddressMetadataInterface::getCustomAttributesMetadata

GET

/V1/attributeMetadata/customerAddress/form/:formCode

Customer · Magento\Customer\Api\AddressMetadataInterface::getAttributes

GET

/V1/customerGroups/:id

Get customer group by group ID.

Customer · Magento\Customer\Api\GroupRepositoryInterface::getById

GET

/V1/customerGroups/:id/permissions

Check if customer group can be deleted.

Customer · Magento\Customer\Api\GroupManagementInterface::isReadonly

GET

/V1/customerGroups/default

Get default customer group.

Customer · Magento\Customer\Api\GroupManagementInterface::getDefaultGroup

GET

/V1/customerGroups/default/:storeId

Get default customer group.

Customer · Magento\Customer\Api\GroupManagementInterface::getDefaultGroup

GET

/V1/customerGroups/search

Retrieve customer groups.

Customer · Magento\Customer\Api\GroupRepositoryInterface::getList

GET

/V1/customers/:customerId

Get customer by Customer ID.

Customer · Magento\Customer\Api\CustomerRepositoryInterface::getById

GET

/V1/customers/:customerId/billingAddress

Retrieve default billing address for the given customerId.

Customer · Magento\Customer\Api\AccountManagementInterface::getDefaultBillingAddress

GET

/V1/customers/:customerId/confirm

Gets the account confirmation status.

Customer · Magento\Customer\Api\AccountManagementInterface::getConfirmationStatus

GET

/V1/customers/:customerId/password/resetLinkToken/:resetPasswordLinkToken

Anonymous

Check if password reset token is valid.

Customer · Magento\Customer\Api\AccountManagementInterface::validateResetPasswordLinkToken

GET

/V1/customers/:customerId/permissions/readonly

Check if customer can be deleted.

Customer · Magento\Customer\Api\AccountManagementInterface::isReadonly

GET

/V1/customers/:customerId/shippingAddress

Retrieve default shipping address for the given customerId.

Customer · Magento\Customer\Api\AccountManagementInterface::getDefaultShippingAddress

GET

/V1/customers/addresses/:addressId

Retrieve customer address.

Customer · Magento\Customer\Api\AddressRepositoryInterface::getById

GET

/V1/customers/me

Self

Get customer by Customer ID.

Customer · Magento\Customer\Api\CustomerRepositoryInterface::getById

GET

/V1/customers/me/billingAddress

Self

Retrieve default billing address for the given customerId.

Customer · Magento\Customer\Api\AccountManagementInterface::getDefaultBillingAddress

GET

/V1/customers/me/shippingAddress

Self

Retrieve default shipping address for the given customerId.

Customer · Magento\Customer\Api\AccountManagementInterface::getDefaultShippingAddress

GET

/V1/customers/search

Retrieve customers which match a specified criteria.

Customer · Magento\Customer\Api\CustomerRepositoryInterface::getList

GET

/V1/directory/countries

Anonymous

Get all countries and regions information for the store.

Directory · Magento\Directory\Api\CountryInformationAcquirerInterface::getCountriesInfo

GET

/V1/directory/countries/:countryId

Anonymous

Get country and region information for the store.

Directory · Magento\Directory\Api\CountryInformationAcquirerInterface::getCountryInfo

GET

/V1/directory/currency

Anonymous

Get currency information for the store.

Directory · Magento\Directory\Api\CurrencyInformationAcquirerInterface::getCurrencyInfo

GET

/V1/products/:sku/downloadable-links

List of links with associated samples

Downloadable · Magento\Downloadable\Api\LinkRepositoryInterface::getList

GET

/V1/products/:sku/downloadable-links/samples

List of samples for downloadable product

Downloadable · Magento\Downloadable\Api\SampleRepositoryInterface::getList

GET

/V1/eav/attribute-sets/:attributeSetId

Retrieve attribute set information based on given ID

Eav · Magento\Eav\Api\AttributeSetRepositoryInterface::get

GET

/V1/eav/attribute-sets/list

Retrieve list of Attribute Sets

Eav · Magento\Eav\Api\AttributeSetRepositoryInterface::getList

GET

/V1/carts/:cartId/gift-message

Return the gift message for a specified order.

GiftMessage · Magento\GiftMessage\Api\CartRepositoryInterface::get

GET

/V1/carts/:cartId/gift-message/:itemId

Return the gift message for a specified item in a specified shopping cart.

GiftMessage · Magento\GiftMessage\Api\ItemRepositoryInterface::get

GET

/V1/carts/mine/gift-message

Self

Return the gift message for a specified order.

GiftMessage · Magento\GiftMessage\Api\CartRepositoryInterface::get

GET

/V1/carts/mine/gift-message/:itemId

Self

Return the gift message for a specified item in a specified shopping cart.

GiftMessage · Magento\GiftMessage\Api\ItemRepositoryInterface::get

GET

/V1/guest-carts/:cartId/gift-message

Anonymous

Return the gift message for a specified order.

GiftMessage · Magento\GiftMessage\Api\GuestCartRepositoryInterface::get

GET

/V1/guest-carts/:cartId/gift-message/:itemId

Anonymous

Return the gift message for a specified item in a specified shopping cart.

GiftMessage · Magento\GiftMessage\Api\GuestItemRepositoryInterface::get

GET

/V1/inventory/get-sources-assigned-to-stock-ordered-by-priority/:stockId

Get Sources assigned to Stock ordered by priority

InventoryApi · Magento\InventoryApi\Api\GetSourcesAssignedToStockOrderedByPriorityInterface::execute

GET

/V1/inventory/source-items

Find SourceItems by SearchCriteria

InventoryApi · Magento\InventoryApi\Api\SourceItemRepositoryInterface::getList

GET

/V1/inventory/sources

Find Sources by SearchCriteria

InventoryApi · Magento\InventoryApi\Api\SourceRepositoryInterface::getList

GET

/V1/inventory/sources/:sourceCode

Get Source data by given code. If you want to create plugin on get method, also you need to create separate

InventoryApi · Magento\InventoryApi\Api\SourceRepositoryInterface::get

GET

/V1/inventory/stock-source-links

Find StockSourceLink list by given SearchCriteria

InventoryApi · Magento\InventoryApi\Api\GetStockSourceLinksInterface::execute

GET

/V1/inventory/stocks

Find Stocks by given SearchCriteria

InventoryApi · Magento\InventoryApi\Api\StockRepositoryInterface::getList

GET

/V1/inventory/stocks/:stockId

Get Stock data by given stockId. If you want to create plugin on get method, also you need to create separate

InventoryApi · Magento\InventoryApi\Api\StockRepositoryInterface::get

GET

/V1/inventory/get-distance

Get distance between two points

InventoryDistanceBasedSourceSelectionApi · Magento\InventoryDistanceBasedSourceSelectionApi\Api\GetDistanceInterface::execute

GET

/V1/inventory/get-distance-provider-code

Get Default distance provider code

InventoryDistanceBasedSourceSelectionApi · Magento\InventoryDistanceBasedSourceSelectionApi\Api\GetDistanceProviderCodeInterface::execute

GET

/V1/inventory/get-latlng-from-address

Get latitude and longitude object from address

InventoryDistanceBasedSourceSelectionApi · Magento\InventoryDistanceBasedSourceSelectionApi\Api\GetLatLngFromAddressInterface::execute

GET

/V1/inventory/get-latslngs-from-address

Get all available latitude and longitude objects from address.

InventoryDistanceBasedSourceSelectionApi · Magento\InventoryDistanceBasedSourceSelectionApi\Api\GetLatsLngsFromAddressInterface::execute

GET

/V1/inventory/dump-stock-index-data/:salesChannelType/:salesChannelCode

Provides stock index export from inventory_stock_% table

InventoryExportStockApi · Magento\InventoryExportStockApi\Api\ExportStockIndexDataInterface::execute

GET

/V1/inventory/export-stock-salable-qty/:salesChannelType/:salesChannelCode

Export product stock data filtered by search criteria.

InventoryExportStockApi · Magento\InventoryExportStockApi\Api\ExportStockSalableQtyInterface::execute

GET

/V1/inventory/in-store-pickup/pickup-locations/

Anonymous

Get Pickup Locations according to the results of filtration by Search Request.

InventoryInStorePickupApi · Magento\InventoryInStorePickupApi\Api\GetPickupLocationsInterface::execute

GET

/V1/inventory/low-quantity-notification/:sourceCode/:sku

Get the source item configuration

InventoryLowQuantityNotificationApi · Magento\InventoryLowQuantityNotificationApi\Api\GetSourceItemConfigurationInterface::execute

GET

/V1/inventory/are-product-salable-for-requested-qty/

Get whether products are salable in requested Qty for given set of SKUs in specified stock.

InventorySalesApi · Magento\InventorySalesApi\Api\AreProductsSalableForRequestedQtyInterface::execute

GET

/V1/inventory/are-products-salable

Get products salable status for given SKUs and given Stock.

InventorySalesApi · Magento\InventorySalesApi\Api\AreProductsSalableInterface::execute

GET

/V1/inventory/get-product-salable-quantity/:sku/:stockId

Get Product Quantity for given SKU and Stock

InventorySalesApi · Magento\InventorySalesApi\Api\GetProductSalableQtyInterface::execute

GET

/V1/inventory/is-product-salable-for-requested-qty/:sku/:stockId/:requestedQty

Get is product salable for given SKU in a given Stock for a certain Qty

InventorySalesApi · Magento\InventorySalesApi\Api\IsProductSalableForRequestedQtyInterface::execute

GET

/V1/inventory/is-product-salable/:sku/:stockId

Get is product in salable for given SKU in a given Stock

InventorySalesApi · Magento\InventorySalesApi\Api\IsProductSalableInterface::execute

GET

/V1/inventory/stock-resolver/:type/:code

Resolve Stock by Sales Channel type and code

InventorySalesApi · Magento\InventorySalesApi\Api\StockResolverInterface::execute

GET

/V1/inventory/source-selection-algorithm-list

Returns a list of registered Source Selection Algorithm (SSA) data interfaces available in the system.

InventorySourceSelectionApi · Magento\InventorySourceSelectionApi\Api\GetSourceSelectionAlgorithmListInterface::execute

GET

/V1/carts/mine/payment-order/:id

Self

Get payment order for logged in customer

PaymentServicesPaypal · Magento\PaymentServicesPaypal\Api\PaymentOrderRequestInterface::get

GET

/V1/guest-carts/:cartId/payment-order/:id

Anonymous

Get payment order for guest customer

PaymentServicesPaypal · Magento\PaymentServicesPaypal\Api\PaymentOrderRequestInterface::getForGuest

GET

/V1/payments-config/:location

Anonymous

Get Config.

PaymentServicesPaypal · Magento\PaymentServicesPaypal\Api\PaymentConfigRequestInterface::getConfig

GET

/V1/payments-config/apple-pay/:location

Anonymous

Get Apple Pay Config.

PaymentServicesPaypal · Magento\PaymentServicesPaypal\Api\PaymentConfigRequestInterface::getApplePayConfig

GET

/V1/payments-config/google-pay/:location

Anonymous

Get Google Pay Config.

PaymentServicesPaypal · Magento\PaymentServicesPaypal\Api\PaymentConfigRequestInterface::getGooglePayConfig

GET

/V1/payments-config/hosted-fields/:location

Anonymous

Get Hosted Fields Config.

PaymentServicesPaypal · Magento\PaymentServicesPaypal\Api\PaymentConfigRequestInterface::getHostedFieldsConfig

GET

/V1/payments-config/smart-buttons/:location

Anonymous

Get Smart Buttons Config.

PaymentServicesPaypal · Magento\PaymentServicesPaypal\Api\PaymentConfigRequestInterface::getSmartButtonsConfig

GET

/V1/payments-sdk/:location

Anonymous

Get payment sdk url by location

PaymentServicesPaypal · Magento\PaymentServicesPaypal\Api\PaymentSdkRequestInterface::getByLocation

GET

/V1/payments-sdk/:location/:methodCode

Anonymous

Get payment sdk url by location and methodCode

PaymentServicesPaypal · Magento\PaymentServicesPaypal\Api\PaymentSdkRequestInterface::getByLocationAndMethodCode

GET

/V1/carts/:cartId

Enables an administrative user to return information for a specified cart.

Quote · Magento\Quote\Api\CartRepositoryInterface::get

GET

/V1/carts/:cartId/billing-address

Returns the billing address for a specified quote.

Quote · Magento\Quote\Api\BillingAddressManagementInterface::get

GET

/V1/carts/:cartId/coupons

Returns information for a coupon in a specified cart.

Quote · Magento\Quote\Api\CouponManagementInterface::get

GET

/V1/carts/:cartId/items

Lists items that are assigned to a specified cart.

Quote · Magento\Quote\Api\CartItemRepositoryInterface::getList

GET

/V1/carts/:cartId/payment-methods

Lists available payment methods for a specified shopping cart.

Quote · Magento\Quote\Api\PaymentMethodManagementInterface::getList

GET

/V1/carts/:cartId/selected-payment-method

Returns the payment method for a specified shopping cart.

Quote · Magento\Quote\Api\PaymentMethodManagementInterface::get

GET

/V1/carts/:cartId/shipping-methods

Lists applicable shipping methods for a specified quote.

Quote · Magento\Quote\Api\ShippingMethodManagementInterface::getList

GET

/V1/carts/:cartId/totals

Returns quote totals data for a specified cart.

Quote · Magento\Quote\Api\CartTotalRepositoryInterface::get

GET

/V1/carts/mine

Self

Returns information for the cart for a specified customer.

Quote · Magento\Quote\Api\CartManagementInterface::getCartForCustomer

GET

/V1/carts/mine/billing-address

Self

Returns the billing address for a specified quote.

Quote · Magento\Quote\Api\BillingAddressManagementInterface::get

GET

/V1/carts/mine/coupons

Self

Returns information for a coupon in a specified cart.

Quote · Magento\Quote\Api\CouponManagementInterface::get

GET

/V1/carts/mine/items

Self

Lists items that are assigned to a specified cart.

Quote · Magento\Quote\Api\CartItemRepositoryInterface::getList

GET

/V1/carts/mine/payment-methods

Self

Lists available payment methods for a specified shopping cart.

Quote · Magento\Quote\Api\PaymentMethodManagementInterface::getList

GET

/V1/carts/mine/selected-payment-method

Self

Returns the payment method for a specified shopping cart.

Quote · Magento\Quote\Api\PaymentMethodManagementInterface::get

GET

/V1/carts/mine/shipping-methods

Self

Lists applicable shipping methods for a specified quote.

Quote · Magento\Quote\Api\ShippingMethodManagementInterface::getList

GET

/V1/carts/mine/totals

Self

Returns quote totals data for a specified cart.

Quote · Magento\Quote\Api\CartTotalRepositoryInterface::get

GET

/V1/carts/search

Enables administrative users to list carts that match specified search criteria.

Quote · Magento\Quote\Api\CartRepositoryInterface::getList

GET

/V1/guest-carts/:cartId

Anonymous

Enable a guest user to return information for a specified cart.

Quote · Magento\Quote\Api\GuestCartRepositoryInterface::get

GET

/V1/guest-carts/:cartId/billing-address

Anonymous

Return the billing address for a specified quote.

Quote · Magento\Quote\Api\GuestBillingAddressManagementInterface::get

GET

/V1/guest-carts/:cartId/coupons

Anonymous

Return information for a coupon in a specified cart.

Quote · Magento\Quote\Api\GuestCouponManagementInterface::get

GET

/V1/guest-carts/:cartId/items

Anonymous

List items that are assigned to a specified cart.

Quote · Magento\Quote\Api\GuestCartItemRepositoryInterface::getList

GET

/V1/guest-carts/:cartId/payment-methods

Anonymous

List available payment methods for a specified shopping cart.

Quote · Magento\Quote\Api\GuestPaymentMethodManagementInterface::getList

GET

/V1/guest-carts/:cartId/selected-payment-method

Anonymous

Return the payment method for a specified shopping cart.

Quote · Magento\Quote\Api\GuestPaymentMethodManagementInterface::get

GET

/V1/guest-carts/:cartId/shipping-methods

Anonymous

List applicable shipping methods for a specified quote.

Quote · Magento\Quote\Api\GuestShippingMethodManagementInterface::getList

GET

/V1/guest-carts/:cartId/totals

Anonymous

Return quote totals data for a specified cart.

Quote · Magento\Quote\Api\GuestCartTotalRepositoryInterface::get

GET

/V1/creditmemo/:id

Loads a specified credit memo.

Sales · Magento\Sales\Api\CreditmemoRepositoryInterface::get

GET

/V1/creditmemo/:id/comments

Lists comments for a specified credit memo.

Sales · Magento\Sales\Api\CreditmemoManagementInterface::getCommentsList

GET

/V1/creditmemos

Lists credit memos that match specified search criteria.

Sales · Magento\Sales\Api\CreditmemoRepositoryInterface::getList

GET

/V1/invoices

Lists invoices that match specified search criteria.

Sales · Magento\Sales\Api\InvoiceRepositoryInterface::getList

GET

/V1/invoices/:id

Loads a specified invoice.

Sales · Magento\Sales\Api\InvoiceRepositoryInterface::get

GET

/V1/invoices/:id/comments

Lists comments for a specified invoice.

Sales · Magento\Sales\Api\InvoiceManagementInterface::getCommentsList

GET

/V1/orders

Lists orders that match specified search criteria.

Sales · Magento\Sales\Api\OrderRepositoryInterface::getList

GET

/V1/orders/:id

Loads a specified order.

Sales · Magento\Sales\Api\OrderRepositoryInterface::get

GET

/V1/orders/:id/comments

Lists comments for a specified order.

Sales · Magento\Sales\Api\OrderManagementInterface::getCommentsList

GET

/V1/orders/:id/statuses

Gets the status for a specified order.

Sales · Magento\Sales\Api\OrderManagementInterface::getStatus

GET

/V1/orders/items

Lists order items that match specified search criteria.

Sales · Magento\Sales\Api\OrderItemRepositoryInterface::getList

GET

/V1/orders/items/:id

Loads a specified order item.

Sales · Magento\Sales\Api\OrderItemRepositoryInterface::get

GET

/V1/shipment/:id

Loads a specified shipment.

Sales · Magento\Sales\Api\ShipmentRepositoryInterface::get

GET

/V1/shipment/:id/comments

Lists comments for a specified shipment.

Sales · Magento\Sales\Api\ShipmentManagementInterface::getCommentsList

GET

/V1/shipment/:id/label

Gets a specified shipment label.

Sales · Magento\Sales\Api\ShipmentManagementInterface::getLabel

GET

/V1/shipments

Lists shipments that match specified search criteria.

Sales · Magento\Sales\Api\ShipmentRepositoryInterface::getList

GET

/V1/transactions

Lists transactions that match specified search criteria.

Sales · Magento\Sales\Api\TransactionRepositoryInterface::getList

GET

/V1/transactions/:id

Loads a specified transaction.

Sales · Magento\Sales\Api\TransactionRepositoryInterface::get

GET

/V1/coupons/:couponId

Get coupon by coupon id.

SalesRule · Magento\SalesRule\Api\CouponRepositoryInterface::getById

GET

/V1/coupons/search

Retrieve a coupon using the specified search criteria.

SalesRule · Magento\SalesRule\Api\CouponRepositoryInterface::getList

GET

/V1/salesRules/:ruleId

Get rule by ID.

SalesRule · Magento\SalesRule\Api\RuleRepositoryInterface::getById

GET

/V1/salesRules/search

Retrieve sales rules that match te specified criteria.

SalesRule · Magento\SalesRule\Api\RuleRepositoryInterface::getList

GET

/V1/search

Anonymous

Search · Magento\Search\Api\SearchInterface::search

GET

/V1/store/storeConfigs

Store · Magento\Store\Api\StoreConfigManagerInterface::getStoreConfigs

GET

/V1/store/storeGroups

Retrieve list of all groups

Store · Magento\Store\Api\GroupRepositoryInterface::getList

GET

/V1/store/storeViews

Retrieve list of all stores

Store · Magento\Store\Api\StoreRepositoryInterface::getList

GET

/V1/store/websites

Retrieve list of all websites

Store · Magento\Store\Api\WebsiteRepositoryInterface::getList

GET

/V1/taxClasses/:taxClassId

Get a tax class with the given tax class id.

Tax · Magento\Tax\Api\TaxClassRepositoryInterface::get

GET

/V1/taxClasses/search

Retrieve tax classes which match a specific criteria.

Tax · Magento\Tax\Api\TaxClassRepositoryInterface::getList

GET

/V1/taxRates/:rateId

Get tax rate

Tax · Magento\Tax\Api\TaxRateRepositoryInterface::get

GET

/V1/taxRates/search

Search TaxRates

Tax · Magento\Tax\Api\TaxRateRepositoryInterface::getList

GET

/V1/taxRules/:ruleId

Get TaxRule

Tax · Magento\Tax\Api\TaxRuleRepositoryInterface::get

GET

/V1/taxRules/search

Search TaxRules

Tax · Magento\Tax\Api\TaxRuleRepositoryInterface::getList

GET

/V1/tfa/default-provider-code/:userId

Get default provider

TwoFactorAuth · Magento\TwoFactorAuth\Api\UserConfigManagerInterface::getDefaultProvider

GET

/V1/tfa/forced-providers

Retrieve forced providers list

TwoFactorAuth · Magento\TwoFactorAuth\Api\TfaInterface::getForcedProviders

GET

/V1/tfa/installed-providers

Get a list of providers

TwoFactorAuth · Magento\TwoFactorAuth\Api\TfaInterface::getAllProviders

GET

/V1/tfa/providers-to-activate/:userId

Returns a list of providers to configure/enroll

TwoFactorAuth · Magento\TwoFactorAuth\Api\TfaInterface::getProvidersToActivate

GET

/V1/tfa/tfat-providers-to-activate

Anonymous

Get the providers that the user still needs to configure

TwoFactorAuth · Magento\TwoFactorAuth\Api\TfatActionsInterface::getProvidersToActivate

GET

/V1/tfa/tfat-user-providers

Anonymous

Get the providers that the user is able to use for 2fa

TwoFactorAuth · Magento\TwoFactorAuth\Api\TfatActionsInterface::getUserProviders

GET

/V1/tfa/user-providers/:userId

Get a user provider

TwoFactorAuth · Magento\TwoFactorAuth\Api\TfaInterface::getUserProviders

GET

/V1/customers/:id

Get customer by Customer ID.

Webapi · Magento\Customer\Api\CustomerRepositoryInterface::getById

GET

/V1/customers/me

Get customer by Customer ID.

Webapi · Magento\Customer\Api\CustomerRepositoryInterface::getById

GET

/V1/customers/me/session

Get customer by Customer ID.

Webapi · Magento\Customer\Api\CustomerRepositoryInterface::getById

Last verified: against Magento 2.4.9.

Every Magento dev tool, in one hosted workspace.

Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.