Documentation
API Reference
Information
System
Health check
get
MCP Server
post
OptimisationSlim
Get optimisation result (slim)
get
Download optimisation result
get
List optimisation results
get
Delete optimisation results
delete
Start optimisation
post
Subscription
Get company subscription
get
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
RulePacks
Get rule pack detail
get
List rule packs
get
Subscribe to a rule pack
post
Unsubscribe from a rule pack
delete
Reference Data
Get countries
get
Get industry sectors
get
Get inventory materials
get
Get inventory types
get
Get metal grades
get
Get metal standards
get
Get organisation roles
get
Get mill certification statuses
get
Reference
Get stock locations
get
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
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
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
Order Line Items
Download line items for an order as CSV
get
OrderLineItems
Upload order line items from CSV
post
Get CSV upload template for order line items
get
Onboarding
Get the latest onboarding session
get
Get or create the onboarding session
post
Generate AI configuration proposals
post
Update a proposal's status
patch
Update the onboarding session
patch
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
MillCertifications
Archive mill certifications
post
Delete mill certifications
delete
Get mill certification change history
get
List archived mill certifications
get
List mill certifications suggested for archiving
get
List deleted mill certifications
get
Restore deleted mill certifications
post
Unarchive mill certifications
post
Mill Certification
List mill certifications
get
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 page content
get
Get signed URLs for mill certification pages
get
Manually create a mill certification
post
Review a mill certification
post
Update mill certification data
put
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
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
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
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
Unreserve stock from the inventory page
delete
Upload inventory from CSV
post
Get CSV upload template
get
Geocoding
Search for address candidates
get
Entitlements
Check feature access
get
List company entitlements
get
Configuration
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
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
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
OptimisationSlim
