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.

63 result(s) in PUT · Clear

PUT

/V1/bundle-products/:sku/links/:id

Bundle · Magento\Bundle\Api\ProductLinkManagementInterface::saveChild

PUT

/V1/bundle-products/options/:optionId

Add new option for bundle product

Bundle · Magento\Bundle\Api\ProductOptionManagementInterface::save

PUT

/V1/categories/:categoryId/move

Move category

Catalog · Magento\Catalog\Api\CategoryManagementInterface::move

PUT

/V1/categories/:categoryId/products

Assign a product to the required category

Catalog · Magento\Catalog\Api\CategoryLinkRepositoryInterface::save

PUT

/V1/categories/:id

Create category service

Catalog · Magento\Catalog\Api\CategoryRepositoryInterface::save

PUT

/V1/products/:sku

Create product

Catalog · Magento\Catalog\Api\ProductRepositoryInterface::save

PUT

/V1/products/:sku/links

Save product link

Catalog · Magento\Catalog\Api\ProductLinkRepositoryInterface::save

PUT

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

Update gallery entry

Catalog · Magento\Catalog\Api\ProductAttributeMediaGalleryManagementInterface::update

PUT

/V1/products/:sku/websites

Assign a product to the website

Catalog · Magento\Catalog\Api\ProductWebsiteLinkRepositoryInterface::save

PUT

/V1/products/attribute-sets/:attributeSetId

Save attribute set data

Catalog · Magento\Catalog\Api\AttributeSetRepositoryInterface::save

PUT

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

Save attribute group

Catalog · Magento\Catalog\Api\ProductAttributeGroupRepositoryInterface::save

PUT

/V1/products/attributes/:attributeCode

Save attribute data

Catalog · Magento\Catalog\Api\ProductAttributeRepositoryInterface::save

PUT

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

Set 'is_filterable' property for specific attribute as integer

Catalog · Magento\Catalog\Api\ProductAttributeIsFilterableManagementInterface::set

PUT

/V1/products/attributes/:attributeCode/options/:optionId

Update attribute option

Catalog · Magento\Catalog\Api\ProductAttributeOptionUpdateInterface::update

PUT

/V1/products/options/:optionId

Save Custom Option

Catalog · Magento\Catalog\Api\ProductCustomOptionRepositoryInterface::save

PUT

/V1/products/tier-prices

Remove existing tier prices and replace them with the new ones. If any items will have invalid price, price type, website id, sku, customer group or quantity, they will be marked as failed and excluded from replace list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.

Catalog · Magento\Catalog\Api\TierPriceStorageInterface::replace

PUT

/V1/products/:productSku/stockItems/:itemId

CatalogInventory · Magento\CatalogInventory\Api\StockRegistryInterface::updateStockItemBySku

PUT

/V1/cmsBlock/:id

Save block.

Cms · Magento\Cms\Api\BlockRepositoryInterface::save

PUT

/V1/cmsPage/:id

Save page.

Cms · Magento\Cms\Api\PageRepositoryInterface::save

PUT

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

Save option

ConfigurableProduct · Magento\ConfigurableProduct\Api\OptionRepositoryInterface::save

PUT

/V1/configurable-products/variation

Generate variation based on same product

ConfigurableProduct · Magento\ConfigurableProduct\Api\ConfigurableProductManagementInterface::generateVariation

PUT

/V1/customerGroups/:id

Save customer group.

Customer · Magento\Customer\Api\GroupRepositoryInterface::save

PUT

/V1/customerGroups/default/:id

Set system default customer group.

Customer · Magento\Customer\Api\CustomerGroupConfigInterface::setDefaultCustomerGroup

PUT

/V1/customers/:customerId

Create or update a customer.

Customer · Magento\Customer\Api\CustomerRepositoryInterface::save

PUT

/V1/customers/:email/activate

Activate a customer account using a key that was sent in a confirmation email.

Customer · Magento\Customer\Api\AccountManagementInterface::activate

PUT

/V1/customers/me

Self

Create or update a customer.

Customer · Magento\Customer\Api\CustomerRepositoryInterface::save

PUT

/V1/customers/me/activate

Self

Activate a customer account using a key that was sent in a confirmation email.

Customer · Magento\Customer\Api\AccountManagementInterface::activateById

PUT

/V1/customers/me/password

Self

Change customer password.

Customer · Magento\Customer\Api\AccountManagementInterface::changePasswordById

PUT

/V1/customers/password

Anonymous

Send an email to the customer with a password reset link.

Customer · Magento\Customer\Api\AccountManagementInterface::initiatePasswordReset

PUT

/V1/customers/validate

Validate customer data.

Customer · Magento\Customer\Api\AccountManagementInterface::validate

PUT

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

Update downloadable link of the given product (link type and its resources cannot be changed)

Downloadable · Magento\Downloadable\Api\LinkRepositoryInterface::save

PUT

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

Update downloadable sample of the given product

Downloadable · Magento\Downloadable\Api\SampleRepositoryInterface::save

PUT

/V1/eav/attribute-sets/:attributeSetId

Save attribute set data

Eav · Magento\Eav\Api\AttributeSetRepositoryInterface::save

PUT

/V1/inventory/sources/:sourceCode

Save Source data

InventoryApi · Magento\InventoryApi\Api\SourceRepositoryInterface::save

PUT

/V1/inventory/stocks/:stockId

Save Stock data

InventoryApi · Magento\InventoryApi\Api\StockRepositoryInterface::save

PUT

/V1/carts/:cartId

Assigns a specified customer to a specified shopping cart.

Quote · Magento\Quote\Api\CartManagementInterface::assignCustomer

PUT

/V1/carts/:cartId/coupons/:couponCode

Adds a coupon by code to a specified cart.

Quote · Magento\Quote\Api\CouponManagementInterface::set

PUT

/V1/carts/:cartId/items/:itemId

Add/update the specified cart item.

Quote · Magento\Quote\Api\CartItemRepositoryInterface::save

PUT

/V1/carts/:cartId/order

Places an order for a specified cart.

Quote · Magento\Quote\Api\CartManagementInterface::placeOrder

PUT

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

Adds a specified payment method to a specified shopping cart.

Quote · Magento\Quote\Api\PaymentMethodManagementInterface::set

PUT

/V1/carts/mine

Self

Save quote

Quote · Magento\Quote\Api\CartRepositoryInterface::save

PUT

/V1/carts/mine/collect-totals

Self

Set shipping/billing methods and additional data for cart and collect totals.

Quote · Magento\Quote\Api\CartTotalManagementInterface::collectTotals

PUT

/V1/carts/mine/coupons/:couponCode

Self

Adds a coupon by code to a specified cart.

Quote · Magento\Quote\Api\CouponManagementInterface::set

PUT

/V1/carts/mine/items/:itemId

Self

Add/update the specified cart item.

Quote · Magento\Quote\Api\CartItemRepositoryInterface::save

PUT

/V1/carts/mine/order

Self

Places an order for a specified cart.

Quote · Magento\Quote\Api\CartManagementInterface::placeOrder

PUT

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

Self

Adds a specified payment method to a specified shopping cart.

Quote · Magento\Quote\Api\PaymentMethodManagementInterface::set

PUT

/V1/guest-carts/:cartId

Self

Assign a specified customer to a specified shopping cart.

Quote · Magento\Quote\Api\GuestCartManagementInterface::assignCustomer

PUT

/V1/guest-carts/:cartId/collect-totals

Anonymous

Set shipping/billing methods and additional data for cart and collect totals for guest.

Quote · Magento\Quote\Api\GuestCartTotalManagementInterface::collectTotals

PUT

/V1/guest-carts/:cartId/coupons/:couponCode

Anonymous

Add a coupon by code to a specified cart.

Quote · Magento\Quote\Api\GuestCouponManagementInterface::set

PUT

/V1/guest-carts/:cartId/items/:itemId

Anonymous

Add/update the specified cart item.

Quote · Magento\Quote\Api\GuestCartItemRepositoryInterface::save

PUT

/V1/guest-carts/:cartId/order

Anonymous

Place an order for a specified cart.

Quote · Magento\Quote\Api\GuestCartManagementInterface::placeOrder

PUT

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

Anonymous

Add a specified payment method to a specified shopping cart.

Quote · Magento\Quote\Api\GuestPaymentMethodManagementInterface::set

PUT

/V1/creditmemo/:id

Cancels a specified credit memo.

Sales · Magento\Sales\Api\CreditmemoManagementInterface::cancel

PUT

/V1/orders/:parent_id

Performs persist operations for a specified order address.

Sales · Magento\Sales\Api\OrderAddressRepositoryInterface::save

PUT

/V1/orders/create

Performs persist operations for a specified order.

Sales · Magento\Sales\Api\OrderRepositoryInterface::save

PUT

/V1/coupons/:couponId

Save a coupon.

SalesRule · Magento\SalesRule\Api\CouponRepositoryInterface::save

PUT

/V1/salesRules/:ruleId

Save sales rule.

SalesRule · Magento\SalesRule\Api\RuleRepositoryInterface::save

PUT

/V1/taxClasses/:classId

Create a Tax Class

Tax · Magento\Tax\Api\TaxClassRepositoryInterface::save

PUT

/V1/taxRates

Create or update tax rate

Tax · Magento\Tax\Api\TaxRateRepositoryInterface::save

PUT

/V1/taxRules

Save TaxRule

Tax · Magento\Tax\Api\TaxRuleRepositoryInterface::save

PUT

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

Set default provider code

TwoFactorAuth · Magento\TwoFactorAuth\Api\TfaInterface::setDefaultProviderCode

PUT

/V1/tfa/user-providers/:userId

Set providers

TwoFactorAuth · Magento\TwoFactorAuth\Api\TfaInterface::setProvidersCodes

PUT

/V1/customers/me

Create or update a customer.

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

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.