Skip to main content

Bulk Replace Shipping Method Mappings

PUT 
/api/magento2/integration-instances/:magento2IntegrationInstance/shipping-method-mappings

Bulk-replaces the shipping method mappings for the instance in a single transaction. Uses replace semantics:

  • Rows present in the payload with a non-null sku_shipping_method_id are upserted.
  • Rows present with a null sku_shipping_method_id are removed (the user cleared the row-level select).
  • Rows whose magento_method_code is absent from the payload are removed (delete-by-omission).
Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

A mapping is applied when SKU.io creates the sales order for a Magento order: the order's shipping method is set to the mapped SKU.io method. An unmapped method leaves the shipping method empty and keeps the Magento method as the order's requested shipping method. Changing a mapping affects orders imported afterwards, not orders already created.

Authenticated. Requires a Bearer token.

Request body (mappings[]):

  • magento_carrier_code (string, optional, max 64) — informational; the canonical key is magento_method_code.
  • magento_method_code (string, required, max 128) — the Magento {carrier}_{method} identifier (e.g. flatrate_flatrate, ups_GND, fedex_FEDEX_2_DAY).
  • sku_shipping_method_id (integer or null, optional) — must exist in shipping_methods. null removes the mapping.
  • sku_shipping_method_name (string, optional, max 255) — informational label used by the UI / activity log; not authoritative.

Request​

Responses​

OK

Response Headers
    Content-Type