GoSmarter API Gateway

Inventory

Endpointhttps://api.gosmarter.ai

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 › 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

typeLabel

string

Resolved label for Type

materialLabel

string

Resolved label for Material

supplierName

string

Resolved name for Supplier (from Organisations)

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)

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

shell

Example Responses

[
  {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "millCertificationId": "00000000-0000-0000-0000-000000000000",
    "typeLabel": "typeLabel",
    "materialLabel": "materialLabel",
    "supplierName": "supplierName",
    "quantity": 0,
    "weight": 0,
    "heatCode": "heatCode",
    "diameter": 0,
    "length": 0,
    "width": 0,
    "depth": 0,
    "type": 0,
    "material": 0,
    "supplierId": "00000000-0000-0000-0000-000000000000",
    "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 › 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)

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)

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)

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 '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",
    "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",
    "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",
    "quantity": 0,
    "weight": 0,
    "heatCode": "heatCode",
    "diameter": 0,
    "length": 0,
    "width": 0,
    "depth": 0,
    "type": 0,
    "material": 0,
    "supplierId": "00000000-0000-0000-0000-000000000000",
    "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 › 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)

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)

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)

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 '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",
    "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",
    "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",
    "quantity": 0,
    "weight": 0,
    "heatCode": "heatCode",
    "diameter": 0,
    "length": 0,
    "width": 0,
    "depth": 0,
    "type": 0,
    "material": 0,
    "supplierId": "00000000-0000-0000-0000-000000000000",
    "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

Deletes one or more inventory items for the specified company using a stored procedure that enforces authorisation and ownership.

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 › Request Body

string[]

Delete inventory items › Responses

Inventory items deleted successfully

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

curl --request DELETE \
  --url https://api.gosmarter.ai/api/company/:companyId/inventory-slim \
  --header 'Content-Type: application/json' \
  --data '
[
  "00000000-0000-0000-0000-000000000000"
]
'

shell

Example Request Body

[
  "00000000-0000-0000-0000-000000000000"
]

json

Example Responses

{}

json

application/json

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 › Responses

CSV file with inventory data

string · binary

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

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/inventory-slim/download

shell

Example Responses

string

csv

text/csv

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 › 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

typeLabel

string

Resolved label for Type

materialLabel

string

Resolved label for Material

supplierName

string

Resolved name for Supplier (from Organisations)

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)

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

shell

Example Responses

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

json

application/json

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 › Request Body

Upload inventory from CSV › Responses

CSV uploaded and processed successfully

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

curl --request POST \
  --url https://api.gosmarter.ai/api/company/:companyId/inventory-slim/upload \
  --header 'Content-Type: application/json' \
  --data '{}'

shell

Example Request Body

{}

json

Example Responses

{}

json

application/json

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 › Responses

CSV template file with examples

string · binary

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

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/inventory-slim/upload-template

shell

Example Responses

string

csv

text/csv

Mill Certification Configuration

GoSmarter API Gateway

Inventory

Endpointhttps://api.gosmarter.ai

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 › 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

typeLabel

string

Resolved label for Type

materialLabel

string

Resolved label for Material

supplierName

string

Resolved name for Supplier (from Organisations)

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)

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

shell

Example Responses

[
  {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "millCertificationId": "00000000-0000-0000-0000-000000000000",
    "typeLabel": "typeLabel",
    "materialLabel": "materialLabel",
    "supplierName": "supplierName",
    "quantity": 0,
    "weight": 0,
    "heatCode": "heatCode",
    "diameter": 0,
    "length": 0,
    "width": 0,
    "depth": 0,
    "type": 0,
    "material": 0,
    "supplierId": "00000000-0000-0000-0000-000000000000",
    "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 › 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)

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)

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)

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 '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",
    "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",
    "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",
    "quantity": 0,
    "weight": 0,
    "heatCode": "heatCode",
    "diameter": 0,
    "length": 0,
    "width": 0,
    "depth": 0,
    "type": 0,
    "material": 0,
    "supplierId": "00000000-0000-0000-0000-000000000000",
    "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 › 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)

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)

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)

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 '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",
    "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",
    "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",
    "quantity": 0,
    "weight": 0,
    "heatCode": "heatCode",
    "diameter": 0,
    "length": 0,
    "width": 0,
    "depth": 0,
    "type": 0,
    "material": 0,
    "supplierId": "00000000-0000-0000-0000-000000000000",
    "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

Deletes one or more inventory items for the specified company using a stored procedure that enforces authorisation and ownership.

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 › Request Body

string[]

Delete inventory items › Responses

Inventory items deleted successfully

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

curl --request DELETE \
  --url https://api.gosmarter.ai/api/company/:companyId/inventory-slim \
  --header 'Content-Type: application/json' \
  --data '
[
  "00000000-0000-0000-0000-000000000000"
]
'

shell

Example Request Body

[
  "00000000-0000-0000-0000-000000000000"
]

json

Example Responses

{}

json

application/json

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 › Responses

CSV file with inventory data

string · binary

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

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/inventory-slim/download

shell

Example Responses

string

csv

text/csv

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 › 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

typeLabel

string

Resolved label for Type

materialLabel

string

Resolved label for Material

supplierName

string

Resolved name for Supplier (from Organisations)

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)

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

shell

Example Responses

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

json

application/json

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 › Request Body

Upload inventory from CSV › Responses

CSV uploaded and processed successfully

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

curl --request POST \
  --url https://api.gosmarter.ai/api/company/:companyId/inventory-slim/upload \
  --header 'Content-Type: application/json' \
  --data '{}'

shell

Example Request Body

{}

json

Example Responses

{}

json

application/json

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 › Responses

CSV template file with examples

string · binary

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

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/inventory-slim/upload-template

shell

Example Responses

string

csv

text/csv

Mill Certification Configuration