Inventory

Inventory items are physical goods you sell or use on jobs — replacement parts, accessories, consumables. Each item has an SKU, optional GTIN, weight, and a stock count that you can let Servicebay track for you.

Endpoints

GET/organisations/{orgId}/inventory — List inventory items (paginated)
POST/organisations/{orgId}/inventory — Create inventory item
GET/organisations/{orgId}/inventory/{itemId} — Get inventory item
PUT/organisations/{orgId}/inventory/{itemId} — Update inventory item
DELETE/organisations/{orgId}/inventory/{itemId} — Delete inventory item

Server-side SKU lookup

Pass ?sku=BAT-001 to the list endpoint to perform an exact-match SKU query in Firestore. This is much faster than fetching everything and filtering client-side, and it doesn't count against the 100-row page limit.

List filters

Query param	Description
`limit`	Page size (max 100, default 50)
`startAfter`	Cursor — pass the previous response's `nextCursor`
`search`	Partial match on `itemName`, `description`, or `sku`
`sku`	Exact SKU match (server-side query)
`categoryId`	Filter to a single category

Authorization

apiKey

X-API-Key<token>

API key for authentication. Get your key from the Developer Dashboard.

In: header

Path Parameters

orgId*string

Organisation ID

Query Parameters

limit?integer

Maximum number of items to return (max 100)

Default50

Range1 <= value <= 100

startAfter?string

Cursor for pagination - ID of the last item from previous page

categoryId?string

sku?string

Exact SKU lookup

search?string

Response Body

`application/json`

curl -X GET "https://developer.servicebay.io/api/v1/organisations/string/inventory"

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "string",
        "itemName": "string",
        "description": "string",
        "categoryId": "string",
        "gtin": "string",
        "sku": "string",
        "price": 0,
        "weight": 0,
        "weightUnit": "g",
        "stockCount": 0,
        "tracksStock": true,
        "warranty": true,
        "warrantyPeriod": "day",
        "warrantyDuration": 0,
        "quantity": 0,
        "taxRateId": "string",
        "index": 0,
        "createdAt": "2019-08-24T14:15:22Z"
      }
    ],
    "pagination": {
      "limit": 0,
      "hasMore": true,
      "nextCursor": "string"
    }
  }
}

Authorization

apiKey

X-API-Key<token>

API key for authentication. Get your key from the Developer Dashboard.

In: header

Path Parameters

orgId*string

Organisation ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

itemName*string

description?string

categoryId?string

gtin?string

sku?string

price?number

weight?number

weightUnit?string

Value in"g" | "kg" | "oz" | "lb"

stockCount?integer

tracksStock?boolean

warranty?boolean

warrantyPeriod?string

Value in"day" | "week" | "month" | "year"

warrantyDuration?integer

quantity?number

taxRateId?string

index?integer

Response Body

`application/json`

curl -X POST "https://developer.servicebay.io/api/v1/organisations/string/inventory" \  -H "Content-Type: application/json" \  -d '{    "itemName": "string"  }'

{
  "success": true,
  "data": {
    "id": "string",
    "itemName": "string",
    "description": "string",
    "categoryId": "string",
    "gtin": "string",
    "sku": "string",
    "price": 0,
    "weight": 0,
    "weightUnit": "g",
    "stockCount": 0,
    "tracksStock": true,
    "warranty": true,
    "warrantyPeriod": "day",
    "warrantyDuration": 0,
    "quantity": 0,
    "taxRateId": "string",
    "index": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
}

{
  "success": false,
  "error": "An error occurred"
}

Authorization

apiKey

X-API-Key<token>

API key for authentication. Get your key from the Developer Dashboard.

In: header

Path Parameters

orgId*string

Organisation ID

itemId*string

Response Body

`application/json`

curl -X GET "https://developer.servicebay.io/api/v1/organisations/string/inventory/string"

{
  "success": true,
  "data": {
    "id": "string",
    "itemName": "string",
    "description": "string",
    "categoryId": "string",
    "gtin": "string",
    "sku": "string",
    "price": 0,
    "weight": 0,
    "weightUnit": "g",
    "stockCount": 0,
    "tracksStock": true,
    "warranty": true,
    "warrantyPeriod": "day",
    "warrantyDuration": 0,
    "quantity": 0,
    "taxRateId": "string",
    "index": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
}

{
  "success": false,
  "error": "An error occurred"
}

{
  "success": false,
  "error": "An error occurred"
}

{
  "success": false,
  "error": "An error occurred"
}

Authorization

apiKey

X-API-Key<token>

API key for authentication. Get your key from the Developer Dashboard.

In: header

Path Parameters

orgId*string

Organisation ID

itemId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

itemName*string

description?string

categoryId?string

gtin?string

sku?string

price?number

weight?number

weightUnit?string

Value in"g" | "kg" | "oz" | "lb"

stockCount?integer

tracksStock?boolean

warranty?boolean

warrantyPeriod?string

Value in"day" | "week" | "month" | "year"

warrantyDuration?integer

quantity?number

taxRateId?string

index?integer

Response Body

`application/json`

curl -X PUT "https://developer.servicebay.io/api/v1/organisations/string/inventory/string" \  -H "Content-Type: application/json" \  -d '{    "itemName": "string"  }'

{
  "success": true,
  "data": {
    "id": "string",
    "itemName": "string",
    "description": "string",
    "categoryId": "string",
    "gtin": "string",
    "sku": "string",
    "price": 0,
    "weight": 0,
    "weightUnit": "g",
    "stockCount": 0,
    "tracksStock": true,
    "warranty": true,
    "warrantyPeriod": "day",
    "warrantyDuration": 0,
    "quantity": 0,
    "taxRateId": "string",
    "index": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
}

{
  "success": false,
  "error": "An error occurred"
}

{
  "success": false,
  "error": "An error occurred"
}

{
  "success": false,
  "error": "An error occurred"
}

{
  "success": false,
  "error": "An error occurred"
}

Authorization

apiKey

X-API-Key<token>

API key for authentication. Get your key from the Developer Dashboard.

In: header

Path Parameters

orgId*string

Organisation ID

itemId*string

Response Body

`application/json`

curl -X DELETE "https://developer.servicebay.io/api/v1/organisations/string/inventory/string"

{
  "success": true,
  "data": {
    "message": "Operation completed successfully"
  }
}

{
  "success": false,
  "error": "An error occurred"
}

{
  "success": false,
  "error": "An error occurred"
}

{
  "success": false,
  "error": "An error occurred"
}

Machine-readable version: OpenAPI 3.1 spec.

Inventory

200application/json

201application/json

400application/json

200application/json

401application/json

403application/json

404application/json

200application/json

400application/json

401application/json

403application/json

404application/json

200application/json

401application/json

403application/json

404application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`