Magento 2 - Enable API Access

Karl Falconer · Updated

This article is for whoever connects a Magento 2 store inside DropStream — a fulfillment provider (3PL) or a merchant who manages their own DropStream account. You’ll add the store through DropStream’s Add Connection wizard. If a fulfillment provider is setting up DropStream for you, you don’t need this page — just gather your Magento 2 API credentials and send them over.

What you’ll need

How DropStream connects to Magento 2

Every store connects through the same Add Connection wizard. For the full walkthrough of the wizard’s four steps, see Add a Connection. This article covers only the Store Setup step, where you enter the Magento 2-specific details.

Enter your Magento 2 details

  1. In the Add Connection wizard, work through to the Store Setup step. Choose Create new store, give the store a Name, and select Magento 2 as the Platform. The Magento 2 credential fields appear below.

  2. Enter your credentials:

    Field What it is Example
    Access token The Magento 2 Integration access token (OAuth bearer token) a1b2c3d4e5f6g7h8
    Store URL The base URL of your Magento store https://store.example.com
    Store View Code (Optional) Specifies the store for this integration (multi-store only) default

    For where to find each value, see Get Your API Credentials.

  3. (Optional) Adjust the import settings:

    • Order Import Status — orders with this status in Magento are imported. (Default: processing)
    • Delay Orders Imported By (minutes) — hold orders until this many minutes have elapsed since the order was placed.
    • Include Bundle Parent — for bundled items, send the bundle parent SKU. (Default: disabled)
    • Use Compact Shipment Ship Notification — use the alternative /ship API call in Magento. (Default: enabled)
  4. Click Add connection.

Notes

  • Magento 2 authenticates with an Integration access token (an OAuth-style bearer token created under System > Integrations), not a username/API key.
  • On Magento 2.4.4 and above, set Allow OAuth Access Tokens to be used as standalone Bearer tokens to Yes, or API requests may fail with The consumer isn't authorized to access %resources. See Allow OAuth Access Tokens To Be Used as Standalone Bearer Tokens.

Once the connection is added, confirm orders are flowing with Review Order Status.

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

Comments

0 comments

Please sign in to leave a comment.