What is it for?

Field Required Description How to obtain it
name NO Descriptive name for the rule You define it. E.g.: "Express France"
priority NO Priority order (1 = first) You define it. Rules are evaluated from 1 onwards.
active NO Whether the rule is active Write: true or false
rules NO Conditions to be met See conditions table below
actions NO What to do when conditions are met See actions table below

Conditions

• Requires authentication.
• Validations:
  • The rule name MUST be unique — you cannot have two rules with the same name:
  • Error: SHIPPING_RULE_ALREADY_EXISTS (HTTP 409)
  • Message: "The shipping rule already exists."
  • If you specify a courier_service_id in the actions, that service MUST be active:
  • If the courier is inactive or does not exist, the operation will fail.
  • Actions must be compatible with the selected courier:
  • Each courier only accepts certain action types. Check with the team
  • which actions are available for your integration.
  • After creating the rule:
  • → The priority is automatically assigned at the end of the list if not specified
  • → Orders that already had shipping rule-related errors are recalculated

Parameters

Fill in the fields in Body Params, Query Params and/or Path Params as applicable.

Expected response

HTTP 201 → { "id": 5 }