Get Rates

This method get possible rates for labels between two addresses.

Request
Request Body schema: application/json
transaction_id
required
string <guid>

A randomly generated transaction ID, used to correlate the request and response.

advanced_options
object

This is a schemaless object. It is for open ended customizations unique to particular carriers. If the field is absent it should be interpreted as the default value for any applicable options, e.g. false for booleans.

required
object (Auth)

Authentication properties

confirmation
string (DeliveryConfirmation)

This is the list of valid values for delivery confirmation types.

Enum: "None" "Delivery" "Signature" "AdultSignature" "DirectSignature"
object (Customs)

Customs declarations for this package.

object (Fulfillment Plan Details)

An fulfillment plan details object representing a fulfilment plan.

insurance_provider
string

The insurance provider for the insured value of the label, carrier indicates that the user is requesting insurance from the carrier directly, anything else is extra information that should not result in a transaction.

Enum: "None" "Shipstation" "Carrier" "External"
international
boolean

Indicates Whether the shipment is international.

is_return_label
boolean

Indicates whether the label is a return.

is_residential
boolean

Indicates whether the label is to a residential address.

next_day
boolean

Indicates whether this shipment is expected to use a next day service class. If the field is absent it should be interpreted as false

packages
string

All the packages that make up this shipment. There will always be at least one package defined.

object (PickupLocationDetails)

Pickup/Dropoff location address used by carriers.

service_code
string

Code used to map to what the carrier uses to identify the service.

ship_datetime
string

When the package is expected to ship. Not guaranteed to be in the future. Formatted per the https://tools.ietf.org/html/rfc3339 spec. Will always be in UTC.

object (ShippingAddress)

An address object representing address information.

object (ShippingAddress)

An address object representing address information.

object (ShippingAddress)

An address object representing address information.

Responses
200

OK

post/get_rates
Request samples
application/json
{
  • "transaction_id": "8e4e3181-2a7e-4153-ba6a-f2d6e121500b",
  • "advanced_options": { },
  • "auth": {
    },
  • "confirmation": "None",
  • "customs": {
    },
  • "fulfillment_plan_details": {
    },
  • "insurance_provider": "None",
  • "international": true,
  • "is_return_label": true,
  • "is_residential": true,
  • "next_day": true,
  • "packages": "string",
  • "pickup_location": {
    },
  • "service_code": "string",
  • "ship_datetime": "string",
  • "ship_from": {
    },
  • "ship_from_display": {
    },
  • "ship_to": {
    }
}
Response samples
application/json
{
  • "rates": [
    ]
}