OfficeGest
Stocks/Movements

List stock movements

Returns stock movements ordered by movement number ascending, paginated by cursor: follow meta.next to the last page. Supports optional filtering by movement date range, type and warehouse.

GET
/stocks/movements
AuthorizationBearer <token>

In: header

Query Parameters

cursor?string

Opaque cursor taken from meta.next or meta.previous; omit it for the first page. A cursor that was changed, or that was issued for another sort, answers 422 INVALID_CURSOR. There are no page numbers: sending page answers 422.

sort?string

Field to sort by: movement_type_id, warehouse_enter_id or warehouse_exit_id, prefixed with - for descending. Ties are ordered by id in the same direction.

movement_type_id?stringDeprecated
warehouse_enter_id?integerDeprecated
warehouse_exit_id?integerDeprecated
filter[movement_type_id][operator]?string

Filter by movement type code. Operators: eq. Example: filter[movement_type_id][eq]=value

filter[warehouse_enter_id][operator]?integer

Filter by entry warehouse identifier. Operators: eq. Example: filter[warehouse_enter_id][eq]=value

filter[warehouse_exit_id][operator]?integer

Filter by exit warehouse identifier. Operators: eq. Example: filter[warehouse_exit_id][eq]=value

filter[start_date]?string

Filter movements with date on or after this value (Y-m-d).

Formatdate
filter[end_date]?string

Filter movements with date on or before this value (Y-m-d).

Formatdate
limit?integer

Items per page. Default 50, maximum 250; a larger value is truncated to 250.

Default50
Range1 <= value <= 250

Response Body

curl -X GET "https://og-tenant1.test:8003/api/v2/stocks/movements?cursor=string&sort=string&movement_type_id=string&warehouse_enter_id=0&warehouse_exit_id=0&filter%5Bmovement_type_id%5D%5Boperator%5D=string&filter%5Bwarehouse_enter_id%5D%5Boperator%5D=0&filter%5Bwarehouse_exit_id%5D%5Boperator%5D=0&filter%5Bstart_date%5D=2019-08-24&filter%5Bend_date%5D=2019-08-24&limit=50"
{
  "data": [
    {
      "id": "string",
      "description": "string",
      "movement_type": {},
      "warehouse_enter": {},
      "warehouse_exit": {},
      "annulled": true,
      "date": "2019-08-24",
      "register_date": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "next": "string",
    "previous": "string",
    "has_more": true,
    "per_page": 50
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}