For Partner Use
Do NOT include confidential information (such as logins, passwords, API keys, private keys, secret tokens) on Confluence pages.

Accounts

The Accounts page lists each company account managed by ShipHawk.

image-20240916-185820.png

To find a particular company account, use the Filters options on the right-hand side panel. For instance, In CUSTOMER NAME CONTAINS, enter the name of the company account of interest and then click the Filter button located at the bottom of the panel.

To view and edit the company account details, click on the (hyperlinked) company name (in the first, Company column).

A page that summarizes the company’s details is displayed. (To edit this page, click Edit Companies, and you’ll get a short page where you can specify the Id, Company name, Tax, and Logo.)

To view the settings in detail, in the Account field, click the company’s name.

On Active Admin, a company’s account settings page include the following settings, organized into panels.

This page is view only, and displays the settings somewhat differently than the page for editing the settings. To edit account settings, on the top of the page, click Edit Account (see Edit Account for details on editing these settings).

This page’s sections include:

Example

 

Details

Setting

Description

Setting

Description

IS DISABLED

Indicates if account is disabled in the system.

COMPANY

The name and ID of the company. This ID number matches the URL on your browser (example: shiphawk.com/aadmin/accounts/4845). Sometimes you'll see tickets about what account to log into refer to the number instead of the company’s name.

ID

The ID number of the company.

UUID

A universally unique identifier for the account. See Universally unique identifier .

SFDC

The Salesforce (SFDC) identifier for the account. The SFDC ID is a unique, 18-character identifier of any records located in Salesforce organizations.

PARENT ACCOUNT

Indicates if this account has a parent account / company. Field will be empty by default.

SUBDOMAIN

 

DEMO ACCOUNT?

Indicates if the account is used as a demo account and not for production purposes. Demo accounts show sample data on the dashboard instead of using real data. Use only as required for a production account that is being used for demo purposes

NUMBER OF DEMO SHIPMENTS PER MONTH TO SHOW IN DASHBOARD

Displays the number of sample shipments per month to show on the dashboard page for demo purposes.

ALLOW ALTERNATE RETURN ADDRESS

Specifies if the Allow ultimate consignee address feature set is enabled for this account. Field should be defaulted on.

ALLOW ULTIMATE CONSIGNEE ADDRESS

Specifies if the Allow ultimate consignee address feature set is enabled for this account. Field is set to no by default. This feature allows customers to ship freight to a domestic freight forwarder that has an ultimate consignee in another country.

PRINT 2 LABELS PER PAGE

[DO NOT USE - TO BE DEPRECATED]

FEATURE SET

 

CHILD ACCOUNTS FEATURE SET

Displays which feature sets belong to this account. Field is empty by default.

STRIPE CUSTOMER

The Stripe customer account ID. Field is empty by default. [DO NOT USE - TO BE DEPRECATED]

PAYMENT STATUS

Indicates whether the account is actively making payments to ShipHawk.

OWNER

The ID of the account owner or user.

ON CREDIT

Specifies if the account is allowed to ship without entering billing information.

TIME ZONE

Displays the time zone for this account. Typically, this is set to the time zone for the main warehouse.

INTERNATIONAL ENABLED

Indicates if international shipping is shown on the user interface (but does not affect API usage). [TO BE DEPRECATED]

EXTERNAL SHIPMENTS ENABLED

Indicates if customers can book shipments outside of ShipHawk. Field is set to on by default. [DEFAULT IS ON- TO BE DEPRECATED]

AUTO DISPATCH ENABLED

Indicates if the Auto dispatch enabled option is turned on.

SYNCHRONOUS DISPATCH

Indicates if the Synchronous dispatch option is turned on. Synchronous dispatch sets all dispatches to occur synchronously instead of being completed as a Sidekiq job. [NEED FOR THIS SETTING UNCLEAR?]

MANUALLY GENERATE PROPOSED SHIPMENT LABELS

Indicates if the Manually Generate Proposed Shipment Labels option is enabled. [COX AUTOMOTIVE FEATURE ONLY]

RECALCULATE PACKAGE WEIGHT WHEN ITEMS ARE CHANGED

Indicates if the Recalculate Package Weight when Items are changed option is enabled. When enabled, the system automatically updates package weight as you add items from the user interface (use of this setting assumes the merchant has the right data in the system for the weights of all items).

INCLUDE PACKING SLIPS INTO LABELS

[WILL BE DEPRECATED - once AutoPrint enabled for all customers and autoprint addresses batch processing]

INCLUDE UCC LABELS INTO LABELS

[WILL BE DEPRECATED - once AutoPrint enabled for all customers and autoprint addresses batch processing]

PACKAGE LABELS FORMAT

 

RATE TIMEOUT (SEC)

Indicates if there is a cutoff time for receiving rate requests from carriers. Field is empty by defualt.

GL CODE

[TO BE DEPRECATED]

FREIGHT CLASS OVERRIDE

Indicates if this account overrides freight classes. When enabled, this setting will override every packages freight class on the BOL to the value that is set in this field. It will not override anywhere else. [CHECK - FLAG FOR DEPRECATION]

NMFC OVERRIDE

When enabled, this setting will override every packages NMFC on the BOL to the value that is set in this field. It will not override anywhere else. [CHECK - FLAG FOR DEPRECATION]

PRICING LEVEL

 

REPORT

 

SETTINGS

Consolidated list of all settings this account has enabled.

TRACKING PAGE SETTINGS

Consolidated list of all the tracking page settings this account has enabled.

BRAND SETTINGS

 

TEST ACCOUNT

Indicates whether this is a test account.

PERSIST EXTERNAL FULFILLMENT CARRIER

NetSuite order fulfillment strategy setting. [SHOULD BE DEPRECATED]

NS CLOSED ORDERS SYNC

Indicates if the Ns closed orders sync option is enabled. The closed orders sync option synchronizes closed orders in NetSuite. [SHOULD BE DEPRECATED?]

SHOW TEST FEATURES

[SHOULD BE DEPRECATED?]

ENABLE UPS READY

[TO BE DEPRECATED]

ENABLE IF WRITE BACKS

Indicates if write back reporting is enabled for customers on NS.

DEPRECATE ORDER ORIGIN ADDRESS

[TO BE DEPRECATED - after it can be safely enabled for everybody]

CONVERT PDF FROM ZPL TO 4 BY 6

Special setting to help with rendering ZPL data. Field is set to no by default.

OPTIMIZE PERFORMANCE FOR LARGE ORDERS

Indicates if the Optimize performance for large orders performance performance feature is enabled. Field is set to no by default.

ALLOW ASYNC BOOKING

Indicates if asynchronous booking is enabled for this account.

ALLOW ASYNC SAVING

Indicates if asynchronous saving is enabled for this account.

ENABLE ORDER PREV NEXT LINKS

Indicates if the Orders page in user interface has Prev/Next links. Field is set to no by default.

SEND DELIVERY CONFIRMATION EMAILS

Indicates if account automatically sends delivery confirmation emails to customers upon booking a shipment.

 

 

Performance features

Performance features change the behavior in the ShipHawk UI to allow ShipHawk to handle extremely large orders with large quantities of line items.

Do not make things any faster, make it so that time does not prevent a proposed shipment from being generated or shipped.

Setting

Description

Setting

Description

OPTIMIZE PERFORMANCE FOR LARGE ORDERS

Indicates if the Optimize performance for large orders performance performance feature is enabled. Field is set to no by default.

ALLOW ASYNC BOOKING

Indicates if asynchronous booking is enabled for this account.

ALLOW ASYNC SAVING

Indicates if asynchronous saving is enabled for this account.

Material Containers

Lists all packing materials used by this account.

Click Export all ….

Column

Description

Column

Description

NAME

Name of the packing material as it appears on the user interface. Most customers set the package name to be the package dimensions (i.e. 10 x 10 x 10).

IS ACTIVE

Indicates whether the packing material is actively being used for shipments.

PACKING TYPE

Describes the packing material type. Packing materials can be of box, envelope, or pallet type.

DIMENSIONS

The packing material’s length, width, and height.

Users

Column

Description

Column

Description

EMAIL

Email customer uses to log in to their ShipHawk account.

FIRST NAME

Name that will display on the user’s ShipHawk user interface.

LAST NAME

Name that will display on the user’s ShipHawk user interface.

Click New User

Custom Tariffs

Column

Description

Column

Description

NAME

Name of the custom tariff enabled for this account.

CARRIER

Carrier the custom tariff applies to.

Click Create Tariff

Carriers

Setting

Description

Setting

Description

NAME

Name of the carrier enabled for this account.

Allow creds for carrier types

Allows customers to enter their own account credentials for carriers.

Setting

Description

Setting

Description

small_parcel

Indicates if customer can enter their own account credentials for small parcel carrier types.

home_delivery

Indicates if customer can enter their own account credentials for home delivery carrier types.

ltl

Indicates if customer can enter their own account credentials for LTL carrier types.

Address verification

Setting

Description

Setting

Description

ADDRESS VALIDATION STRATEGY

Indicates whether address validation is enabled for this account. Address validation is a setting that validates a customer’s destination address before booking a shipment. Setting is turned off by default.

ENABLE INTERNATIONAL ADDRESS VALIDATION

Indicates whether address validation for international addresses is enabled for this account. Address validation strategy must be ‘manual’ or higher (this can’t be enabled if address validation is disabled).

GET LOCATION TYPE WITH SMARTY STREETS

A setting that, when enabled, also validates the address type of a destination address- such as residential or commercial.

SMARTY STREETS IGNORE PO BOX TYPE

When enabled, this setting will ignore the po box type of an address during address validation. Setting is turned off by default.

AUTO DETECT PO BOX ADDRESSES

When enabled, this setting will auto detect the po box type of an address during address validation. Setting is turned off by default.

Smart packing (packing algo)

Setting

Description

Setting

Description

PACKING ENABLED

Indicates if basic packing is enabled for this account. [SHOULD BE DEPRECATED]

SMART PACKING

Indicates if Smart Packing is enabled for this account. ShipHawk displays the suggested box or pallet composition on the Proposed Shipment screen for each shipment order. This setting is required to begin using the Smart Packing™ feature.

ALLOW BOX TELESCOPING

Indicates whether Smart Packing will allow box telescoping when packing. When this setting is enabled, Smart Packing will attempt to pack any oversized items with multiples of the same packing material to create a new custom packing material to pack the item. This process is called telescoping. The new telescoped box is still subject to the parcel weight limit of 150 lbs and any relevant dimension restrictions.

ALLOW BOX CUT DOWN

Indicates whether Smart Packing will allow the creation of cut down boxes. A cut down box is made by cutting along the seams of a box and folding the resulting flaps down to make a smaller carton. This suggestion is given when the smallest available box is still too large along one dimension. This setting is optional and must not be enabled for businesses that are unfamiliar with or not set up for cutting down boxes.

AVOID CREATION OF CUSTOM BOX

Avoid creation of custom boxes by packing algorithm [CHANGE to opposite: default should be checked by default]

INCLUDE MATERIAL WRAPPERS

Allow packing algorithm to add material wrappers (Bubble Wrap, Shrink Wrap). (Should be OFF by default.)

PALLET EDGE OFFSET

How far (in inches) packages should sit from the edge of the pallet to prevent overhang during packing. Minimum distance from item to edge of pallet; can be positive or negative. Default: 2

This is the amount of space we will leave around the edge of a pallet. Default is set to "2" which means that we will leave 2" inches of space around the entire pallet. This is the amount of space we will leave around the edge of a pallet. Default is set to "2" which means that we will leave 2" inches of space around the entire pallet. Example: 48x48x4 pallet with a 2" offset leaves 44x44x4 of packing space.

MAX REGULAR BOX ASPECT RATIO

Default: 10.0

The maximum length-to-width ratio for a regular box.

MAX SPIKE BOX ASPECT RATIO

A spike box dictates what packing materials qualify to hold spike items.

The maximum spike ratio that will be SmartPacked™.

NOTE A Spike is an item whose length-to-width ratio resembles a javelin or “spike.” E.g. long tubes.

Default: 40.0

(A spike box is a box whose length-to-width ratio resembles a javelin or “spike.” Example: long tubes.)

SPIKE ITEM ASPECT RATIO

A spike item dictates what items qualify to be treated like spikes.

Spike item aspect ratio allows you to change the value used for the length divided by width ratio. Default is greater than or equal to 10.

Default: 10.0 Item characteristic necessary to be met in order to qualify an item as a spike. If item qualifies as a spike, it will be packed in a spike box by the packing algorithm.

SPIKE ITEM MIN LENGTH

Spike item aspect ratio allows you to change the minimum length to classify an item as a spike. Default is 24 (greater than 24 inches).

Default: 24.0 (Item characteristic necessary to be met in order to qualify an item as a spike, to be packed in a spike box.)

SMART PACKING SIMPLIFIED AFTER

Number of items after which Smart packing will switch to a faster mode (when items rotated as LWH, and LWH only)

Example: 500

PALLETIZE WHEN WEIGHT EXCEEDS

The minimum weight of a shipment that can be palletized: palletize when weight (lbs) of items to be packaged exceeds the specified value.

Default: 70

PALLETIZE WHEN DIMENSIONAL WEIGHT EXCEEDS

Indicates if there is a minimum dimensional weight of a shipment that can be palletized for this account: palletize when dimensional weight (lbs) of items to be packaged exceeds the specified value.

NOTE Dimensional weight is a pricing method for freight that multiplies height by weight by width.

Default: 150

PALLETIZE WHEN PACKAGE COUNT EXCEEDS

Indicates whether the app will force using a palletized version and skip package version when the algorithm produces more than the specified number of boxes.

DISABLE PACKING ALG QTY

Indicates if there is a threshold that set for your account to disable the packing algorithm when exceeding a certain quantity of items in the request.  

Customers use this to simplify workflows as some product catalogs at certain quantities are simpler to fulfill when the system falls back to non-smart packing behavior (e.g. weight only rated proposed shipments).

--

Sets the maximum number of items that can be fed to the packing algorithm. If exceeded, then all items are put into single package with accurate weight. (If undefined, uses the global default.)

Fraud controls

[FRAUD CONTROLS DEPRECATED]

Setting

Description

Setting

Description

DAILY SHIPMENTS LIMIT

 

LOCK BILLING DETAILS

 

USE BRAINTREE KOUNT PROTECTION

[DO NOT USE]

BILLING INFO FAILURES COUNT

[DO NOT USE]

Enabled/Disabled UI elements for Feature sets

Allow Pages

If setting is not enabled, customer cannot see this particular UI element (page/setting) in the ShipHawk UI.

 

Setting

Description

Setting

Description

ENABLED SMART PACKING PAGE

Indicates if the smart packing page is enabled for this account

ENABLED COMMODITIES PAGE

Indicates if the commodities page is enabled for this account.

ENABLED SHIPMENTS PAGE

Indicates if the shipments page is enabled for this account.

ENABLED QUOTES PAGE

Indicates if the quotes page is enabled for this account.

ENABLED ORDER SETTINGS PAGE

Indicates if the order settings page is enabled for this account.

ENABLED PICK TICKETS PAGE

Indicates if the pick tickets page is enabled for this account.

ENABLED PACKING SLIPS PAGE

Indicates if the packing slips page is enabled for this account.

ENABLED ADDRESS BOOK PAGE

Indicates if the address books page is enabled for this account.

ENABLED RULES PAGE

Indicates if the rules page is enabled for this account.

READY TO SHIP MODE ENABLED

Indicates if the ready-to-ship mode is enabled for this account.

WEBHOOKS AVAILABLE

Indicates if webhooks are available for this account.

DEVELOPER API AVAILABLE

Indicates if the API is available for this account.

CUSTOMER TRACKING AVAILABLE

Indicates if customer tracking is available for this account.

SHOW TRANSACTION REPORTS

Indicates if transaction reports are displayed for this account

ENABLED USER PROFILE PAGE

Indicates if the user profile page is enabled for this account.

ALLOW MANUAL ORDERS

Indicates if manual orders are allowed for this account.

ALLOW ORDER IMPORT CSV

Indicates if order imports via csv are allowed for this account.

ALLOW MANUAL SHIPMENTS

Indicates if manual shipments are allowed for this account.

ALLOW SHIPMENTS IMPORT CSV

Indicates if shipments imports via csv are allowed for this account.

Weekly Performance Report Settings

Settings dictate which performance settings are visible in the UI.

Setting

Description

Setting

Description

WEEKLY PERFORMANCE REPORT ENABLED

Indicates if the weekly performance report is enabled for this account.

WEEKLY PERFORMANCE EMAIL ENABLED

Indicates if a weekly performance email is sent out to this account.

ORDERS ENABLED

Indicates if the Orders report is enabled.

SHIPMENTS ENABLED

Indicates if the Shipments report is enabled.

RATE OPTIMIZATION SAVINGS ENABLED

Indicates if the rate optimization savings report is enabled.

ON TIME DELIVERIES ENABLED

Indicates if the on-time deliveries report is enabled.

ORDER/SHIPMENT PROCESSING AVERAGES ENABLED

Indicates if the Order/Shipment processing averages report is enabled.

MOST UTILIZED CARRIER SERVICE ENABLED

Indicates if the most utilized carrier service report is enabled.

SMART PACK COUNT ENABLED

Indicates if the smart pack count report is enabled.

DID YOU KNOW? ENABLED

Indicates if the ‘Did you know’ modal is enabled.

PRIMARY CARRIER

Displays the primary carrier for this account. Field is set to empty by default.

Allow Modals/UI blocks

If setting is not enabled, customer cannot see this particular UI element (modals/UI blocks) in the ShipHawk UI.

Setting

Description

Setting

Description

ALLOW TO ADD CARRIER CREDENTIALS

Indicates if the account is allowed to add to carrier credentials.

ALLOW TO CHANGE SHIPMENT BILL TO

Indicates if this account is allowed to change the shipment ‘bill to’ information.

SHIPMENTS LABEL PRINTING SETTINGS AVAILABLE

Indicates if shipment label printing settings are available for this account.

ALLOW THIRD PARTY BILLING FOR LABELS

Indicates if third party billing for labels are allowed for this account.

ALLOW THIRD PARTY BILLING FOR DUTIES AND TAX

Indicates if third party billing for duties and tax are allowed for this account.

ALLOW BRAINTREE CARD CONNECTION

Indicates if Braintree card connection is allowed for this acccount.

SHOW SPLIT ORDER OPTION

Indicates if the split order option is displayed on the ShipHawk UI.

SHOW COMBINE ORDER OPTION

Indicates if the combine order option is displayed on the ShipHawk UI.

SHOW FILTERS ON CARRIERS PAGE

Indicates if the filters on the Carriers page are displayed on the ShipHawk UI.

SHOW SEQUENCE NUMBERS ON ITEMS VERIFICATION

Indicates if the sequence numbers on items verification are displayed on the ShipHawk UI.

ENABLE ORDER PREV NEXT LINKS

Shows if the Prev/Next links are enabled on the Order page.

SHOW AUTO PRINT SETTINGS

Shows if Auto Print settings are enabled for this account.

Allowed Integrations

If ‘integration’ is allowed (set to true / yes), it will be available on the Integrations screen (shiphawk.com/app/integrations)

Setting

Description

Setting

Description

3 PL CENTRAL

(Marketing Display Only)

API

Available

AS2

(Marketing Display Only)

ACUMATICA

Available

AMAZON SELLER CENTRAL

Available

AMAZON VENDOR CENTRAL

Available

BIG COMMERCE

Available

CHANNEL ADVISOR

(Marketing Display Only)

E BAY

(Marketing Display Only)

EDI

Available

EPICOR P21

(Marketing Display Only)

EVEREST

(Marketing Display Only)

IBM AS/400

(Marketing Display Only)

INFOR

(Coming Soon)

J.D. EDWARDS

(Marketing Display Only)

JET

(Marketing Display Only)

LEMONSTAND

(Marketing Display Only)

MAGENTO

(Marketing Display Only)

MAGENTO 2

Available

MICROSOFT DYNAMICS

(Marketing Display Only)

NETSUITE

Available

ODBC

(Marketing Display Only)

ORACLE

(Marketing Display Only)

QUICKBOOKS ONLINE

(Marketing Display Only)

QUICKBOOKS DESKTOP

(Marketing Display Only)

RAKUTEN

(Marketing Display Only)

SAP

(Marketing Display Only)

SAGE 100

(Marketing Display Only)

SAGE 500

(Marketing Display Only)

SAGE 50

(Marketing Display Only)

SAGE X3

(Marketing Display Only)

SALESFORCE

(Marketing Display Only)

SHOPIFY

Available

SHOPIFY PLUS

(Marketing Display Only)

SQUARESPACE

(Marketing Display Only)

STITCH LABS

(Marketing Display Only)

WOO COMMERCE

(Marketing Display Only)

WALMART

(Marketing Display Only)

Allowed Filters For Integrations

Setting

Description

Setting

Description

FILTER BY PLAN

Shows if the Filter By Plan UI element is enabled on the Integrations page.

FILTER BY TYPE

Shows if the Filter By Type UI element is enabled on the Integrations page.

FILTER BY STATUS

Shows if the Filter By Status UI element is enabled on the Integrations page.

 

Versions

Column

Description

Column

Description

MODIFIED AT

Date the version of ShipHawk was updated.

MODIFIED BY (USER ID)

User ID of the user who modified the account.

EVENT

Type of modification made to the account.

CHANGES

Displays which settings and options were updated for this account.

 

Related pages

For Partner Use
Do NOT include confidential information (such as logins, passwords, API keys, private keys, secret tokens) on Confluence pages.