Item price specials

Special pricing headers. The rows live in itempricespecialdetails.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
customerid	integer	Reference to `customers`, by id. Write either this or `customer`.
customer	string(30)	Code for the referenced customer, instead of the id.
jobid	integer	Jobid. Id only.
description	text	Description. Stored as `text`, no practical length limit.
inventorylocationid	integer	Inventorylocationid. Id only.
inventorylocation	string(20)	The `locationcode` of the referenced inventorylocations, instead of the id. Send this or `inventorylocationid`, not both unless they agree.
begindate	string	Date the special pricing starts.
enddate	string	Date the special pricing ends.
entrydateread-only	string	When the record was created.
cancel	boolean	Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
static	boolean	1 when the special is a static price rather than a discount off the regular price.
externalid	string(100)	Your own key. Scoped to your company.

Endpoints#

POST/itempricespecials/batch 207

Create many.

Requires scope items:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
customerid	integer	Reference to `customers`, by id. Write either this or `customer`.
customer	string(30)	Code for the referenced customer, instead of the id.
jobid	integer	Jobid. Id only.
description	text	Description. Stored as `text`, no practical length limit.
inventorylocationid	integer	Inventorylocationid. Id only.
inventorylocation	string(20)	The `locationcode` of the referenced inventorylocations, instead of the id. Send this or `inventorylocationid`, not both unless they agree.
begindate	string	Date the special pricing starts.
enddate	string	Date the special pricing ends.
entrydateread-only	string	When the record was created.
cancel	boolean	Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
static	boolean	1 when the special is a static price rather than a discount off the regular price.
externalid	string(100)	Your own key. Scoped to your company.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/itempricespecials/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "customerid": 104,
        "customer": "Example customer",
        "jobid": 104,
        "description": "Example description",
        "inventorylocationid": 104,
        "inventorylocation": "Example inventorylocation"
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/itempricespecials/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'customerid' => 104,
      'customer' => 'Example customer',
      'jobid' => 104,
      'description' => 'Example description',
      'inventorylocationid' => 104,
      'inventorylocation' => 'Example inventorylocation',
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/itempricespecials/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "customerid": 104,
            "customer": "Example customer",
            "jobid": 104,
            "description": "Example description",
            "inventorylocationid": 104,
            "inventorylocation": "Example inventorylocation",
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/itempricespecials/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        customerid: 104,
        customer: "Example customer",
        jobid: 104,
        description: "Example description",
        inventorylocationid: 104,
        inventorylocation: "Example inventorylocation",
      },
    ]),
  }
);
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 {
        customerid = 104,
        customer = "Example customer",
        jobid = 104,
        description = "Example description",
        inventorylocationid = 104,
        inventorylocation = "Example inventorylocation",
    },
};

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

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

GET/itempricespecials 200403

List item price specials.

Requires scope items:read.

Parameters

Name	In	Type	Notes
customerid	query	string	Restrict to one customerid.
inventorylocationid	query	string	Restrict to one inventorylocationid.
jobid	query	string	Restrict to one jobid.
description	query	string	description. 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/itempricespecials' \
  -H 'Authorization: Bearer $NP_TOKEN'

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

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

POST/itempricespecials 201400

Create.

Requires scope items:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
idread-only	integer	NolaPro id.
customerid	integer	Reference to `customers`, by id. Write either this or `customer`.
customer	string(30)	Code for the referenced customer, instead of the id.
jobid	integer	Jobid. Id only.
description	text	Description. Stored as `text`, no practical length limit.
inventorylocationid	integer	Inventorylocationid. Id only.
inventorylocation	string(20)	The `locationcode` of the referenced inventorylocations, instead of the id. Send this or `inventorylocationid`, not both unless they agree.
begindate	string	Date the special pricing starts.
enddate	string	Date the special pricing ends.
entrydateread-only	string	When the record was created.
cancel	boolean	Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
static	boolean	1 when the special is a static price rather than a discount off the regular price.
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/itempricespecials' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "customerid": 104,
    "customer": "Example customer",
    "jobid": 104,
    "description": "Example description",
    "inventorylocationid": 104,
    "inventorylocation": "Example inventorylocation"
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/itempricespecials');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'customerid' => 104,
    'customer' => 'Example customer',
    'jobid' => 104,
    'description' => 'Example description',
    'inventorylocationid' => 104,
    'inventorylocation' => 'Example inventorylocation',
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/itempricespecials",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "customerid": 104,
        "customer": "Example customer",
        "jobid": 104,
        "description": "Example description",
        "inventorylocationid": 104,
        "inventorylocation": "Example inventorylocation",
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/itempricespecials',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      customerid: 104,
      customer: "Example customer",
      jobid: 104,
      description: "Example description",
      inventorylocationid: 104,
      inventorylocation: "Example inventorylocation",
    }),
  }
);
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 {
    customerid = 104,
    customer = "Example customer",
    jobid = 104,
    description = "Example description",
    inventorylocationid = 104,
    inventorylocation = "Example inventorylocation",
};

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

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

Response 201

{
    "customerid": 104,
    "customer": "Example customer",
    "jobid": 104,
    "description": "Example description",
    "inventorylocationid": 104,
    "inventorylocation": "Example inventorylocation"
}

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

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

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

Response 200

{
    "customerid": 104,
    "customer": "Example customer",
    "jobid": 104,
    "description": "Example description",
    "inventorylocationid": 104,
    "inventorylocation": "Example inventorylocation"
}

PATCH/itempricespecials/{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.
customerid	integer	Reference to `customers`, by id. Write either this or `customer`.
customer	string(30)	Code for the referenced customer, instead of the id.
jobid	integer	Jobid. Id only.
description	text	Description. Stored as `text`, no practical length limit.
inventorylocationid	integer	Inventorylocationid. Id only.
inventorylocation	string(20)	The `locationcode` of the referenced inventorylocations, instead of the id. Send this or `inventorylocationid`, not both unless they agree.
begindate	string	Date the special pricing starts.
enddate	string	Date the special pricing ends.
entrydateread-only	string	When the record was created.
cancel	boolean	Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
static	boolean	1 when the special is a static price rather than a discount off the regular price.
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/itempricespecials/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "customerid": 104,
    "customer": "Example customer",
    "jobid": 104,
    "description": "Example description",
    "inventorylocationid": 104,
    "inventorylocation": "Example inventorylocation"
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/itempricespecials/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'customerid' => 104,
    'customer' => 'Example customer',
    'jobid' => 104,
    'description' => 'Example description',
    'inventorylocationid' => 104,
    'inventorylocation' => 'Example inventorylocation',
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/itempricespecials/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "customerid": 104,
        "customer": "Example customer",
        "jobid": 104,
        "description": "Example description",
        "inventorylocationid": 104,
        "inventorylocation": "Example inventorylocation",
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/itempricespecials/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      customerid: 104,
      customer: "Example customer",
      jobid: 104,
      description: "Example description",
      inventorylocationid: 104,
      inventorylocation: "Example inventorylocation",
    }),
  }
);
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 {
    customerid = 104,
    customer = "Example customer",
    jobid = 104,
    description = "Example description",
    inventorylocationid = 104,
    inventorylocation = "Example inventorylocation",
};

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

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

Response 200

{
    "customerid": 104,
    "customer": "Example customer",
    "jobid": 104,
    "description": "Example description",
    "inventorylocationid": 104,
    "inventorylocation": "Example inventorylocation"
}

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

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

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

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

Response 200

{
    "customerid": 104,
    "customer": "Example customer",
    "jobid": 104,
    "description": "Example description",
    "inventorylocationid": 104,
    "inventorylocation": "Example inventorylocation"
}

Item price special rows →

Special pricing rows for an item.

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.