List components

GET

/api/v1/components

curl --request GET \
  --url 'https://api.stocksmith.io/api/v1/components?state=active' \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• bearer_auth

Parameters

Query Parameters

page

integer

Page number (default: 1)

per_page

integer

Results per page (default: 25, max: 100)

state

string

Allowed values: active archived all

Filter by state. Defaults to ‘active’.

name

string

Partial name filter (case-insensitive substring match)

sku

string

Exact SKU/code filter (case-insensitive)

category_name

string

Partial category name filter (case-insensitive substring match)

Responses

200

Paginated list of components

Media type application/json

object

components

required

Array<object>

object

id

required

integer

name

required

string

sku

string

nullable

output_type

required

string

category

string

nullable

default_variation_id

ID of the default active variation, or null if archived

integer

nullable

variations

required

Array<object>

object

id

integer

name

string

nullable

sku

string

nullable

default

boolean

stock_on_hand

Decimal string

string

committed_stock

Decimal string

string

available_stock

Decimal string

string

low_stock_limit

Decimal string

string

state

string

Allowed values: active archived

attributes

Array<object>

object

label

string

nullable

value

string

unit_price

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

string format: date-time

updated_at

string format: date-time

stock_on_hand

required

Decimal string

string

committed_stock

required

Decimal string

string

available_stock

required

Decimal string

string

low_stock_limit

required

Decimal string

string

state

required

string

Allowed values: active archived

unit_price

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

meta

required

object

current_page

required

integer

total_pages

required

integer

total_count

required

integer

per_page

required

integer

Example

{
  "components": [
    {
      "output_type": "component",
      "variations": [
        {
          "state": "active"
        }
      ],
      "state": "active"
    }
  ]
}

401

Missing or invalid Bearer token

Media type application/json

object

error

required

Error message

string

Example ^generated

{
  "error": "example"
}