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).

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

200

OK

Response Headers

Content-Type

401

Unauthorized

Response Headers

Content-Type

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

422

Unprocessable Entity

Response Headers

Content-Type

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.