Documentation
API Reference

GoSmarter

Home

© 2026 Nightingale HQ Ltd. All rights reserved.

Health checkget

OptimisationSlim

Get optimisation result (slim)get

Download optimisation resultget

List optimisation resultsget

Delete optimisation resultsdelete

Start optimisationpost

Get company subscriptionget

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 rule pack detailget

List rule packsget

Subscribe to a rule packpost

Unsubscribe from a rule packdelete

Get countriesget

Get industry sectorsget

Get inventory materialsget

Get inventory typesget

Get metal gradesget

Get metal standardsget

Get organisation rolesget

Get mill certification statusesget

Get stock locationsget

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

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

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

Order Line Items

Download line items for an order as CSVget

Upload order line items from CSVpost

Get CSV upload template for order line itemsget

Get the latest onboarding sessionget

Get or create the onboarding sessionpost

Generate AI configuration proposalspost

Update a proposal's statuspatch

Update the onboarding sessionpatch

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

MillCertifications

Archive mill certificationspost

Delete mill certificationsdelete

Get mill certification change historyget

List archived mill certificationsget

List mill certifications suggested for archivingget

List deleted mill certificationsget

Restore deleted mill certificationspost

Unarchive mill certificationspost

Mill Certification

List mill certificationsget

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 page contentget

Get signed URLs for mill certification pagesget

Manually create a mill certificationpost

Review a mill certificationpost

Update mill certification dataput

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

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 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

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

Unreserve stock from the inventory pagedelete

Upload inventory from CSVpost

Get CSV upload templateget

Search for address candidatesget

Check feature accessget

List company entitlementsget

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

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

powered by Zuplo

GoSmarter API Gateway

GoSmarter API Gateway

Reference

Get stock locations

GET

https://api.gosmarter.ai

/api/reference/stocklocations

Gets all stock location reference data

Get stock locations › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get stock locations › Responses

200

List of stock locations

stockLocationDto[]

stockLocationDto

stockLocationId

integer · int32

category

string

value

string

GET/api/reference/stocklocations

curl https://api.gosmarter.ai/api/reference/stocklocations \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "stockLocationId": 0,
    "category": "category",
    "value": "value"
  }
]

json

application/json

Reference Data Organisations