Coupons

Coupon codes.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
coupon_code	string(50)	Code the customer enters to apply the coupon.
percent_discountnumber	string(2dp)	Numeric string, 2 decimal places. Not money - do not apply currency rounding.
dollars_discountmoney	string(5dp)	Stored as `decimal(19,5)`.
description	string(255)	Description of the coupon.
expirationdate	string	Date the coupon stops working.
maxdollarsmoney	string(6dp)	Stored as `decimal(19,6)`.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydateread-only	string	When the record was created.
externalid	string(100)	Your own key. Scoped to your company.

Endpoints#

POST/coupons/batch 207

Create many.

Requires scope setup:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
coupon_code	string(50)	Code the customer enters to apply the coupon.
percent_discountnumber	string(2dp)	Numeric string, 2 decimal places. Not money - do not apply currency rounding.
dollars_discountmoney	string(5dp)	Stored as `decimal(19,5)`.
description	string(255)	Description of the coupon.
expirationdate	string	Date the coupon stops working.
maxdollarsmoney	string(6dp)	Stored as `decimal(19,6)`.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydateread-only	string	When the record was created.
externalid	string(100)	Your own key. Scoped to your company.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/coupons/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "coupon_code": "ACME-01",
        "percent_discount": "Example percent discount",
        "dollars_discount": "125.0000",
        "description": "Example description",
        "expirationdate": "2026-08-01",
        "maxdollars": "125.0000"
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/coupons/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'coupon_code' => 'ACME-01',
      'percent_discount' => 'Example percent discount',
      'dollars_discount' => '125.0000',
      'description' => 'Example description',
      'expirationdate' => '2026-08-01',
      'maxdollars' => '125.0000',
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/coupons/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "coupon_code": "ACME-01",
            "percent_discount": "Example percent discount",
            "dollars_discount": "125.0000",
            "description": "Example description",
            "expirationdate": "2026-08-01",
            "maxdollars": "125.0000",
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/coupons/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        coupon_code: "ACME-01",
        percent_discount: "Example percent discount",
        dollars_discount: "125.0000",
        description: "Example description",
        expirationdate: "2026-08-01",
        maxdollars: "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 {
        coupon_code = "ACME-01",
        percent_discount = "Example percent discount",
        dollars_discount = "125.0000",
        description = "Example description",
        expirationdate = "2026-08-01",
        maxdollars = "125.0000",
    },
};

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

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

GET/coupons 200403

List coupons.

Requires scope setup:read.

Parameters

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

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

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

POST/coupons 201400

Create.

Requires scope setup:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
idread-only	integer	NolaPro id.
coupon_code	string(50)	Code the customer enters to apply the coupon.
percent_discountnumber	string(2dp)	Numeric string, 2 decimal places. Not money - do not apply currency rounding.
dollars_discountmoney	string(5dp)	Stored as `decimal(19,5)`.
description	string(255)	Description of the coupon.
expirationdate	string	Date the coupon stops working.
maxdollarsmoney	string(6dp)	Stored as `decimal(19,6)`.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydateread-only	string	When the record was created.
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/coupons' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "coupon_code": "ACME-01",
    "percent_discount": "Example percent discount",
    "dollars_discount": "125.0000",
    "description": "Example description",
    "expirationdate": "2026-08-01",
    "maxdollars": "125.0000"
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/coupons');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'coupon_code' => 'ACME-01',
    'percent_discount' => 'Example percent discount',
    'dollars_discount' => '125.0000',
    'description' => 'Example description',
    'expirationdate' => '2026-08-01',
    'maxdollars' => '125.0000',
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/coupons",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "coupon_code": "ACME-01",
        "percent_discount": "Example percent discount",
        "dollars_discount": "125.0000",
        "description": "Example description",
        "expirationdate": "2026-08-01",
        "maxdollars": "125.0000",
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/coupons',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      coupon_code: "ACME-01",
      percent_discount: "Example percent discount",
      dollars_discount: "125.0000",
      description: "Example description",
      expirationdate: "2026-08-01",
      maxdollars: "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 {
    coupon_code = "ACME-01",
    percent_discount = "Example percent discount",
    dollars_discount = "125.0000",
    description = "Example description",
    expirationdate = "2026-08-01",
    maxdollars = "125.0000",
};

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

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

Response 201

{
    "coupon_code": "ACME-01",
    "percent_discount": "Example percent discount",
    "dollars_discount": "125.0000",
    "description": "Example description",
    "expirationdate": "2026-08-01",
    "maxdollars": "125.0000"
}

GET/coupons/{id} 200404

Retrieve one record.

Requires scope setup: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/coupons/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

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

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

Response 200

{
    "coupon_code": "ACME-01",
    "percent_discount": "Example percent discount",
    "dollars_discount": "125.0000",
    "description": "Example description",
    "expirationdate": "2026-08-01",
    "maxdollars": "125.0000"
}

PATCH/coupons/{id} 200404

Update.

Requires scope setup:write.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

Body

Field	Type	Description
idread-only	integer	NolaPro id.
coupon_code	string(50)	Code the customer enters to apply the coupon.
percent_discountnumber	string(2dp)	Numeric string, 2 decimal places. Not money - do not apply currency rounding.
dollars_discountmoney	string(5dp)	Stored as `decimal(19,5)`.
description	string(255)	Description of the coupon.
expirationdate	string	Date the coupon stops working.
maxdollarsmoney	string(6dp)	Stored as `decimal(19,6)`.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydateread-only	string	When the record was created.
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/coupons/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "coupon_code": "ACME-01",
    "percent_discount": "Example percent discount",
    "dollars_discount": "125.0000",
    "description": "Example description",
    "expirationdate": "2026-08-01",
    "maxdollars": "125.0000"
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/coupons/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'coupon_code' => 'ACME-01',
    'percent_discount' => 'Example percent discount',
    'dollars_discount' => '125.0000',
    'description' => 'Example description',
    'expirationdate' => '2026-08-01',
    'maxdollars' => '125.0000',
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/coupons/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "coupon_code": "ACME-01",
        "percent_discount": "Example percent discount",
        "dollars_discount": "125.0000",
        "description": "Example description",
        "expirationdate": "2026-08-01",
        "maxdollars": "125.0000",
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/coupons/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      coupon_code: "ACME-01",
      percent_discount: "Example percent discount",
      dollars_discount: "125.0000",
      description: "Example description",
      expirationdate: "2026-08-01",
      maxdollars: "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 {
    coupon_code = "ACME-01",
    percent_discount = "Example percent discount",
    dollars_discount = "125.0000",
    description = "Example description",
    expirationdate = "2026-08-01",
    maxdollars = "125.0000",
};

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

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

Response 200

{
    "coupon_code": "ACME-01",
    "percent_discount": "Example percent discount",
    "dollars_discount": "125.0000",
    "description": "Example description",
    "expirationdate": "2026-08-01",
    "maxdollars": "125.0000"
}

DELETE/coupons/{id} 200404

Cancel.

Requires scope setup: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/coupons/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

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

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

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

Response 200

{
    "coupon_code": "ACME-01",
    "percent_discount": "Example percent discount",
    "dollars_discount": "125.0000",
    "description": "Example description",
    "expirationdate": "2026-08-01",
    "maxdollars": "125.0000"
}

Carriers →

Shipping carriers.

Carrier services →

Service levels offered by a carrier.