Skip to content
E-commerce

Magento and Shipwire integration

Plan how Magento and Shipwire should share data across your business. Work with Stacksync engineers on record mapping, system access, and the requirements for running the integration.

  • Scope your workflow with an integration engineer
  • Review the systems, records, and updates you need
Integration planning
stacksync.com

Teams building with Stacksync

Plan the connection your business needs

Explore a Magento and Shipwire integration with a Stacksync engineer. Stacksync support for Magento and Shipwire is not established by the connector documentation reviewed for this page. Start with one record and the update your business needs to identify an implementation path.

01 / Business process

Start with one meaningful update

Identify the record that changes in Magento or Shipwire, where it needs to appear, and which team depends on it.

02 / Data access

Establish the available connection

Bring the objects, account editions, and required directions. An engineer can review the connector path, permissions, and field access.

03 / Success criteria

Define a result you can verify

Agree on record matching, acceptable delay, expected volume, and how your team will resolve failed updates.

Technical referenceAvailable documentation, candidate record relationships, and questions for your technical review.

What records can you sync?

Explore the record types and read/write requirements for each system.

MagentoConnection and object support require review

Record types to review with Stacksync

Record typeCoverage and requirements
ProductsConfirm support for this record type and the direction you need.
Configurable / variant productsConfirm support for this record type and the direction you need.
CategoriesConfirm support for this record type and the direction you need.
OrdersConfirm support for this record type and the direction you need.
CustomersConfirm support for this record type and the direction you need.
Inventory source items (MSI)Confirm support for this record type and the direction you need.

Discuss Magento requirements

ShipwireConnection and object support require review

Record types to review with Stacksync

Record typeCoverage and requirements
OrdersConfirm support for this record type and the direction you need.
ProductsConfirm support for this record type and the direction you need.
StockConfirm support for this record type and the direction you need.
ReceivingsConfirm support for this record type and the direction you need.
ReturnsConfirm support for this record type and the direction you need.
Purchase OrdersConfirm support for this record type and the direction you need.

Discuss Shipwire requirements

Connection requirements and limits

Magento

Integration interface
REST and GraphQL Web APIs (SOAP also available)
Authentication
Confirm the credentials, API plan, and permissions required for Magento.
Change detection
Confirm how Stacksync detects changes for this connector and the objects you need.
Read access
Confirm with Stacksync
Write access
Confirm with Stacksync

Limitations to check

  • Confirm Stacksync support for Magento and the record types your workflow needs.
  • Review write-back, deletion handling, update timing, and account limits with the integration team.

Shipwire

Integration interface
REST API (v3)
Authentication
Confirm the credentials, API plan, and permissions required for Shipwire.
Change detection
Confirm how Stacksync detects changes for this connector and the objects you need.
Read access
Confirm with Stacksync
Write access
Confirm with Stacksync

Limitations to check

  • Confirm Stacksync support for Shipwire and the record types your workflow needs.
  • Review write-back, deletion handling, update timing, and account limits with the integration team.

Prepare your technical review

Use the worksheets and reference checks to capture record identity, ownership, and the result your business expects.

Implementation reference

Record identity and field ownership

Use these data-model references to describe the records your connection needs. They are planning examples; connector availability and supported operations must be established before implementation.

Download the mapping worksheet

CSV · No email required · Record matching, ownership, and test cases

Business processInvoices Orders

Order-to-invoice handoff: Shipwire Orders provides context for Magento Invoices. These are related records, not equivalent entities.

Magento
Object support to establish
Shipwire
Object support to establish

Record identity

Link order and line IDs to invoice and line IDs; allow partial invoicing and multiple invoices per order.

Field ownership

Finance owns invoice posting; the order system supplies the approved commercial context.

Fields to include

  • Source record reference
  • Destination record reference
  • Approved handoff state
  • Duplicate-detection key
Business processShipments Orders

Order-to-fulfillment handoff: Shipwire Orders provides context for Magento Shipments. These are related records, not equivalent entities.

Magento
Object support to establish
Shipwire
Object support to establish

Record identity

Link the order and selected line IDs to separate fulfillment IDs; allow split shipments.

Field ownership

The fulfillment owner decides when an approved order can ship and how cancellations are handled.

Fields to include

  • Source record reference
  • Destination record reference
  • Approved handoff state
  • Duplicate-detection key
Record matchingOrders Orders

Compare whether Magento Orders and Shipwire Orders describe the same sales order in your business.

Magento
Object support to establish
Shipwire
Object support to establish

Record identity

Preserve both the order ID and stable line IDs. Allow one order to relate to several shipments or invoices.

Field ownership

Decide which system approves the order and which can cancel or amend it after fulfillment begins.

Fields to include

  • Source order ID
  • Customer reference
  • Line references and quantities
  • Order status
  • Currency
Record matchingProducts Products

Compare whether Magento Products and Shipwire Products describe the same product or catalog item in your business.

Magento
Object support to establish
Shipwire
Object support to establish

Record identity

Distinguish the product ID, variant ID, SKU, and price-list entry; they are not interchangeable keys.

Field ownership

Assign ownership for catalog content, price, and stock separately.

Fields to include

  • Source product ID
  • SKU or variant reference
  • Description
  • Unit of measure
  • Price-list reference
Record matchingInventory source items (MSI) Stock

Compare whether Magento Inventory source items (MSI) and Shipwire Stock describe the same inventory or stock position in your business.

Magento
Object support to establish
Shipwire
Object support to establish

Record identity

Identify stock by product/variant, location, and any lot or serial dimension; a product ID alone is insufficient.

Field ownership

Choose the stock authority and distinguish available, reserved, and physical quantities.

Fields to include

  • Product reference
  • Location reference
  • Quantity type
  • Quantity
  • As-of time

Architecture decision

Choose how to connect your systems

Choose a method around one example record and the update your business needs. Use Invoices / Orders to review record matching and confirm Stacksync support for the required operations. Compare ongoing sync, a custom workflow, and a scheduled export against that requirement.

Stacksync managed sync

Best fit
Review compatibility with a Stacksync engineer using an example of the records and updates you need.
Operating responsibility
Fits ongoing record synchronization when the required operations are supported. Add workflow steps for approvals or business actions that go beyond copying fields.
Before you choose
Check record matching: Link order and line IDs to invoice and line IDs; allow partial invoicing and multiple invoices per order. Verify field coverage, deletion handling, and how changes are detected.

Native vendor integration

Best fit
A vendor-built integration may fit if it supports your Magento and Shipwire record types.
Operating responsibility
Can reduce setup for a supported workflow. You may need another method for records or business steps it does not cover.
Before you choose
First check whether either vendor offers this integration. If available, verify Invoices / Orders, update direction, account tier, and related-record handling.

Custom API or workflow

Best fit
Consider explicit orchestration for the Invoices / Orders handoff.
Operating responsibility
Provides control over business steps; the team owns credentials, version changes, error queues, and reconciliation.
Before you choose
Verify endpoint permissions, pagination, quotas, duplicate detection, and failure recovery.

File or scheduled snapshot

Best fit
Consider for a one-time Magento / Shipwire migration or a reporting need with an explicit freshness window.
Operating responsibility
Can simplify a bounded transfer; later changes and deletion history require another extraction or a separately designed incremental process.
Before you choose
Record the extraction cutoff, source IDs, encoding, date/number formats, and reconciliation totals.

Workflow reference

From a business event to the right update

Open a workflow to see its trigger, record relationships, and expected result.

Sales order process handoff

Starting event: A change to the selected Invoices or Orders record needs a defined result in the other system.

  1. Start with Magento Invoices and Shipwire Orders. Use the record-matching and field-ownership rules from your mapping worksheet.
  2. Create or locate the customer and products first; resolve taxes, currency, and fulfillment references.
  3. Test a normal update and one failed or repeated update in the supported direction. Keep both record IDs with the test results.

Expected result: Test a partially invoiced order, tax rounding, and a repeated handoff without generating another invoice.

If it fails: Check for an existing destination order before retrying a timed-out create; reconcile line IDs to avoid duplicate fulfillment.

Sales order process handoff

Starting event: A change to the selected Shipments or Orders record needs a defined result in the other system.

  1. Start with Magento Shipments and Shipwire Orders. Use the record-matching and field-ownership rules from your mapping worksheet.
  2. Create or locate the customer and products first; resolve taxes, currency, and fulfillment references.
  3. Test a normal update and one failed or repeated update in the supported direction. Keep both record IDs with the test results.

Expected result: Test partial fulfillment, an out-of-stock line, and a repeated request that must not create a second shipment.

If it fails: Check for an existing destination order before retrying a timed-out create; reconcile line IDs to avoid duplicate fulfillment.

Sales order sync test

Starting event: A change to the selected Orders or Orders record needs a defined result in the other system.

  1. Start with Magento Orders and Shipwire Orders. Use the record-matching and field-ownership rules from your mapping worksheet.
  2. Create or locate the customer and products first; resolve taxes, currency, and fulfillment references.
  3. Test a normal update and one failed or repeated update in the supported direction. Keep both record IDs with the test results.

Expected result: Test a multi-line order, a partial cancellation, and two partial shipments. Compare line totals as well as the header.

If it fails: Check for an existing destination order before retrying a timed-out create; reconcile line IDs to avoid duplicate fulfillment.

Coordinate Magento commerce data with Shipwire

Starting event: A catalog, order, or fulfillment change in Magento matters to Orders or Products.

  1. Choose the commerce entity from Products or Configurable / variant products; separate products, variants, orders, and fulfillments.
  2. Preserve order and line references through the Shipwire process. Define many-to-one or one-to-many relationships explicitly.
  3. Assign separate ownership for commercial approval, inventory, and fulfillment, including partial cancellations or returns.

Expected result: A split fulfillment and repeated request preserve line quantities without duplicate orders or shipments.

If it fails: Look up existing downstream records before retrying creation; reconcile current order and fulfillment states.

Production readiness

Test the behavior your business depends on

Keep both record IDs with the expected and actual result. Reconcile the same filters and time window in each system.

Invoices / Orders

Test case

Test a partially invoiced order, tax rounding, and a repeated handoff without generating another invoice.

Expected result

The expected sales order relationship is preserved with no duplicate action or unintended write.

Shipments / Orders

Test case

Test partial fulfillment, an out-of-stock line, and a repeated request that must not create a second shipment.

Expected result

The expected sales order relationship is preserved with no duplicate action or unintended write.

Orders / Orders

Test case

Test a multi-line order, a partial cancellation, and two partial shipments. Compare line totals as well as the header.

Expected result

The expected sales order relationship is preserved with no duplicate action or unintended write.

Products / Products

Test case

Test two variants of one product, a changed SKU, and a price that applies to only one market or currency.

Expected result

The expected product or catalog item relationship is preserved with no duplicate action or unintended write.

Direction and permissions

Test case

Bring an example source record and the intended destination operation to the compatibility review. Confirm the supported route before granting write access.

Expected result

Only an approved, supported direction and permitted fields are written.

Freshness and reconciliation

Test case

Measure source and destination times for the selected records under normal load and a burst. Reconcile IDs and values using the same filters and cutoff.

Expected result

The process meets its agreed freshness target and reconciliation has no unexplained differences.

Failure recovery

Find the cause. Restore the data flow.

Start with the failed record and the destination error, then inspect the source value, field requirements, and access.

Rejected or repeated sales order change

Investigate

Inspect Magento Invoices and Shipwire Orders, their IDs, and the destination error.

Next action

Check for an existing destination order before retrying a timed-out create; reconcile line IDs to avoid duplicate fulfillment.

Rejected or repeated sales order change

Investigate

Inspect Magento Shipments and Shipwire Orders, their IDs, and the destination error.

Next action

Check for an existing destination order before retrying a timed-out create; reconcile line IDs to avoid duplicate fulfillment.

Rejected or repeated sales order change

Investigate

Inspect Magento Orders and Shipwire Orders, their IDs, and the destination error.

Next action

Check for an existing destination order before retrying a timed-out create; reconcile line IDs to avoid duplicate fulfillment.

A record type or update is unavailable

Investigate

Check the Magento and Shipwire connector guides, account permissions, and any operations marked On Request.

Next action

Ask the integration team to confirm a supported way to handle that record. Verify whether it needs connector configuration or a separate workflow step.

Source and destination disagree after a retry

Investigate

Compare current source values, destination validation, identity mappings, and any side effects already completed.

Next action

Stacksync issue retry reads the current source state. Decide the intended state before retrying or reverting; reconcile downstream effects separately.

Read the Stacksync issues dashboard guide for retry and revert behavior.

How updates move between Magento and Shipwire

See how each system detects changes and which updates the other system can receive. Each direction has its own permissions and record requirements.

Magento Shipwire Direction requires confirmation

Detect changesConfirm how Stacksync detects changes for this connector and the objects you need.

Apply updatesConfirm that Stacksync can create or update the records you need in Shipwire.

Shipwire Magento Direction requires confirmation

Detect changesConfirm how Stacksync detects changes for this connector and the objects you need.

Apply updatesConfirm that Stacksync can create or update the records you need in Magento.

Update timing and record limits

  • Measure initial-load and ongoing-change latency separately. Source detection, selected objects, account limits, and destination validation determine the observed delay.
  • Review write-back, deletion handling, update timing, and account limits with the integration team.
  • Review write-back, deletion handling, update timing, and account limits with the integration team.

Prepare Magento and Shipwire access

Set up both accounts before testing the mapping. Use test records where available, and identify the account administrator who can approve access and help resolve setup errors.

Magento setup checklist

  • Identify the Magento account, edition, environment, and business objects the integration must access.
  • Confirm a Stacksync connector or implementation path for Magento, including read/write support, authentication, and initial-load limits.

Shipwire setup checklist

  • Identify the Shipwire account, edition, environment, and business objects the integration must access.
  • Confirm a Stacksync connector or implementation path for Shipwire, including read/write support, authentication, and initial-load limits.

Prepare to go live

Record the fields each system can update, the first-load cutoff, both record IDs, the expected update delay, and who handles errors. Complete the tests before production before expanding to more records.

Use the Magento and Shipwire planning worksheet to capture these decisions. Record the access owner in the worksheet and enter credentials only in the connection setup.

Talk to an engineer · Review current pricing

Security and control for your integrations

Use SSO and SCIM to manage access, secure connection options to reach your systems, and record-level retry and revert controls to resolve sync errors.

Explore security controls
FAQ

Magento and Shipwire integration FAQ

Find the right integration path

Walk through your Magento and Shipwire records, field mappings, and requirements with an integration engineer.