Documentation
API Reference
Information
System
Health check
get
MCP Server
post
Documentation
Documentation: 30-day-behaviour-change-playbook/index.md
get
Documentation: _index.md
get
Documentation: archetype-implementation-toolkit/index.md
get
Documentation: archetype-rollout-packages/index.md
get
Documentation: customising-advanced-tips/index.md
get
Documentation: dashboard/index.md
get
Documentation: digitising-mill-certificates/index.md
get
Documentation: faq/index.md
get
Documentation: getting-started/index.md
get
Documentation: glossary/index.md
get
Documentation: gosmarter-ui/index.md
get
Documentation: implementation-project-plan/index.md
get
Documentation: integration-strategy/index.md
get
Documentation: inventory/index.md
get
Documentation: managing-inventory-operations/index.md
get
Documentation: mill-certificates/index.md
get
Documentation: onboarding/index.md
get
Documentation: optimisations/index.md
get
Documentation: optimised-production-plans/index.md
get
Documentation: orders/index.md
get
Documentation: quick-reference/index.md
get
Documentation: scrap-calculator/index.md
get
Documentation: scrap/index.md
get
Documentation: tags-and-tag-rules/index.md
get
Documentation: track-scrap/index.md
get
Documentation: tracking-reducing-scrap/index.md
get
Documentation: troubleshooting/index.md
get
Documentation: what-are-azure-cognitive-services/index.md
get
Documentation: what-are-database-improvements/index.md
get
Documentation: what-are-long-products-in-steel/index.md
get
Documentation: what-are-longrange-lowpower-sensor-networks/index.md
get
Documentation: what-is-a-heat-number/index.md
get
Documentation: what-is-a-mill-test-certificate/index.md
get
Documentation: what-is-ai-integration-into-applications/index.md
get
Documentation: what-is-ai-product-development/index.md
get
Documentation: what-is-ai-strategy/index.md
get
Documentation: what-is-ai/index.md
get
Documentation: what-is-amazon-s3/index.md
get
Documentation: what-is-aws-redshift/index.md
get
Documentation: what-is-aws/index.md
get
Documentation: what-is-azure-batch/index.md
get
Documentation: what-is-azure-data-factory/index.md
get
Documentation: what-is-azure-logic-apps/index.md
get
Documentation: what-is-azure/index.md
get
Documentation: what-is-business-intelligence/index.md
get
Documentation: what-is-cloud-data-development/index.md
get
Documentation: what-is-cutting-optimisation/index.md
get
Documentation: what-is-data-collection/index.md
get
Documentation: what-is-data-modeling/index.md
get
Documentation: what-is-data-platform-auditing/index.md
get
Documentation: what-is-data-platform-development/index.md
get
Documentation: what-is-data-platform-security-auditing/index.md
get
Documentation: what-is-data-science-auditing/index.md
get
Documentation: what-is-data-science-consulting/index.md
get
Documentation: what-is-data-science-development/index.md
get
Documentation: what-is-data-science-strategy/index.md
get
Documentation: what-is-data-science/index.md
get
Documentation: what-is-data-strategy/index.md
get
Documentation: what-is-data-visualisation/index.md
get
Documentation: what-is-data-warehousing/index.md
get
Documentation: what-is-database-maintenance/index.md
get
Documentation: what-is-developing-a-centre-of-excellence/index.md
get
Documentation: what-is-dynamics-365-field-service/index.md
get
Documentation: what-is-dynamics-365/index.md
get
Documentation: what-is-en-10204/index.md
get
Documentation: what-is-erp-metals-manufacturing/index.md
get
Documentation: what-is-google-cloud-bigquery/index.md
get
Documentation: what-is-google-cloud/index.md
get
Documentation: what-is-ibm-cloud/index.md
get
Documentation: what-is-jupyter/index.md
get
Documentation: what-is-metals-inventory-management/index.md
get
Documentation: what-is-microsoft-power-platform/index.md
get
Documentation: what-is-microsoft-project-bonsai/index.md
get
Documentation: what-is-power-bi/index.md
get
Documentation: what-is-python/index.md
get
Documentation: what-is-rebar/index.md
get
Documentation: what-is-remote-support/index.md
get
Documentation: what-is-steel-traceability/index.md
get
Documentation: what-is-the-internet-of-things/index.md
get
Documentation: what-is-yield-rate/index.md
get
OptimisationSlim
Get optimisation result (slim)
get
Download optimisation result
get
List optimisation results
get
Delete optimisation results
delete
Start optimisation
post
User
List companies by IDs for a user
post
Check user sync status
post
Update user profile in database
put
Company
List companies by IDs for a user
post
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
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
Reference Data
Get inventory materials
get
Get inventory types
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
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
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
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
Mill Certification
Download mill certification
get
Generate branded Material Test Certificate PDF
post
Get mill certification details
get
Upload a mill certification
post
Get mill certification PDF page content
get
Get signed URLs for mill certification PDF pages
get
List mill certifications
get
Manually create a mill certification
post
Review a mill certification
post
Update mill certification data
put
MillCertifications
Get mill certification change history
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
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
Gateway
Zuplo API key creation webhook
post
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
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
Secure API gateway for GoSmarter platform with JWT authentication and backend integration
Tags
System
Documentation
OptimisationSlim
User
Company
ScrapLog
Reference Data
Reference
Organisations
Orders
Order Line Items
OrderLineItems
Mill Certification
MillCertifications
InventoryTags
InventoryTagRules
Inventory
Gateway
Entitlements
Configuration
Admin
