Is disabled – Select checkbox to disable this account in the system.

Uuid

A universally unique identifier for the account. See https://en.wikipedia.org/wiki/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

A drop-down that lists all the accounts in the system. If this account has a parent account / company, select it from this drop-down. Default is blank.

User Owner

The ID of the account owner or user.

Company

The 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.

Time zone

The time zone for this account. (Select from the drop-down.) Typically, this is set to the time zone for the main warehouse.

External shipments enabled

Enables shipments to be made outside of ShipHawk. If selected, a user can book a shipment not using ShipHawk’s shipping function.

[DEFAULT IS ON: DO NOT TURN OFF - TO BE DEPRECATED]

International enabled

Enables international shipping to be shown on user interface (but does not affect API usage).

[DEFAULT IS ON: DO NOT TURN OFF - TO BE DEPRECATED]

• If selected, on the user interface, there is a field for Harmonized codes in product page and making a shipment.

• If not selected, no Harmonized codes field is displayed on the user interface.

Include Freight Cost on Commercial Invoice by default

[DEFAULT IS ON: DO NOT TURN OFF – TO BE DEPRECATED]

Use order shipping price as freight costs on commercial invoice

Uses Order shipping price for Commercial Freight cost field: only select this option if this account always ships complete for international orders.

[DEFAULT IS ON: TYPICALLY KEPT ON – TO BE DEPRECATED]

To be deprecated because this behavior is managed from the user interface in Commercial Invoice Settings - Confirm with Nibesh Moktan

Auto dispatch enabled

Enable Auto Dispatch option when shipped is clicked. Dispatch is always used with Freight and LTL. When you book a shipment, ShipHawk will automatically try to dispatch if possible. Turn off if there are regular carrier pickups.

Synchronous dispatch

Sets all dispatches to occur synchronously instead of being completed as a Sidekiq job.

[CHECK WITH Vasiliy Sablin ]

Allow 3rd Party/Recipient Dispatch

Allow’s Allows third party and collect/recipient LTL shipments to be dispatched after the shipment is booked.

Reset shipping costs and prices for third party/recipient shipments

Default response is False. When shipping with a third party, the shipping costs and prices will be reset to zero. For more see RM ticket #16149.

Reset shipping costs and prices for collect shipments

This will have the system reset shipping costs and prices to zero, if it is a collect shipment.

Test account

Specify whether this account is for testing purposes. Use only as required for a production account that is being used for testing purposes.

Demo account

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. For instance, if ON, we show mock data in the Weekly Shipping Performance Report in the Web Interface; if OFF, show the actual data for the account.

Demo Shipments per Month

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

Use parent tariff

[TO BE DEPRECATED]

Bol enabled

Select to enable Bill of Lading (BOL).[ALWAYS ON - TO BE DEPRECATED]

Team ww include declared value

Select to include Team Worldwide declared value. [TO BE DEPRECATED]

Printnode enabled

ON by default. (PrintNode is a connector software program that allows ShipHawk to seamlessly communicate print jobs (labels, packing slips, pick tickets, etc.) to your locally or server-installed printers.)

Generate proposed shipments when orders created

Used anytime a customer wants to generate a proposed shipment when an order is created. for syncing item fulfillments as orders.

Regenerate proposed shipments when orders updated

Delete and regenerate an order when it changes (for example, new line item needs to be added to the order).

Copy proposed shipments when split orders

When selected, ShipHawk will propose using the same proposed shipment data (for example, box size and so on) for proposed shipments that have been split from an original proposed shipment. (Typically for customers who do not have an ERP. )

Manually Generate Proposed Shipment Labels

[COX AUTOMOTIVE FEATURE ONLY]

Recalculate Package Weight when Items are changed

Specifies that 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).

Clear carrier if package was changed

If package type is changed, the selected carrier will be cleared. The user will need to re-rate to select a new carrier.

Allow export shipment line items

[COX AUTOMOTIVE FEATURE ONLY]

Ns closed orders sync

Enable to synchronize closed orders in NetSuite.

[CHECK WITH Nibesh Moktan ]

Send tracking email

Send tracking email automatically to the merchant’s end customer. The email includes a link to the merchant’s branded tracking page. Merchants (that is, our ShipHawk customers) pay for this feature.

Hazmat enabled

Select to enable hazardous materials service. (Account-specific setting.)

Allow shipper’s letter of instruction

Always ON. (A shipper’s letter of instruction, or SLI, is an optional shipping document that communicates specific instructions from the shipper to their freight forwarding agents or intermediate consignee, usually for air or ocean shipments.)

[TO BE DEPRECATED]

Combine orders merge proposed shipments

When orders are combined, also combine the proposed shipments for those orders. Always ON. (Default should be ON.)

Allow shipping price markup/markdown

For this account, after a shipment has been booked, the merchant can mark up or down manually in the user interface, or from a rule.

Max return tracking days

Specify the number of days after which ShipHawk will stop tracking the return shipment if no tracking events have been recorded yet. Example: 60.

When Allow return label tracking (above) is enabled, this setting tells ShipHawk how far back to look for a return shipment.

Auto void not sent shipments

[TO BE DEPRECATED]

This setting was used when ShipHawk was functioning as a freight broker, and is now no longer used.

Allow delete credentials

Allows merchant to delete their shipping API credentials. Always ON.

[TO BE DEPRECATED]

Disable add proposed shipments for shipping clerks

Allows or prevents a shipping clerk from creating a proposed shipment. OFF by default.

Disable delete proposed shipments for shipping clerks

Prevents clerk from deleting a proposed shipment. OFF by default.

Disable delete proposed shipments with source system

[Check with jonathan.day; no RM ticket for addition]

Disable book without dims and weight

If true, user will not be able to book unless weights and dims are entered. If false, user will be able to book despite weights and dims not being present.

Prefer api params for items

Should be on by default for every customer. Don’t touch this setting unless you know what you’re doing.

Prefer api params for items with optimize packaging level

[No RM ticket for addition, only for above setting, per William Stanton ]

Special case: when prefer_api_params_for_items enabled but you still want to use master-pack optimization. If enabled - we switch "Prefer API params" to "Prefer PMS items" (the same behaviour if prefer_api_params_for_items = false). It works only when prefer_api_params_for_items and optimize_packaging_level are enabled and item has master-pack.

Force users to enter an ITN for international shipments if the value of items exceeds a threshold

When enabled, shipping clerks will not be able to book a shipment without entering an ITN if product value exceeds their threshold they have setup (such as 2500). If they do not input ITN, the shipment will not go through and they will receive a clear error message noting that an ITN is required. See RM ticket #13850 for more.information.

Prevent users with ‘Shipping Clerk’ role from booking a shipment that does NOT include all items designated for that shipment

This will stop any user who is a shipping clerk from booking a shipment with multiple items, if the shipment is missing any of the items involved. See RM # 16375 for more.

Force ShipHawk users with ‘Shipping Clerk’ role to scan every item into the shipment using barcode scanners

This is only applicable and visible to accounts that are verifying line items before shipping. It will make any shipping clerk have to scan every item into the shipment prior to booking. See RM #16366 for more.

Enable IF Write Backs

Enables write back reporting, enable for every NS customer.

[Move to NetSuite integration settings]

Enable ShipHawk SPS Commerce Connector for ASN

When enabled in integrations settings, ShipHawk will write the shipment package information to SPS Commerce’s records (if available) in NetSuite instead of ShipHawk fields which allows for Advanced Ship Notice (ASN) generation.

Deprecate order origin address

Temporary flag to eliminate the concept of an origin address on outbound shipments because people are shipping from warehouses.

[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 (check with Vasiliy Sablin )

Default destination phone number

The phone number offered by default for the destination.

Rate Timeout (sec)

Specify the cutoff time for receiving rate requests from carriers. [Check with Vasiliy Sablin – e.g., five seconds from the time when we initiate carriers…

]Maximum hardcoded timeout is 45 seconds.

Return label service

Class of service for returns. If not set, uses same service as label creation service. Typically, specify a lower level of service for return labels. For example, if the shipment to the customer was Next Day delivery, the return label could be Ground delivery.

International return label service

Class of service for returns. (Typically, specify a lower level of service for return labels.)

GI code

[TO BE DEPRECATED] – GL CODE

Child accounts feature set

Select from the following:

• Allow child accounts [TO BE DEPRECATED]

• Allow alternate return address [should be defaulted to ON]

• Allow alternate return address for LTL - LTL carriers will use alternate address as origin on BOL

• Allow ultimate consignee address – built specifically for AstroNova, but is generally available in case another customer needs to ship freight to a domestic freight forwarder that has an ultimate consignee in another country.

• Allow book shipment before rating – this is a performance optimization setting to avoid possible lag time due to waiting for rating data.

• Print 2 labels per page [TO BE DEPRECATED – if no one uses it]

Select items button mode

Select from drop-down: in_each_piece or in_all_pieces.

On the Orders Details screen, in the Handling Unit / Package Details section, the user manually scans an item to verify a package and clicks the Select Items button, which opens the Select Items screen. On the Select Items screen, the user can then verify the items in the package or enter a new item. The Select Items screen can function in an ‘in each piece’ mode, or an ‘in all pieces’ mode, depending on this ‘Select items button mode’ setting. The Select Items screen is where users can tell ShipHawk which items go in which boxes/commodities. (For LTL, it is commodities, which make up a handling unit, aka pallet).

in_each_piece – This mode requires the user to specify how many of each SKU are in each piece. If the user attempts to change the number of pieces in the commodity, and the piece count entered by the user does not evenly divide the quantity for each line item evenly, then the user will receive an error message: “Can’t equally spread out selected items between N packages.” With the in_each_piece setting, we force the user to describe which SKUs are in each box, which means that ShipHawk knows for certain which items are in which boxes, and can generate carton labels and write back carton information accordingly.

in_all_pieces – This mode does not require that the SKUs are evenly distributed among the pieces. For example, you can have 5 items in 6 pieces. This makes things easier for the user because they have free control to enter the number of packages in a commodity, along with the number of SKUs in that entire commodity, as opposed to in each piece in the commodity.

IMPORTANT: If you are working with carton labels, you need to select ‘in_each_piece’ rather than ‘in_all_pieces’.

Verify order line items

Include packing slips into labels [WILL BE DEPRECATED - once AutoPrint enabled for all customers and autoprint addresses batch processing]

Include Carton/Pallet labels into combined label [WILL BE DEPRECATED - once AutoPrint enabled for all customers]

Label image format

Select from:

• PDF

• PNG
  

Label size format

Select from the following:

• 4x6

• 4x6.75_doctab

• 4x8_doctab

• 4x8_doctab_with_items

• 4x8_fedex_sel_169

Batch print labels by

Select from the following:

• None

• Order number: 1 to 9

• Order number: 9 to 1

• Order Date/Time: oldest to newest

• Order Date/Time: newest to oldest

• Recipient name: a to z

• Recipient name: z to a

Warehouse carrier zone table

Select from the following:

• fedex

• ups

• usps

Used if you want ShipHawk to select which warehouse to ship from based on closest destination address.

Netsuite order fulfillment strategy

For the NetSuite order fulfillment strategy, select from the following:

[Should be moved to NS integration settings]

• only_create_fulfillment

• only_update_fulfillment

• create_or_update fulfillment

• disabled

Persist external fulfillment carrier – Select checkbox [SHOULD BE DEPRECATED]

Edge time to next ship date

Enter time in HH:MM SS format. (This is the shipping cutoff time. After this time, set it to tomorrow’s date, because it’s going out tomorrow.)

Packing slip reference numbers

Enter reference number names separated by commas. Applies to packing slips in ZPL format.

[SHOULD THIS GO SOMEWHERE ELSE…this is document specific]

Example:

"Invoice, Customer Order #, Reference ID, Purchase Order #, BOL #, YOU_NAME_IT"

Allow external image urls in html document templates

Disable lets talk – select to disable the Let’s Talk platform for this account. [SHOULD BE DEPRECATED]

Order calculate age from

Select from the following: (calculates age shown on Order Details page)

• created_at

• source_system_processesed_at

Newquote defaults

(Should be hidden from this page – should not be editable here. On the UI, it’s a JSON blob.)

Charge label fee for custom tariffs

Select whether to charge label fee for custom tariffs. [SHOULD BE DEPRECATED]

License plate enabled

Select to enable license plate. [Specific to API or UI – check with Nibesh Moktan ]

Tote number enabled

Select to enable tote number. [Specific to API or UI – check with Nibesh Moktan ]

Show/Hide Example Config button [Should be hidden from this page]

Primary color

Hex value for color on branded tracking page.

Display name

Enter the company’s name (name displayed if logo not present).

Logo path

(Merchant Info) branded tracking page.

Continue shipping url

(Merchant Info)

Facebook link

(Merchant Info)

Pinterest link

(Merchant Info)

Twitter link

(Merchant Info)

Instagram link

(Merchant Info)

Email

(Merchant Info)

Phone number

(Merchant Info)

Favicon url

(Merchant Info)

Contact info text

(Merchant Info)

Ad image url

(Merchant Info)

Ad target url

(Merchant Info)

Subdomain

(Merchant Info) The subdomain of the ShipHawk URL for the merchant’s account. For example, in merchant_name.shiphawk.com, the subdomain is merchant_name.

Return policy url

(Merchant Info)

Max number of amazon mws integrations

Specify the maximum number of Amazon Marketplace Web Service (Amazon MWS) integration accounts you can connect to (typically 1).

Max number of amazon vendor central integrations

Specify the maximum number of Amazon Vendor Central integrations (typically 1).

Max number of Amazon shipping integrations

Specify the maximum number of Amazon Shipping integrations (typically 1).

Max number of magento integrations

Specify the maximum number of Magento integrations (typically 1).

Max number of magento2 integrations

Specify the maximum number of Magento2 integrations (typically 1).

Max number of shopify integrations

Specify the maximum number of Shopify integrations (typically 1).

Max number of ebay integrations

Specify the maximum number of eBay integrations (typically 1). [SHOULD BE DEPRECATED]

Max number of big commerce integrations

Specify the maximum number of BigCommerce integrations (typically 1).

Max number of netsuite integrations

Specify the maximum number of NetSuite integrations (typically 1).

NetSuite request page size

Specify the NetSuite request page size. This setting for product data sync between NetSuite and ShipHawk.

Default: 500

Although the default is 500, for many data syncs with large products and kits, this setting might need to be as low as 50 to avoid timeout. For many merchants, a setting of 200 typically works well. The key consideration is how the daata sync is subject to a timeout (the unicorn timeout, which is about 60 seconds). The best value for this setting can vary depending on the merchant’s SKU complexity, if there are child objects, if there are kits, and so on. The default setting can work for some merchants but fail for others depending on factors such as product structure complexity. The default setting could equate to a large amount of data being pulled from NetSuite and sent to ShipHawk for processing (to our products microservice, or PMS). If the timeout is exceeded before the data sync is complete, then this setting must be adjusted to a smaller number to avoid exceeding the timeout.

[MOVE TO INTEGRATION SETTINGS?]

net_suite_request_page_size

NetSuite write back add application id to SSCC

Default: false [Check with jonathan.day ]

Wms hostname

Specify the ShipHawk WMS hostname URL. Example: https://aws-stage-suite-wm.shiphawk.com/<merchant_name>/test/swmAPI.php
Connect ShipHawk to support WMS API data routing--so we can route data from public WMS APIs to our WMS API. [REVISIT]

Block users from adding or removing saved views

Select checkbox to prevent users from changing the saved views (default is un-selected).

Maximum Number of Saved Views per user

Default is 10. No more than 25 allowed for performance reasons.

Api limit*

Drop-down set to Default. Select the following checkboxes for further adjustments:

Include warehouses outside of the US for “domestic” multi-origin rating when items are not available in US warehouses

Overwrite tags on order and ps update

Rate parcel and LTL simultaneously for packed shipments - adds ability for users to better decide whether to ship LTL and parcel. Only available when Strict Item Type is ON

Packing enabled
Enable usage of basic packing (for instance: add items without dims into one box).

[SHOULD BE DEPRECATED - always active?]

Smart packing
Enable ability to use Packing Algo (Smart Packing). The only way Packing Algo works is if all items have dimensions and box sizes that are accurate.

This setting enables the Smart Packing™ feature. 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 – 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 boxes to be cut down – allow the Smart Packing™ algorithm to suggest creating 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.)

Allow materials preferences
Allow materials preferences in packing algorithm. (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.)

Min spike box aspect ratio

The minimum spike ratio that qualifies as a spike for SmartPacking™.

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

Default: 5.0

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

The minimum dimensional weight of a shipment that can be palletized: 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

When algorithm produces more than the specified number of boxes, the app forces using palletized version and skips package version.

(general)

Show test features [MIGHT NOT USE THIS ANYMORE - CAN BE DEPRECATED?]

Address validation strategy

Select from the following:

• Disabled - address validation is not turned on the for the account

• Manual - allow users to click a button on the UI to validate the address. Listed under the destination address field on the order.

• Auto - performs an address validation when the order is imported into ShipHawk. Users that look at the order will be presented with a pop saying the address is not correct, or could be adjusted, and will allow them to make changes.

• Auto-correction - upon order import into ShipHawk, the address will be validated and auto corrected for any errors it may have.

Enable international address validation
Address validation strategy must be ‘manual’ or higher (this can’t be enabled if address validation is disabled).

Smarty streets ignore po box type [DEPRECATED]– use Smarty Streets for address validation.

Auto detect po box addresses

Automatically correct destination address location type for external rate requests
Works completely independently from the Address Validation Strategy

Automatically correct destination address location type on order create/update requests
[DEPRECATED] Works completely independently from the Address Validation Strategy.

Automatically correct destination address location type on order create requests
Works completely independently from the Address Validation Strategy. Can be enabled by only CS team

Automatically correct destination address location type on order update requests
Works completely independently from the Address Validation Strategy. Can be enabled by only CS team

Available packing types

List of available packing types, with a checkbox for each:

• parcel

• unpacked

• pallet

• box

• crate [NOT OFTEN USED]

Default packing type

Select from the following:

• parcel

• unpacked

• pallet

• box

• crate [NOT OFTEN USED]

Piece Types

bag

bale

box

bunch

bundle

can

carboy

carton

case

crate

cylinder

drum

other

pail

pallet

pieces

reel

roll

totes

tube

unit