Set Up the Acumatica Company using the Oauth method

Enable Secure API Access in Acumatica

These steps explain how to allow StarShip to securely connect to your Acumatica data using OAuth sign‑in.
You are registering an external app in Acumatica, giving it permission to securely access your data, and allowing users to approve access without sharing passwords.

Log In to Acumatica

1. Open Acumatica in your browser.
2. Sign in with your administrator account.
3. Confirm the correct company in the top‑right corner.

Open Connected Applications

1. Click More Items → Integration
   Click Integration->Connected Applications.
   

Create a New Application

1. Click Add New.
2. Enter Client Name (friendly name).
3. Select OAuth 2.0 Flow: Authorization Code.
4. Ensure Active is checked.
   

Set Session Options

• Enable Refresh Tokens.
• Leave default expiration settings.
  

Create a Security Secret

1. Open the Secrets tab.
2. Click Add Shared Secret.
3. Enter a description and save.
4. Copy the secret immediately.
   

Add Redirect URI

1. Open Redirect URIs tab.
2. Add the provided redirect URL.
   • Login to Starship tenant, go to Setup->Source Interface->Acumatica Company setup.
   • Click New Company, copy the Redirect URL field value
   • Paste it into Acumatica Redirect URL field.
     
3. Save.
   

Save and Copy Client ID

1. Save the application.
2. Copy Client ID and Client Secret.
   

Confirm API Access

1. Navigate to Integration → Web Service Endpoints.
2. Confirm an endpoint exists (e.g., DEFAULT).
   

Add Acumatica Company by OAuth 2.0

1. From Setup, select Source Interfaces > Acumatica (version).
2. In Companies, click the New Company button if you don’t have existing one.
   
3. Enter the Acumatica company information:
   • Company Name: Your company name as you would like it to appear in StarShip. You may want to include the warehouse name with the company if you use multiple warehouses. For example, “MyCompany-NYC-MAIN”.
   • Acumatica Contract Service URL: This is the URL used to connect to Acumatica Contract Services.
     Note
     Make sure the Acumatica Contract Service URL you are entering in StarShip is the same as the one shown in Acumatica. If you are unsure of where to find the Contract Service URL in Acumatica, see Copy the Acumatica Contract Service URL for help.

1. • Authentication Type: Choose OAuth2 way. You will be redirected to Acumatica application by yourself and approve access for StarShip, no password is shared.
   • ClientId: The ClientId you generated in Acumatica.
   • ClientSecret: The ClientSecret generated in Acumatica.
   • Generate Token: Clicking this button will direct you to Acumatica application, you will be required to enter your username and password, and approve access to StarShip. The access token will be generated successfully after returning to the StarShip application.
   • Acumatica Login Name: Enter the Acumatica Login name as it appears in Acumatica. The Acumatica Login Name can be found on the Acumatica Tenant List.
   • Acumatica Branch ID: This is the exact Branch ID as it appears in Acumatica (Organization > Organization Structure > Configure > Branches).
   • Acumatica Warehouse ID: This is the exact Warehouse ID of the warehouse for this company connection (Distribution > Inventory > Warehouses). Only items on order with this Warehouse ID can be shipped using this company connection. By default, the associated Warehouse address is mapped to the Sender Address.
     

Multiple Warehouses

If you ship from multiple Warehouses, it is important to read the Multiple Warehouses Setup topic for more information about what to enter in this field.

1. For “Share Company connection between multiple users”: If you have a limited number of licenses or limited parallel connections, you may want to check this setting. It allows users to share one company connection instead of occupying one source interface seat for each user. You can also set the number of connections to be shared.
2. Click Submit.