Item options

Options on a configurable item.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
itemoptiongroupid	integer	Itemoptiongroupid. 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.
optioncode	string(50)	Short code of the option, shown after its name in pickers.
pricemoney	string(6dp)	Stored as `decimal(12,6)`.
costmoney	string(6dp)	Stored as `decimal(12,6)`.
minqtyqty	string(6dp)	Quantity, 6 decimal places, as a string. Stored as `decimal(6dp)`.
maxqtyqty	string(6dp)	Quantity, 6 decimal places, as a string. Stored as `decimal(6dp)`.
mainind	integer	0 when the option quantity follows the main item quantity, 1 when it is independent (the screen asks Dependent On Main Item Qty).
name	string(255)	Option name shown to the buyer.
description	text	Description. Stored as `text`, no practical length limit.
priceunitnameid	integer	Priceunitnameid. Id only.
priceunitname	string(50)	The `unitname` of the referenced unitnames, instead of the id. Send this or `priceunitnameid`, not both unless they agree.
salesunitnameid	integer	Reference to `unitnames`, by id. Write either this or `salesunitname`.
salesunitname	string(50)	The `unitname` of the referenced unitnames, instead of the id. Send this or `salesunitnameid`, not both unless they agree.
saleunitperpriceunitnumber	string(2dp)	Numeric string, 2 decimal places. Not money - do not apply currency rounding.
lbsperpriceunitnumber	string	Numeric string. Not money - do not apply currency rounding.
defaultvaluemoney	string(6dp)	Stored as `decimal(12,6)`.
defaultoption	integer	1 preselects this option in its group.
displayorder	integer	Position of the option within its group.
taxable	integer	Whether this line is taxed.
salesglaccountid	integer	Reference to `glaccounts`, by id. Write either this or `salesglaccount`.
salesglaccount	string(20)	The `name` of the referenced glaccounts, instead of the id. Send this or `salesglaccountid`, not both unless they agree.
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
externalid	string(100)	Your own key. Scoped to your company.

Endpoints#

POST/itemoptions/batch 207

Create many.

Requires scope items:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
itemoptiongroupid	integer	Itemoptiongroupid. 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.
optioncode	string(50)	Short code of the option, shown after its name in pickers.
pricemoney	string(6dp)	Stored as `decimal(12,6)`.
costmoney	string(6dp)	Stored as `decimal(12,6)`.
minqtyqty	string(6dp)	Quantity, 6 decimal places, as a string. Stored as `decimal(6dp)`.
maxqtyqty	string(6dp)	Quantity, 6 decimal places, as a string. Stored as `decimal(6dp)`.
mainind	integer	0 when the option quantity follows the main item quantity, 1 when it is independent (the screen asks Dependent On Main Item Qty).
name	string(255)	Option name shown to the buyer.
description	text	Description. Stored as `text`, no practical length limit.
priceunitnameid	integer	Priceunitnameid. Id only.
priceunitname	string(50)	The `unitname` of the referenced unitnames, instead of the id. Send this or `priceunitnameid`, not both unless they agree.
salesunitnameid	integer	Reference to `unitnames`, by id. Write either this or `salesunitname`.
salesunitname	string(50)	The `unitname` of the referenced unitnames, instead of the id. Send this or `salesunitnameid`, not both unless they agree.
saleunitperpriceunitnumber	string(2dp)	Numeric string, 2 decimal places. Not money - do not apply currency rounding.
lbsperpriceunitnumber	string	Numeric string. Not money - do not apply currency rounding.
defaultvaluemoney	string(6dp)	Stored as `decimal(12,6)`.
defaultoption	integer	1 preselects this option in its group.
displayorder	integer	Position of the option within its group.
taxable	integer	Whether this line is taxed.
salesglaccountid	integer	Reference to `glaccounts`, by id. Write either this or `salesglaccount`.
salesglaccount	string(20)	The `name` of the referenced glaccounts, instead of the id. Send this or `salesglaccountid`, not both unless they agree.
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
externalid	string(100)	Your own key. Scoped to your company.

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

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

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/itemoptions/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "itemoptiongroupid": 104,
            "itemid": 104,
            "item": "Example item",
            "optioncode": "ACME-01",
            "price": "125.0000",
            "cost": "125.0000",
        },
    ],
)
r.raise_for_status()

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

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

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

GET/itemoptions 200403

List item options.

Requires scope items:read.

Parameters

Name	In	Type	Notes
itemid	query	string	Restrict to one itemid.
description	query	string	description. Partial match, case-insensitive.
name	query	string	Partial match, case insensitive.
cancel	query	string	Defaults to `false`. Pass `true` or `any`.
modifiedsince	query	string	RFC 3339 UTC timestamp. Returns only records changed since then, including cancelled ones - so `cancel` defaults to any rather than `false` when this is used. The response carries `_meta.synced_through`; store it and send it back next time.
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/itemoptions' \
  -H 'Authorization: Bearer $NP_TOKEN'

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

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

POST/itemoptions 201400

Create.

Requires scope items:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
idread-only	integer	NolaPro id.
itemoptiongroupid	integer	Itemoptiongroupid. 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.
optioncode	string(50)	Short code of the option, shown after its name in pickers.
pricemoney	string(6dp)	Stored as `decimal(12,6)`.
costmoney	string(6dp)	Stored as `decimal(12,6)`.
minqtyqty	string(6dp)	Quantity, 6 decimal places, as a string. Stored as `decimal(6dp)`.
maxqtyqty	string(6dp)	Quantity, 6 decimal places, as a string. Stored as `decimal(6dp)`.
mainind	integer	0 when the option quantity follows the main item quantity, 1 when it is independent (the screen asks Dependent On Main Item Qty).
name	string(255)	Option name shown to the buyer.
description	text	Description. Stored as `text`, no practical length limit.
priceunitnameid	integer	Priceunitnameid. Id only.
priceunitname	string(50)	The `unitname` of the referenced unitnames, instead of the id. Send this or `priceunitnameid`, not both unless they agree.
salesunitnameid	integer	Reference to `unitnames`, by id. Write either this or `salesunitname`.
salesunitname	string(50)	The `unitname` of the referenced unitnames, instead of the id. Send this or `salesunitnameid`, not both unless they agree.
saleunitperpriceunitnumber	string(2dp)	Numeric string, 2 decimal places. Not money - do not apply currency rounding.
lbsperpriceunitnumber	string	Numeric string. Not money - do not apply currency rounding.
defaultvaluemoney	string(6dp)	Stored as `decimal(12,6)`.
defaultoption	integer	1 preselects this option in its group.
displayorder	integer	Position of the option within its group.
taxable	integer	Whether this line is taxed.
salesglaccountid	integer	Reference to `glaccounts`, by id. Write either this or `salesglaccount`.
salesglaccount	string(20)	The `name` of the referenced glaccounts, instead of the id. Send this or `salesglaccountid`, not both unless they agree.
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
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/itemoptions' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "itemoptiongroupid": 104,
    "itemid": 104,
    "item": "Example item",
    "optioncode": "ACME-01",
    "price": "125.0000",
    "cost": "125.0000"
}'

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

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/itemoptions",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "itemoptiongroupid": 104,
        "itemid": 104,
        "item": "Example item",
        "optioncode": "ACME-01",
        "price": "125.0000",
        "cost": "125.0000",
    },
)
r.raise_for_status()

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

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

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

Response 201

{
    "itemoptiongroupid": 104,
    "itemid": 104,
    "item": "Example item",
    "optioncode": "ACME-01",
    "price": "125.0000",
    "cost": "125.0000"
}

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

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

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

Response 200

{
    "itemoptiongroupid": 104,
    "itemid": 104,
    "item": "Example item",
    "optioncode": "ACME-01",
    "price": "125.0000",
    "cost": "125.0000"
}

PATCH/itemoptions/{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.
itemoptiongroupid	integer	Itemoptiongroupid. 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.
optioncode	string(50)	Short code of the option, shown after its name in pickers.
pricemoney	string(6dp)	Stored as `decimal(12,6)`.
costmoney	string(6dp)	Stored as `decimal(12,6)`.
minqtyqty	string(6dp)	Quantity, 6 decimal places, as a string. Stored as `decimal(6dp)`.
maxqtyqty	string(6dp)	Quantity, 6 decimal places, as a string. Stored as `decimal(6dp)`.
mainind	integer	0 when the option quantity follows the main item quantity, 1 when it is independent (the screen asks Dependent On Main Item Qty).
name	string(255)	Option name shown to the buyer.
description	text	Description. Stored as `text`, no practical length limit.
priceunitnameid	integer	Priceunitnameid. Id only.
priceunitname	string(50)	The `unitname` of the referenced unitnames, instead of the id. Send this or `priceunitnameid`, not both unless they agree.
salesunitnameid	integer	Reference to `unitnames`, by id. Write either this or `salesunitname`.
salesunitname	string(50)	The `unitname` of the referenced unitnames, instead of the id. Send this or `salesunitnameid`, not both unless they agree.
saleunitperpriceunitnumber	string(2dp)	Numeric string, 2 decimal places. Not money - do not apply currency rounding.
lbsperpriceunitnumber	string	Numeric string. Not money - do not apply currency rounding.
defaultvaluemoney	string(6dp)	Stored as `decimal(12,6)`.
defaultoption	integer	1 preselects this option in its group.
displayorder	integer	Position of the option within its group.
taxable	integer	Whether this line is taxed.
salesglaccountid	integer	Reference to `glaccounts`, by id. Write either this or `salesglaccount`.
salesglaccount	string(20)	The `name` of the referenced glaccounts, instead of the id. Send this or `salesglaccountid`, not both unless they agree.
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
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/itemoptions/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "itemoptiongroupid": 104,
    "itemid": 104,
    "item": "Example item",
    "optioncode": "ACME-01",
    "price": "125.0000",
    "cost": "125.0000"
}'

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

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/itemoptions/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "itemoptiongroupid": 104,
        "itemid": 104,
        "item": "Example item",
        "optioncode": "ACME-01",
        "price": "125.0000",
        "cost": "125.0000",
    },
)
r.raise_for_status()

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

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

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

Response 200

{
    "itemoptiongroupid": 104,
    "itemid": 104,
    "item": "Example item",
    "optioncode": "ACME-01",
    "price": "125.0000",
    "cost": "125.0000"
}

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

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

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

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

Response 200

{
    "itemoptiongroupid": 104,
    "itemid": 104,
    "item": "Example item",
    "optioncode": "ACME-01",
    "price": "125.0000",
    "cost": "125.0000"
}

Item option groups →

Groups that item options belong to.

Item comparison groups →

Groups used to compare items against each other in the storefront.