Introduction

Welcome to the ScriptDrop Pricing API.

The Pricing API returns delivery price quotes for decision support. A quote does not create an Omni request, reserve a rate, create a label, persist a quote, or guarantee that a later label purchase will match the returned price.

Pricing is documented as a standalone API surface because it can be consumed by Omni API and Pharmacy API integrations without coupling the contract to either API.

Authentication

Authentication is performed using an API key and secret and sent using the Authorization header with the Basic realm.

To authorize, use this code:

api_key = "pk_myapikey1234"
api_secret = "tesk_myapisecret1234"

encoded_authorization = Base.url_encode64("#{api_key}:#{api_secret}")

authorization_header = "Basic #{encoded_authorization}"

ScriptDrop uses API keys to allow access to the API. Please contact our support team for API keys.

ScriptDrop expects the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: Basic encoded_authorization

V1 Quotes

Create a Quote

url = "https://request.scriptdrop.co/pricing/v1/quotes"

headers = [
  {"Authorization", "Basic encoded_authorization"},
  {"Content-type", "application/json"}
]

quote_params = %{
  "pickup" => %{
    "address" => %{
      "zipcode" => "43200"
    }
  },
  "dropoff" => %{
    "address" => %{
      "zipcode" => "43210"
    }
  },
  "providers" => ["all"],
  "service_level" => "ground_advantage",
  "package_dimensions" => %{
    "length_in" => 8,
    "width_in" => 5,
    "height_in" => 3,
    "weight_oz" => 15
  }
}

HTTPoison.start()
HTTPoison.post(url, Jason.encode!(quote_params), headers)

The above command returns JSON structured like this:

{
  "quotes": [
    {
      "provider": "usps",
      "service": "ground_advantage",
      "price_usd": 6.44
    }
  ]
}

This endpoint returns delivery price quotes.

The first Pricing API v1 implementation supports USPS Ground Advantage quotes. The response intentionally omits zone, quote expiration, rate-lock terms, label purchase terms, package codes, signature requirements, and Omni request identifiers.

HTTP Request

POST https://request.scriptdrop.co/pricing/v1/quotes

Body Parameters

Package Dimensions

Pricing API v1 does not silently infer package weight or dimensions. Consumers may use standardized launch defaults, such as liquid vs. non-liquid weight or standard package dimensions, but those values must be explicitly sent in the request.

Round one supports caller-supplied dimensions, not carrier package codes. GoodRx or another consumer may choose a standard package size, such as a launch default like 10 x 12 x 5, but the consumer must send the selected dimensions in the payload. Carrier package types, such as USPS flat-rate boxes or FedEx One Rate packaging, can be considered in a later version.

Validation Rules

Full street address, name, and phone number are not required for the first ZIP-only USPS Ground Advantage quote path unless USPS integration testing proves they are necessary.

200 Response Schema

Empty Quotes

When the request is valid and processed but no matching USPS Ground Advantage quote is available, the endpoint returns a 200 response with an empty quote list.

{
  "quotes": []
}

An empty quotes list is not an error condition.

Error Response

See Errors.

V1 Deferred Features

The following features are intentionally deferred from Pricing API v1:

Errors

Example validation error response:

{
  "error": {
    "message": "Package weight must be greater than 0."
  }
}

JSON example of a USPS upstream failure response:

{
  "error": {
    "message": "Unable to retrieve pricing from USPS."
  }
}

The ScriptDrop Pricing API uses the following error codes: