MobiariDocs
Admin APIManufacturing

List components

GET
/stores/{store_id}/components

Every part of the store (variants created as parts or used in a bill of materials) with stock, how many kits use it, and what open build jobs still need. Biggest shortfall first.

Authorization

bearer_auth
AuthorizationBearer <token>

Authorization: Bearer <token>. Either a session access token from POST /auth/login (refresh it with POST /auth/refresh) or a store API token (mobi_st_…). A store API token works only for the store it was issued in, and can do at most what its issuing user can there, narrowed to the scopes it was issued with.

In: header

Path Parameters

store_id*string

Store id

Formatuuid

Query Parameters

search?string

Matches SKU, name or product title.

short_only?boolean

Only components whose open build demand exceeds what is available: what is blocking production.

limit?integer

Page size, 1 to 200. Defaults to 50.

Formatint64
Range1 <= value <= 200
cursor?string

next_cursor from the previous page. Omit for the first page.

offset?integer

Rows to skip, for UIs that jump to a page number. Ignored when cursor is set. Prefer cursor for walking a whole list.

Formatint64
Range0 <= value
include_total?boolean

Also return total, the count of all matching rows. Costs an extra query; leave off when you only walk pages.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/stores/497f6eca-6276-4993-bfeb-53cbbbba6f08/components?limit=50"
{
  "data": [
    {
      "allow_backorder": true,
      "available": 0,
      "cost_cents": 0,
      "height_cm": 0,
      "is_active": true,
      "length_cm": 0,
      "name": "string",
      "on_hand": 0,
      "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
      "product_name": "string",
      "product_status": "string",
      "reorder_point": 0,
      "required_open": 0,
      "reserved": 0,
      "shortfall": 0,
      "sku": "string",
      "used_in_kits": 0,
      "variant_id": "8a2d415d-59aa-4132-bef3-011f97c4a0f6",
      "weight_grams": 0,
      "width_cm": 0
    }
  ],
  "has_more": true,
  "next_cursor": "string",
  "total": 0
}
{
  "code": "not_found",
  "details": {},
  "error": "Order not found"
}
{
  "code": "not_found",
  "details": {},
  "error": "Order not found"
}
{
  "code": "not_found",
  "details": {},
  "error": "Order not found"
}
{
  "code": "not_found",
  "details": {},
  "error": "Order not found"
}