Reference Data
Get countries
Retrieves the full ISO-3166 country reference list (CountryId, Iso2Code, Iso3Code, Name), ordered by name.
path Parameters
companyIdThe unique identifier of the company
Headers
GoSmarter-Api-KeyThe 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
countryIdUnique identifier for the country
iso2CodeISO-3166 alpha-2 country code (e.g. GB, US)
iso3CodeISO-3166 alpha-3 country code (e.g. GBR, USA)
nameCountry name
Get industry sectors
Retrieves the full industry sector reference list (IndustrySectorId, Name), ordered by name.
path Parameters
companyIdThe unique identifier of the company
Headers
GoSmarter-Api-KeyThe 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
industrySectorIdUnique identifier for the industry sector
nameIndustry sector name
Get inventory materials
Retrieves all available inventory material reference data
path Parameters
companyIdThe unique identifier of the company
Headers
GoSmarter-Api-KeyThe 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
inventoryMaterialIdcategoryvalueGet inventory types
Retrieves all available inventory type reference data
path Parameters
companyIdThe unique identifier of the company
Headers
GoSmarter-Api-KeyThe 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
inventoryTypeIdcategoryvalueGet metal grades
Retrieves metal grades, optionally filtered by metal standard, for order line item specification and Rule Pack dropdowns.
path Parameters
companyIdThe unique identifier of the company
query Parameters
metalStandardIdFilter to grades belonging to this metal standard
Headers
GoSmarter-Api-KeyThe 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
metalGradeIdUnique identifier for the metal grade
metalStandardIdThe standard this grade is defined under
metalStandardCodeStandard code this grade belongs to (e.g. ASTM_A615)
codeGrade code (e.g. B500B, Grade 60, 316L, 6061-T6)
nameGrade display name
compositionNotesComposition/property notes
Get metal standards
Retrieves metal standards, optionally filtered by material family or standards body, for order line item specification and Rule Pack dropdowns.
path Parameters
companyIdThe unique identifier of the company
query Parameters
materialFamilyIdFilter to standards belonging to this material family
standardsBodyIdFilter to standards published by this standards body
Headers
GoSmarter-Api-KeyThe 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
metalStandardIdUnique identifier for the metal standard
standardsBodyIdPublishing standards body identifier (see StandardsBodies)
standardsBodyCodePublishing standards body code (e.g. ASTM, BSI, CEN)
materialFamilyIdMaterial family identifier this standard belongs to
materialFamilyNameMaterial family name (e.g. Rebar, Titanium, Non-Ferrous Metals)
codeStandard code (e.g. ASTM_A615, BS4449)
nameStandard display name (e.g. ASTM A615, BS 4449:2005+A3:2016)
scopeBrief plain-English scope summary
versionStandard version/revision
Get organisation roles
Retrieves all available organisation role reference data (Supplier, Customer, Distributor, etc.)
path Parameters
companyIdThe unique identifier of the company
Headers
GoSmarter-Api-KeyThe 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
organisationRoleIdUnique identifier for the role
valueRole name
Get mill certification statuses
Retrieves all available mill certification status reference data
path Parameters
companyIdThe unique identifier of the company
Headers
GoSmarter-Api-KeyThe 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
millCertificationStatusIdtypelabelnotes
