StockChanges

Bulk read stockchanges

Retrieves a list of stockchanges. Supports filtering by fields, sorting, and pagination.

get/v1/stock-changes

Request

  • Base URL: https://api.finalpos.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.finalpos.com/v1/stock-changes
  • Auth: API key in header x-api-key

Query parameters

skipnumber

Number of records to skip (default: 0)

limitnumber

Maximum number of records to return (default: 100, max: 1000)

sortBy'createdAt' | 'updatedAt'

Field name to sort results by

sortOrder'asc' | 'desc'

Sort direction (default: asc)

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time

Filter by createdAt using range operators

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time

Filter by updatedAt using range operators

Response

Successfully retrieved list of items

Example response

{
  "data": [
    {
      "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "createdAt": "2025-12-07T19:31:48.436+00:00",
      "updatedAt": "2025-12-07T19:35:48.436+00:00",
      "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "userId": "507f1f77bcf86cd799439011",
      "source": "public-api",
      "productId": "507f1f77bcf86cd799439012",
      "variantId": "507f1f77bcf86cd799439013",
      "variantName": "Bottle",
      "outletId": "507f1f77bcf86cd799439014",
      "baseAction": "ADD",
      "specificAction": "INVENTORY_RECOUNT",
      "customActionId": "507f1f77bcf86cd799439016",
      "customActionName": "Exhibition loan",
      "quantity": 400000,
      "updatedQuantity": 359000,
      "unitId": "GRM",
      "unitQuantity": -3,
      "viaVariantId": "507f1f77bcf86cd799439015",
      "viaVariantName": "Glass",
      "compositeProductId": "507f1f77bcf86cd799439016",
      "compositeName": "Combo #1",
      "idempotencyKey": "sarnia:shopify:b54c8f9e-4c6a-4f5a-9d2e-7a1b3c9d0e2f"
    }
  ],
  "meta": {
    "count": 1450,
    "limit": 100
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.