Retrieve a material

GET

/api/v1/materials/{id}

curl --request GET \
  --url https://api.stocksmith.io/api/v1/materials/1 \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• bearer_auth

Parameters

Path Parameters

id

required

integer

Material ID

Responses

200

Material details

Media type application/json

object

material

required

object

id

required

integer

name

required

string

sku

string

nullable

unit_measure

Unit of measure name, e.g. ‘grams’

string

nullable

category

string

nullable

stock_on_hand

required

Decimal string

string

committed_stock

required

Decimal string (always ‘0’ for materials)

string

available_stock

required

Decimal string

string

reorder_level

required

Decimal string

string

on_order

required

Decimal string, stock units (not purchase units)

string

state

required

string

Allowed values: active archived

unit_cost

Omitted for view-only users.

object

amount

Decimal string, e.g. ‘8.75’

string

currency_code

ISO 4217 code, e.g. ‘USD’

string

created_at

required

string format: date-time

updated_at

required

string format: date-time

Example

{
  "material": {
    "state": "active"
  }
}

401

Missing or invalid Bearer token

Media type application/json

object

error

required

Error message

string

Example ^generated

{
  "error": "example"
}

404

Material not found

Media type application/json

object

error

required

Error message

string

Example ^generated

{
  "error": "example"
}