OfficeGest
Stocks/Recounts

List recounts

Returns a paginated list of stock recount documents ordered by identifier descending. Supports filtering by warehouse, status, date range, family, subfamily and brand.

GET
/stocks/recounts
AuthorizationBearer <token>

In: header

Query Parameters

warehouse_id?integerDeprecated
status?stringDeprecated
family_id?stringDeprecated
sub_family_id?stringDeprecated
brand_id?stringDeprecated
sector_id?integerDeprecated
filter[warehouse_id][operator]?integer

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

filter[status][operator]?string

Filter by status: A (open), F (closed). Operators: eq. Example: filter[status][eq]=value

filter[family_id][operator]?string

Filter by article family. Operators: eq. Example: filter[family_id][eq]=value

filter[sub_family_id][operator]?string

Filter by article subfamily. Operators: eq. Example: filter[sub_family_id][eq]=value

filter[brand_id][operator]?string

Filter by brand code. Operators: eq. Example: filter[brand_id][eq]=value

filter[sector_id][operator]?integer

Filter by sector identifier (SETORES module). Operators: eq. Example: filter[sector_id][eq]=value

filter[start_date]?string

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

Formatdate
filter[end_date]?string

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

Formatdate
page?integer

Page number. Default 1; a value below 1 counts as 1.

Default1
Range1 <= value
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/recounts?warehouse_id=0&status=string&family_id=string&sub_family_id=string&brand_id=string&sector_id=0&filter%5Bwarehouse_id%5D%5Boperator%5D=0&filter%5Bstatus%5D%5Boperator%5D=string&filter%5Bfamily_id%5D%5Boperator%5D=string&filter%5Bsub_family_id%5D%5Boperator%5D=string&filter%5Bbrand_id%5D%5Boperator%5D=string&filter%5Bsector_id%5D%5Boperator%5D=0&filter%5Bstart_date%5D=2019-08-24&filter%5Bend_date%5D=2019-08-24&page=1&limit=50"
{
  "data": [
    {
      "id": 0,
      "description": "string",
      "date": "2019-08-24",
      "status": "A",
      "warehouse_id": 0,
      "warehouse": {},
      "family_id": "string",
      "family_name": "string",
      "sub_family_id": "string",
      "sub_family_name": "string",
      "brand_id": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "sector_id": 0,
      "sector_name": "string",
      "sector_barcode": "string"
    }
  ],
  "meta": {
    "per_page": 50,
    "current_page": 1,
    "has_more": true
  }
}
{
  "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"
  }
}