Skip to main content

NCR Counterpoint Package Shipments to ShipStation Implementation Guide

How NCR Counterpoint subscriptions send each release ticket to ShipStation as one shipment per package: package fields, mappings, switch-on, errors and checks.

Overview

Package shipments send one Counterpoint release ticket to ShipStation as one shipment per package. Each package can go to a different recipient: a customer who sends gifts to many people places one order, and each line of the order carries the package it belongs to and that package's recipient and address.

  • Where the packages come from: Counterpoint stores each line's package and recipient in user-defined fields on the order line (the line extension table). The release ticket carries them on the lines it ships.

  • What reaches ShipStation: one ShipStation shipment for each package on the release, with that package's lines, recipient, address, phone, email, gift note and ship-by date. Two packages going to the same address are still two shipments.

  • Release tickets only: shipments are created from release tickets, not from open orders. A release does not change once it is created, so each release always produces the same shipments. An open order can still be edited after its shipments exist, which would leave ShipStation with shipments that no longer match the order.

  • Who needs this guide: NCR Counterpoint and ShipStation subscriptions installed before package shipments were released. A subscription keeps the mappings it was installed with, so each change below must be made in your own subscriptions. Subscribers or their MiSP make these changes; the Counterpoint step in Step 1 is for whoever administers the Counterpoint server.

At a glance

  • Every shipped line needs a package. A release line without a package, on a release with no ship-to address, stops the whole release with SHST-VALD-1004 instead of being left off the shipments.

  • Send only the shipped lines. A partial release also lists the order's lines that are not shipping yet. Filter the release lines to the shipped ones (Step 3), or ShipStation receives the unshipped items as well.

  • The ShipStation mappings are on the line. A package has no address record of its own, so its ship-to, warehouse, store and other shipment details are mapped on Add/Update ShipStation Order Line Item FROM iPaaS.com (Step 4).

  • The same field names on both sides. The custom field names you map in Counterpoint (Step 3) are the names the ShipStation mappings read (Step 4). This guide uses the names below; if you choose others, use them in both places.

Before you start

  • ShipStation integration version: use the release that adds package shipments. You can tell it is installed when Add/Update ShipStation Order Line Item FROM iPaaS.com offers PackageGroupId and the Shipment_ShipTo_ fields as mapping destinations. Your MiSP or iPaaS.com Support can move the subscription to it.

  • One iPaaS.com company: the NCR Counterpoint and ShipStation subscriptions must belong to the same iPaaS.com company, so the releases Counterpoint sends are the ones ShipStation receives.

  • Enable Multi Address Shipment: this ShipStation setting must be on. With it off, a release that has no ship-to address is not sent to ShipStation at all, and no error is reported; a release that carries a ship-to address goes as a single shipment to that address (see ShipStation Connections and Settings).

  • Items in iPaaS.com: every item a release ships must already exist in iPaaS.com as a product, or the release is rejected with NFND-1003 (see Step 3, Sku).

  • A ShipStation warehouse to ship from: the release has no address record to carry a ship-from location, so the package shipments use one warehouse that you name in Step 4.

  • Record your current mappings for every collection this guide changes, so you can put them back if needed.

  • Try it in a test environment first. Send one release with several packages through the whole flow and check the results (Step 6) before changing production.

Step 1: Prepare the Counterpoint data

The package fields on the order line

Each order line needs these user-defined fields on the line extension table. The names below are the ones this guide uses; yours may differ.

Counterpoint field

Holds

Example

USR_PKG_ID

The package the line belongs to. Lines with the same value ship together.

2

USR_NAM

The recipient's name.

Jane Smith

USR_FST_NAM, USR_LST_NAM

The recipient's first and last name, if you keep them separately.

Jane, Smith

USR_ADRS_1, USR_ADRS_2

The street address and second address line.

123 Main Street, Apt 4

USR_ADRS_3

A third address line, or a message.

Happy birthday!

USR_CITY, USR_STATE, USR_ZIP_COD

The city, state and ZIP code.

Atlanta, GA, 30303

USR_CNTRY

The country, as a two-letter code. When it is empty, the shipment is sent to the United States.

US, CA

USR_PHONE_1, USR_EMAIL_ADRS_1

The recipient's phone number and email address.

555-555-0100, jane@example.com

USR_GREETING

The gift message for the package.

Happy holidays!

USR_SHIP_DAT

The date the package must ship by.

12/15/2026

USR_SALUTATION, USR_SHIP_ADRS_ID

The recipient's salutation, and the customer's saved ship-to address number.

Ms., 3

  • Every line of a package should carry the same values. When they differ, the ShipStation shipment takes each value from the first line of the package that has it.

  • Two packages, one address: give them different package values. Package shipments are grouped by package alone, never by address.

  • USR_SHIP_ADRS_ID is not the package. It is the customer's saved ship-to address, which several packages can share.

Keep the fields on posted tickets

Add the same fields, with the same names, to the posted ticket line extension table as well. A release that is posted before its transfer runs, for example after a connection outage, is read from ticket history, so its package fields must be there too. Subscribers should validate in a staging environment that a posted release still carries its package fields before relying on it in production.

Regenerate the data dictionary cache

After adding the fields, regenerate the CPHive data dictionary cache, as described in NCR Counterpoint Installation Instructions. Until then the integration does not see the new fields, and the mappings in Step 3 return nothing.

Step 2: Create the custom fields in iPaaS.com

Create these custom fields in iPaaS.com, as text fields, on your company's iPaaS.com system (the records the releases are written to):

  • On the Transaction Line table: PKG_ID, NAM, FST_NAM, LST_NAM, ADRS_1, ADRS_2, ADRS_3, City, STATE, ZIP_COD, CNTRY, PHONE_1, EMAIL_ADRS_1, GREETING, SHIP_DAT, SALUTATION, SHIP_ADRS_ID and ITEM.

  • On the Transaction table: ShipStation Store.

Names are matched exactly, including letter case: City is mixed case where the others are upper case.

Step 3: Change the Counterpoint release collections

Add/Update NCR Counterpoint Order Release Line TO iPaaS.com

  • Collection type: Transaction Line

  • Direction: TO iPaaS.com

  • Parent collection: Add/Update NCR Counterpoint Order Release TO iPaaS.com

  • Mapping filter: LIN_TYP == "S" (new)

The filter. A partial release lists the lines it ships (LIN_TYP S) and the order's lines still to ship (LIN_TYP U). Without the filter, the unshipped lines reach iPaaS.com and ShipStation ships them too. With it, only the shipped lines transfer. A release that ships the whole order has only S lines, so the filter changes nothing for it.

The custom field mappings (new), each a Field mapping from the Counterpoint field of Step 1:

  • PKG_ID: Field, from USR_PKG_ID

  • NAM: Field, from USR_NAM

  • FST_NAM: Field, from USR_FST_NAM

  • LST_NAM: Field, from USR_LST_NAM

  • ADRS_1: Field, from USR_ADRS_1

  • ADRS_2: Field, from USR_ADRS_2

  • ADRS_3: Field, from USR_ADRS_3

  • City: Field, from USR_CITY

  • STATE: Field, from USR_STATE

  • ZIP_COD: Field, from USR_ZIP_COD

  • CNTRY: Field, from USR_CNTRY

  • PHONE_1: Field, from USR_PHONE_1

  • EMAIL_ADRS_1: Field, from USR_EMAIL_ADRS_1

  • GREETING: Field, from USR_GREETING

  • SHIP_DAT: Field, from USR_SHIP_DAT

  • SALUTATION: Field, from USR_SALUTATION

  • SHIP_ADRS_ID: Field, from USR_SHIP_ADRS_ID

  • ITEM: Dynamic Formula, the item number with its grid dimensions, the same formula the template uses for Sku: (ITEM_NO + (DIM_1_UPR == "*" ? "" : "|" + DIM_1_UPR) + (DIM_2_UPR == "*" ? "" : "|" + DIM_2_UPR) + (DIM_3_UPR == "*" ? "" : "|" + DIM_3_UPR)).TrimEnd()

Sku. Keep the template's Sku mapping, the item number formula above, so each line is linked to its iPaaS.com product and every item ships under its real number. If you replace it with a fixed value (for example LINEITEM) to avoid syncing products, a product with that SKU must exist in iPaaS.com, and the ShipStation SKU then comes from the ITEM custom field (Step 4).

Add/Update NCR Counterpoint Order Release TO iPaaS.com

  • ShipStation Store (new): Static, the name of the ShipStation store the shipments are filed under, exactly as it appears in ShipStation, for example Manual Orders. Leave it out to send the shipments without a store.

  • EmailAddress: keep the template's Field mapping from BILL_EMAIL_ADRS_1. A release with no billing email is rejected with VALD-1002; give such releases a billing email in Counterpoint, or map a fixed address.

Step 4: Change the ShipStation subscription

Add/Update ShipStation Order Line Item FROM iPaaS.com

  • Collection type: Transaction Line

  • Direction: FROM iPaaS.com

  • Parent collection: Add/Update ShipStation Order FROM iPaaS.com

Keep the template's existing mappings (quantity, ShipToTransactionAddressId, Shipment_Item_ExternalOrderItemId, the item weight, unit price and tax), and add or change these. Each is a Dynamic Formula. Each value is read from the line's custom field of Step 2; a blank value sends nothing.

PackageGroupId (new), the package. Lines with the same value ship together as one shipment. A line without a package ships to the transaction's address; when there is no address, the transfer stops with SHST-VALD-1004 instead of leaving the line off every shipment.

// Package: the line custom field "PKG_ID". Lines with the same value ship together as one shipment.
// A line without one ships to the transaction's address; when there is no address, the transfer stops with SHST-VALD-1004,
// naming the line and its item, instead of leaving the line off every shipment.
var value = "";
if (CustomFields != null) { value = GetCustomFieldValue(CustomFields, "PKG_ID"); }
if (!string.IsNullOrWhiteSpace(value)) { return value.Trim(); }
if (Parent == null || Parent.Addresses == null || Parent.Addresses.Count == 0)
{
    var item = "";
    if (CustomFields != null) { item = GetCustomFieldValue(CustomFields, "ITEM"); }
    if (string.IsNullOrWhiteSpace(item)) { item = Sku; }
    throw new Exception("SHST-VALD-1004 - Line " + SequenceNumber + " (" + item + ") has no package and the transaction has no shipping address, so ShipStation has nowhere to ship it. Give the line a package id in Counterpoint, or add a ship-to address to the release, then re-run the transfer.");
}
return "";

The ship-to fields (new), each reading one custom field with this formula, where NAM is replaced by the custom field named below:

var value = "";
if (CustomFields != null) { value = GetCustomFieldValue(CustomFields, "NAM"); }
if (string.IsNullOrWhiteSpace(value)) { return ""; }
return value.Trim();
  • Shipment_ShipTo_Name: NAM

  • Shipment_ShipTo_AddressLine1: ADRS_1

  • Shipment_ShipTo_AddressLine2: ADRS_2

  • Shipment_ShipTo_CityLocality: City

  • Shipment_ShipTo_StateProvince: STATE

  • Shipment_ShipTo_PostalCode: ZIP_COD

  • Shipment_ShipTo_Phone: PHONE_1

  • Shipment_ShipTo_AddressLine3: ADRS_3, when it holds address data. Leave it unmapped when ADRS_3 holds a message.

  • Shipment_ShipTo_Email: EMAIL_ADRS_1. A package with no email of its own is sent without one; the release's email is the buyer's, not the recipient's. To use the release's email when the package has none, use the formula below instead.

  • Shipment_NotesForGift: GREETING, the package's gift message. If your messages are kept in ADRS_3 instead, read ADRS_3 here, and leave Shipment_ShipTo_AddressLine3 unmapped so the message does not print as part of the address.

The email formula with the release's email as a fallback:

// Recipient email: the line custom field "EMAIL_ADRS_1"; the release's email when the package has none.
var value = "";
if (CustomFields != null) { value = GetCustomFieldValue(CustomFields, "EMAIL_ADRS_1"); }
if (!string.IsNullOrWhiteSpace(value)) { return value.Trim(); }
if (Parent != null && !string.IsNullOrWhiteSpace(Parent.EmailAddress)) { return Parent.EmailAddress; }
return "";

Shipment_ShipTo_CountryCode (new), the country, the United States when it is empty:

// Ship-to country: the line custom field "CNTRY"; US when it is blank.
var value = "";
if (CustomFields != null) { value = GetCustomFieldValue(CustomFields, "CNTRY"); }
if (string.IsNullOrWhiteSpace(value)) { return "US"; }
return value.Trim();

Shipment_ShipByDate (new), the ship-by date. Counterpoint sends it as month/day/year text, and ShipStation takes an ISO date:

// Ship-by date: the line custom field "SHIP_DAT" (MM/dd/yyyy text), sent as an ISO date; blank sends none.
var value = "";
if (CustomFields != null) { value = GetCustomFieldValue(CustomFields, "SHIP_DAT"); }
if (string.IsNullOrWhiteSpace(value)) { return ""; }
DateTime date;
if (!DateTime.TryParse(value.Trim(), System.Globalization.CultureInfo.GetCultureInfo("en-US"), System.Globalization.DateTimeStyles.None, out date)) { return ""; }
return date.ToString("yyyy-MM-dd") + "T00:00:00Z";

Shipment_WarehouseId (new), the warehouse the packages ship from:

// Ship-from warehouse: a fixed ShipStation warehouse name (a release has no address to carry one). Change "Main Warehouse" to yours.
var warehouseId = await GetWarehouseIdByNameAsync("Main Warehouse");
if (string.IsNullOrWhiteSpace(warehouseId)) { return ""; }
return warehouseId;

Placeholder value — replace during implementation: Main Warehouse is an example. Use the name of your ShipStation warehouse (Ship From Location), as it appears in ShipStation; letter case is ignored. When the name matches no warehouse, each package is reported in SHST-EXTN-1004 rather than sent from a guessed location, unless you map the Shipment_ShipFrom_ fields on the line instead.

Shipment_StoreId (new), the store named on the release in ShipStation Store:

// Store: the name in the release custom field "ShipStation Store" (letter case ignored); blank or unmatched sends no store.
var name = "";
if (Parent != null && Parent.CustomFields != null) { name = GetCustomFieldValue(Parent.CustomFields, "ShipStation Store"); }
if (string.IsNullOrWhiteSpace(name)) { return ""; }
var storeId = await GetStoreIdByNameAsync(name.Trim());
if (string.IsNullOrWhiteSpace(storeId)) { return ""; }
return storeId;

sku and name (changed from Field mappings of Sku), the item number from ITEM, falling back to the line's own SKU:

// SKU: the real item number in the line custom field "ITEM"; the line's own SKU when it is blank.
var item = "";
if (CustomFields != null) { item = GetCustomFieldValue(CustomFields, "ITEM"); }
if (string.IsNullOrWhiteSpace(item)) { return Sku; }
return item.Trim();

These two changes are needed only if Step 3 replaced the Counterpoint Sku with a fixed value; with the template's Sku they send the same item number either way.

The other ShipStation collections

Add/Update ShipStation Order FROM iPaaS.com and Add/Update ShipStation Shipment Address FROM iPaaS.com need no change. The Shipment Address mappings apply to releases that carry a ship-to address; a package takes its shipment details from its lines instead.

Step 5: Switch it on

  1. On the ShipStation subscription, check that Enable Multi Address Shipment is on.

  2. Release a test order in Counterpoint with at least two packages, including two packages to the same address and one package with several lines.

  3. The release reaches iPaaS.com through the release ticket change notification, and goes on to ShipStation when the ShipStation subscription's transfer of transactions is on. To send it by hand, run Manual Sync on Add/Update NCR Counterpoint Order Release TO iPaaS.com with the release's id in the form {"DOC_ID":"201382533104"}, using your release's document id (a bare document id finds the release only while it is unposted), then on Add/Update ShipStation Order FROM iPaaS.com with the iPaaS.com transaction id.

Step 6: Check the result

  • In iPaaS.com: the transaction for the release has only its shipped lines, each with the package custom fields.

  • In ShipStation:

    • One shipment for each package, numbered with the release number and the package, for example 10025-01-2 for package 2 of release 10025-01.

    • Each shipment has only its package's items, under their real item numbers.

    • The ship-to, phone, email, gift note and ship-by date are the package's own. The country is the United States when the line had none.

    • The warehouse and store are the ones you set in Steps 3 and 4.

  • A repeated transfer of the same release updates the same shipments; it does not create new ones.

Error reference

Errors appear in Dashboard / Integration Monitoring / Error Logs. The SHST- codes are also described in the ShipStation Error Messages article.

  • SHST-VALD-1004 ("Line 3 (0013S) has no package and the transaction has no shipping address..."): the release line named, with its item, has no package, and the release has no ship-to address, so it cannot be shipped. No package of the release is sent until it is fixed. Give the line a package in Counterpoint, or check that the PKG_ID mapping in Step 3 reads the right field, then re-run the transfer.

  • VALD-1002 ("Required field (Customer Id, Email address, or Company Id) is null or empty"): the release has no billing email. See Step 3, EmailAddress.

  • NFND-1003 ("Product Id: ... does not exist"): an item on the release is not in iPaaS.com. Transfer the item to iPaaS.com, or see Step 3, Sku.

  • SHST-EXTN-1004 naming a package with "No ShipStation warehouse or ship-from address is set for this package": the name in Shipment_WarehouseId matches no ShipStation warehouse. The release's other packages are still sent. Correct the name (Step 4), then re-run the transfer; the packages already sent are updated, not created again.

Troubleshooting

  • The release never reached ShipStation, and no error was reported: Enable Multi Address Shipment is off. Turn it on, then re-run the transfer.

  • The release stopped with SHST-VALD-1004 on every line: the release lines have no PKG_ID values. Check the release's lines in iPaaS.com for the custom fields; if they are missing, regenerate the data dictionary cache (Step 1) and check the Step 3 mappings.

  • ShipStation received items that were not shipping: the release line filter is missing (Step 3).

  • Every item shows the same SKU in ShipStation: the Counterpoint Sku is a fixed value and the ShipStation sku mapping still reads it. Make the Step 4 sku and name changes.

  • A posted release arrived without its package fields: the fields are missing from the posted ticket line extension table, or were added after the ticket was posted (Step 1).

How it behaves afterwards

At the time this documentation was written:

  • Each package becomes its own shipment, grouped by package across the whole release, whatever order its lines are in.

  • Each shipment value is taken from the first line of the package that has it, so a value set on one line, such as a gift note, still reaches the package's shipment.

  • A release transferred again, including the automatic retry after an error, updates the package's existing shipment rather than creating another.

  • Each partial release of an order is its own set of shipments, numbered with that release's number.

  • A release that has already been posted is read from ticket history, so a release whose transfer was delayed past posting is still sent. This applies to the release ticket notification, and to a Manual Sync given the {"DOC_ID":...} form.

  • A shipment's store is set when it is created. Correcting ShipStation Store and re-running the transfer does not move an existing shipment to another store.

  • Open orders do not create shipments; only release tickets do.

Related Documents

Did this answer your question?