PATCH /stocks/materials/{materialId}

Update a material

This endpoint allows you to update a specific material.

Operation ID: updateStockMaterial

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 `material_type` `warehouse` `supplier_custom_price`

Request Body

Content-Type: application/json · Required fields: material_type_id, name, code, units

name string required

Name of the material

Example: Chair

code string required

Code of the material. It must be unique

Example: CH-0001

description string | null

Description of the material

Example: This is a chair

units string required

What unit should this item be measured with

Example: un

material_type_id integer required

Material type id

Example: 1

observations string | null

Material observations

Example: This is an observation

sku string | null

SKU of the material

Example: SKU-00001

ean_upc string | null

EAN/UPC of the material

Example: 1234567890123

purchase_consumption_type string

Purchase consumption type of the material

INHERIT AUTOMATIC MANUAL

Responses

data object

Material model structure details

id string required read-only

ID of the Material

Example: 1

type string required read-only

Model type

stock-material

Example: stock-material

attributes object required

material_id string read-only

ID of the material

Example: 1

material_type_id string read-only

ID of the material type

Example: 11

name string

Name of the material

Example: Chair

code string

Code of the material

Example: CH-00001

purchase_consumption_type string

Purchase consumption type of the material

INHERIT AUTOMATIC MANUAL

Example: INHERIT

units string

Indicates which kind of unit should this material be measured with

Example: un

observations string | null

Material observations

Example: This is a observation

description string

Description of the material

Example: This is a chair

sku string | null

SKU of the material

Example: SKU-00001

ean_upc string | null

EAN/UPC of the material

Example: 1234567890123

sale_price number

Sale price of the material

Example: 10

sale_vat number

Sale VAT of the material

Example: 23

created_at string | null read-only

Date of creation

Example: 2021-07-21 18:38:00

updated_at string | null read-only

Last update date

Example: 2021-07-21 18:38:00

warehouses_minimum_stocks array<object>

warehouse_id integer

Example: 1

warehouse_name string

Example: Warehouse

minimum_quantity integer

Example: 10

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

check material_type check supplier_custom_price check warehouse

Request Body

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

curl -X PATCH \
  'https://api.sandbox.infraspeak.com/v3/stocks/materials/{materialId}' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -d '{
    "name": "Chair",
    "code": "CH-0001",
    "description": "This is a chair",
    "units": "un",
    "material_type_id": 1,
    "observations": "This is an observation",
    "sku": "SKU-00001",
    "ean_upc": "1234567890123",
    "purchase_consumption_type": ""
}'

const response = await fetch('https://api.sandbox.infraspeak.com/v3/stocks/materials/{materialId}', {
  method: 'PATCH',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_TOKEN',
  },
  body: JSON.stringify({
    "name": "Chair",
    "code": "CH-0001",
    "description": "This is a chair",
    "units": "un",
    "material_type_id": 1,
    "observations": "This is an observation",
    "sku": "SKU-00001",
    "ean_upc": "1234567890123",
    "purchase_consumption_type": ""
}),
});

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/materials/{materialId}',
    array (
      'name' => 'Chair',
      'code' => 'CH-0001',
      'description' => 'This is a chair',
      'units' => 'un',
      'material_type_id' => 1,
      'observations' => 'This is an observation',
      'sku' => 'SKU-00001',
      'ean_upc' => '1234567890123',
      'purchase_consumption_type' => '',
    )
  );

import requests

response = requests.patch(
    'https://api.sandbox.infraspeak.com/v3/stocks/materials/{materialId}',
    headers={
        'Accept': 'application/json',
        'Content-Type': 'application/json',
        'Authorization': 'Bearer YOUR_API_TOKEN',
    },
    json={
        {
            "name": "Chair",
            "code": "CH-0001",
            "description": "This is a chair",
            "units": "un",
            "material_type_id": 1,
            "observations": "This is an observation",
            "sku": "SKU-00001",
            "ean_upc": "1234567890123",
            "purchase_consumption_type": ""
        }
    },
)

data = response.json()

data_object Example Response

200 OK

{
    "data": {
        "id": "1",
        "type": "stock-material",
        "attributes": {
            "material_id": "1",
            "material_type_id": "11",
            "name": "Chair",
            "code": "CH-00001",
            "purchase_consumption_type": "INHERIT",
            "units": "un",
            "observations": "This is a observation",
            "description": "This is a chair",
            "sku": "SKU-00001",
            "ean_upc": "1234567890123",
            "sale_price": 10,
            "sale_vat": 23,
            "created_at": "2021-07-21 18:38:00",
            "updated_at": "2021-07-21 18:38:00",
            "warehouses_minimum_stocks": {
                "warehouse_id": 1,
                "warehouse_name": "Warehouse",
                "minimum_quantity": 10
            }
        }
    }
}

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