For Partner Use
Do NOT include confidential information (such as logins, passwords, API keys, private keys, secret tokens) on Confluence pages.
Edit Account
On the Edit Account screen, you can modify the settings for an account. The layout and organization of this page is similar but not identical to the view-only Accounts page.
This page has many sections that organize the various settings available.
Once you have made any changes to the settings, at the bottom of the page, you can click Update Account or Cancel.
The page’s sections include:
Example
Details
| 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]
|
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 | 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 |
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. 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:
|
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:
|
Label size format | Select from the following:
|
Batch print labels by | Select from the following:
|
Warehouse carrier zone table | Select from the following:
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]
Persist external fulfillment carrier – Select checkbox [SHOULD BE DEPRECATED] |
Edge time to next ship date | Enter time in |
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:
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)
|
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) |
(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 |
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?]
|
NetSuite write back add application id to SSCC | Default: false [Check with @jonathan.day ] |
Wms hostname | Specify the ShipHawk WMS hostname URL. Example: |
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 |
Freight Audit
Enabled freight audit for parcel | Enable the freight audit product (ShipHawk Audit) for parcel shipments. |
Enabled freight audit for ltl | Enable the freight audit product (ShipHawk Audit) for LTL shipments. |
Freight Class, NMFC
Freight class override | Enter a value. The system will override every package’s freight class on the BOL with this value. (The value will not override anywhere else.) |
Nmfc override | Enter a value. The system will override every package’s NMFC on the BOL with this value. (The value will not override anywhere else.) |
Set commodities and freight class at handling unit level | When enabled, ShipHawk will display freight class and NMFC at the handling unit level. User can only modify handling unit level settings. When disabled, ShipHawk will display freight class and NMFC at the commodity level. User can only modify commodity level settings. |
Set freight class based on density | Select this option to have ShipHawk automatically calculate and set the Freight Class based on Handling Unit (H.U.) density, so you can use a density-based Freight Class rather than an item-derived Freight Class. With this approach, you can reduce order processing time by automatically setting the Freight Class based on the density calculation. The user interface now shows the Total H.U. Weight and the H.U. Density. |
Deprecations, experiment flags, risky change feature flags
Use these settings with permission from the Product Team only. If you change these without notifying Product or Engineering, you risk derailing global integrations!
|
Skip Third Party Billing in Bol For Sender
Use warehouse address as an origin address for getting rates when warehouse_code passed Prevent auto-detect of FedEx carrier contianers when one rate is turned on
Use restlet to define shipping method Use NetSuite lists creation for package items
Strict Item Type mode: Enable mode with Loose/Box/Pallet type of items only Enables auto printing of labels during a booking request if PrintNode enabled.
Enable table list performance optimized alternative
Enable usage of location_type_defaults, and disable old default of `is_residential` for addresses from Order Create/Order Update/OLI update/Integration Hooks
Enable new redesigned version of carrier accounts page.
Assign accessorials from rate when booking shipment using rate_id and params accessorials empty
Hide deprecated "hazmat" and "orm_d" for all responses with packages
Tax info will be sent for all international shipments even without EEI Old behavior - FALSE, new behaviour - TRUE
Enabled support of customs data for multi package
Deprecate PMS
Use Separate DB connection for PRO Numbers
Uses document files data for creation of shipment aggregation package_labels
This setting remove invalid chars from ZPL label
Removes ZPL page separator from Aggregated labels
Removes ZPL wrapper on ZPL labels combine
Return default shipment billing details in shipment response (webhook or api) if it is not present in db
Skip additional bol generation after synchronous dispatch.
Rebuild version of Shipment creation and Split orders logic
Rerate third party shipments - Only used when Reset shipping costs and prices for Third Party/Recipient shipments = FALSE
Enable optimized response build in /web/orders/find - Only affects order get on the order detail page in the Dashboard UI.
Disable set of default package item value on Package Update - Prevent setting package item value if not provided in the request
Include packing slips into labels - Deprecated, use auto printing instead
Include ucc labels into labels - Deprecated, use auto printing instead
Select international warehouse based on available_in for external rating Smart Packing: "Repack by tail" - new way of re-packing of boxes
|
Smart packing (Packing Algo)
| Packing enabled [SHOULD BE DEPRECATED - always active?] Smart packing Smart Packing works only if if all items have dimensions and box sizes 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 Include material wrappers Allow materials preferences
|
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. |
Teach mode / Packing rules
| Enable Teach Mode / Packing Rules
|
Advanced COD
Optimized Collect on Delivery | On Rating/Booking request to reduce delivery cost we optimize COD to first package (Value - sum of all package values) |
Hazmat Defaults
Emergency response phone number | The phone number to call for HAZMAT emergency response services. |
Emergency contact name | The name of who to contact in the event of a HAZMAT emergency. |
Emergency contact phone number | The phone number of who to contact in the event of a HAZMAT emergency. |
Positions for text in UPS Hazmat Label | Edit tree-based display to adjust printed HAZMAT label text position offsets, structured by the format object, including:
|
Show test features
(general) | Show test features [MIGHT NOT USE THIS ANYMORE - CAN BE DEPRECATED?]
|
Address verification
[Should be called Address Validation – we don’t do “verification”)
Address validation strategy | Select from the following:
Enable international address validation
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
Automatically correct destination address location type on order create/update requests
Automatically correct destination address location type on order create requests
Automatically correct destination address location type on order update requests
|
Location type defaults
Origin* | The default origin location type. From the drop-down, select commercial or residential (default: commercial). |
Destination* | The default destination location type. From the drop-down, select commercial or residential (default: commercial). |
Other* | The default location type for locations other than origin or destination locations. From the drop-down, select commercial or residential (default: commercial). |
Renewal Management
| Renewal enabled Allow account to use app even with an overdue renewal date. |
Renewal date | Date is displayed here; date is set using the Salesforce integration. |
Fraud Controls
[FRAUD CONTROLS DEPRECATED]
Daily shipments limit | (fill in) [Consider keeping only this setting but deprecate the rest] Lock billing details [DO NOT USE] Use braintree kount protection [DO NOT USE] |
API Details
Enabled TPL Providers
List of which 3pls/ freight brokers are not enabled for an account. [SHOULD BE OPT IN INSTEAD OF OPT OUT]
When a checkbox is selected, the provider is disabled (not active) for the account.
Recommendation: select any providers not being used; otherwise, rate requests will slow down and might time out.
AFS Logistics | Select checkbox to disable this third-party logistics provider. |
Amazon Merchant | Select checkbox to disable this third-party logistics provider. |
Amazon Vendor Central | Select checkbox to disable this third-party logistics provider. |
BlueGrace | Select checkbox to disable this third-party logistics provider. |
C.H. Robinson | Select checkbox to disable this third-party logistics provider. |
Echo | Select checkbox to disable this third-party logistics provider. |
EDI Express | Select checkbox to disable this third-party logistics provider. |
Essential Hub | Select checkbox to disable this third-party logistics provider. |
Freight Quote | Select checkbox to disable this third-party logistics provider. |
GlobalTranz | Select checkbox to disable this third-party logistics provider. |
Keystone Dedicated Logistics | Select checkbox to disable this third-party logistics provider. |
Priority1 | Select checkbox to disable this third-party logistics provider. |
QuadExpress | Select checkbox to disable this third-party logistics provider. |
ReTrans | Select checkbox to disable this third-party logistics provider. |
TranzAct | Select checkbox to disable this third-party logistics provider. |
TSG | Select checkbox to disable this third-party logistics provider. |
TSI | Select checkbox to disable this third-party logistics provider. |
Unshippers | Select checkbox to disable this third-party logistics provider. |
WorldwideExpress | Select checkbox to disable this third-party logistics provider. |
Enabled Carriers
Disables carrier for the account. If carrier is a carrier for a 3PL service that you intend to use with that 3PL, it must not be disabled. [SHOULD BE OPT IN INSTEAD OF OPT OUT- SHOULD BE ABLE TO ENABLE/DISABLE CARRIERS FOR 3PLs INDEPENDENTLY]
Recommendation: select any carriers not being used; otherwise, requests will slow down and might time out.
Disabled carrier types | List of the carrier types, with a checkbox for each to select whether they are disabled for this account: Truckload Blanket Wrap Courier Small Parcel LTL Intermodal Auto Local Delivery Home Delivery Final Mile Custom Carrier Third-Party Fulfillment |
Disabled carriers | List of the many carriers, with a checkbox for each to specify whether they are disabled for this account. |
Deny Creds For Carriers
Do not let customers enter their own account credentials for the carriers that have been denied. [SHOULD BE DEPRECATED IF ALLOW CREDS WORKS AS EXPECTED]
Deny cred for carriers | List of the many carriers, with checkbox for each to specify whether to deny credentials.
|
Allow Creds
Allows customers to enter their own account credentials for carriers.
Allow creds for carrier types | List of carrier types, with checkbox for each: Third-Party Fulfillment Blanket Wrap Small Parcel Home Delivery LTL |
Allow creds for tpls | List of the many third-party logistics companies, with checkbox for each. |
Allow CRM Tariff Carriers
[LEGACY DO NOT USE- ONLY WHEN SHIPHAWK IS ACTING AS A BROKER]
Allow CRM tariffs carriers | List of carriers, with a checkbox for each for allowing CRM tariffs.
|
Allowed carrier packing types
Dictates which packing types are available in the user interface. Not related to individual carrier packages.
Available packing types | List of available packing types, with a checkbox for each:
|
Default packing type | Select from the following:
|
Piece Types | bag bale box bunch bundle can carboy carton case crate cylinder drum other pail pallet pieces reel roll totes tube unit |
Help menu items
Allows you to add a new drop-down menu to any account. [SHOULD BE DEPRECATED - DO NOT USE]
Click Add to add help menu items.
Labels
Enables label functionality for an account.
| Select checkboxes to set label functionality: Allow Pallet and Carton labels (default: off) Allow address label (default: on) Allow military labels (default: off) Allow return label tracking (default: off) Allow sku return labels (default: off) Sort labels by LPN (default: off) Allow to persist SSCC code after updating handling units (default: off) Use LPN number as serial number when generating SSCC code (default: off) |
Workstations
Enables workstation functionality for the account.
| Allow Workstations Select checkbox to allow workstations. Workstations in ShipHawk are a pre-configured set of permissions and features that creates a streamlined ShipHawk interface to fulfill orders faster with fewer processing errors. ShipHawk workstation workflows are meant to be used with corresponding physical workstations in a warehouse, which are locations where warehouse associates perform picking, packing, sorting, and/or shipping. The ShipHawk workstation is a virtual counterpart to complement and enhance your physical workstation. NOTE: When selecting Allow Workstations, you must have a URL subdomain specified in the Subdomain setting (see Details panel) in order to support workstations. |
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.
Max serialized package items per proposed shipment | Default: 100 WARNING: If you need to change this setting - create a ticket for L2/L3 support and explain the reasons why the customer needs it. |
Optimize performance for large orders | Select checkbox to optimize performance for large orders. Changes to the UI include:
|
Allow Async Booking | If enabled: UI starts working through `async - book` endpoint. The request will be performed in background and UI will use long-polling to retrieve results. |
Allow Async Saving | If enabled: UI starts working through `async - save/update` endpoint. The request will be performed in background and UI will use long-polling to retrieve results. |
Allow Async Rating | If enabled: UI starts working through `async - rating` endpoint. The request will be performed in background and UI will use long-polling to retrieve results |
Async ucc label generation cartons qty threshold | Default: 200 |
Disable packing alg qty | Sets max items that can be fed to the packing algorithm. If over, then all items put into single package with accurate weight. If undefined uses global default. WARNING: If you need to change that setting - create a ticket for L2/L3 support This is a threshold that can be 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.) |
Allowed max quantity of packages per proposed shipment | Sets a limit on the total number of packages in a proposed shipment. The default is 100 packages. WARNING: If you need to change that setting - create a ticket for L2/L3 support and explain the reasons why the customer needs it. |
Limit for batch shipment operations | This setting prevents processing of orders / proposed shipments (PS) when the quantity of proposed shipments exceeds this threshold. Default: 500 |
Enable/Disable UI elements
Allow Pages
If setting is not enabled, customer cannot see this particular UI element (page/setting) in the ShipHawk UI.
Enabled smart packing page | Select checkbox to enable the smart packing page. |
Enabled commodities page | Select checkbox to enable the commodities page. |
Enabled shipments page | Select checkbox to enable the shipments page. |
Enabled quotes page | Select checkbox to enable the quotes page. |
Enabled order settings page | Select checkbox to enable the order settings page. |
Enabled package preset settings page | Select checkbox to enable the package preset settings page. |
Enabled pick tickets page | Select checkbox to enable the pick tickets page. |
Enabled packing slips page | Select checkbox to allow manual orders. |
Enabled address book page | Select checkbox to enable the address book page. |
Enabled rules page | Select checkbox to enable the rules page. |
Enabled pro numbers page | Select checkbox to allow manual orders. |
Ready-to-ship Mode enabled | Select checkbox to enable ready-to-ship mode. |
Webhooks available | Select checkbox to make the webhooks available. |
Developer api available | Select checkbox to make the API available. |
Customer tracking available | Select checkbox to make customer tracking available. |
Show transaction reports | Select checkbox to show transaction reports. |
Enabled user profile page | Select checkbox to enable user profile page. |
Allow manual orders | Select checkbox to allow manual orders. |
Allow order import csv | Select checkbox to allow importing orders from a .csv file. |
Allow manual shipments | Select checkbox to allow manual shipments. |
Allow shipments import csv | Select checkbox to allow importing shipments from a .csv file. |
Allow scan gs1 barcodes | Select checkbox to allow manual orders. |
Weekly Performance Report Settings
Settings dictate which performance settings are visible in the UI.
Weekly performance report enabled | Select checkbox to enable the weekly performance report. |
Weekly performance email enabled | Select checkbox to enable a weekly performance email. |
Orders enabled | Select checkbox to enable Orders report. |
Shipments enabled | Select checkbox to enable Shipments report. |
Rate optimization savings enabled | Select checkbox to enable rate optimization savings report. |
Top shippers enabled | Select checkbox to enable top shippers report. |
On-time deliveries enabled | Select checkbox to enable on-time deliveries report. |
Order/Shipment processing averages enabled | Select checkbox to enable Order/Shipment processing averages report. |
Most utilized carrier service enabled | Select checkbox to enable most utilized carrier service report. |
Smart pack count enabled | Select checkbox to enable smart pack count report. |
Did you know? enabled | Select checkbox to enable ‘Did you know?’ report. |
Primary carrier | From dropdown, select the primary carrier (for example, FedEx). |
Allow Modals/UI blocks
If setting is not enabled, customer cannot see this particular UI element (modals/UI blocks) in the ShipHawk UI.
Allow to add to carrier credentials | Select checkbox to allow adding to carrier credentials. |
Allow to change shipment bill to | Select checkbox to allow changing the shipment ‘bill to’ information. |
Shipments label printing settings available | Select checkbox to make available the shipments label printing settings. |
Allow third party billing for labels | Select checkbox to allow third party billing or labels. |
Allow third party billing for duties and tax | Select checkbox to allow third party billing for duties and tax. |
Show split order option | Select checkbox to show the split order option. |
Show combine order option | Select checkbox to show the combine order option. |
Show filters on carriers page | Select checkbox to show filters on the Carriers page. |
Show sequence numbers on items verification | Select checkbox to show sequence numbers on items verification. |
Enable Prev/Next links on Order page | Select checkbox to enable Prev/Next links on the Order page. |
Show auto print settings | Select checkbox to show the Auto Print settings. |
Show app notifications (combine orders suggestions) | Select checkbox to show notifications (the bell icon) in the toolbar that there are orders that can be combined. By default, this alert is now hidden on the user interface, but you can enable it here. |
Show ads block | (Selected by default.) |
Show processing time UI block | (Not selected by default.) |
Allow Integrations
Dictates which integrations you can see on the UI.
(Integration list) | List of the many integrations to allow, with a checkbox for each. If an integration is allowed (checkbox selected below), it will be available in shiphawk.com/app/integrations. As of Feb 2, 2024 , the list includes:
|
Allow Filters Integrations
| Select white list integration filters: Filter By Plan (default: on) Filter By Type (default: on) Filter By Status (default: on) |
Allowed Item Types
| Select allowed item types: parcel (default: on) handling_unit (default: on) unpacked (default: on) |
Related pages
For Partner Use
Do NOT include confidential information (such as logins, passwords, API keys, private keys, secret tokens) on Confluence pages.