Carriers

Shipping carriers.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
customernumber	string(20)	Your account number with the carrier.
trackingurlbase	string(150)	Base URL used to build tracking links for this carrier.
trackingurlvarname	string(30)	Query parameter name the tracking number is appended as when building tracking links.
description	string(100)	Carrier name shown on documents and pickers.
vendorid	integer	Reference to `vendors`, by id. Write either this or `vendor`.
vendor	string(30)	Code for the referenced vendor, instead of the id.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
carrier_upchargemoney	string(2dp)	Stored as `decimal(5,2)`.
carrier_upcharge_flatmoney	string(6dp)	Stored as `decimal(19,6)`.
maxboxweightnumber	string(2dp)	Numeric string, 2 decimal places. Not money - do not apply currency rounding.
shipheightmoney	string(2dp)	Stored as `decimal(7,2)`.
shiplengthmoney	string(2dp)	Stored as `decimal(7,2)`.
shipwidthmoney	string(2dp)	Stored as `decimal(7,2)`.
usenegotiatedrates	integer	1 rates shipments with your negotiated carrier rates instead of published rates.
externalid	string(100)	Your own key. Scoped to your company.

Endpoints#

POST/carriers/batch 207

Create many.

Requires scope setup:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
customernumber	string(20)	Your account number with the carrier.
trackingurlbase	string(150)	Base URL used to build tracking links for this carrier.
trackingurlvarname	string(30)	Query parameter name the tracking number is appended as when building tracking links.
description	string(100)	Carrier name shown on documents and pickers.
vendorid	integer	Reference to `vendors`, by id. Write either this or `vendor`.
vendor	string(30)	Code for the referenced vendor, instead of the id.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
carrier_upchargemoney	string(2dp)	Stored as `decimal(5,2)`.
carrier_upcharge_flatmoney	string(6dp)	Stored as `decimal(19,6)`.
maxboxweightnumber	string(2dp)	Numeric string, 2 decimal places. Not money - do not apply currency rounding.
shipheightmoney	string(2dp)	Stored as `decimal(7,2)`.
shiplengthmoney	string(2dp)	Stored as `decimal(7,2)`.
shipwidthmoney	string(2dp)	Stored as `decimal(7,2)`.
usenegotiatedrates	integer	1 rates shipments with your negotiated carrier rates instead of published rates.
externalid	string(100)	Your own key. Scoped to your company.
services	array of RefCarrierservicesCreate	Service levels offered by this carrier.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/carriers/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "services": [
            {
                "description": "Example description",
                "abbreviation": "Example abbreviation",
                "sortorder": 1,
                "not_on_b2b": 1,
                "onquote": 1,
                "box1_charge": "125.0000"
            }
        ]
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/carriers/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'services' => [
        [
          'description' => 'Example description',
          'abbreviation' => 'Example abbreviation',
          'sortorder' => 1,
          'not_on_b2b' => 1,
          'onquote' => 1,
          'box1_charge' => '125.0000',
        ],
      ],
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/carriers/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "services": [
                {
                    "description": "Example description",
                    "abbreviation": "Example abbreviation",
                    "sortorder": 1,
                    "not_on_b2b": 1,
                    "onquote": 1,
                    "box1_charge": "125.0000",
                },
            ],
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/carriers/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        services: [
          {
            description: "Example description",
            abbreviation: "Example abbreviation",
            sortorder: 1,
            not_on_b2b: 1,
            onquote: 1,
            box1_charge: "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 {
        services = new[] {
            new {
                description = "Example description",
                abbreviation = "Example abbreviation",
                sortorder = 1,
                not_on_b2b = 1,
                onquote = 1,
                box1_charge = "125.0000",
            },
        },
    },
};

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

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

GET/carriers 200403

List carriers.

Requires scope setup:read.

Parameters

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

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

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

POST/carriers 201400

Create.

Requires scope setup:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
customernumber	string(20)	Your account number with the carrier.
trackingurlbase	string(150)	Base URL used to build tracking links for this carrier.
trackingurlvarname	string(30)	Query parameter name the tracking number is appended as when building tracking links.
description	string(100)	Carrier name shown on documents and pickers.
vendorid	integer	Reference to `vendors`, by id. Write either this or `vendor`.
vendor	string(30)	Code for the referenced vendor, instead of the id.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
carrier_upchargemoney	string(2dp)	Stored as `decimal(5,2)`.
carrier_upcharge_flatmoney	string(6dp)	Stored as `decimal(19,6)`.
maxboxweightnumber	string(2dp)	Numeric string, 2 decimal places. Not money - do not apply currency rounding.
shipheightmoney	string(2dp)	Stored as `decimal(7,2)`.
shiplengthmoney	string(2dp)	Stored as `decimal(7,2)`.
shipwidthmoney	string(2dp)	Stored as `decimal(7,2)`.
usenegotiatedrates	integer	1 rates shipments with your negotiated carrier rates instead of published rates.
externalid	string(100)	Your own key. Scoped to your company.
services	array of RefCarrierservicesCreate	Service levels offered by this carrier.

When it fails

Status	Code	Meaning
400	invalid_request	A required field was missing.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/carriers' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "services": [
        {
            "description": "Example description",
            "abbreviation": "Example abbreviation",
            "sortorder": 1,
            "not_on_b2b": 1,
            "onquote": 1,
            "box1_charge": "125.0000"
        }
    ]
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/carriers');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'services' => [
      [
        'description' => 'Example description',
        'abbreviation' => 'Example abbreviation',
        'sortorder' => 1,
        'not_on_b2b' => 1,
        'onquote' => 1,
        'box1_charge' => '125.0000',
      ],
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/carriers",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "services": [
            {
                "description": "Example description",
                "abbreviation": "Example abbreviation",
                "sortorder": 1,
                "not_on_b2b": 1,
                "onquote": 1,
                "box1_charge": "125.0000",
            },
        ],
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/carriers',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      services: [
        {
          description: "Example description",
          abbreviation: "Example abbreviation",
          sortorder: 1,
          not_on_b2b: 1,
          onquote: 1,
          box1_charge: "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 {
    services = new[] {
        new {
            description = "Example description",
            abbreviation = "Example abbreviation",
            sortorder = 1,
            not_on_b2b = 1,
            onquote = 1,
            box1_charge = "125.0000",
        },
    },
};

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

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

Response 201

{
    "customernumber": "INV-88421",
    "trackingurlbase": "Example trackingurlbase",
    "trackingurlvarname": "Example trackingurlvarname",
    "description": "Example description",
    "vendorid": 104,
    "vendor": "Example vendor"
}

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

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

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

Response 200

{
    "customernumber": "INV-88421",
    "trackingurlbase": "Example trackingurlbase",
    "trackingurlvarname": "Example trackingurlvarname",
    "description": "Example description",
    "vendorid": 104,
    "vendor": "Example vendor"
}

PATCH/carriers/{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.
customernumber	string(20)	Your account number with the carrier.
trackingurlbase	string(150)	Base URL used to build tracking links for this carrier.
trackingurlvarname	string(30)	Query parameter name the tracking number is appended as when building tracking links.
description	string(100)	Carrier name shown on documents and pickers.
vendorid	integer	Reference to `vendors`, by id. Write either this or `vendor`.
vendor	string(30)	Code for the referenced vendor, instead of the id.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
carrier_upchargemoney	string(2dp)	Stored as `decimal(5,2)`.
carrier_upcharge_flatmoney	string(6dp)	Stored as `decimal(19,6)`.
maxboxweightnumber	string(2dp)	Numeric string, 2 decimal places. Not money - do not apply currency rounding.
shipheightmoney	string(2dp)	Stored as `decimal(7,2)`.
shiplengthmoney	string(2dp)	Stored as `decimal(7,2)`.
shipwidthmoney	string(2dp)	Stored as `decimal(7,2)`.
usenegotiatedrates	integer	1 rates shipments with your negotiated carrier rates instead of published rates.
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/carriers/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "customernumber": "INV-88421",
    "trackingurlbase": "Example trackingurlbase",
    "trackingurlvarname": "Example trackingurlvarname",
    "description": "Example description",
    "vendorid": 104,
    "vendor": "Example vendor"
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/carriers/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'customernumber' => 'INV-88421',
    'trackingurlbase' => 'Example trackingurlbase',
    'trackingurlvarname' => 'Example trackingurlvarname',
    'description' => 'Example description',
    'vendorid' => 104,
    'vendor' => 'Example vendor',
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/carriers/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "customernumber": "INV-88421",
        "trackingurlbase": "Example trackingurlbase",
        "trackingurlvarname": "Example trackingurlvarname",
        "description": "Example description",
        "vendorid": 104,
        "vendor": "Example vendor",
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/carriers/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      customernumber: "INV-88421",
      trackingurlbase: "Example trackingurlbase",
      trackingurlvarname: "Example trackingurlvarname",
      description: "Example description",
      vendorid: 104,
      vendor: "Example vendor",
    }),
  }
);
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 {
    customernumber = "INV-88421",
    trackingurlbase = "Example trackingurlbase",
    trackingurlvarname = "Example trackingurlvarname",
    description = "Example description",
    vendorid = 104,
    vendor = "Example vendor",
};

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

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

Response 200

{
    "customernumber": "INV-88421",
    "trackingurlbase": "Example trackingurlbase",
    "trackingurlvarname": "Example trackingurlvarname",
    "description": "Example description",
    "vendorid": 104,
    "vendor": "Example vendor"
}

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

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

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

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

Response 200

{
    "customernumber": "INV-88421",
    "trackingurlbase": "Example trackingurlbase",
    "trackingurlvarname": "Example trackingurlvarname",
    "description": "Example description",
    "vendorid": 104,
    "vendor": "Example vendor"
}

Carrier services →

Service levels offered by a carrier.

Interest charge options →

This table has no name, code or label - it is an id and a rate. There is therefore no code sibling anywhere that references it, permanently. Read-only.