NAV
Shell HTTP JavaScript Ruby Python PHP Java Go

Introduction

The Nue API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Applications can perform HTTP operations (GET, PUT, POST, PATCH, DELETE) against the REST resources available at Nue. Nue offers a dual-platform mode. If there is a Salesforce connection via Salesforce OAuth2.0 configured in your Nue tenant, some API calls will route the request to Salesforce to read and write data directly in Salesforce.

Nue also supplies a series of composite APIs to ease the process for creating complex objects (e.g. bundle products) with ease.

Authentication

Nue provides API Key authentication as a primary method to secure access to its API endpoints. API Keys are unique identifiers that allow clients to authenticate themselves when making requests to the Nue API. For detailed information about Nue API Keys, please refer to this article.

Please be aware of the following best practices of using API Key to authenticate your APIs:

Nue also authenticates your API requests using your tenant's API Access Key along with an authentication token. If you don’t include your API Access Key (apiAccessKey) in the request header when making an API request, or use an incorrect one, Nue returns a 401 - Unauthorized HTTP response code.

Nue supports the following 2 primary means for API authentication:

JWT

The client can use JWT token to access Nue APIs. This is the recommended way to authenticate into Nue API. The JWT token will be expired in 1 hour.

Code sample for getting access token

# You can also use wget
curl -X POST https://api.nue.io/auth/token \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'


POST https://api.nue.io/auth/token HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "userName": "string",
  "password": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.nue.io/auth/token',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api.nue.io/auth/token',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.nue.io/auth/token', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/auth/token', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/auth/token");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/auth/token", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /auth/token

Body parameter

{
  "userName": "string",
  "password": "string"
}

Responses

Status Meaning Description Schema
200 OK Succeed to get the access token for authentication. AuthenticationResult
401 Unauthorized Unauthorized None

After getting the access token, the client can access Nue's API with header like

Basic

You can also use Basic Authentication along with the API Access Key to authenticate into Nue API. For example, to get tenant details, use the following API:

curl -X GET https://api.nue.io/tenant \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic {basic_token} \
-H 'apiAccessKey: {apiAccessKey}'

Errors

Nue uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Nue's servers (these are rare).

Some 4xx errors that could be handled programmatically (e.g., a card is declined) include an error code that briefly explains the error reported.

Status Code Summary
200 OK -- Everything worked as expected.
400 Bad Request -- The request was unacceptable, often due to missing a required parameter, or a request body that cannot be processed according to the content type.
401 Unauthorized -- No valid API key, auto tokens or user credentials are provided.
403 Forbidden -- The authenticated user doesn't have permissions to perform the request.
404 Not Found -- The requested resource doesn't exist.
500 Internal Server Error -- We had a problem with our server. Try again later.
503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

title: Tenants and Users v1.0 language_tabs: - shell: Shell - http: HTTP - javascript: JavaScript - ruby: Ruby - python: Python - php: PHP - java: Java - go: Go toc_footers: [] includes: [] search: false highlight_theme: darkula headingLevel: 2

Tenants and Users v1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

Authentication

Login History

Retrieve the login history sorted by the login time in a descendant order.

Get Login History

Code samples

# You can also use wget
curl -X GET https://api.nue.io/loginHistory \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.nue.io/loginHistory HTTP/1.1
Host: api.nue.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/loginHistory',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/loginHistory',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/loginHistory', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/loginHistory', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/loginHistory");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/loginHistory", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /loginHistory

Retrieve the login history of the current organization.

Parameters

Name In Type Required Description
startTime query string false The start time of the login history.
Should provide as a string that represent a valid date-time,
which will be parsed using the DateTimeFormatter.ISO_OFFSET_DATE_TIME format follows the pattern:yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
e.g."2023-10-31T12:37:32.000%2B01:00","2023-10-31T12:37:32.000-01:00","2023-10-31T12:37:32.000Z"in URL.
endTime query string false The end time of the login history.
Should provide as a string that represent a valid date-time,
which will be parsed using the DateTimeFormatter.ISO_OFFSET_DATE_TIME format follows the pattern:yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
e.g."2023-10-31T12:37:32.000%2B01:00","2023-10-31T12:37:32.000-01:00","2023-10-31T12:37:32.000Z"in URL.
limit query integer(int32) false The limit of the number of records queried.

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [LoginHistoryVO] false none none
» userId string false none The user ID
» tenantId string false none The tenant ID
» browser string false none The browser or access point the user used to login with
» loginTime string(date-time) false none The login time
» status string false none The login status, Success or Error.
» username string false none User Name
» loginUrl string false none none
» role string false none The user role.
» errorMessage string false none The error message

Enumerated Values

Property Value
status Success
status Error

Get User Login History

Code samples

# You can also use wget
curl -X GET https://api.nue.io/loginHistory/user/{userId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.nue.io/loginHistory/user/{userId} HTTP/1.1
Host: api.nue.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/loginHistory/user/{userId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/loginHistory/user/{userId}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/loginHistory/user/{userId}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/loginHistory/user/{userId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/loginHistory/user/{userId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/loginHistory/user/{userId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /loginHistory/user/{userId}

Retrieve the login history of the current user.

Parameters

Name In Type Required Description
userId path string true User ID
startTime query string false The start time of the login history.
Should provide as a string that represent a valid date-time,
which will be parsed using the DateTimeFormatter.ISO_OFFSET_DATE_TIME format follows the pattern:yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
e.g."2023-10-31T12:37:32.000%2B01:00","2023-10-31T12:37:32.000-01:00","2023-10-31T12:37:32.000Z"in URL.
endTime query string false The end time of the login history.
Should provide as a string that represent a valid date-time,
which will be parsed using the DateTimeFormatter.ISO_OFFSET_DATE_TIME format follows the pattern:yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
e.g."2023-10-31T12:37:32.000%2B01:00","2023-10-31T12:37:32.000-01:00","2023-10-31T12:37:32.000Z"in URL.
limit query integer(int32) false The limit of the number of records queried.

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [LoginHistoryVO] false none none
» userId string false none The user ID
» tenantId string false none The tenant ID
» browser string false none The browser or access point the user used to login with
» loginTime string(date-time) false none The login time
» status string false none The login status, Success or Error.
» username string false none User Name
» loginUrl string false none none
» role string false none The user role.
» errorMessage string false none The error message

Enumerated Values

Property Value
status Success
status Error

Users and Roles

Get User Roles

Code samples

# You can also use wget
curl -X GET https://api.nue.io/users/{userId}/roles \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.nue.io/users/{userId}/roles HTTP/1.1
Host: api.nue.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/users/{userId}/roles',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/users/{userId}/roles',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/users/{userId}/roles', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/users/{userId}/roles', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/users/{userId}/roles");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/users/{userId}/roles", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /users/{userId}/roles

Retrieve all roles associated with the user.

Parameters

Name In Type Required Description
userId path string true The user ID

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [UserRole] false none none
» id string false none none
» name string false none none
» effective boolean false none none
» functions [Function] false none none
»» id string false none none
»» name string false none none
»» label string false none none
»» policy FunctionPolicy false none none
»»» actions [string] false none none
»» featureId string false none none
»» featureName string false none none

Get Connected Salesforce User

Code samples

# You can also use wget
curl -X GET https://api.nue.io/users/salesforce \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.nue.io/users/salesforce HTTP/1.1
Host: api.nue.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/users/salesforce',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/users/salesforce',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/users/salesforce', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/users/salesforce', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/users/salesforce");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/users/salesforce", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /users/salesforce

Retrieve the connected Salesforce user name of the current user.

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK OK SalesforceUserIntegration

Get User Profile

Code samples

# You can also use wget
curl -X GET https://api.nue.io/users/profile \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.nue.io/users/profile HTTP/1.1
Host: api.nue.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/users/profile',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/users/profile',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/users/profile', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/users/profile', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/users/profile");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/users/profile", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /users/profile

Retrieve the user profile information and the user's roles using the API Access Key and Access Token.

Parameters

Name In Type Required Description
with-detail query boolean false none

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK OK GetUserResult

Get Function Policies

Code samples

# You can also use wget
curl -X GET https://api.nue.io/users/functions \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.nue.io/users/functions HTTP/1.1
Host: api.nue.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/users/functions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/users/functions',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/users/functions', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/users/functions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/users/functions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/users/functions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /users/functions

Retrieve the functions the current user has access to.

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Function] false none none
» id string false none none
» name string false none none
» label string false none none
» policy FunctionPolicy false none none
»» actions [string] false none none
» featureId string false none none
» featureName string false none none

Get Roles

Code samples

# You can also use wget
curl -X GET https://api.nue.io/roles \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.nue.io/roles HTTP/1.1
Host: api.nue.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/roles',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/roles',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/roles', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/roles', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/roles");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/roles", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /roles

Retrieve a list of all user roles

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [RoleVO] false none none
» id string false none The user role ID
» name string false none The user role name
» functions [FunctionVO] false none A list of functions this user role has access to.
»» id string false none Function name
»» functionPolicy FunctionPolicy false none none
»»» actions [string] false none none
»» featureName string false none Feature Name

Get Role

Code samples

# You can also use wget
curl -X GET https://api.nue.io/roles/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.nue.io/roles/{id} HTTP/1.1
Host: api.nue.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/roles/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/roles/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/roles/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/roles/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/roles/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/roles/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /roles/{id}

Retrieve detailed information of a user role, including the functions the role has access to.

Parameters

Name In Type Required Description
id path string true The user role ID

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK OK Role

Access Tokens

Acquire, refresh and verify API access tokens.

Verify Token

Code samples

# You can also use wget
curl -X POST https://api.nue.io/auth/verify \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'


POST https://api.nue.io/auth/verify HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json


const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.nue.io/auth/verify',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api.nue.io/auth/verify',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.nue.io/auth/verify', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/auth/verify', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/auth/verify");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/auth/verify", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /auth/verify

Verify the access token.

Body parameter

null

Parameters

Name In Type Required Description
body body TokenVerificationRequest true The token verification request.

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK Verified the access tokens successfully. AuthenticationResult
401 Unauthorized Unauthorized None

Response Schema

Get Access Token

Code samples

# You can also use wget
curl -X POST https://api.nue.io/auth/token \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'


POST https://api.nue.io/auth/token HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json


const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.nue.io/auth/token',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api.nue.io/auth/token',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.nue.io/auth/token', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/auth/token', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/auth/token");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/auth/token", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /auth/token

Acquire the access token, refresh token and API access key for a user.

In Nue, a user may have access to more than one tenants in an organization. Use showTenants parameter to show all the tenants the user has access to in the organization.

Body parameter

null

Parameters

Name In Type Required Description
body body AuthenticationRequest true The authentication request.

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK Received the access tokens successfully. AuthenticationResult
401 Unauthorized Unauthorized None

Response Schema

Revoke refresh token

Code samples

# You can also use wget
curl -X POST https://api.nue.io/auth/revokeToken \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*'


POST https://api.nue.io/auth/revokeToken HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*


const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('https://api.nue.io/auth/revokeToken',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*'
}

result = RestClient.post 'https://api.nue.io/auth/revokeToken',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*'
}

r = requests.post('https://api.nue.io/auth/revokeToken', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/auth/revokeToken', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/auth/revokeToken");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/auth/revokeToken", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /auth/revokeToken

Revoke the refresh token

Body parameter

null

Parameters

Name In Type Required Description
body body RevokeTokenRequest true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK string

Refresh Token

Code samples

# You can also use wget
curl -X POST https://api.nue.io/auth/refreshToken \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'apiAccessKey: null'


POST https://api.nue.io/auth/refreshToken HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json
apiAccessKey: null


const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'apiAccessKey':null
};

fetch('https://api.nue.io/auth/refreshToken',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'apiAccessKey' => null
}

result = RestClient.post 'https://api.nue.io/auth/refreshToken',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'apiAccessKey': null
}

r = requests.post('https://api.nue.io/auth/refreshToken', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'apiAccessKey' => 'null',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/auth/refreshToken', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/auth/refreshToken");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "apiAccessKey": []string{"null"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/auth/refreshToken", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /auth/refreshToken

Refresh the access token.

Body parameter

null

Parameters

Name In Type Required Description
apiAccessKey header string true API Access Key
body body TokenRefreshRequest true The authentication request

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK Received the access tokens successfully AuthenticationResult
401 Unauthorized Unauthorized None

Response Schema

Schemas

TokenVerificationRequest

null

Properties

Name Type Required Restrictions Description
apiAccessKey string true none none
token string true none none

AuthenticationResult

null

Properties

Name Type Required Restrictions Description
token string false none none
refreshToken string false none none
expiresIn integer(int32) false none none
challenge Challenge false none none
tenants [UserMappedTenantResponse] false none none

Challenge

null

Properties

Name Type Required Restrictions Description
session string false none none
name string false none none

UserMappedTenantResponse

null

Properties

Name Type Required Restrictions Description
apiAccessKey string false none none
tenantNumber integer(int32) false none none
tenantName string false none none
tenantId string false none none
orgId string false none none
orgName string false none none

AuthenticationRequest

null

Properties

Name Type Required Restrictions Description
userName string true none none
password string true none none
showTenants boolean false none none

RevokeTokenRequest

null

Properties

Name Type Required Restrictions Description
token string true none none
userName string true none none

TokenRefreshRequest

null

Properties

Name Type Required Restrictions Description
refreshToken string true none none
userName string true none none

Function

null

Properties

Name Type Required Restrictions Description
id string false none none
name string false none none
label string false none none
policy FunctionPolicy false none none
featureId string false none none
featureName string false none none

FunctionPolicy

null

Properties

Name Type Required Restrictions Description
actions [string] false none none

UserRole

null

Properties

Name Type Required Restrictions Description
id string false none none
name string false none none
effective boolean false none none
functions [Function] false none none

SalesforceUserIntegration

null

Properties

Name Type Required Restrictions Description
userName string false none none

Address

null

Properties

Name Type Required Restrictions Description
street string false none none
state string false none none
city string false none none
zipCode string false none none
country string false none none

GetUserResult

null

Properties

Name Type Required Restrictions Description
id string false none none
status string false none none
email string false none none
phoneNumber string false none none
firstName string false none none
lastName string false none none
timeZone string false none none
locale string false none none
currency string false none none
effectiveRoleId string false none none
userName string false none none
salesforceUserName string false none none
name string false none none
roles [Role] false none none
userDetail UserDetail false none none
tenantId string false none none
lastLoginTime string(date-time) false none none
createdDate string(date-time) false none none
imageSignedUrl string false none none
mfaEnabled boolean false none none

Role

null

Properties

Name Type Required Restrictions Description
id string false none none
name string false none none
effective boolean false none none
functions [string] false none none
features [string] false none none

UserDetail

null

Properties

Name Type Required Restrictions Description
title string false none none
department string false none none
division string false none none
address Address false none none

FunctionVO

null

A list of functions this user role has access to.

Properties

Name Type Required Restrictions Description
id string false none Function name
functionPolicy FunctionPolicy false none none
featureName string false none Feature Name

RoleVO

null

Properties

Name Type Required Restrictions Description
id string false none The user role ID
name string false none The user role name
functions [FunctionVO] false none A list of functions this user role has access to.

LoginHistoryVO

null

Properties

Name Type Required Restrictions Description
userId string false none The user ID
tenantId string false none The tenant ID
browser string false none The browser or access point the user used to login with
loginTime string(date-time) false none The login time
status string false none The login status, Success or Error.
username string false none User Name
loginUrl string false none none
role string false none The user role.
errorMessage string false none The error message

Enumerated Values

Property Value
status Success
status Error

title: Metadata v1.0 language_tabs: - shell: Shell - http: HTTP - javascript: JavaScript - ruby: Ruby - python: Python - php: PHP - java: Java - go: Go toc_footers: [] includes: [] search: false highlight_theme: darkula headingLevel: 2

Metadata v1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

Authentication

Layouts

A Layout represents page layouts or views of an object. Nue supports the following types of layouts:

Create a Layout

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/metadata/layouts \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json;charset=UTF-8' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.nue.io/v1/metadata/layouts HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json;charset=UTF-8


const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json;charset=UTF-8',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/layouts',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json;charset=UTF-8',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/metadata/layouts',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json;charset=UTF-8',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/metadata/layouts', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json;charset=UTF-8',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/metadata/layouts', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/layouts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json;charset=UTF-8"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/metadata/layouts", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /metadata/layouts

Create the metadata of a layout.

Body parameter

null

Parameters

Name In Type Required Description
body body CreateLayoutRequest true The request to create a layout.

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK OK LayoutChecksumResponse

Delete Layouts

Code samples

# You can also use wget
curl -X DELETE https://api.nue.io/v1/metadata/layouts \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json;charset=UTF-8' \
  -H 'Authorization: Bearer {access-token}'


DELETE https://api.nue.io/v1/metadata/layouts HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json;charset=UTF-8


const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json;charset=UTF-8',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/layouts',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json;charset=UTF-8',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.nue.io/v1/metadata/layouts',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json;charset=UTF-8',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.nue.io/v1/metadata/layouts', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json;charset=UTF-8',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.nue.io/v1/metadata/layouts', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/layouts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json;charset=UTF-8"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.nue.io/v1/metadata/layouts", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /metadata/layouts

Delete a list of layouts.

Body parameter

null

Parameters

Name In Type Required Description
body body BatchLayoutsApiNameRequest true The request to delete layouts

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK OK LayoutResponse

Get a Layout

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/metadata/layouts/{layoutApiName} \
  -H 'Accept: application/json;charset=UTF-8' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.nue.io/v1/metadata/layouts/{layoutApiName} HTTP/1.1
Host: api.nue.io
Accept: application/json;charset=UTF-8



const headers = {
  'Accept':'application/json;charset=UTF-8',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/layouts/{layoutApiName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json;charset=UTF-8',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/metadata/layouts/{layoutApiName}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json;charset=UTF-8',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/metadata/layouts/{layoutApiName}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json;charset=UTF-8',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/metadata/layouts/{layoutApiName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/layouts/{layoutApiName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json;charset=UTF-8"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/metadata/layouts/{layoutApiName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /metadata/layouts/{layoutApiName}

Retrieve the layout configuration of a given layout.

Parameters

Name In Type Required Description
layoutApiName path string true none

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK OK GetLayoutDetailResponse

Update a Layout

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/metadata/layouts/{layoutApiName} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json;charset=UTF-8' \
  -H 'Authorization: Bearer {access-token}'


PATCH https://api.nue.io/v1/metadata/layouts/{layoutApiName} HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json;charset=UTF-8


const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json;charset=UTF-8',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/layouts/{layoutApiName}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json;charset=UTF-8',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/metadata/layouts/{layoutApiName}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json;charset=UTF-8',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/metadata/layouts/{layoutApiName}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json;charset=UTF-8',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/metadata/layouts/{layoutApiName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/layouts/{layoutApiName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json;charset=UTF-8"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/metadata/layouts/{layoutApiName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /metadata/layouts/{layoutApiName}

Update the metadata of a layout.

Body parameter

null

Parameters

Name In Type Required Description
layoutApiName path string true The layout name.
body body UpdateLayoutRequest true The request to update a layout.

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK OK LayoutChecksumResponse

Deactivate Layouts

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/metadata/layouts/deactivate \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json;charset=UTF-8' \
  -H 'Authorization: Bearer {access-token}'


PATCH https://api.nue.io/v1/metadata/layouts/deactivate HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json;charset=UTF-8


const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json;charset=UTF-8',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/layouts/deactivate',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json;charset=UTF-8',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/metadata/layouts/deactivate',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json;charset=UTF-8',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/metadata/layouts/deactivate', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json;charset=UTF-8',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/metadata/layouts/deactivate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/layouts/deactivate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json;charset=UTF-8"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/metadata/layouts/deactivate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /metadata/layouts/deactivate

Deactivate the list of layouts.

Body parameter

null

Parameters

Name In Type Required Description
body body BatchLayoutsApiNameRequest true The request to deactivate layouts

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK OK LayoutResponse

Activate Layouts

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/metadata/layouts/activate \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json;charset=UTF-8' \
  -H 'Authorization: Bearer {access-token}'


PATCH https://api.nue.io/v1/metadata/layouts/activate HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json;charset=UTF-8


const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json;charset=UTF-8',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/layouts/activate',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json;charset=UTF-8',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/metadata/layouts/activate',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json;charset=UTF-8',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/metadata/layouts/activate', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json;charset=UTF-8',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/metadata/layouts/activate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/layouts/activate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json;charset=UTF-8"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/metadata/layouts/activate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /metadata/layouts/activate

Activate a list of layouts.

Body parameter

null

Parameters

Name In Type Required Description
body body BatchLayoutsApiNameRequest true The request to activate layouts

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK OK LayoutResponse

Objects

An object field represents a certain attribute of a business object. Nue supports various types of standard and custom fields.

Sync Custom Fields

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/metadata/orders:sync-all \
  -H 'Authorization: Bearer {access-token}'


POST https://api.nue.io/v1/metadata/orders:sync-all HTTP/1.1
Host: api.nue.io



const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/orders:sync-all',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/metadata/orders:sync-all',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/metadata/orders:sync-all', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/metadata/orders:sync-all', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/orders:sync-all");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/metadata/orders:sync-all", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /metadata/orders:sync-all

Synchronize custom fields of all objects in Revenue Manager, including Order, Invoice, etc.

Responses

Status Meaning Description Schema
200 OK OK None

Delete Custom Field

Code samples

# You can also use wget
curl -X DELETE https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName} \
  -H 'Accept: application/json;charset=UTF-8' \
  -H 'Authorization: Bearer {access-token}'


DELETE https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName} HTTP/1.1
Host: api.nue.io
Accept: application/json;charset=UTF-8



const headers = {
  'Accept':'application/json;charset=UTF-8',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json;charset=UTF-8',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json;charset=UTF-8',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json;charset=UTF-8',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json;charset=UTF-8"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /metadata/objects/{objectApiName}/fields/{fieldApiName}

Delete a custom field.

Parameters

Name In Type Required Description
objectApiName path string true The object name.
fieldApiName path string true The field name.

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Update Field Metadata

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


PATCH https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName} HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "autoNumberSetting": {
    "displayFormat": "CUSTOM-INV-{00000000}",
    "startValue": 1
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /metadata/objects/{objectApiName}/fields/{fieldApiName}

Update the field metadata and currently only supports updating the format and starting value of an auto number field

Body parameter

Update Auto Number Metadata Request Example

{
  "autoNumberSetting": {
    "displayFormat": "CUSTOM-INV-{00000000}",
    "startValue": 1
  }
}

Parameters

Name In Type Required Description
objectApiName path string true The object name
fieldApiName path string true The field name
body body UpdateFieldRequest true The request to update a field's metadata.

Example responses

Update Field Metadata Response

{
  "name": "name"
}

Responses

Status Meaning Description Schema
default Default default response CreateFieldResponse

Describe all objects

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/metadata/objects \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.nue.io/v1/metadata/objects HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/objects',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/metadata/objects',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/metadata/objects', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/metadata/objects', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/objects");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/metadata/objects", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /metadata/objects

Retrieve definition of all objects, including object properties, standard fields and custom fields.

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [DescribeRubyObjectResponse] false none none
» apiName string false none none
» name string false none none
» description string false none none
» salesforceApiName string false none none
» endpoint string false none none
» customizable boolean false none none
» feature string false none none
» objectType string false none none
» pluralName string false none none
» nameField string false none none
» fields [FieldMetadata] false none none
»» apiName string false none none
»» name string false none none
»» type string false none none
»» description string false none none
»» creatable boolean false none none
»» updatable boolean false none none
»» filterable boolean false none none
»» sortable boolean false none none
»» customField boolean false none none
»» encrypted boolean false none none
»» defaultValue string false none none
»» inlineHelpText string false none none
»» required boolean false none none
»» unique boolean false none none
»» exportId boolean false none none
»» minLength integer(int32) false none none
»» maxLength integer(int32) false none none
»» valueSet ValueSet false none none
»»» apiName string false none none
»»» name string false none none
»»» defaultValue string false none none
»»» alphabeticallyOrdered boolean false none none
»»» valuePairs [ValuePair] false none none
»»»» apiName string false none none
»»»» name string false none none
»»»» orderNumber integer(int32) false none none
»»»» active boolean false none none
»» precision integer(int32) false none none
»» scale integer(int32) false none none
»» salesforceApiName string false none none
»» lookupRelation LookupRelation false none none
»»» referenceTo string false none none
»»» referenceField string false none none
»»» relationName string false none none
»»» relationLabel string false none none
»» masterDetailRelation MasterDetailRelation false none none
»»» referenceTo string false none none
»»» referenceField string false none none
»»» relationName string false none none
»»» relationLabel string false none none
»»» detailRelationName string false none none
»»» detailRelationLabel string false none none
»» autoNumberSetting AutoNumberSetting false none auto number customization settings including displayFormat and startValue
»»» displayFormat string false none Auto number display format
»»» startValue integer(int64) false none Starting number of the auto number field
» relations [RelationMetadata] false none none
»» referenceObjectName string false none none
»» referenceFieldName string false none none
»» relationFieldName string false none none
»» relationName string false none none
»» relationLabel string false none none
»» relationType string false none none
»» detailAccessPolicy DetailAccessPolicy false none none
»»» viewable boolean false none none
»»» creatable boolean false none none
»»» updatable boolean false none none

Get Object Definition

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/metadata/objects/{objectName} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.nue.io/v1/metadata/objects/{objectName} HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/objects/{objectName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/metadata/objects/{objectName}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/metadata/objects/{objectName}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/metadata/objects/{objectName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/objects/{objectName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/metadata/objects/{objectName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /metadata/objects/{objectName}

Retrieve the object definition, including object properties, standard fields and custom fields.

Parameters

Name In Type Required Description
objectName path string true The object name, for example, Customer
withIntegrationMapping query boolean false Whether to include integration mapping

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK DescribeRubyObjectResponse

Get Custom Fields of Object

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/metadata/objects/{objectApiName}/fields \
  -H 'Accept: application/json;charset=UTF-8' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.nue.io/v1/metadata/objects/{objectApiName}/fields HTTP/1.1
Host: api.nue.io
Accept: application/json;charset=UTF-8



const headers = {
  'Accept':'application/json;charset=UTF-8',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/objects/{objectApiName}/fields',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json;charset=UTF-8',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/metadata/objects/{objectApiName}/fields',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json;charset=UTF-8',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/metadata/objects/{objectApiName}/fields', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json;charset=UTF-8',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/metadata/objects/{objectApiName}/fields', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/objects/{objectApiName}/fields");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json;charset=UTF-8"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/metadata/objects/{objectApiName}/fields", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /metadata/objects/{objectApiName}/fields

Retrieve all custom fields of a given object identified by objectApiName

Parameters

Name In Type Required Description
objectApiName path string true The object name.

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [FieldMetadata] false none none
» apiName string false none none
» name string false none none
» type string false none none
» description string false none none
» creatable boolean false none none
» updatable boolean false none none
» filterable boolean false none none
» sortable boolean false none none
» customField boolean false none none
» encrypted boolean false none none
» defaultValue string false none none
» inlineHelpText string false none none
» required boolean false none none
» unique boolean false none none
» exportId boolean false none none
» minLength integer(int32) false none none
» maxLength integer(int32) false none none
» valueSet ValueSet false none none
»» apiName string false none none
»» name string false none none
»» defaultValue string false none none
»» alphabeticallyOrdered boolean false none none
»» valuePairs [ValuePair] false none none
»»» apiName string false none none
»»» name string false none none
»»» orderNumber integer(int32) false none none
»»» active boolean false none none
» precision integer(int32) false none none
» scale integer(int32) false none none
» salesforceApiName string false none none
» lookupRelation LookupRelation false none none
»» referenceTo string false none none
»» referenceField string false none none
»» relationName string false none none
»» relationLabel string false none none
» masterDetailRelation MasterDetailRelation false none none
»» referenceTo string false none none
»» referenceField string false none none
»» relationName string false none none
»» relationLabel string false none none
»» detailRelationName string false none none
»» detailRelationLabel string false none none
» autoNumberSetting AutoNumberSetting false none auto number customization settings including displayFormat and startValue
»» displayFormat string false none Auto number display format
»» startValue integer(int64) false none Starting number of the auto number field

Filters

A Filter can be persisted for every Nue object based on the object attributes and shared to all Nue users.

Get Filter

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/metadata/filters/{objectApiName} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.nue.io/v1/metadata/filters/{objectApiName} HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/filters/{objectApiName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/metadata/filters/{objectApiName}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/metadata/filters/{objectApiName}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/metadata/filters/{objectApiName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/filters/{objectApiName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/metadata/filters/{objectApiName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /metadata/filters/{objectApiName}

Retrieve the filter definition, given the object name and the filter ID.

Parameters

Name In Type Required Description
objectApiName path string true The object name.
id path string true The filter ID.

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK FilterMetadataVO

Create Filter

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/metadata/filters/{objectApiName} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.nue.io/v1/metadata/filters/{objectApiName} HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*


const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/filters/{objectApiName}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/metadata/filters/{objectApiName}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/metadata/filters/{objectApiName}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/metadata/filters/{objectApiName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/filters/{objectApiName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/metadata/filters/{objectApiName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /metadata/filters/{objectApiName}

Create a saved filter that is accessible by all Nue users.

Body parameter

null

Parameters

Name In Type Required Description
objectApiName path string true The object name.
body body ConfigureFilterRequest true The request to save a new filter

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK FilterMetadataVO

Delete Filter

Code samples

# You can also use wget
curl -X DELETE https://api.nue.io/v1/metadata/filters/{objectApiName}/{id} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


DELETE https://api.nue.io/v1/metadata/filters/{objectApiName}/{id} HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/filters/{objectApiName}/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.nue.io/v1/metadata/filters/{objectApiName}/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.nue.io/v1/metadata/filters/{objectApiName}/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.nue.io/v1/metadata/filters/{objectApiName}/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/filters/{objectApiName}/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.nue.io/v1/metadata/filters/{objectApiName}/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /metadata/filters/{objectApiName}/{id}

Delete a saved filter by ID.

Parameters

Name In Type Required Description
objectApiName path string true The object name.
id path string true The filter ID.

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK string

Update Filter

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/metadata/filters/{objectApiName}/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


PATCH https://api.nue.io/v1/metadata/filters/{objectApiName}/{id} HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*


const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/filters/{objectApiName}/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/metadata/filters/{objectApiName}/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/metadata/filters/{objectApiName}/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/metadata/filters/{objectApiName}/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/filters/{objectApiName}/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/metadata/filters/{objectApiName}/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /metadata/filters/{objectApiName}/{id}

Update a saved filter.

Body parameter

null

Parameters

Name In Type Required Description
objectApiName path string true The object name.
id path string true The filter ID.
body body ConfigureFilterRequest true The request to update a filter

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK FilterMetadataVO

Get Filters

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/metadata/filters/{objectApiName}/list \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.nue.io/v1/metadata/filters/{objectApiName}/list HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/filters/{objectApiName}/list',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/metadata/filters/{objectApiName}/list',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/metadata/filters/{objectApiName}/list', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/metadata/filters/{objectApiName}/list', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/filters/{objectApiName}/list");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/metadata/filters/{objectApiName}/list", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /metadata/filters/{objectApiName}/list

Retrieve a list of filter accessible by the current user.

Parameters

Name In Type Required Description
objectApiName path string true The object name.

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [FilterMetadataVO] false none none
» conditions [object] false none none
»» additionalProperties object false none none
» name string false none none
» id string false none none

Value Sets

A value set is a set of picklist values that can be used for single-select and multi-select picklist fields.

Get Value Sets

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/metadata/valueSets \
  -H 'Accept: application/json;charset=UTF-8' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.nue.io/v1/metadata/valueSets HTTP/1.1
Host: api.nue.io
Accept: application/json;charset=UTF-8



const headers = {
  'Accept':'application/json;charset=UTF-8',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/valueSets',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json;charset=UTF-8',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/metadata/valueSets',
  params: {
  'names' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json;charset=UTF-8',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/metadata/valueSets', params={
  'names': null
}, headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json;charset=UTF-8',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/metadata/valueSets', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/valueSets");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json;charset=UTF-8"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/metadata/valueSets", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /metadata/valueSets

Retrieve values of value sets , given the value set names.

Parameters

Name In Type Required Description
names query string true The value set names. Eg: Name1,Name2

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ValueSetResponse] false none none
» apiName string false none none
» name string false none none
» values [ValuePair] false none none
»» apiName string false none none
»» name string false none none
»» orderNumber integer(int32) false none none
»» active boolean false none none
» defaultValue string false none none
» alphabeticallyOrdered boolean false none none

Create Value Set

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/metadata/valueSets \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.nue.io/v1/metadata/valueSets HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*


const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/valueSets',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/metadata/valueSets',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/metadata/valueSets', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/metadata/valueSets', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/valueSets");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/metadata/valueSets", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /metadata/valueSets

Create a value set

Body parameter

null

Parameters

Name In Type Required Description
body body CreateValueSetRequest true The request to create a value set.

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK CreateValueSetResponse

Sync Custom Fields

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/metadata/valueSets:sync-all


POST https://api.nue.io/v1/metadata/valueSets:sync-all HTTP/1.1
Host: api.nue.io



fetch('https://api.nue.io/v1/metadata/valueSets:sync-all',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

result = RestClient.post 'https://api.nue.io/v1/metadata/valueSets:sync-all',
  params: {
  }

p JSON.parse(result)


import requests

r = requests.post('https://api.nue.io/v1/metadata/valueSets:sync-all')

print(r.json())


<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/metadata/valueSets:sync-all', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/valueSets:sync-all");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/metadata/valueSets:sync-all", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /metadata/valueSets:sync-all

Synchronize all custom fields from Salesforce. Please make sure the custom fields have been added into Field Set "Fields Expose to Nue" on Salesforce side.

Responses

Status Meaning Description Schema
200 OK OK None

Sync Picklist Values

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/metadata/valueSets/{objectName}/{fieldName}:sync


POST https://api.nue.io/v1/metadata/valueSets/{objectName}/{fieldName}:sync HTTP/1.1
Host: api.nue.io



fetch('https://api.nue.io/v1/metadata/valueSets/{objectName}/{fieldName}:sync',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

result = RestClient.post 'https://api.nue.io/v1/metadata/valueSets/{objectName}/{fieldName}:sync',
  params: {
  }

p JSON.parse(result)


import requests

r = requests.post('https://api.nue.io/v1/metadata/valueSets/{objectName}/{fieldName}:sync')

print(r.json())


<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/metadata/valueSets/{objectName}/{fieldName}:sync', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/valueSets/{objectName}/{fieldName}:sync");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/metadata/valueSets/{objectName}/{fieldName}:sync", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /metadata/valueSets/{objectName}/{fieldName}:sync

Synchronize a field-level value set by its object and field names.

Parameters

Name In Type Required Description
objectName path string true none
fieldName path string true none

Responses

Status Meaning Description Schema
200 OK OK None

Sync Global Value Sets

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/metadata/valueSets/{nueApiName}:sync


POST https://api.nue.io/v1/metadata/valueSets/{nueApiName}:sync HTTP/1.1
Host: api.nue.io



fetch('https://api.nue.io/v1/metadata/valueSets/{nueApiName}:sync',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

result = RestClient.post 'https://api.nue.io/v1/metadata/valueSets/{nueApiName}:sync',
  params: {
  }

p JSON.parse(result)


import requests

r = requests.post('https://api.nue.io/v1/metadata/valueSets/{nueApiName}:sync')

print(r.json())


<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/metadata/valueSets/{nueApiName}:sync', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/valueSets/{nueApiName}:sync");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/metadata/valueSets/{nueApiName}:sync", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /metadata/valueSets/{nueApiName}:sync

Synchronize global value sets by their API names.

Parameters

Name In Type Required Description
nueApiName path string true none
crm-api-name query string false none

Responses

Status Meaning Description Schema
200 OK OK None

Get Value Set

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/metadata/valueSets/{valueSetName} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.nue.io/v1/metadata/valueSets/{valueSetName} HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/valueSets/{valueSetName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/metadata/valueSets/{valueSetName}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/metadata/valueSets/{valueSetName}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/metadata/valueSets/{valueSetName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/valueSets/{valueSetName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/metadata/valueSets/{valueSetName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /metadata/valueSets/{valueSetName}

Retrieve values of a value set, given the value set name.

Parameters

Name In Type Required Description
valueSetName path string true The value set name.

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK CreateValueSetResponse

Delete Value Set

Code samples

# You can also use wget
curl -X DELETE https://api.nue.io/v1/metadata/valueSets/{valueSetName} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


DELETE https://api.nue.io/v1/metadata/valueSets/{valueSetName} HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/valueSets/{valueSetName}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.nue.io/v1/metadata/valueSets/{valueSetName}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.nue.io/v1/metadata/valueSets/{valueSetName}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.nue.io/v1/metadata/valueSets/{valueSetName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/valueSets/{valueSetName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.nue.io/v1/metadata/valueSets/{valueSetName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /metadata/valueSets/{valueSetName}

Delete a value set, given the value set name.

Parameters

Name In Type Required Description
valueSetName path string true The value set name.

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Update Value Set

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/metadata/valueSets/{valueSetName} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


PATCH https://api.nue.io/v1/metadata/valueSets/{valueSetName} HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*


const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/valueSets/{valueSetName}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/metadata/valueSets/{valueSetName}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/metadata/valueSets/{valueSetName}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/metadata/valueSets/{valueSetName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/valueSets/{valueSetName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/metadata/valueSets/{valueSetName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /metadata/valueSets/{valueSetName}

Update a value set, given the value set name.

Body parameter

null

Parameters

Name In Type Required Description
valueSetName path string true The value set name.
body body CreateValueSetRequest true The request to update a value set.

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK CreateValueSetResponse

Update Value Set Values

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/metadata/valueSets/{valueSetName}/values \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


PATCH https://api.nue.io/v1/metadata/valueSets/{valueSetName}/values HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*


const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/valueSets/{valueSetName}/values',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/metadata/valueSets/{valueSetName}/values',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/metadata/valueSets/{valueSetName}/values', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/metadata/valueSets/{valueSetName}/values', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/metadata/valueSets/{valueSetName}/values");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/metadata/valueSets/{valueSetName}/values", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /metadata/valueSets/{valueSetName}/values

Update a list of values in the value set.

Body parameter

null

Parameters

Name In Type Required Description
valueSetName path string true The value set name.
body body PatchValueSetValuesRequest true The request to update values in a value set.

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK CreateValueSetResponse

Schemas

CreateValueSetRequest

null

Properties

Name Type Required Restrictions Description
apiName string true none none
name string true none none
values [ValuePair] false none none
defaultValue string false none none
alphabeticallyOrdered boolean false none none

ValuePair

null

Properties

Name Type Required Restrictions Description
apiName string false none none
name string false none none
orderNumber integer(int32) false none none
active boolean false none none

CreateValueSetResponse

null

Properties

Name Type Required Restrictions Description
apiName string false none none
name string false none none
values [ValuePair] false none none
defaultValue string false none none
alphabeticallyOrdered boolean false none none

CreateLayoutRequest

null

Properties

Name Type Required Restrictions Description
type string true none none
apiName string true none none
name string true none none
objectApiName string false none none
content string false none none
tags [string] false none none

Enumerated Values

Property Value
type FormView
type ListView
type SearchView

LayoutChecksumResponse

null

Properties

Name Type Required Restrictions Description
status string false none none
message string false none none
apiName string false none none
contentChecksum string false none none

Enumerated Values

Property Value
status Succeeded
status Failed

ConfigureFilterRequest

null

Properties

Name Type Required Restrictions Description
name string false none none
conditions [object] false none none
» additionalProperties object false none none

FilterMetadataVO

null

Properties

Name Type Required Restrictions Description
conditions [object] false none none
» additionalProperties object false none none
name string false none none
id string false none none

PatchValueSetValuesRequest

null

Properties

Name Type Required Restrictions Description
values [ValuePair] true none none

AutoNumberSetting

{
  "displayFormat": "CUSTOM-INV-{00000000}",
  "startValue": 1
}

auto number customization settings including displayFormat and startValue

Properties

Name Type Required Restrictions Description
displayFormat string false none Auto number display format
startValue integer(int64) false none Starting number of the auto number field

UpdateFieldRequest

null

Properties

Name Type Required Restrictions Description
name string false none none
description string false none none
creatable boolean false none none
updatable boolean false none none
filterable boolean false none none
sortable boolean false none none
encrypted boolean false none none
inlineHelpText string false none none
required boolean false none none
unique boolean false none none
length integer(int32) false none none
valueSet string false none none
precision integer(int32) false none none
scale integer(int32) false none none
autoNumberSetting AutoNumberSetting false none auto number customization settings including displayFormat and startValue

CreateFieldResponse

null

Properties

Name Type Required Restrictions Description
name string false none none

UpdateLayoutRequest

null

Properties

Name Type Required Restrictions Description
name string false none none
content string false none none
tags [string] false none none

BatchLayoutsApiNameRequest

null

Properties

Name Type Required Restrictions Description
layoutsApiName [string] true none none

LayoutResponse

null

Properties

Name Type Required Restrictions Description
status string false none none
message string false none none

Enumerated Values

Property Value
status Succeeded
status Failed

ValueSetResponse

null

Properties

Name Type Required Restrictions Description
apiName string false none none
name string false none none
values [ValuePair] false none none
defaultValue string false none none
alphabeticallyOrdered boolean false none none

DescribeRubyObjectResponse

null

Properties

Name Type Required Restrictions Description
apiName string false none none
name string false none none
description string false none none
salesforceApiName string false none none
endpoint string false none none
customizable boolean false none none
feature string false none none
objectType string false none none
pluralName string false none none
nameField string false none none
fields [FieldMetadata] false none none
relations [RelationMetadata] false none none

DetailAccessPolicy

null

Properties

Name Type Required Restrictions Description
viewable boolean false none none
creatable boolean false none none
updatable boolean false none none

FieldMetadata

null

Properties

Name Type Required Restrictions Description
apiName string false none none
name string false none none
type string false none none
description string false none none
creatable boolean false none none
updatable boolean false none none
filterable boolean false none none
sortable boolean false none none
customField boolean false none none
encrypted boolean false none none
defaultValue string false none none
inlineHelpText string false none none
required boolean false none none
unique boolean false none none
exportId boolean false none none
minLength integer(int32) false none none
maxLength integer(int32) false none none
valueSet ValueSet false none none
precision integer(int32) false none none
scale integer(int32) false none none
salesforceApiName string false none none
lookupRelation LookupRelation false none none
masterDetailRelation MasterDetailRelation false none none
autoNumberSetting AutoNumberSetting false none auto number customization settings including displayFormat and startValue

LookupRelation

null

Properties

Name Type Required Restrictions Description
referenceTo string false none none
referenceField string false none none
relationName string false none none
relationLabel string false none none

MasterDetailRelation

null

Properties

Name Type Required Restrictions Description
referenceTo string false none none
referenceField string false none none
relationName string false none none
relationLabel string false none none
detailRelationName string false none none
detailRelationLabel string false none none

RelationMetadata

null

Properties

Name Type Required Restrictions Description
referenceObjectName string false none none
referenceFieldName string false none none
relationFieldName string false none none
relationName string false none none
relationLabel string false none none
relationType string false none none
detailAccessPolicy DetailAccessPolicy false none none

ValueSet

null

Properties

Name Type Required Restrictions Description
apiName string false none none
name string false none none
defaultValue string false none none
alphabeticallyOrdered boolean false none none
valuePairs [ValuePair] false none none

GetLayoutDetailResponse

null

Properties

Name Type Required Restrictions Description
status string false none none
message string false none none
layout LayoutDetailInfo false none none

Enumerated Values

Property Value
status Succeeded
status Failed

LayoutDetailInfo

null

Properties

Name Type Required Restrictions Description
type string false none none
apiName string false none none
name string false none none
objectApiName string false none none
contentChecksum string false none none
layoutStatus string false none none
tags [string] false none none
content string false none none

Enumerated Values

Property Value
type FormView
type ListView
type SearchView
layoutStatus Draft
layoutStatus Active
layoutStatus Inactive

title: LIFECYCLE MANAGER v1.0 language_tabs: - shell: Shell - http: HTTP - javascript: JavaScript - ruby: Ruby - python: Python - php: PHP - java: Java - go: Go toc_footers: [] includes: [] search: false highlight_theme: darkula headingLevel: 2

LIFECYCLE MANAGER v1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

Authentication

GraphQL Query

Support graphql query for entity: User Profile, UOM, Product, Product Feature, Product Option, Product Price Dimension, Price Book, Price Book Entry, Feature, Feature Price Dimension, Bundle Suite, Bundle Suite Bundle, Credit Conversion.

GraphQL Query API on GET

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/async/graphql \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.nue.io/v1/async/graphql HTTP/1.1
Host: api.nue.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/async/graphql',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/async/graphql',
  params: {
  'query' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/async/graphql', params={
  'query': null
}, headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/async/graphql', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/async/graphql");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/async/graphql", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /async/graphql

The graghQL query is passed in the URL.

Parameters

Name In Type Required Description
query query string true none
operationName query string false none
variables query string false none

Example responses

200 Response

null

400 Response

Responses

Status Meaning Description Schema
200 OK OK Inline
400 Bad Request Bad Request ErrorMessage

Response Schema

GraphQL Query API on POST

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/async/graphql \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Content-Type: null' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.nue.io/v1/async/graphql HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json
Content-Type: null


const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Content-Type':null,
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/async/graphql',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Content-Type' => null,
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/async/graphql',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Content-Type': null,
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/async/graphql', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Content-Type' => 'null',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/async/graphql', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/async/graphql");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Content-Type": []string{"null"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/async/graphql", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /async/graphql

The graghQL query is passed in the request body.

Body parameter

null

Parameters

Name In Type Required Description
Content-Type header string false none
query query string false none
operationName query string false none
variables query string false none
body body string false none

Example responses

200 Response

null

400 Response

Responses

Status Meaning Description Schema
200 OK OK Inline
400 Bad Request Bad Request ErrorMessage

Response Schema

Self Service Catalog

Product Catalog is a mirror cache of published products for self service.

Usage Rating

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/cpq/usage-rate \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.nue.io/v1/cpq/usage-rate HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*


const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/cpq/usage-rate',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/cpq/usage-rate',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/cpq/usage-rate', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/cpq/usage-rate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/cpq/usage-rate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/cpq/usage-rate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cpq/usage-rate

Price rate based on customer's usage

Body parameter

null

Parameters

Name In Type Required Description
body body BulkUsageRateRequest true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK BulkUsageRateResponse
400 Bad Request Bad Request ErrorMessage

Publish settings

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/usage-rating-options:publish \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.nue.io/v1/catalog/usage-rating-options:publish HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/usage-rating-options:publish',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/usage-rating-options:publish',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/usage-rating-options:publish', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/usage-rating-options:publish', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/catalog/usage-rating-options:publish");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/usage-rating-options:publish", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/usage-rating-options:publish

Publish Ruby settings for Self Service to access.

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline
400 Bad Request Bad Request ErrorMessage

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [RubySetting] false none none
» id string false none none
» category string false none none
» subcategory string false none none
» name string false none none
» value string false none none

Republish products

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/products:republish \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.nue.io/v1/catalog/products:republish HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/products:republish',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/products:republish',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/products:republish', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/products:republish', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/catalog/products:republish");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/products:republish", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/products:republish

Republish published bundles and products to Nue mirror cache for Self Service to access.

Parameters

Name In Type Required Description
removeNonexistent query boolean false none

Example responses

400 Response

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request Bad Request ErrorMessage

Unpublish product

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/products/{id}:unpublish \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.nue.io/v1/catalog/products/{id}:unpublish HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/products/{id}:unpublish',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/products/{id}:unpublish',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/products/{id}:unpublish', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/products/{id}:unpublish', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/catalog/products/{id}:unpublish");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/products/{id}:unpublish", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/products/{id}:unpublish

Unpublish a product to Nue mirror cache for Self Service to access.

Parameters

Name In Type Required Description
id path string true none

Example responses

400 Response

Responses

Status Meaning Description Schema
202 Accepted Accepted None
400 Bad Request Bad Request ErrorMessage

Publish product

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/products/{id}:publish \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.nue.io/v1/catalog/products/{id}:publish HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/products/{id}:publish',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/products/{id}:publish',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/products/{id}:publish', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/products/{id}:publish', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/catalog/products/{id}:publish");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/products/{id}:publish", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/products/{id}:publish

Publish a product to Nue mirror cache for Self Service to access.

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Product
400 Bad Request Bad Request ErrorMessage

Outdate bundle suite

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/products/{id}:outdatePublishStatus \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.nue.io/v1/catalog/products/{id}:outdatePublishStatus HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/products/{id}:outdatePublishStatus',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/products/{id}:outdatePublishStatus',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/products/{id}:outdatePublishStatus', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/products/{id}:outdatePublishStatus', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/catalog/products/{id}:outdatePublishStatus");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/products/{id}:outdatePublishStatus", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/products/{id}:outdatePublishStatus

Set bundle suite publish status outdated.

Parameters

Name In Type Required Description
id path string true none

Example responses

400 Response

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request Bad Request ErrorMessage

Enable price book for self-service

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/priceBooks/{id}:enableSelfService \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.nue.io/v1/catalog/priceBooks/{id}:enableSelfService HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/priceBooks/{id}:enableSelfService',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/priceBooks/{id}:enableSelfService',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/priceBooks/{id}:enableSelfService', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/priceBooks/{id}:enableSelfService', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/catalog/priceBooks/{id}:enableSelfService");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/priceBooks/{id}:enableSelfService", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/priceBooks/{id}:enableSelfService

Enable Price Book Self Service.

Parameters

Name In Type Required Description
id path string true none

Example responses

400 Response

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request Bad Request ErrorMessage

Disable price book for self-service

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/priceBooks/{id}:disableSelfService \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.nue.io/v1/catalog/priceBooks/{id}:disableSelfService HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/priceBooks/{id}:disableSelfService',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/priceBooks/{id}:disableSelfService',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/priceBooks/{id}:disableSelfService', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/priceBooks/{id}:disableSelfService', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/catalog/priceBooks/{id}:disableSelfService");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/priceBooks/{id}:disableSelfService", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/priceBooks/{id}:disableSelfService

Disable Price Book Self Service.

Parameters

Name In Type Required Description
id path string true none

Example responses

400 Response

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request Bad Request ErrorMessage

Unpublish price tag

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/price-tags/{id}:unpublish \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.nue.io/v1/catalog/price-tags/{id}:unpublish HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/price-tags/{id}:unpublish',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/price-tags/{id}:unpublish',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/price-tags/{id}:unpublish', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/price-tags/{id}:unpublish', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/catalog/price-tags/{id}:unpublish");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/price-tags/{id}:unpublish", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/price-tags/{id}:unpublish

Unpublish a price tag to Nue mirror cache for Self Service to access.

Parameters

Name In Type Required Description
id path string true none

Example responses

400 Response

Responses

Status Meaning Description Schema
202 Accepted Accepted None
400 Bad Request Bad Request ErrorMessage

Publish price tag

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/price-tags/{id}:publish \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.nue.io/v1/catalog/price-tags/{id}:publish HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/price-tags/{id}:publish',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/price-tags/{id}:publish',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/price-tags/{id}:publish', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/price-tags/{id}:publish', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/catalog/price-tags/{id}:publish");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/price-tags/{id}:publish", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/price-tags/{id}:publish

Publish a price tag to Nue mirror cache for Self Service to access.

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK PriceDimension
400 Bad Request Bad Request ErrorMessage

Outdate price tag

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/price-tags/{id}:outdatePublishStatus \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.nue.io/v1/catalog/price-tags/{id}:outdatePublishStatus HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/price-tags/{id}:outdatePublishStatus',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/price-tags/{id}:outdatePublishStatus',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/price-tags/{id}:outdatePublishStatus', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/price-tags/{id}:outdatePublishStatus', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/catalog/price-tags/{id}:outdatePublishStatus");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/price-tags/{id}:outdatePublishStatus", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/price-tags/{id}:outdatePublishStatus

Set price tag publish status outdated.

Parameters

Name In Type Required Description
id path string true none

Example responses

400 Response

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request Bad Request ErrorMessage

Publish object mapping settings

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/object-mapping-settings:publish \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.nue.io/v1/catalog/object-mapping-settings:publish HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/object-mapping-settings:publish',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/object-mapping-settings:publish',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/object-mapping-settings:publish', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/object-mapping-settings:publish', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/catalog/object-mapping-settings:publish");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/object-mapping-settings:publish", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/object-mapping-settings:publish

Publish object mapping settings for Self Service to access.

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline
400 Bad Request Bad Request ErrorMessage

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ObjectMapping] false none none
» id string false none none
» fromObject string false none none
» toObject string false none none
» fromField string false none none
» toField string false none none

Unpublish bundle suite

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/bundleSuites/{id}:unpublish \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.nue.io/v1/catalog/bundleSuites/{id}:unpublish HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/bundleSuites/{id}:unpublish',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/bundleSuites/{id}:unpublish',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/bundleSuites/{id}:unpublish', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/bundleSuites/{id}:unpublish', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/catalog/bundleSuites/{id}:unpublish");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/bundleSuites/{id}:unpublish", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/bundleSuites/{id}:unpublish

Unpublish a bundle suite to Nue mirror cache for Self Service to access.

Parameters

Name In Type Required Description
id path string true none

Example responses

400 Response

Responses

Status Meaning Description Schema
202 Accepted Accepted None
400 Bad Request Bad Request ErrorMessage

Publish bundle suite

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/bundleSuites/{id}:publish \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.nue.io/v1/catalog/bundleSuites/{id}:publish HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/bundleSuites/{id}:publish',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/bundleSuites/{id}:publish',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/bundleSuites/{id}:publish', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/bundleSuites/{id}:publish', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/catalog/bundleSuites/{id}:publish");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/bundleSuites/{id}:publish", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/bundleSuites/{id}:publish

Publish a bundle suite to Nue mirror cache for Self Service to access.

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK BundleSuite
400 Bad Request Bad Request ErrorMessage

Outdate product

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/bundleSuites/{id}:outdatePublishStatus \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.nue.io/v1/catalog/bundleSuites/{id}:outdatePublishStatus HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/bundleSuites/{id}:outdatePublishStatus',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/bundleSuites/{id}:outdatePublishStatus',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/bundleSuites/{id}:outdatePublishStatus', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/bundleSuites/{id}:outdatePublishStatus', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/catalog/bundleSuites/{id}:outdatePublishStatus");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/bundleSuites/{id}:outdatePublishStatus", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/bundleSuites/{id}:outdatePublishStatus

Set product publish status outdated

Parameters

Name In Type Required Description
id path string true none

Example responses

400 Response

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request Bad Request ErrorMessage

Load products

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/catalog/products \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.nue.io/v1/catalog/products HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/products',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/catalog/products',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/catalog/products', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/catalog/products', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/catalog/products");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/catalog/products", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /catalog/products

Load products from Nue mirror cache for Self Service to access.

Parameters

Name In Type Required Description
filter query string false none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline
400 Bad Request Bad Request ErrorMessage

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Product] false none none
» id string false none none
» name string false none none
» sku string false none none
» recordType string false none none
» configurable boolean false none none
» soldIndependently boolean false none none
» status string false none none
» bundleTemplate string false none none
» description string false none none
» priceModel string false none none
» startDate string false none none
» endDate string false none none
» freeTrialUnit integer(int32) false none none
» freeTrialType string false none none
» productCategory string false none none
» autoRenew boolean false none none
» defaultRenewalTerm number false none none
» defaultSubscriptionTerm integer(int32) false none none
» billingTiming string false none none
» billingPeriod string false none none
» showIncludedProductOptions boolean false none none
» publishStatus string false none none
» lastPublishedById string false none none
» lastPublishedDate string false none none
» taxCode string false none none
» taxMode string false none none
» referenceProduct Product false none none
» uom Uom false none none
»» id string false none none
»» name string false none none
»» decimalScale integer(int32) false none none
»» roundingMode string false none none
»» quantityDimension string false none none
»» termDimension string false none none
» priceBook PriceBook false none none
»» id string false none none
»» name string false none none
»» description string false none none
»» standard boolean false none none
»» active boolean false none none
»» archived boolean false none none
»» selfServiceEnabled boolean false none none
» imageUrl string false none none
» evergreen boolean false none none
» carvesLiabilitySegment string false none none
» carvesRevenueSegment string false none none
» contractLiabilitySegment string false none none
» contractRevenueSegment string false none none
» creditConversionId string false none none
» creditConversion CreditConversion false none none
»» id string false none none
»» name string false none none
»» creditTypeId string false none none
»» uomQuantityDimension string false none none
»» uomQuantity number false none none
»» creditQuantity number false none none
»» conversionRate number false none none
»» decimalScale integer(int32) false none none
»» roundingMode string false none none
» priceBookEntries [PriceBookEntry] false none none
»» id string false none none
»» listPrice number false none none
»» active boolean false none none
»» currencyIsoCode string false none none
»» recommended boolean false none none
»» billingTiming string false none none
»» uom Uom false none none
»» priceBookId string false none none
»» pricingAttributes [PricingAttribute] false none none
»»» id string false none none
»»» name string false none none
»»» description string false none none
»»» mapping string false none none
»»» label string false none none
»»» value string false none none
» productFeatures [ProductFeature] false none none
»» id string false none none
»» name string false none none
»» featureOrder integer(int32) false none none
»» minOptions integer(int32) false none none
»» maxOptions integer(int32) false none none
»» featureName string false none none
»» featureDescription string false none none
»» feature Feature false none none
»»» id string false none none
»»» name string false none none
»»» imageSignedUrl string false none none
»»» status string false none none
»»» featurePriceTags [FeaturePriceDimension] false none none
»»»» id string false none none
»»»» name string false none none
»»»» serialNumber integer(int32) false none none
»»»» active boolean false none none
»»»» priceTag PriceDimension false none none
»»»»» id string false none none
»»»»» name string false none none
»»»»» description string false none none
»»»»» recordType string false none none
»»»»» priceTagType string false none none
»»»»» startTime string false none none
»»»»» endTime string false none none
»»»»» priceType string false none none
»»»»» active boolean false none none
»»»»» objectId string false none none
»»»»» objectType string false none none
»»»»» code string false none none
»»»»» uomDimension string false none none
»»»»» priceBook PriceBook false none none
»»»»» uom Uom false none none
»»»»» priceTiers [PriceTier] false none none
»»»»»» id string false none none
»»»»»» name string false none none
»»»»»» amount number false none none
»»»»»» chargeModel string false none none
»»»»»» discountPercentage number false none none
»»»»»» endUnit number false none none
»»»»»» startUnit number false none none
»»»»»» tierNumber number false none none
»»»»» publishStatus string false none none
»»»»» lastPublishedById string false none none
»»»»» lastPublishedDate string false none none
»» productOptions [ProductOption] false none none
»»» id string false none none
»»» name string false none none
»»» optionName string false none none
»»» optionOrder integer(int32) false none none
»»» optionType string false none none
»»» defaultQuantity number false none none
»»» includedQuantity number false none none
»»» minQuantity number false none none
»»» maxQuantity number false none none
»»» quantityEditable boolean false none none
»»» required boolean false none none
»»» bundled boolean false none none
»»» recommended boolean false none none
»»» independentPricing boolean false none none
»»» priceBookEntry PriceBookEntry false none none
»»» product Product false none none
»»» productOptionPriceTags [ProductOptionPriceDimension] false none none
»»»» id string false none none
»»»» name string false none none
»»»» serialNumber integer(int32) false none none
»»»» active boolean false none none
»»»» priceTag PriceDimension false none none
» productOptions [ProductOption] false none none
» productPriceTags [ProductPriceDimension] false none none
»» id string false none none
»» name string false none none
»» serialNumber integer(int32) false none none
»» active boolean false none none
»» priceBookEntry PriceBookEntry false none none
»» priceTag PriceDimension false none none
» carvesEligible boolean false none none

Enumerated Values

Property Value
publishStatus Unpublished
publishStatus Published
publishStatus Outdated
roundingMode Up
roundingMode Down
publishStatus Unpublished
publishStatus Published
publishStatus Outdated

Load product

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/catalog/products/{id} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.nue.io/v1/catalog/products/{id} HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/products/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/catalog/products/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/catalog/products/{id}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/catalog/products/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/catalog/products/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/catalog/products/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /catalog/products/{id}

Load product by Id from Nue mirror cache for Self Service to access.

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Product
400 Bad Request Bad Request ErrorMessage

Load price tags

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/catalog/price-tags/{tagCode} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.nue.io/v1/catalog/price-tags/{tagCode} HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/price-tags/{tagCode}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/catalog/price-tags/{tagCode}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/catalog/price-tags/{tagCode}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/catalog/price-tags/{tagCode}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("https://api.nue.io/v1/catalog/price-tags/{tagCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/catalog/price-tags/{tagCode}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /catalog/price-tags/{tagCode}

Load price tags from Nue mirror cache by price tag code for Self Service to access.

Parameters

Name In Type Required Description
tagCode path string true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK PriceDimension
400 Bad Request Bad Request ErrorMessage

Load object mapping settings

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/catalog/object-mapping-settings \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.nue.io/v1/catalog/object-mapping-settings HTTP/1.1
Host: api.nue.io
Accept: */*



const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/object-mapping-settings',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/catalog/object-mapping-settings',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization':