Skip to main content

Adobe Commerce/Magento 2 API Endpoints

Complete inventory of the Adobe Commerce/Magento 2 REST endpoints the iPaaS.com integration calls, grouped by entity, for deprecation checks and firewall allow-listing.

See what the Adobe Commerce / Magento integration can do →

API Endpoints

The Adobe Commerce (Magento 2) integration communicates with your store over the Adobe Commerce REST API. This article catalogs every endpoint the integration calls, grouped by entity, so you can allow-list the required paths on your firewall, plan API scopes, and quickly assess whether a published Adobe Commerce deprecation notice affects the integration.

All endpoints share a common base URL that is derived from the store URL you enter in the integration's connection settings. The base URL is your Adobe Commerce store address followed by the REST namespace:

[Base URL]/rest/V1/

When a store view is configured in the connection settings, the integration issues store-scoped calls that insert the store view code between the REST prefix and the version segment:

[Base URL]/rest/{store}/V1/

Throughout this article, [Base URL] stands for your store's address (for example, your production or sandbox Adobe Commerce URL) so that the documented paths apply to any environment. Requests are authenticated with a bearer token supplied in the Authorization header; see the Authorization Endpoint section for how that token is obtained. List endpoints use Adobe Commerce searchCriteria query parameters for filtering and paging (for example, searchCriteria[pageSize] and searchCriteria[currentPage]); results are returned in the standard Adobe Commerce search-results envelope.

Table of Contents

Products Endpoints

Get a Product by SKU (GET)

[Base URL]/rest/V1/products/{sku}

Search Products (GET)

[Base URL]/rest/V1/products?searchCriteria[filter_groups][0][filters][0][field]=sku&searchCriteria[filter_groups][0][filters][0][value]={value}&searchCriteria[filter_groups][0][filters][0][condition_type]=like&searchCriteria[currentPage]=1&searchCriteria[pageSize]=100

Create a Product (POST)

[Base URL]/rest/V1/products

Update a Product (PUT)

[Base URL]/rest/V1/products/{sku}

Delete a Product (DELETE)

[Base URL]/rest/V1/products/{sku}

Get Product Attributes (GET)

[Base URL]/rest/V1/products/attributes?searchCriteria[filter_groups][0][filters][0][field]=attribute_code&searchCriteria[filter_groups][0][filters][0][value]={attributeCode}&searchCriteria[filter_groups][0][filters][0][condition_type]=eq

Create a Product Attribute (POST)

[Base URL]/rest/V1/products/attributes

Get Attribute Options (GET)

[Base URL]/rest/V1/products/attributes/{attributeCode}/options

Create an Attribute Option (POST)

[Base URL]/rest/V1/products/attributes/{attributeCode}/options

Get Attributes for an Attribute Set (GET)

[Base URL]/rest/V1/products/attribute-sets/{attributeSetId}/attributes

Assign an Attribute to an Attribute Set (POST)

[Base URL]/rest/V1/products/attribute-sets/attributes

Set a Product Tier Price (POST)

[Base URL]/rest/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{value}

Delete a Product Tier Price (DELETE)

[Base URL]/rest/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}

Configurable Products Endpoints

Get Configurable Product Options (GET)

[Base URL]/rest/V1/configurable-products/{sku}/options/all

Add a Configurable Product Option (POST)

[Base URL]/rest/V1/configurable-products/{sku}/options

Update a Configurable Product Option (PUT)

[Base URL]/rest/V1/configurable-products/{sku}/options/{id}

Get Configurable Product Children (GET)

[Base URL]/rest/V1/configurable-products/{sku}/children

Add a Configurable Product Child (POST)

[Base URL]/rest/V1/configurable-products/{sku}/child

Categories Endpoints

Get a Category (GET)

[Base URL]/rest/V1/categories/{categoryId}

Get the Category Tree (GET)

[Base URL]/rest/V1/categories?rootCategoryId={rootCategoryId}&depth={depth}

Search Categories (GET)

[Base URL]/rest/V1/categories/list?searchCriteria[filter_groups][0][filters][0][field]=parent_id&searchCriteria[filter_groups][0][filters][0][value]={value}&searchCriteria[filter_groups][0][filters][0][condition_type]=eq

Create a Category (POST)

[Base URL]/rest/V1/categories

Update a Category (PUT)

[Base URL]/rest/V1/categories/{categoryId}

Move a Category (PUT)

[Base URL]/rest/V1/categories/{id}/move

Delete a Category (DELETE)

[Base URL]/rest/V1/categories/{id}

Customers Endpoints

Get a Customer (GET)

[Base URL]/rest/V1/customers/{id}

Search Customers (GET)

[Base URL]/rest/V1/customers/search?searchCriteria[filter_groups][0][filters][0][field]=email&searchCriteria[filter_groups][0][filters][0][value]={email}&searchCriteria[filter_groups][0][filters][0][condition_type]=eq

Create a Customer (POST)

[Base URL]/rest/V1/customers

Update a Customer (PUT)

[Base URL]/rest/V1/customers/{id}

Delete a Customer (DELETE)

[Base URL]/rest/V1/customers/{id}

Customer Groups Endpoints

Get a Customer Group (GET)

[Base URL]/rest/V1/customerGroups/{id}

Search Customer Groups (GET)

[Base URL]/rest/V1/customerGroups/search?searchCriteria[filter_groups][0][filters][0][field]=code&searchCriteria[filter_groups][0][filters][0][value]={value}&searchCriteria[filter_groups][0][filters][0][condition_type]=eq

Create a Customer Group (POST)

[Base URL]/rest/V1/customerGroups

Update a Customer Group (PUT)

[Base URL]/rest/V1/customerGroups/{id}

Delete a Customer Group (DELETE)

[Base URL]/rest/V1/customerGroups/{id}

Orders Endpoints

Get an Order (GET)

[Base URL]/rest/V1/orders/{id}

Search Orders (GET)

[Base URL]/rest/V1/orders?searchCriteria[currentPage]=1&searchCriteria[pageSize]=100

Get an Order Item (GET)

[Base URL]/rest/V1/orders/items/{id}

Create an Order (POST)

[Base URL]/rest/V1/orders

Cancel an Order (POST)

[Base URL]/rest/V1/orders/{id}/cancel

Add an Order Comment (POST)

[Base URL]/rest/V1/orders/{id}/comments

Invoices Endpoints

Get an Invoice (GET)

[Base URL]/rest/V1/invoices/{id}

Create an Invoice for an Order (POST)

[Base URL]/rest/V1/order/{id}/invoice

Create an Invoice (POST)

[Base URL]/rest/V1/invoices

Add an Invoice Comment (POST)

[Base URL]/rest/V1/invoices/comments

Shipments Endpoints

Get a Shipment (GET)

[Base URL]/rest/V1/shipment/{id}

Create a Shipment for an Order (POST)

[Base URL]/rest/V1/order/{id}/ship

Create a Shipment (POST)

[Base URL]/rest/V1/shipment

Inventory Endpoints

Get Inventory Sources (GET)

[Base URL]/rest/V1/inventory/sources

Get an Inventory Source (GET)

[Base URL]/rest/V1/inventory/sources/{sourceCode}

Create an Inventory Source (POST)

[Base URL]/rest/V1/inventory/sources

Update an Inventory Source (PUT)

[Base URL]/rest/V1/inventory/sources/{sourceCode}

Get Inventory Stocks (GET)

[Base URL]/rest/V1/inventory/stocks

Get an Inventory Stock (GET)

[Base URL]/rest/V1/inventory/stocks/{stockId}

Create an Inventory Stock (POST)

[Base URL]/rest/V1/inventory/stocks

Update an Inventory Stock (PUT)

[Base URL]/rest/V1/inventory/stocks/{stockId}

Delete an Inventory Stock (DELETE)

[Base URL]/rest/V1/inventory/stocks/{stockId}

Get Inventory Source Items (GET)

[Base URL]/rest/V1/inventory/source-items?searchCriteria[filter_groups][0][filters][0][field]=sku&searchCriteria[filter_groups][0][filters][0][value]={sku}&searchCriteria[filter_groups][0][filters][0][condition_type]=eq

Create or Update Inventory Source Items (POST)

[Base URL]/rest/V1/inventory/source-items

Delete Inventory Source Items (POST)

[Base URL]/rest/V1/inventory/source-items-delete

Company Endpoints

Get Companies (GET)

[Base URL]/rest/V1/company?searchCriteria[filter_groups][0][filters][0][field]=company_name&searchCriteria[filter_groups][0][filters][0][value]={value}&searchCriteria[filter_groups][0][filters][0][condition_type]=eq

Create a Company (POST)

[Base URL]/rest/V1/company

Update a Company (PUT)

[Base URL]/rest/V1/company/{companyId}

Shared Catalog Endpoints

Search Shared Catalogs (GET)

[Base URL]/rest/V1/sharedCatalog?searchCriteria[filter_groups][0][filters][0][field]=name&searchCriteria[filter_groups][0][filters][0][value]={value}&searchCriteria[filter_groups][0][filters][0][condition_type]=eq

Create a Shared Catalog (POST)

[Base URL]/rest/V1/sharedCatalog

Update a Shared Catalog (PUT)

[Base URL]/rest/V1/sharedCatalog/{id}

Assign Categories to a Shared Catalog (POST)

[Base URL]/rest/V1/sharedCatalog/{catalogId}/assignCategories

Gift Card Endpoints

Check a Gift Card (GET)

[Base URL]/rest/V1/giftcard/check/{giftcode}

Get a Sold Gift Card Code for an Order Item (GET)

[Base URL]/rest/V1/cpgift/giftCardGetGiftCode/{orderincrementid}/{itemid}

Get Redeemed Gift Cards for an Order (GET)

[Base URL]/rest/V1/cpgift/salesOrderGiftCardInfo/{orderincrementid}

Tax Classes Endpoints

Search Tax Classes (GET)

[Base URL]/rest/V1/taxClasses/search?searchCriteria[filter_groups][0][filters][0][field]=class_name&searchCriteria[filter_groups][0][filters][0][value]={value}&searchCriteria[filter_groups][0][filters][0][condition_type]=eq

Directory Endpoints

Get Countries (GET)

[Base URL]/rest/V1/directory/countries

Store Endpoints

Get Websites (GET)

[Base URL]/rest/V1/store/websites

Get Store Views (GET)

[Base URL]/rest/V1/store/storeViews

Authorization Endpoint

The integration authenticates every request with a bearer token passed in the Authorization header. There are two ways to supply that token, depending on how the connection is configured.

Admin token exchange. When the connection is configured with an Adobe Commerce username and password, the integration exchanges those credentials for an admin bearer token by posting to the token endpoint. By default, admin tokens expire after four hours (this expiry is controlled in Adobe Commerce under Stores, Settings, Configuration, Services, OAuth, Access Token Expiration), after which the integration requests a new token automatically.

Get an Admin Token (POST)

[Base URL]/rest/V1/integration/admin/token

Integration access token (no exchange call). When the connection is configured with an Adobe Commerce integration access token, the integration uses that token directly as the bearer token and no token-exchange request is made. Adobe Commerce OAuth 1.0a credentials (consumer key/secret and access token/secret) are also supported; when a three-legged OAuth flow is used, the temporary and permanent tokens are obtained from the Adobe Commerce OAuth endpoints below.

Get an OAuth Request Token (POST)

[Base URL]/oauth/token/request

Get an OAuth Access Token (POST)

[Base URL]/oauth/token/access
Related Articles
Did this answer your question?