Skip to main content

Next Plus API Guide

Asaf Cohen avatar
Written by Asaf Cohen
Updated over 3 weeks ago

Next Plus offers a comprehensive REST API that supports various types of requests and methods, enabling users to perform all available actions programmatically.

API Overview

  • Type: REST API

  • Documentation: While not all methods are fully documented, you can contact the technical team for specific examples and assistance.

Getting Started

Prerequisites

  1. Instance URL

  2. Username and Password

  3. User account with the "API" checkbox enabled

Postman Collection

To help you explore and test the API, we provide a Postman Collection with selected API endpoints.

  1. Download the Postman Collection: Next Plus Postman Collection

  2. Import the collection into Postman

  3. Configure the collection:

    • Click on the Collection root folder (Next Plus)

    • Navigate to the "Variables" tab

    • Update the "baseUrl" variable's "CURRENT VALUE" with your instance URL (e.g., https://company-name.nextplus.io)

    • Save the changes

Authentication

  1. Open the "Login" POST request

  2. Update the request body with your username and password

  3. Execute the request to obtain an access token

  4. Copy the access token

  5. Paste the token in the Collection's "Variables" tab under the "auth" value

  6. Save the changes

Creating Work Orders via API

Follow these steps to create a work order using the API:

  1. Select the Request: Open the "Create Workorder" request under the "Workorder" folder in your Postman collection.

  2. Verify Endpoint: Ensure the request type is POST and the URL is set to:

    {{baseUrl}}/api/Workorders/

  3. Configure Request Body: Update the request body with the payload below.

    • Note: You can add custom fields to the root of the object as needed (e.g., "C_YourFieldName": "Value").

    • Note: Ensure date fields adhere to the ISO 8601 format (e.g., 2025-02-18T10:39:00.559Z).

{
"sku": "",
"quantity": 1,
"productRev": "",
"workorderTypeId": "",
"workorderNumber": "",
"source": "",
"name": "",
"partDesc": "",
"kitItems": [
{
"sku": "",
"quantity": 1,
"rev": "",
"unit": "",
"act": "",
"issuedToKit": false,
"manualIssue": false,
"issuedQuantity": 0,
"serials": [
{
"sku": "",
"serial": ""
}
],
"lotNumbers": [
{
"sku": "",
"lotNumber": "",
"quantity": 1
}
]
}
],
"assignedUsers": [""],
"groups": [""],
"generatedSerials": [
{
"serial": "",
"otherId": ""
}
],
"releasedAt": "2025-02-18T10:39:00.559Z",
"expectedDate": "2025-02-18T10:39:00.559Z",
"parentWorkorderNumber": "",
"erpStatus": "",
"erpClosed": false,
"rmaNumber": "",
"serviceType": "",
"callType": "",
"orderNumber": "",
"orderNumberLine": "",
"orderLine": "",
"customer": {
"accountNumber": "",
"accountName": ""
},
"supplier": {
"name": "",
"description": ""
},
"project": {
"description": "",
"projectNumber": ""
},
"purchaseOrderNumber": "",
"purchaseOrderLine": "",
"erpProductionStartDate": "2025-02-18T10:39:00.559Z",
"erpProductionEndDate": "2025-02-18T10:39:00.559Z",
"externalType": "",
"customerDiagnosis": "",
"description": "",
"faultDescription": "",
"fixDescription": "",
"malfunctionCode": "",
"externalId": "",
"priority": 0,
"_actions": [
{
"actCode": "",
"actDesc": "",
"workCenter": "",
"workCenterCode": "",
"position": 0,
"otherId": 0
}
]
// add needed Custom fields (example: C_AAA)
}
  1. Execute the request: Send the POST command.

  2. Verify: Check the server response for details to confirm the work order was created successfully.

Did this answer your question?