Create Text Rule
POST/api/walmart/:integrationInstance/routing/rules
Appends a text rule (layer 3), matched against the shipment's free-text carrier.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
match_type is contains, starts_with or exact; matching is case-insensitive. A rule must either route to a carrier or set suppress: true — one that does neither would match shipments and then do nothing.
New rules are appended last, so adding one can never silently shadow an existing rule.
Every change returns the COMPLETE refreshed routing configuration, not just the row that changed — the layers interact, so a partial response could disagree with what the next shipment would actually send.
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.
Unprocessable Content
Response Headers
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.