NVMS Exchange (REST)

API web services for integrating with NVMS, Inc.
More information: http://www.nvms.com
Contact Info: support@nvms.com
Version: 2.5-oas3
Testing endpoint: https://sandbox.nvms.com
Production endpoint: https://api.nvms.com

API Collection Download Formats:

View In Swagger

NVMS Exchange (REST).postman_collection.json
NVMS-API-nvms-exchange-2.5-oas3-swagger.json
NVMS-API-nvms-exchange-2.5-oas3-swagger.yaml
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. Authorization Header: Bearer Token

Methods

[ Jump to Models ]

Table of Contents

Lists

NewOrders

Results

Lists

Up 
post /exchange/ClientJobNotes
Get a list of job notes for given order (exchangeClientJobNotesPost)
Pass in a NVMS Order ID reference or FileNumber reference to search

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SearchObject (required)
Body Parameter — JSON Body String

Return type

MessageResponse

Example data

Content-Type: application/json
{
  "code" : "200",
  "ResultReference" : [ {
    "Filenumber" : 133244
  }, {
    "OrderID" : 298383
  }, {
    "Link" : "Link to order page on NVMS site"
  } ],
  "message" : "There was an error processing transaction",
  "results" : "JSON array here",
  "errors" : "Some error here",
  "status" : "Success/NoRecords/Error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MessageResponse

401

Authentication Error MessageResponse

501

Server Error MessageResponse
Up 
get /exchange/ClientServices
Get a list of services currently available on your account (exchangeClientServicesGet)
No parameters

Return type

MessageResponse

Example data

Content-Type: application/json
{
  "code" : "200",
  "ResultReference" : [ {
    "Filenumber" : 133244
  }, {
    "OrderID" : 298383
  }, {
    "Link" : "Link to order page on NVMS site"
  } ],
  "message" : "There was an error processing transaction",
  "results" : "JSON array here",
  "errors" : "Some error here",
  "status" : "Success/NoRecords/Error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MessageResponse

401

Authentication Error MessageResponse

501

Server Error MessageResponse
Up 
get /exchange/OpenJobList
Get a list of open jobs on your account (exchangeOpenJobListGet)
No parameters

Return type

MessageResponse

Example data

Content-Type: application/json
{
  "code" : "200",
  "ResultReference" : [ {
    "Filenumber" : 133244
  }, {
    "OrderID" : 298383
  }, {
    "Link" : "Link to order page on NVMS site"
  } ],
  "message" : "There was an error processing transaction",
  "results" : "JSON array here",
  "errors" : "Some error here",
  "status" : "Success/NoRecords/Error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MessageResponse

401

Authentication Error MessageResponse

501

Server Error MessageResponse
Up 
post /exchange/SingleOrderStatus
Get single order status for query (exchangeSingleOrderStatusPost)
Pass in a NVMS Order ID reference or FileNumber reference to search

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SearchObject (required)
Body Parameter — JSON Body String

Return type

MessageResponse

Example data

Content-Type: application/json
{
  "code" : "200",
  "ResultReference" : [ {
    "Filenumber" : 133244
  }, {
    "OrderID" : 298383
  }, {
    "Link" : "Link to order page on NVMS site"
  } ],
  "message" : "There was an error processing transaction",
  "results" : "JSON array here",
  "errors" : "Some error here",
  "status" : "Success/NoRecords/Error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MessageResponse

401

Authentication Error MessageResponse

501

Server Error MessageResponse

NewOrders

Up 
post /exchange/NewDrawOrder
Adds a new draw order item (exchangeNewDrawOrderPost)
Submit a new draw order to NVMS

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body draw_orders_inner (required)
Body Parameter — JSON Body String

Return type

MessageResponse

Example data

Content-Type: application/json
{
  "code" : "200",
  "ResultReference" : [ {
    "Filenumber" : 133244
  }, {
    "OrderID" : 298383
  }, {
    "Link" : "Link to order page on NVMS site"
  } ],
  "message" : "There was an error processing transaction",
  "results" : "JSON array here",
  "errors" : "Some error here",
  "status" : "Success/NoRecords/Error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MessageResponse

401

Authentication Error MessageResponse

501

Server Error MessageResponse
Up 
post /exchange/NewOrders
Adds a new inspection order item (exchangeNewOrdersPost)
Submit a new inspection order to NVMS

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body orders_inner (required)
Body Parameter — JSON Body String

Return type

MessageResponse

Example data

Content-Type: application/json
{
  "code" : "200",
  "ResultReference" : [ {
    "Filenumber" : 133244
  }, {
    "OrderID" : 298383
  }, {
    "Link" : "Link to order page on NVMS site"
  } ],
  "message" : "There was an error processing transaction",
  "results" : "JSON array here",
  "errors" : "Some error here",
  "status" : "Success/NoRecords/Error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MessageResponse

401

Authentication Error MessageResponse

501

Server Error MessageResponse

Results

Up 
post /exchange/DrawItems
Get draw item details for given NVMS Job ID (exchangeDrawItemsPost)
Pass in a NVMS Order ID reference for results

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SearchObject (required)
Body Parameter — JSON Body String

Return type

MessageResponse

Example data

Content-Type: application/json
{
  "code" : "200",
  "ResultReference" : [ {
    "Filenumber" : 133244
  }, {
    "OrderID" : 298383
  }, {
    "Link" : "Link to order page on NVMS site"
  } ],
  "message" : "There was an error processing transaction",
  "results" : "JSON array here",
  "errors" : "Some error here",
  "status" : "Success/NoRecords/Error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MessageResponse

401

Authentication Error MessageResponse

501

Server Error MessageResponse
Up 
post /exchange/FullDrawExport
Get full draw item details of all property draws for given NVMS Job ID (exchangeFullDrawExportPost)
Pass in a NVMS Order ID reference for results

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SearchObject (required)
Body Parameter — JSON Body String

Return type

MessageResponse

Example data

Content-Type: application/json
{
  "code" : "200",
  "ResultReference" : [ {
    "Filenumber" : 133244
  }, {
    "OrderID" : 298383
  }, {
    "Link" : "Link to order page on NVMS site"
  } ],
  "message" : "There was an error processing transaction",
  "results" : "JSON array here",
  "errors" : "Some error here",
  "status" : "Success/NoRecords/Error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MessageResponse

401

Authentication Error MessageResponse

501

Server Error MessageResponse
Up 
post /exchange/OrderReport
Get order details with photos (exchangeOrderReportPost)
Pass in a NVMS Order ID reference or FileNumber reference for results

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SearchObject (required)
Body Parameter — JSON Body String

Return type

MessageResponse

Example data

Content-Type: application/json
{
  "code" : "200",
  "ResultReference" : [ {
    "Filenumber" : 133244
  }, {
    "OrderID" : 298383
  }, {
    "Link" : "Link to order page on NVMS site"
  } ],
  "message" : "There was an error processing transaction",
  "results" : "JSON array here",
  "errors" : "Some error here",
  "status" : "Success/NoRecords/Error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MessageResponse

401

Authentication Error MessageResponse

501

Server Error MessageResponse
Up 
post /exchange/ReportPDF
Get order results as a PDF document (exchangeReportPDFPost)
Pass in a NVMS Order ID reference or FileNumber reference for results

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SearchObject (required)
Body Parameter — JSON Body String

Return type

MessageResponse

Example data

Content-Type: application/json
{
  "code" : "200",
  "ResultReference" : [ {
    "Filenumber" : 133244
  }, {
    "OrderID" : 298383
  }, {
    "Link" : "Link to order page on NVMS site"
  } ],
  "message" : "There was an error processing transaction",
  "results" : "JSON array here",
  "errors" : "Some error here",
  "status" : "Success/NoRecords/Error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MessageResponse

401

Authentication Error MessageResponse

501

Server Error MessageResponse
Up 
post /exchange/ReportPhotos
Get all order photo attachments (exchangeReportPhotosPost)
Pass in a NVMS Order ID reference or FileNumber reference for results

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SearchObject (required)
Body Parameter — JSON Body String

Return type

MessageResponse

Example data

Content-Type: application/json
{
  "code" : "200",
  "ResultReference" : [ {
    "Filenumber" : 133244
  }, {
    "OrderID" : 298383
  }, {
    "Link" : "Link to order page on NVMS site"
  } ],
  "message" : "There was an error processing transaction",
  "results" : "JSON array here",
  "errors" : "Some error here",
  "status" : "Success/NoRecords/Error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MessageResponse

401

Authentication Error MessageResponse

501

Server Error MessageResponse

Models

[ Jump to Methods ]

Table of Contents

  1. DrawOrders
  2. MessageResponse
  3. Orders
  4. SearchObject
  5. draw_items
  6. draw_orders_inner
  7. orders_inner

DrawOrders Up

MessageResponse Up

API Message response object
code (optional)
String HTTP code returned
example: 200
message (optional)
String Any error message description
example: There was an error processing transaction
status (optional)
String Status string of request
example: Success/NoRecords/Error
errors (optional)
List Multiple error description array
example: Some error here
results (optional)
String JSON String of query results
example: JSON array here
ResultReference (optional)
List Array of new order results
example: [{"Filenumber":133244},{"OrderID":298383},{"Link":"Link to order page on NVMS site"}]

Orders Up

SearchObject Up

Object group used for searching orders
NVMSJobID (optional)
Integer
FileNumber (optional)
String
PONumber (optional)
String

draw_items Up

Order draw items
DrawReference (optional)
String Your unique draw item reference
example: 98412
DrawItem (optional)
String The draw item name
example: Kitchen Cabinets
DrawDescription (optional)
String The draw item description
example: White cabiniets installed with chrome handles
DrawBudget (optional)
String The draw item budget amount
example: 5,000

draw_orders_inner Up

FileNumber
String Your unique property id (required)
example: TEST1234
PropOwner
String Property owner name or address (required)
example: John Doe
PropAddress
String Property street address (required)
example: 123 Main Street
PropCity
String Property city name (required)
example: Anytown
PropState
String Property state abbreviation (required)
example: VA
PropZip
String Property five digit zip code (required)
example: 20112
UserID
Integer User account of person placing this order
example: 9283
PONumber (optional)
String Your customer PO Number if applicable
dbaName (optional)
String DBA value of your account reference
PropDesc (optional)
String Property description
AccContact (optional)
String Account contact name
AccMobile (optional)
String Contact mobile phone number
AccHome (optional)
String Contact home phone number
AccWork (optional)
String Contact work phone number
AccEmail (optional)
String Contact email address (separate multiple with semi-colons)
CallbackReference (optional)
String Webhook URL that we will ping when order is completed
Notes (optional)
String Inspection notes and/or instructions
Services
String Service ids of services you are ordering. Separate multiple with a comma (required)
ReportHTML (optional)
String Report that will be returned with the final PDF report
DrawItemsList (optional)
array[draw_items] When re-ordering a draw for the same FileNumber, leave this field as a blank array and we will reorder the same draw items as in first draw

orders_inner Up

FileNumber
String Your unique property id (required)
example: TEST1234
PropOwner
String Property owner name or address (required)
example: John Doe
PropAddress
String Property street address (required)
example: 123 Main Street
PropCity
String Property city name (required)
example: Anytown
PropState
String Property state abbreviation (required)
example: VA
PropZip
String Property five digit zip code (required)
example: 20112
UserID
Integer User account of person placing this order
example: 9283
PONumber (optional)
String Your customer PO Number if applicable
dbaName (optional)
String DBA value of your account reference
PropDesc (optional)
String Property description
AccContact (optional)
String Account contact name
AccMobile (optional)
String Contact mobile phone number
AccHome (optional)
String Contact home phone number
AccWork (optional)
String Contact work phone number
AccEmail (optional)
String Contact email address (separate multiple with semi-colons)
CallbackReference (optional)
String Webhook URL that we will ping when order is completed
Notes (optional)
String Inspection notes and/or instructions
Services
String Service ids of services you are ordering. Separate multiple with a comma (required)
ReportHTML (optional)
String Report that will be returned with the final PDF report