---
title: "Get a list of stock movements"
method: GET
path: "/v1/stockMovement"
tags: ["Stock"]
---

# Get a list of stock movements

`GET /v1/stockMovement`

Retrieves a paged collection of stock movements (required scope stock:read)

## Query parameters

- `id` integer[]
- `jobId` integer[]
- `pickUpAtFrom` string, date-time
- `pickUpAtTo` string, date-time
- `dropOffAtFrom` string, date-time
- `dropOffAtTo` string, date-time
- `stockDetailsId` integer[]
- `stockItemId` integer[]
- `vehicleId` integer[]
- `dropOffContactId` integer[]
- `dropOffVehicleId` integer[]
- `pageNumber` integer
- `pageSize` integer

## Headers

- `Customer-Id` integer, required

## Response `200`

OK

- PagedResponseReadStockMovementModel — A paged collection of items
  - `items` ReadStockMovementModel[] — The items returned for the requested page
    - `id` integer — The unique identifier for each stock movement record
    - `stockDetailsId` integer — The identifier of the type of stock associated with the stock movement
    - `stockItemId` integer, nullable — The identifier of the specific stock item involved in the stock movement
    - `jobId` integer, nullable — The identifier of the job associated with the stock usage/movement
    - `pickupAt` string, date-time, nullable — The timestamp with time zone offset of the stock pickup
    - `dropOffAt` string, date-time, nullable — The UTC timestamp of the stock drop-off
    - `isDropOffForSell` boolean — A flag indicating if the delivered stock is meant for sale
    - `pickupPosition` Location — Represents a geographical location
      - `latitude` number, double, required — Latitude of the center of the location
      - `longitude` number, double, required — Longitude of the center of the location
    - `dropOffPosition` Location — Represents a geographical location
      - `latitude` number, double, required — Latitude of the center of the location
      - `longitude` number, double, required — Longitude of the center of the location
    - `pickupVehicleId` integer, nullable — The identifier of the vehicle at the pickup location
    - `vehicleId` integer, nullable — The identifier of the vehicle associated with the stock movement
    - `dropOffVehicleId` integer, nullable — The identifier of the vehicle at the drop-off location
    - `dropOffStockItemId` integer, nullable — The identifier of the stock item at the drop-off location
    - `pickupStockItemId` integer, nullable — The identifier of the stock item at the pickup location
    - `isEquipmentAtPickup` boolean — A flag indicating if the stock at the pickup location is equipment
    - `isEquipmentAtDropOff` boolean — A flag indicating if the stock at the drop-off location is equipment
    - `ownerId` integer, nullable — The identifier of the owner related to the stock movement
    - `ownerName` string, nullable — The name of the individual or entity who owns the stock movement
    - `invoiceId` integer, nullable — The unique identifier of the invoice associated with the stock usage or movement
    - `pickupContactId` integer, nullable — The unique identifier of the contact at the pickup location
    - `dropOffContactId` integer, nullable — The unique identifier of the contact at the drop-off location
    - `pickUpQuantity` number, double, nullable — The count of stock units that were picked up
    - `dropOffQuantity` number, double, nullable — The count of stock units that were delivered
  - `pageNumber` integer — The page number of the response where 1 is the first page
  - `pageSize` integer — The number of items requested for the current page
  - `pageItemCount` integer — The number of items returned in the current page

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.net/bigchange/apis/bigchange-dx.md) · [All operations](https://skmtc.net/bigchange/apis/bigchange-dx/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bigchange/bigchange-dx/revisions/916e669fc527/schema)
