Get the decision behind a selected rate

curl --request GET \
  --url https://api.goshippo.com/automations/labels/{request_id}/decision \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.goshippo.com/automations/labels/{request_id}/decision"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.goshippo.com/automations/labels/{request_id}/decision', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.goshippo.com/automations/labels/{request_id}/decision",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.goshippo.com/automations/labels/{request_id}/decision"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.goshippo.com/automations/labels/{request_id}/decision")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "request_id": "b3b8f6b0-1a2b-4c3d-9e4f-5a6b7c8d9e0f",
  "test": false,
  "status": "purchased",
  "dry_run": false,
  "shipment_id": "5e40ead7cffe4cc1ad45108696162e42",
  "transaction_id": "9b2d4f6a8c0e4a1b3d5f7a9c1e3b5d7f",
  "tracking_number": "9400111899223197428490",
  "label_url": "https://shippo-delivery.s3.amazonaws.com/2f8b6d1e4a9c4f3b8e7d5a1c6b9e0f24.pdf",
  "created_at": "2026-09-03T18:04:10Z",
  "evaluated_at": "2026-09-03T18:04:12Z",
  "label_processed_at": "2026-09-03T18:04:20Z",
  "decision": {
    "decision_log_id": "c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
    "auto_provisioned": true,
    "estimate_available": false,
    "matched_rule_name": "default",
    "matched_priority": 1,
    "fallback_triggered": false,
    "selected_rate": {
      "rate_id": "c4e8a2f6d0b94c17a3e5f7b9d1c3e5a7",
      "carrier": "USPS",
      "service_level": "usps_priority",
      "amount": "7.35"
    },
    "facts_input": {
      "planned_ship_date": null
    },
    "ruleset_snapshot": {
      "rule_set_id": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f70",
      "fallback": {
        "strategy": "min_field",
        "field": "cost"
      },
      "rules": [
        {
          "priority": 1,
          "rule_id": "e5f6a7b8-c9d0-4e1f-8a2b-3c4d5e6f7a81",
          "name": "default",
          "version": 1,
          "condition_groups": [],
          "action": {
            "strategy": "min_field",
            "field": "cost"
          }
        }
      ]
    },
    "rule_trace": [
      {
        "priority": 1,
        "rule_id": "e5f6a7b8-c9d0-4e1f-8a2b-3c4d5e6f7a81",
        "rule_name": "default",
        "rule_version": 1,
        "matched": true,
        "short_circuited": false,
        "condition_results": [],
        "selection": {
          "strategy": "min_field",
          "field": "cost",
          "winner_id": "c4e8a2f6d0b94c17a3e5f7b9d1c3e5a7",
          "values_considered": [
            {
              "rate_id": "c4e8a2f6d0b94c17a3e5f7b9d1c3e5a7",
              "value": "7.35"
            },
            {
              "rate_id": "7a1c3e5b9d2f4a6c8e0b1d3f5a7c9e2b",
              "value": "9.85"
            }
          ],
          "tiebreaker_applied": false,
          "tiebreaker_resolved_by": null,
          "tied_candidates": []
        }
      }
    ]
  }
}

{
  "detail": "Authentication credentials were not provided."
}

{
  "detail": "Automations is not available for this account."
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "detail": "Automations is temporarily unavailable."
}

Automations

Get the decision behind a selected rate

Returns the rule-evaluation decision for a request: the rule that matched, the rate selected, the facts the engine evaluated, and the full rule trace. Read-only.

This is the answer to “why this carrier, why this price” — the audit record for the decision; it does not change once written.

In this beta the matched rule is always default, the single rule provisioned for your account. matched_priority and fallback_triggered describe ordering and fallback behavior that become meaningful when customer-defined rules ship.

Available once evaluation has written a decision, including while a purchase is still processing. Outcomes reached before evaluation have no decision and return 409, and 404 for a request id that does not exist or does not belong to your account.

GET

automations

labels

{request_id}

decision

Get the decision behind a selected rate

curl --request GET \
  --url https://api.goshippo.com/automations/labels/{request_id}/decision \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.goshippo.com/automations/labels/{request_id}/decision"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.goshippo.com/automations/labels/{request_id}/decision', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.goshippo.com/automations/labels/{request_id}/decision",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.goshippo.com/automations/labels/{request_id}/decision"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.goshippo.com/automations/labels/{request_id}/decision")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "request_id": "b3b8f6b0-1a2b-4c3d-9e4f-5a6b7c8d9e0f",
  "test": false,
  "status": "purchased",
  "dry_run": false,
  "shipment_id": "5e40ead7cffe4cc1ad45108696162e42",
  "transaction_id": "9b2d4f6a8c0e4a1b3d5f7a9c1e3b5d7f",
  "tracking_number": "9400111899223197428490",
  "label_url": "https://shippo-delivery.s3.amazonaws.com/2f8b6d1e4a9c4f3b8e7d5a1c6b9e0f24.pdf",
  "created_at": "2026-09-03T18:04:10Z",
  "evaluated_at": "2026-09-03T18:04:12Z",
  "label_processed_at": "2026-09-03T18:04:20Z",
  "decision": {
    "decision_log_id": "c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
    "auto_provisioned": true,
    "estimate_available": false,
    "matched_rule_name": "default",
    "matched_priority": 1,
    "fallback_triggered": false,
    "selected_rate": {
      "rate_id": "c4e8a2f6d0b94c17a3e5f7b9d1c3e5a7",
      "carrier": "USPS",
      "service_level": "usps_priority",
      "amount": "7.35"
    },
    "facts_input": {
      "planned_ship_date": null
    },
    "ruleset_snapshot": {
      "rule_set_id": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f70",
      "fallback": {
        "strategy": "min_field",
        "field": "cost"
      },
      "rules": [
        {
          "priority": 1,
          "rule_id": "e5f6a7b8-c9d0-4e1f-8a2b-3c4d5e6f7a81",
          "name": "default",
          "version": 1,
          "condition_groups": [],
          "action": {
            "strategy": "min_field",
            "field": "cost"
          }
        }
      ]
    },
    "rule_trace": [
      {
        "priority": 1,
        "rule_id": "e5f6a7b8-c9d0-4e1f-8a2b-3c4d5e6f7a81",
        "rule_name": "default",
        "rule_version": 1,
        "matched": true,
        "short_circuited": false,
        "condition_results": [],
        "selection": {
          "strategy": "min_field",
          "field": "cost",
          "winner_id": "c4e8a2f6d0b94c17a3e5f7b9d1c3e5a7",
          "values_considered": [
            {
              "rate_id": "c4e8a2f6d0b94c17a3e5f7b9d1c3e5a7",
              "value": "7.35"
            },
            {
              "rate_id": "7a1c3e5b9d2f4a6c8e0b1d3f5a7c9e2b",
              "value": "9.85"
            }
          ],
          "tiebreaker_applied": false,
          "tiebreaker_resolved_by": null,
          "tied_candidates": []
        }
      }
    ]
  }
}

{
  "detail": "Authentication credentials were not provided."
}

{
  "detail": "Automations is not available for this account."
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "detail": "Automations is temporarily unavailable."
}

Authorizations

Authorization

string

header

default:ShippoToken

required

Shippo API token, sent as Authorization: ShippoToken <API_TOKEN>.

Path Parameters

request_id

string<uuid>

required

Response

Successful Response

Returned by GET /automations/labels/{request_id}/decision: the request's status and identifiers plus its full decision record. Available once rule evaluation has completed.

request_id

string<uuid>

required

test

boolean

required

Whether this request was created in test mode.

status

enum<string>

required

Current status of the request.

Available options:

processing,

purchased,

dry_run_completed,

no_match,

failed

dry_run

boolean

required

Whether this request evaluates selection without purchasing a label.

created_at

string<date-time>

required

decision

DecisionBlock · object

required

The record of one completed rule evaluation: the rule that matched, the rate selected, the facts evaluated, and the full rule trace. It is written once and never changes. estimate_available is always false in this beta.

Show child attributes

shipment_id

string | null

transaction_id

string | null

tracking_number

string | null

label_url

string | null

evaluated_at

string<date-time> | null

label_processed_at

string<date-time> | null

⌘I

Overview

Shippo API

Enums

Addresses API v2

Reporting API

Estimate API

Automations API

Get the decision behind a selected rate

Authorizations

Path Parameters

Response