Acumatica Options

Some additional options allow you to further customize shipping Acumatica documents with StarShip. These options are accessible from Setup > Source Interface > Acumatica (Version) > Options.


In the Options section of Acumatica setup, you can configure additional settings for related documents, diagnostics, and log files.

When importing a document that has an existing non-posted shipment, always
  • Prompt: Prompt the user for action. The prompt will include the options to Create New, View, or Edit. Note that View is only available for Processed shipments; Draft (Open) shipments will always open in Edit mode.
  • Create New: StarShip will automatically create a new shipment from the data being imported from the source interface without prompting the user.
  • Edit Existing: Set the existing document to “Open” status so that it can be edited.
  • View Existing: Open the existing shipment in View-only mode.
StarShip will search for any draft shipment or shipment processed within the last “#” days

When importing a document (Sales Orders, Shipments, etc.) from your source interface, StarShip will scan all open (draft) shipments, and only the processed shipments within the number of days you set here, for shipments that may already exist for that document. So, for example, if you add an order to a shipment you’ve already saved or processed in StarShip, you can reprocess the shipment with the new order added without voiding write-back or tracking numbers. Note that you cannot set the number of days if you set the option above it to Create New.

Run in Diagnostic Mode

Check this option to have StarShip run in a special diagnostic mode that shows the raw input from the source interface before any mapping or translations are performed on it. When enabled, a Show Diagnostics button appears on the source interface tab.

Enable logging of Acumatica transactions

StarShip will run in a special mode that provides more information to aid Technical Support. You can also specify Normal or Maximum levels of logging. To change the default directory, click the arrow next to the file path.

Disable Search of Source Documents

This option controls searching for source documents when in Rate/Ship. When it is checked, StarShip will not display the Search Documents grid and will require that you enter the exact Document Number.

Refresh List of Source Documents after shipping

When this option is checked, StarShip will update the list of Acumatica documents in the Documents grid after you process a shipment. New documents are retrieved and shipments no longer matching the filters will not be seen.

Additional Options

Allow write-back for return shipments

When this option is checked, the tracking number for Return shipments will be written back to Acumatica. Write-back will only occur for returns that were processed by importing an Acumatica order and selecting a carrier return option in the Shipment Options; write-back is not available for returns initiated from the Ship screen using the Ship/Process/Create Return method.

Allow user to modify units to ship for line items from Acumatica Shipments

When checked, this option allows you to modify the units to ship after importing an Acumatica Shipment into StarShip. When the shipment is processed, the Shipped Qty will then be updated in Acumatica.

Filter Shipments to retrieve those with picked flag set

Do you use StarShip along with an inventory or warehouse management system? When this option is checked, StarShip will only import Shipments from Acumatica that are fully picked. This eliminates the possibility of shipping a partially picked Acumatica Shipment.

Maximum Number of Concurrent Web Services API Requests

In Acumatica 2018 and later, Acumatica has introduced throttling of requests to its Web Services API based on license tier. The Number of Concurrent Web Services API Requests is affected by the number of workstations using StarShip to ship, as well as other external applications that connect to Acumatica. This setting can help to minimize and manage the impact of Acumatica throttling on shipping speed by specifying the number of concurrent requests StarShip can send. If no other applications in your environment are using the Acumatica Web Services API, you can allow StarShip to use the Maximum Number of Concurrent Web Services API Requests allowed for your tier. You can find this value in Acumatica under Configuration > Common Settings > Licensing Monitoring Console. You must set this option to a lower value if StarShip shares the tier limit with other applications that connect to Acumatica.

It may appear that shipment processing is slower because StarShip has to wait to send requests to the Acumatica Web Services API. StarShip will effectively “hold on” to transactions until the Web Services API is ready to accept them. This topic is covered in greater depth in the article on Transactions and Licensing.

Explode Non-Stock Kit items when loading documents into StarShip

Check this option if you want to explode the components of a Non-Stock Kit into line items in StarShip when you import an Acumatica document containing a Non-Stock Kit. This enables you to pack the components of the kit items in the Shipment Editor. When checked, StarShip will write back all the line items to the Package Contents in Acumatica, as well as match the serial numbers. StarShip will also write back the tracking information to the Package tab in Acumatica.

Search shipment document by sales order number

To access the Order Nbr. filtering feature for shipment documents, select this option and go to the Rate/Ship page in StarShip using Acumatica 2022 R2 or a newer version, and with VTechEndPointV6_2022R2 or a higher version.


This option is exclusively for REST Integration.

To filter through shipment documents by Order Nbr., use these steps:

  • Enter the order number in the Transaction Number field, it will search for exact shipment details.

  • Select Add Filter, choose Order Number, and then you can enter the Contains, Begins with, Equals, and Not equal options to search for exact shipment.

  • You can add the Order Nbr. as a column and display in this page.

Require to allocate “When Received” line items for Sales Orders and Shipments

Lot/Serial items can have either a “When Received” or “When Used” allocation method. When checked, StarShip will require you to allocate line items imported into StarShip if “When Received” is the allocation type on the items.

Acumatica Additional Settings