Nexus SoftSphereDocumentation

REST API for Nexus Inventory

Every HTTP endpoint the application exposes, grouped by resource.

Calling the API

The API is served from the same address as the application, under /api. Requests carry the session cookie issued at sign-in, so a browser session and an API call are the same identity and obey the same permissions.

Every state changing request (POST, PUT, PATCH, DELETE) must also carry this application family's presence header, or it is refused with 403 bad request. That refusal reads like a permissions fault but is not one. Integration and APIs lists the header per family.

Endpoints

441 endpoints in 127 resource groups.

activity · addons · adjustments · alerts · api · asn · assemblies · assets · atp · attachments · automation · backorders · base-currency · billing · bills · boms · bu · carriers · carton-types · cartonize · compliance · connect · consigned-stock · consolidations · consumption-advice · cost-allocs · costing · count-schedules · countries · counts · crossdock · currencies · custom-domain · customers · dashboard · docks · documents · entstruct · exec-inventory · export · forecast · forecast-all · goods-receipts · import · inspection-plans · inspections · inv-agents · inventory · item-txn-defaults · journals · label · labor · landed-costs · locations · login · logout · lots · lpn-lines · lpns · me · move-orders · movements · ncr · next-number · nxdocs · nxdocs-file · nxtz · packages · password · perms · physical-inventory · physical-tags · planning · planning-update · products · provision · purchase-orders · push · putaway · register · replenishment · reports · requisitions · reservations · returns-supplier · rf · rfid · roles · sales-orders · scan · search · sender-domains · sender-emails · sender-options · sender-prefs · serials · session · settings · shipments · shipping · shipping-agents · skus · slotting · sso · stock · storage · stream · subinventories · supplier-returns · supplier-sites · suppliers · supply-demand · tasks · trace · track · tracking-config · transfer-routes · transfers · txn · uom2 · username · users · valuation · waves · workflow-config · workforce · zoho

activity 1

MethodPathAccess
GET/api/activitysigned in

addons 3

MethodPathAccess
GET/api/addonssigned in
POST/api/addons/:code/enablesigned in
POST/api/addons/:code/trialsigned in

adjustments 2

MethodPathAccess
GET/api/adjustmentssigned in
POST/api/adjustmentssigned in

alerts 3

MethodPathAccess
GET/api/alertssigned in
POST/api/alerts/:id/resolvesigned in
POST/api/alerts/scan-expirysigned in

api 3

MethodPathAccess
GET/api/signed in
POST/api/administrator
PUT/api/administrator

asn 5

MethodPathAccess
GET/api/asnsigned in
POST/api/asnsigned in
GET/api/asn/:idsigned in
POST/api/asn/:id/cancelsigned in
POST/api/asn/:id/receivesigned in

assemblies 3

MethodPathAccess
GET/api/assembliessigned in
POST/api/assembliessigned in
GET/api/assemblies/buildablesigned in

assets 5

MethodPathAccess
GET/api/assetssigned in
POST/api/assetsadministrator
GET/api/assets/:idsigned in
PUT/api/assets/:idsigned in
POST/api/assets/:id/eventsigned in

atp 2

MethodPathAccess
GET/api/atp/:product_idsigned in
POST/api/atp/promisesigned in

attachments 4

MethodPathAccess
GET/api/attachmentssigned in
POST/api/attachmentssigned in
DELETE/api/attachments/:idsigned in
GET/api/attachments/:id/downloadsigned in

automation 9

MethodPathAccess
GET/api/automation/equipmentsigned in
POST/api/automation/equipmentsigned in
GET/api/automation/eventssigned in
POST/api/automation/faultsigned in
POST/api/automation/ingestsigned in
GET/api/automation/monitorsigned in
GET/api/automation/routessigned in
POST/api/automation/routessigned in
DELETE/api/automation/routes/:idsigned in

backorders 1

MethodPathAccess
GET/api/backorderssigned in

base-currency 1

MethodPathAccess
GET/api/base-currencysigned in

billing 4

MethodPathAccess
GET/api/billing/invoicessigned in
GET/api/billing/invoices/:idsigned in
PUT/api/billing/invoices/:idadministrator
POST/api/billing/invoices/generateadministrator

bills 6

MethodPathAccess
GET/api/billssigned in
POST/api/billssigned in
GET/api/bills/:idsigned in
POST/api/bills/:id/approvesigned in
POST/api/bills/:id/paysigned in
POST/api/bills/:id/validatesigned in

boms 2

MethodPathAccess
GET/api/boms/:product_idsigned in
PUT/api/boms/:product_idsigned in

bu 14

MethodPathAccess
GET/api/busigned in
GET/api/bu/access-previewadministrator
POST/api/bu/assign-orgadministrator
POST/api/bu/entitiesadministrator
GET/api/bu/for-entitysigned in
POST/api/bu/functionsadministrator
GET/api/bu/my-accesssigned in
GET/api/bu/resolvesigned in
GET/api/bu/securitysigned in
POST/api/bu/securityadministrator
POST/api/bu/security/assignadministrator
POST/api/bu/service-providersadministrator
POST/api/bu/service-providers/:id/deleteadministrator
POST/api/bu/unitsadministrator

carriers 2

MethodPathAccess
GET/api/carrierssigned in
PUT/api/carriers/:idadministrator

carton-types 2

MethodPathAccess
GET/api/carton-typessigned in
POST/api/carton-typessigned in

cartonize 1

MethodPathAccess
POST/api/cartonizesigned in

compliance 4

MethodPathAccess
GET/api/compliance/auditadministrator
GET/api/compliance/export/auditadministrator
GET/api/compliance/statusadministrator
GET/api/compliance/traceabilitysigned in

connect 25

MethodPathAccess
GET/api/connect/connectionssigned in
POST/api/connect/connectionssigned in
DELETE/api/connect/connections/:idsigned in
PUT/api/connect/connections/:idsigned in
POST/api/connect/connections/:id/callsigned in
POST/api/connect/connections/:id/testsigned in
GET/api/connect/hookssigned in
POST/api/connect/hookssigned in
DELETE/api/connect/hooks/:idsigned in
PUT/api/connect/hooks/:idsigned in
GET/api/connect/hooks/:id/eventssigned in
GET/api/connect/logsigned in
GET/api/connect/metasigned in
GET/api/connect/subssigned in
POST/api/connect/subssigned in
DELETE/api/connect/subs/:idsigned in
PUT/api/connect/subs/:idsigned in
POST/api/connect/subs/:id/testadministrator
GET/api/connect/tokenssigned in
POST/api/connect/tokenssigned in
DELETE/api/connect/tokens/:idsigned in
PUT/api/connect/tokens/:idsigned in
POST/connect/hook/:slugsigned in
GET/connect/mcpsigned in
POST/connect/mcpsigned in

consigned-stock 4

MethodPathAccess
GET/api/consigned-stocksigned in
POST/api/consigned-stocksigned in
POST/api/consigned-stock/:id/consumesigned in
POST/api/consigned-stock/:id/transfer-ownershipsigned in

consolidations 1

MethodPathAccess
GET/api/consolidationssigned in

consumption-advice 1

MethodPathAccess
GET/api/consumption-advicesigned in

cost-allocs 3

MethodPathAccess
GET/api/cost-allocssigned in
POST/api/cost-allocssigned in
DELETE/api/cost-allocs/:idsigned in

costing 1

MethodPathAccess
GET/api/costing/variancessigned in

count-schedules 3

MethodPathAccess
GET/api/count-schedulessigned in
POST/api/count-schedulessigned in
DELETE/api/count-schedules/:idsigned in

countries 1

MethodPathAccess
GET/api/countriessigned in

counts 5

MethodPathAccess
GET/api/countssigned in
POST/api/countssigned in
GET/api/counts/:idsigned in
PUT/api/counts/:id/linessigned in
POST/api/counts/:id/submitsigned in

crossdock 2

MethodPathAccess
POST/api/crossdock/executesigned in
GET/api/crossdock/opportunitiessigned in

currencies 2

MethodPathAccess
GET/api/currenciessigned in
POST/api/currencies/refreshadministrator

custom-domain 3

MethodPathAccess
GET/api/custom-domainsigned in
PUT/api/custom-domainsigned in
POST/api/custom-domain/verifysigned in

customers 2

MethodPathAccess
GET/api/customerssigned in
POST/api/customerssigned in

dashboard 1

MethodPathAccess
GET/api/dashboardsigned in

docks 3

MethodPathAccess
GET/api/dockssigned in
POST/api/dockssigned in
PUT/api/docks/:idsigned in

documents 4

MethodPathAccess
GET/api/documentssigned in
POST/api/documentssigned in
DELETE/api/documents/:idsigned in
GET/api/documents/:id/downloadsigned in

entstruct 5

MethodPathAccess
GET/api/entstructsigned in
POST/api/entstruct/assignadministrator
POST/api/entstruct/entitiesadministrator
POST/api/entstruct/registrationsadministrator
POST/api/entstruct/registrations/:id/deleteadministrator

exec-inventory 1

MethodPathAccess
GET/api/exec-inventorysigned in

export 1

MethodPathAccess
GET/api/export/:whatsigned in

forecast 1

MethodPathAccess
GET/api/forecast/:idsigned in

forecast-all 1

MethodPathAccess
GET/api/forecast-allsigned in

goods-receipts 2

MethodPathAccess
GET/api/goods-receiptssigned in
GET/api/goods-receipts/:idsigned in

import 2

MethodPathAccess
POST/api/import/:modulesigned in
GET/api/import/:module/templatesigned in

inspection-plans 4

MethodPathAccess
GET/api/inspection-planssigned in
POST/api/inspection-planssigned in
GET/api/inspection-plans/:idsigned in
PUT/api/inspection-plans/:idsigned in

inspections 6

MethodPathAccess
GET/api/inspectionssigned in
POST/api/inspectionssigned in
GET/api/inspections/:idsigned in
PUT/api/inspections/:idsigned in
GET/api/inspections/:id/resultssigned in
POST/api/inspections/:id/resultssigned in

inv-agents 4

MethodPathAccess
GET/api/inv-agentssigned in
POST/api/inv-agents/:key/asksigned in
POST/api/inv-agents/conciergesigned in
GET/api/inv-agents/runsadministrator

inventory 1

MethodPathAccess
GET/api/inventorysigned in

item-txn-defaults 2

MethodPathAccess
GET/api/item-txn-defaultssigned in
POST/api/item-txn-defaultssigned in

journals 1

MethodPathAccess
GET/api/journalssigned in

label 1

MethodPathAccess
GET/api/label/:typesigned in

labor 1

MethodPathAccess
GET/api/laborsigned in

landed-costs 3

MethodPathAccess
GET/api/landed-costssigned in
POST/api/landed-costssigned in
POST/api/landed-costs/previewsigned in

locations 3

MethodPathAccess
GET/api/locationssigned in
POST/api/locationssigned in
PUT/api/locations/:idsigned in

login 2

MethodPathAccess
POST/api/loginpublic
POST/api/login/2fapublic

logout 1

MethodPathAccess
POST/api/logoutsigned in

lots 6

MethodPathAccess
GET/api/lotssigned in
POST/api/lotssigned in
PUT/api/lots/:idsigned in
GET/api/lots/:id/genealogysigned in
GET/api/lots/expiringsigned in
POST/api/lots/genealogysigned in

lpn-lines 1

MethodPathAccess
DELETE/api/lpn-lines/:idsigned in

lpns 5

MethodPathAccess
GET/api/lpnssigned in
POST/api/lpnssigned in
PUT/api/lpns/:idsigned in
GET/api/lpns/:id/linessigned in
POST/api/lpns/:id/linessigned in

me 5

MethodPathAccess
POST/api/me/passwordsigned in
GET/api/me/prefssigned in
POST/api/me/prefssigned in
GET/api/me/profilesigned in
PUT/api/me/profilesigned in

move-orders 4

MethodPathAccess
GET/api/move-orderssigned in
POST/api/move-orderssigned in
POST/api/move-orders/:id/cancelsigned in
POST/api/move-orders/:id/executesigned in

movements 1

MethodPathAccess
GET/api/movementssigned in

ncr 3

MethodPathAccess
GET/api/ncrsigned in
POST/api/ncrsigned in
PUT/api/ncr/:idsigned in

next-number 1

MethodPathAccess
GET/api/next-numbersigned in

nxdocs 2

MethodPathAccess
GET/api/nxdocs/:kind/:refsigned in
POST/api/nxdocs/:kind/:refsigned in

nxdocs-file 2

MethodPathAccess
DELETE/api/nxdocs-file/:idsigned in
GET/api/nxdocs-file/:idsigned in

nxtz 3

MethodPathAccess
GET/api/nxtzsigned in
PUT/api/nxtzsigned in
POST/api/nxtz/devicesigned in

packages 5

MethodPathAccess
GET/api/packagessigned in
POST/api/packagessigned in
GET/api/packages/:idsigned in
POST/api/packages/:id/deliversigned in
POST/api/packages/:id/dispatchsigned in

password 2

MethodPathAccess
POST/api/password/forgotpublic
POST/api/password/resetsigned in

perms 2

MethodPathAccess
GET/api/perms/catalogsigned in
GET/api/perms/resolvedadministrator

physical-inventory 5

MethodPathAccess
GET/api/physical-inventorysigned in
POST/api/physical-inventorysigned in
POST/api/physical-inventory/:id/reconcilesigned in
GET/api/physical-inventory/:id/tagssigned in
POST/api/physical-inventory/:id/tagssigned in

physical-tags 1

MethodPathAccess
PUT/api/physical-tags/:idsigned in

planning 8

MethodPathAccess
POST/api/planning/applysigned in
POST/api/planning/calculatesigned in
GET/api/planning/networksigned in
PUT/api/planning/network/:warehouse_idsigned in
GET/api/planning/paramssigned in
POST/api/planning/scenariosigned in
GET/api/planning/scenariossigned in
GET/api/planning/scenarios/comparesigned in

planning-update 1

MethodPathAccess
POST/api/planning-updatesigned in

products 8

MethodPathAccess
GET/api/productssigned in
POST/api/productssigned in
GET/api/products/:idsigned in
PUT/api/products/:idsigned in
DELETE/api/products/:id/imagesigned in
GET/api/products/:id/imagesigned in
POST/api/products/:id/imagesigned in
POST/api/products/:id/standard-costadministrator

provision 1

MethodPathAccess
POST/api/provisionsigned in

purchase-orders 8

MethodPathAccess
GET/api/purchase-orderssigned in
POST/api/purchase-orderssigned in
GET/api/purchase-orders/:idsigned in
PUT/api/purchase-orders/:idsigned in
POST/api/purchase-orders/:id/approveadministrator
GET/api/purchase-orders/:id/bill-draftsigned in
POST/api/purchase-orders/:id/receivesigned in
POST/api/purchase-orders/:id/submitsigned in

push 4

MethodPathAccess
GET/api/push/keysigned in
POST/api/push/subscribesigned in
POST/api/push/testsigned in
POST/api/push/unsubscribesigned in

putaway 2

MethodPathAccess
POST/api/putaway/executesigned in
POST/api/putaway/suggestsigned in

register 7

MethodPathAccess
GET/api/registersigned in
POST/api/registersigned in
GET/api/register/:idsigned in
PUT/api/register/:idsigned in
POST/api/register/:id/shipoutsigned in
POST/api/register/consolidatesigned in
GET/api/register/lookupsigned in

replenishment 2

MethodPathAccess
GET/api/replenishmentsigned in
POST/api/replenishment/create-possigned in

reports 12

MethodPathAccess
GET/api/reports/abcsigned in
GET/api/reports/agingsigned in
GET/api/reports/batch-trackingsigned in
GET/api/reports/cogssigned in
GET/api/reports/goods-movementsigned in
GET/api/reports/low-stocksigned in
GET/api/reports/occupancysigned in
GET/api/reports/order-accuracysigned in
GET/api/reports/physical-inventorysigned in
GET/api/reports/picking-performancesigned in
GET/api/reports/slow-movingsigned in
GET/api/reports/valuationsigned in

requisitions 7

MethodPathAccess
GET/api/requisitionssigned in
POST/api/requisitionssigned in
GET/api/requisitions/:idsigned in
PUT/api/requisitions/:idsigned in
POST/api/requisitions/:id/convertadministrator
POST/api/requisitions/:id/decideadministrator
POST/api/requisitions/:id/submitsigned in

reservations 3

MethodPathAccess
GET/api/reservationssigned in
POST/api/reservationssigned in
POST/api/reservations/:id/releasesigned in

returns-supplier 2

MethodPathAccess
GET/api/returns-suppliersigned in
POST/api/returns-suppliersigned in

rf 6

MethodPathAccess
POST/api/rf/adhoc-movesigned in
GET/api/rf/nextsigned in
POST/api/rf/tasks/:id/claimsigned in
POST/api/rf/tasks/:id/confirmsigned in
POST/api/rf/tasks/:id/skipsigned in
POST/api/rf/tasks/:id/verifysigned in

rfid 1

MethodPathAccess
POST/api/rfid/ingestsigned in

roles 5

MethodPathAccess
GET/api/rolesadministrator
POST/api/rolesadministrator
DELETE/api/roles/:idadministrator
PUT/api/roles/:idadministrator
GET/api/roles/:id/usersadministrator

sales-orders 8

MethodPathAccess
GET/api/sales-orderssigned in
POST/api/sales-orderssigned in
GET/api/sales-orders/:idsigned in
POST/api/sales-orders/:id/allocatesigned in
GET/api/sales-orders/:id/packagessigned in
POST/api/sales-orders/:id/picksigned in
POST/api/sales-orders/:id/returnsigned in
POST/api/sales-orders/:id/shipsigned in

scan 1

MethodPathAccess
GET/api/scansigned in
MethodPathAccess
GET/api/searchsigned in

sender-domains 1

MethodPathAccess
GET/api/sender-domains/:domain/dkimsigned in

sender-emails 6

MethodPathAccess
POST/api/sender-emailssigned in
DELETE/api/sender-emails/:idsigned in
PUT/api/sender-emails/:idsigned in
POST/api/sender-emails/:id/primarysigned in
POST/api/sender-emails/:id/resendsigned in
POST/api/sender-emails/:id/verifysigned in

sender-options 1

MethodPathAccess
GET/api/sender-optionssigned in

sender-prefs 1

MethodPathAccess
GET/api/sender-prefssigned in

serials 3

MethodPathAccess
GET/api/serialssigned in
POST/api/serialssigned in
GET/api/serials/:serial/tracesigned in

session 1

MethodPathAccess
GET/api/sessionsigned in

settings 4

MethodPathAccess
GET/api/settingsadministrator
PUT/api/settingsadministrator
POST/api/settings/rfid-keyadministrator
POST/api/settings/zoho-secretadministrator

shipments 1

MethodPathAccess
GET/api/shipmentssigned in

shipping 1

MethodPathAccess
POST/api/shipping/quotesigned in

shipping-agents 4

MethodPathAccess
GET/api/shipping-agentssigned in
POST/api/shipping-agentssigned in
DELETE/api/shipping-agents/:idsigned in
POST/api/shipping-agents/:id/servicessigned in

skus 5

MethodPathAccess
GET/api/skussigned in
POST/api/skussigned in
DELETE/api/skus/:idsigned in
GET/api/skus/effectivesigned in
GET/api/skus/replenishmentsigned in

slotting 2

MethodPathAccess
POST/api/slotting/applysigned in
GET/api/slotting/recommendationssigned in

sso 2

MethodPathAccess
GET/api/ssosigned in
POST/api/sso/accountssigned in

stock 7

MethodPathAccess
POST/api/stock/adjustsigned in
POST/api/stock/blocksigned in
GET/api/stock/inquirysigned in
GET/api/stock/inquiry/:product_idsigned in
POST/api/stock/issuesigned in
POST/api/stock/movesigned in
POST/api/stock/receivesigned in

storage 1

MethodPathAccess
GET/api/storage/statussigned in

stream 1

MethodPathAccess
GET/api/streamsigned in

subinventories 2

MethodPathAccess
GET/api/subinventoriessigned in
POST/api/subinventoriessigned in

supplier-returns 5

MethodPathAccess
GET/api/supplier-returnssigned in
POST/api/supplier-returnssigned in
GET/api/supplier-returns/:idsigned in
POST/api/supplier-returns/:id/cancelsigned in
POST/api/supplier-returns/:id/shipsigned in

supplier-sites 1

MethodPathAccess
DELETE/api/supplier-sites/:idsigned in

suppliers 13

MethodPathAccess
GET/api/supplierssigned in
POST/api/supplierssigned in
DELETE/api/suppliers/:idadministrator
GET/api/suppliers/:idsigned in
PUT/api/suppliers/:idsigned in
POST/api/suppliers/:id/contactssigned in
DELETE/api/suppliers/:id/contacts/:cidsigned in
POST/api/suppliers/:id/docssigned in
DELETE/api/suppliers/:id/docs/:didsigned in
GET/api/suppliers/:id/docs/:didsigned in
GET/api/suppliers/:id/sitessigned in
POST/api/suppliers/:id/sitessigned in
GET/api/suppliers/next-numbersigned in

supply-demand 1

MethodPathAccess
GET/api/supply-demandsigned in

tasks 3

MethodPathAccess
GET/api/taskssigned in
POST/api/tasks/:id/assignsigned in
POST/api/tasks/:id/completesigned in

trace 10

MethodPathAccess
POST/api/trace/aggregatesigned in
POST/api/trace/commissionsigned in
POST/api/trace/disaggregatesigned in
GET/api/trace/history/:serialsigned in
POST/api/trace/observesigned in
GET/api/trace/recallssigned in
POST/api/trace/recallssigned in
POST/api/trace/recalls/:id/holdsigned in
GET/api/trace/recalls/:id/impactsigned in
GET/api/trace/serialssigned in

track 1

MethodPathAccess
GET/api/tracksigned in

tracking-config 2

MethodPathAccess
GET/api/tracking-configadministrator
PUT/api/tracking-configadministrator

transfer-routes 5

MethodPathAccess
GET/api/transfer-routessigned in
POST/api/transfer-routessigned in
DELETE/api/transfer-routes/:idsigned in
GET/api/transfer-routes/lookupsigned in
GET/api/transfer-routes/metasigned in

transfers 5

MethodPathAccess
GET/api/transferssigned in
POST/api/transferssigned in
GET/api/transfers/:idsigned in
POST/api/transfers/:id/receivesigned in
POST/api/transfers/:id/shipsigned in

txn 10

MethodPathAccess
POST/api/txn/:id/approveadministrator
POST/api/txn/:id/rejectadministrator
GET/api/txn/completedsigned in
POST/api/txn/holdsigned in
POST/api/txn/interorg-transfersigned in
POST/api/txn/misc-issuesigned in
POST/api/txn/misc-receiptsigned in
GET/api/txn/pendingsigned in
POST/api/txn/subinv-transfersigned in
GET/api/txn/thresholdadministrator

uom2 4

MethodPathAccess
GET/api/uom2/:product_idsigned in
PUT/api/uom2/:product_idadministrator
POST/api/uom2/:product_id/capturesigned in
GET/api/uom2/convertsigned in

username 1

MethodPathAccess
POST/api/username/forgotpublic

users 6

MethodPathAccess
GET/api/usersadministrator
POST/api/usersadministrator
DELETE/api/users/:idadministrator
PUT/api/users/:idadministrator
GET/api/users/:id/rolesadministrator
PUT/api/users/:id/rolesadministrator

valuation 2

MethodPathAccess
GET/api/valuationsigned in
GET/api/valuation/:product_idsigned in

waves 4

MethodPathAccess
GET/api/wavessigned in
POST/api/wavessigned in
GET/api/waves/:idsigned in
POST/api/waves/:id/picksigned in

workflow-config 2

MethodPathAccess
GET/api/workflow-configadministrator
PUT/api/workflow-configadministrator

workforce 6

MethodPathAccess
GET/api/workforce/performancesigned in
GET/api/workforce/plansigned in
GET/api/workforce/standardssigned in
POST/api/workforce/standardssigned in
GET/api/workforce/travelsigned in
PUT/api/workforce/travelsigned in

zoho 2

MethodPathAccess
GET/api/zoho/statussigned in
POST/api/zoho/webhooksigned in