Item price special rows

Special pricing rows for an item.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
itempricespecialid	integer	Itempricespecialid. Id only.
itemid	integer	Reference to `items`, by id. Write either this or `item`.
item	string(255)	The `sku` of the referenced items, instead of the id. Send this or `itemid`, not both unless they agree.
pricemoney	string(6dp)	Stored as `decimal(18,6)`.
begindate	string	Date the special price starts.
enddate	string	Date the special price ends.
marginmoney	string(6dp)	Stored as `decimal(18,6)`.
mincostmoney	string(6dp)	Stored as `decimal(18,6)`.
notes	string(255)	Notes on the special price.
period	string(1)	Rental period the special price applies to: D = daily, W = weekly, M = monthly. Empty for non-rental pricing.
externalid	string(100)	Your own key. Scoped to your company.

Endpoints#

POST/itempricespecialdetails/batch 207

Create many.

Requires scope items:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
itempricespecialid	integer	Itempricespecialid. Id only.
itemid	integer	Reference to `items`, by id. Write either this or `item`.
item	string(255)	The `sku` of the referenced items, instead of the id. Send this or `itemid`, not both unless they agree.
pricemoney	string(6dp)	Stored as `decimal(18,6)`.
begindate	string	Date the special price starts.
enddate	string	Date the special price ends.
marginmoney	string(6dp)	Stored as `decimal(18,6)`.
mincostmoney	string(6dp)	Stored as `decimal(18,6)`.
notes	string(255)	Notes on the special price.
period	string(1)	Rental period the special price applies to: D = daily, W = weekly, M = monthly. Empty for non-rental pricing.
externalid	string(100)	Your own key. Scoped to your company.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/itempricespecialdetails/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "itempricespecialid": 104,
        "itemid": 104,
        "item": "Example item",
        "price": "125.0000",
        "begindate": "2026-08-01",
        "enddate": "2026-08-01"
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/itempricespecialdetails/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'itempricespecialid' => 104,
      'itemid' => 104,
      'item' => 'Example item',
      'price' => '125.0000',
      'begindate' => '2026-08-01',
      'enddate' => '2026-08-01',
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/itempricespecialdetails/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "itempricespecialid": 104,
            "itemid": 104,
            "item": "Example item",
            "price": "125.0000",
            "begindate": "2026-08-01",
            "enddate": "2026-08-01",
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/itempricespecialdetails/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        itempricespecialid: 104,
        itemid: 104,
        item: "Example item",
        price: "125.0000",
        begindate: "2026-08-01",
        enddate: "2026-08-01",
      },
    ]),
  }
);
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 {
        itempricespecialid = 104,
        itemid = 104,
        item = "Example item",
        price = "125.0000",
        begindate = "2026-08-01",
        enddate = "2026-08-01",
    },
};

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

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

GET/itempricespecialdetails 200403

List item price specials.

Requires scope items:read.

Parameters

Name	In	Type	Notes
itemid	query	string	Restrict to one itemid.
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/itempricespecialdetails' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/itempricespecialdetails');
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/itempricespecialdetails",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/itempricespecialdetails',
  {
    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/itempricespecialdetails");
res.EnsureSuccessStatusCode();

POST/itempricespecialdetails 201400

Create.

Requires scope items:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
idread-only	integer	NolaPro id.
itempricespecialid	integer	Itempricespecialid. Id only.
itemid	integer	Reference to `items`, by id. Write either this or `item`.
item	string(255)	The `sku` of the referenced items, instead of the id. Send this or `itemid`, not both unless they agree.
pricemoney	string(6dp)	Stored as `decimal(18,6)`.
begindate	string	Date the special price starts.
enddate	string	Date the special price ends.
marginmoney	string(6dp)	Stored as `decimal(18,6)`.
mincostmoney	string(6dp)	Stored as `decimal(18,6)`.
notes	string(255)	Notes on the special price.
period	string(1)	Rental period the special price applies to: D = daily, W = weekly, M = monthly. Empty for non-rental pricing.
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/itempricespecialdetails' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "itempricespecialid": 104,
    "itemid": 104,
    "item": "Example item",
    "price": "125.0000",
    "begindate": "2026-08-01",
    "enddate": "2026-08-01"
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/itempricespecialdetails');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'itempricespecialid' => 104,
    'itemid' => 104,
    'item' => 'Example item',
    'price' => '125.0000',
    'begindate' => '2026-08-01',
    'enddate' => '2026-08-01',
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/itempricespecialdetails",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "itempricespecialid": 104,
        "itemid": 104,
        "item": "Example item",
        "price": "125.0000",
        "begindate": "2026-08-01",
        "enddate": "2026-08-01",
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/itempricespecialdetails',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      itempricespecialid: 104,
      itemid: 104,
      item: "Example item",
      price: "125.0000",
      begindate: "2026-08-01",
      enddate: "2026-08-01",
    }),
  }
);
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 {
    itempricespecialid = 104,
    itemid = 104,
    item = "Example item",
    price = "125.0000",
    begindate = "2026-08-01",
    enddate = "2026-08-01",
};

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

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

Response 201

{
    "itempricespecialid": 104,
    "itemid": 104,
    "item": "Example item",
    "price": "125.0000",
    "begindate": "2026-08-01",
    "enddate": "2026-08-01"
}

GET/itempricespecialdetails/{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/itempricespecialdetails/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/itempricespecialdetails/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/itempricespecialdetails/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/itempricespecialdetails/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/itempricespecialdetails/104");
res.EnsureSuccessStatusCode();

Response 200

{
    "itempricespecialid": 104,
    "itemid": 104,
    "item": "Example item",
    "price": "125.0000",
    "begindate": "2026-08-01",
    "enddate": "2026-08-01"
}

PATCH/itempricespecialdetails/{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.
itempricespecialid	integer	Itempricespecialid. Id only.
itemid	integer	Reference to `items`, by id. Write either this or `item`.
item	string(255)	The `sku` of the referenced items, instead of the id. Send this or `itemid`, not both unless they agree.
pricemoney	string(6dp)	Stored as `decimal(18,6)`.
begindate	string	Date the special price starts.
enddate	string	Date the special price ends.
marginmoney	string(6dp)	Stored as `decimal(18,6)`.
mincostmoney	string(6dp)	Stored as `decimal(18,6)`.
notes	string(255)	Notes on the special price.
period	string(1)	Rental period the special price applies to: D = daily, W = weekly, M = monthly. Empty for non-rental pricing.
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/itempricespecialdetails/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "itempricespecialid": 104,
    "itemid": 104,
    "item": "Example item",
    "price": "125.0000",
    "begindate": "2026-08-01",
    "enddate": "2026-08-01"
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/itempricespecialdetails/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'itempricespecialid' => 104,
    'itemid' => 104,
    'item' => 'Example item',
    'price' => '125.0000',
    'begindate' => '2026-08-01',
    'enddate' => '2026-08-01',
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/itempricespecialdetails/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "itempricespecialid": 104,
        "itemid": 104,
        "item": "Example item",
        "price": "125.0000",
        "begindate": "2026-08-01",
        "enddate": "2026-08-01",
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/itempricespecialdetails/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      itempricespecialid: 104,
      itemid: 104,
      item: "Example item",
      price: "125.0000",
      begindate: "2026-08-01",
      enddate: "2026-08-01",
    }),
  }
);
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 {
    itempricespecialid = 104,
    itemid = 104,
    item = "Example item",
    price = "125.0000",
    begindate = "2026-08-01",
    enddate = "2026-08-01",
};

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

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

Response 200

{
    "itempricespecialid": 104,
    "itemid": 104,
    "item": "Example item",
    "price": "125.0000",
    "begindate": "2026-08-01",
    "enddate": "2026-08-01"
}

Inventory locations →

Warehouses and stocking locations. Address-shaped rather than code-shaped. Carries both cancel and inactive, which mean different things - a location can be active but temporarily not stocking. Read-only in this release; creating one has physical inventory consequences.

Unit names →

Units of measure - Each, M, Pound - used on items, invoice lines and order lines. This list is not company scoped. unitname has no company column, so every company on the install shares one set of units and a change here is visible to all of them immediately.