Magento B2B
Magento Commerce is the leading provider of open omnichannel innovation.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Magento Commerce is the leading provider of open omnichannel innovation.
Endpoints 400
addresses/{addressId}
- DELETEaddresses/{addressId}
/V1/addresses/:addressIdDelete customer address by ID.
amazon-billing-address/{amazonOrderReferenceId}
- PUTamazon-billing-address/{amazonOrderReferenceId}
/V1/amazon-billing-address/:amazonOrderReferenceId
amazon-shipping-address/{amazonOrderReferenceId}
- PUTamazon-shipping-address/{amazonOrderReferenceId}
/V1/amazon-shipping-address/:amazonOrderReferenceId
amazon/order-ref
- DELETEamazon/order-ref
/V1/amazon/order-ref
analytics/link
- GETanalytics/link
/V1/analytics/link
attributeMetadata/customer
- GETattributeMetadata/customer
/V1/attributeMetadata/customerGet all attribute metadata.
attributeMetadata/customer/attribute/{attributeCode}
- GETattributeMetadata/customer/attribute/{attributeCode}
/V1/attributeMetadata/customer/attribute/:attributeCodeRetrieve attribute metadata.
attributeMetadata/customer/custom
- GETattributeMetadata/customer/custom
/V1/attributeMetadata/customer/custom?dataInterfaceName=stringGet custom attributes metadata for the given data interface.
attributeMetadata/customer/form/{formCode}
- GETattributeMetadata/customer/form/{formCode}
/V1/attributeMetadata/customer/form/:formCodeRetrieve all attributes filtered by form code
attributeMetadata/customerAddress
- GETattributeMetadata/customerAddress
/V1/attributeMetadata/customerAddressGet all attribute metadata.
attributeMetadata/customerAddress/attribute/{attributeCode}
- GETattributeMetadata/customerAddress/attribute/{attributeCode}
/V1/attributeMetadata/customerAddress/attribute/:attributeCodeRetrieve attribute metadata.
attributeMetadata/customerAddress/custom
- GETattributeMetadata/customerAddress/custom
/V1/attributeMetadata/customerAddress/custom?dataInterfaceName=stringGet custom attributes metadata for the given data interface.
attributeMetadata/customerAddress/form/{formCode}
- GETattributeMetadata/customerAddress/form/{formCode}
/V1/attributeMetadata/customerAddress/form/:formCodeRetrieve all attributes filtered by form code
bulk/{bulkUuid}/detailed-status
- GETbulk/{bulkUuid}/detailed-status
/V1/bulk/:bulkUuid/detailed-statusGet Bulk summary data with list of operations items full data.
bulk/{bulkUuid}/operation-status/{status}
- GETbulk/{bulkUuid}/operation-status/{status}
/V1/bulk/:bulkUuid/operation-status/:statusGet operations count by bulk uuid and status.
bulk/{bulkUuid}/status
- GETbulk/{bulkUuid}/status
/V1/bulk/:bulkUuid/statusGet Bulk summary data with list of operations items short data.
bundle-products/{productSku}/children
- GETbundle-products/{productSku}/children
/V1/bundle-products/:productSku/children?optionId=0Get all children for Bundle product
bundle-products/{sku}/links/{id}
- PUTbundle-products/{sku}/links/{id}
/V1/bundle-products/:sku/links/:id
bundle-products/{sku}/links/{optionId}
- POSTbundle-products/{sku}/links/{optionId}
/V1/bundle-products/:sku/links/:optionIdAdd child product to specified Bundle option by product sku
bundle-products/{sku}/options/{optionId}
- GETbundle-products/{sku}/options/{optionId}
/V1/bundle-products/:sku/options/:optionIdGet option for bundle product - DELETEbundle-products/{sku}/options/{optionId}
/V1/bundle-products/:sku/options/:optionIdRemove bundle option
bundle-products/{sku}/options/{optionId}/children/{childSku}
- DELETEbundle-products/{sku}/options/{optionId}/children/{childSku}
/V1/bundle-products/:sku/options/:optionId/children/:childSkuRemove product from Bundle product option
bundle-products/{sku}/options/all
- GETbundle-products/{sku}/options/all
/V1/bundle-products/:sku/options/allGet all options for bundle product
bundle-products/options/{optionId}
- PUTbundle-products/options/{optionId}
/V1/bundle-products/options/:optionIdAdd new option for bundle product
bundle-products/options/add
- POSTbundle-products/options/add
/V1/bundle-products/options/addAdd new option for bundle product
bundle-products/options/types
- GETbundle-products/options/types
/V1/bundle-products/options/typesGet all types for options for bundle products
carts/
- POSTcarts/
/V1/carts/Creates an empty cart and quote for a guest.
carts/{cartId}
- GETcarts/{cartId}
/V1/carts/:cartIdEnables an administrative user to return information for a specified cart. - PUTcarts/{cartId}
/V1/carts/:cartIdAssigns a specified customer to a specified shopping cart.
carts/{cartId}/billing-address
- GETcarts/{cartId}/billing-address
/V1/carts/:cartId/billing-addressReturns the billing address for a specified quote. - POSTcarts/{cartId}/billing-address
/V1/carts/:cartId/billing-addressAssigns a specified billing address to a specified cart.
carts/{cartId}/coupons
- GETcarts/{cartId}/coupons
/V1/carts/:cartId/couponsReturns information for a coupon in a specified cart. - DELETEcarts/{cartId}/coupons
/V1/carts/:cartId/couponsDeletes a coupon from a specified cart.
carts/{cartId}/coupons/{couponCode}
- PUTcarts/{cartId}/coupons/{couponCode}
/V1/carts/:cartId/coupons/:couponCodeAdds a coupon by code to a specified cart.
carts/{cartId}/estimate-shipping-methods
- POSTcarts/{cartId}/estimate-shipping-methods
/V1/carts/:cartId/estimate-shipping-methodsEstimate shipping by address and return list of available shipping methods
carts/{cartId}/estimate-shipping-methods-by-address-id
- POSTcarts/{cartId}/estimate-shipping-methods-by-address-id
/V1/carts/:cartId/estimate-shipping-methods-by-address-idEstimate shipping
carts/{cartId}/gift-message
- GETcarts/{cartId}/gift-message
/V1/carts/:cartId/gift-messageReturn the gift message for a specified order. - POSTcarts/{cartId}/gift-message
/V1/carts/:cartId/gift-messageSet the gift message for an entire order.
carts/{cartId}/gift-message/{itemId}
- GETcarts/{cartId}/gift-message/{itemId}
/V1/carts/:cartId/gift-message/:itemIdReturn the gift message for a specified item in a specified shopping cart. - POSTcarts/{cartId}/gift-message/{itemId}
/V1/carts/:cartId/gift-message/:itemIdSet the gift message for a specified item in a specified shopping cart.
carts/{cartId}/giftCards
- PUTcarts/{cartId}/giftCards
/V1/carts/:cartId/giftCards
carts/{cartId}/giftCards/{giftCardCode}
- DELETEcarts/{cartId}/giftCards/{giftCardCode}
/V1/carts/:cartId/giftCards/:giftCardCodeRemove GiftCard Account entity
carts/{cartId}/items
- GETcarts/{cartId}/items
/V1/carts/:cartId/itemsLists items that are assigned to a specified cart.
carts/{cartId}/items/{itemId}
- PUTcarts/{cartId}/items/{itemId}
/V1/carts/:cartId/items/:itemIdAdd/update the specified cart item. - DELETEcarts/{cartId}/items/{itemId}
/V1/carts/:cartId/items/:itemIdRemoves the specified item from the specified cart.
carts/{cartId}/order
- PUTcarts/{cartId}/order
/V1/carts/:cartId/orderPlaces an order for a specified cart.
carts/{cartId}/payment-methods
- GETcarts/{cartId}/payment-methods
/V1/carts/:cartId/payment-methodsLists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object’s attributes…
carts/{cartId}/selected-payment-method
- GETcarts/{cartId}/selected-payment-method
/V1/carts/:cartId/selected-payment-methodReturns the payment method for a specified shopping cart. - PUTcarts/{cartId}/selected-payment-method
/V1/carts/:cartId/selected-payment-methodAdds a specified payment method to a specified shopping cart.
carts/{cartId}/shipping-information
- POSTcarts/{cartId}/shipping-information
/V1/carts/:cartId/shipping-information
carts/{cartId}/shipping-methods
- GETcarts/{cartId}/shipping-methods
/V1/carts/:cartId/shipping-methodsLists applicable shipping methods for a specified quote.
carts/{cartId}/totals
- GETcarts/{cartId}/totals
/V1/carts/:cartId/totalsReturns quote totals data for a specified cart.
carts/{cartId}/totals-information
- POSTcarts/{cartId}/totals-information
/V1/carts/:cartId/totals-informationCalculate quote totals based on address and shipping method.
carts/{quoteId}/giftCards
- GETcarts/{quoteId}/giftCards
/V1/carts/:quoteId/giftCardsReturn GiftCard Account cards
carts/{quoteId}/items
- POSTcarts/{quoteId}/items
/V1/carts/:quoteId/itemsAdd/update the specified cart item.
carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
- GETcarts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
/V1/carts/guest-carts/:cartId/checkGiftCard/:giftCardCode
carts/guest-carts/{cartId}/giftCards
- POSTcarts/guest-carts/{cartId}/giftCards
/V1/carts/guest-carts/:cartId/giftCards
carts/guest-carts/{cartId}/giftCards/{giftCardCode}
- DELETEcarts/guest-carts/{cartId}/giftCards/{giftCardCode}
/V1/carts/guest-carts/:cartId/giftCards/:giftCardCodeRemove GiftCard Account entity
carts/licence
- GETcarts/licence
/V1/carts/licenceLists active checkout agreements.
carts/mine
- GETcarts/mine
/V1/carts/mineReturns information for the cart for a specified customer. - PUTcarts/mine
/V1/carts/mineSave quote - POSTcarts/mine
/V1/carts/mineCreates an empty cart and quote for a specified customer if customer does not have a cart yet.
carts/mine/balance/apply
- POSTcarts/mine/balance/apply
/V1/carts/mine/balance/applyApply store credit.
carts/mine/balance/unapply
- POSTcarts/mine/balance/unapply
/V1/carts/mine/balance/unapplyUnapply store credit.
carts/mine/billing-address
- GETcarts/mine/billing-address
/V1/carts/mine/billing-addressReturns the billing address for a specified quote. - POSTcarts/mine/billing-address
/V1/carts/mine/billing-addressAssigns a specified billing address to a specified cart.
carts/mine/checkGiftCard/{giftCardCode}
- GETcarts/mine/checkGiftCard/{giftCardCode}
/V1/carts/mine/checkGiftCard/:giftCardCode
carts/mine/checkout-fields
- POSTcarts/mine/checkout-fields
/V1/carts/mine/checkout-fields
carts/mine/collect-totals
- PUTcarts/mine/collect-totals
/V1/carts/mine/collect-totalsSet shipping/billing methods and additional data for cart and collect totals.
carts/mine/collection-point/search-request
- PUTcarts/mine/collection-point/search-request
/V1/carts/mine/collection-point/search-request - DELETEcarts/mine/collection-point/search-request
/V1/carts/mine/collection-point/search-request
carts/mine/collection-point/search-result
- GETcarts/mine/collection-point/search-result
/V1/carts/mine/collection-point/search-result
carts/mine/collection-point/select
- POSTcarts/mine/collection-point/select
/V1/carts/mine/collection-point/select
carts/mine/coupons
- GETcarts/mine/coupons
/V1/carts/mine/couponsReturns information for a coupon in a specified cart. - DELETEcarts/mine/coupons
/V1/carts/mine/couponsDeletes a coupon from a specified cart.
carts/mine/coupons/{couponCode}
- PUTcarts/mine/coupons/{couponCode}
/V1/carts/mine/coupons/:couponCodeAdds a coupon by code to a specified cart.
carts/mine/delivery-option
- POSTcarts/mine/delivery-option
/V1/carts/mine/delivery-optionHandle selected delivery option.
carts/mine/estimate-shipping-methods
- POSTcarts/mine/estimate-shipping-methods
/V1/carts/mine/estimate-shipping-methodsEstimate shipping by address and return list of available shipping methods
carts/mine/estimate-shipping-methods-by-address-id
- POSTcarts/mine/estimate-shipping-methods-by-address-id
/V1/carts/mine/estimate-shipping-methods-by-address-idEstimate shipping
carts/mine/gift-message
- GETcarts/mine/gift-message
/V1/carts/mine/gift-messageReturn the gift message for a specified order. - POSTcarts/mine/gift-message
/V1/carts/mine/gift-messageSet the gift message for an entire order.
carts/mine/gift-message/{itemId}
- GETcarts/mine/gift-message/{itemId}
/V1/carts/mine/gift-message/:itemIdReturn the gift message for a specified item in a specified shopping cart. - POSTcarts/mine/gift-message/{itemId}
/V1/carts/mine/gift-message/:itemIdSet the gift message for a specified item in a specified shopping cart.
carts/mine/giftCards
- POSTcarts/mine/giftCards
/V1/carts/mine/giftCards
carts/mine/giftCards/{giftCardCode}
- DELETEcarts/mine/giftCards/{giftCardCode}
/V1/carts/mine/giftCards/:giftCardCodeRemove GiftCard Account entity
carts/mine/items
- GETcarts/mine/items
/V1/carts/mine/itemsLists items that are assigned to a specified cart. - POSTcarts/mine/items
/V1/carts/mine/itemsAdd/update the specified cart item.
carts/mine/items/{itemId}
- PUTcarts/mine/items/{itemId}
/V1/carts/mine/items/:itemIdAdd/update the specified cart item. - DELETEcarts/mine/items/{itemId}
/V1/carts/mine/items/:itemIdRemoves the specified item from the specified cart.
carts/mine/order
- PUTcarts/mine/order
/V1/carts/mine/orderPlaces an order for a specified cart.
carts/mine/payment-information
- GETcarts/mine/payment-information
/V1/carts/mine/payment-informationGet payment information - POSTcarts/mine/payment-information
/V1/carts/mine/payment-informationSet payment information and place order for a specified cart.
carts/mine/payment-methods
- GETcarts/mine/payment-methods
/V1/carts/mine/payment-methodsLists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object’s attributes…
carts/mine/selected-payment-method
- GETcarts/mine/selected-payment-method
/V1/carts/mine/selected-payment-methodReturns the payment method for a specified shopping cart. - PUTcarts/mine/selected-payment-method
/V1/carts/mine/selected-payment-methodAdds a specified payment method to a specified shopping cart.
carts/mine/set-payment-information
- POSTcarts/mine/set-payment-information
/V1/carts/mine/set-payment-informationSet payment information for a specified cart.
carts/mine/shipping-information
- POSTcarts/mine/shipping-information
/V1/carts/mine/shipping-information
carts/mine/shipping-methods
- GETcarts/mine/shipping-methods
/V1/carts/mine/shipping-methodsLists applicable shipping methods for a specified quote.
carts/mine/totals
- GETcarts/mine/totals
/V1/carts/mine/totalsReturns quote totals data for a specified cart.
carts/mine/totals-information
- POSTcarts/mine/totals-information
/V1/carts/mine/totals-informationCalculate quote totals based on address and shipping method.
carts/search
- GETcarts/search
/V1/carts/search?searchCriteria[filterGroups][0][filters][0][field]=string&searchCriteria[filterGroups][0][filters][0][value]=string&searchCriteria[filterGroups][0][filters][0][conditionType]=string&searchCriteria[sortOrders][0][field]=string&searchCriteria[sortOrders][0][direction]=string&searchCriteria[pageSize]=0&searchCriteria[currentPage]=0Enables administrative users to list carts that match specified search criteria. This call returns an array of objects, but detailed information about each…
categories
- GETcategories
/V1/categories?rootCategoryId=0&depth=0Retrieve list of categories - POSTcategories
/V1/categoriesCreate category service
categories/{categoryId}
- GETcategories/{categoryId}
/V1/categories/:categoryId?storeId=0Get info about category by category id - DELETEcategories/{categoryId}
/V1/categories/:categoryIdDelete category by identifier
categories/{categoryId}/move
- PUTcategories/{categoryId}/move
/V1/categories/:categoryId/moveMove category
categories/{categoryId}/products
- GETcategories/{categoryId}/products
/V1/categories/:categoryId/productsGet products assigned to category - PUTcategories/{categoryId}/products
/V1/categories/:categoryId/productsAssign a product to the required category - POSTcategories/{categoryId}/products
/V1/categories/:categoryId/productsAssign a product to the required category
categories/{categoryId}/products/{sku}
- DELETEcategories/{categoryId}/products/{sku}
/V1/categories/:categoryId/products/:skuRemove the product assignment from the category by category id and sku
categories/{id}
- PUTcategories/{id}
/V1/categories/:idCreate category service
categories/attributes
- GETcategories/attributes
/V1/categories/attributes?searchCriteria[filterGroups][0][filters][0][field]=string&searchCriteria[filterGroups][0][filters][0][value]=string&searchCriteria[filterGroups][0][filters][0][conditionType]=string&searchCriteria[sortOrders][0][field]=string&searchCriteria[sortOrders][0][direction]=string&searchCriteria[pageSize]=0&searchCriteria[currentPage]=0Retrieve all attributes for entity type
categories/attributes/{attributeCode}
- GETcategories/attributes/{attributeCode}
/V1/categories/attributes/:attributeCodeRetrieve specific attribute
categories/attributes/{attributeCode}/options
- GETcategories/attributes/{attributeCode}/options
/V1/categories/attributes/:attributeCode/optionsRetrieve list of attribute options
categories/list
- GETcategories/list
/V1/categories/list?searchCriteria[filterGroups][0][filters][0][field]=string&searchCriteria[filterGroups][0][filters][0][value]=string&searchCriteria[filterGroups][0][filters][0][conditionType]=string&searchCriteria[sortOrders][0][field]=string&searchCriteria[sortOrders][0][direction]=string&searchCriteria[pageSize]=0&searchCriteria[currentPage]=0Get category list
cmsBlock
- POSTcmsBlock
/V1/cmsBlockSave block.
cmsBlock/{blockId}
- GETcmsBlock/{blockId}
/V1/cmsBlock/:blockIdRetrieve block. - DELETEcmsBlock/{blockId}
/V1/cmsBlock/:blockIdDelete block by ID.
cmsBlock/{id}
- PUTcmsBlock/{id}
/V1/cmsBlock/:idSave block.
cmsBlock/search
- GETcmsBlock/search
/V1/cmsBlock/search?searchCriteria[filterGroups][0][filters][0][field]=string&searchCriteria[filterGroups][0][filters][0][value]=string&searchCriteria[filterGroups][0][filters][0][conditionType]=string&searchCriteria[sortOrders][0][field]=string&searchCriteria[sortOrders][0][direction]=string&searchCriteria[pageSize]=0&searchCriteria[currentPage]=0Retrieve blocks matching the specified criteria.
cmsPage
- POSTcmsPage
/V1/cmsPageSave page.
cmsPage/{id}
- PUTcmsPage/{id}
/V1/cmsPage/:idSave page.
cmsPage/{pageId}
- GETcmsPage/{pageId}
/V1/cmsPage/:pageIdRetrieve page. - DELETEcmsPage/{pageId}
/V1/cmsPage/:pageIdDelete page by ID.
cmsPage/search
- GETcmsPage/search
/V1/cmsPage/search?searchCriteria[filterGroups][0][filters][0][field]=string&searchCriteria[filterGroups][0][filters][0][value]=string&searchCriteria[filterGroups][0][filters][0][conditionType]=string&searchCriteria[sortOrders][0][field]=string&searchCriteria[sortOrders][0][direction]=string&searchCriteria[pageSize]=0&searchCriteria[currentPage]=0Retrieve pages matching the specified criteria.
company/
- GETcompany/
/V1/company/?searchCriteria[filterGroups][0][filters][0][field]=string&searchCriteria[filterGroups][0][filters][0][value]=string&searchCriteria[filterGroups][0][filters][0][conditionType]=string&searchCriteria[sortOrders][0][field]=string&searchCriteria[sortOrders][0][direction]=string&searchCriteria[pageSize]=0&searchCriteria[currentPage]=0Returns the list of companies. The list is an array of objects, and detailed information about item attributes might not be included. - POSTcompany/
/V1/company/Create or update a company account.
company/{companyId}
- GETcompany/{companyId}
/V1/company/:companyIdReturns company details. - PUTcompany/{companyId}
/V1/company/:companyIdCreate or update a company account. - DELETEcompany/{companyId}
/V1/company/:companyIdDelete a company. Customers belonging to a company are not deleted with this request.
company/assignRoles
- PUTcompany/assignRoles
/V1/company/assignRolesChange a role for a company user.
company/role/
- GETcompany/role/
/V1/company/role/?searchCriteria[filterGroups][0][filters][0][field]=string&searchCriteria[filterGroups][0][filters][0][value]=string&searchCriteria[filterGroups][0][filters][0][conditionType]=string&searchCriteria[sortOrders][0][field]=string&searchCriteria[sortOrders][0][direction]=string&searchCriteria[pageSize]=0&searchCriteria[currentPage]=0Returns the list of roles and permissions for a specified company. - POSTcompany/role/
/V1/company/role/Create or update a role for a selected company.
company/role/{id}
- PUTcompany/role/{id}
/V1/company/role/:idCreate or update a role for a selected company.
company/role/{roleId}
- GETcompany/role/{roleId}
/V1/company/role/:roleIdReturns the list of permissions for a specified role. - DELETEcompany/role/{roleId}
/V1/company/role/:roleIdDelete a role.
company/role/{roleId}/users
- GETcompany/role/{roleId}/users
/V1/company/role/:roleId/usersView the list of company users assigned to a specified role.
companyCredits/
- GETcompanyCredits/
/V1/companyCredits/?searchCriteria[filterGroups][0][filters][0][field]=string&searchCriteria[filterGroups][0][filters][0][value]=string&searchCriteria[filterGroups][0][filters][0][conditionType]=string&searchCriteria[sortOrders][0][field]=string&searchCriteria[sortOrders][0][direction]=string&searchCriteria[pageSize]=0&searchCriteria[currentPage]=0Returns the list of credits for specified companies.
companyCredits/{creditId}
- GETcompanyCredits/{creditId}
/V1/companyCredits/:creditId?reload=trueReturns data on the credit limit for a specified credit limit ID.
companyCredits/{creditId}/decreaseBalance
- POSTcompanyCredits/{creditId}/decreaseBalance
/V1/companyCredits/:creditId/decreaseBalanceDecreases the company credit with an Update, Reimburse, or Purchase transaction. This transaction increases company's outstanding balance and decreases…
companyCredits/{creditId}/increaseBalance
- POSTcompanyCredits/{creditId}/increaseBalance
/V1/companyCredits/:creditId/increaseBalanceIncreases the company credit with an Allocate, Update, Refund, Revert, or Reimburse transaction. This transaction decreases company's outstanding balance and…
companyCredits/{id}
- PUTcompanyCredits/{id}
/V1/companyCredits/:idUpdate the following company credit attributes: credit currency, credit limit and setting to exceed credit.
companyCredits/company/{companyId}
- GETcompanyCredits/company/{companyId}
/V1/companyCredits/company/:companyIdReturns data on the credit limit for a specified company.
companyCredits/history
- GETcompanyCredits/history
/V1/companyCredits/history?searchCriteria[filterGroups][0][filters][0][field]=string&searchCriteria[filterGroups][0][filters][0][value]=string&searchCriteria[filterGroups][0][filters][0][conditionType]=string&searchCriteria[sortOrders][0][field]=string&searchCriteria[sortOrders][0][direction]=string&searchCriteria[pageSize]=0&searchCriteria[currentPage]=0Returns the credit history for one or more companies.
companyCredits/history/{historyId}
- PUTcompanyCredits/history/{historyId}
/V1/companyCredits/history/:historyIdUpdate the PO Number and/or comment for a Reimburse transaction.
configurable-products/{sku}/child
- POSTconfigurable-products/{sku}/child
/V1/configurable-products/:sku/child
configurable-products/{sku}/children
- GETconfigurable-products/{sku}/children
/V1/configurable-products/:sku/childrenGet all children for Configurable product
configurable-products/{sku}/children/{childSku}
- DELETEconfigurable-products/{sku}/children/{childSku}
/V1/configurable-products/:sku/children/:childSkuRemove configurable product option
configurable-products/{sku}/options
- POSTconfigurable-products/{sku}/options
/V1/configurable-products/:sku/optionsSave option
configurable-products/{sku}/options/{id}
- GETconfigurable-products/{sku}/options/{id}
/V1/configurable-products/:sku/options/:idGet option for configurable product - PUTconfigurable-products/{sku}/options/{id}
/V1/configurable-products/:sku/options/:idSave option - DELETEconfigurable-products/{sku}/options/{id}
/V1/configurable-products/:sku/options/:idRemove option from configurable product
configurable-products/{sku}/options/all
- GETconfigurable-products/{sku}/options/all
/V1/configurable-products/:sku/options/allGet all options for configurable product
configurable-products/variation
- PUTconfigurable-products/variation
/V1/configurable-products/variationGenerate variation based on same product
coupons
- POSTcoupons
/V1/couponsSave a coupon.
coupons/{couponId}
- GETcoupons/{couponId}
/V1/coupons/:couponIdGet coupon by coupon id. - PUTcoupons/{couponId}
/V1/coupons/:couponIdSave a coupon. - DELETEcoupons/{couponId}
/V1/coupons/:couponIdDelete coupon by coupon id.
coupons/deleteByCodes
- POSTcoupons/deleteByCodes
/V1/coupons/deleteByCodesDelete coupon by coupon codes.
coupons/deleteByIds
- POSTcoupons/deleteByIds
/V1/coupons/deleteByIdsDelete coupon by coupon ids.
coupons/generate
- POSTcoupons/generate
/V1/coupons/generateGenerate coupon for a rule
coupons/search
- GETcoupons/search
/V1/coupons/search?searchCriteria[filterGroups][0][filters][0][field]=string&searchCriteria[filterGroups][0][filters][0][value]=string&searchCriteria[filterGroups][0][filters][0][conditionType]=string&searchCriteria[sortOrders][0][field]=string&searchCriteria[sortOrders][0][direction]=string&searchCriteria[pageSize]=0&searchCriteria[currentPage]=0Retrieve a coupon using the specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might…
creditmemo
- POSTcreditmemo
/V1/creditmemoPerforms persist operations for a specified credit memo.
creditmemo/{id}
- GETcreditmemo/{id}
/V1/creditmemo/:idLoads a specified credit memo. - PUTcreditmemo/{id}
/V1/creditmemo/:idCancels a specified credit memo.
creditmemo/{id}/comments
- GETcreditmemo/{id}/comments
/V1/creditmemo/:id/commentsLists comments for a specified credit memo. - POSTcreditmemo/{id}/comments
/V1/creditmemo/:id/commentsPerforms persist operations for a specified entity.
creditmemo/{id}/emails
- POSTcreditmemo/{id}/emails
/V1/creditmemo/:id/emailsEmails a user a specified credit memo.
creditmemo/refund
- POSTcreditmemo/refund
/V1/creditmemo/refundPrepare creditmemo to refund and save it.
creditmemos
- GETcreditmemos
/V1/creditmemos?searchCriteria[filterGroups][0][filters][0][field]=string&searchCriteria[filterGroups][0][filters][0][value]=string&searchCriteria[filterGroups][0][filters][0][conditionType]=string&searchCriteria[sortOrders][0][field]=string&searchCriteria[sortOrders][0][direction]=string&searchCriteria[pageSize]=0&searchCriteria[currentPage]=0Lists credit memos that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might…
customerGroups
- POSTcustomerGroups
/V1/customerGroupsSave customer group.
customerGroups/{id}
- GETcustomerGroups/{id}
/V1/customerGroups/:idGet customer group by group ID. - PUTcustomerGroups/{id}
/V1/customerGroups/:idSave customer group. - DELETEcustomerGroups/{id}
/V1/customerGroups/:idDelete customer group by ID.
customerGroups/{id}/permissions
- GETcustomerGroups/{id}/permissions
/V1/customerGroups/:id/permissionsCheck if customer group can be deleted.
customerGroups/default
- GETcustomerGroups/default
/V1/customerGroups/default?storeId=0Get default customer group.
customerGroups/default/{id}
- PUTcustomerGroups/default/{id}
/V1/customerGroups/default/:idSet system default customer group.
customerGroups/default/{storeId}
- GETcustomerGroups/default/{storeId}
/V1/customerGroups/default/:storeIdGet default customer group.
customerGroups/search
- GETcustomerGroups/search
/V1/customerGroups/search?searchCriteria[filterGroups][0][filters][0][field]=string&searchCriteria[filterGroups][0][filters][0][value]=string&searchCriteria[filterGroups][0][filters][0][conditionType]=string&searchCriteria[sortOrders][0][field]=string&searchCriteria[sortOrders][0][direction]=string&searchCriteria[pageSize]=0&searchCriteria[currentPage]=0Retrieve customer groups. The list of groups can be filtered to exclude the NOT_LOGGED_IN group using the first parameter and/or it can be filtered by tax…
customers
- POSTcustomers
/V1/customersCreate customer account. Perform necessary business operations like sending email.
customers/{customerId}
- GETcustomers/{customerId}
/V1/customers/:customerIdGet customer by Customer ID. - PUTcustomers/{customerId}
/V1/customers/:customerIdCreate or update a customer. - DELETEcustomers/{customerId}
/V1/customers/:customerIdDelete customer by Customer ID.
customers/{customerId}/billingAddress
- GETcustomers/{customerId}/billingAddress
/V1/customers/:customerId/billingAddressRetrieve default billing address for the given customerId.
customers/{customerId}/carts
- POSTcustomers/{customerId}/carts
/V1/customers/:customerId/cartsCreates an empty cart and quote for a specified customer if customer does not have a cart yet.
customers/{customerId}/confirm
- GETcustomers/{customerId}/confirm
/V1/customers/:customerId/confirmGets the account confirmation status.
customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
- GETcustomers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
/V1/customers/:customerId/password/resetLinkToken/:resetPasswordLinkTokenCheck if password reset token is valid.
customers/{customerId}/permissions/readonly
- GETcustomers/{customerId}/permissions/readonly
/V1/customers/:customerId/permissions/readonlyCheck if customer can be deleted.
customers/{customerId}/shippingAddress
- GETcustomers/{customerId}/shippingAddress
/V1/customers/:customerId/shippingAddressRetrieve default shipping address for the given customerId.
customers/{email}/activate
- PUTcustomers/{email}/activate
/V1/customers/:email/activateActivate a customer account using a key that was sent in a confirmation email.
customers/addresses/{addressId}
- GETcustomers/addresses/{addressId}
/V1/customers/addresses/:addressIdRetrieve customer address.
customers/confirm
- POSTcustomers/confirm
/V1/customers/confirmResend confirmation email.
customers/isEmailAvailable
- POSTcustomers/isEmailAvailable
/V1/customers/isEmailAvailableCheck if given email is associated with a customer account in given website.
customers/me
- GETcustomers/me
/V1/customers/meGet customer by Customer ID. - PUTcustomers/me
/V1/customers/meCreate or update a customer.
customers/me/activate
- PUTcustomers/me/activate
/V1/customers/me/activateActivate a customer account using a key that was sent in a confirmation email.
customers/me/billingAddress
- GETcustomers/me/billingAddress
/V1/customers/me/billingAddressRetrieve default billing address for the given customerId.
customers/me/password
- PUTcustomers/me/password
/V1/customers/me/passwordChange customer password.
customers/me/shippingAddress
- GETcustomers/me/shippingAddress
/V1/customers/me/shippingAddressRetrieve default shipping address for the given customerId.
customers/password
- PUTcustomers/password
/V1/customers/passwordSend an email to the customer with a password reset link.
customers/resetPassword
- POSTcustomers/resetPassword
/V1/customers/resetPasswordReset customer password.
customers/search
- GETcustomers/search
/V1/customers/search?searchCriteria[filterGroups][0][filters][0][field]=string&searchCriteria[filterGroups][0][filters][0][value]=string&searchCriteria[filterGroups][0][filters][0][conditionType]=string&searchCriteria[sortOrders][0][field]=string&searchCriteria[sortOrders][0][direction]=string&searchCriteria[pageSize]=0&searchCriteria[currentPage]=0Retrieve customers which match a specified criteria. This call returns an array of objects, but detailed information about each object’s attributes might not…
customers/validate
- PUTcustomers/validate
/V1/customers/validateValidate customer data.
directory/countries
- GETdirectory/countries
/V1/directory/countriesGet all countries and regions information for the store.
directory/countries/{countryId}
- GETdirectory/countries/{countryId}
/V1/directory/countries/:countryIdGet country and region information for the store.
directory/currency
- GETdirectory/currency
/V1/directory/currencyGet currency information for the store.
eav/attribute-sets
- POSTeav/attribute-sets
/V1/eav/attribute-setsCreate attribute set from data
eav/attribute-sets/{attributeSetId}
- GETeav/attribute-sets/{attributeSetId}
/V1/eav/attribute-sets/:attributeSetIdRetrieve attribute set information based on given ID - PUTeav/attribute-sets/{attributeSetId}
/V1/eav/attribute-sets/:attributeSetIdSave attribute set data - DELETEeav/attribute-sets/{attributeSetId}
/V1/eav/attribute-sets/:attributeSetIdRemove attribute set by given ID
eav/attribute-sets/list
- GETeav/attribute-sets/list
/V1/eav/attribute-sets/list?searchCriteria[filterGroups][0][filters][0][field]=string&searchCriteria[filterGroups][0][filters][0][value]=string&searchCriteria[filterGroups][0][filters][0][conditionType]=string&searchCriteria[sortOrders][0][field]=string&searchCriteria[sortOrders][0][direction]=string&searchCriteria[pageSize]=0&searchCriteria[currentPage]=0Retrieve list of Attribute Sets This call returns an array of objects, but detailed information about each object’s attributes might not be included. See…
gift-wrappings
- GETgift-wrappings
/V1/gift-wrappings?searchCriteria[filterGroups][0][filters][0][field]=string&searchCriteria[filterGroups][0][filters][0][value]=string&searchCriteria[filterGroups][0][filters][0][conditionType]=string&searchCriteria[sortOrders][0][field]=string&searchCriteria[sortOrders][0][direction]=string&searchCriteria[pageSize]=0&searchCriteria[currentPage]=0Return list of gift wrapping data objects based on search criteria - POSTgift-wrappings
/V1/gift-wrappingsCreate/Update new gift wrapping with data object values
gift-wrappings/{id}
- GETgift-wrappings/{id}
/V1/gift-wrappings/:id?storeId=0Return data object for specified wrapping ID and store. - DELETEgift-wrappings/{id}
/V1/gift-wrappings/:idDelete gift wrapping
gift-wrappings/{wrappingId}
- PUTgift-wrappings/{wrappingId}
/V1/gift-wrappings/:wrappingIdCreate/Update new gift wrapping with data object values
giftregistry/mine/estimate-shipping-methods
- POSTgiftregistry/mine/estimate-shipping-methods
/V1/giftregistry/mine/estimate-shipping-methodsEstimate shipping
guest-carts
- POSTguest-carts
/V1/guest-cartsEnable an customer or guest user to create an empty cart and quote for an anonymous customer.
guest-carts/{cartId}
- GETguest-carts/{cartId}
/V1/guest-carts/:cartIdEnable a guest user to return information for a specified cart. - PUTguest-carts/{cartId}
/V1/guest-carts/:cartIdAssign a specified customer to a specified shopping cart.
guest-carts/{cartId}/billing-address
- GETguest-carts/{cartId}/billing-address
/V1/guest-carts/:cartId/billing-addressReturn the billing address for a specified quote. - POSTguest-carts/{cartId}/billing-address
/V1/guest-carts/:cartId/billing-addressAssign a specified billing address to a specified cart.
guest-carts/{cartId}/checkout-fields
- POSTguest-carts/{cartId}/checkout-fields
/V1/guest-carts/:cartId/checkout-fields
guest-carts/{cartId}/collect-totals
- PUTguest-carts/{cartId}/collect-totals
/V1/guest-carts/:cartId/collect-totalsSet shipping/billing methods and additional data for cart and collect totals for guest.
guest-carts/{cartId}/collection-point/search-request
- PUTguest-carts/{cartId}/collection-point/search-request
/V1/guest-carts/:cartId/collection-point/search-request - DELETEguest-carts/{cartId}/collection-point/search-request
/V1/guest-carts/:cartId/collection-point/search-request
guest-carts/{cartId}/collection-point/search-result
- GETguest-carts/{cartId}/collection-point/search-result
/V1/guest-carts/:cartId/collection-point/search-result
guest-carts/{cartId}/collection-point/select
- POSTguest-carts/{cartId}/collection-point/select
/V1/guest-carts/:cartId/collection-point/select
guest-carts/{cartId}/coupons
- GETguest-carts/{cartId}/coupons
/V1/guest-carts/:cartId/couponsReturn information for a coupon in a specified cart. - DELETEguest-carts/{cartId}/coupons
/V1/guest-carts/:cartId/couponsDelete a coupon from a specified cart.
guest-carts/{cartId}/coupons/{couponCode}
- PUTguest-carts/{cartId}/coupons/{couponCode}
/V1/guest-carts/:cartId/coupons/:couponCodeAdd a coupon by code to a specified cart.
guest-carts/{cartId}/delivery-option
- POSTguest-carts/{cartId}/delivery-option
/V1/guest-carts/:cartId/delivery-optionHandle selected delivery option.
guest-carts/{cartId}/estimate-shipping-methods
- POSTguest-carts/{cartId}/estimate-shipping-methods
/V1/guest-carts/:cartId/estimate-shipping-methodsEstimate shipping by address and return list of available shipping methods
guest-carts/{cartId}/gift-message
- GETguest-carts/{cartId}/gift-message
/V1/guest-carts/:cartId/gift-messageReturn the gift message for a specified order. - POSTguest-carts/{cartId}/gift-message
/V1/guest-carts/:cartId/gift-messageSet the gift message for an entire order.
guest-carts/{cartId}/gift-message/{itemId}
- GETguest-carts/{cartId}/gift-message/{itemId}
/V1/guest-carts/:cartId/gift-message/:itemIdReturn the gift message for a specified item in a specified shopping cart. - POSTguest-carts/{cartId}/gift-message/{itemId}
/V1/guest-carts/:cartId/gift-message/:itemIdSet the gift message for a specified item in a specified shopping cart.
guest-carts/{cartId}/items
- GETguest-carts/{cartId}/items
/V1/guest-carts/:cartId/itemsList items that are assigned to a specified cart. - POSTguest-carts/{cartId}/items
/V1/guest-carts/:cartId/itemsAdd/update the specified cart item.
guest-carts/{cartId}/items/{itemId}
- PUTguest-carts/{cartId}/items/{itemId}
/V1/guest-carts/:cartId/items/:itemIdAdd/update the specified cart item. - DELETEguest-carts/{cartId}/items/{itemId}
/V1/guest-carts/:cartId/items/:itemIdRemove the specified item from the specified cart.
guest-carts/{cartId}/order
- PUTguest-carts/{cartId}/order
/V1/guest-carts/:cartId/orderPlace an order for a specified cart.
guest-carts/{cartId}/payment-information
- GETguest-carts/{cartId}/payment-information
/V1/guest-carts/:cartId/payment-informationGet payment information - POSTguest-carts/{cartId}/payment-information
/V1/guest-carts/:cartId/payment-informationSet payment information and place order for a specified cart.
guest-carts/{cartId}/payment-methods
- GETguest-carts/{cartId}/payment-methods
/V1/guest-carts/:cartId/payment-methodsList available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object’s attributes…
guest-carts/{cartId}/selected-payment-method
- GETguest-carts/{cartId}/selected-payment-method
/V1/guest-carts/:cartId/selected-payment-methodReturn the payment method for a specified shopping cart. - PUTguest-carts/{cartId}/selected-payment-method
/V1/guest-carts/:cartId/selected-payment-methodAdd a specified payment method to a specified shopping cart.
guest-carts/{cartId}/set-payment-information
- POSTguest-carts/{cartId}/set-payment-information
/V1/guest-carts/:cartId/set-payment-informationSet payment information for a specified cart.
guest-carts/{cartId}/shipping-information
- POSTguest-carts/{cartId}/shipping-information
/V1/guest-carts/:cartId/shipping-information
guest-carts/{cartId}/shipping-methods
- GETguest-carts/{cartId}/shipping-methods
/V1/guest-carts/:cartId/shipping-methodsList applicable shipping methods for a specified quote.
guest-carts/{cartId}/totals
- GETguest-carts/{cartId}/totals
/V1/guest-carts/:cartId/totalsReturn quote totals data for a specified cart.
guest-carts/{cartId}/totals-information
- POSTguest-carts/{cartId}/totals-information
/V1/guest-carts/:cartId/totals-informationCalculate quote totals based on address and shipping method.
guest-giftregistry/{cartId}/estimate-shipping-methods
- POSTguest-giftregistry/{cartId}/estimate-shipping-methods
/V1/guest-giftregistry/:cartId/estimate-shipping-methodsEstimate shipping
hierarchy/{id}
- GEThierarchy/{id}
/V1/hierarchy/:idReturns the list of teams and company users in the company structure.
hierarchy/move/{id}
- PUThierarchy/move/{id}
/V1/hierarchy/move/:idMoves teams and users within the company structure.
integration/admin/token
- POSTintegration/admin/token
/V1/integration/admin/tokenCreate access token for admin given the admin credentials.
integration/customer/token
- POSTintegration/customer/token
/V1/integration/customer/tokenCreate access token for admin given the customer credentials.
invoice/{invoiceId}/refund
- POSTinvoice/{invoiceId}/refund
/V1/invoice/:invoiceId/refundCreate refund for invoice
invoices
- GETinvoices
/V1/invoices?searchCriteria[filterGroups][0][filters][0][field]=string&searchCriteria[filterGroups][0][filters][0][value]=string&searchCriteria[filterGroups][0][filters][0][conditionType]=string&searchCriteria[sortOrders][0][field]=string&searchCriteria[sortOrders][0][direction]=string&searchCriteria[pageSize]=0&searchCriteria[currentPage]=0Lists invoices that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not…
invoices/
- POSTinvoices/
/V1/invoices/Performs persist operations for a specified invoice.
invoices/{id}
- GETinvoices/{id}
/V1/invoices/:idLoads a specified invoice.
invoices/{id}/capture
- POSTinvoices/{id}/capture
/V1/invoices/:id/captureSets invoice capture.
invoices/{id}/comments
- GETinvoices/{id}/comments
/V1/invoices/:id/commentsLists comments for a specified invoice.
invoices/{id}/emails
- POSTinvoices/{id}/emails
/V1/invoices/:id/emailsEmails a user a specified invoice.
invoices/{id}/void
- POSTinvoices/{id}/void
/V1/invoices/:id/voidVoids a specified invoice.
invoices/comments
- POSTinvoices/comments
/V1/invoices/commentsPerforms persist operations for a specified invoice comment.
modules
- GETmodules
/V1/modulesReturns an array of enabled modules
negotiable-carts/{cartId}/billing-address
- GETnegotiable-carts/{cartId}/billing-address
/V1/negotiable-carts/:cartId/billing-addressReturns the billing address for a specified quote. - POSTnegotiable-carts/{cartId}/billing-address
/V1/negotiable-carts/:cartId/billing-addressAssigns a specified billing address to a specified cart.
negotiable-carts/{cartId}/coupons
- DELETEnegotiable-carts/{cartId}/coupons
/V1/negotiable-carts/:cartId/couponsDeletes a coupon from a specified cart.
negotiable-carts/{cartId}/coupons/{couponCode}
- PUTnegotiable-carts/{cartId}/coupons/{couponCode}
/V1/negotiable-carts/:cartId/coupons/:couponCodeAdds a coupon by code to a specified cart.
negotiable-carts/{cartId}/estimate-shipping-methods
- POSTnegotiable-carts/{cartId}/estimate-shipping-methods
/V1/negotiable-carts/:cartId/estimate-shipping-methodsEstimate shipping by address and return list of available shipping methods
negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id
- POSTnegotiable-carts/{cartId}/estimate-shipping-methods-by-address-id
/V1/negotiable-carts/:cartId/estimate-shipping-methods-by-address-idEstimate shipping
negotiable-carts/{cartId}/giftCards
- POSTnegotiable-carts/{cartId}/giftCards
/V1/negotiable-carts/:cartId/giftCards
negotiable-carts/{cartId}/giftCards/{giftCardCode}
- DELETEnegotiable-carts/{cartId}/giftCards/{giftCardCode}
/V1/negotiable-carts/:cartId/giftCards/:giftCardCodeRemove GiftCard Account entity
negotiable-carts/{cartId}/payment-information
- GETnegotiable-carts/{cartId}/payment-information
/V1/negotiable-carts/:cartId/payment-informationGet payment information - POSTnegotiable-carts/{cartId}/payment-information
/V1/negotiable-carts/:cartId/payment-informationSet payment information and place order for a specified cart.
negotiable-carts/{cartId}/set-payment-information
- POSTnegotiable-carts/{cartId}/set-payment-information
/V1/negotiable-carts/:cartId/set-payment-informationSet payment information for a specified cart.
negotiable-carts/{cartId}/shipping-information
- POSTnegotiable-carts/{cartId}/shipping-information
/V1/negotiable-carts/:cartId/shipping-information
negotiable-carts/{cartId}/totals
- GETnegotiable-carts/{cartId}/totals
/V1/negotiable-carts/:cartId/totalsReturns quote totals data for a specified cart.
negotiableQuote/{quoteId}
- PUTnegotiableQuote/{quoteId}
/V1/negotiableQuote/:quoteIdSave quote
negotiableQuote/{quoteId}/comments
- GETnegotiableQuote/{quoteId}/comments
/V1/negotiableQuote/:quoteId/commentsReturns comments for a specified negotiable quote.
negotiableQuote/{quoteId}/shippingMethod
- PUTnegotiableQuote/{quoteId}/shippingMethod
/V1/negotiableQuote/:quoteId/shippingMethodUpdates the shipping method on a negotiable quote.
negotiableQuote/attachmentContent
- GETnegotiableQuote/attachmentContent
/V1/negotiableQuote/attachmentContent?attachmentIds=0Returns content for one or more files attached on the quote comment.
negotiableQuote/decline
- POSTnegotiableQuote/decline
/V1/negotiableQuote/declineDecline the B2B quote. All custom pricing will be removed from this quote. The buyer will be able to place an order using their standard catalog prices and…
negotiableQuote/pricesUpdated
- POSTnegotiableQuote/pricesUpdated
/V1/negotiableQuote/pricesUpdatedRefreshes item prices, taxes, discounts, cart rules in the negotiable quote as per the latest changes in the catalog / shared catalog and in the price rules.…
negotiableQuote/request
- POSTnegotiableQuote/request
/V1/negotiableQuote/requestCreate a B2B quote based on a regular Magento quote. If the B2B quote requires a shipping address (for negotiation or tax calculations), add it to the regular…
negotiableQuote/submitToCustomer
- POSTnegotiableQuote/submitToCustomer
/V1/negotiableQuote/submitToCustomerSubmit the B2B quote to the customer. The quote status for the customer will be changed to 'Updated', and the customer can work with the quote.
order/{orderId}/invoice
- POSTorder/{orderId}/invoice
/V1/order/:orderId/invoice
order/{orderId}/refund
- POSTorder/{orderId}/refund
/V1/order/:orderId/refundCreate offline refund for order
order/{orderId}/ship
- POSTorder/{orderId}/ship
/V1/order/:orderId/shipCreates new Shipment for given Order.
orders
- GETorders
/V1/orders?searchCriteria[filterGroups][0][filters][0][field]=string&searchCriteria[filterGroups][0][filters][0][value]=string&searchCriteria[filterGroups][0][filters][0][conditionType]=string&searchCriteria[sortOrders][0][field]=string&searchCriteria[sortOrders][0][direction]=string&searchCriteria[pageSize]=0&searchCriteria[currentPage]=0Lists orders that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be…
orders/
- POSTorders/
/V1/orders/Performs persist operations for a specified order.
orders/{id}
- GETorders/{id}
/V1/orders/:idLoads a specified order.
orders/{id}/cancel
- POSTorders/{id}/cancel
/V1/orders/:id/cancelCancels a specified order.
orders/{id}/comments
- GETorders/{id}/comments
/V1/orders/:id/commentsLists comments for a specified order. - POSTorders/{id}/comments
/V1/orders/:id/commentsAdds a comment to a specified order.
orders/{id}/emails
- POSTorders/{id}/emails
/V1/orders/:id/emailsEmails a user a specified order.
orders/{id}/hold
- POSTorders/{id}/hold
/V1/orders/:id/holdHolds a specified order.
orders/{id}/statuses
- GETorders/{id}/statuses
/V1/orders/:id/statusesGets the status for a specified order.
Showing 300 of 400 endpoints. Fork the collection to see all of them.
API details
- Base URL
https://example.com/rest/default- Authentication
- None declared in the description
- Operations
- 455 operations on 363 pathsGET 184POST 144PUT 75DELETE 52
- Main resources
- carts/mine 3categories/{categoryId}/products 3company/{companyId} 3configurable-products/{sku}/options/{id} 3coupons/{couponId} 3customerGroups/{id} 3customers/{customerId} 3eav/attribute-sets/{attributeSetId} 3products/attribute-sets/{attributeSetId} 3products/attributes/{attributeCode} 3
- Response formats
application/jsonapplication/xml- Description format
- OpenAPI 3.0.0, API version
2.2.10 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Magento B2B in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Magento B2B collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “addresses/{addressId}” (DELETE /V1/addresses/:addressId), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Magento B2B?
Magento Commerce is the leading provider of open omnichannel innovation. It is listed under E-commerce and has 455 endpoints.
Who publishes the Magento B2B?
It is listed from Magento's public API description (an OpenAPI document), not published by Magento on Swastik Codes. Anyone who controls magento.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Magento B2B?
Requests go to https://example.com/rest/default. Endpoint paths are added to this base URL.
How do I authenticate with the Magento B2B?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Magento B2B have?
455 operations on 363 paths (184 GET, 144 POST, 75 PUT, 52 DELETE). The largest groups are carts/mine, categories/{categoryId}/products, company/{companyId}, configurable-products/{sku}/options/{id}. This listing's collection holds the first 400.
Is forking the Magento B2B free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.