Map Carrier/Service

PUT 
/api/starshipit/integration-instances/:integration_instance/shipping-methods/map

Creates or updates the mapping for a single carrier/service code to a SKU shipping method.

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

Request body:

• code (string, required, max 255) — the carrier/service code, format "{carrier}|{carrier_service_code}"
• shipping_method_id (integer, required) — must exist in shipping_methods

Authentication: Requires Bearer token.

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

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 Content

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.