PATCH /stocks/stock-status/{stockStatus}

Update a Stock Status

This endpoint allows you to update a Stock Status. A stock status corresponds to an existing stock in a warehouse for a material.

Operation ID: updateStockStatus

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

Path Parameters

Name	Type	Description
`stockStatus` required path	string	The stock status ID

Request Body

Content-Type: application/json

minimum_quantity integer

Minimum quantity

Example: 10

mean_price number

Mean price

Example: 10.5

observations string

Observations about the stock status update

Example: Stock status updated to in stock

Responses

data object

StockStatus model structure details

id string required read-only

ID of the StockStatus

type string required read-only

Model type

stock-status

attributes object required

material_id integer read-only

ID of the Material

Example: 1

warehouse_id integer read-only

ID of the Warehouse

Example: 1

quantity number read-only

Quantity of the material present in the warehouse

mean_price number | null read-only

Mean price of the material associated with the warehouse

observations string | null read-only

Description or notes

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

Path Parameters

stockStatus

Request Body

PATCH https://api.sandbox.infraspeak.com/v3/stocks/stock-status/{stockStatus}

curl -X PATCH \
  'https://api.sandbox.infraspeak.com/v3/stocks/stock-status/{stockStatus}' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -d '{
    "minimum_quantity": 10,
    "mean_price": 10.5,
    "observations": "Stock status updated to in stock"
}'

const response = await fetch('https://api.sandbox.infraspeak.com/v3/stocks/stock-status/{stockStatus}', {
  method: 'PATCH',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_TOKEN',
  },
  body: JSON.stringify({
    "minimum_quantity": 10,
    "mean_price": 10.5,
    "observations": "Stock status updated to in stock"
}),
});

const data = await response.json();

$response = Http::withHeaders([
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
])->withToken('YOUR_API_TOKEN')
  ->patch('https://api.sandbox.infraspeak.com/v3/stocks/stock-status/{stockStatus}',
    array (
      'minimum_quantity' => 10,
      'mean_price' => 10.5,
      'observations' => 'Stock status updated to in stock',
    )
  );

import requests

response = requests.patch(
    'https://api.sandbox.infraspeak.com/v3/stocks/stock-status/{stockStatus}',
    headers={
        'Accept': 'application/json',
        'Content-Type': 'application/json',
        'Authorization': 'Bearer YOUR_API_TOKEN',
    },
    json={
        {
            "minimum_quantity": 10,
            "mean_price": 10.5,
            "observations": "Stock status updated to in stock"
        }
    },
)

data = response.json()

data_object Example Response

200 OK

{
    "data": {
        "id": "string",
        "type": "stock-status",
        "attributes": {
            "material_id": 1,
            "warehouse_id": 1,
            "quantity": 0,
            "mean_price": 0,
            "observations": "string"
        }
    }
}

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