Item option groups

Groups that item options belong to.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
name	string(255)	Name of the option group shown above its choices.
description	text	Description. Stored as `text`, no practical length limit.
optiontype	text	How the group renders: radio, checkbox, or select.
allowblank	integer	1 allows leaving the group unselected.
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).
default	boolean	Default choice for the group.
invoiceprinthidezerototals	boolean	1 hides zero-total option lines when printing invoices.
invoiceprintmode	boolean	How chosen options print on invoices: 0 = each option on its own line, 1 = grouped into a subtotal.
externalid	string(100)	Your own key. Scoped to your company.

Endpoints#

POST/itemoptiongroups/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 option group shown above its choices.
description	text	Description. Stored as `text`, no practical length limit.
optiontype	text	How the group renders: radio, checkbox, or select.
allowblank	integer	1 allows leaving the group unselected.
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).
default	boolean	Default choice for the group.
invoiceprinthidezerototals	boolean	1 hides zero-total option lines when printing invoices.
invoiceprintmode	boolean	How chosen options print on invoices: 0 = each option on its own line, 1 = grouped into a subtotal.
externalid	string(100)	Your own key. Scoped to your company.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/itemoptiongroups/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "name": "Example name",
        "description": "Example description",
        "optiontype": "Example optiontype",
        "allowblank": 1,
        "default": false,
        "invoiceprinthidezerototals": false
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/itemoptiongroups/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',
      'description' => 'Example description',
      'optiontype' => 'Example optiontype',
      'allowblank' => 1,
      'default' => false,
      'invoiceprinthidezerototals' => false,
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/itemoptiongroups/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "name": "Example name",
            "description": "Example description",
            "optiontype": "Example optiontype",
            "allowblank": 1,
            "default": False,
            "invoiceprinthidezerototals": False,
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/itemoptiongroups/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        name: "Example name",
        description: "Example description",
        optiontype: "Example optiontype",
        allowblank: 1,
        default: false,
        invoiceprinthidezerototals: 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",
        description = "Example description",
        optiontype = "Example optiontype",
        allowblank = 1,
        @default = false,
        invoiceprinthidezerototals = false,
    },
};

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

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

GET/itemoptiongroups 200403

List item option groups.

Requires scope items:read.

Parameters

Name	In	Type	Notes
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/itemoptiongroups' \
  -H 'Authorization: Bearer $NP_TOKEN'

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

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

POST/itemoptiongroups 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 option group shown above its choices.
description	text	Description. Stored as `text`, no practical length limit.
optiontype	text	How the group renders: radio, checkbox, or select.
allowblank	integer	1 allows leaving the group unselected.
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).
default	boolean	Default choice for the group.
invoiceprinthidezerototals	boolean	1 hides zero-total option lines when printing invoices.
invoiceprintmode	boolean	How chosen options print on invoices: 0 = each option on its own line, 1 = grouped into a subtotal.
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/itemoptiongroups' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "name": "Example name",
    "description": "Example description",
    "optiontype": "Example optiontype",
    "allowblank": 1,
    "default": false,
    "invoiceprinthidezerototals": false
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/itemoptiongroups');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'name' => 'Example name',
    'description' => 'Example description',
    'optiontype' => 'Example optiontype',
    'allowblank' => 1,
    'default' => false,
    'invoiceprinthidezerototals' => false,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/itemoptiongroups",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "name": "Example name",
        "description": "Example description",
        "optiontype": "Example optiontype",
        "allowblank": 1,
        "default": False,
        "invoiceprinthidezerototals": False,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/itemoptiongroups',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      name: "Example name",
      description: "Example description",
      optiontype: "Example optiontype",
      allowblank: 1,
      default: false,
      invoiceprinthidezerototals: 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",
    description = "Example description",
    optiontype = "Example optiontype",
    allowblank = 1,
    @default = false,
    invoiceprinthidezerototals = false,
};

var req = new HttpRequestMessage(HttpMethod.Post,
    "https://acme.nolapro.com/!/api/v2/itemoptiongroups") {
    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",
    "description": "Example description",
    "optiontype": "Example optiontype",
    "allowblank": 1,
    "default": false,
    "invoiceprinthidezerototals": false
}

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

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

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

Response 200

{
    "name": "Example name",
    "description": "Example description",
    "optiontype": "Example optiontype",
    "allowblank": 1,
    "default": false,
    "invoiceprinthidezerototals": false
}

PATCH/itemoptiongroups/{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 option group shown above its choices.
description	text	Description. Stored as `text`, no practical length limit.
optiontype	text	How the group renders: radio, checkbox, or select.
allowblank	integer	1 allows leaving the group unselected.
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).
default	boolean	Default choice for the group.
invoiceprinthidezerototals	boolean	1 hides zero-total option lines when printing invoices.
invoiceprintmode	boolean	How chosen options print on invoices: 0 = each option on its own line, 1 = grouped into a subtotal.
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/itemoptiongroups/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "name": "Example name",
    "description": "Example description",
    "optiontype": "Example optiontype",
    "allowblank": 1,
    "default": false,
    "invoiceprinthidezerototals": false
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/itemoptiongroups/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',
    'description' => 'Example description',
    'optiontype' => 'Example optiontype',
    'allowblank' => 1,
    'default' => false,
    'invoiceprinthidezerototals' => false,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/itemoptiongroups/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "name": "Example name",
        "description": "Example description",
        "optiontype": "Example optiontype",
        "allowblank": 1,
        "default": False,
        "invoiceprinthidezerototals": False,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/itemoptiongroups/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      name: "Example name",
      description: "Example description",
      optiontype: "Example optiontype",
      allowblank: 1,
      default: false,
      invoiceprinthidezerototals: 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",
    description = "Example description",
    optiontype = "Example optiontype",
    allowblank = 1,
    @default = false,
    invoiceprinthidezerototals = false,
};

var req = new HttpRequestMessage(HttpMethod.Patch,
    "https://acme.nolapro.com/!/api/v2/itemoptiongroups/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",
    "description": "Example description",
    "optiontype": "Example optiontype",
    "allowblank": 1,
    "default": false,
    "invoiceprinthidezerototals": false
}

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

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

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

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

Response 200

{
    "name": "Example name",
    "description": "Example description",
    "optiontype": "Example optiontype",
    "allowblank": 1,
    "default": false,
    "invoiceprinthidezerototals": false
}

Item comparison groups →

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

Item price specials →

Special pricing headers. The rows live in itempricespecialdetails.