Adobe Commerce B2B API Endpoints
Base URLs
Sandbox/Test: Supplied by the client
Production/Live: Supplied by the client
Table of Contents
Customer Endpoints
Get a Customer: (GET)
https://{BaseURL}/rest/V1/customers/{customer-id}
Get All Customer: (GET)
https://{BaseURL}/rest/V1/customers?searchCriteria[pageSize]=100
Get Customer By Email: (GET)
https://{BaseURL}/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)
https://{BaseURL}/rest/V1/customers
Update a Customer: (PUT)
https://{BaseURL}/rest/V1/customers/{customer-id}
Update a Customer: (DELETE)
https://{BaseURL}/rest/V1/customers/{customer-id}
Customer Group Endpoints
Get a Customer Group: (GET)
https://{BaseURL}/rest/V1/customerGroups/{id}
Create a Customer Group: (POST)
https://{BaseURL}/rest/V1/customerGroups
Update a Customer Group: (PUT)
https://{BaseURL}/rest/V1/customerGroups/{id}
Get Customer Group by filter: (GET)
https://{BaseURL}/rest/V1/customerGroups /search?searchCriteria[filter_groups][0][filters][0][value]={value}&searchCriteria[filter_groups][0][filters][0][condition_type]=eq&searchCriteria[filter_groups][0][filters][0][field]=code
Delete a Customer Group: (DELETE)
https://{BaseURL}/rest/V1/customerGroups/{id}
Company Endpoints
Get a Company: (GET)
https://{BaseURL}/rest/V1/company/{company-id}
Create a Company: (POST)
https://{BaseURL}/rest/V1/company
Update a Company: (PUT)
https://{BaseURL}/rest/V1/company/{company-id}
Get Company By Email: (GET)
https://{BaseURL}rest/V1/company/search?searchCriteria[filter_groups][0][filters][0][value]={email}&searchCriteria[filter_groups][0][filters][0][condition_type]=eq&searchCriteria[filter_groups][0][filters][0][field]=email
Gift Card Endpoints
Get a Company: (GET)
https://{BaseURL}/rest/V1/giftcard/check/{giftcode}
Transaction/Order Endpoints
Get All Orders(by Id): (GET)
https://{BaseURL}/rest/V1/orders/{id}
Get All Orders: (GET)
https://{BaseURL}/rest/V1/orders?searchCriteria[currentPage]=1&searchCriteria[pageSize]=100
Create Order: (POST)
https://{BaseURL}/rest/V1/orders]
Cancel Order: (POST)
https://{BaseURL}/rest/V1/orders{id}/cancel
Post Comments Of Order: (POST)
https://{BaseURL}/rest/V1/orders{id}/comments
Get Order Gift Card: (GET)
https://{BaseURL}/rest/V1/cpgift/giftCardGetGiftCode/{orderincrementid}/{itemid}
Get Order Gift Card Sold: (GET)
https://{BaseURL}/rest/V1/cpgift/giftCardGetGiftCode/{orderincrementid}/{itemid}
Get Order Gift Card Redeemed: (GET)
https://{BaseURL}/rest/V1/cpgift/salesOrderGiftCardInfo/{orderincrementid}
Transaction/Invoice Endpoints
Get Invoice (by Key): (GET)
https://{BaseURL}/rest/V1/invoices/{invoice-id}
Create Invoice of Specific Order: (POST)
https://{BaseURL}/rest/V1/order/{order-id}/invoice
Create Invoice: (POST)
https://{BaseURL}/rest/V1/invoices
Invoice Comments: (POST)
https://{BaseURL}/rest/V1/invoices/comments
Shipment Endpoints
Get Shipment (by Key): (GET)
https://{BaseURL}/rest/V1/shipment/{id}
Create Shipment: (POST)
https://{BaseURL}/rest/V1/shipment
Create Shipment of Specific Order: (POST)
https://{BaseURL}/rest/V1/order/{order-id}/ship
Update Shipment: (PUT)
https://{BaseURL}/rest/V1/shipments
Get Inventory source items: (GET)
https://{BaseURL}rest/V1/inventory/source-items?searchCriteria[filter_groups][0][filters][0][value]={sku}&searchCriteria[filter_groups][0][filters][0][condition_type]=eq&searchCriteria[filter_groups][0][filters][0][field]=sku
Inventory Endpoints
Get Inventory (by source-code): (GET)
https://{BaseURL}/rest/V1/inventory/sources/{source-code}
Create Inventory: (POST)
https://{BaseURL}/rest/V1/inventory/sources
Update Inventory: (PUT)
https://{BaseURL}/rest/V1/inventory/sources/{source-code}
Product Endpoints
Get Product (by SKU): (GET)
https://{BaseURL}/rest/V1/products/{sku}
Create Product: (POST)
https://{BaseURL}/rest/V1/products
Update Product: (PUT)
https://{BaseURL}/rest/V1/products/{sku}
Delete Product: (DELETE)
https://{BaseURL}/rest/V1/products/{sku}
Get All Product: (GET)
https://{BaseURL}/rest/V1/products?searchCriteria[currentPage]=1&searchCriteria[pageSize]=100
Get Product By Sku: (GET)
https://{BaseURL}/rest/V1/products?searchCriteria[filter_groups][0][filters][0][field]=sku&searchCriteria[filter_groups][0][filters][0][value]=%25{Sku}^%25&searchCriteria[filter_groups][0][filters][0][condition_type]=like
Get Product Children: (GET)
https://{BaseURL}/rest/V1/products?configurable-products/{sku}/children
Get Product Attributes: (GET)
https://{BaseURL}/rest/V1/products/attribute-sets/{attributeSetId}/attributes
Get Product’s All Attributes Of Specific Set: (GET)
https://{BaseURL}/rest/V1/products/attribute-sets/groups/list?searchCriteria[filterGroups][0][filters][0][field]=attribute_set_id&searchCriteria[filterGroups][0][filters][0][value]={attributeSetId}
Create Product Attributes: (POST)
https://{BaseURL}/rest/V1/products/attributes
Assign Product Attribute Set Assignment: (POST)
https://{BaseURL}/rest/V1/ products/attribute-sets/attributes
Create Product Price Tier: (POST)
https://{BaseURL}/rest/v1/products/{sku}/group- prices/{customerGroup-Id}/tiers/{qty}
Delete Product Price Tier: (DELETE)
https://{BaseURL}/rest/v1/products/{sku}/group- prices/{customerGroup-Id}/tiers/{qty}
Product Options Endpoints
Get All Options: (GET)
https://{BaseURL}/rest/V1/products/attributes?searchCriteria
Get Product Option Values: (GET)
https://{BaseURL}/rest/V1/products/attribute-sets/{attributeCode}/options
Get Product Option Sets: (GET)
https://{BaseURL}/rest/V1/products/attribute-sets/{attributeSetId}/attributes
Create Product Option: (POST)
https://{BaseURL}/rest/V1/products/attributes
Product Variants Endpoints
Get Configurable Product: (GET)
https://{BaseURL}/rest/V1/configurable-products/{sku}/options/all
Get Product Attributes Options: (GET)
https://{BaseURL}/rest/V1/products/attributes/{attributeCode}/options
Create Product Attributes Options: (POST)
https://{BaseURL}/rest/V1/products/attributes/{attributeCode}/options
Create Product Variant: (POST)
https://{BaseURL}/rest/V1/configurable-products/{sku}/options
Update Configurable Product: (PUT)
https://{BaseURL}/rest/V1/configurable-products/{sku}/options/{id}
Create Configurable Product Child: (POST)
https://{BaseURL}/rest/V1/configurable-products/{sku}/child
Product Category Endpoints
Get Category: (GET)
https://{BaseURL}/rest/ V1/categories/{categoryId}
Get Shared Catalog: (GET)
https://{BaseURL}/rest/ V1/categories/list?searchCriteria
Create Category: (POST)
https://{BaseURL}/rest/ V1/categories
Create Shared Catalog: (POST)
https://{BaseURL}/rest/V1/sharedCatalog
Update Shared Catalog: (PUT)
https://{BaseURL}/rest/ V1/sharedCatalog/{id}
Delete Category: (GET)
https://{BaseURL}/rest/ V1/categories/{categoryId}
Get Categories W/O Depth: (GET)
https://{BaseURL}/rest/ V1/categories?rootCategoryId={rootCategoryId}
Get Categories With Depth: (GET)
https://{BaseURL}/rest/V1/categories?Depth={depth}&rootCategoryId={rootCategoryId}
Get Stores: (GET)
https://{BaseURL}/rest/ V1/store/storeViews?searchCriteria
Assign Categories to shared catalog: (POST)
https://{BaseURL}/rest/V1/sharedCatalog/{catalogId}/assignCategories
Move Product Category: (PUT)
https://{BaseURL}/rest/V1/categories/{id}/move
Inventory Endpoints
Get Inventory: (GET)
https://{BaseURL}/rest/V1/inventory/source-items/?searchCriteria[filterGroups][0][filters][0][field]=sku_set_id&searchCriteria[filterGroups][0][filters][0][value]={sku}
Get Inventory (by source-code): (GET)
https://{BaseURL}/rest/V1/inventory/sources/{source-code}
Create Inventory: (POST)
https://{BaseURL}/rest/V1/inventory/source-items
Delete Inventory: (DELETE)
https://{BaseURL}/rest/V1/inventory/source-items-delete
Inventory Source Endpoints
Get Inventory Source: (GET)
https://{BaseURL}/rest/V1/inventory/sources/{sourceCode}
Create Inventory Source: (POST)
https://{BaseURL}/rest/V1/inventory/sources
Update Inventory Source: (PUT)
https://{BaseURL}/rest/V1/inventory/sources/{sourceCode}
Inventory Location Group Endpoints
Get Inventory Source: (GET)
https://{BaseURL}/rest/V1/inventory/stocks/{stockId}
Create Inventory Source: (POST)
https://{BaseURL}/rest/V1/inventory/stocks
Update Inventory Source: (PUT)
https://{BaseURL}/rest/V1/inventory/stocks/{stockId}
Delete Inventory Source: (DELETE)
https://{BaseURL}/rest/V1/inventory/stocks/{stockId}
Authentication/OAuth Endpoints
Get Access Token: (POST)
https://{BaseURL}/rest/V1/integration/admin/token
Generic Endpoints
Search TaxClass By Specific Field: (GET)
https://{BaseURL}/rest/V1/taxClasses/search?searchCriteria[filter_groups][0][filters][0][value]={value}&searchCriteria[filter_groups][0][filters][0][condition_type]=eq&searchCriteria[filter_groups][0][filters][0][field]=code
Get Stores: (GET)
https://{BaseURL}/rest/V1/store/websites
Get Store Views: (GET)
https://{BaseURL}/rest/V1/store/storeViews/?searchcriteria
Get All Companies: (GET)
https://{BaseURL}/rest/V1/company?search?searchCriteria[pageSize]=100
Get All Companies: (GET)
https://{BaseURL}/rest/V1/directory/countries