Skip to main content
POST
/
material
Create material
curl --request POST \
  --url https://api.truecold.io/material \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "material_code": "<string>",
  "material_name": "<string>",
  "allowance": 123,
  "temperature_range_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "TOR_bucket_hours": 123,
  "min": 123,
  "max": 123
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "material_code": "<string>",
  "material_name": "<string>",
  "allowance": 123,
  "temperature_range_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "max": 123,
  "min": 123,
  "soft_deleted": "2023-11-07T05:31:56Z",
  "soft_deleted_by": "<string>",
  "TOR_bucket_hours": 123,
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

API key for authentication. Contact your administrator to get an API key.

Body

application/json

Material input data for creation/update

material_code
string

Material code

material_name
string

Material name

allowance
number

Material allowance

temperature_range_id
string<uuid>

Temperature range ID of the material

TOR_bucket_hours
number

TOR bucket hours

min
number

Minimum temperature allowed by the material (ºC)

max
number

Maximum temperature allowed by the material (ºC)

Response

Successfully created material

Material entity (API response)

id
string<uuid>

Unique identifier

created_at
string<date-time>

Creation timestamp

account_id
string<uuid>

Account ID

material_code
string

material code

material_name
string

material name

allowance
integer

Allowance

temperature_range_id
string<uuid>

Temperature range ID

max
number

Max

min
number

Min

soft_deleted
string<date-time>

Soft deletion timestamp

soft_deleted_by
string

User who soft deleted the record

TOR_bucket_hours
integer

TOR Bucket Hours

updated_at
string<date-time>

Last update timestamp