Bulk Map Shipping Method Values
PUT/api/shiphero/integration-instances/:integration_instance/shipping-methods/mappings/bulk
Apply many mapping decisions in ONE request, inside a transaction.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
The per-value endpoint returns the whole refreshed configuration, which re-derives observed volume from fulfillment history - correct, but it makes every single selection a full round trip. Use this when saving a page of edits.
Body fields:
mappings(required, array, 1-500)mappings.*.carrier(required, string, max 191) - as ShipHero reports itmappings.*.service(required but may be EMPTY or null, string, max 191)mappings.*.shipping_method_id(required, nullable, integer) - must existmappings.*.suppress(optional, boolean) - leave the value as free text
Returns the same full configuration payload as the list endpoint.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 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.
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.
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.