GET /stocks/stock-transactions

List all the stock transactions

This endpoint allows you to list all the stock transactions.

Operation ID: getAllStockTransactions

lock This endpoint requires a Bearer token in the Authorization header.

Query Parameters

Name	Type	Description
`sort` query	string	he name of the attribute to use for sort order
`order` query	string	The direction of the sort order `asc` `desc`
`page` query	integer	The page number (1-based) to retrieve the results, according to the `limit` defined
`limit` query	integer	Limit to restrict the number of entries per page
`warehouse_id` query	string	Filter by warehouse id
`material_id` query	string	Filter by material id
`expand` query	string	Comma-separated list of relations to include in the response `operator`
`s_warehouse_id` query	string	Filter by warehouse id
`s_material_id` query	string	Filter by material id
`date_min_created_at` query	string	Filter by minimum created_at.
`date_max_created_at` query	string	Filter by maximum created_at.
`date_min_updated_at` query	string	Filter by minimum updated_at.
`date_max_updated_at` query	string	Filter by maximum updated_at.
`s_operator_id` query	string	Filter by operator id

Responses

data object

StockTransaction model structure details

id string read-only

ID of the transaction

type string read-only

Model type

stock-transaction

attributes object

warehouse_id integer

ID of the warehouse

Example: 1

material_id integer

ID of the material

Example: 1

quantity integer

Transaction's quantity

Example: 25

action string

Transaction's action

ADD SUBTRACT

Example: SUBTRACT

observations string | null

Transaction's observations

cost_price integer

Transaction's associated price

Example: 25

created_at string

Transaction's created date

Example: 2024-08-16T13:33:39.000000Z

operator_id integer

ID of the operator

Example: 1

stock_transaction_batch_id integer read-only

ID of the parent transaction batch

Example: 1

status string

error

error object

properties object

Only present when related to property validation error

dev_message string

Example: Property validation error. Check the "properties" section in the response.

http_code integer

400

message string

Example: Property validation error.

more_info string

status string

error

error object

http_code integer

401

message string

Example: Authentication token invalid.

more_info string

status string

error

error object

http_code integer

429

message string

Example: Too Many Requests.

more_info string

status string

error

error object

http_code integer

500

message string

Example: An error has occurred during the request.

more_info string

play_circle Try It

Environment

Authorization

Bearer

filter_alt Filters

Sort

Pagination

GET https://api.sandbox.infraspeak.com/v3/stocks/stock-transactions

curl -X GET \
  'https://api.sandbox.infraspeak.com/v3/stocks/stock-transactions' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.sandbox.infraspeak.com/v3/stocks/stock-transactions', {
  method: 'GET',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_TOKEN',
  },
});

const data = await response.json();

$response = Http::withHeaders([
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
])->withToken('YOUR_API_TOKEN')
  ->get('https://api.sandbox.infraspeak.com/v3/stocks/stock-transactions');

import requests

response = requests.get(
    'https://api.sandbox.infraspeak.com/v3/stocks/stock-transactions',
    headers={
        'Accept': 'application/json',
        'Content-Type': 'application/json',
        'Authorization': 'Bearer YOUR_API_TOKEN',
    },
)

data = response.json()

data_object Example Response

200 OK

{
    "data": {
        "id": "string",
        "type": "stock-transaction",
        "attributes": {
            "warehouse_id": 1,
            "material_id": 1,
            "quantity": 25,
            "action": "SUBTRACT",
            "observations": "string",
            "cost_price": 25,
            "created_at": "2024-08-16T13:33:39.000000Z",
            "operator_id": 1,
            "stock_transaction_batch_id": 1
        }
    }
}

400 Bad Request. Occurs when invalid parameters are provided or on data validation errors. For example, trying to create a resource without providing required fields. In this case, you can check the `properties` attribute on the response for more details.

{
    "status": "error",
    "error": {
        "properties": {},
        "dev_message": "Property validation error. Check the \"properties\" section in the response.",
        "http_code": 400,
        "message": "Property validation error.",
        "more_info": "string"
    }
}

401 Unauthorized. Authentication or permission error. E.g.: missing, incorrect or invalid Access Token.

{
    "status": "error",
    "error": {
        "http_code": 401,
        "message": "Authentication token invalid.",
        "more_info": "string"
    }
}

429 Too Many Requests. The client has sent too many requests in a given amount of time (check Throttling section).

{
    "status": "error",
    "error": {
        "http_code": 429,
        "message": "Too Many Requests.",
        "more_info": "string"
    }
}

500 Internal Server Error. Please, report us and try to provide as much information as possible, such as the endpoint, HTTP request headers and request body if applicable.

{
    "status": "error",
    "error": {
        "http_code": 500,
        "message": "An error has occurred during the request.",
        "more_info": "string"
    }
}