Adobe Commerce only. Learn more
REST API reference for Adobe Commerce as a Cloud Service
The Adobe Commerce as a Cloud Service REST API contains the following endpoints. More detailed endpoint information will be available in the future. For more immediate information, you can cross-reference the endpoints listed here with the existing REST API reference for Adobe Commerce on Cloud and on-premises deployments.
Endpoints
| Endpoint | Method |
|---|---|
/V1/addresses/:addressId | DELETE |
/V1/adobe_io_events/check_configuration | GET |
/V1/adobestock/asset/:id | DELETE |
/V1/adobestock/asset/:id | GET |
/V1/adobestock/asset/list | GET |
/V1/adobestock/asset/search | GET |
/V1/adobestock/search | GET |
/V1/analytics/link | GET |
/V1/attributeMetadata/customer | GET |
/V1/attributeMetadata/customer/attribute/:attributeCode | GET |
/V1/attributeMetadata/customer/custom | GET |
/V1/attributeMetadata/customer/form/:formCode | GET |
/V1/attributeMetadata/customerAddress | GET |
/V1/attributeMetadata/customerAddress/attribute/:attributeCode | GET |
/V1/attributeMetadata/customerAddress/custom | GET |
/V1/attributeMetadata/customerAddress/form/:formCode | GET |
/V1/bulk | GET |
/V1/bulk/:bulkUuid/detailed-status | GET |
/V1/bulk/:bulkUuid/operation-status/:status | GET |
/V1/bulk/:bulkUuid/status | GET |
/V1/bundle-products/:productSku/children | GET |
/V1/bundle-products/:sku/links/:id | PUT |
/V1/bundle-products/:sku/links/:optionId | POST |
/V1/bundle-products/:sku/options/:optionId | GET |
/V1/bundle-products/:sku/options/:optionId | DELETE |
/V1/bundle-products/:sku/options/:optionId/children/:childSku | DELETE |
/V1/bundle-products/:sku/options/all | GET |
/V1/bundle-products/options/:optionId | PUT |
/V1/bundle-products/options/add | POST |
/V1/bundle-products/options/types | GET |
/V1/carts/ | POST |
/V1/carts/:cartId | GET |
/V1/carts/:cartId | PUT |
/V1/carts/:cartId/billing-address | GET |
/V1/carts/:cartId/billing-address | POST |
/V1/carts/:cartId/coupons | GET |
/V1/carts/:cartId/coupons | DELETE |
/V1/carts/:cartId/coupons/:couponCode | PUT |
/V1/carts/:cartId/estimate-shipping-methods | POST |
/V1/carts/:cartId/estimate-shipping-methods-by-address-id | POST |
/V1/carts/:cartId/giftCards | PUT |
/V1/carts/:cartId/giftCards/:giftCardCode | DELETE |
/V1/carts/:cartId/gift-message | GET |
/V1/carts/:cartId/gift-message | POST |
/V1/carts/:cartId/gift-message/:itemId | GET |
/V1/carts/:cartId/gift-message/:itemId | POST |
/V1/carts/:cartId/items | GET |
/V1/carts/:cartId/items/:itemId | PUT |
/V1/carts/:cartId/items/:itemId | DELETE |
/V1/carts/:cartId/order | PUT |
/V1/carts/:cartId/payment-methods | GET |
/V1/carts/:cartId/selected-payment-method | GET |
/V1/carts/:cartId/selected-payment-method | PUT |
/V1/carts/:cartId/shipping-information | POST |
/V1/carts/:cartId/shipping-methods | GET |
/V1/carts/:cartId/totals | GET |
/V1/carts/:cartId/totals-information | POST |
/V1/carts/:quoteId/giftCards | GET |
/V1/carts/:quoteId/items | POST |
/V1/carts/licence | GET |
/V1/carts/licence/list | GET |
/V1/carts/search | GET |
/V1/categories | POST |
/V1/categories | GET |
/V1/categories/:categoryId | DELETE |
/V1/categories/:categoryId | GET |
/V1/categories/:categoryId/move | PUT |
/V1/categories/:categoryId/products | GET |
/V1/categories/:categoryId/products | POST |
/V1/categories/:categoryId/products | PUT |
/V1/categories/:categoryId/products/:sku | DELETE |
/V1/categories/:id | PUT |
/V1/categories/attributes | GET |
/V1/categories/attributes/:attributeCode | GET |
/V1/categories/attributes/:attributeCode/options | GET |
/V1/categories/list | GET |
/V1/company/ | GET |
/V1/company/ | POST |
/V1/company/:companyId | GET |
/V1/company/:companyId | DELETE |
/V1/company/:companyId | PUT |
/V1/company/:parentId/relations | POST |
/V1/company/:parentId/relations/:companyId | DELETE |
/V1/company/assignRoles | PUT |
/V1/company/relations | GET |
/V1/company/role/ | GET |
/V1/company/role/ | POST |
/V1/company/role/:id | PUT |
/V1/company/role/:roleId | GET |
/V1/company/role/:roleId | DELETE |
/V1/company/role/:roleId/users | GET |
/V1/company/setCustomAttributes | POST |
/V1/companyCredits/ | GET |
/V1/companyCredits/:creditId | GET |
/V1/companyCredits/:creditId/decreaseBalance | POST |
/V1/companyCredits/:creditId/increaseBalance | POST |
/V1/companyCredits/:id | PUT |
/V1/companyCredits/company/:companyId | GET |
/V1/companyCredits/history | GET |
/V1/companyCredits/history/:historyId | PUT |
/V1/configurable-products/:sku/child | POST |
/V1/configurable-products/:sku/children | GET |
/V1/configurable-products/:sku/children/:childSku | DELETE |
/V1/configurable-products/:sku/options | POST |
/V1/configurable-products/:sku/options/:id | GET |
/V1/configurable-products/:sku/options/:id | PUT |
/V1/configurable-products/:sku/options/:id | DELETE |
/V1/configurable-products/:sku/options/all | GET |
/V1/configurable-products/variation | PUT |
/V1/coupons | POST |
/V1/coupons/:couponId | GET |
/V1/coupons/:couponId | PUT |
/V1/coupons/:couponId | DELETE |
/V1/coupons/deleteByCodes | POST |
/V1/coupons/deleteByIds | POST |
/V1/coupons/generate | POST |
/V1/coupons/search | GET |
/V1/creditmemo | POST |
/V1/creditmemo/:id | GET |
/V1/creditmemo/:id | PUT |
/V1/creditmemo/:id/comments | GET |
/V1/creditmemo/:id/comments | POST |
/V1/creditmemo/:id/emails | POST |
/V1/creditmemo/refund | POST |
/V1/creditmemos | GET |
/V1/customerGroups | POST |
/V1/customerGroups/:id | GET |
/V1/customerGroups/:id | PUT |
/V1/customerGroups/:id | DELETE |
/V1/customerGroups/:id/permissions | GET |
/V1/customerGroups/default | GET |
/V1/customerGroups/default/:id | PUT |
/V1/customerGroups/default/:storeId | GET |
/V1/customerGroups/search | GET |
/V1/customers/:customerId | GET |
/V1/customers/:customerId | PUT |
/V1/customers/:customerId | DELETE |
/V1/customers/:customerId/billingAddress | GET |
/V1/customers/:customerId/carts | POST |
/V1/customers/:customerId/confirm | GET |
/V1/customers/:customerId/permissions/readonly | GET |
/V1/customers/:customerId/shippingAddress | GET |
/V1/customers/:email/activate | PUT |
/V1/customers/addresses/:addressId | GET |
/V1/customers/confirm | POST |
/V1/customers/search | GET |
/V1/customers/validate | PUT |
/V1/eav/attribute-sets | POST |
/V1/eav/attribute-sets/:attributeSetId | GET |
/V1/eav/attribute-sets/:attributeSetId | DELETE |
/V1/eav/attribute-sets/:attributeSetId | PUT |
/V1/eav/attribute-sets/list | GET |
/V1/eventing/eventSubscribe/:name | POST |
/V1/eventing/eventUnsubscribe/:name | POST |
/V1/eventing/getEventProviders | GET |
/V1/eventing/getEventSubscriptions | GET |
/V1/eventing/updateConfiguration | PUT |
/V1/gift-wrappings | POST |
/V1/gift-wrappings | GET |
/V1/gift-wrappings/:id | GET |
/V1/gift-wrappings/:id | DELETE |
/V1/gift-wrappings/:wrappingId | PUT |
/V1/hierarchy/:id | GET |
/V1/hierarchy/move/:id | PUT |
/V1/import/csv | POST |
/V1/import/json | POST |
/V1/inventory/are-product-salable-for-requested-qty/ | GET |
/V1/inventory/are-products-salable | GET |
/V1/inventory/bulk-partial-source-transfer | POST |
/V1/inventory/bulk-product-source-assign | POST |
/V1/inventory/bulk-product-source-transfer | POST |
/V1/inventory/bulk-product-source-unassign | POST |
/V1/inventory/dump-stock-index-data/:salesChannelType/:salesChannelCode | GET |
/V1/inventory/export-stock-salable-qty/:salesChannelType/:salesChannelCode | GET |
/V1/inventory/get-distance | GET |
/V1/inventory/get-distance-provider-code | GET |
/V1/inventory/get-latlng-from-address | GET |
/V1/inventory/get-latslngs-from-address | GET |
/V1/inventory/get-product-salable-quantity/:sku/:stockId | GET |
/V1/inventory/get-sources-assigned-to-stock-ordered-by-priority/:stockId | GET |
/V1/inventory/is-product-salable/:sku/:stockId | GET |
/V1/inventory/is-product-salable-for-requested-qty/:sku/:stockId/:requestedQty | GET |
/V1/inventory/low-quantity-notification | POST |
/V1/inventory/low-quantity-notification/:sourceCode/:sku | GET |
/V1/inventory/low-quantity-notifications-delete | POST |
/V1/inventory/source-items | GET |
/V1/inventory/source-items | POST |
/V1/inventory/source-items-delete | POST |
/V1/inventory/sources | GET |
/V1/inventory/sources | POST |
/V1/inventory/sources/:sourceCode | GET |
/V1/inventory/sources/:sourceCode | PUT |
/V1/inventory/source-selection-algorithm-list | GET |
/V1/inventory/source-selection-algorithm-result | POST |
/V1/inventory/stock-resolver/:type/:code | GET |
/V1/inventory/stocks | GET |
/V1/inventory/stocks | POST |
/V1/inventory/stocks/:stockId | GET |
/V1/inventory/stocks/:stockId | DELETE |
/V1/inventory/stocks/:stockId | PUT |
/V1/inventory/stock-source-links | GET |
/V1/inventory/stock-source-links | POST |
/V1/inventory/stock-source-links-delete | POST |
/V1/invoice/:invoiceId/refund | POST |
/V1/invoices | GET |
/V1/invoices/ | POST |
/V1/invoices/:id | GET |
/V1/invoices/:id/capture | POST |
/V1/invoices/:id/comments | GET |
/V1/invoices/:id/emails | POST |
/V1/invoices/:id/void | POST |
/V1/invoices/comments | POST |
/V1/modules | GET |
/V1/negotiable-cart-item-note | POST |
/V1/negotiable-cart-item-note/:noteId | GET |
/V1/negotiable-cart-item-note/:noteId | DELETE |
/V1/negotiable-cart-item-note/search | GET |
/V1/negotiableQuote/:negotiableQuoteId/duplicate | POST |
/V1/negotiableQuote/:quoteId | PUT |
/V1/negotiableQuote/:quoteId/comments | GET |
/V1/negotiableQuote/:quoteId/shippingMethod | PUT |
/V1/negotiableQuote/attachmentContent | GET |
/V1/negotiableQuote/decline | POST |
/V1/negotiableQuote/draft | POST |
/V1/negotiableQuote/pricesUpdated | POST |
/V1/negotiableQuote/request | POST |
/V1/negotiableQuote/setCustomAttributes | POST |
/V1/negotiableQuote/submitToCustomer | POST |
/V1/negotiableQuoteTemplate/:templateId | PUT |
/V1/negotiableQuoteTemplate/decline | POST |
/V1/negotiableQuoteTemplate/draft | POST |
/V1/negotiableQuoteTemplate/request | POST |
/V1/negotiableQuoteTemplate/submitToCustomer | POST |
/V1/oope_payment_method/:code | GET |
/V1/oope_payment_method | GET |
/V1/oope_payment_method | POST |
/V1/oope_shipping_carrier | GET |
/V1/oope_shipping_carrier/:code | GET |
/V1/oope_shipping_carrier | POST |
/V1/oope_shipping_carrier | PUT |
/V1/oope_shipping_carrier/:code | DELETE |
/V1/order/:orderId/invoice | POST |
/V1/order/:orderId/refund | POST |
/V1/order/:orderId/ship | POST |
/V1/order/notify-orders-are-ready-for-pickup | POST |
/V1/orders | GET |
/V1/orders | POST |
/V1/orders/:id | GET |
/V1/orders/:id/cancel | POST |
/V1/orders/:id/comments | POST |
/V1/orders/:id/comments | GET |
/V1/orders/:id/emails | POST |
/V1/orders/:id/hold | POST |
/V1/orders/:id/statuses | GET |
/V1/orders/:id/unhold | POST |
/V1/orders/:parent_id | PUT |
/V1/orders/create | PUT |
/V1/orders/items | GET |
/V1/orders/items/:id | GET |
/V1/products | POST |
/V1/products | GET |
/V1/products/:productSku/stockItems/:itemId | PUT |
/V1/products/:sku | PUT |
/V1/products/:sku | DELETE |
/V1/products/:sku | GET |
/V1/products/:sku/downloadable-links | GET |
/V1/products/:sku/downloadable-links | POST |
/V1/products/:sku/downloadable-links/:id | PUT |
/V1/products/:sku/downloadable-links/samples | GET |
/V1/products/:sku/downloadable-links/samples | POST |
/V1/products/:sku/downloadable-links/samples/:id | PUT |
/V1/products/:sku/group-prices/:customerGroupId/tiers | GET |
/V1/products/:sku/group-prices/:customerGroupId/tiers/:qty | DELETE |
/V1/products/:sku/group-prices/:customerGroupId/tiers/:qty/price/:price | POST |
/V1/products/:sku/links | POST |
/V1/products/:sku/links | PUT |
/V1/products/:sku/links/:type | GET |
/V1/products/:sku/links/:type/:linkedProductSku | DELETE |
/V1/products/:sku/media | POST |
/V1/products/:sku/media | GET |
/V1/products/:sku/media/:entryId | GET |
/V1/products/:sku/media/:entryId | PUT |
/V1/products/:sku/media/:entryId | DELETE |
/V1/products/:sku/options | GET |
/V1/products/:sku/options/:optionId | GET |
/V1/products/:sku/options/:optionId | DELETE |
/V1/products/:sku/websites | POST |
/V1/products/:sku/websites | PUT |
/V1/products/:sku/websites/:websiteId | DELETE |
/V1/products/attributes | GET |
/V1/products/attributes | POST |
/V1/products/attributes/:attributeCode | GET |
/V1/products/attributes/:attributeCode | PUT |
/V1/products/attributes/:attributeCode | DELETE |
/V1/products/attributes/:attributeCode/is-filterable | GET |
/V1/products/attributes/:attributeCode/is-filterable/:isFilterable | PUT |
/V1/products/attributes/:attributeCode/options | GET |
/V1/products/attributes/:attributeCode/options | POST |
/V1/products/attributes/:attributeCode/options/:optionId | PUT |
/V1/products/attributes/:attributeCode/options/:optionId | DELETE |
/V1/products/attributes/types | GET |
/V1/products/attribute-sets | POST |
/V1/products/attribute-sets/:attributeSetId | GET |
/V1/products/attribute-sets/:attributeSetId | DELETE |
/V1/products/attribute-sets/:attributeSetId | PUT |
/V1/products/attribute-sets/:attributeSetId/attributes | GET |
/V1/products/attribute-sets/:attributeSetId/attributes/:attributeCode | DELETE |
/V1/products/attribute-sets/:attributeSetId/groups | PUT |
/V1/products/attribute-sets/attributes | POST |
/V1/products/attribute-sets/groups | POST |
/V1/products/attribute-sets/groups/:groupId | DELETE |
/V1/products/attribute-sets/groups/list | GET |
/V1/products/attribute-sets/sets/list | GET |
/V1/products/base-prices | POST |
/V1/products/base-prices-information | POST |
/V1/products/cost | POST |
/V1/products/cost-delete | POST |
/V1/products/cost-information | POST |
/V1/products/downloadable-links/:id | DELETE |
/V1/products/downloadable-links/samples/:id | DELETE |
/V1/products/links/:type/attributes | GET |
/V1/products/links/types | GET |
/V1/products/media/types/:attributeSetName | GET |
/V1/products/options | POST |
/V1/products/options/:optionId | PUT |
/V1/products/options/types | GET |
/V1/products/special-price | POST |
/V1/products/special-price-delete | POST |
/V1/products/special-price-information | POST |
/V1/products/tier-prices | POST |
/V1/products/tier-prices | PUT |
/V1/products/tier-prices-delete | POST |
/V1/products/tier-prices-information | POST |
/V1/products/types | GET |
/V1/returns | POST |
/V1/returns | GET |
/V1/returns/:id | GET |
/V1/returns/:id | DELETE |
/V1/returns/:id | PUT |
/V1/returns/:id/comments | POST |
/V1/returns/:id/comments | GET |
/V1/returns/:id/labels | GET |
/V1/returns/:id/tracking-numbers | POST |
/V1/returns/:id/tracking-numbers | GET |
/V1/returns/:id/tracking-numbers/:trackId | DELETE |
/V1/returnsAttributeMetadata | GET |
/V1/returnsAttributeMetadata/:attributeCode | GET |
/V1/returnsAttributeMetadata/custom | GET |
/V1/returnsAttributeMetadata/form/:formCode | GET |
/V1/saasOrderSync/orderSync | POST |
/V1/saasOrderSync/orderSync | GET |
/V1/saasOrderSync/orderSync/:sync_id | GET |
/V1/saasOrderSync/orderSync/:sync_id/cancel | PUT |
/V1/salesRules | POST |
/V1/salesRules/:ruleId | GET |
/V1/salesRules/:ruleId | PUT |
/V1/salesRules/:ruleId | DELETE |
/V1/salesRules/search | GET |
/V1/sharedCatalog | POST |
/V1/sharedCatalog/ | GET |
/V1/sharedCatalog/:id | PUT |
/V1/sharedCatalog/:id/assignCategories | POST |
/V1/sharedCatalog/:id/assignProducts | POST |
/V1/sharedCatalog/:id/categories | GET |
/V1/sharedCatalog/:id/products | GET |
/V1/sharedCatalog/:id/unassignCategories | POST |
/V1/sharedCatalog/:id/unassignProducts | POST |
/V1/sharedCatalog/:sharedCatalogId | GET |
/V1/sharedCatalog/:sharedCatalogId | DELETE |
/V1/sharedCatalog/:sharedCatalogId/assignCompanies | POST |
/V1/sharedCatalog/:sharedCatalogId/assignTierPrices | POST |
/V1/sharedCatalog/:sharedCatalogId/companies | GET |
/V1/sharedCatalog/:sharedCatalogId/resetTierPrices | POST |
/V1/sharedCatalog/:sharedCatalogId/unassignCompanies | POST |
/V1/shipment/ | POST |
/V1/shipment/:id | GET |
/V1/shipment/:id/comments | GET |
/V1/shipment/:id/comments | POST |
/V1/shipment/:id/emails | POST |
/V1/shipment/:id/label | GET |
/V1/shipment/track | POST |
/V1/shipment/track/:id | DELETE |
/V1/shipments | GET |
/V1/stockItems/:productSku | GET |
/V1/stockItems/lowStock/ | GET |
/V1/stockStatuses/:productSku | GET |
/V1/store/storeConfigs | GET |
/V1/store/storeGroups | GET |
/V1/store/storeViews | GET |
/V1/store/websites | GET |
/V1/taxClasses | POST |
/V1/taxClasses/:classId | PUT |
/V1/taxClasses/:taxClassId | GET |
/V1/taxClasses/:taxClassId | DELETE |
/V1/taxClasses/search | GET |
/V1/taxRates | POST |
/V1/taxRates | PUT |
/V1/taxRates/:rateId | GET |
/V1/taxRates/:rateId | DELETE |
/V1/taxRates/search | GET |
/V1/taxRules | POST |
/V1/taxRules | PUT |
/V1/taxRules/:ruleId | DELETE |
/V1/taxRules/:ruleId | GET |
/V1/taxRules/search | GET |
/V1/team/ | GET |
/V1/team/:companyId | POST |
/V1/team/:teamId | GET |
/V1/team/:teamId | DELETE |
/V1/team/:teamId | PUT |
/V1/tfa/default-provider-code/:userId | GET |
/V1/tfa/default-provider-code/:userId | PUT |
/V1/tfa/forced-providers | GET |
/V1/tfa/installed-providers | GET |
/V1/tfa/providers-to-activate/:userId | GET |
/V1/tfa/user-providers/:userId | GET |
/V1/tfa/user-providers/:userId | PUT |
/V1/transactions | GET |
/V1/transactions/:id | GET |
/V1/webhooks/list | GET |
/V1/webhooks/subscribe | POST |
/V1/webhooks/unsubscribe | POST |
/V2/carts/:cartId/coupons | GET |
/V2/carts/:cartId/coupons | POST |
/V2/carts/:cartId/coupons | PUT |
/V2/carts/:cartId/coupons/deleteByCodes | POST |
