GoSmarter API Gateway

Reference Data

Endpointhttps://api.gosmarter.ai

Get inventory materials

GET

https://api.gosmarter.ai

/api/company/{companyId}/inventory-reference/materials

Retrieves all available inventory material reference data

Get inventory materials › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Get inventory materials › Responses

List of inventory materials retrieved successfully

object[]

inventoryMaterialId

integer · int32

category

string

value

string

GET/api/company/{companyId}/inventory-reference/materials

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

shell

Example Responses

[
  {
    "inventoryMaterialId": 0,
    "category": "category",
    "value": "value"
  }
]

json

application/json

Get inventory types

GET

https://api.gosmarter.ai

/api/company/{companyId}/inventory-reference/types

Retrieves all available inventory type reference data

Get inventory types › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Get inventory types › Responses

List of inventory types retrieved successfully

object[]

inventoryTypeId

integer · int32

category

string

value

string

GET/api/company/{companyId}/inventory-reference/types

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

shell

Example Responses

[
  {
    "inventoryTypeId": 0,
    "category": "category",
    "value": "value"
  }
]

json

application/json

Get organisation roles

GET

https://api.gosmarter.ai

/api/company/{companyId}/organisation-reference/roles

Retrieves all available organisation role reference data (Supplier, Customer, Distributor, etc.)

Get organisation roles › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Get organisation roles › Responses

List of organisation roles retrieved successfully

object[]

organisationRoleId

integer · int32

Unique identifier for the role

value

string

Role name

GET/api/company/{companyId}/organisation-reference/roles

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/organisation-reference/roles

shell

Example Responses

[
  {
    "organisationRoleId": 0,
    "value": "value"
  }
]

json

application/json

Get mill certification statuses

GET

https://api.gosmarter.ai

/api/company/{companyId}/millcertification-status

Retrieves all available mill certification status reference data

Get mill certification statuses › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Get mill certification statuses › Responses

List of mill certification statuses retrieved successfully

object[]

millCertificationStatusId

integer · int32

type

string

label

string

notes

string

GET/api/company/{companyId}/millcertification-status

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/millcertification-status

shell

Example Responses

[
  {
    "millCertificationStatusId": 0,
    "type": "type",
    "label": "label",
    "notes": "notes"
  }
]

json

application/json

ScrapLog Organisations

GoSmarter API Gateway

Reference Data

Endpointhttps://api.gosmarter.ai

Get inventory materials

GET

https://api.gosmarter.ai

/api/company/{companyId}/inventory-reference/materials

Retrieves all available inventory material reference data

Get inventory materials › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Get inventory materials › Responses

List of inventory materials retrieved successfully

object[]

inventoryMaterialId

integer · int32

category

string

value

string

GET/api/company/{companyId}/inventory-reference/materials

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

shell

Example Responses

[
  {
    "inventoryMaterialId": 0,
    "category": "category",
    "value": "value"
  }
]

json

application/json

Get inventory types

GET

https://api.gosmarter.ai

/api/company/{companyId}/inventory-reference/types

Retrieves all available inventory type reference data

Get inventory types › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Get inventory types › Responses

List of inventory types retrieved successfully

object[]

inventoryTypeId

integer · int32

category

string

value

string

GET/api/company/{companyId}/inventory-reference/types

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

shell

Example Responses

[
  {
    "inventoryTypeId": 0,
    "category": "category",
    "value": "value"
  }
]

json

application/json

Get organisation roles

GET

https://api.gosmarter.ai

/api/company/{companyId}/organisation-reference/roles

Retrieves all available organisation role reference data (Supplier, Customer, Distributor, etc.)

Get organisation roles › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Get organisation roles › Responses

List of organisation roles retrieved successfully

object[]

organisationRoleId

integer · int32

Unique identifier for the role

value

string

Role name

GET/api/company/{companyId}/organisation-reference/roles

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/organisation-reference/roles

shell

Example Responses

[
  {
    "organisationRoleId": 0,
    "value": "value"
  }
]

json

application/json

Get mill certification statuses

GET

https://api.gosmarter.ai

/api/company/{companyId}/millcertification-status

Retrieves all available mill certification status reference data

Get mill certification statuses › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Get mill certification statuses › Responses

List of mill certification statuses retrieved successfully

object[]

millCertificationStatusId

integer · int32

type

string

label

string

notes

string

GET/api/company/{companyId}/millcertification-status

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/millcertification-status

shell

Example Responses

[
  {
    "millCertificationStatusId": 0,
    "type": "type",
    "label": "label",
    "notes": "notes"
  }
]

json

application/json

ScrapLog Organisations