Overview

  • Integrate Starshipit with Magento 2, so you can import Magento 2 orders.
  • Starshipit will write back tracking information when you print a label (or when you manifest, depending upon your settings).

1. Create a user and role in Magento 2

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.

2. Enter your Magento 2 details in Starshipit

  1. In your Starshipit account select Settings, then select Integrations.
  2. Click Add a new integration, and select Magento 2.
  3. Click the Enable Magento 2 checkbox. 
  4. Enter the URL of your site, e.g. https://www.myShop.com
  5. Enter the username and password from step 1.
  6. Select your import status.
  7. Test your connection, and then click Save.

3. (Optional) Import 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.

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.