Skip to content

Integration · E-commerce

business.adobe.com

Connect Claude & ChatGPT to Magento 2

Ask your AI where an order stands, which products are running low, or to change a price in Magento 2 (Adobe Commerce). It can search and handle orders, invoices, shipments and credit memos, manage products and stock, and look up customers and categories. Store questions get answered without clicking through the Admin.

Connect Magento 2 (Adobe Commerce) free

Free plan, no credit card. Takes about a minute.

Try asking

  • “What is the status of order 000001234?”

    The AI searches orders by increment ID and shows status, items, addresses and payment.

  • “Which products have 5 or fewer in stock?”

    It lists low-stock items at or below that quantity for the default scope.

  • “Ship order 000001234 with tracking number 00370712345678901234 and notify the customer.”

    It creates a shipment for the order with the tracking number and emails the customer.

What your AI can do

Orders

Search and read orders, add comments, hold and release, cancel, invoice, ship and refund offline with a credit memo.

Products and stock

Search, create and update products, read stock per product or per inventory source, list low stock and set source quantities.

Customers and store

Search, create and update customers, and read invoices, shipments, credit memos, categories and store view settings.

  • “Set the price of SKU TSHIRT-BLK-M to 199.”

    It updates that product's price by SKU and leaves the other fields as they are.

  • “Which orders from [email protected] came in this year?”

    It searches orders by customer email and creation date and lists them.

  • “Put order 000001240 on hold and add a comment that we are checking the address.”

    It holds the order and adds a status-history comment, without notifying the customer unless you ask.

583 tools for Magento 2 (Adobe Commerce)

These tools are switched on when you connect. You can switch any of them off, or require your approval before it runs.

  • add_order_commentChanges dataAdd a status-history comment to an order. Set `is_customer_notified` to email the customer and `is_visible_on_front` to show it in their account.
  • approve_customerVisible to othersConfirm a customer. Has effects visible outside this system. API summary: customers/confirm.
  • approve_customer_confirmVisible to othersConfirm a customer (customer id). Has effects visible outside this system. API summary: customers/{customerId}/confirm.
  • approve_quoteVisible to othersAccept a quote. Has effects visible outside this system. API summary: negotiableQuoteTemplate/accept.
  • attach_analyticChanges dataLink a analytic. API summary: analytics/link.
  • attach_company_rolesMoves moneyAssign a company. Financial or irreversible action; may require approval. API summary: company/assignRoles.
  • attach_shared_catalog_categoriesChanges dataAssign a shared catalog (shared catalog id). API summary: sharedCatalog/{id}/assignCategories.
  • attach_shared_catalog_companiesChanges dataAssign a shared catalog (shared catalog id). API summary: sharedCatalog/{sharedCatalogId}/assignCompanies.
  • attach_shared_catalog_productsChanges dataAssign a shared catalog (shared catalog id). API summary: sharedCatalog/{id}/assignProducts.
  • attach_shared_catalog_tier_pricesChanges dataAssign a shared catalog (shared catalog id). API summary: sharedCatalog/{sharedCatalogId}/assignTierPrices.
  • cancel_invoiceDeletesVoid a invoice (invoice id). Destructive action; may require approval. API summary: invoices/{id}/void.
  • cancel_orderDeletesCancel an order by `order_id`. Cannot be undone.
  • cancel_quoteDeletesCancel a quote. Destructive action; may require approval. API summary: negotiableQuoteTemplate/cancel.
  • create_addChanges dataCreate a new add. Required: option. API summary: bundle-products/options/add.
  • create_addressChanges dataCreate a new address. Required: address. Search addresses first to avoid duplicates. API summary: carts/mine/billing-address.
  • create_applyChanges dataCreate a new apply. API summary: carts/mine/balance/apply.
  • create_attribute_setChanges dataCreate a new attribute set. Required: entity type code, attribute set or skeleton id. API summary: eav/attribute-sets.
  • create_attribute_set_post_v1_products_attributesetsChanges dataCreate a new attribute set. Required: attribute set or skeleton id. API summary: products/attribute-sets.
  • create_authenticate_onetouchChanges dataCreate a new authenticate onetouch. Required: username or password. API summary: tfa/provider/authy/authenticate-onetouch.
  • create_authentication_challengeChanges dataCreate a new authentication challenge. Required: username or password. API summary: tfa/provider/u2fkey/authentication-challenge.
  • create_base_priceChanges dataCreate a new base price. Required: prices. API summary: products/base-prices.
  • create_base_prices_informationChanges dataCreate a new base prices information. Required: skus. API summary: products/base-prices-information.
  • create_bulk_partial_source_transferMoves moneyCreate a new bulk partial source transfer. Required: origin source code, destination source code or items. Financial or irreversible action; may require approval. API summary: inventory/bulk-partial-source-transfer.
  • create_bulk_product_source_assignVisible to othersCreate a new bulk product source assign. Required: skus or source codes. Has effects visible outside this system. API summary: inventory/bulk-product-source-assign.
  • create_bulk_product_source_transferMoves moneyCreate a new bulk product source transfer. Required: skus, origin source, destination source or unassign from origin. Financial or irreversible action; may require approval. API summary: inventory/bulk-product-source-transfer.
  • create_bulk_product_source_unassignVisible to othersCreate a new bulk product source unassign. Required: skus or source codes. Has effects visible outside this system. API summary: inventory/bulk-product-source-unassign.
  • create_cartChanges dataCreate a new cart. Search carts first to avoid duplicates. API summary: carts/.
  • create_cart_addressChanges dataCreate a new address for a cart. Required: address. Search addresses first to avoid duplicates. API summary: carts/{cartId}/billing-address.
  • create_cart_couponChanges dataCreate a new coupon for a cart. Required: coupon codes. Search coupons first to avoid duplicates. API summary: carts/{cartId}/coupons.
  • create_cart_estimate_shipping_methodChanges dataCreate a new estimate shipping method for a cart. Required: address. API summary: carts/{cartId}/estimate-shipping-methods.
  • create_cart_estimate_shipping_methods_by_address_idChanges dataCreate a new estimate shipping methods by address id for a cart. Required: address id. API summary: carts/{cartId}/estimate-shipping-methods-by-address-id.
  • create_cart_messageVisible to othersCreate a new message for a cart. Required: gift message. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: carts/{cartId}/gift-message.
  • create_cart_productChanges dataCreate a new product for a cart. Required: cart item. Search products first to avoid duplicates. API summary: carts/{quoteId}/items.
  • create_cart_shipping_informationChanges dataCreate a new shipping information for a cart. Required: address information. API summary: carts/{cartId}/shipping-information.
  • create_cart_totals_informationChanges dataCreate a new totals information for a cart. Required: address information. API summary: carts/{cartId}/totals-information.
  • create_categoryChanges dataCreate a new category. Required: category. Search categories first to avoid duplicates.
  • create_category_productChanges dataCreate a new product for a category. Required: product link. Search products first to avoid duplicates. API summary: categories/{categoryId}/products.
  • create_cms_blockChanges dataCreate a new cms block. Required: block. Search cms blocks first to avoid duplicates. API summary: cmsBlock.
  • create_companyChanges dataCreate a new company. Required: company. Search companies first to avoid duplicates. API summary: company/.
  • create_company_decrease_balanceChanges dataCreate a new decrease balance for a company. Required: value, currency or operation type. API summary: companyCredits/{creditId}/decreaseBalance.
  • create_company_increase_balanceChanges dataCreate a new increase balance for a company. Required: value, currency or operation type. API summary: companyCredits/{creditId}/increaseBalance.
  • create_company_post_v1_company_roleDeletesCreate a new company. Required: role. Search companies first to avoid duplicates. Destructive action; may require approval. API summary: company/role/.
  • create_company_post_v1_customers_companiesChanges dataCreate a new company. Required: company attributes. Search companies first to avoid duplicates. API summary: customers/companies.
  • create_company_relationChanges dataCreate a new relation for a company. Required: relations. API summary: company/{parentId}/relations.
  • create_configurable_product_productChanges dataCreate a new product for a configurable product. Required: child sku. Search products first to avoid duplicates. API summary: configurable-products/{sku}/child.
  • create_configurable_product_product_post_v1_configurableproductsChanges dataCreate a new product for a configurable product. Required: option. Search products first to avoid duplicates. API summary: configurable-products/{sku}/options.
  • create_configureChanges dataCreate a new configure. Required: tfa token or device data. API summary: tfa/provider/authy/configure.
  • create_configure_post_v1_tfa_provider_duo_security_configureChanges dataCreate a new configure. Required: tfa token. API summary: tfa/provider/duosecurity/configure.
  • create_configure_post_v1_tfa_provider_google_configureChanges dataCreate a new configure. Required: tfa token. API summary: tfa/provider/google/configure.
  • create_configure_post_v1_tfa_provider_u2fkey_configureChanges dataCreate a new configure. Required: tfa token. API summary: tfa/provider/u2fkey/configure.
  • create_costChanges dataCreate a new cost. Required: prices. API summary: products/cost.
  • create_cost_deleteChanges dataCreate a new cost delete. Required: skus. API summary: products/cost-delete.
  • create_cost_informationChanges dataCreate a new cost information. Required: skus. API summary: products/cost-information.
  • create_couponChanges dataCreate a new coupon. Required: coupon. Search coupons first to avoid duplicates.
  • create_coupon_post_v2_carts_mine_couponsChanges dataCreate a new coupon. Required: coupon codes. Search coupons first to avoid duplicates. API summary: carts/mine/coupons.
  • create_credit_noteChanges dataCreate a new credit note. Required: entity. Search credit notes first to avoid duplicates. API summary: creditmemo.
  • create_credit_note_messageChanges dataCreate a new message for a credit note. Required: entity. Search messages first to avoid duplicates. API summary: creditmemo/{id}/comments.
  • create_credit_note_message_post_v1_creditmemo_id_emailsChanges dataCreate a new message for a credit note. Search messages first to avoid duplicates. API summary: creditmemo/{id}/emails.
  • create_csvChanges dataCreate a new csv. Required: source. API summary: import/csv.
  • create_customerChanges dataCreate a customer account with email, firstname and lastname, plus optional addresses and group.
  • create_customer_2Changes dataCreate a new customer. Required: group. Search customers first to avoid duplicates. API summary: customerGroups.
  • create_customer_cartChanges dataCreate a new cart for a customer. Search carts first to avoid duplicates. API summary: customers/{customerId}/carts.
  • create_customer_post_v1_negotiable_quote_template_cancel_meChanges dataCreate a new customer. Required: template id. Search customers first to avoid duplicates. API summary: negotiableQuoteTemplate/cancel/me.
  • create_customer_post_v1_negotiable_quote_template_open_meChanges dataCreate a new customer. Required: template id. Search customers first to avoid duplicates. API summary: negotiableQuoteTemplate/open/me.
  • create_customer_post_v1_negotiable_quote_template_request_meChanges dataCreate a new customer. Required: quote id. Search customers first to avoid duplicates. API summary: negotiableQuoteTemplate/request/me.
  • create_estimate_shipping_methodChanges dataCreate a new estimate shipping method. Required: address. API summary: carts/mine/estimate-shipping-methods.
  • create_estimate_shipping_method_post_v1_giftregistry_mine_estimaChanges dataCreate a new estimate shipping method. Required: registry id. API summary: giftregistry/mine/estimate-shipping-methods.
  • create_estimate_shipping_methods_by_address_idChanges dataCreate a new estimate shipping methods by address id. Required: address id. API summary: carts/mine/estimate-shipping-methods-by-address-id.
  • create_event_subscribeChanges dataCreate a new event subscribe. Required: event. API summary: eventing/eventSubscribe.
  • create_generateChanges dataCreate a new generate. Required: coupon spec. API summary: coupons/generate.
  • create_gift_cardChanges dataCreate a new gift card. Required: gift card account data. API summary: carts/mine/giftCards.
  • create_gift_wrappingChanges dataCreate a new gift wrapping. Required: data. Search gift wrappings first to avoid duplicates. API summary: gift-wrappings.
  • create_groupChanges dataCreate a new group. Required: group. API summary: products/attribute-sets/groups.
  • create_guest_cartChanges dataCreate a new guest cart. API summary: guest-carts.
  • create_guest_cart_addressChanges dataCreate a new address for a guest cart. Required: address. Search addresses first to avoid duplicates. API summary: guest-carts/{cartId}/billing-address.
  • create_guest_cart_estimate_shipping_methodChanges dataCreate a new estimate shipping method for a guest cart. Required: address. API summary: guest-carts/{cartId}/estimate-shipping-methods.
  • create_guest_cart_gift_cardChanges dataCreate a new gift card for a guest cart. Required: gift card account data. API summary: carts/guest-carts/{cartId}/giftCards.
  • create_guest_cart_messageVisible to othersCreate a new message for a guest cart. Required: gift message. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: guest-carts/{cartId}/gift-message.
  • create_guest_cart_orderChanges dataCreate a new order for a guest cart. Required: method code, payment source or location. Search orders first to avoid duplicates. API summary: guest-carts/{cartId}/payment-order.
  • create_guest_cart_paymentChanges dataCreate a new payment for a guest cart. Required: email or payment method. Search payments first to avoid duplicates. API summary: guest-carts/{cartId}/payment-information.
  • create_guest_cart_productChanges dataCreate a new product for a guest cart. Required: cart item. Search products first to avoid duplicates. API summary: guest-carts/{cartId}/items.
  • create_guest_cart_shipping_informationChanges dataCreate a new shipping information for a guest cart. Required: address information. API summary: guest-carts/{cartId}/shipping-information.
  • create_guest_cart_totals_informationChanges dataCreate a new totals information for a guest cart. Required: address information. API summary: guest-carts/{cartId}/totals-information.
  • create_guest_giftregistry_estimate_shipping_methodChanges dataCreate a new estimate shipping method for a guest giftregistry. Required: registry id. API summary: guest-giftregistry/{cartId}/estimate-shipping-methods.
  • create_inventoryChanges dataCreate a new inventory. Required: source item configurations. Search inventories first to avoid duplicates. API summary: inventory/low-quantity-notification.
  • create_inventory_post_v1_inventory_sourcesChanges dataCreate a new inventory. Required: source. Search inventories first to avoid duplicates. API summary: inventory/sources.
  • create_inventory_post_v1_inventory_sourceselectionalgorithmresulChanges dataCreate a new inventory. Required: inventory request or algorithm code. Search inventories first to avoid duplicates. API summary: inventory/source-selection-algorithm-result.
  • create_inventory_post_v1_inventory_stocksChanges dataCreate a new inventory. Required: stock. Search inventories first to avoid duplicates. API summary: inventory/stocks.
  • create_inventory_post_v1_inventory_stocksourcelinksChanges dataCreate a new inventory. Required: links. Search inventories first to avoid duplicates. API summary: inventory/stock-source-links.
  • create_invoiceChanges dataCreate a new invoice. Required: entity. Search invoices first to avoid duplicates. API summary: invoices/.
  • create_invoice_messageChanges dataCreate a new message for a invoice. Search messages first to avoid duplicates. API summary: invoices/{id}/emails.
  • create_is_email_availableVisible to othersCreate a new is email available. Required: customer email. Has effects visible outside this system. API summary: customers/isEmailAvailable.
  • create_jsonChanges dataCreate a new json. Required: source. API summary: import/json.
  • create_low_quantity_notifications_deleteChanges dataCreate a new low quantity notifications delete. Required: source items. API summary: inventory/low-quantity-notifications-delete.
  • create_messageVisible to othersCreate a new message. Required: gift message. Search messages first to avoid duplicates. Has effects visible outside this system. API summary: carts/mine/gift-message.
  • create_message_post_v1_invoices_commentsChanges dataCreate a new message. Required: entity. Search messages first to avoid duplicates. API summary: invoices/comments.
  • create_message_post_v1_negotiablecartitemnoteChanges dataCreate a new message. Required: item note. Search messages first to avoid duplicates. API summary: negotiable-cart-item-note.
  • create_mineChanges dataCreate a new mine. API summary: carts/mine.
  • create_negotiable_cart_addressChanges dataCreate a new address for a negotiable cart. Required: address. Search addresses first to avoid duplicates. API summary: negotiable-carts/{cartId}/billing-address.
  • create_negotiable_cart_estimate_shipping_methodChanges dataCreate a new estimate shipping method for a negotiable cart. Required: address. API summary: negotiable-carts/{cartId}/estimate-shipping-methods.
  • create_negotiable_cart_estimate_shipping_methods_by_address_idChanges dataCreate a new estimate shipping methods by address id for a negotiable cart. Required: address id. API summary: negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id.
  • create_negotiable_cart_gift_cardChanges dataCreate a new gift card for a negotiable cart. Required: gift card account data. API summary: negotiable-carts/{cartId}/giftCards.
  • create_negotiable_cart_paymentChanges dataCreate a new payment for a negotiable cart. Required: payment method. Search payments first to avoid duplicates. API summary: negotiable-carts/{cartId}/payment-information.
  • create_negotiable_cart_shipping_informationChanges dataCreate a new shipping information for a negotiable cart. Required: address information. API summary: negotiable-carts/{cartId}/shipping-information.
  • create_openChanges dataCreate a new open. Required: template id. API summary: negotiableQuoteTemplate/open.
  • create_orderChanges dataCreate a new order. Required: method code, payment source or location. Search orders first to avoid duplicates. API summary: carts/mine/payment-order.
  • create_order_message_post_v1_orders_id_emailsChanges dataCreate a new message for a order. Search messages first to avoid duplicates. API summary: orders/{id}/emails.
  • create_order_post_v1_ordersChanges dataCreate a new order. Required: entity. Search orders first to avoid duplicates.
  • create_pageChanges dataCreate a new page. Required: page. Search pages first to avoid duplicates. API summary: cmsPage.
  • create_paymentChanges dataCreate a new payment. Required: payment method. Search payments first to avoid duplicates. API summary: carts/mine/payment-information.
  • create_po_payment_informationChanges dataCreate a new po payment information. Required: payment method. API summary: carts/mine/po-payment-information.
  • create_prices_updatedChanges dataCreate a new prices updated. Required: quote ids. API summary: negotiableQuote/pricesUpdated.
  • create_productChanges dataCreate a product with sku, name, price, attribute_set_id, type_id, status, visibility and weight.
  • create_product_2Changes dataCreate a new product. Required: cart item. Search products first to avoid duplicates. API summary: carts/mine/items.
  • create_product_downloadable_linkChanges dataCreate a new downloadable link for a product. Required: link. API summary: products/{sku}/downloadable-links.
  • create_product_optionChanges dataCreate a new option for a product. Required: option. API summary: products/attributes/{attributeCode}/options.
  • create_product_post_v1_products_attributesChanges dataCreate a new product. Required: attribute. Search products first to avoid duplicates. API summary: products/attributes.
  • create_product_post_v1_products_attributesets_attributesChanges dataCreate a new product. Required: attribute set id, attribute group id, attribute code or sort order. Search products first to avoid duplicates. API summary: products/attribute-sets/attributes.
  • create_product_post_v1_products_optionsChanges dataCreate a new product. Required: option. Search products first to avoid duplicates. API summary: products/options.
  • create_product_post_v1_products_sku_linksChanges dataCreate a new product for a product. Required: items. Search products first to avoid duplicates. API summary: products/{sku}/links.
  • create_product_post_v1_products_sku_mediaChanges dataCreate a new product for a product. Required: entry. Search products first to avoid duplicates. API summary: products/{sku}/media.
  • create_product_websiteChanges dataCreate a new website for a product. Required: product website link. API summary: products/{sku}/websites.
  • create_purchase_order_cart_addressChanges dataCreate a new address for a purchase order cart. Required: address. Search addresses first to avoid duplicates. API summary: purchase-order-carts/{cartId}/billing-address.
  • create_purchase_order_cart_estimate_shipping_methodChanges dataCreate a new estimate shipping method for a purchase order cart. Required: address. API summary: purchase-order-carts/{cartId}/estimate-shipping-methods.
  • create_purchase_order_cart_estimate_shipping_methods_by_address_Changes dataCreate a new estimate shipping methods by address id for a purchase order cart. Required: address id. API summary: purchase-order-carts/{cartId}/estimate-shipping-methods-by-address-id.
  • create_purchase_order_cart_gift_cardChanges dataCreate a new gift card for a purchase order cart. Required: gift card account data. API summary: purchase-order-carts/{cartId}/giftCards.
  • create_purchase_order_cart_paymentChanges dataCreate a new payment for a purchase order cart. Required: payment method. Search payments first to avoid duplicates. API summary: purchase-order-carts/{cartId}/payment-information.
  • create_quoteChanges dataCreate a new quote. Required: customer id. Search quotes first to avoid duplicates. API summary: negotiableQuote/draft.
  • create_quote_post_v1_negotiable_quote_requestChanges dataCreate a new quote. Required: quote id or quote name. Search quotes first to avoid duplicates. API summary: negotiableQuote/request.
  • create_quote_post_v1_negotiable_quote_template_draftChanges dataCreate a new quote. Required: customer id. Search quotes first to avoid duplicates. API summary: negotiableQuoteTemplate/draft.
  • create_quote_post_v1_negotiable_quote_template_generate_quoteChanges dataCreate a new quote. Required: template id. Search quotes first to avoid duplicates. API summary: negotiableQuoteTemplate/generateQuote.
  • create_quote_post_v1_negotiable_quote_template_requestChanges dataCreate a new quote. Required: quote id. Search quotes first to avoid duplicates. API summary: negotiableQuoteTemplate/request.
  • create_requisition_listChanges dataCreate a new requisition list. Required: requisition list. API summary: requisitionlists.
  • create_reset_passwordDeletesCreate a new reset password. Required: email, reset token or new password. Destructive action; may require approval. API summary: customers/resetPassword.
  • create_returnChanges dataCreate a new return. Required: rma data object. Search returns first to avoid duplicates.
  • create_return_messageChanges dataCreate a new message for a return. Required: data. Search messages first to avoid duplicates. API summary: returns/{id}/comments.
  • create_revoke_customer_tokenDeletesCreate a new revoke customer token. Destructive action; may require approval. API summary: integration/customer/revoke-customer-token.
  • create_sales_ruleChanges dataCreate a new sales rule. Required: rule. Search sales rules first to avoid duplicates. API summary: salesRules.
  • create_sampleChanges dataCreate a new sample. Required: sample. API summary: products/{sku}/downloadable-links/samples.
  • create_shared_catalogChanges dataCreate a new shared catalog. Required: shared catalog. Search shared catalogs first to avoid duplicates. API summary: sharedCatalog.
  • create_shared_catalog_reset_tier_priceChanges dataCreate a new reset tier price for a shared catalog. Required: skus. API summary: sharedCatalog/{sharedCatalogId}/resetTierPrices.
  • create_shipmentChanges dataCreate a new shipment. Required: entity. Search shipments first to avoid duplicates. API summary: shipment/.
  • create_shipment_messageChanges dataCreate a new message for a shipment. Required: entity. Search messages first to avoid duplicates. API summary: shipment/{id}/comments.
  • create_shipment_message_post_v1_shipment_id_emailsChanges dataCreate a new message for a shipment. Search messages first to avoid duplicates. API summary: shipment/{id}/emails.
  • create_shipping_informationChanges dataCreate a new shipping information. Required: address information. API summary: carts/mine/shipping-information.
  • create_source_items_deleteChanges dataCreate a new source items delete. Required: source items. API summary: inventory/source-items-delete.
  • create_special_priceChanges dataCreate a new special price. Required: prices. API summary: products/special-price.
  • create_special_price_deleteChanges dataCreate a new special price delete. Required: prices. API summary: products/special-price-delete.
  • create_special_price_informationChanges dataCreate a new special price information. Required: skus. API summary: products/special-price-information.
  • create_stock_source_links_deleteChanges dataCreate a new stock source links delete. Required: links. API summary: inventory/stock-source-links-delete.
  • create_tax_classChanges dataCreate a new tax class. Required: tax class. Search tax classes first to avoid duplicates. API summary: taxClasses.
  • create_tax_rateChanges dataCreate a new tax rate. Required: tax rate. Search tax rates first to avoid duplicates. API summary: taxRates.
  • create_tax_ruleChanges dataCreate a new tax rule. Required: rule. Search tax rules first to avoid duplicates. API summary: taxRules.
  • create_tier_priceChanges dataCreate a new tier price. Required: prices. API summary: products/tier-prices.
  • create_tier_prices_deleteChanges dataCreate a new tier prices delete. Required: prices. API summary: products/tier-prices-delete.
  • create_tier_prices_informationChanges dataCreate a new tier prices information. Required: skus. API summary: products/tier-prices-information.
  • create_totals_informationChanges dataCreate a new totals information. Required: address information. API summary: carts/mine/totals-information.
  • create_use_rewardChanges dataCreate a new use reward. API summary: reward/mine/use-reward.
  • create_vaultChanges dataCreate a new vault. Required: payment. API summary: braintree/mine/payment/vault.
  • delete_addressDeletesPermanently delete a address by address id. Destructive action; may require approval. API summary: addresses/{addressId}.
  • delete_assetDeletesPermanently delete a asset by asset id. Destructive action; may require approval. API summary: adobestock/asset/{id}.
  • delete_attribute_setDeletesPermanently delete a attribute set by attribute set id. Destructive action; may require approval. API summary: eav/attribute-sets/{attributeSetId}.
  • delete_attribute_set_delete_v1_products_attributesets_attribute_DeletesPermanently delete a attribute set by attribute set id. Destructive action; may require approval. API summary: products/attribute-sets/{attributeSetId}.
  • delete_attribute_set_productDeletesPermanently delete a product by product code. Destructive action; may require approval. API summary: products/attribute-sets/{attributeSetId}/attributes/{attributeCode}.
  • delete_bundle_product_optionDeletesPermanently delete a option by option id. Destructive action; may require approval. API summary: bundle-products/{sku}/options/{optionId}.
  • delete_cart_couponsMoves moneyPermanently delete a coupon by cart id. Financial or irreversible action; may require approval. API summary: carts/{cartId}/coupons.
  • delete_cart_gift_cardDeletesPermanently delete a gift card by gift card code. Destructive action; may require approval. API summary: carts/{cartId}/giftCards/{giftCardCode}.
  • delete_cart_productDeletesPermanently delete a product by product id. Destructive action; may require approval. API summary: carts/{cartId}/items/{itemId}.
  • delete_categoryDeletesPermanently delete a category by category id. Destructive action; may require approval. API summary: categories/{categoryId}.
  • delete_category_productDeletesPermanently delete a product by sku. Destructive action; may require approval. API summary: categories/{categoryId}/products/{sku}.
  • delete_cms_blockDeletesPermanently delete a cms block by block id. Destructive action; may require approval. API summary: cmsBlock/{blockId}.
  • delete_companyDeletesPermanently delete a company by company id. Destructive action; may require approval. API summary: company/role/{roleId}.
  • delete_company_delete_v1_company_company_idDeletesPermanently delete a company by company id. Destructive action; may require approval. API summary: company/{companyId}.
  • delete_company_delete_v1_team_team_idDeletesPermanently delete a company by company id. Destructive action; may require approval. API summary: team/{teamId}.
  • delete_company_relationDeletesPermanently delete a relation by company id. Destructive action; may require approval. API summary: company/{parentId}/relations/{companyId}.
  • delete_configurable_product_productDeletesPermanently delete a product by product sku. Destructive action; may require approval. API summary: configurable-products/{sku}/children/{childSku}.
  • delete_configurable_product_product_delete_v1_configurableproducDeletesPermanently delete a product by product id. Destructive action; may require approval. API summary: configurable-products/{sku}/options/{id}.
  • delete_couponDeletesPermanently delete a coupon by coupon id. Destructive action; may require approval. API summary: coupons/{couponId}.
  • delete_couponsMoves moneyPermanently delete a coupon. Financial or irreversible action; may require approval. API summary: carts/mine/coupons.
  • delete_coupons_by_codesDeletesPermanently delete a coupon. Destructive action; may require approval. API summary: coupons/deleteByCodes.
  • delete_coupons_by_codes_deleteDeletesPermanently delete a coupon. Destructive action; may require approval. API summary: carts/mine/coupons/deleteByCodes.
  • delete_coupons_by_codes_post_v2_carts_cart_id_coupons_delete_by_DeletesPermanently delete a coupon by cart id. Destructive action; may require approval. API summary: carts/{cartId}/coupons/deleteByCodes.
  • delete_coupons_by_idsDeletesPermanently delete a coupon. Destructive action; may require approval. API summary: coupons/deleteByIds.
  • delete_customerDeletesPermanently delete a customer by customer id. Destructive action; may require approval. API summary: customerGroups/{id}.
  • delete_customer_companyDeletesPermanently delete a company by company id. Destructive action; may require approval. API summary: customers/{customerId}/companies/{companyId}.
  • delete_customer_delete_v1_customers_customer_idDeletesPermanently delete a customer by customer id. Destructive action; may require approval. API summary: customers/{customerId}.
  • delete_customer_delete_v1_negotiable_quote_template_me_template_DeletesPermanently delete a customer by template id. Destructive action; may require approval. API summary: negotiableQuoteTemplate/me/{templateId}.
  • delete_documentDeletesPermanently delete a document by link id. Destructive action; may require approval. API summary: negotiableQuoteTemplate/referenceDocumentLink/{linkId}.
  • delete_downloadable_linkDeletesPermanently delete a downloadable link by downloadable link id. Destructive action; may require approval. API summary: products/downloadable-links/{id}.
  • delete_gift_cardDeletesPermanently delete a gift card by gift card code. Destructive action; may require approval. API summary: carts/mine/giftCards/{giftCardCode}.
  • delete_gift_wrappingDeletesPermanently delete a gift wrapping by gift wrapping id. Destructive action; may require approval. API summary: gift-wrappings/{id}.
  • delete_groupDeletesPermanently delete a group by group id. Destructive action; may require approval. API summary: products/attribute-sets/groups/{groupId}.
  • delete_group_price_productDeletesPermanently delete a product by qty. Destructive action; may require approval. API summary: products/{sku}/group-prices/{customerGroupId}/tiers/{qty}.
  • delete_guest_cart_couponsMoves moneyPermanently delete a coupon by cart id. Financial or irreversible action; may require approval. API summary: guest-carts/{cartId}/coupons.
  • delete_guest_cart_gift_cardDeletesPermanently delete a gift card by gift card code. Destructive action; may require approval. API summary: carts/guest-carts/{cartId}/giftCards/{giftCardCode}.
  • delete_guest_cart_productDeletesPermanently delete a product by product id. Destructive action; may require approval. API summary: guest-carts/{cartId}/items/{itemId}.
  • delete_inventoryDeletesPermanently delete a inventory by inventory id. Destructive action; may require approval. API summary: inventory/stocks/{stockId}.
  • delete_messageDeletesPermanently delete a message by note id. Destructive action; may require approval. API summary: negotiable-cart-item-note/{noteId}.
  • delete_negotiable_cart_couponsMoves moneyPermanently delete a coupon by cart id. Financial or irreversible action; may require approval. API summary: negotiable-carts/{cartId}/coupons.
  • delete_negotiable_cart_gift_cardDeletesPermanently delete a gift card by gift card code. Destructive action; may require approval. API summary: negotiable-carts/{cartId}/giftCards/{giftCardCode}.
  • delete_pageDeletesPermanently delete a page by page id. Destructive action; may require approval. API summary: cmsPage/{pageId}.
  • delete_productDeletesPermanently delete a product by product id. Destructive action; may require approval. API summary: carts/mine/items/{itemId}.
  • delete_product_childDeletesPermanently delete a child by child sku. Destructive action; may require approval. API summary: bundle-products/{sku}/options/{optionId}/children/{childSku}.
  • delete_product_delete_v1_products_attributes_attribute_codeDeletesPermanently delete a product by product code. Destructive action; may require approval. API summary: products/attributes/{attributeCode}.
  • delete_product_delete_v1_products_skuDeletesPermanently delete a product by sku. Destructive action; may require approval. API summary: products/{sku}.
  • delete_product_delete_v1_products_sku_links_type_linked_product_DeletesPermanently delete a product by linked product sku. Destructive action; may require approval. API summary: products/{sku}/links/{type}/{linkedProductSku}.
  • delete_product_delete_v1_products_sku_media_entry_idDeletesPermanently delete a product by entry id. Destructive action; may require approval. API summary: products/{sku}/media/{entryId}.
  • delete_product_delete_v1_products_sku_options_option_idDeletesPermanently delete a product by product id. Destructive action; may require approval. API summary: products/{sku}/options/{optionId}.
  • delete_product_optionDeletesPermanently delete a option by option id. Destructive action; may require approval. API summary: products/attributes/{attributeCode}/options/{optionId}.
  • delete_product_websiteDeletesPermanently delete a website by website id. Destructive action; may require approval. API summary: products/{sku}/websites/{websiteId}.
  • delete_purchase_order_cart_gift_cardDeletesPermanently delete a gift card by gift card code. Destructive action; may require approval. API summary: purchase-order-carts/{cartId}/giftCards/{giftCardCode}.
  • delete_quoteDeletesPermanently delete a quote by template id. Destructive action; may require approval. API summary: negotiableQuoteTemplate/{templateId}.
  • delete_returnDeletesPermanently delete a return by return id. Destructive action; may require approval. API summary: returns/{id}.
  • delete_return_tracking_numberDeletesPermanently delete a tracking number by track id. Destructive action; may require approval. API summary: returns/{id}/tracking-numbers/{trackId}.
  • delete_sales_ruleDeletesPermanently delete a sales rule by rule id. Destructive action; may require approval. API summary: salesRules/{ruleId}.
  • delete_sampleDeletesPermanently delete a sample by sample id. Destructive action; may require approval. API summary: products/downloadable-links/samples/{id}.
  • delete_shared_catalogDeletesPermanently delete a shared catalog by shared catalog id. Destructive action; may require approval. API summary: sharedCatalog/{sharedCatalogId}.
  • delete_tax_classDeletesPermanently delete a tax class by tax class id. Destructive action; may require approval. API summary: taxClasses/{taxClassId}.
  • delete_tax_rateDeletesPermanently delete a tax rate by rate id. Destructive action; may require approval. API summary: taxRates/{rateId}.
  • delete_tax_ruleDeletesPermanently delete a tax rule by rule id. Destructive action; may require approval. API summary: taxRules/{ruleId}.
  • delete_trackDeletesPermanently delete a track by track id. Destructive action; may require approval. API summary: shipment/track/{id}.
  • detach_shared_catalog_categoriesChanges dataUnassign a shared catalog (shared catalog id). API summary: sharedCatalog/{id}/unassignCategories.
  • detach_shared_catalog_companiesChanges dataUnassign a shared catalog (shared catalog id). API summary: sharedCatalog/{sharedCatalogId}/unassignCompanies.
  • detach_shared_catalog_productsChanges dataUnassign a shared catalog (shared catalog id). API summary: sharedCatalog/{id}/unassignProducts.
  • get_addressGet one address by address id. API summary: customers/addresses/{addressId}.
  • get_assetGet one asset by asset id. API summary: adobestock/asset/{id}.
  • get_attribute_setGet one attribute set by attribute set id. API summary: eav/attribute-sets/{attributeSetId}.
  • get_attribute_set_get_v1_products_attributesets_attribute_set_idGet one attribute set by attribute set id. API summary: products/attribute-sets/{attributeSetId}.
  • get_bulk_operation_statusGet one operation status for a bulk by status. API summary: bulk/{bulkUuid}/operation-status/{status}.
  • get_bulk_statusGet the current status of a bulk by bulk uuid. API summary: bulk/{bulkUuid}/status.
  • get_bundle_product_optionGet one option for a bundle product by option id. API summary: bundle-products/{sku}/options/{optionId}.
  • get_cartGet one cart by cart id. API summary: carts/{cartId}.
  • get_cart_messageGet one message for a cart by item id. API summary: carts/{cartId}/gift-message/{itemId}.
  • get_categoryGet one category by category id. API summary: categories/{categoryId}.
  • get_check_gift_cardGet one check gift card by gift card code. API summary: carts/mine/checkGiftCard/{giftCardCode}.
  • get_cms_blockGet one cms block by block id. API summary: cmsBlock/{blockId}.
  • get_companyGet one company by company id. API summary: company/role/{roleId}.
  • get_company_get_v1_company_company_idGet one company by company id. API summary: company/{companyId}.
  • get_company_get_v1_company_credits_company_company_idGet one company by company id. API summary: companyCredits/company/{companyId}.
  • get_company_get_v1_company_credits_credit_idGet one company by credit id. API summary: companyCredits/{creditId}.
  • get_company_get_v1_team_team_idGet one company by company id. API summary: team/{teamId}.
  • get_configurable_product_productGet one product for a configurable product by product id. API summary: configurable-products/{sku}/options/{id}.
  • get_countryGet one country by country id. API summary: directory/countries/{countryId}.
  • get_couponGet one coupon by coupon id. API summary: coupons/{couponId}.
  • get_credit_memoGet one credit memo by ID, with refunded items and amounts.
  • get_customerGet one customer by `customer_id`, with addresses and group.
  • get_customer_2Get one customer by customer code. API summary: attributeMetadata/customer/form/{formCode}.
  • get_customer_companyGet one company for a customer by company id. API summary: customers/{customerId}/companies/{companyId}.
  • get_customer_get_v1_attribute_metadata_customer_address_form_forGet one customer by customer code. API summary: attributeMetadata/customerAddress/form/{formCode}.
  • get_customer_get_v1_customer_groups_default_store_idGet one customer by store id. API summary: customerGroups/default/{storeId}.
  • get_customer_get_v1_customer_groups_idGet one customer by customer id. API summary: customerGroups/{id}.
  • get_customer_get_v1_returns_attribute_metadata_form_form_codeGet one customer by customer code. API summary: returnsAttributeMetadata/form/{formCode}.
  • get_default_provider_codeGet one default provider code by user id. API summary: tfa/default-provider-code/{userId}.
  • get_documentGet one document by link id. API summary: negotiableQuoteTemplate/referenceDocumentLink/{linkId}.
  • get_eventing_event_providersGet one eventing. API summary: eventing/getEventProviders.
  • get_eventing_event_subscriptionsGet one eventing. API summary: eventing/getEventSubscriptions.
  • get_get_product_salable_quantityGet one get product salable quantity by stock id. API summary: inventory/get-product-salable-quantity/{sku}/{stockId}.
  • get_gift_wrappingGet one gift wrapping by gift wrapping id. API summary: gift-wrappings/{id}.
  • get_guest_cartGet one guest cart by cart id. API summary: guest-carts/{cartId}.
  • get_guest_cart_check_gift_cardGet one check gift card for a guest cart by gift card code. API summary: carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}.
  • get_guest_cart_messageGet one message for a guest cart by item id. API summary: guest-carts/{cartId}/gift-message/{itemId}.
  • get_guest_cart_orderGet one order for a guest cart by order id. API summary: guest-carts/{cartId}/payment-order/{id}.
  • get_hierarchyGet one hierarchy by hierarchy id. API summary: hierarchy/{id}.
  • get_inventoryGet one inventory by sales channel code. API summary: inventory/dump-stock-index-data/{salesChannelType}/{salesChannelCode}.
  • get_inventory_distanceGet one inventory. API summary: inventory/get-distance.
  • get_inventory_distance_provider_codeGet one inventory. API summary: inventory/get-distance-provider-code.
  • get_inventory_get_v1_inventory_exportstocksalableqty_sales_channGet one inventory by sales channel code. API summary: inventory/export-stock-salable-qty/{salesChannelType}/{salesChannelCode}.
  • get_inventory_get_v1_inventory_getsourcesassignedtostockorderedbGet one inventory by stock id. API summary: inventory/get-sources-assigned-to-stock-ordered-by-priority/{stockId}.
  • get_inventory_get_v1_inventory_isproductsalableforrequestedqty_sGet one inventory by requested qty. API summary: inventory/is-product-salable-for-requested-qty/{sku}/{stockId}/{requestedQty}.
  • get_inventory_get_v1_inventory_lowquantitynotification_source_coGet one inventory by sku. API summary: inventory/low-quantity-notification/{sourceCode}/{sku}.
  • get_inventory_get_v1_inventory_sources_source_codeGet one inventory by inventory code. API summary: inventory/sources/{sourceCode}.
  • get_inventory_get_v1_inventory_stockresolver_type_codeGet one inventory by inventory code. API summary: inventory/stock-resolver/{type}/{code}.
  • get_inventory_get_v1_inventory_stocks_stock_idGet one inventory by inventory id. API summary: inventory/stocks/{stockId}.
  • get_inventory_get_v1_stock_statuses_product_skuGet one inventory by product sku. API summary: stockStatuses/{productSku}.
  • get_inventory_latlng_from_addressGet one inventory. API summary: inventory/get-latlng-from-address.
  • get_inventory_latslngs_from_addressGet one inventory. API summary: inventory/get-latslngs-from-address.
  • get_invoiceGet one invoice by `invoice_id`, with items and totals.
  • get_is_product_salableGet one is product salable by stock id. API summary: inventory/is-product-salable/{sku}/{stockId}.
  • get_massactionGet one massaction by request id. API summary: adminuisdk/massaction/{requestid}.
  • get_messageGet one message by item id. API summary: carts/mine/gift-message/{itemId}.
  • get_message_get_v1_negotiablecartitemnote_note_idGet one message by note id. API summary: negotiable-cart-item-note/{noteId}.
  • get_orderGet one order by its internal `order_id` (entity ID), with items, addresses, payment and status.
  • get_order_2Get one order by order id. API summary: carts/mine/payment-order/{id}.
  • get_pageGet one page by page id. API summary: cmsPage/{pageId}.
  • get_paymentGet one payment by location. API summary: payments-config/apple-pay/{location}.
  • get_payment_get_v1_paymentsconfig_googlepay_locationGet one payment by location. API summary: payments-config/google-pay/{location}.
  • get_payment_get_v1_paymentsconfig_hostedfields_locationGet one payment by location. API summary: payments-config/hosted-fields/{location}.
  • get_payment_get_v1_paymentsconfig_locationGet one payment by location. API summary: payments-config/{location}.
  • get_payment_get_v1_paymentsconfig_smartbuttons_locationGet one payment by location. API summary: payments-config/smart-buttons/{location}.
  • get_payment_get_v1_paymentssdk_locationGet one payment by location. API summary: payments-sdk/{location}.
  • get_payment_get_v1_paymentssdk_location_method_codeGet one payment by method code. API summary: payments-sdk/{location}/{methodCode}.
  • get_payment_get_v1_transactions_idGet one payment by payment id. API summary: transactions/{id}.
  • get_productGet one product by `sku`, with price, status, attributes and stock.
  • get_product_2Get one product by product code. API summary: attributeMetadata/customer/attribute/{attributeCode}.
  • get_product_get_v1_attribute_metadata_customer_address_attributeGet one product by product code. API summary: attributeMetadata/customerAddress/attribute/{attributeCode}.
  • get_product_get_v1_categories_attributes_attribute_codeGet one product by product code. API summary: categories/attributes/{attributeCode}.
  • get_product_get_v1_orders_items_idGet one product by product id. API summary: orders/items/{id}.
  • get_product_get_v1_products_attributes_attribute_codeGet one product by product code. API summary: products/attributes/{attributeCode}.
  • get_product_get_v1_products_media_types_attribute_set_nameGet one product by attribute set name. API summary: products/media/types/{attributeSetName}.
  • get_product_get_v1_products_sku_links_typeGet one product for a product by type. API summary: products/{sku}/links/{type}.
  • get_product_get_v1_products_sku_media_entry_idGet one product for a product by entry id. API summary: products/{sku}/media/{entryId}.
  • get_product_get_v1_products_sku_options_option_idGet one product for a product by product id. API summary: products/{sku}/options/{optionId}.
  • get_providers_to_activateGet one providers to activate by user id. API summary: tfa/providers-to-activate/{userId}.
  • get_quoteGet one quote by template id. API summary: negotiableQuoteTemplate/{templateId}.
  • get_reset_link_tokenGet one reset link token by reset password link token. API summary: customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}.
  • get_returnGet one return by return id. API summary: returns/{id}.
  • get_return_status_numbersGet the current status of a return by return id. API summary: returns/{id}/tracking-numbers.
  • get_return_status_numbers_trackingChanges dataGet the current status of a return by return id. API summary: returns/{id}/tracking-numbers.
  • get_returns_attribute_metadataGet one returns attribute metadata by attribute code. API summary: returnsAttributeMetadata/{attributeCode}.
  • get_sales_ruleGet one sales rule by rule id. API summary: salesRules/{ruleId}.
  • get_shared_catalogGet one shared catalog by shared catalog id. API summary: sharedCatalog/{sharedCatalogId}.
  • get_shipmentGet one shipment by `shipment_id`, with items and tracking numbers.
  • get_shipment_statusChanges dataGet the current status of a shipment. API summary: shipment/track.
  • get_stock_itemGet the stock level and in-stock status of a product by `product_sku`.
  • get_tax_classGet one tax class by tax class id. API summary: taxClasses/{taxClassId}.
  • get_tax_rateGet one tax rate by rate id. API summary: taxRates/{rateId}.
  • get_tax_ruleGet one tax rule by rule id. API summary: taxRules/{ruleId}.
  • get_user_providerGet one user provider by user id. API summary: tfa/user-providers/{userId}.
  • hold_orderChanges dataPut an order on hold by `order_id`.
  • invoice_orderChanges dataCreate an invoice for an order (all items, or chosen `items` with qty). Set `capture` to charge the payment online and `notify` to email the customer.
  • list_addressesList addresses. API summary: attributeMetadata/customerAddress.
  • list_addresses_get_v1_carts_mine_billingaddressList addresses. API summary: carts/mine/billing-address.
  • list_addresses_get_v1_customers_me_billing_addressList addresses. API summary: customers/me/billingAddress.
  • list_addresses_get_v1_customers_me_shipping_addressList addresses. API summary: customers/me/shippingAddress.
  • list_attribute_set_productsList products for a attribute set. API summary: products/attribute-sets/{attributeSetId}/attributes.
  • list_authsList auths. API summary: applepay/auth.
  • list_bulk_detailed_statusesList detailed statuses for a bulk. API summary: bulk/{bulkUuid}/detailed-status.
  • list_bundle_product_childrenList children for a bundle product. Optional filters: option id. API summary: bundle-products/{productSku}/children.
  • list_cart_addressesList addresses for a cart. API summary: carts/{cartId}/billing-address.
  • list_cart_couponsList coupons for a cart. API summary: carts/{cartId}/coupons.
  • list_cart_coupons_get_v2_carts_cart_id_couponsList coupons for a cart. API summary: carts/{cartId}/coupons.
  • list_cart_gift_cardsList gift cards for a cart. API summary: carts/{quoteId}/giftCards.
  • list_cart_messagesList messages for a cart. API summary: carts/{cartId}/gift-message.
  • list_cart_paymentsList payments for a cart. API summary: carts/{cartId}/payment-methods.
  • list_cart_payments_get_v1_carts_cart_id_selectedpaymentmethodList payments for a cart. API summary: carts/{cartId}/selected-payment-method.
  • list_cart_productsList products for a cart. API summary: carts/{cartId}/items.
  • list_cart_shipping_methodsList shipping methods for a cart. API summary: carts/{cartId}/shipping-methods.
  • list_cart_totalsList totals for a cart. API summary: carts/{cartId}/totals.
  • list_categoriesGet the category tree, optionally from `root_category_id` to a given `depth`.
  • list_categories_get_v1_webhooks_listList categories. API summary: webhooks/list.
  • list_category_productsList products for a category. API summary: categories/{categoryId}/products.
  • list_check_configurationsList check configurations. API summary: adobeioevents/checkconfiguration.
  • list_companiesList companies. Optional filters: criteria filter groups 0 filters 0 field, criteria filter groups 0 filters 0 value, criteria filter groups 0 filters 0 condition type, criteria sort orders 0 field, criteria sort orders 0 direction or criteria page size. API summary: customers/companies.
  • list_company_usersList users for a company. API summary: company/role/{roleId}/users.
  • list_configurable_product_productsList products for a configurable product. API summary: configurable-products/{sku}/children.
  • list_countriesList countries. API summary: directory/countries.
  • list_couponsList coupons. API summary: carts/mine/coupons.
  • list_coupons_get_v2_carts_mine_couponsList coupons. API summary: carts/mine/coupons.
  • list_credit_note_messagesList messages for a credit note. API summary: creditmemo/{id}/comments.
  • list_currenciesList currencies. API summary: directory/currency.
  • list_customer_addressesList addresses for a customer. API summary: customers/{customerId}/billingAddress.
  • list_customer_addresses_get_v1_customers_customer_id_shipping_adList addresses for a customer. API summary: customers/{customerId}/shippingAddress.
  • list_customer_companiesList companies for a customer. API summary: customers/{customerId}/companies.
  • list_customer_permissionsList permissions for a customer. API summary: customerGroups/{id}/permissions.
  • list_customersList customers. API summary: attributeMetadata/customer.
  • list_customers_get_v1_attribute_metadata_customer_address_customList customers. Optional filters: data interface name. API summary: attributeMetadata/customerAddress/custom.
  • list_customers_get_v1_attribute_metadata_customer_customList customers. Optional filters: data interface name. API summary: attributeMetadata/customer/custom.
  • list_customers_get_v1_customer_groups_defaultList customers. Optional filters: store id. API summary: customerGroups/default.
  • list_customers_get_v1_customers_meList customers. API summary: customers/me.
  • list_customers_get_v1_returns_attribute_metadata_customList customers. Optional filters: data object class name. API summary: returnsAttributeMetadata/custom.
  • list_forced_providersList forced providers. API summary: tfa/forced-providers.
  • list_group_price_productsList products for a group price. API summary: products/{sku}/group-prices/{customerGroupId}/tiers.
  • list_guest_cart_addressesList addresses for a guest cart. API summary: guest-carts/{cartId}/billing-address.
  • list_guest_cart_couponsList coupons for a guest cart. API summary: guest-carts/{cartId}/coupons.
  • list_guest_cart_messagesList messages for a guest cart. API summary: guest-carts/{cartId}/gift-message.
  • list_guest_cart_paymentsList payments for a guest cart. API summary: guest-carts/{cartId}/payment-information.
  • list_guest_cart_payments_get_v1_guestcarts_cart_id_paymentmethodList payments for a guest cart. API summary: guest-carts/{cartId}/payment-methods.
  • list_guest_cart_payments_get_v1_guestcarts_cart_id_selectedpaymeList payments for a guest cart. API summary: guest-carts/{cartId}/selected-payment-method.
  • list_guest_cart_productsList products for a guest cart. API summary: guest-carts/{cartId}/items.
  • list_guest_cart_shipping_methodsList shipping methods for a guest cart. API summary: guest-carts/{cartId}/shipping-methods.
  • list_guest_cart_totalsList totals for a guest cart. API summary: guest-carts/{cartId}/totals.
  • list_installed_providersList installed providers. API summary: tfa/installed-providers.
  • list_inventoriesList inventories. Optional filters: sku requests 0 sku, sku requests 0 qty or stock id. API summary: inventory/are-product-salable-for-requested-qty/.
  • list_inventories_get_v1_inventory_areproductssalableList inventories. Optional filters: skus or stock id. API summary: inventory/are-products-salable.
  • list_inventories_get_v1_inventory_sourceselectionalgorithmlistList inventories. API summary: inventory/source-selection-algorithm-list.
  • list_invoice_messagesList messages for a invoice. API summary: invoices/{id}/comments.
  • list_licencesList licences. API summary: carts/licence.
  • list_link_productsList products for a link. API summary: products/links/{type}/attributes.
  • list_low_stock_itemsList products whose stock is at or below `qty` for a scope (use `scope_id` 0 for the default).
  • list_messagesList messages. API summary: carts/mine/gift-message.
  • list_minesList mines. API summary: carts/mine.
  • list_modulesList modules.
  • list_negotiable_cart_addressesList addresses for a negotiable cart. API summary: negotiable-carts/{cartId}/billing-address.
  • list_negotiable_cart_paymentsList payments for a negotiable cart. API summary: negotiable-carts/{cartId}/payment-information.
  • list_negotiable_cart_totalsList totals for a negotiable cart. API summary: negotiable-carts/{cartId}/totals.
  • list_order_commentsList the status history comments on an order.
  • list_order_statusesList statuses for a order. API summary: orders/{id}/statuses.
  • list_paymentsList payments. API summary: carts/mine/payment-information.
  • list_payments_get_v1_carts_mine_paymentmethodsList payments. API summary: carts/mine/payment-methods.
  • list_payments_get_v1_carts_mine_selectedpaymentmethodList payments. API summary: carts/mine/selected-payment-method.
  • list_product_downloadable_linksList downloadable links for a product. API summary: products/{sku}/downloadable-links.
  • list_product_optionsList options for a product. API summary: categories/attributes/{attributeCode}/options.
  • list_product_options_get_v1_products_attributes_attribute_code_oList options for a product. API summary: products/attributes/{attributeCode}/options.
  • list_productsList products. API summary: bundle-products/options/types.
  • list_products_get_v1_bundleproducts_sku_options_allList products. API summary: bundle-products/{sku}/options/all.
  • list_products_get_v1_carts_mine_itemsList products. API summary: carts/mine/items.
  • list_products_get_v1_configurableproducts_sku_options_allList products. API summary: configurable-products/{sku}/options/all.
  • list_products_get_v1_products_attributes_typesList products. API summary: products/attributes/types.
  • list_products_get_v1_products_links_typesList products. API summary: products/links/types.
  • list_products_get_v1_products_options_typesList products. API summary: products/options/types.
  • list_products_get_v1_products_sku_mediaList products for a product. API summary: products/{sku}/media.
  • list_products_get_v1_products_sku_optionsList products for a product. API summary: products/{sku}/options.
  • list_products_get_v1_products_typesList products. API summary: products/types.
  • list_purchase_order_cart_paymentsList payments for a purchase order cart. API summary: purchase-order-carts/{cartId}/payment-information.
  • list_purchase_order_cart_totalsList totals for a purchase order cart. API summary: purchase-order-carts/{cartId}/totals.
  • list_quote_messagesList messages for a quote. API summary: negotiableQuote/{quoteId}/comments.
  • list_quotesList quotes. Optional filters: attachment ids. API summary: negotiableQuote/attachmentContent.
  • list_readonliesList readonlies. API summary: customers/{customerId}/permissions/readonly.
  • list_return_labelsList labels for a return. API summary: returns/{id}/labels.
  • list_return_messagesList messages for a return. API summary: returns/{id}/comments.
  • list_returns_attribute_metadataList returns attribute metadata. API summary: returnsAttributeMetadata.
  • list_samplesList samples. API summary: products/{sku}/downloadable-links/samples.
  • list_shared_catalog_categoriesList categories for a shared catalog. API summary: sharedCatalog/{id}/categories.
  • list_shared_catalog_companiesList companies for a shared catalog. API summary: sharedCatalog/{sharedCatalogId}/companies.
  • list_shared_catalog_productsList products for a shared catalog. API summary: sharedCatalog/{id}/products.
  • list_shipment_labelsList labels for a shipment. API summary: shipment/{id}/label.
  • list_shipment_messagesList messages for a shipment. API summary: shipment/{id}/comments.
  • list_shipping_methodsList shipping methods. API summary: carts/mine/shipping-methods.
  • list_store_configsGet the store views' settings: codes, base URLs, currency, locale and timezone.
  • list_store_groupsList store groups. API summary: store/storeGroups.
  • list_store_viewsList store views. API summary: store/storeViews.
  • list_tfat_providers_to_activatesList tfat providers to activates. Optional filters: tfa token. API summary: tfa/tfat-providers-to-activate.
  • list_tfat_user_providersList tfat user providers. Optional filters: tfa token. API summary: tfa/tfat-user-providers.
  • list_totalsList totals. API summary: carts/mine/totals.
  • list_websitesList websites. API summary: store/websites.
  • pay_invoiceMoves moneyCapture a invoice (invoice id). Financial or irreversible action; may require approval. API summary: invoices/{id}/capture.
  • refund_credit_noteMoves moneyRefund a credit note. Financial or irreversible action; may require approval. API summary: creditmemo/refund.
  • refund_invoiceMoves moneyRefund a invoice (invoice id). Financial or irreversible action; may require approval. API summary: invoice/{invoiceId}/refund.
  • refund_orderMoves moneyRefund an order offline (creates a credit memo) for all or chosen items, with optional shipping/adjustment amounts. Money-moving; confirm with the user first.
  • reject_quoteVisible to othersDecline a quote. Has effects visible outside this system. API summary: negotiableQuote/decline.
  • reject_quote_declineVisible to othersDecline a quote. Has effects visible outside this system. API summary: negotiableQuoteTemplate/decline.
  • release_order_holdChanges dataRelease a held order by `order_id`.
  • search_addressesSearch addresses by search request area radius, search request area search term, search request filters country value, search request filters country condition type, search request filters postcode value or search request filters postcode condition type. Use this to find existing addresses before creating a new address. API summary: inventory/in-store-pickup/pickup-locations/.
  • search_adobestocksSearch adobestocks by search criteria request name, search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field or search criteria sort orders 0 direction. Use this to find existing adobestocks before creating a new adobestock. API summary: adobestock/search.
  • search_assetsSearch assets by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing assets before creating a new asset. API summary: adobestock/asset/search.
  • search_bulksSearch bulks by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing bulks before creating a new bulk.
  • search_cartsSearch carts by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing carts before creating a new cart. API summary: carts/search.
  • search_categoriesSearch categories by search criteria request name, search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field or search criteria sort orders 0 direction. Use this to find existing categories before creating a new category. API summary: adobestock/asset/list.
  • search_categories_get_v1_carts_licence_listSearch categories by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing categories before creating a new category. API summary: carts/licence/list.
  • search_categories_get_v1_categories_listSearch categories by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing categories before creating a new category. API summary: categories/list.
  • search_categories_get_v1_eav_attributesets_listSearch categories by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing categories before creating a new category. API summary: eav/attribute-sets/list.
  • search_categories_get_v1_products_attributesets_groups_listSearch categories by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing categories before creating a new category. API summary: products/attribute-sets/groups/list.
  • search_categories_get_v1_products_attributesets_sets_listSearch categories by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing categories before creating a new category. API summary: products/attribute-sets/sets/list.
  • search_cms_blocksSearch cms blocks by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing cms blocks before creating a new cms block. API summary: cmsBlock/search.
  • search_companiesSearch companies by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing companies before creating a new company. API summary: company/.
  • search_companies_get_v1_company_creditsSearch companies by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing companies before creating a new company. API summary: companyCredits/.
  • search_companies_get_v1_company_credits_historySearch companies by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing companies before creating a new company. API summary: companyCredits/history.
  • search_companies_get_v1_company_relationsSearch companies by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing companies before creating a new company. API summary: company/relations.
  • search_companies_get_v1_company_roleSearch companies by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing companies before creating a new company. API summary: company/role/.
  • search_companies_get_v1_teamSearch companies by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing companies before creating a new company. API summary: team/.
  • search_couponsSearch coupons by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing coupons before creating a new coupon. API summary: coupons/search.
  • search_credit_memosSearch credit memos (refunds) with one filter field (e.g. order_id), value and condition_type.
  • search_customersSearch customers with one filter field (e.g. email, firstname, lastname), value and condition_type. Supports sort and paging.
  • search_customers_2Search customers by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing customers before creating a new customer. API summary: customerGroups/search.
  • search_documentsSearch documents by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing documents before creating a new document. API summary: negotiableQuoteTemplate/referenceDocumentLink.
  • search_gift_wrappingsSearch gift wrappings by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing gift wrappings before creating a new gift wrapping. API summary: gift-wrappings.
  • search_inventoriesSearch inventories by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing inventories before creating a new inventory. API summary: inventory/sources.
  • search_inventories_get_v1_inventory_stocksSearch inventories by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing inventories before creating a new inventory. API summary: inventory/stocks.
  • search_inventories_get_v1_inventory_stocksourcelinksSearch inventories by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing inventories before creating a new inventory. API summary: inventory/stock-source-links.
  • search_invoicesSearch invoices with one filter field (e.g. order_id, state, created_at), value and condition_type.
  • search_messagesSearch messages by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing messages before creating a new message. API summary: negotiable-cart-item-note/search.
  • search_ordersSearch orders with one filter: `search_criteria_filter_groups_0_filters_0_field` (e.g. increment_id, customer_email, status, created_at), value and condition_type (eq, like, gt, lt...). Supports sort and paging.
  • search_pagesSearch pages by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing pages before creating a new page. API summary: cmsPage/search.
  • search_paymentsSearch payments by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing payments before creating a new payment. API summary: transactions.
  • search_product_is_filterablesSearch is filterables for a product. Use this to find existing is filterables before creating a new is filterable. API summary: products/attributes/{attributeCode}/is-filterable.
  • search_productsSearch products with one filter field (e.g. sku, name, status, type_id), value and condition_type (eq, like...). Supports sort and paging.
  • search_products_2Search products by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing products before creating a new product. API summary: categories/attributes.
  • search_products_get_v1_orders_itemsSearch products by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing products before creating a new product. API summary: orders/items.
  • search_products_get_v1_products_attributesSearch products by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing products before creating a new product. API summary: products/attributes.
  • search_products_get_v1_productsrenderinfoSearch products by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing products before creating a new product. API summary: products-render-info.
  • search_quotesSearch quotes by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing quotes before creating a new quote. API summary: negotiableQuoteTemplate.
  • search_returnsSearch returns by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing returns before creating a new return.
  • search_sales_rulesSearch sales rules by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing sales rules before creating a new sales rule. API summary: salesRules/search.
  • search_searchesSearch searches by search criteria request name, search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field or search criteria sort orders 0 direction. Use this to find existing searches before creating a new search.
  • search_shared_catalogsSearch shared catalogs by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing shared catalogs before creating a new shared catalog. API summary: sharedCatalog/.
  • search_shipmentsSearch shipments with one filter field (e.g. order_id, created_at), value and condition_type.
  • search_source_stockSearch stock quantities per inventory source (multi-source inventory), filtered e.g. by sku or source_code.
  • search_tax_classesSearch tax classes by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing tax classes before creating a new tax class. API summary: taxClasses/search.
  • search_tax_ratesSearch tax rates by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing tax rates before creating a new tax rate. API summary: taxRates/search.
  • search_tax_rulesSearch tax rules by search criteria filter groups 0 filters 0 field, search criteria filter groups 0 filters 0 value, search criteria filter groups 0 filters 0 condition type, search criteria sort orders 0 field, search criteria sort orders 0 direction or search criteria page size. Use this to find existing tax rules before creating a new tax rule. API summary: taxRules/search.
  • send_order_are_ready_for_pickupVisible to othersNotify a order. Has effects visible outside this system. API summary: order/notify-orders-are-ready-for-pickup.
  • set_source_stockChanges dataSet the stock quantity and status for one or more SKUs at an inventory source (multi-source inventory).
  • ship_orderVisible to othersCreate a shipment for an order, optionally with tracking numbers (`tracks`) and specific items. Set `notify` to email the customer.
  • submit_authyVisible to othersActivate a authy. Has effects visible outside this system. API summary: tfa/provider/authy/activate.
  • submit_customerDeletesActivate a customer. Destructive action; may require approval. API summary: customers/me/activate.
  • submit_customer_activateVisible to othersActivate a customer (email). Has effects visible outside this system. API summary: customers/{email}/activate.
  • submit_customer_validateDeletesValidate a customer. Destructive action; may require approval. API summary: customers/validate.
  • submit_duo_securityVisible to othersActivate a duo security. Has effects visible outside this system. API summary: tfa/provider/duosecurity/activate.
  • submit_googleVisible to othersActivate a google. Has effects visible outside this system. API summary: tfa/provider/google/activate.
  • submit_quoteVisible to othersDuplicate a quote (negotiable quote id). Has effects visible outside this system. API summary: negotiableQuote/{negotiableQuoteId}/duplicate.
  • submit_quote_to_customerVisible to othersSubmit a quote. Has effects visible outside this system. API summary: negotiableQuote/submitToCustomer.
  • submit_quote_to_customer_submitVisible to othersSubmit a quote. Has effects visible outside this system. API summary: negotiableQuoteTemplate/submitToCustomer.
  • submit_quote_to_sellerVisible to othersSubmit a quote. Has effects visible outside this system. API summary: negotiableQuoteTemplate/submitToSeller.
  • submit_u2fkeyVisible to othersActivate a u2fkey. Has effects visible outside this system. API summary: tfa/provider/u2fkey/activate.
  • submit_u2fkey_verifyVisible to othersVerify a u2fkey. Has effects visible outside this system. API summary: tfa/provider/u2fkey/verify.
  • update_attribute_setChanges dataUpdate an existing attribute set identified by attribute set id. API summary: eav/attribute-sets/{attributeSetId}.
  • update_attribute_set_groupsVisible to othersUpdate an existing group identified by attribute set id. Has effects visible outside this system. API summary: products/attribute-sets/{attributeSetId}/groups.
  • update_bundle_product_linkChanges dataUpdate an existing link identified by link id. API summary: bundle-products/{sku}/links/{id}.
  • update_bundle_product_link_post_v1_bundleproducts_sku_links_optiChanges dataUpdate an existing link identified by option id. API summary: bundle-products/{sku}/links/{optionId}.
  • update_cartChanges dataUpdate an existing cart identified by cart id. API summary: carts/{cartId}.
  • update_cart_couponChanges dataUpdate an existing coupon identified by coupon code. API summary: carts/{cartId}/coupons/{couponCode}.
  • update_cart_couponsVisible to othersUpdate an existing coupon identified by cart id. Has effects visible outside this system. API summary: carts/{cartId}/coupons.
  • update_cart_gift_cardsVisible to othersUpdate an existing gift card identified by cart id. Has effects visible outside this system. API summary: carts/{cartId}/giftCards.
  • update_cart_messageVisible to othersUpdate an existing message identified by item id. Has effects visible outside this system. API summary: carts/{cartId}/gift-message/{itemId}.
  • update_cart_ordersVisible to othersUpdate an existing order identified by cart id. Has effects visible outside this system. API summary: carts/{cartId}/order.
  • update_cart_paymentsVisible to othersUpdate an existing payment identified by cart id. Has effects visible outside this system. API summary: carts/{cartId}/selected-payment-method.
  • update_cart_productChanges dataUpdate an existing product identified by product id. API summary: carts/{cartId}/items/{itemId}.
  • update_categoryChanges dataUpdate an existing category identified by category id. API summary: categories/{id}.
  • update_category_movesVisible to othersUpdate an existing move identified by category id. Has effects visible outside this system. API summary: categories/{categoryId}/move.
  • update_category_productsVisible to othersUpdate an existing product identified by category id. Has effects visible outside this system. API summary: categories/{categoryId}/products.
  • update_cms_blockChanges dataUpdate an existing cms block identified by cms block id. API summary: cmsBlock/{id}.
  • update_collect_totalsVisible to othersUpdate an existing collect total. Has effects visible outside this system. API summary: carts/mine/collect-totals.
  • update_companyDeletesUpdate an existing company identified by company id. Destructive action; may require approval. API summary: company/role/{id}.
  • update_company_post_v1_team_company_idChanges dataUpdate an existing company identified by company id. API summary: team/{companyId}.
  • update_company_put_v1_company_company_idChanges dataUpdate an existing company identified by company id. API summary: company/{companyId}.
  • update_company_put_v1_company_credits_history_history_idChanges dataUpdate an existing company identified by company id. API summary: companyCredits/history/{historyId}.
  • update_company_put_v1_company_credits_idChanges dataUpdate an existing company identified by company id. API summary: companyCredits/{id}.
  • update_configurable_product_productChanges dataUpdate an existing product identified by product id. API summary: configurable-products/{sku}/options/{id}.
  • update_couponChanges dataUpdate an existing coupon identified by coupon code. API summary: carts/mine/coupons/{couponCode}.
  • update_couponsVisible to othersUpdate an existing coupon. Has effects visible outside this system. API summary: carts/mine/coupons.
  • update_credit_noteChanges dataUpdate an existing credit note identified by credit note id. API summary: creditmemo/{id}.
  • update_customerChanges dataUpdate a customer by `customer_id`; `customer` must include email, firstname and lastname.
  • update_customer_2Changes dataUpdate an existing customer identified by customer id. API summary: customerGroups/default/{id}.
  • update_customer_companyChanges dataUpdate an existing company identified by company id. API summary: customers/{customerId}/companies/{companyId}.
  • update_customer_put_v1_customer_groups_idChanges dataUpdate an existing customer identified by customer id. API summary: customerGroups/{id}.
  • update_customersVisible to othersUpdate an existing customer. Has effects visible outside this system. API summary: customers/me.
  • update_default_provider_codeChanges dataUpdate an existing default provider code identified by user id. API summary: tfa/default-provider-code/{userId}.
  • update_documentsVisible to othersUpdate an existing document. Has effects visible outside this system. API summary: negotiableQuoteTemplate/referenceDocumentLink.
  • update_event_subscribeChanges dataUpdate an existing event subscribe identified by name. API summary: eventing/eventSubscribe/{name}.
  • update_event_unsubscribeChanges dataUpdate an existing event unsubscribe identified by name. API summary: eventing/eventUnsubscribe/{name}.
  • update_eventings_configurationVisible to othersUpdate an existing eventing. Has effects visible outside this system. API summary: eventing/updateConfiguration.
  • update_gift_wrappingChanges dataUpdate an existing gift wrapping identified by wrapping id. API summary: gift-wrappings/{wrappingId}.
  • update_guest_cartChanges dataUpdate an existing guest cart identified by cart id. API summary: guest-carts/{cartId}.
  • update_guest_cart_collect_totalsVisible to othersUpdate an existing collect total identified by cart id. Has effects visible outside this system. API summary: guest-carts/{cartId}/collect-totals.
  • update_guest_cart_couponChanges dataUpdate an existing coupon identified by coupon code. API summary: guest-carts/{cartId}/coupons/{couponCode}.
  • update_guest_cart_messageVisible to othersUpdate an existing message identified by item id. Has effects visible outside this system. API summary: guest-carts/{cartId}/gift-message/{itemId}.
  • update_guest_cart_orderChanges dataUpdate an existing order identified by order id. API summary: guest-carts/{cartId}/payment-order/{id}.
  • update_guest_cart_ordersVisible to othersUpdate an existing order identified by cart id. Has effects visible outside this system. API summary: guest-carts/{cartId}/order.
  • update_guest_cart_payment_informationChanges dataUpdate an existing guest cart identified by cart id. API summary: guest-carts/{cartId}/set-payment-information.
  • update_guest_cart_paymentsVisible to othersUpdate an existing payment identified by cart id. Has effects visible outside this system. API summary: guest-carts/{cartId}/selected-payment-method.
  • update_guest_cart_productChanges dataUpdate an existing product identified by product id. API summary: guest-carts/{cartId}/items/{itemId}.
  • update_inventoryChanges dataUpdate an existing inventory identified by inventory code. API summary: inventory/sources/{sourceCode}.
  • update_inventory_put_v1_inventory_stocks_stock_idChanges dataUpdate an existing inventory identified by inventory id. API summary: inventory/stocks/{stockId}.
  • update_messageVisible to othersUpdate an existing message identified by item id. Has effects visible outside this system. API summary: carts/mine/gift-message/{itemId}.
  • update_minesVisible to othersUpdate an existing mine. Has effects visible outside this system. API summary: carts/mine.
  • update_mines_payment_informationChanges dataUpdate an existing mine. API summary: carts/mine/set-payment-information.
  • update_moveChanges dataUpdate an existing move identified by move id. API summary: hierarchy/move/{id}.
  • update_negotiable_cart_couponChanges dataUpdate an existing coupon identified by coupon code. API summary: negotiable-carts/{cartId}/coupons/{couponCode}.
  • update_negotiable_cart_payment_informationChanges dataUpdate an existing negotiable cart identified by cart id. API summary: negotiable-carts/{cartId}/set-payment-information.
  • update_orderChanges dataUpdate an existing order identified by order id. API summary: carts/mine/payment-order/{id}.
  • update_order_put_v1_orders_parent_idChanges dataUpdate an existing order identified by parent id. API summary: orders/{parentid}.
  • update_ordersVisible to othersUpdate an existing order. Has effects visible outside this system. API summary: carts/mine/order.
  • update_orders_put_v1_orders_createVisible to othersUpdate an existing order. Has effects visible outside this system. API summary: orders/create.
  • update_pageChanges dataUpdate an existing page identified by page id. API summary: cmsPage/{id}.
  • update_passwordsMoves moneyUpdate an existing password. Financial or irreversible action; may require approval. API summary: customers/me/password.
  • update_paymentsVisible to othersUpdate an existing payment. Has effects visible outside this system. API summary: carts/mine/selected-payment-method.
  • update_productChanges dataUpdate a product by `sku`, e.g. name, price or status; pass only the fields to change inside `product` (which also needs `sku`).
  • update_product_2Changes dataUpdate an existing product identified by product id. API summary: bundle-products/options/{optionId}.
  • update_product_downloadable_linkChanges dataUpdate an existing downloadable link identified by downloadable link id. API summary: products/{sku}/downloadable-links/{id}.
  • update_product_is_filterableChanges dataUpdate an existing is filterable identified by is filterable. API summary: products/attributes/{attributeCode}/is-filterable/{isFilterable}.
  • update_product_optionChanges dataUpdate an existing option identified by option id. API summary: products/attributes/{attributeCode}/options/{optionId}.
  • update_product_put_v1_carts_mine_items_item_idChanges dataUpdate an existing product identified by product id. API summary: carts/mine/items/{itemId}.
  • update_product_put_v1_products_attributes_attribute_codeChanges dataUpdate an existing product identified by product code. API summary: products/attributes/{attributeCode}.
  • update_product_put_v1_products_product_sku_stock_items_item_idChanges dataUpdate an existing product identified by item id. API summary: products/{productSku}/stockItems/{itemId}.
  • update_product_put_v1_products_sku_media_entry_idChanges dataUpdate an existing product identified by entry id. API summary: products/{sku}/media/{entryId}.
  • update_product_websitesVisible to othersUpdate an existing website identified by sku. Has effects visible outside this system. API summary: products/{sku}/websites.
  • update_productsVisible to othersUpdate an existing product. Has effects visible outside this system. API summary: configurable-products/variation.
  • update_products_put_v1_products_sku_linksVisible to othersUpdate an existing product identified by sku. Has effects visible outside this system. API summary: products/{sku}/links.
  • update_purchase_order_cart_payment_informationChanges dataUpdate an existing purchase order cart identified by cart id. API summary: purchase-order-carts/{cartId}/set-payment-information.
  • update_quoteChanges dataUpdate an existing quote identified by quote id. API summary: negotiableQuote/{quoteId}.
  • update_quote_shipping_methodsVisible to othersUpdate an existing shipping method identified by quote id. Has effects visible outside this system. API summary: negotiableQuote/{quoteId}/shippingMethod.
  • update_quotesVisible to othersUpdate an existing quote. Has effects visible outside this system. API summary: negotiableQuoteTemplate.
  • update_returnChanges dataUpdate an existing return identified by return id. API summary: returns/{id}.
  • update_sales_ruleChanges dataUpdate an existing sales rule identified by rule id. API summary: salesRules/{ruleId}.
  • update_sampleChanges dataUpdate an existing sample identified by sample id. API summary: products/{sku}/downloadable-links/samples/{id}.
  • update_send_tokenDeletesUpdate an existing send token identified by via. Destructive action; may require approval. API summary: tfa/provider/authy/send-token/{via}.
  • update_shared_catalogChanges dataUpdate an existing shared catalog identified by shared catalog id. API summary: sharedCatalog/{id}.
  • update_tax_classChanges dataUpdate an existing tax class identified by class id. API summary: taxClasses/{classId}.
  • update_tax_ratesVisible to othersUpdate an existing tax rate. Has effects visible outside this system. API summary: taxRates.
  • update_tax_rulesVisible to othersUpdate an existing tax rule. Has effects visible outside this system. API summary: taxRules.
  • update_tier_priceChanges dataUpdate an existing price identified by price. API summary: products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}.
  • update_tier_pricesVisible to othersUpdate an existing tier price. Has effects visible outside this system. API summary: products/tier-prices.
  • update_user_providerChanges dataUpdate an existing user provider identified by user id. API summary: tfa/user-providers/{userId}.

Set up in three steps

  1. 1

    Pick the app

    Create a free HeyMyApps account and choose Magento 2 (Adobe Commerce) from the app list.

  2. 2

    Paste your key

    Enter your store's base address without a trailing slash (for example https://shop.example.com) and paste an integration access token. In the Magento Admin go to System > Extensions > Integrations > Add New Integration, give it a name, pick the API resources it may use, save and click Activate, then copy the Access Token. On Magento 2.4.4 or newer also set Stores > Configuration > Services > OAuth > Consumer Settings > 'Allow OAuth Access Tokens to be used as standalone Bearer tokens' to Yes.

  3. 3

    Add the link to your AI

    You get a personal MCP link. Add it to Claude, ChatGPT or Cursor:

    1. Click your name, then Settings › Connectors › Add custom connector.
    2. Paste your link as the Remote MCP server URL.
    3. Switch it on from the + menu in a chat.

Questions

What can the AI do in Magento 2?

The AI can search and read orders, invoices, shipments, credit memos, products, stock, customers, categories and store settings. It can comment on, hold, release, cancel, invoice, ship and refund orders, create and update products and customers, and set stock at an inventory source, if you switch those tools on.

Does the AI see my Magento access token?

No. Your Magento access token is encrypted at rest and never shown to the AI. After you save it, it is not shown again, not even to you. The AI only sees the results of the tools it calls.

Can I control what the AI is allowed to do?

Yes. You choose which tools are switched on, so you can start read-only. Cancelling an order cannot be undone, refunds move money, and invoicing can capture payment online. Those actions can require your approval before they run. Every tool call is logged.

Does it work with ChatGPT?

Yes. In ChatGPT go to Settings › Apps & Connectors › Advanced and turn on Developer mode, then add your HeyMyApps link. Developer mode needs a paid ChatGPT plan: Plus, Pro, Business or Enterprise. The same link also works in Claude (Settings › Connectors › Add custom connector), Cursor and other MCP clients.

What does it cost?

HeyMyApps has a free plan with no credit card required. Paid plans bill per completed task. You also need your own Magento 2 or Adobe Commerce store.

Why does Magento need a setting changed for the token?

From Magento 2.4.4, integration access tokens are only accepted as Bearer tokens when 'Allow OAuth Access Tokens to be used as standalone Bearer tokens' is set to Yes under Stores > Configuration > Services > OAuth > Consumer Settings. Without it, the token is refused. The API resources you pick for the integration also limit what the AI can reach.

Let your AI work in Magento 2 (Adobe Commerce) today.

Start free. Your key stays encrypted, and you decide what the AI may do.

Connect Magento 2 (Adobe Commerce) free

HeyMyApps is not affiliated with Magento 2 (Adobe Commerce). Product names are trademarks of their owners.