Documentation
API Reference
Information
Company
List companies accessible to the caller
post
Get company stamp for branded certificates
get
Upload company stamp for branded certificates
put
Delete company stamp for branded certificates
delete
Get a company by ID
get
Update a company
put
Get company logo for branded certificates
get
Upload company logo for branded certificates
put
Get certificate branding settings
get
Update certificate branding settings
patch
List email domains
get
Add email domain
post
Remove email domain
delete
Get email domain change history
get
Restore email domain
post
Organisations
List organisations for a company
get
Create new organisations
post
Get organisation by ID
get
Update an existing organisation
put
Delete organisation
delete
Download organisations as CSV
get
Get organisation change history
get
Upload organisations from CSV
post
Get organisations CSV template
get
Company Settings
List inventory materials
get
Create company inventory materials
post
Update company inventory materials
patch
List order statuses
get
Create company order statuses
post
Update company order statuses
patch
List stock locations
get
Create company stock locations
post
Update company stock locations
patch
List inventory types
get
Create company inventory types
post
Update company inventory types
patch
Soft-delete an inventory material
delete
Soft-delete an order status
delete
Soft-delete a stock location
delete
Soft-delete an inventory type
delete
Download materials as CSV
get
Download order statuses as CSV
get
Download stock locations as CSV
get
Download types as CSV
get
Get inventory material change history
get
Get order status change history
get
Get stock location change history
get
Get inventory type change history
get
Populate company inventory materials
post
Populate company order statuses
post
Populate company stock locations
post
Populate company inventory types
post
Restore a soft-deleted inventory material
post
Restore a soft-deleted order status
post
Restore a soft-deleted stock location
post
Restore a soft-deleted inventory type
post
Upload materials from CSV
post
Upload order statuses from CSV
post
Upload stock locations from CSV
post
Get materials CSV upload template
get
Get order statuses CSV upload template
get
Get stock locations CSV upload template
get
Get types CSV upload template
get
Upload types from CSV
post
RulePacks
Get rule pack detail
get
List rule packs
get
Subscribe to a rule pack
post
Unsubscribe from a rule pack
delete
RuleFields
Get the field/operator catalogue for a tag-rule entity
get
Reference Data
Get countries
get
Get countries (no company context required)
get
Get industry sectors
get
Get inventory materials
get
Get inventory types
get
Get metal grades
get
Get metal standards
get
Get fine-tuned mill-certificate suppliers
get
Get organisation roles
get
Get stock locations
get
Get mill certification statuses
get
Geocoding
Search for address candidates
get
Inventory
List inventory items for a company
get
Update existing inventory items
put
Create new inventory items
post
Delete inventory items
delete
Download inventory as CSV
get
Evaluate inventory tags
post
Get an inventory item by ID
get
Get inventory item change history
get
Get mill certificate match counts for every inventory item in a company
get
Get candidate mill certificate heat matches for an inventory item
get
Confirm/override mill certificate heat matches for an inventory item
put
Unreserve stock from the inventory page
delete
Upload inventory from CSV
post
Get CSV upload template
get
InventoryTags
List all inventory tags
get
Create new inventory tag
post
Get inventory tag
get
Update inventory tag
put
Soft-delete inventory tag
delete
Get inventory tag change history
get
List deleted inventory tags
get
Restore soft-deleted inventory tag
post
List inventory tag assignments
get
Set manual tag assignments
put
InventoryTagRules
List all inventory tag rules
get
Create new inventory tag rule
post
Get inventory tag rule
get
Update inventory tag rule
put
Soft-delete inventory tag rule
delete
Get inventory tag rule change history
get
List deleted inventory tag rules
get
Restore soft-deleted inventory tag rule
post
Orders
List orders
get
Update orders with nested line items
put
Create orders with optional line items
post
Delete orders
delete
Download orders as CSV
get
Download orders + line items (ZIP)
get
Generate or retrieve order certificate pack PDF
post
Generate order supplier certificate pack PDF
post
Get an order by ID with nested line items
get
Get order details with line items
get
Get order change history
get
List deleted orders
get
Reserve inventory for an order line item
post
Restore deleted orders
post
Submit a quality review for an order line item
post
Unreserve inventory from an order line item
delete
Upload orders and/or line items
post
Get CSV upload templates (ZIP)
get
OrderLineItems
Download line items for an order as CSV
get
Upload order line items from CSV
post
Get CSV upload template for order line items
get
OrderTags
List all order tags
get
Create new order tag
post
Update order tag
put
Soft-delete order tag
delete
Get order tag change history
get
List deleted order tags
get
Restore soft-deleted order tag
post
List order tag assignments
get
List tag assignments for an order
get
Set manual tag assignments
put
OrderTagRules
List all order tag rules
get
Create new order tag rule
post
Get order tag rule
get
Update order tag rule
put
Soft-delete order tag rule
delete
Get order tag rule change history
get
List deleted order tag rules
get
Restore soft-deleted order tag rule
post
Production Planning
ProductionPlans
List production plans
get
Get a production plan
get
Accept or reject production plan cut pairings
post
Approve a production plan
post
Discard a production plan
post
ProductionPlanBars
Start a production plan bar
post
Complete a production plan bar
post
OptimisationRuns
List optimisation runs
get
Start an optimisation run
post
Get an optimisation run
get
Cancel an optimisation run
post
OptimisationSlim
Get optimisation result (slim)
get
Download optimisation result
get
List optimisation results
get
Delete optimisation results
delete
Start optimisation
post
OptimisationFilterProfiles
List saved optimisation filter profiles
get
Save a new optimisation filter profile
post
Update a saved optimisation filter profile
put
Soft-delete a saved optimisation filter profile
delete
Mill Certificates
MillCertifications
Archive mill certifications
post
List mill certifications
get
Delete mill certifications
delete
Download mill certification
get
Bulk export all mill certifications as CSV
get
Generate branded Material Test Certificate PDF
post
Get mill certification details
get
Upload a mill certification
post
Get mill certification change history
get
Get fuzzy-matched Organisation suggestions for a mill certificate's Supplier/Mill text
get
Get mill certification page content
get
Get signed URLs for mill certification pages
get
List archived mill certifications
get
List mill certifications suggested for archiving
get
List deleted mill certifications
get
Manually create a mill certification
post
Restore deleted mill certifications
post
Review a mill certification
post
Unarchive mill certifications
post
Update mill certification data
put
MillCertTags
List all mill cert tags
get
Create new mill cert tag
post
Update mill cert tag
put
Soft-delete mill cert tag
delete
Get mill cert tag change history
get
List deleted mill cert tags
get
Restore soft-deleted mill cert tag
post
List mill cert tag assignments
get
List tag assignments for a mill certificate
get
Set manual tag assignments
put
MillCertTagRules
List all mill cert tag rules
get
Create new mill cert tag rule
post
Get mill cert tag rule
get
Update mill cert tag rule
put
Soft-delete mill cert tag rule
delete
Get mill cert tag rule change history
get
List deleted mill cert tag rules
get
Restore soft-deleted mill cert tag rule
post
Scrap
ScrapLog
List all scrap log entries
get
Update existing scrap log entries
put
Create new scrap log entries
post
Delete scrap log entries
delete
Download scrap log as CSV
get
Get a scrap log entry by ID
get
Get scrap log change history
get
Restore deleted scrap log entries
post
Upload scrap log from CSV
post
Get CSV upload template
get
Insights
Get customer order trends
get
Get insights summary for a single customer organisation
get
Get product mix by customer
get
Get slow-moving stock
get
DashboardCharts
Delete a saved chart
delete
List saved charts for a page
get
Save a chart spec to the company's shared dashboard
post
Propose a chart spec from a natural-language prompt
post
Account & Billing
Me
List companies accessible to the caller
post
List API keys
get
Create API key
post
Roll API key
post
Delete API key
delete
Update caller's profile
put
Check caller's sync status
post
Onboarding
Upload a document for AI proposal generation
post
Get the latest onboarding session
get
Get or create the onboarding session
post
Generate AI configuration proposals
post
Generate a proposal for another surface from an already-uploaded document
post
Update a proposal's status
patch
Update the onboarding session
patch
Entitlements
Check feature access
get
List company entitlements
get
Subscription
Self-serve subscription cancellation
post
Self-serve billing commitment switch
put
Self-serve subscription tier change
put
Start a Stripe Billing Portal session
post
Start a self-serve subscription checkout
post
Start a self-serve credit top-up checkout
post
Get company subscription
get
List company credit ledger
get
List subscription plans
get
List credit top-up packs
get
Reconcile a Stripe Checkout Session
post
Undo a scheduled cancellation
post
Admin
Add top-up credits to a company
post
Get a company's subscription
get
Assign a subscription plan to a company
post
Update company subscription settings
patch
Change a company's subscription tier
put
List company credit transactions
get
List subscription plans
get
Get system info
get
List company entitlements
get
Grant feature entitlement
post
List all companies
get
List all features
get
Revoke feature entitlement
post
System
Health check
get
MCP Server
post
Documentation
Documentation: 30-Day Behaviour Change Playbook
get
Documentation: Access Control
get
Documentation: AI Security
get
Documentation: API and MCP Access
get
Documentation: Implementation Toolkit by Business Type
get
Documentation: Rollout Packages by Business Type
get
Documentation: Certifications & Attestations
get
Documentation: Compliance Standards
get
Documentation: How everything hangs together: customer product flows and influence map
get
Documentation: Customising GoSmarter and Advanced Tips
get
Documentation: Dashboard Overview
get
Documentation: Data Residency
get
Documentation: Digitising Mill Certificates and Ensuring Compliance
get
Documentation: Encryption
get
Documentation: FAQ
get
Documentation: Frontend Security
get
Documentation: Getting Started With GoSmarter
get
Documentation: GoSmarter Glossary
get
Documentation: The GoSmarter UI
get
Documentation: Hosting & Infrastructure
get
Documentation: GoSmarter.ai Implementation Project Plan
get
Documentation: Incident Response
get
Documentation: Integration Strategy
get
Documentation: Inventory Management
get
Documentation: Managing Inventory and Daily Operations with GoSmarter
get
Documentation: Calculating Metal Weights
get
Documentation: Digitise your mill certificates / MTRs
get
Documentation: Customer Onboarding Guide
get
Documentation: Cut Long Products (Optimization)
get
Documentation: Generating Optimised Production Plans (Cutting & Scheduling)
get
Documentation: Managing Orders
get
Documentation: Privacy & Data Protection
get
Documentation: Quick Reference Guide
get
Documentation: Scrap Management
get
Documentation: Calculating Scrap Rates
get
Documentation: Security & Compliance
get
Documentation: Tags and Tag Rules
get
Documentation: Tracking and Reducing Scrap with GoSmarter
get
Documentation: Troubleshooting Guide
get
Documentation: Welcome to GoSmarter
get
Documentation: What are Azure Cognitive Services?
get
Documentation: What are database improvements?
get
Documentation: What are Long Products in Steel? Bars, Rebar, Sections, and Tube Explained
get
Documentation: What are long-range, low-power sensor networks?
get
Documentation: What is a Heat Number in Steel? Traceability From the Mill
get
Documentation: What is a Mill Test Certificate? A Plain-English Guide
get
Documentation: What is AI?
get
Documentation: What is AI integration into applications?
get
Documentation: What is AI product development?
get
Documentation: What is AI strategy?
get
Documentation: What is Amazon S3?
get
Documentation: What is AWS (Amazon Web Services)?
get
Documentation: What is AWS Redshift?
get
Documentation: What is Azure?
get
Documentation: What is Azure Batch?
get
Documentation: What is Azure Data Factory?
get
Documentation: What Is Azure Logic Apps?
get
Documentation: What is business intelligence?
get
Documentation: What is cloud data development?
get
Documentation: What is Cutting Optimisation in Steel Manufacturing?
get
Documentation: What is data collection?
get
Documentation: What is data modeling?
get
Documentation: What is data platform auditing?
get
Documentation: What is data platform development?
get
Documentation: What is data platform security auditing?
get
Documentation: What is data science?
get
Documentation: What is data science auditing?
get
Documentation: What is data science consulting?
get
Documentation: What is data science development?
get
Documentation: What is data science strategy?
get
Documentation: What is data strategy?
get
Documentation: What is data visualisation?
get
Documentation: What is data warehousing?
get
Documentation: What is database maintenance?
get
Documentation: What is developing a centre of excellence?
get
Documentation: What is Dynamics 365?
get
Documentation: What is Dynamics 365 Field Service?
get
Documentation: What is a 3.1 Certificate? EN 10204 Types Explained
get
Documentation: What is ERP in Metals Manufacturing — and Why Do So Many Manufacturers Outgrow Theirs?
get
Documentation: What is Google Cloud?
get
Documentation: What is Google Cloud BigQuery?
get
Documentation: What is IBM Cloud?
get
Documentation: What is Jupyter?
get
Documentation: What is Metals Inventory Management? Why Steel Is Different From Widgets
get
Documentation: What Is Microsoft Power Platform?
get
Documentation: What is Microsoft Project Bonsai?
get
Documentation: What is Power BI?
get
Documentation: What is Python?
get
Documentation: What is Rebar? Reinforcing Bar Explained for Manufacturers and Fabricators
get
Documentation: What is remote support?
get
Documentation: What is Steel Traceability? From Mill to Customer
get
Documentation: What is the Internet of Things?
get
Documentation: What is Yield Rate in Steel Manufacturing? Formula, Benchmarks, and How to Improve It
get
Schemas
powered by Zuplo
Menu
GoSmarter API Gateway
GoSmarter API Gateway
System
Health check
GET
https://api.gosmarter.ai
/api/health
Check gateway health status
Health check ›
Responses
200
Gateway is healthy
status
string
timestamp
string
·
date-time
MCP Server
Admin
Documentation
