inventory-movements

List inventory movements

Returns a paginated history of inventory movements (SNAPSHOT and DELTA records) read from the Elasticsearch audit log, scoped to the caller account and ordered newest-first ("occurred_at" desc) by default. Filter by exact "sku", free-text "q" matching SKU or product name (case-insensitive substring), "strategyCode", "reason" and "updateType". Each item exposes the running balance ("balance_after") recorded when the movement occurred, which may be null for deltas still awaiting backfill.

get/api/v1/inventory-movements

Query parameters

skustring
qstring
strategyCodestring[]
reasonstring
updateTypestring
occurredFromstring
occurredTostring
pagenumber
limitnumber
sortBystring
sortOrderstring

Response

Paginated history of inventory movements.

Example response

{
  "meta": {
    "total": 42,
    "pages": 3,
    "current_page": 1,
    "next_page": 2,
    "limit": 20
  }
}

Changes

Changed in 2 of the 9 revisions of this API.91121

    • added the new optional query request parameter limit

      new-optional-request-parameter

    • added the new optional query request parameter occurredFrom

      new-optional-request-parameter

    • added the new optional query request parameter occurredTo

      new-optional-request-parameter

    • added the new optional query request parameter page

      new-optional-request-parameter

    • added the new optional query request parameter q

      new-optional-request-parameter

    • added the new optional query request parameter reason

      new-optional-request-parameter

    • added the new optional query request parameter sku

      new-optional-request-parameter

    • added the new optional query request parameter sortBy

      new-optional-request-parameter

    • added the new optional query request parameter sortOrder

      new-optional-request-parameter

    • added the new optional query request parameter strategyCode

      new-optional-request-parameter

    • added the new optional query request parameter updateType

      new-optional-request-parameter

    • removed the DELTA enum value from the data/items/update_type response property for the response status 200

      response-property-enum-value-removed

    • added the required property data/items/balance_after/allOf[InventoryMovementBalanceAfterResponse]/blocked to the response with the 200 status

      response-required-property-added

    • added the required property data/items/balance_after/allOf[InventoryMovementBalanceAfterResponse]/on_hand to the response with the 200 status

      response-required-property-added

    • added the required property data/items/balance_after/allOf[InventoryMovementBalanceAfterResponse]/reserved to the response with the 200 status

      response-required-property-added

    • added the required property data/items/event_id to the response with the 200 status

      response-required-property-added

    • added the required property data/items/id to the response with the 200 status

      response-required-property-added

    • added the required property data/items/occurred_at to the response with the 200 status

      response-required-property-added

    • added the required property data/items/quantity to the response with the 200 status

      response-required-property-added

    • added the required property data/items/sku to the response with the 200 status

      response-required-property-added

    • added the required property data/items/strategy_code to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 84194c31ab85911See the full diff
    • removed the required property data/items/balance_after/allOf[InventoryMovementBalanceAfterResponse]/blocked from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/balance_after/allOf[InventoryMovementBalanceAfterResponse]/on_hand from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/balance_after/allOf[InventoryMovementBalanceAfterResponse]/reserved from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/event_id from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/id from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/occurred_at from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/quantity from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/sku from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/strategy_code from the response with the 200 status

      response-required-property-removed

    • deleted the query request parameter limit

      request-parameter-removed

    • deleted the query request parameter occurredFrom

      request-parameter-removed

    • deleted the query request parameter occurredTo

      request-parameter-removed

    • deleted the query request parameter page

      request-parameter-removed

    • deleted the query request parameter q

      request-parameter-removed

    • deleted the query request parameter reason

      request-parameter-removed

    • deleted the query request parameter sku

      request-parameter-removed

    • deleted the query request parameter sortBy

      request-parameter-removed

    • deleted the query request parameter sortOrder

      request-parameter-removed

    • deleted the query request parameter strategyCode

      request-parameter-removed

    • deleted the query request parameter updateType

      request-parameter-removed

    This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog