Documentation
API Reference

GoSmarter

Home

© 2026 Nightingale HQ Ltd. All rights reserved.

List companies accessible to the callerpost

Get company stamp for branded certificatesget

Upload company stamp for branded certificatesput

Delete company stamp for branded certificatesdelete

Get a company by IDget

Update a companyput

Get company logo for branded certificatesget

Upload company logo for branded certificatesput

Get certificate branding settingsget

Update certificate branding settingspatch

List email domainsget

Add email domainpost

Remove email domaindelete

Get email domain change historyget

Restore email domainpost

List organisations for a companyget

Create new organisationspost

Get organisation by IDget

Update an existing organisationput

Delete organisationdelete

Download organisations as CSVget

Get organisation change historyget

Upload organisations from CSVpost

Get organisations CSV templateget

Company Settings

List inventory materialsget

Create company inventory materialspost

Update company inventory materialspatch

List order statusesget

Create company order statusespost

Update company order statusespatch

List stock locationsget

Create company stock locationspost

Update company stock locationspatch

List inventory typesget

Create company inventory typespost

Update company inventory typespatch

Soft-delete an inventory materialdelete

Soft-delete an order statusdelete

Soft-delete a stock locationdelete

Soft-delete an inventory typedelete

Download materials as CSVget

Download order statuses as CSVget

Download stock locations as CSVget

Download types as CSVget

Get inventory material change historyget

Get order status change historyget

Get stock location change historyget

Get inventory type change historyget

Populate company inventory materialspost

Populate company order statusespost

Populate company stock locationspost

Populate company inventory typespost

Restore a soft-deleted inventory materialpost

Restore a soft-deleted order statuspost

Restore a soft-deleted stock locationpost

Restore a soft-deleted inventory typepost

Upload materials from CSVpost

Upload order statuses from CSVpost

Upload stock locations from CSVpost

Get materials CSV upload templateget

Get order statuses CSV upload templateget

Get stock locations CSV upload templateget

Get types CSV upload templateget

Upload types from CSVpost

Get rule pack detailget

List rule packsget

Subscribe to a rule packpost

Unsubscribe from a rule packdelete

Get the field/operator catalogue for a tag-rule entityget

Get countriesget

Get countries (no company context required)get

Get industry sectorsget

Get inventory materialsget

Get inventory typesget

Get metal gradesget

Get metal standardsget

Get fine-tuned mill-certificate suppliersget

Get organisation rolesget

Get stock locationsget

Get mill certification statusesget

Search for address candidatesget

List inventory items for a companyget

Update existing inventory itemsput

Create new inventory itemspost

Delete inventory itemsdelete

Download inventory as CSVget

Evaluate inventory tagspost

Get an inventory item by IDget

Get inventory item change historyget

Get mill certificate match counts for every inventory item in a companyget

Get candidate mill certificate heat matches for an inventory itemget

Confirm/override mill certificate heat matches for an inventory itemput

Unreserve stock from the inventory pagedelete

Upload inventory from CSVpost

Get CSV upload templateget

List all inventory tagsget

Create new inventory tagpost

Get inventory tagget

Update inventory tagput

Soft-delete inventory tagdelete

Get inventory tag change historyget

List deleted inventory tagsget

Restore soft-deleted inventory tagpost

List inventory tag assignmentsget

Set manual tag assignmentsput

InventoryTagRules

List all inventory tag rulesget

Create new inventory tag rulepost

Get inventory tag ruleget

Update inventory tag ruleput

Soft-delete inventory tag ruledelete

Get inventory tag rule change historyget

List deleted inventory tag rulesget

Restore soft-deleted inventory tag rulepost

Update orders with nested line itemsput

Create orders with optional line itemspost

Delete ordersdelete

Download orders as CSVget

Download orders + line items (ZIP)get

Generate or retrieve order certificate pack PDFpost

Generate order supplier certificate pack PDFpost

Get an order by ID with nested line itemsget

Get order details with line itemsget

Get order change historyget

List deleted ordersget

Reserve inventory for an order line itempost

Restore deleted orderspost

Submit a quality review for an order line itempost

Unreserve inventory from an order line itemdelete

Upload orders and/or line itemspost

Get CSV upload templates (ZIP)get

Download line items for an order as CSVget

Upload order line items from CSVpost

Get CSV upload template for order line itemsget

List all order tagsget

Create new order tagpost

Update order tagput

Soft-delete order tagdelete

Get order tag change historyget

List deleted order tagsget

Restore soft-deleted order tagpost

List order tag assignmentsget

List tag assignments for an orderget

Set manual tag assignmentsput

List all order tag rulesget

Create new order tag rulepost

Get order tag ruleget

Update order tag ruleput

Soft-delete order tag ruledelete

Get order tag rule change historyget

List deleted order tag rulesget

Restore soft-deleted order tag rulepost

Production Planning

ProductionPlans

List production plansget

Get a production planget

Accept or reject production plan cut pairingspost

Approve a production planpost

Discard a production planpost

ProductionPlanBars

Start a production plan barpost

Complete a production plan barpost

OptimisationRuns

List optimisation runsget

Start an optimisation runpost

Get an optimisation runget

Cancel an optimisation runpost

OptimisationSlim

Get optimisation result (slim)get

Download optimisation resultget

List optimisation resultsget

Delete optimisation resultsdelete

Start optimisationpost

OptimisationFilterProfiles

List saved optimisation filter profilesget

Save a new optimisation filter profilepost

Update a saved optimisation filter profileput

Soft-delete a saved optimisation filter profiledelete

Mill Certificates

MillCertifications

Archive mill certificationspost

List mill certificationsget

Delete mill certificationsdelete

Download mill certificationget

Bulk export all mill certifications as CSVget

Generate branded Material Test Certificate PDFpost

Get mill certification detailsget

Upload a mill certificationpost

Get mill certification change historyget

Get fuzzy-matched Organisation suggestions for a mill certificate's Supplier/Mill textget

Get mill certification page contentget

Get signed URLs for mill certification pagesget

List archived mill certificationsget

List mill certifications suggested for archivingget

List deleted mill certificationsget

Manually create a mill certificationpost

Restore deleted mill certificationspost

Review a mill certificationpost

Unarchive mill certificationspost

Update mill certification dataput

List all mill cert tagsget

Create new mill cert tagpost

Update mill cert tagput

Soft-delete mill cert tagdelete

Get mill cert tag change historyget

List deleted mill cert tagsget

Restore soft-deleted mill cert tagpost

List mill cert tag assignmentsget

List tag assignments for a mill certificateget

Set manual tag assignmentsput

MillCertTagRules

List all mill cert tag rulesget

Create new mill cert tag rulepost

Get mill cert tag ruleget

Update mill cert tag ruleput

Soft-delete mill cert tag ruledelete

Get mill cert tag rule change historyget

List deleted mill cert tag rulesget

Restore soft-deleted mill cert tag rulepost

Scrap

List all scrap log entriesget

Update existing scrap log entriesput

Create new scrap log entriespost

Delete scrap log entriesdelete

Download scrap log as CSVget

Get a scrap log entry by IDget

Get scrap log change historyget

Restore deleted scrap log entriespost

Upload scrap log from CSVpost

Get CSV upload templateget

Get customer order trendsget

Get insights summary for a single customer organisationget

Get product mix by customerget

Get slow-moving stockget

DashboardCharts

Delete a saved chartdelete

List saved charts for a pageget

Save a chart spec to the company's shared dashboardpost

Propose a chart spec from a natural-language promptpost

Account & Billing

List companies accessible to the callerpost

List API keysget

Create API keypost

Roll API keypost

Delete API keydelete

Update caller's profileput

Check caller's sync statuspost

Upload a document for AI proposal generationpost

Get the latest onboarding sessionget

Get or create the onboarding sessionpost

Generate AI configuration proposalspost

Generate a proposal for another surface from an already-uploaded documentpost

Update a proposal's statuspatch

Update the onboarding sessionpatch

Check feature accessget

List company entitlementsget

Self-serve subscription cancellationpost

Self-serve billing commitment switchput

Self-serve subscription tier changeput

Start a Stripe Billing Portal sessionpost

Start a self-serve subscription checkoutpost

Start a self-serve credit top-up checkoutpost

Get company subscriptionget

List company credit ledgerget

List subscription plansget

List credit top-up packsget

Reconcile a Stripe Checkout Sessionpost

Undo a scheduled cancellationpost

Add top-up credits to a companypost

Get a company's subscriptionget

Assign a subscription plan to a companypost

Update company subscription settingspatch

Change a company's subscription tierput

List company credit transactionsget

List subscription plansget

Get system infoget

List company entitlementsget

Grant feature entitlementpost

List all companiesget

List all featuresget

Revoke feature entitlementpost

Health checkget

Documentation: 30-Day Behaviour Change Playbookget

Documentation: Access Controlget

Documentation: AI Securityget

Documentation: API and MCP Accessget

Documentation: Implementation Toolkit by Business Typeget

Documentation: Rollout Packages by Business Typeget

Documentation: Certifications & Attestationsget

Documentation: Compliance Standardsget

Documentation: How everything hangs together: customer product flows and influence mapget

Documentation: Customising GoSmarter and Advanced Tipsget

Documentation: Dashboard Overviewget

Documentation: Data Residencyget

Documentation: Digitising Mill Certificates and Ensuring Complianceget

Documentation: Encryptionget

Documentation: FAQget

Documentation: Frontend Securityget

Documentation: Getting Started With GoSmarterget

Documentation: GoSmarter Glossaryget

Documentation: The GoSmarter UIget

Documentation: Hosting & Infrastructureget

Documentation: GoSmarter.ai Implementation Project Planget

Documentation: Incident Responseget

Documentation: Integration Strategyget

Documentation: Inventory Managementget

Documentation: Managing Inventory and Daily Operations with GoSmarterget

Documentation: Calculating Metal Weightsget

Documentation: Digitise your mill certificates / MTRsget

Documentation: Customer Onboarding Guideget

Documentation: Cut Long Products (Optimization)get

Documentation: Generating Optimised Production Plans (Cutting & Scheduling)get

Documentation: Managing Ordersget

Documentation: Privacy & Data Protectionget

Documentation: Quick Reference Guideget

Documentation: Scrap Managementget

Documentation: Calculating Scrap Ratesget

Documentation: Security & Complianceget

Documentation: Tags and Tag Rulesget

Documentation: Tracking and Reducing Scrap with GoSmarterget

Documentation: Troubleshooting Guideget

Documentation: Welcome to GoSmarterget

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 Explainedget

Documentation: What are long-range, low-power sensor networks?get

Documentation: What is a Heat Number in Steel? Traceability From the Millget

Documentation: What is a Mill Test Certificate? A Plain-English Guideget

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 Explainedget

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 Widgetsget

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 Fabricatorsget

Documentation: What is remote support?get

Documentation: What is Steel Traceability? From Mill to Customerget

Documentation: What is the Internet of Things?get

Documentation: What is Yield Rate in Steel Manufacturing? Formula, Benchmarks, and How to Improve Itget

powered by Zuplo

GoSmarter API Gateway

GoSmarter API Gateway

Secure API gateway for GoSmarter platform with JWT authentication and backend integration

Tags

Company Settings

InventoryTagRules

ProductionPlans

ProductionPlanBars

OptimisationRuns

OptimisationSlim

OptimisationFilterProfiles

MillCertifications

MillCertTagRules

DashboardCharts

Servers

https://api.gosmarter.ai