Magento 2 Integration


  • The steps below will guide you through integrating your Magento 2 platform to Starshipit.  Once completed, your orders will be imported into Starshipit and the tracking information will be written back when you print a label.
  • There are two ways to connect your Magento2 store with Starshipit. Token based authentication is recommended especially if you are using two-factor authentication on your store.


  • Magento 2.4: Two-factor authentication is enabled by default on Magento2. This means you will need to use token authentication to connect with Starshipit.
  • Magento 2.4.4 users will need to enable token access in the Admin by setting the Stores > Configuration > Services > OAuth > Consumer Settings > Allow OAuth Access Tokens to be used as standalone Bearer tokens option to Yes.

What you need to get started:

Before getting started with Magento 2 you will need a few things. 

  • If using Token Authentication (recommended): An access token 
  • If using User Authentication: A user set up

If you do not have the above fields, follow the below steps:

Token Authentication (Recommended): Create an access token

  1. Log into your Magento2 admin page.
  2. At the very bottom left of the sidebar click System > Extensions > Integrations.
  3. Click Add New Integration.
    • Enter Starshipit in the Name field.
    • Enter your admin password in the Your Password field. Leave all other fields blank.
    • Click the API tab.
    • Under the Resource Access dropdown select All.
    • Click Save in the top right of the screen.
  4. You will then be taken back to the Integrations page.
  5. Click Allow.
  6. A dialog will appear with a Consumer Key, Consumer Secret, Access Token, and Access Token Secret.
  7. Only the Access Token is required. Copy your Access Token and click Done.

User Authentication (skip if Token authentication has been completed): Create a role and user

Note: Skip this section if you have completed the steps above for Token Authentication

Create a new role

  1. Go to your Magento Admin Dashboard and select System.
  2. Under Permissions, select User Roles.
  3. Click Add New Role.
  4. In Role Name, enter Integration, then select the Role Resources tab.
  5. From the Resource Access dropdown, select All.
  6. Click Save Role.

Assign your new role to a user

  1. From the Dashboard panel, select System.
  2. Under Permissions, select All Users.
  3. From the Users page, click Add New User.
  4. Enter the required user information. We recommend you note your username and password for later use.
  5. Select the User Role tab, then select the Integration role you previously created.
  6. Click Save User.

How to set up Magento 2:

To enable Magento 2 on your account:

  1. Go to Starshipit > Settings > Integrations > Add a new integration > Magento 2
  2. Click the Enable Magento2 checkbox. 
  3. Select your Authentication Method (Token or authentication)
  4. Enter the URL of your site, e.g.
  5. Enter your Access Token or Username and Password.
  6. Select your import status.
  7. Click Save

Additional Configuration

Status to import
Use this option to specify what status orders should be in to import into Starshipit. You can specify multiple by separating each status with a semi colon. 
Delivery information

Give your customers the option to choose between Signature on Delivery and Authority to Leave during the checkout process. To set this up, create the following custom fields:

delivery_comment (String max 100) for the delivery instruction 
authority_to_leave: values can be 0, 1, true, false, yes or no
signature_required: values can be 0, 1, true, false, yes or no

NOTE: To add the file to /rest/V1/orders/ you need to add them to the order search Criteria API.

Import Bundles 
By default Starshipit does not import Magento bundles. If you would like to enable this feature tick Import bundled items. This feature will allow writeback for orders which have bundle items in them.
Limitations: The bundle items will not display in the UI. They are only visible on the Customised packing slip. Ship together bundles are not supported. 


Was this article helpful?
2 out of 5 found this helpful



Article is closed for comments.