List inventory increases

Operation ID: inventoryIncreases

Group: Inventory › Inventory Increases

Open in the interactive reference

GET /inventory/inventory-increases

Read-only: Reads and returns; changes nothing.

Lists inventory increases. Each inventory increase comes back with its main fields and lineCount, but without the lines.

To read the lines, use GET inventory/inventory-increases/:id or POST inventory/inventory-increases/search. To filter by item, use POST inventory/inventory-increases/search.

Parameters

Query surface

• id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• documentNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• documentStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• documentDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• entityId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• locationId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• locationCode — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• reasonCodeId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• reasonCode — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• Orderable: id, documentNumber, documentDate, documentStatus, createdDate, lastModifiedDate
• Selectable: id, documentNumber, documentStatus, documentDate, entityId, entityName, locationId, locationCode, locationName, reasonCodeId, reasonCode, reasonCodeDescription, currency, lineCount, notes, createdDate, lastModifiedDate
• page[size] — Page size
• page[cursor] — Opaque continuation cursor

Response

200 Success

Under data, an array of inventoryIncreasesRow:

{
  "data": [
    {
      "id": "d4a17f28-6b93-4c50-8e71-2a5d0c9b3e64",
      "documentNumber": "INC-42",
      "documentStatus": "DRAFT",
      "documentDate": "2026-08-14",
      "entityId": "1a9c4e70-38b5-4d26-9f01-7c2e5b8a6d43",
      "entityName": "Acme Netherlands B.V.",
      "locationId": "e1d84c07-5b39-4a26-9f70-2c8b613ad495",
      "locationCode": "WH-01",
      "locationName": "Rotterdam Distribution Centre",
      "reasonCodeId": "6f2b58c1-9d47-4e03-a815-70c9d2e46b38",
      "reasonCode": "COUNT",
      "reasonCodeDescription": "Count correction",
      "currency": "EUR",
      "lineCount": 1,
      "notes": "August cycle count",
      "createdDate": "2026-08-14T09:12:00.000Z",
      "lastModifiedDate": "2026-08-14T09:12:00.000Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "<nextCursor>"
  }
}

Statuses

• 400 — Invalid request or business failure
• 401 — The request carries no valid access token.
• 403 — Not authorized
• 404 — Not found
• 429 — Too many requests from this client address. The response has no body and no Retry-After header.
• 500 — Internal server error