List Shipping Method Mappings
GET/api/magento2/integration-instances/:magento2IntegrationInstance/shipping-method-mappings
Returns the existing Magento -> SKU.io shipping method mappings, the distinct Magento shipping methods observed on past imported orders for this instance, and the catalogue of SKU.io ShippingMethod records that can be picked from the row-level select.
Authenticated. Requires a Bearer token.
Response fields:
data.mappings[]— union of observed methods and any persisted mappings.sku_shipping_method_id/sku_shipping_method_nameare null when the method is not yet mapped.magento_method_labelis the human-friendly description fromshipping_descriptionon the original order (when available).data.observed_methods[]— raw list of distinct{carrier}_{method}codes seen on past orders, paired with the latestshipping_descriptionobserved.data.sku_shipping_methods[]— every SKU.io ShippingMethod available to pick from. Rendered as friendly labels in the row-level select viafull_name("Carrier - Method").
The page renders the entire table from this single response — no separate call for the shipping-method catalogue is required.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.