Reference Data

Get countries

GET

https://api.gosmarter.ai

/api/company/{companyId}/reference/countries

Retrieves the full ISO-3166 country reference list (CountryId, Iso2Code, Iso3Code, Name), ordered by name.

Get countries › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Get countries › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get countries › Responses

List of countries retrieved successfully

countryDto[]

countryDto

countryId

integer · int32

Unique identifier for the country

iso2Code

string

ISO-3166 alpha-2 country code (e.g. GB, US)

iso3Code

string

ISO-3166 alpha-3 country code (e.g. GBR, USA)

name

string

Country name

Get countries (no company context required)

GET

https://api.gosmarter.ai

/api/reference/countries

Retrieves the full ISO-3166 country reference list (CountryId, Iso2Code, Iso3Code, Name), ordered by name. Use before a company exists (e.g. onboarding); once a company exists, prefer the company-scoped route.

Get countries (no company context required) › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get countries (no company context required) › Responses

List of countries retrieved successfully

countryDto[]

countryDto

countryId

integer · int32

Unique identifier for the country

iso2Code

string

ISO-3166 alpha-2 country code (e.g. GB, US)

iso3Code

string

ISO-3166 alpha-3 country code (e.g. GBR, USA)

name

string

Country name

Get industry sectors

GET

https://api.gosmarter.ai

/api/company/{companyId}/reference/industry-sectors

Retrieves the full industry sector reference list (IndustrySectorId, Name), ordered by name.

Get industry sectors › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Get industry sectors › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get industry sectors › Responses

List of industry sectors retrieved successfully

industrySectorDto[]

industrySectorDto

industrySectorId

integer · int32

Unique identifier for the industry sector

name

string

Industry sector name

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

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get inventory materials › Responses

List of inventory materials retrieved successfully

inventoryMaterialDto[]

inventoryMaterialDto

inventoryMaterialId

integer · int32

category

string

value

string

Get inventory statuses

GET

https://api.gosmarter.ai

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

Retrieves the fixed inventory lifecycle statuses (id and label)

Get inventory statuses › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Get inventory statuses › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get inventory statuses › Responses

List of inventory statuses retrieved successfully

inventoryStatusDto[]

inventoryStatusDto

inventoryStatusId

integer · int32

label

string

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

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get inventory types › Responses

List of inventory types retrieved successfully

inventoryTypeDto[]

inventoryTypeDto

inventoryTypeId

integer · int32

category

string

value

string

Get metal grades

GET

https://api.gosmarter.ai

/api/company/{companyId}/reference/metal-grades

Retrieves metal grades, optionally filtered by metal standard, for order line item specification and Rule Pack dropdowns.

Get metal grades › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Get metal grades › query Parameters

metalStandardId

integer · int32

Filter to grades belonging to this metal standard

Get metal grades › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get metal grades › Responses

List of metal grades retrieved successfully

metalGradeDto[]

metalGradeDto

metalGradeId

integer · int32

Unique identifier for the metal grade

metalStandardId

integer · int32

The standard this grade is defined under

metalStandardCode

string

Standard code this grade belongs to (e.g. ASTM_A615)

code

string

Grade code (e.g. B500B, Grade 60, 316L, 6061-T6)

name

string

Grade display name

compositionNotes

string

Composition/property notes

Get metal standards

GET

https://api.gosmarter.ai

/api/company/{companyId}/reference/metal-standards

Retrieves metal standards, optionally filtered by material family or standards body, for order line item specification and Rule Pack dropdowns.

Get metal standards › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Get metal standards › query Parameters

materialFamilyId

integer · int32

Filter to standards belonging to this material family

standardsBodyId

integer · int32

Filter to standards published by this standards body

Get metal standards › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get metal standards › Responses

List of metal standards retrieved successfully

metalStandardDto[]

metalStandardDto

metalStandardId

integer · int32

Unique identifier for the metal standard

standardsBodyId

integer · int32

Publishing standards body identifier (see StandardsBodies)

standardsBodyCode

string

Publishing standards body code (e.g. ASTM, BSI, CEN)

materialFamilyId

integer · int32

Material family identifier this standard belongs to

materialFamilyName

string

Material family name (e.g. Rebar, Titanium, Non-Ferrous Metals)

regionId

integer · int32

Region identifier this standard belongs to (see Regions)

regionCode

string

Region code (e.g. EU_UK, USA, IN, GLOBAL)

regionName

string

Region display name (e.g. Europe/UK, USA, India, Global)

usesExecutionClass

boolean

True if this standard carries the EN 1090-2/EN 1990 Execution Class (EXC1-EXC4) and Consequence Class (CC1-CC3) scheme

code

string

Standard code (e.g. ASTM_A615, BS4449)

name

string

Standard display name (e.g. ASTM A615, BS 4449:2005+A3:2016)

scope

string

Brief plain-English scope summary

version

string

Standard version/revision

Get fine-tuned mill-certificate suppliers

GET

https://api.gosmarter.ai

/api/company/{companyId}/reference/millcert-suppliers

Retrieves the reference list of mill-certificate suppliers with a fine-tuned AI classification/extraction template, including aliases and associated mills, ordered by name.

Get fine-tuned mill-certificate suppliers › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Get fine-tuned mill-certificate suppliers › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get fine-tuned mill-certificate suppliers › Responses

List of fine-tuned mill-certificate suppliers retrieved successfully

millCertSupplierDto[]

millCertSupplierDto

millCertSupplierId

integer · int32

name

string

website

string

countryId

integer · int32

countryName

string

aliases

string[]

millCertSupplierMillDto[]

GET/api/company/{companyId}/reference/millcert-suppliers

curl https://api.gosmarter.ai/api/company/:companyId/reference/millcert-suppliers \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "millCertSupplierId": 0,
    "name": "name",
    "website": "website",
    "countryId": 0,
    "countryName": "countryName",
    "aliases": [
      "string"
    ],
    "mills": [
      {
        "millCertSupplierMillId": 0,
        "name": "name",
        "addressLine1": "addressLine1",
        "addressLine2": "addressLine2",
        "city": "city",
        "region": "region",
        "postalCode": "postalCode",
        "countryId": 0,
        "countryName": "countryName",
        "latitude": 0,
        "longitude": 0,
        "geocodeConfidence": 0,
        "geocodedAt": "2024-08-25T15:00:00Z"
      }
    ]
  }
]

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

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get organisation roles › Responses

List of organisation roles retrieved successfully

organisationRoleDto[]

organisationRoleDto

organisationRoleId

integer · int32

Unique identifier for the role

value

string

Role name

Get regions

GET

https://api.gosmarter.ai

/api/company/{companyId}/reference/regions

Retrieves the geographic/regulatory regions used to filter metal standards dropdowns.

Get regions › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Get regions › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get regions › Responses

List of regions retrieved successfully

regionDto[]

regionDto

regionId

integer · int32

Unique identifier for the region

code

string

Region code (e.g. EU_UK, USA, IN, GLOBAL)

name

string

Region display name (e.g. Europe/UK, USA, India, Global)

Get inventory shape families

GET

https://api.gosmarter.ai

/api/company/{companyId}/inventory-reference/shape-families

Retrieves the fixed set of inventory ShapeFamily values, each with a description and whether it supports the Cut action

Get inventory shape families › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Get inventory shape families › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get inventory shape families › Responses

List of shape families retrieved successfully

shapeFamilyDto[]

shapeFamilyDto

shapeFamily

string

description

string

supportsCut

boolean

sortOrder

integer · int32

Get stock locations

GET

https://api.gosmarter.ai

/api/reference/stocklocations

Gets all stock location reference data

Get stock locations › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get stock locations › Responses

List of stock locations

stockLocationDto[]

stockLocationDto

stockLocationId

integer · int32

category

string

value

string

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

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get mill certification statuses › Responses

List of mill certification statuses retrieved successfully

millCertificationStatusDto[]

millCertificationStatusDto

millCertificationStatusId

integer · int32

type

string

label

string

notes

string

RuleFields Geocoding