Skip to main content

Create Text Rule

POST 
/api/shiphero/integration-instances/:integration_instance/shipping-methods/rules

Add an ordered text rule, applied to values that have no explicit mapping. New rules are appended last so they cannot shadow existing ones.

Not yet available to API tokens

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

Rules match against both the full value (endicia (USPS Priority Mail)) and the service alone (USPS Priority Mail), ignoring case and punctuation.

Body fields:

  • match_type (required, string) - one of contains, starts_with, exact
  • match_value (required, string, max 255)
  • shipping_method_id (required, nullable, integer) - must exist; required unless suppress is true
  • suppress (optional, boolean) - matching values are left as free text. Defaults to false when omitted, so a rule that sends neither a shipping_method_id nor suppress: true is rejected
  • position (optional, integer, min 0) - defaults to last

Order matters: contains "priority mail express" must sit above contains "priority", or Express resolves to plain Priority.

Authentication: Requires Bearer token.

Every endpoint in this folder returns the SAME full configuration payload (provider_methods, sku_methods, text_rules, summary). The resolution layers interact, so a mutation returns the whole refreshed configuration rather than the single row that changed.

Request​

Responses​

OK

Response Headers
    Content-Type