Inventory Pro
Skip to main content

Contents

api

Quickstart

Quickstart

This guide walks you through authenticating with the API and making your first requests. You’ll get a token, list items, and create a new item — all from the command line.

Prerequisites

You need: API credentials (client ID and secret), your base URL, and curl or PowerShell.

Step 1: Get a Token

curl -X POST https://your-host/api/v2/Token \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET"
{
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1Ni...",
  "token_type": "bearer",
  "expires_in": 14399
}

Save the access_token — include it in every subsequent request. PowerShell users: see Authentication for an Invoke-RestMethod equivalent.

Step 2: List Items

curl "https://your-host/api/v2/Item?page=1&pageSize=5" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
{
  "value": [
    {
      "partNo": 1,
      "shortId": "BOLT-M8",
      "description": "Hex Bolt M8x30",
      "category": 5,
      "uom": 1
    }
  ],
  "totalCount": 2340,
  "page": 1,
  "pageSize": 5,
  "pageCount": 468,
  "hasMore": true
}

Step 3: Get a Single Item

curl "https://your-host/api/v2/Item/BOLT-M8-30?type=id" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

The response is the full item object — no paging wrapper. Items are looked up by ShortID (type=id), or by alias with ?type=alias.

Step 4: Create an Item

curl -X POST https://your-host/api/v2/Item \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ShortID": "TEST-API-001",
    "Description": "Created via API"
  }'
{
  "shortId": "TEST-API-001",
  "status": "created"
}

A 200 OK response confirms the item was created. Note that the write body uses the Parts entity field names (PascalCase) — ShortID is required.

Note: A 403 response means your credentials lack write access to the item master.

What’s Next

On this page