Skip to main content

FIFO Layer Inventory Movements

GET 
/api/v2/fifo-layers/:fifoLayer/inventory-movements

Paginated usage movements for a FIFO layer (standard paginated response: data[] plus current_page, last_page, per_page, total, ...).

Required scope: inventory:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

The movement that originally created the layer is excluded by default — it is presented in the layer's origin block on the single-layer endpoint instead of as a usage. Pass exclude_origin=0 to include it (e.g. to tally the layer's full movement history).

Filters (server-side):

  • filter[type] — exact movement type match. Dotted operator variants are also available (filter[type.is], filter[type.contains], ...).
  • filter[link_type] — exact source-document type match.
  • filter[inventory_status] — defaults to active; pass all for no status restriction. Dotted operator variants (filter[inventory_status.is], ...) are also available.
  • filter[reference] — text operator filters (filter[reference.contains], ...).
  • filter[quantity] — numeric operator filters (filter[quantity.gte], ...).
  • filter[inventory_movement_date], filter[created_at] — date operator filters (.on, .before, .after, .between).
  • filter[search] — searches ID (exact), Reference, SKU, and Product Name.

Allowed sorts: id, inventory_movement_date, type, inventory_status, quantity, reference, created_at (prefix with - for descending; default: -inventory_movement_date).

Authentication: Requires Bearer token.

Request​

Responses​

OK