Map Shipping Method Value

PUT 
/api/shiphero/integration-instances/:integration_instance/shipping-methods/mappings

Set or suppress the SKU.io shipping method for one ShipHero value. An explicit mapping outranks both text rules and automatic matching.

Not yet available to API tokens

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

Values are addressed by the (carrier, service) PAIR, not a row id: what ShipHero sends is derived from fulfillment history, so most values have no stored row until a decision is made about them.

Body fields:

• carrier (required, string, max 191) - as ShipHero reports it, e.g. endicia
• service (required but may be EMPTY, string, max 191) - ShipHero really does report a carrier with no service, and that is a distinct value
• shipping_method_id (required, nullable, integer) - must exist; send null to leave it to the layers below
• suppress (optional, boolean) - deliberately leave this value as free text so no rule below can claim it. Setting it clears any mapping.

Authentication: Requires Bearer token.

Every endpoint in this folder returns the SAME full configuration payload (provider_methods, sku_methods, text_rules, summary).

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

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

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.