GET /stocks/materials/{materialId}/registry

Get the Material Registry

This endpoint allows you to get the Material Registry.

Operation ID: getStockMaterialRegistry

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

Path Parameters

Name	Type	Description
`materialId` required path	string	The Material ID

Query Parameters

Name	Type	Description
`expanded` query	string	Comma-separated list of relations to include in the response `operator`

Responses

data object

Material Registry model structure details

id string read-only

ID of the material registry

Example: 1

type string read-only

Model type

stock-material-registry

Example: stock-material-registry

attributes object

material_registry_id integer read-only

ID of the material registry

Example: 1

material_id integer read-only

ID of the material

Example: 1

operator_id integer

ID of the operator

Example: 1

action string

Action of the operation

CREATED UPDATED DELETED

Example: CREATED

field string

The field we changed the value

CODE NAME OBSERVATIONS DESCRIPTION SKU EAN_UPC UNITS SALE_PRICE SALE_VAT MATERIAL_TYPE PURCHASE_CONSUMPTION_TYPE

Example: CODE

from string

The warehouse id material was transfered from

Example: 1

to string

The warehouse id material was transfered to

Example: 2

aux_id string

Field auxiliary ID, for example, the associated material type id

Example: 12

created_at string (date-time)

Date of creation

Example: 2021-01-01 00:00:00

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

404

message string

Example: Resource not found

more_info string | null

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

Path Parameters

materialId

filter_alt Filters

Pagination

check operator

GET https://api.sandbox.infraspeak.com/v3/stocks/materials/{materialId}/registry

curl -X GET \
  'https://api.sandbox.infraspeak.com/v3/stocks/materials/{materialId}/registry' \
  -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/materials/{materialId}/registry', {
  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/materials/{materialId}/registry');

import requests

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

data = response.json()

data_object Example Response

200 OK

{
    "data": {
        "id": "1",
        "type": "stock-material-registry",
        "attributes": {
            "material_registry_id": 1,
            "material_id": 1,
            "operator_id": 1,
            "action": "CREATED",
            "field": "CODE",
            "from": "1",
            "to": "2",
            "aux_id": "12",
            "created_at": "2021-01-01 00:00:00"
        }
    }
}

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"
    }
}

404 Resource Not Found. Requests to resources that don't exist or are malformed.

{
    "status": "error",
    "error": {
        "http_code": 404,
        "message": "Resource not found",
        "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"
    }
}