Inventory

List inventory items for a company

GET

https://api.gosmarter.ai

/api/company/{companyId}/inventory-slim

Retrieves all inventory items belonging to the specified company. Supports optimisation scenarios by returning key product and section metadata.

List inventory items for a company › path Parameters

companyId

string · uuid · required

The unique identifier of the company. Example: 11111111-2222-3333-4444-555555555555

List inventory items for a company › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List inventory items for a company › Responses

List of inventory items retrieved successfully

object[]

createdAt

string · date-time

Timestamp when the record was created (UTC)

updatedAt

string · date-time

Timestamp when the record was last updated (UTC)

millCertificationId

string · uuid

Mill certification ID if inventory is linked to a mill cert via heat code

linkedOrders

string

JSON array string of linked orders in format '[{"orderId":"...","orderReference":"..."},...]'. '[]' when no orders are linked.

typeLabel

string

Resolved label for Type

materialLabel

string

Resolved label for Material

supplierName

string

Resolved name for Supplier (from Organisations)

stockLocationLabel

string

Resolved label for Stock Location (from CompanyStockLocations)

quantity

integer · int32

Number of pieces available

weight

number · double

Total weight in kilograms

heatCode

string

Heat code for traceability

diameter

integer · int32

Diameter in millimetres

length

integer · int32

Length dimension (mm)

width

integer · int32

Width dimension (mm)

depth

integer · int32

Depth dimension (mm)

type

integer · int32

Type reference (FK to InventoryTypes)

material

integer · int32

Material reference (FK to InventoryMaterials)

supplierId

string · uuid

Supplier reference (FK to Organisations)

stockLocationId

integer · int32

Stock location reference (FK to CompanyStockLocations)

inventoryId

string · uuid

Unique identifier for the inventory record

companyId

string · uuid

Identifier of the owning company

productName

string

Human readable product name

unitPrice

number · double

Unit price in company currency

GET/api/company/{companyId}/inventory-slim

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/inventory-slim \
  --header 'Authorization: <string>'

shell

Example Responses

[
  {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "millCertificationId": "00000000-0000-0000-0000-000000000000",
    "linkedOrders": "linkedOrders",
    "typeLabel": "typeLabel",
    "materialLabel": "materialLabel",
    "supplierName": "supplierName",
    "stockLocationLabel": "stockLocationLabel",
    "quantity": 0,
    "weight": 0,
    "heatCode": "heatCode",
    "diameter": 0,
    "length": 0,
    "width": 0,
    "depth": 0,
    "type": 0,
    "material": 0,
    "supplierId": "00000000-0000-0000-0000-000000000000",
    "stockLocationId": 0,
    "inventoryId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "productName": "productName",
    "unitPrice": 0
  }
]

json

application/json

Update existing inventory items

PUT

https://api.gosmarter.ai

/api/company/{companyId}/inventory-slim

Updates one or more existing inventory items. Each item must belong to the specified company and will be validated before persistence.

Update existing inventory items › path Parameters

companyId

string · uuid · required

The unique identifier of the company for which items are updated. Example: 11111111-2222-3333-4444-555555555555

Update existing inventory items › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update existing inventory items › Request Body

object[]

quantity

integer · int32

Number of pieces available

weight

number · double

Total weight in kilograms

heatCode

string

Heat code for traceability

diameter

integer · int32

Diameter in millimetres

length

integer · int32

Length dimension (mm)

width

integer · int32

Width dimension (mm)

depth

integer · int32

Depth dimension (mm)

type

integer · int32

Type reference (FK to InventoryTypes)

material

integer · int32

Material reference (FK to InventoryMaterials)

supplierId

string · uuid

Supplier reference (FK to Organisations)

stockLocationId

integer · int32

Stock location reference (FK to CompanyStockLocations)

inventoryId

string · uuid

Unique identifier for the inventory record

companyId

string · uuid

Identifier of the owning company

productName

string

Human readable product name

unitPrice

number · double

Unit price in company currency

Update existing inventory items › Responses

Inventory items updated successfully with enriched type and material labels

object[]

typeLabel

string

Resolved label for Type

materialLabel

string

Resolved label for Material

supplierName

string

Resolved name for Supplier (from Organisations)

stockLocationLabel

string

Resolved label for Stock Location (from CompanyStockLocations)

quantity

integer · int32

Number of pieces available

weight

number · double

Total weight in kilograms

heatCode

string

Heat code for traceability

diameter

integer · int32

Diameter in millimetres

length

integer · int32

Length dimension (mm)

width

integer · int32

Width dimension (mm)

depth

integer · int32

Depth dimension (mm)

type

integer · int32

Type reference (FK to InventoryTypes)

material

integer · int32

Material reference (FK to InventoryMaterials)

supplierId

string · uuid

Supplier reference (FK to Organisations)

stockLocationId

integer · int32

Stock location reference (FK to CompanyStockLocations)

inventoryId

string · uuid

Unique identifier for the inventory record

companyId

string · uuid

Identifier of the owning company

productName

string

Human readable product name

unitPrice

number · double

Unit price in company currency

PUT/api/company/{companyId}/inventory-slim

curl --request PUT \
  --url https://api.gosmarter.ai/api/company/:companyId/inventory-slim \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "quantity": 0,
    "weight": 0,
    "heatCode": "heatCode",
    "diameter": 0,
    "length": 0,
    "width": 0,
    "depth": 0,
    "type": 0,
    "material": 0,
    "supplierId": "00000000-0000-0000-0000-000000000000",
    "stockLocationId": 0,
    "inventoryId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "productName": "productName",
    "unitPrice": 0
  }
]
'

shell

Example Request Body

[
  {
    "quantity": 0,
    "weight": 0,
    "heatCode": "heatCode",
    "diameter": 0,
    "length": 0,
    "width": 0,
    "depth": 0,
    "type": 0,
    "material": 0,
    "supplierId": "00000000-0000-0000-0000-000000000000",
    "stockLocationId": 0,
    "inventoryId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "productName": "productName",
    "unitPrice": 0
  }
]

json

Example Responses

[
  {
    "typeLabel": "typeLabel",
    "materialLabel": "materialLabel",
    "supplierName": "supplierName",
    "stockLocationLabel": "stockLocationLabel",
    "quantity": 0,
    "weight": 0,
    "heatCode": "heatCode",
    "diameter": 0,
    "length": 0,
    "width": 0,
    "depth": 0,
    "type": 0,
    "material": 0,
    "supplierId": "00000000-0000-0000-0000-000000000000",
    "stockLocationId": 0,
    "inventoryId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "productName": "productName",
    "unitPrice": 0
  }
]

json

application/json

Create new inventory items

POST

https://api.gosmarter.ai

/api/company/{companyId}/inventory-slim

Creates one or more new inventory items for the specified company. Each item will be associated with the companyId provided in the route.

Create new inventory items › path Parameters

companyId

string · uuid · required

The unique identifier of the company under which items are created. Example: 11111111-2222-3333-4444-555555555555

Create new inventory items › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Create new inventory items › Request Body

object[]

quantity

integer · int32

Number of pieces available

weight

number · double

Total weight in kilograms

heatCode

string

Heat code for traceability

diameter

integer · int32

Diameter in millimetres

length

integer · int32

Length dimension (mm)

width

integer · int32

Width dimension (mm)

depth

integer · int32

Depth dimension (mm)

type

integer · int32

Type reference (FK to InventoryTypes)

material

integer · int32

Material reference (FK to InventoryMaterials)

supplierId

string · uuid

Supplier reference (FK to Organisations)

stockLocationId

integer · int32

Stock location reference (FK to CompanyStockLocations)

inventoryId

string · uuid

Unique identifier for the inventory record

companyId

string · uuid

Identifier of the owning company

productName

string

Human readable product name

unitPrice

number · double

Unit price in company currency

Create new inventory items › Responses

Inventory items created successfully with enriched type, material, and supplier labels

object[]

typeLabel

string

Resolved label for Type

materialLabel

string

Resolved label for Material

supplierName

string

Resolved name for Supplier (from Organisations)

stockLocationLabel

string

Resolved label for Stock Location (from CompanyStockLocations)

quantity

integer · int32

Number of pieces available

weight

number · double

Total weight in kilograms

heatCode

string

Heat code for traceability

diameter

integer · int32

Diameter in millimetres

length

integer · int32

Length dimension (mm)

width

integer · int32

Width dimension (mm)

depth

integer · int32

Depth dimension (mm)

type

integer · int32

Type reference (FK to InventoryTypes)

material

integer · int32

Material reference (FK to InventoryMaterials)

supplierId

string · uuid

Supplier reference (FK to Organisations)

stockLocationId

integer · int32

Stock location reference (FK to CompanyStockLocations)

inventoryId

string · uuid

Unique identifier for the inventory record

companyId

string · uuid

Identifier of the owning company

productName

string

Human readable product name

unitPrice

number · double

Unit price in company currency

POST/api/company/{companyId}/inventory-slim

curl --request POST \
  --url https://api.gosmarter.ai/api/company/:companyId/inventory-slim \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "quantity": 0,
    "weight": 0,
    "heatCode": "heatCode",
    "diameter": 0,
    "length": 0,
    "width": 0,
    "depth": 0,
    "type": 0,
    "material": 0,
    "supplierId": "00000000-0000-0000-0000-000000000000",
    "stockLocationId": 0,
    "inventoryId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "productName": "productName",
    "unitPrice": 0
  }
]
'

shell

Example Request Body

[
  {
    "quantity": 0,
    "weight": 0,
    "heatCode": "heatCode",
    "diameter": 0,
    "length": 0,
    "width": 0,
    "depth": 0,
    "type": 0,
    "material": 0,
    "supplierId": "00000000-0000-0000-0000-000000000000",
    "stockLocationId": 0,
    "inventoryId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "productName": "productName",
    "unitPrice": 0
  }
]

json

Example Responses

[
  {
    "typeLabel": "typeLabel",
    "materialLabel": "materialLabel",
    "supplierName": "supplierName",
    "stockLocationLabel": "stockLocationLabel",
    "quantity": 0,
    "weight": 0,
    "heatCode": "heatCode",
    "diameter": 0,
    "length": 0,
    "width": 0,
    "depth": 0,
    "type": 0,
    "material": 0,
    "supplierId": "00000000-0000-0000-0000-000000000000",
    "stockLocationId": 0,
    "inventoryId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "productName": "productName",
    "unitPrice": 0
  }
]

json

application/json

Delete inventory items

DELETE

https://api.gosmarter.ai

/api/company/{companyId}/inventory-slim

Soft deletes one or more inventory items by setting Active = 0. Temporal tables preserve the previous row state automatically.

Delete inventory items › path Parameters

companyId

string · uuid · required

The unique identifier of the company owning the items. Example: 11111111-2222-3333-4444-555555555555

Delete inventory items › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Delete inventory items › Request Body

string[]

Delete inventory items › Responses

Inventory items deleted successfully

deletedCount

integer · int32

Number of items deleted

deletedIds

string[]

List of IDs that were deleted

Download inventory as CSV

GET

https://api.gosmarter.ai

/api/company/{companyId}/inventory-slim/download

Downloads all inventory items for a company as a CSV file

Download inventory as CSV › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Download inventory as CSV › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Download inventory as CSV › Responses

CSV file with inventory data

string · binary

Evaluate inventory tags

POST

https://api.gosmarter.ai

/api/company/{companyId}/inventory-slim/{inventoryId}/tags/evaluate

Evaluates active inventory tag rules for a single inventory item and updates rule-based tag assignments.

Evaluate inventory tags › path Parameters

companyId

string · uuid · required

The unique identifier of the company

inventoryId

string · uuid · required

The unique identifier of the inventory item

Evaluate inventory tags › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Evaluate inventory tags › Responses

Evaluation completed

inventoryId

string · uuid

companyId

string · uuid

assignedTagCount

integer · int32

object[]

POST/api/company/{companyId}/inventory-slim/{inventoryId}/tags/evaluate

curl --request POST \
  --url https://api.gosmarter.ai/api/company/:companyId/inventory-slim/:inventoryId/tags/evaluate \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "inventoryId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "assignedTagCount": 0,
  "assignedTags": [
    {
      "assignmentId": "00000000-0000-0000-0000-000000000000",
      "inventoryId": "00000000-0000-0000-0000-000000000000",
      "tagId": "00000000-0000-0000-0000-000000000000",
      "assignedByRuleId": "00000000-0000-0000-0000-000000000000",
      "assignedAt": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Get an inventory item by ID

GET

https://api.gosmarter.ai

/api/company/{companyId}/inventory-slim/{inventoryId}

Retrieves a single inventory item by its unique ID within the specified company. Includes core metadata required for optimisation and reporting.

Get an inventory item by ID › path Parameters

companyId

string · uuid · required

The unique identifier of the company that owns the inventory item. Example: 11111111-2222-3333-4444-555555555555

inventoryId

string · uuid · required

The unique identifier of the inventory item to retrieve. Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Get an inventory item by ID › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get an inventory item by ID › Responses

Inventory item retrieved successfully

createdAt

string · date-time

Timestamp when the record was created (UTC)

updatedAt

string · date-time

Timestamp when the record was last updated (UTC)

millCertificationId

string · uuid

Mill certification ID if inventory is linked to a mill cert via heat code

linkedOrders

string

JSON array string of linked orders in format '[{"orderId":"...","orderReference":"..."},...]'. '[]' when no orders are linked.

typeLabel

string

Resolved label for Type

materialLabel

string

Resolved label for Material

supplierName

string

Resolved name for Supplier (from Organisations)

stockLocationLabel

string

Resolved label for Stock Location (from CompanyStockLocations)

quantity

integer · int32

Number of pieces available

weight

number · double

Total weight in kilograms

heatCode

string

Heat code for traceability

diameter

integer · int32

Diameter in millimetres

length

integer · int32

Length dimension (mm)

width

integer · int32

Width dimension (mm)

depth

integer · int32

Depth dimension (mm)

type

integer · int32

Type reference (FK to InventoryTypes)

material

integer · int32

Material reference (FK to InventoryMaterials)

supplierId

string · uuid

Supplier reference (FK to Organisations)

stockLocationId

integer · int32

Stock location reference (FK to CompanyStockLocations)

inventoryId

string · uuid

Unique identifier for the inventory record

companyId

string · uuid

Identifier of the owning company

productName

string

Human readable product name

unitPrice

number · double

Unit price in company currency

GET/api/company/{companyId}/inventory-slim/{inventoryId}

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/inventory-slim/:inventoryId \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "millCertificationId": "00000000-0000-0000-0000-000000000000",
  "linkedOrders": "linkedOrders",
  "typeLabel": "typeLabel",
  "materialLabel": "materialLabel",
  "supplierName": "supplierName",
  "stockLocationLabel": "stockLocationLabel",
  "quantity": 0,
  "weight": 0,
  "heatCode": "heatCode",
  "diameter": 0,
  "length": 0,
  "width": 0,
  "depth": 0,
  "type": 0,
  "material": 0,
  "supplierId": "00000000-0000-0000-0000-000000000000",
  "stockLocationId": 0,
  "inventoryId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "productName": "productName",
  "unitPrice": 0
}

json

application/json

Get inventory item change history

GET

https://api.gosmarter.ai

/api/company/{companyId}/inventory-slim/{inventoryId}/history

Returns field-level audit history for a specific inventory item, derived from SQL Server temporal tables.

Get inventory item change history › path Parameters

companyId

string · uuid · required

The unique identifier of the company

inventoryId

string · uuid · required

The unique identifier of the inventory item

Get inventory item change history › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get inventory item change history › Responses

List of audit events for the inventory item

object[]

changedAt

string · date-time

changedById

string · uuid

changedByName

string

changeType

string

object[]

entityType

string

entityLabel

string

Unreserve stock from the inventory page

DELETE

https://api.gosmarter.ai

/api/company/{companyId}/inventory-slim/{inventoryId}/reserve

Removes the reservation link(s) for an inventory item and renames the inventory row to 'OriginalName - Prev Reserved (OrderReference)'. Split rows are retained as standalone inventory (no quantity merge-back). Supports inventory-context mode: operates on all links for the given inventory item within the company.

Unreserve stock from the inventory page › path Parameters

companyId

string · uuid · required

The unique identifier of the company.

inventoryId

string · uuid · required

The inventory item to unreserve.

Unreserve stock from the inventory page › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Unreserve stock from the inventory page › Responses

Unreservation successful — returns all deleted link rows

object[]

linkId

string · uuid

companyId

string · uuid

orderLineItemId

string · uuid

inventoryId

string · uuid

Upload inventory from CSV

POST

https://api.gosmarter.ai

/api/company/{companyId}/inventory-slim/upload

Uploads and processes a CSV file to create or update inventory items in bulk

Upload inventory from CSV › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Upload inventory from CSV › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Upload inventory from CSV › Request Body

Upload inventory from CSV › Responses

CSV uploaded and processed successfully

Get CSV upload template

GET

https://api.gosmarter.ai

/api/company/{companyId}/inventory-slim/upload-template

Downloads a CSV template file with example inventory data for bulk uploads

Get CSV upload template › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Get CSV upload template › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get CSV upload template › Responses

CSV template file with examples

string · binary

InventoryTagRules Gateway