Set Carrier Family Default
PUT/api/odoo-3pl/:integration_instance/shipping-methods/routing/families/:shippingCarrier
Layer 2 — set the default Odoo 3PL carrier for a whole shipping-carrier family. This is what makes a large catalog routable before any order exists.
odoo_3pl_shipping_method_id — the catalog entry to route the family to; null clears the default.
suppress — the family deliberately sends no carrier (it is not a 3PL shipment); cannot be combined with a target.
apply_to_methods — also clear per-method overrides inside the family, so they stop shadowing the new default.
Authentication: requires a Bearer token.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
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.