Shipping Setup API

Create a new carrier account for the merchant. The account holds the credentials and configuration Carriyo uses to book shipments with that carrier.

List carrier accounts configured for your tenant. The response is a paginated wrapper (items plus pagination), not a JSON array at the root.

By default, active and inactive accounts are included. Pass status (e.g. ACTIVE) to narrow the list. Only ACTIVE accounts can be used to book shipments.

Use page and page_size to page through results. Set pagination=false to return all matches in a single response (pagination metadata will show page and page_size as 0).

Return a single carrier account by its carrier-account-id. By default the response matches a configured account (carrier-account-object). Pass statistics=true to receive activity timestamps (carrier-account-statistics-object).

Replace the configuration of a carrier account. The request body fully replaces the existing account; fields you omit are reset to defaults.

Soft-delete the specified carrier account. The account moves to deleted status and is no longer returned by GET /carrier-accounts unless you pass status=deleted. Active bookings on the account are not affected.

The request is rejected with 400 if the account is referenced by any automation rule or service-level rule. Remove the references first, then retry.

Create an automation ruleset. The ruleset is the container for the routing rules Carriyo evaluates at booking time to pick a carrier account for each shipment. You can optionally pass an initial set of rules on the request; rules can also be added later.

List automation rulesets. Pass merchant to filter to one merchant, or omit it to return rulesets across all merchants. Pass entity-type (FORWARD or REVERSE) to narrow to forward-shipment or reverse-shipment rulesets.

Return a single automation ruleset by its automation-ruleset-id.

Replace the ruleset and the rules it contains. The request body overwrites both; any rule not in the request is removed. To change just the ruleset's own metadata (name, merchants, entity type) without touching its rules, use PATCH instead.

Update the ruleset's own metadata (name, merchants, entity type) without touching the rules it contains. To replace the rules as well, use PUT.

Delete the ruleset and every rule it contains. Active bookings are unaffected, but from this point forward new bookings will fall through to any remaining rulesets, or return an error if no other ruleset matches.

Add a new rule to an existing ruleset. The rule's position in the evaluation order is managed separately via Update automation sequence.

List the rules in the specified ruleset, ordered by their configured sequence.

Set the evaluation order of rules within the ruleset. Carriyo evaluates rules in this order at booking time and stops at the first matching rule, so sequence drives which rule wins when more than one would match the shipment.

Return a single automation rule by its automation-rule-id within the ruleset.

Replace the rule's configuration. The request body fully replaces the existing rule; fields you omit are reset to defaults. The rule's position in the evaluation sequence is unchanged and is managed separately via Update automation sequence.

Remove a single rule from its ruleset. The rest of the ruleset is unchanged. New bookings that would have matched this rule fall through to the next matching rule in the ruleset.

Create a service-level ruleset. Service-level rules drive the delivery promise (estimated delivery date and any cut-off windows) Carriyo computes for each shipment. You can optionally include an initial set of rules on the request; rules can also be added later.

List service-level rulesets. Pass merchant to filter to one merchant, or omit it to return rulesets across all merchants. Pass entity-type (FORWARD or REVERSE) to narrow to forward-shipment or reverse-shipment rulesets.

Return a single service-level ruleset by its service-level-ruleset-id.

Replace the ruleset and the rules it contains. The request body overwrites both; any rule not in the request is removed. To change just the ruleset's own metadata without touching its rules, use PATCH instead.

Update the ruleset's own metadata (name, merchants, entity type) without touching the rules it contains. To replace the rules as well, use PUT.

Delete the ruleset and every rule it contains. Without an applicable service-level ruleset, Carriyo falls back to carrier-provided estimates for new shipments.

Add a new rule to an existing service-level ruleset. The rule's position in the evaluation order is managed separately via Update service level sequence.