Skip to content

REST API

The MSI REST API is otherwise unchanged: module names, namespaces and service contracts are the same as upstream, so the Adobe Commerce inventory REST reference applies.

Reads the adjustment history.

  • ACL: Magento_InventoryAdjustment::view.
  • Input: searchCriteria, with filters on any history field.
  • Order: newest first.
  • Paging: always paged. pageSize above cataloginventory/source_item_adjustment/max_page_size (500 by default) is rejected with a 400 that names the limit.

POST /V1/inventory/source-items, and its async variant, accept an adjustment extension attribute on each source item, with reason, note, reference_type and reference_id. It sets why the history records the change. Saying why over REST lists the accepted values and the requests that are rejected with a 400.

  • POST /V1/inventory/bulk-product-source-transfer moves the reservations of open orders with the stock when source-level reservations are enabled, and is refused when the destination is not assigned to the stock of such an order.
  • POST /V1/inventory/bulk-partial-source-transfer sums a repeated SKU before validating, rejects zero or negative quantities, and moves every item or none.
  • ShipOrder without extension_attributes.source_code on a stock with several sources resolves the source or rejects the shipment with a validation message.