Ship-tos

Delivery addresses on a customer. An order or invoice ships to one of these.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
defaultshipvia	integer	Default shipping method (carrier service) for orders shipping to this address.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
address1	string(100)	Street address.
address2	string(100)	Second address line.
mailstop	string(20)	Mail stop line printed with the address.
city	string(50)	City of the address.
state	string(20)	State of the address.
zip	string(15)	Postal code.
country	string(20)	Country of the address.
phone1	string(20)	Primary phone.
phone1comment	string(20)	Label describing what phone1 reaches (Office, Mobile, ...).
phone2	string(20)	Additional phone number.
phone2comment	string(20)	Label describing what phone2 reaches (Office, Mobile, ...).
phone3	string(20)	Additional phone number.
phone3comment	string(20)	Label describing what phone3 reaches (Office, Mobile, ...).
phone4	string(20)	Additional phone number.
phone4comment	string(20)	Label describing what phone4 reaches (Office, Mobile, ...).
email1	string(255)	Primary email address for this location.
email2	string(255)	Secondary email.
email1comment	string(20)	Label describing what email1 is for.
email2comment	string(20)	Label describing what email2 is for.
customerid	integer	Reference to `customers`, by id. Write either this or `customer`.
customer	string(30)	Code for the referenced customer, instead of the id.
shipname	string(50)	Ship To name printed on shipping documents.
entry_firstname	string(32)	First name of the receiving contact, printed as the ship-to attention line.
entry_lastname	string(32)	Last name of the receiving contact, printed as the ship-to attention line.
entry_country_id	integer	Numeric country id in the osCommerce-style cart tables. Kept for shopping-cart integrations; the address itself uses `country`.
entry_country	string(2)	The `countries_iso_code_2` of the referenced countries, instead of the id. Send this or `entry_country_id`, not both unless they agree.
entry_zone_id	integer	Numeric state/zone id in the osCommerce-style cart tables. Kept for shopping-cart integrations; the address itself uses `state`.
entry_zone	string(5)	The `zone_code` of the referenced zones, instead of the id. Send this or `entry_zone_id`, not both unless they agree.
taxexemptid	integer	Reference to `taxexempts`, by id. Write either this or `taxexempt`.
taxexempt	string(32)	The `exemptname` of the referenced taxexempts, instead of the id. Send this or `taxexemptid`, not both unless they agree.
salestaxnum	string(30)	Sales tax registration number.
weather_cf	string(1)	C or F - the temperature unit for the weather shown for this location on scheduling screens.
weather_zip	string(20)	ZIP code used to look up the weather for this location.
time_zone	string(6)	UTC offset of the location, e.g. -05:00.
is_default	integer	1 when this is the customer’s default ship-to address.
shipper_number	string(50)	Shipper Number - the customer’s carrier account that freight to this address is billed to, printed on invoices with the UPS account type.
shipname2	string(50)	Second Ship To name line, printed under `shipname`.
upstype	string(5)	UPS Account Type that `shipper_number` refers to: SHP = shipper, REC = receiver, TP = third party, CB = consignee billed. Empty when not used.
addressverifiedread-only	string(32)	Hash of the address as it stood when it last passed the AvaTax/USPS address check; when it no longer matches the current address the address counts as unverified. Maintained by the verification flow, so it cannot be written through the API.
blindship	boolean	True when shipments to this address are blind shipments - shipping papers do not reveal the shipper.
county	string(50)	County of the address, used for county sales tax.
countyid	string(25)	Tax-system county identifier used with `county` to pick the county tax; may be a dotted composite code.
residential	integer	1 when the address is residential. Affects carrier rating and tax address classification.
timezoneid	integer	Reference to `timezones`, by id. Write either this or `timezone`.
timezone	string(64)	The `name` of the referenced timezones, instead of the id. Send this or `timezoneid`, not both unless they agree.
contactnameid	integer	Contactnameid. Id only.
salesinventorylocationid	integer	Reference to `inventorylocations`, by id. Write either this or `salesinventorylocation`.
salesinventorylocation	string(20)	The `locationcode` of the referenced inventorylocations, instead of the id. Send this or `salesinventorylocationid`, not both unless they agree.
unincorporated	integer	1 when the address is in an unincorporated area, so no city sales tax applies.
recordtype	boolean	True when the row is a bill-to address record. NolaPro stores bill-to and ship-to addresses in the same table.
externalid	string(100)	Your own key. Scoped to your company.

Endpoints#

POST/shiptos/batch 207

Create many.

Requires scope customers:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
defaultshipvia	integer	Default shipping method (carrier service) for orders shipping to this address.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
address1	string(100)	Street address.
address2	string(100)	Second address line.
mailstop	string(20)	Mail stop line printed with the address.
city	string(50)	City of the address.
state	string(20)	State of the address.
zip	string(15)	Postal code.
country	string(20)	Country of the address.
phone1	string(20)	Primary phone.
phone1comment	string(20)	Label describing what phone1 reaches (Office, Mobile, ...).
phone2	string(20)	Additional phone number.
phone2comment	string(20)	Label describing what phone2 reaches (Office, Mobile, ...).
phone3	string(20)	Additional phone number.
phone3comment	string(20)	Label describing what phone3 reaches (Office, Mobile, ...).
phone4	string(20)	Additional phone number.
phone4comment	string(20)	Label describing what phone4 reaches (Office, Mobile, ...).
email1	string(255)	Primary email address for this location.
email2	string(255)	Secondary email.
email1comment	string(20)	Label describing what email1 is for.
email2comment	string(20)	Label describing what email2 is for.
customerid	integer	Reference to `customers`, by id. Write either this or `customer`.
customer	string(30)	Code for the referenced customer, instead of the id.
shipname	string(50)	Ship To name printed on shipping documents.
entry_firstname	string(32)	First name of the receiving contact, printed as the ship-to attention line.
entry_lastname	string(32)	Last name of the receiving contact, printed as the ship-to attention line.
entry_country_id	integer	Numeric country id in the osCommerce-style cart tables. Kept for shopping-cart integrations; the address itself uses `country`.
entry_country	string(2)	The `countries_iso_code_2` of the referenced countries, instead of the id. Send this or `entry_country_id`, not both unless they agree.
entry_zone_id	integer	Numeric state/zone id in the osCommerce-style cart tables. Kept for shopping-cart integrations; the address itself uses `state`.
entry_zone	string(5)	The `zone_code` of the referenced zones, instead of the id. Send this or `entry_zone_id`, not both unless they agree.
taxexemptid	integer	Reference to `taxexempts`, by id. Write either this or `taxexempt`.
taxexempt	string(32)	The `exemptname` of the referenced taxexempts, instead of the id. Send this or `taxexemptid`, not both unless they agree.
salestaxnum	string(30)	Sales tax registration number.
weather_cf	string(1)	C or F - the temperature unit for the weather shown for this location on scheduling screens.
weather_zip	string(20)	ZIP code used to look up the weather for this location.
time_zone	string(6)	UTC offset of the location, e.g. -05:00.
is_default	integer	1 when this is the customer’s default ship-to address.
shipper_number	string(50)	Shipper Number - the customer’s carrier account that freight to this address is billed to, printed on invoices with the UPS account type.
shipname2	string(50)	Second Ship To name line, printed under `shipname`.
upstype	string(5)	UPS Account Type that `shipper_number` refers to: SHP = shipper, REC = receiver, TP = third party, CB = consignee billed. Empty when not used.
addressverifiedread-only	string(32)	Hash of the address as it stood when it last passed the AvaTax/USPS address check; when it no longer matches the current address the address counts as unverified. Maintained by the verification flow, so it cannot be written through the API.
blindship	boolean	True when shipments to this address are blind shipments - shipping papers do not reveal the shipper.
county	string(50)	County of the address, used for county sales tax.
countyid	string(25)	Tax-system county identifier used with `county` to pick the county tax; may be a dotted composite code.
residential	integer	1 when the address is residential. Affects carrier rating and tax address classification.
timezoneid	integer	Reference to `timezones`, by id. Write either this or `timezone`.
timezone	string(64)	The `name` of the referenced timezones, instead of the id. Send this or `timezoneid`, not both unless they agree.
contactnameid	integer	Contactnameid. Id only.
salesinventorylocationid	integer	Reference to `inventorylocations`, by id. Write either this or `salesinventorylocation`.
salesinventorylocation	string(20)	The `locationcode` of the referenced inventorylocations, instead of the id. Send this or `salesinventorylocationid`, not both unless they agree.
unincorporated	integer	1 when the address is in an unincorporated area, so no city sales tax applies.
recordtype	boolean	True when the row is a bill-to address record. NolaPro stores bill-to and ship-to addresses in the same table.
externalid	string(100)	Your own key. Scoped to your company.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/shiptos/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "defaultshipvia": 1,
        "address1": "Example address1",
        "address2": "Example address2",
        "mailstop": "Example mailstop",
        "city": "Example city",
        "state": "Example state"
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/shiptos/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'defaultshipvia' => 1,
      'address1' => 'Example address1',
      'address2' => 'Example address2',
      'mailstop' => 'Example mailstop',
      'city' => 'Example city',
      'state' => 'Example state',
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/shiptos/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "defaultshipvia": 1,
            "address1": "Example address1",
            "address2": "Example address2",
            "mailstop": "Example mailstop",
            "city": "Example city",
            "state": "Example state",
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/shiptos/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        defaultshipvia: 1,
        address1: "Example address1",
        address2: "Example address2",
        mailstop: "Example mailstop",
        city: "Example city",
        state: "Example state",
      },
    ]),
  }
);
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 {
        defaultshipvia = 1,
        address1 = "Example address1",
        address2 = "Example address2",
        mailstop = "Example mailstop",
        city = "Example city",
        state = "Example state",
    },
};

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

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

GET/shiptos 200403

List ship-tos.

Requires scope customers:read.

Parameters

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

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

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

POST/shiptos 201400

Create.

Requires scope customers:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
idread-only	integer	NolaPro id.
defaultshipvia	integer	Default shipping method (carrier service) for orders shipping to this address.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
address1	string(100)	Street address.
address2	string(100)	Second address line.
mailstop	string(20)	Mail stop line printed with the address.
city	string(50)	City of the address.
state	string(20)	State of the address.
zip	string(15)	Postal code.
country	string(20)	Country of the address.
phone1	string(20)	Primary phone.
phone1comment	string(20)	Label describing what phone1 reaches (Office, Mobile, ...).
phone2	string(20)	Additional phone number.
phone2comment	string(20)	Label describing what phone2 reaches (Office, Mobile, ...).
phone3	string(20)	Additional phone number.
phone3comment	string(20)	Label describing what phone3 reaches (Office, Mobile, ...).
phone4	string(20)	Additional phone number.
phone4comment	string(20)	Label describing what phone4 reaches (Office, Mobile, ...).
email1	string(255)	Primary email address for this location.
email2	string(255)	Secondary email.
email1comment	string(20)	Label describing what email1 is for.
email2comment	string(20)	Label describing what email2 is for.
customerid	integer	Reference to `customers`, by id. Write either this or `customer`.
customer	string(30)	Code for the referenced customer, instead of the id.
shipname	string(50)	Ship To name printed on shipping documents.
entry_firstname	string(32)	First name of the receiving contact, printed as the ship-to attention line.
entry_lastname	string(32)	Last name of the receiving contact, printed as the ship-to attention line.
entry_country_id	integer	Numeric country id in the osCommerce-style cart tables. Kept for shopping-cart integrations; the address itself uses `country`.
entry_country	string(2)	The `countries_iso_code_2` of the referenced countries, instead of the id. Send this or `entry_country_id`, not both unless they agree.
entry_zone_id	integer	Numeric state/zone id in the osCommerce-style cart tables. Kept for shopping-cart integrations; the address itself uses `state`.
entry_zone	string(5)	The `zone_code` of the referenced zones, instead of the id. Send this or `entry_zone_id`, not both unless they agree.
taxexemptid	integer	Reference to `taxexempts`, by id. Write either this or `taxexempt`.
taxexempt	string(32)	The `exemptname` of the referenced taxexempts, instead of the id. Send this or `taxexemptid`, not both unless they agree.
salestaxnum	string(30)	Sales tax registration number.
weather_cf	string(1)	C or F - the temperature unit for the weather shown for this location on scheduling screens.
weather_zip	string(20)	ZIP code used to look up the weather for this location.
time_zone	string(6)	UTC offset of the location, e.g. -05:00.
is_default	integer	1 when this is the customer’s default ship-to address.
shipper_number	string(50)	Shipper Number - the customer’s carrier account that freight to this address is billed to, printed on invoices with the UPS account type.
shipname2	string(50)	Second Ship To name line, printed under `shipname`.
upstype	string(5)	UPS Account Type that `shipper_number` refers to: SHP = shipper, REC = receiver, TP = third party, CB = consignee billed. Empty when not used.
addressverifiedread-only	string(32)	Hash of the address as it stood when it last passed the AvaTax/USPS address check; when it no longer matches the current address the address counts as unverified. Maintained by the verification flow, so it cannot be written through the API.
blindship	boolean	True when shipments to this address are blind shipments - shipping papers do not reveal the shipper.
county	string(50)	County of the address, used for county sales tax.
countyid	string(25)	Tax-system county identifier used with `county` to pick the county tax; may be a dotted composite code.
residential	integer	1 when the address is residential. Affects carrier rating and tax address classification.
timezoneid	integer	Reference to `timezones`, by id. Write either this or `timezone`.
timezone	string(64)	The `name` of the referenced timezones, instead of the id. Send this or `timezoneid`, not both unless they agree.
contactnameid	integer	Contactnameid. Id only.
salesinventorylocationid	integer	Reference to `inventorylocations`, by id. Write either this or `salesinventorylocation`.
salesinventorylocation	string(20)	The `locationcode` of the referenced inventorylocations, instead of the id. Send this or `salesinventorylocationid`, not both unless they agree.
unincorporated	integer	1 when the address is in an unincorporated area, so no city sales tax applies.
recordtype	boolean	True when the row is a bill-to address record. NolaPro stores bill-to and ship-to addresses in the same table.
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/shiptos' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "defaultshipvia": 1,
    "address1": "Example address1",
    "address2": "Example address2",
    "mailstop": "Example mailstop",
    "city": "Example city",
    "state": "Example state"
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/shiptos');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'defaultshipvia' => 1,
    'address1' => 'Example address1',
    'address2' => 'Example address2',
    'mailstop' => 'Example mailstop',
    'city' => 'Example city',
    'state' => 'Example state',
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/shiptos",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "defaultshipvia": 1,
        "address1": "Example address1",
        "address2": "Example address2",
        "mailstop": "Example mailstop",
        "city": "Example city",
        "state": "Example state",
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/shiptos',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      defaultshipvia: 1,
      address1: "Example address1",
      address2: "Example address2",
      mailstop: "Example mailstop",
      city: "Example city",
      state: "Example state",
    }),
  }
);
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 {
    defaultshipvia = 1,
    address1 = "Example address1",
    address2 = "Example address2",
    mailstop = "Example mailstop",
    city = "Example city",
    state = "Example state",
};

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

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

Response 201

{
    "defaultshipvia": 1,
    "address1": "Example address1",
    "address2": "Example address2",
    "mailstop": "Example mailstop",
    "city": "Example city",
    "state": "Example state"
}

GET/shiptos/{id} 200404

Retrieve one record.

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

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

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

Response 200

{
    "defaultshipvia": 1,
    "address1": "Example address1",
    "address2": "Example address2",
    "mailstop": "Example mailstop",
    "city": "Example city",
    "state": "Example state"
}

PATCH/shiptos/{id} 200404

Update.

Requires scope customers:write.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

Body

Field	Type	Description
idread-only	integer	NolaPro id.
defaultshipvia	integer	Default shipping method (carrier service) for orders shipping to this address.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
address1	string(100)	Street address.
address2	string(100)	Second address line.
mailstop	string(20)	Mail stop line printed with the address.
city	string(50)	City of the address.
state	string(20)	State of the address.
zip	string(15)	Postal code.
country	string(20)	Country of the address.
phone1	string(20)	Primary phone.
phone1comment	string(20)	Label describing what phone1 reaches (Office, Mobile, ...).
phone2	string(20)	Additional phone number.
phone2comment	string(20)	Label describing what phone2 reaches (Office, Mobile, ...).
phone3	string(20)	Additional phone number.
phone3comment	string(20)	Label describing what phone3 reaches (Office, Mobile, ...).
phone4	string(20)	Additional phone number.
phone4comment	string(20)	Label describing what phone4 reaches (Office, Mobile, ...).
email1	string(255)	Primary email address for this location.
email2	string(255)	Secondary email.
email1comment	string(20)	Label describing what email1 is for.
email2comment	string(20)	Label describing what email2 is for.
customerid	integer	Reference to `customers`, by id. Write either this or `customer`.
customer	string(30)	Code for the referenced customer, instead of the id.
shipname	string(50)	Ship To name printed on shipping documents.
entry_firstname	string(32)	First name of the receiving contact, printed as the ship-to attention line.
entry_lastname	string(32)	Last name of the receiving contact, printed as the ship-to attention line.
entry_country_id	integer	Numeric country id in the osCommerce-style cart tables. Kept for shopping-cart integrations; the address itself uses `country`.
entry_country	string(2)	The `countries_iso_code_2` of the referenced countries, instead of the id. Send this or `entry_country_id`, not both unless they agree.
entry_zone_id	integer	Numeric state/zone id in the osCommerce-style cart tables. Kept for shopping-cart integrations; the address itself uses `state`.
entry_zone	string(5)	The `zone_code` of the referenced zones, instead of the id. Send this or `entry_zone_id`, not both unless they agree.
taxexemptid	integer	Reference to `taxexempts`, by id. Write either this or `taxexempt`.
taxexempt	string(32)	The `exemptname` of the referenced taxexempts, instead of the id. Send this or `taxexemptid`, not both unless they agree.
salestaxnum	string(30)	Sales tax registration number.
weather_cf	string(1)	C or F - the temperature unit for the weather shown for this location on scheduling screens.
weather_zip	string(20)	ZIP code used to look up the weather for this location.
time_zone	string(6)	UTC offset of the location, e.g. -05:00.
is_default	integer	1 when this is the customer’s default ship-to address.
shipper_number	string(50)	Shipper Number - the customer’s carrier account that freight to this address is billed to, printed on invoices with the UPS account type.
shipname2	string(50)	Second Ship To name line, printed under `shipname`.
upstype	string(5)	UPS Account Type that `shipper_number` refers to: SHP = shipper, REC = receiver, TP = third party, CB = consignee billed. Empty when not used.
addressverifiedread-only	string(32)	Hash of the address as it stood when it last passed the AvaTax/USPS address check; when it no longer matches the current address the address counts as unverified. Maintained by the verification flow, so it cannot be written through the API.
blindship	boolean	True when shipments to this address are blind shipments - shipping papers do not reveal the shipper.
county	string(50)	County of the address, used for county sales tax.
countyid	string(25)	Tax-system county identifier used with `county` to pick the county tax; may be a dotted composite code.
residential	integer	1 when the address is residential. Affects carrier rating and tax address classification.
timezoneid	integer	Reference to `timezones`, by id. Write either this or `timezone`.
timezone	string(64)	The `name` of the referenced timezones, instead of the id. Send this or `timezoneid`, not both unless they agree.
contactnameid	integer	Contactnameid. Id only.
salesinventorylocationid	integer	Reference to `inventorylocations`, by id. Write either this or `salesinventorylocation`.
salesinventorylocation	string(20)	The `locationcode` of the referenced inventorylocations, instead of the id. Send this or `salesinventorylocationid`, not both unless they agree.
unincorporated	integer	1 when the address is in an unincorporated area, so no city sales tax applies.
recordtype	boolean	True when the row is a bill-to address record. NolaPro stores bill-to and ship-to addresses in the same table.
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/shiptos/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "defaultshipvia": 1,
    "address1": "Example address1",
    "address2": "Example address2",
    "mailstop": "Example mailstop",
    "city": "Example city",
    "state": "Example state"
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/shiptos/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'defaultshipvia' => 1,
    'address1' => 'Example address1',
    'address2' => 'Example address2',
    'mailstop' => 'Example mailstop',
    'city' => 'Example city',
    'state' => 'Example state',
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/shiptos/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "defaultshipvia": 1,
        "address1": "Example address1",
        "address2": "Example address2",
        "mailstop": "Example mailstop",
        "city": "Example city",
        "state": "Example state",
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/shiptos/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      defaultshipvia: 1,
      address1: "Example address1",
      address2: "Example address2",
      mailstop: "Example mailstop",
      city: "Example city",
      state: "Example state",
    }),
  }
);
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 {
    defaultshipvia = 1,
    address1 = "Example address1",
    address2 = "Example address2",
    mailstop = "Example mailstop",
    city = "Example city",
    state = "Example state",
};

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

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

Response 200

{
    "defaultshipvia": 1,
    "address1": "Example address1",
    "address2": "Example address2",
    "mailstop": "Example mailstop",
    "city": "Example city",
    "state": "Example state"
}

DELETE/shiptos/{id} 200404

Cancel.

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

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

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

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

Response 200

{
    "defaultshipvia": 1,
    "address1": "Example address1",
    "address2": "Example address2",
    "mailstop": "Example mailstop",
    "city": "Example city",
    "state": "Example state"
}

Contacts →

Named contacts on a customer or ship-to.

B2B users →

Customer-portal logins. Credentials are never returned.