Add Text Rule
POST/api/odoo-3pl/:integration_instance/shipping-methods/routing/rules
Layer 3 — add a rule matched against the free-text shipping method on an order.
match_type — contains, starts_with or exact. Matching ignores case, spacing and punctuation.
match_value — the text to match.
odoo_3pl_shipping_method_id — required unless suppress is true.
suppress — the matched text is not a carrier, so send nothing. Defaults to false when omitted, so a rule that names neither is rejected.
New rules are appended last. Rules are first-match-wins, so order matters.
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.