Item identifier types

What this company tracks per item: serial number, lot, expiry. datatype is the value shape; singleton means one unit per value, which is how a serial number differs from a lot.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
name	string(255)	Name of the identifier, shown wherever values are entered (e.g. Serial #, Lot).
datatype	string(1)	Value type: empty = text, D = date (dates get parsed and expiration handling).
cancel	boolean	Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
showonpicklist	boolean	True prints the identifier value on pick lists.
showonorderconf	boolean	True prints the identifier value on order confirmations.
showoninvoice	boolean	True prints the identifier value on invoices.
showonpackingslip	boolean	True prints the identifier value on packing slips.
singleton	boolean	True when each value tracks a single unit (serial numbers); false when a value can cover a quantity (lots).
externalid	string(100)	Your own key. Scoped to your company.

Endpoints#

POST/itemidentifiers/batch 207

Create many.

Requires scope items:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
name	string(255)	Name of the identifier, shown wherever values are entered (e.g. Serial #, Lot).
datatype	string(1)	Value type: empty = text, D = date (dates get parsed and expiration handling).
cancel	boolean	Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
showonpicklist	boolean	True prints the identifier value on pick lists.
showonorderconf	boolean	True prints the identifier value on order confirmations.
showoninvoice	boolean	True prints the identifier value on invoices.
showonpackingslip	boolean	True prints the identifier value on packing slips.
singleton	boolean	True when each value tracks a single unit (serial numbers); false when a value can cover a quantity (lots).
externalid	string(100)	Your own key. Scoped to your company.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/itemidentifiers/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "name": "Example name",
        "datatype": "Example datatype",
        "showonpicklist": false,
        "showonorderconf": false,
        "showoninvoice": false,
        "showonpackingslip": false
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/itemidentifiers/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'name' => 'Example name',
      'datatype' => 'Example datatype',
      'showonpicklist' => false,
      'showonorderconf' => false,
      'showoninvoice' => false,
      'showonpackingslip' => false,
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/itemidentifiers/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "name": "Example name",
            "datatype": "Example datatype",
            "showonpicklist": False,
            "showonorderconf": False,
            "showoninvoice": False,
            "showonpackingslip": False,
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/itemidentifiers/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        name: "Example name",
        datatype: "Example datatype",
        showonpicklist: false,
        showonorderconf: false,
        showoninvoice: false,
        showonpackingslip: false,
      },
    ]),
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var body = new[] {
    new {
        name = "Example name",
        datatype = "Example datatype",
        showonpicklist = false,
        showonorderconf = false,
        showoninvoice = false,
        showonpackingslip = false,
    },
};

var req = new HttpRequestMessage(HttpMethod.Post,
    "https://acme.nolapro.com/!/api/v2/itemidentifiers/batch") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

GET/itemidentifiers 200403

List item identifier types.

Requires scope items:read.

Parameters

Name	In	Type	Notes
name	query	string	Partial match, case insensitive.
cancel	query	string	Defaults to `false`. Pass `true` or `any`.
externalid	query	string	Exact match on your own key.
include	query	string	Comma-separated extras to embed. Only `custom_fields` is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions.

When it fails

Status	Code	Meaning
403	insufficient_scope	Token lacks read scope.

curl \
  'https://acme.nolapro.com/!/api/v2/itemidentifiers' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/itemidentifiers');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.get(
    "https://acme.nolapro.com/!/api/v2/itemidentifiers",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/itemidentifiers',
  {
    method: 'GET',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var res = await http.GetAsync(
    "https://acme.nolapro.com/!/api/v2/itemidentifiers");
res.EnsureSuccessStatusCode();

POST/itemidentifiers 201400

Create.

Requires scope items:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
idread-only	integer	NolaPro id.
name	string(255)	Name of the identifier, shown wherever values are entered (e.g. Serial #, Lot).
datatype	string(1)	Value type: empty = text, D = date (dates get parsed and expiration handling).
cancel	boolean	Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
showonpicklist	boolean	True prints the identifier value on pick lists.
showonorderconf	boolean	True prints the identifier value on order confirmations.
showoninvoice	boolean	True prints the identifier value on invoices.
showonpackingslip	boolean	True prints the identifier value on packing slips.
singleton	boolean	True when each value tracks a single unit (serial numbers); false when a value can cover a quantity (lots).
externalid	string(100)	Your own key. Scoped to your company.

When it fails

Status	Code	Meaning
400	invalid_request	A required field was missing.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/itemidentifiers' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "name": "Example name",
    "datatype": "Example datatype",
    "showonpicklist": false,
    "showonorderconf": false,
    "showoninvoice": false,
    "showonpackingslip": false
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/itemidentifiers');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'name' => 'Example name',
    'datatype' => 'Example datatype',
    'showonpicklist' => false,
    'showonorderconf' => false,
    'showoninvoice' => false,
    'showonpackingslip' => false,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/itemidentifiers",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "name": "Example name",
        "datatype": "Example datatype",
        "showonpicklist": False,
        "showonorderconf": False,
        "showoninvoice": False,
        "showonpackingslip": False,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/itemidentifiers',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      name: "Example name",
      datatype: "Example datatype",
      showonpicklist: false,
      showonorderconf: false,
      showoninvoice: false,
      showonpackingslip: false,
    }),
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var body = new {
    name = "Example name",
    datatype = "Example datatype",
    showonpicklist = false,
    showonorderconf = false,
    showoninvoice = false,
    showonpackingslip = false,
};

var req = new HttpRequestMessage(HttpMethod.Post,
    "https://acme.nolapro.com/!/api/v2/itemidentifiers") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

Response 201

{
    "name": "Example name",
    "datatype": "Example datatype",
    "showonpicklist": false,
    "showonorderconf": false,
    "showoninvoice": false,
    "showonpackingslip": false
}

GET/itemidentifiers/{id} 200404

Retrieve one record.

Requires scope items:read.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.
include	query	string	Comma-separated extras to embed. Only `custom_fields` is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.

curl \
  'https://acme.nolapro.com/!/api/v2/itemidentifiers/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/itemidentifiers/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.get(
    "https://acme.nolapro.com/!/api/v2/itemidentifiers/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/itemidentifiers/104',
  {
    method: 'GET',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var res = await http.GetAsync(
    "https://acme.nolapro.com/!/api/v2/itemidentifiers/104");
res.EnsureSuccessStatusCode();

Response 200

{
    "name": "Example name",
    "datatype": "Example datatype",
    "showonpicklist": false,
    "showonorderconf": false,
    "showoninvoice": false,
    "showonpackingslip": false
}

PATCH/itemidentifiers/{id} 200404

Update.

Requires scope items:write.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

Body

Field	Type	Description
idread-only	integer	NolaPro id.
name	string(255)	Name of the identifier, shown wherever values are entered (e.g. Serial #, Lot).
datatype	string(1)	Value type: empty = text, D = date (dates get parsed and expiration handling).
cancel	boolean	Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
showonpicklist	boolean	True prints the identifier value on pick lists.
showonorderconf	boolean	True prints the identifier value on order confirmations.
showoninvoice	boolean	True prints the identifier value on invoices.
showonpackingslip	boolean	True prints the identifier value on packing slips.
singleton	boolean	True when each value tracks a single unit (serial numbers); false when a value can cover a quantity (lots).
externalid	string(100)	Your own key. Scoped to your company.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.

curl -X PATCH \
  'https://acme.nolapro.com/!/api/v2/itemidentifiers/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "name": "Example name",
    "datatype": "Example datatype",
    "showonpicklist": false,
    "showonorderconf": false,
    "showoninvoice": false,
    "showonpackingslip": false
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/itemidentifiers/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'name' => 'Example name',
    'datatype' => 'Example datatype',
    'showonpicklist' => false,
    'showonorderconf' => false,
    'showoninvoice' => false,
    'showonpackingslip' => false,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/itemidentifiers/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "name": "Example name",
        "datatype": "Example datatype",
        "showonpicklist": False,
        "showonorderconf": False,
        "showoninvoice": False,
        "showonpackingslip": False,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/itemidentifiers/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      name: "Example name",
      datatype: "Example datatype",
      showonpicklist: false,
      showonorderconf: false,
      showoninvoice: false,
      showonpackingslip: false,
    }),
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var body = new {
    name = "Example name",
    datatype = "Example datatype",
    showonpicklist = false,
    showonorderconf = false,
    showoninvoice = false,
    showonpackingslip = false,
};

var req = new HttpRequestMessage(HttpMethod.Patch,
    "https://acme.nolapro.com/!/api/v2/itemidentifiers/104") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

Response 200

{
    "name": "Example name",
    "datatype": "Example datatype",
    "showonpicklist": false,
    "showonorderconf": false,
    "showoninvoice": false,
    "showonpackingslip": false
}

DELETE/itemidentifiers/{id} 200404

Cancel.

Requires scope items:cancel.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.

curl -X DELETE \
  'https://acme.nolapro.com/!/api/v2/itemidentifiers/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/itemidentifiers/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'DELETE',
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.delete(
    "https://acme.nolapro.com/!/api/v2/itemidentifiers/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/itemidentifiers/104',
  {
    method: 'DELETE',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var req = new HttpRequestMessage(HttpMethod.Delete,
    "https://acme.nolapro.com/!/api/v2/itemidentifiers/104");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

Response 200

{
    "name": "Example name",
    "datatype": "Example datatype",
    "showonpicklist": false,
    "showonorderconf": false,
    "showoninvoice": false,
    "showonpackingslip": false
}

Item identifier values →

The actual serials and lots in stock, per item and location. quantityonhand and quantityavailable are generated columns and are never writable.

Identifier movements →

Read-only. Which serials and lots moved on which shipment or receipt. Written by the transaction that moved them, never directly - a movement with no transaction behind it would be a stock record nothing can explain.