ESC
Example searches: “errors”, “items”, “fieldValue”, “code”, “website_id”
Search…
Ctrl+K
⌘K
API changelog
Download source
JSON OpenAPI specification
YAML OpenAPI specification
Toggle dark mode
Magento2
Topics
Introduction
Endpoints
storeStoreRepositoryV1
Retrieve list of all stores
GET
storeGroupRepositoryV1
Retrieve list of all groups
GET
storeWebsiteRepositoryV1
Retrieve list of all websites
GET
storeStoreConfigManagerV1
Get v1 store store configs
GET
directoryCurrencyInformationAcquirerV1
Get currency information for the store
GET
directoryCountryInformationAcquirerV1
Get all countries and regions information for the store
GET
Get country and region information for the store
GET
adobeIoEventsClientConfigurationCheckV1
Checks configuration and returns success/failure results for each component
GET
adobeCommerceEventsClientEventSubscriberV1
Subscribes to the event
POST
adobeCommerceEventsClientUpdateConfigurationV1
Updates eventing configuration
PUT
adobeStockImageApiGetImageListV1
Search for images based on search criteria
GET
eavAttributeSetRepositoryV1
Retrieve list of Attribute Sets This call returns an array of objects
GET
Retrieve attribute set information based on given ID
GET
Save attribute set data
PUT
Remove attribute set by given ID
DELETE
eavAttributeSetManagementV1
Create attribute set from data
POST
customerGroupRepositoryV1
Get customer group by group ID
GET
Save customer group
PUT
Delete customer group by ID
DELETE
Retrieve customer groups
GET
Save customer group
POST
customerGroupManagementV1
Get default customer group
GET
Get default customer group
GET
Check if customer group can be deleted
GET
customerCustomerGroupConfigV1
Set system default customer group
PUT
customerCustomerMetadataV1
Retrieve attribute metadata
GET
Retrieve all attributes filtered by form code
GET
Get all attribute metadata
GET
Get custom attributes metadata for the given data interface
GET
customerAddressMetadataV1
Retrieve attribute metadata
GET
Retrieve all attributes filtered by form code
GET
Get all attribute metadata
GET
Get custom attributes metadata for the given data interface
GET
customerCustomerRepositoryV1
Get customer by Customer ID
GET
Create
PUT
Delete customer by Customer ID
DELETE
Get customer by Customer ID
GET
Create
PUT
Retrieve customers which match a specified criteria
GET
customerAccountManagementV1
Create customer account
POST
Activate a customer account using a key that was sent in a confirmation email
PUT
Activate a customer account using a key that was sent in a confirmation email
PUT
Change customer password
PUT
Check if password reset token is valid
GET
Reset customer password
POST
Gets the account confirmation status
GET
Resend confirmation email
POST
Validate customer data
PUT
Check if customer can be deleted
GET
Check if given email is associated with a customer account in given website
POST
Retrieve default billing address for the given customerId
GET
Retrieve default billing address for the given customerId
GET
Retrieve default shipping address for the given customerId
GET
Retrieve default shipping address for the given customerId
GET
winkelstraatCustomerAccountManagementV1
Send an email to the customer with a password reset link
PUT
customerAddressRepositoryV1
Retrieve customer address
GET
Delete customer address by ID
DELETE
backendModuleServiceV1
Returns an array of enabled modules
GET
cmsPageRepositoryV1
Retrieve page
GET
Delete page by ID
DELETE
Retrieve pages matching the specified criteria
GET
Save page
POST
Save page
PUT
cmsBlockRepositoryV1
Retrieve block
GET
Delete block by ID
DELETE
Retrieve blocks matching the specified criteria
GET
Save block
POST
Save block
PUT
catalogProductRepositoryV1
Get product list
GET
Create product
POST
Get info about product by product SKU
GET
Create product
PUT
Delete v1 products sku
DELETE
catalogProductAttributeTypesListV1
Retrieve list of product attribute types
GET
catalogProductAttributeRepositoryV1
Retrieve specific attribute
GET
Save attribute data
PUT
Delete Attribute by id
DELETE
Retrieve all attributes for entity type
GET
Save attribute data
POST
catalogProductAttributeIsFilterableManagementV1
Retrieve 'is_filterable' property for specific attribute as integer
GET
Set 'is_filterable' property for specific attribute as integer
PUT
catalogCategoryAttributeRepositoryV1
Retrieve specific attribute
GET
Retrieve all attributes for entity type
GET
catalogCategoryAttributeOptionManagementV1
Retrieve list of attribute options
GET
catalogProductTypeListV1
Retrieve available product types
GET
catalogAttributeSetRepositoryV1
Retrieve list of Attribute Sets
GET
Retrieve attribute set information based on given ID
GET
Save attribute set data
PUT
Remove attribute set by given ID
DELETE
catalogAttributeSetManagementV1
Create attribute set from data
POST
catalogProductAttributeManagementV1
Retrieve related attributes based on given attribute set ID
GET
Assign attribute to attribute set
POST
Remove attribute from attribute set
DELETE
catalogProductAttributeGroupRepositoryV1
Retrieve list of attribute groups
GET
Save attribute group
POST
Save attribute group
PUT
Remove attribute group by id
DELETE
catalogProductAttributeOptionManagementV1
Retrieve list of attribute options
GET
Add option to attribute
POST
Delete option from attribute
DELETE
catalogProductAttributeOptionUpdateV1
Update attribute option
PUT
catalogProductMediaAttributeManagementV1
Retrieve the list of media attributes
GET
catalogProductAttributeMediaGalleryManagementV1
Return information about gallery entry
GET
Update gallery entry
PUT
Remove gallery entry
DELETE
Retrieve the list of gallery entries associated with given product
GET
Create new gallery entry
POST
catalogProductTierPriceManagementV1
Get tier price of product
GET
Create tier price for product
POST
Remove tier price from product
DELETE
catalogTierPriceStorageV1
Return product prices
POST
Remove existing tier prices and replace them with the new ones
PUT
Add
POST
Delete product tier prices
POST
catalogBasePriceStorageV1
Return product prices
POST
Add
POST
catalogCostStorageV1
Return product prices
POST
Add
POST
Delete product cost
POST
catalogSpecialPriceStorageV1
Return product's special price
POST
Add
POST
Delete product's special price
POST
catalogCategoryRepositoryV1
Get info about category by category id
GET
Delete category by identifier
DELETE
Create category service
POST
Create category service
PUT
catalogCategoryManagementV1
Retrieve list of categories
GET
Move category
PUT
catalogCategoryListV1
Get category list
GET
catalogProductCustomOptionTypeListV1
Get custom option types
GET
catalogProductCustomOptionRepositoryV1
Get the list of custom options for a specific product
GET
Get custom option for a specific product
GET
Delete v1 products sku options option
DELETE
Save Custom Option
POST
Save Custom Option
PUT
catalogProductLinkTypeListV1
Retrieve information about available product link types
GET
Provide a list of the product link type attributes
GET
catalogProductLinkManagementV1
Provide the list of links for a specific product
GET
Assign a product link to another product
POST
catalogProductLinkRepositoryV1
Save product link
PUT
Delete v1 products sku links type linked product sku
DELETE
catalogCategoryLinkManagementV1
Get products assigned to category
GET
catalogCategoryLinkRepositoryV1
Assign a product to the required category
PUT
Assign a product to the required category
POST
Remove the product assignment from the category by category id and sku
DELETE
catalogProductWebsiteLinkRepositoryV1
Assign a product to the website
PUT
Assign a product to the website
POST
Remove the website assignment from the product by product sku
DELETE
catalogProductRenderListV1
Collect and retrieve the list of product render info
GET
quoteCartRepositoryV1
Enables an administrative user to return information for a specified cart
GET
Enables administrative users to list carts that match specified search criteria
GET
Save quote
PUT
quoteCartManagementV1
Assigns a specified customer to a specified shopping cart
PUT
Returns information for the cart for a specified customer
GET
Creates an empty cart and quote for a specified customer if customer does not have a cart yet
POST
Creates an empty cart and quote for a guest
POST
Creates an empty cart and quote for a specified customer if customer does not have a cart yet
POST
Places an order for a specified cart
PUT
Places an order for a specified cart
PUT
quoteGuestCartRepositoryV1
Enable a guest user to return information for a specified cart
GET
quoteGuestCartManagementV1
Assign a specified customer to a specified shopping cart
PUT
Enable an customer
POST
Place an order for a specified cart
PUT
quoteShippingMethodManagementV1
Lists applicable shipping methods for a specified quote
GET
Estimate shipping
POST
Lists applicable shipping methods for a specified quote
GET
Estimate shipping
POST
Estimate shipping
POST
quoteShipmentEstimationV1
Estimate shipping by address and return list of available shipping methods
POST
Estimate shipping by address and return list of available shipping methods
POST
Estimate shipping by address and return list of available shipping methods
POST
quoteGuestShippingMethodManagementV1
List applicable shipping methods for a specified quote
GET
quoteGuestShipmentEstimationV1
Estimate shipping by address and return list of available shipping methods
POST
quoteCartItemRepositoryV1
Lists items that are assigned to a specified cart
GET
Add/update the specified cart item
POST
Add/update the specified cart item
PUT
Removes the specified item from the specified cart
DELETE
Lists items that are assigned to a specified cart
GET
Add/update the specified cart item
POST
Add/update the specified cart item
PUT
Removes the specified item from the specified cart
DELETE
quoteGuestCartItemRepositoryV1
List items that are assigned to a specified cart
GET
Add/update the specified cart item
POST
Add/update the specified cart item
PUT
Remove the specified item from the specified cart
DELETE
quotePaymentMethodManagementV1
Returns the payment method for a specified shopping cart
GET
Adds a specified payment method to a specified shopping cart
PUT
Lists available payment methods for a specified shopping cart
GET
Returns the payment method for a specified shopping cart
GET
Adds a specified payment method to a specified shopping cart
PUT
Lists available payment methods for a specified shopping cart
GET
quoteGuestPaymentMethodManagementV1
Return the payment method for a specified shopping cart
GET
Add a specified payment method to a specified shopping cart
PUT
List available payment methods for a specified shopping cart
GET
quoteBillingAddressManagementV1
Returns the billing address for a specified quote
GET
Assigns a specified billing address to a specified cart
POST
Returns the billing address for a specified quote
GET
Assigns a specified billing address to a specified cart
POST
Assigns a specified billing address to a specified cart
POST
quoteGuestBillingAddressManagementV1
Return the billing address for a specified quote
GET
Assign a specified billing address to a specified cart
POST
quoteCouponManagementV1
Returns information for a coupon in a specified cart
GET
Deletes a coupon from a specified cart
DELETE
Adds a coupon by code to a specified cart
PUT
Returns information for a coupon in a specified cart
GET
Deletes a coupon from a specified cart
DELETE
Adds a coupon by code to a specified cart
PUT
quoteGuestCouponManagementV1
Return information for a coupon in a specified cart
GET
Delete a coupon from a specified cart
DELETE
Add a coupon by code to a specified cart
PUT
quoteCartTotalRepositoryV1
Returns quote totals data for a specified cart
GET
Returns quote totals data for a specified cart
GET
Returns quote totals data for a specified cart
GET
quoteGuestCartTotalManagementV1
Set shipping/billing methods and additional data for cart and collect totals for guest
PUT
quoteGuestCartTotalRepositoryV1
Return quote totals data for a specified cart
GET
quoteCartTotalManagementV1
Set shipping/billing methods and additional data for cart and collect totals
PUT
salesOrderRepositoryV1
Loads a specified order
GET
Lists orders that match specified search criteria
GET
Performs persist operations for a specified order
POST
Performs persist operations for a specified order
PUT
Lists orders that match specified search criteria
POST
salesOrderManagementV1
Gets the status for a specified order
GET
Cancels a specified order
POST
Emails a user a specified order
POST
Holds a specified order
POST
Releases a specified order from hold status
POST
Lists comments for a specified order
GET
Adds a comment to a specified order
POST
salesOrderAddressRepositoryV1
Performs persist operations for a specified order address
PUT
salesOrderItemRepositoryV1
Loads a specified order item
GET
Lists order items that match specified search criteria
GET
salesInvoiceRepositoryV1
Loads a specified invoice
GET
Lists invoices that match specified search criteria
GET
Performs persist operations for a specified invoice
POST
salesInvoiceManagementV1
Lists comments for a specified invoice
GET
Emails a user a specified invoice
POST
Voids a specified invoice
POST
Sets invoice capture
POST
salesInvoiceCommentRepositoryV1
Performs persist operations for a specified invoice comment
POST
salesRefundInvoiceV1
Create refund for invoice
POST
salesCreditmemoManagementV1
Lists comments for a specified credit memo
GET
Cancels a specified credit memo
PUT
Emails a user a specified credit memo
POST
Prepare creditmemo to refund and save it
POST
salesCreditmemoRepositoryV1
Loads a specified credit memo
GET
Lists credit memos that match specified search criteria
GET
Performs persist operations for a specified credit memo
POST
salesCreditmemoCommentRepositoryV1
Performs persist operations for a specified entity
POST
salesRefundOrderV1
Create offline refund for order
POST
salesShipmentRepositoryV1
Loads a specified shipment
GET
Lists shipments that match specified search criteria
GET
Performs persist operations for a specified shipment
POST
salesShipmentManagementV1
Lists comments for a specified shipment
GET
Emails user a specified shipment
POST
Gets a specified shipment label
GET
salesShipmentCommentRepositoryV1
Performs persist operations for a specified shipment comment
POST
salesShipmentTrackRepositoryV1
Performs persist operations for a specified shipment track
POST
Deletes a specified shipment track by ID
DELETE
salesShipOrderV1
Creates new Shipment for given Order
POST
salesTransactionRepositoryV1
Loads a specified transaction
GET
Lists transactions that match specified search criteria
GET
salesInvoiceOrderV1
Post v1 order order id invoice
POST
salesRuleRuleRepositoryV1
Get rule by ID
GET
Save sales rule
PUT
Delete rule by ID
DELETE
Retrieve sales rules that match te specified criteria
GET
Save sales rule
POST
salesRuleCouponRepositoryV1
Get coupon by coupon id
GET
Save a coupon
PUT
Delete coupon by coupon id
DELETE
Retrieve a coupon using the specified search criteria
GET
Save a coupon
POST
salesRuleCouponManagementV1
Generate coupon for a rule
POST
Delete coupon by coupon ids
POST
Delete coupon by coupon codes
POST
bundleProductLinkManagementV1
Add child product to specified Bundle option by product sku
POST
Put v1 bundleproducts sku links
PUT
Get all children for Bundle product
GET
Remove product from Bundle product option
DELETE
bundleProductOptionRepositoryV1
Get all options for bundle product
GET
Get option for bundle product
GET
Remove bundle option
DELETE
bundleProductOptionTypeListV1
Get all types for options for bundle products
GET
bundleProductOptionManagementV1
Add new option for bundle product
POST
Add new option for bundle product
PUT
catalogInventoryStockRegistryV1
Get v1 stock items product sku
GET
Put v1 products product sku stock items item
PUT
Retrieves a list of SKU's with low inventory qty
GET
Get v1 stock statuses product sku
GET
requisitionListRequisitionListRepositoryV1
Save Requisition List
POST
searchV1
Make Full Text Search and return found Documents
GET
checkoutGuestShippingInformationManagementV1
Post v1 guestcarts cart id shippinginformation
POST
checkoutShippingInformationManagementV1
Post v1 carts mine shippinginformation
POST
Post v1 carts cart id shippinginformation
POST
checkoutTotalsInformationManagementV1
Calculate quote totals based on address and shipping method
POST
Calculate quote totals based on address and shipping method
POST
checkoutGuestTotalsInformationManagementV1
Calculate quote totals based on address and shipping method
POST
asyncOrderAsyncPaymentInformationGuestPublisherV1
Set payment information and place order for a specified cart
POST
checkoutGuestPaymentInformationManagementV1
Get payment information
GET
Set payment information for a specified cart
POST
asyncOrderAsyncPaymentInformationCustomerPublisherV1
Set payment information and place order for a specified cart
POST
checkoutPaymentInformationManagementV1
Get payment information
GET
Set payment information for a specified cart
POST
Set payment information for a specified cart
POST
Get payment information
GET
Set payment information and place order for a specified cart
POST
twoFactorAuthAdminTokenServiceV1
Create access token for admin given the admin credentials
POST
integrationCustomerTokenServiceV1
Create access token for admin given the customer credentials
POST
Revoke token by customer id
POST
downloadableLinkRepositoryV1
List of links with associated samples
GET
Update downloadable link of the given product
POST
Update downloadable link of the given product
PUT
Delete downloadable link
DELETE
downloadableSampleRepositoryV1
List of samples for downloadable product
GET
Update downloadable sample of the given product
POST
Update downloadable sample of the given product
PUT
Delete downloadable sample
DELETE
configurableProductLinkManagementV1
Get all children for Configurable product
GET
Remove configurable product option
DELETE
Post v1 configurableproducts sku child
POST
configurableProductConfigurableProductManagementV1
Generate variation based on same product
PUT
configurableProductOptionRepositoryV1
Get option for configurable product
GET
Save option
PUT
Remove option from configurable product
DELETE
Get all options for configurable product
GET
Save option
POST
giftRegistryShippingMethodManagementV1
Estimate shipping
POST
giftRegistryGuestCartShippingMethodManagementV1
Estimate shipping
POST
checkoutAgreementsCheckoutAgreementsRepositoryV1
Lists active checkout agreements
GET
checkoutAgreementsCheckoutAgreementsListV1
List of checkout agreements
GET
companyCompanyRepositoryV1
Returns the list of companies
GET
Create
POST
Returns company details
GET
Create
PUT
Delete a company
DELETE
companyTeamRepositoryV1
Returns the list of teams for the specified search criteria
GET
Returns data for a team in the company
GET
Update a team in the company structure
PUT
Delete a team from the company structure
DELETE
Create a team in the company structure
POST
companyCompanyHierarchyV1
Returns the list of teams and company users in the company structure
GET
Moves teams and users within the company structure
PUT
companyRoleRepositoryV1
Returns the list of roles and permissions for a specified company
GET
Create
POST
Returns the list of permissions for a specified role
GET
Delete a role
DELETE
Create
PUT
companyAclV1
Change a role for a company user
PUT
View the list of company users assigned to a specified role
GET
taxTaxRateRepositoryV1
Create
PUT
Create
POST
Get tax rate
GET
Delete tax rate
DELETE
Search TaxRates This call returns an array of objects
GET
taxTaxRuleRepositoryV1
Save TaxRule
PUT
Save TaxRule
POST
Get TaxRule
GET
Delete TaxRule
DELETE
Search TaxRules This call returns an array of objects
GET
taxTaxClassRepositoryV1
Create a Tax Class
POST
Get a tax class with the given tax class id
GET
Delete a tax class with the given tax class id
DELETE
Create a Tax Class
PUT
Retrieve tax classes which match a specific criteria
GET
companyCreditCreditLimitRepositoryV1
Returns the list of credits for specified companies
GET
Returns data on the credit limit for a specified credit limit ID
GET
Update the following company credit attributes: credit currency
PUT
companyCreditCreditLimitManagementV1
Returns data on the credit limit for a specified company
GET
companyCreditCreditBalanceManagementV1
Increases the company credit with an Allocate
POST
Decreases the company credit with an Update
POST
companyCreditCreditHistoryManagementV1
Returns the credit history for one
GET
Update the PO Number and/or comment for a Reimburse transaction
PUT
twoFactorAuthTfaV1
Get a list of providers
GET
Retrieve forced providers list
GET
Get a user provider
GET
Set providers
PUT
Returns a list of providers to configure/enroll
GET
Set default provider code
PUT
twoFactorAuthUserConfigManagerV1
Get default provider
GET
twoFactorAuthTfatActionsV1
Get the providers that the user is able to use for 2fa
GET
Get the providers that the user still needs to configure
GET
twoFactorAuthGoogleConfigureV1
Get the information required to configure google
POST
Activate the provider and get an admin token
POST
twoFactorAuthGoogleAuthenticateV1
Get an admin token by authenticating using google
POST
twoFactorAuthAuthyConfigureV1
Get the information required to configure google
POST
Activate the provider and get an admin token
POST
twoFactorAuthAuthyAuthenticateV1
Get an admin token using authy 2fa
POST
Send a one time password to a device using authy
POST
Authenticate using the present one touch response and get an admin token
POST
twoFactorAuthU2fKeyConfigureV1
Get the information to initiate a WebAuthn registration ceremony
POST
Activate the provider and get a token
POST
twoFactorAuthU2fKeyAuthenticateV1
Get the information to initiate a WebAuthn registration ceremony
POST
Authenticate with the provider and get a token
POST
twoFactorAuthDuoConfigureV1
Get the information required to configure duo
POST
Activate the provider and get an admin token
POST
twoFactorAuthDuoAuthenticateV1
Get the information required to configure duo
POST
Authenticate and get an admin token
POST
negotiableQuoteNegotiableQuoteDraftManagementV1
Create a new empty B2B quote with NegotiableQuoteInterface::STATUS_DRAFT_BY_ADMIN status
POST
negotiableQuoteNegotiableQuoteManagementV1
Create a B2B quote based on a regular Magento quote
POST
Submit the B2B quote to the customer
POST
Decline the B2B quote
POST
negotiableQuoteNegotiableQuotePriceManagementV1
Refreshes item prices
POST
negotiableQuoteAttachmentContentManagementV1
Returns content for one
GET
negotiableQuoteCommentLocatorV1
Returns comments for a specified negotiable quote
GET
negotiableQuoteNegotiableQuoteShippingManagementV1
Updates the shipping method on a negotiable quote
PUT
negotiableQuoteAsyncOrderAsyncPaymentInformationManagementV1
Set payment information and place order for a specified cart
POST
negotiableQuotePaymentInformationManagementV1
Get payment information
GET
Set payment information for a specified cart
POST
negotiableQuoteShippingInformationManagementV1
Post v1 negotiablecarts cart id shippinginformation
POST
negotiableQuoteShipmentEstimationV1
Estimate shipping by address and return list of available shipping methods
POST
negotiableQuoteShippingMethodManagementV1
Estimate shipping
POST
negotiableQuoteNegotiableCartRepositoryV1
Save quote
PUT
negotiableQuoteBillingAddressManagementV1
Returns the billing address for a specified quote
GET
Assigns a specified billing address to a specified cart
POST
negotiableQuoteCartTotalRepositoryV1
Returns quote totals data for a specified cart
GET
negotiableQuoteCouponManagementV1
Adds a coupon by code to a specified cart
PUT
Deletes a coupon from a specified cart
DELETE
negotiableQuoteGiftCardAccountManagementV1
Post v1 negotiablecarts cart id gift cards
POST
Remove GiftCard Account entity
DELETE
negotiableQuoteItemNoteRepositoryV1
Get item note by ID
GET
Delete item note by ID
DELETE
Set the note for an item in negotiable quote
POST
Get list of item notes
GET
analyticsLinkProviderV1
Get v1 analytics link
GET
customerBalanceBalanceManagementV1
Apply store credit
POST
giftCardAccountGiftCardAccountManagementV1
Return GiftCard Account cards
GET
Add gift card to the cart
PUT
Remove GiftCard Account entity
DELETE
Remove GiftCard Account entity
DELETE
Add gift card to the cart
POST
Check gift card balance if applied to given cart
GET
Add gift card to the cart
POST
Remove GiftCard Account entity
DELETE
giftCardAccountGuestGiftCardAccountManagementV1
Remove GiftCard Account entity
DELETE
Add gift card to the cart
POST
Check gift card balance if added to the cart
GET
sharedCatalogSharedCatalogRepositoryV1
Return the following properties for the selected shared catalog: ID
GET
Delete a shared catalog by ID
DELETE
Create
POST
Create
PUT
Return the list of shared catalogs and basic properties for each catalog
GET
sharedCatalogCompanyManagementV1
Return the list of company IDs for the companies assigned to the selected catalog
GET
Assign companies to a shared catalog
POST
Unassign companies from a shared catalog
POST
sharedCatalogProductManagementV1
Return the list of product SKUs in the selected shared catalog
GET
Add products into the shared catalog
POST
Remove the specified products from the shared catalog
POST
sharedCatalogCategoryManagementV1
Return the list of categories in the selected shared catalog
GET
Add categories into the shared catalog
POST
Remove the specified categories from the shared catalog
POST
sharedCatalogAssignTierPriceV1
Assign custom prices
POST
sharedCatalogResetTierPriceV1
Reset custom prices
POST
giftMessageCartRepositoryV1
Return the gift message for a specified order
GET
Set the gift message for an entire order
POST
Return the gift message for a specified order
GET
Set the gift message for an entire order
POST
giftMessageItemRepositoryV1
Return the gift message for a specified item in a specified shopping cart
GET
Set the gift message for a specified item in a specified shopping cart
POST
Return the gift message for a specified item in a specified shopping cart
GET
Set the gift message for a specified item in a specified shopping cart
POST
giftMessageGuestCartRepositoryV1
Return the gift message for a specified order
GET
Set the gift message for an entire order
POST
giftMessageGuestItemRepositoryV1
Return the gift message for a specified item in a specified shopping cart
GET
Set the gift message for a specified item in a specified shopping cart
POST
giftWrappingWrappingRepositoryV1
Return data object for specified wrapping ID and store
GET
Delete gift wrapping
DELETE
Return list of gift wrapping data objects based on search criteria
GET
Create/Update new gift wrapping with data object values
POST
Create/Update new gift wrapping with data object values
PUT
importCsvApiImportLocalizedSourceDataV1
Start import operation
POST
importJsonApiStartImportV1
Starts import operation
POST
inventoryApiSourceRepositoryV1
Find Sources by SearchCriteria SearchCriteria is not required because load all stocks is useful case
GET
Save Source data
POST
Get Source data by given code
GET
Save Source data
PUT
inventoryApiGetSourcesAssignedToStockOrderedByPriorityV1
Get Sources assigned to Stock ordered by priority If Stock with given id doesn't exist then return an empty array
GET
inventoryApiStockRepositoryV1
Find Stocks by given SearchCriteria SearchCriteria is not required because load all stocks is useful case
GET
Save Stock data
POST
Get Stock data by given stockId
GET
Save Stock data
PUT
Delete the Stock data by stockId
DELETE
inventoryApiGetStockSourceLinksV1
Find StockSourceLink list by given SearchCriteria
GET
inventoryApiStockSourceLinksSaveV1
Save StockSourceLink list data
POST
inventoryApiStockSourceLinksDeleteV1
Remove StockSourceLink list list
POST
inventoryApiSourceItemRepositoryV1
Find SourceItems by SearchCriteria We need to have this method for direct work with SourceItems because this object contains additional data like as qty
GET
inventoryApiSourceItemsSaveV1
Save Multiple Source item data
POST
inventoryApiSourceItemsDeleteV1
Delete Multiple Source item data
POST
inventoryCatalogApiBulkSourceAssignV1
Run mass product to source assignment
POST
inventoryCatalogApiBulkSourceUnassignV1
Run mass product to source un-assignment
POST
inventoryCatalogApiBulkInventoryTransferV1
Run bulk inventory transfer
POST
inventoryCatalogApiBulkPartialInventoryTransferV1
Run bulk partial inventory transfer for specified items
POST
inventoryDistanceBasedSourceSelectionApiGetDistanceProviderCodeV1
Get Default distance provider code
GET
inventoryDistanceBasedSourceSelectionApiGetDistanceV1
Get distance between two points
GET
inventoryDistanceBasedSourceSelectionApiGetLatLngFromAddressV1
Get latitude and longitude object from address
GET
inventoryDistanceBasedSourceSelectionApiGetLatsLngsFromAddressV1
Get all available latitude and longitude objects from address
GET
inventoryExportStockApiExportStockSalableQtyV1
Export product stock data filtered by search criteria
GET
inventoryExportStockApiExportStockIndexDataV1
Provides stock index export from inventory_stock_% table
GET
inventorySalesApiGetProductSalableQtyV1
Get Product Quantity for given SKU and Stock
GET
inventorySalesApiIsProductSalableV1
Get is product in salable for given SKU in a given Stock
GET
inventorySalesApiAreProductsSalableV1
Get products salable status for given SKUs and given Stock
GET
inventorySalesApiIsProductSalableForRequestedQtyV1
Get is product salable for given SKU in a given Stock for a certain Qty
GET
inventorySalesApiAreProductsSalableForRequestedQtyV1
Get whether products are salable in requested Qty for given set of SKUs in specified stock
GET
inventorySalesApiStockResolverV1
Resolve Stock by Sales Channel type and code
GET
inventoryInStorePickupApiGetPickupLocationsV1
Get Pickup Locations according to the results of filtration by Search Request
GET
inventorySourceSelectionApiGetSourceSelectionAlgorithmListV1
Get v1 inventory sourceselectionalgorithmlist
GET
inventorySourceSelectionApiSourceSelectionServiceV1
Post v1 inventory sourceselectionalgorithmresult
POST
inventoryInStorePickupSalesApiNotifyOrdersAreReadyForPickupV1
Notify customer that the orders is ready for pickup
POST
inventoryLowQuantityNotificationApiGetSourceItemConfigurationV1
Get the source item configuration
GET
inventoryLowQuantityNotificationApiSourceItemConfigurationsSaveV1
Post v1 inventory lowquantitynotification
POST
inventoryLowQuantityNotificationApiDeleteSourceItemsConfigurationV1
Delete multiple source items configuration for low quantity
POST
adobeStockAssetApiAssetRepositoryV1
Get asset by id
GET
Delete asset
DELETE
Get a list of assets
GET
adobeStockAssetApiGetAssetListV1
Search for images based on search criteria
GET
multicouponCouponManagementV2
Returns information for all coupons in a specified cart
GET
Replace the coupon code
PUT
Append the coupon code
POST
Returns information for all coupons in a specified cart
GET
Replace the coupon code
PUT
Append the coupon code
POST
Deletes coupon
POST
Deletes coupon
POST
purchaseOrderPurchaseOrderPaymentInformationManagementV1
Set payment information and place purchase order for a specified cart
POST
rewardRewardManagementV1
Set reward points to quote
POST
rmaTrackManagementV1
Get track list
GET
Add track
POST
Remove track by id
DELETE
Get shipping label int the PDF format
GET
rmaRmaRepositoryV1
Return data object for specified RMA id
GET
Delete RMA
DELETE
rmaCommentManagementV1
Comments list
GET
Add comment
POST
rmaRmaManagementV1
Save RMA
PUT
Return list of rma data objects based on search criteria
GET
Save RMA
POST
rmaRmaAttributesManagementV1
Retrieve attribute metadata
GET
Retrieve all attributes filtered by form code
GET
Get all attribute metadata
GET
Get custom attribute metadata for the given Data object's attribute set
GET
paymentServicesPaypalPaymentConfigRequestV1
Get Config
GET
Get Google Pay Config
GET
Get Apple Pay Config
GET
Get Smart Buttons Config
GET
Get Hosted Fields Config
GET
paymentServicesPaypalPaymentOrderRequestV1
Create a payment order for guest customer
POST
Create a payment order for logged in customer
POST
Get payment order for guest customer
GET
Sync payment order for guest customer
POST
Get payment order for logged in customer
GET
Sync payment order for logged in customer
POST
paymentServicesPaypalPaymentSdkRequestV1
Get payment sdk url by location
GET
Get payment sdk url by location and methodCode
GET
asynchronousOperationsBulkStatusV1
Get Bulk summary data with list of operations items full data
GET
Get Bulk summary data with list of operations items short data
GET
Get operations count by bulk uuid and status
GET
asynchronousOperationsOperationRepositoryV1
Lists the bulk operation items that match specified search criteria
GET
adyenPaymentGuestAdyenPaymentMethodManagementV1
Fetches Adyen payment methods for guest customers
POST
adyenPaymentAdyenPaymentMethodManagementV1
Fetches Adyen payment methods for logged in customers
POST
adyenPaymentGuestAdyenPaymentsDetailsV1
Post v1 adyen guestcarts cart id paymentsdetails
POST
adyenPaymentAdyenPaymentsDetailsV1
Post v1 adyen carts mine paymentsdetails
POST
adyenPaymentAdyenStateDataV1
Persist the Adyen state data for the quote so it can be used in the payment request
POST
Removes the Adyen state data with the given entity id
DELETE
adyenPaymentGuestAdyenStateDataV1
Persist the Adyen state data for the quote so it can be used in the payment request
POST
Removes the Adyen state data with the given entity id
DELETE
adyenPaymentAdyenGiftcardV1
Fetches all the adyen_state_data entities and returns giftcard related objects
GET
adyenPaymentGuestAdyenGiftcardV1
Fetches all the adyen_state_data entities and returns giftcard related objects
GET
adyenPaymentAdyenOrderPaymentStatusV1
Post v1 adyen orders carts mine paymentstatus
POST
adyenPaymentGuestAdyenOrderPaymentStatusV1
Post v1 adyen orders guestcarts cart id paymentstatus
POST
adyenPaymentGuestAdyenDonationsV1
Build and send donation payment request for guest shoppers
POST
adyenPaymentAdyenDonationsV1
Build and send donation payment request
POST
adyenPaymentAdyenPaymentMethodsBalanceV1
Build and send paymentMethods/balance request
POST
firebearImportExportImportGetByIdV1
Get job by id
GET
firebearImportExportImportGetListV1
Get job list
GET
firebearImportExportImportSaveV1
Save job
PUT
Save job
POST
firebearImportExportImportDeleteByIdV1
Delete job by id
DELETE
firebearImportExportImportBeforeRunV1
Retrieve file name
POST
firebearImportExportImportRunV1
Run import
POST
firebearImportExportImportGetBunchCountV1
Get job bunch count
POST
firebearImportExportImportProcessV1
Process import
POST
firebearImportExportImportConsoleV1
Get console info
POST
firebearImportExportImportReindexV1
Reindex
POST
firebearImportExportImportUploadV1
Upload file
POST
flektoPostcodePostcodeModelV1
Get v1 international autocomplete context term
GET
Get v1 international address context
GET
Get v1 international address context dispatch country
GET
Get v1 nl address zip code house number
GET
winkelstraatCatalogConfigurableProductsRepositoryV1
Get v1 products sku configurables
GET
\WinkelstraatCustomerFavoriteManufacturersFavouriteManagementV1
Get v1 customers me manufacturer favorite list
GET
Post v1 customers me manufacturer favorite
POST
Delete v1 customers me manufacturer favorite manufacturer code category code
DELETE
winkelstraatCustomerMagicLinkAccountManagementV1
Post v1 customers magichash
POST
winkelstraatRmaV1
Get v1 user rma order order increment
GET
Get v1 user rma
GET
Post v1 user rma
POST
Get v1 user rma rma increment
GET
Get v1 user rma rma increment id shippinglabel
GET
Post v1 user rma rma increment id shippinglabel
POST
winkelstraatRmaRmaAttributeV1
Get v1 winkelstraat returns attributes
GET
Put v1 winkelstraat returns attributes
PUT
winkelstraatRmaRmaItemAttributeV1
Get v1 winkelstraat returns items attributes
GET
Put v1 winkelstraat returns items attributes
PUT
winkelstraatIsaacPimAkeneoIdentifierLinkV1
Post v1 winkelstraat isaac pim akeneo identifier link
POST
winkelstraatGoogleIdentityVerifyIdTokenV1
Post v1 winkelstraat googleidentity verify
POST
winkelstraatGoogleIdentityAccessTokenV1
Post v1 winkelstraat googleidentity token
POST
winkelstraatIntegrationOrderOrderTokenServiceV1
Post v1 integration order token
POST
winkelstraatStatusSyntheticsV1
Get v1 status synthetics monitors
GET
winkelstraatMagento1OrderGuestOrderV1
Post v1 integration magento1order access
POST
winkelstraatSalesRefundOrderV1
Create online refund for order
POST
winkelstraatSalesOrderRepositoryV1
Get v1 winkelstraat orders
GET
Get v1 winkelstraat order hash checkout token
GET
Get v1 winkelstraat orders increment
GET
\WinkelstraatMessageBirdLoginCustomerTokenServiceV1
Create access token for admin given the customer credentials
POST
\WinkelstraatMessageBirdLoginCustomerFinderServiceV1
Post v1 messagebird customer exists
POST
winkelstraatOrderSynchronisationOrderUpdateV1
Post v1 winkelstraat order update
POST
winkelstraatProductAlertStockRepositoryV1
Post v1 winkelstraat productalert stock guest
POST
Post v1 winkelstraat productalert stock add
POST
Get v1 winkelstraat productalert stock get
GET
Delete v1 winkelstraat productalert stock remove
DELETE
winkelstraatCreditmemoApiDeficientOrderV1
Post v1 winkelstraat creditmemo api shipment increment id deficiency
POST
winkelstraatRmaApiShipmentProcessorV1
Post v1 winkelstraat rma api shipment increment
POST
winkelstraatRmaApiAttributeOptionsV1
Get v1 winkelstraat rma api attribute attribute code
GET
\WinkelstraatMerchantAutoCreditmemoMerchantAutomaticCreditmemoEnabledV1
Get v1 winkelstraat merchant code automatic refund allowed
GET
winkelstraatRmaGuestRmaV1
Post v1 guest rma order token
POST
Get v1 guest rma order me
GET
Get v1 guest rma
GET
Post v1 guest rma
POST
Get v1 guest rma rma increment
GET
Get v1 guest rma rma increment id shippinglabel
GET
Post v1 guest rma rma increment id shippinglabel
POST
winkelstraatShippingPickUpPointGuestPickupPointManagementV1
Return the DHL Service Point and UPS Access point for a quote
GET
Post v1 guestcarts cart id pickuppoint
POST
Unset the DHL Service Point and UPS Access point for a quote
DELETE
winkelstraatShippingPickUpPointPickupPointManagementV1
Return the pickup point for a quote
GET
Post v1 carts mine pickuppoint
POST
Unset service points for a quote
DELETE
Return the pickup point for a quote
GET
Post v1 carts cart id pickuppoint
POST
Unset service points for a quote
DELETE
winkelstraatSalesGuestOrderRepositoryV1
Get v1 guest orders me
GET
winkelstraatSalesOrderToCartRestoreCartFromOrderV1
Get v1 winkelstraat orders increment id restore cart
GET
winkelstraatSalesOrderToCartRestoreGuestCartFromOrderV1
Post v1 guestcarts cart id restore from order increment
POST
winkelstraatSalesOrderToCartRestoreCustomerCartFromOrderV1
Post v1 carts mine restore from order increment
POST
\WinkelstraatShippingPackedShipmentPackedV1
Post v1 shipment id packed
POST
\WinkelstraatShippingPackedShipmentPackedResetV1
Post v1 shipment id packed reset
POST
\WinkelstraatShippingPackedExternalShipmentPackedV1
Post v1 shipment increment id merchant packed
POST
\WinkelstraatShippingPackedExternalShipmentPackedResetV1
Post v1 shipment increment id merchant packed reset
POST
\WinkelstraatShippingEstimatesControllerDeliveryEstimateControllerV1
Get v1 winkelstraat shippingestimates delivery
GET
\WinkelstraatShippingExternalFulfillmentTrackAddServiceV1
Post v1 external fulfillment shipment track
POST
\WinkelstraatShippingPackingslipPackingSlipPdfRepositoryV1
Get v1 winkelstraat shippingpackingslip increment
GET
Get v1 winkelstraat shippingpackingslips
GET
winkelstraatDHLParcelServicePointGuestServicePointManagementV1
Return the DHL Service Point for a quote
GET
Post v1 guestcarts cart id dhlparcelservicepoint
POST
Unset the DHL Service Point for a quote
DELETE
winkelstraatDHLParcelServicePointServicePointManagementV1
Return the DHL Service Point for a quote
GET
Post v1 carts mine dhlparcelservicepoint
POST
Unset the DHL Service Point for a quote
DELETE
Return the DHL Service Point for a quote
GET
Post v1 carts cart id dhlparcelservicepoint
POST
Unset the DHL Service Point for a quote
DELETE
winkelstraatStatusSalesUnshippedInvoicesV1
Get v1 status sales unshippedinvoicedorders
GET
winkelstraatStockHubQuoteStockHubQuoteManagementV1
Create Stock Hub quote for a set of product items
POST
List all Stock Hub quotes
GET
Get a specific Stock Hub quote
GET
Convert a Stock Hub quote into an order
POST
\WinkelstraatStockHubRmaRmaManagerV1
List items viable for return for a specific order
GET
List all returns
GET
Create a return for a specific order for the given set of items
POST
Get a specific return
GET
Get the current return label for a specific return
GET
winkelstraatStockHubSalesOrderManagementV1
List orders
GET
Get specific order
GET
\WinkelstraatCatalogImportApiPriceUpdaterV1
Post v1 winkelstraat catalog product prices
POST
\WinkelstraatCatalogImportApiProductUpdaterV1
Post v1 winkelstraat catalog product
POST
\WinkelstraatCatalogImportApiProductDeleteV1
Delete v1 winkelstraat catalog product uuid
DELETE
\WinkelstraatCatalogImportApiProductOperationV1
Post v1 winkelstraat catalog product operation
POST
winkelstraatUpsapGuestAccessPointManagementV1
Return the UPS Access Point for a quote
GET
Post v1 guestcarts cart id upsaccesspoint
POST
Removes the UPS Access Point for a quote
DELETE
winkelstraatUpsapAccessPointManagementV1
Return the UPS Access Point for a quote
GET
Post v1 carts mine upsaccesspoint
POST
Removes the UPS Access Point for a quote
DELETE
Return the UPS Access Point for a quote
GET
Post v1 carts cart id upsaccesspoint
POST
Removes the UPS Access Point for a quote
DELETE
winkelstraatWishlistApiWishlistManagerV1
Post v1 wishlist list
POST
Post v1 wishlist add sku
POST
Post v1 wishlist delete sku
POST
winkelstraatiOSControllerV8OrderCancelControllerV8
Post v8 winkelstraat ios order cancel
POST
winkelstraatiOSControllerV8OrderPlaceControllerV8
Post v8 winkelstraat ios order place
POST
winkelstraatiOSControllerV8ShippingMethodsControllerV8
Get v8 winkelstraat ios shipping methods
GET
Search…
Ctrl+K
⌘K
API changelog
Download source
JSON OpenAPI specification
YAML OpenAPI specification
Toggle dark mode
Magento2
Dismiss highlight
Show more
\WinkelstraatShippingPackedExternalShipmentPackedV1