Skip to main content
GET
/
shipping-price
Retrieve a shipping price
curl --request GET \
  --url https://panel.sendcloud.sc/api/v2/shipping-price \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "price": "6.50",
    "currency": "EUR",
    "to_country": "NL",
    "breakdown": [
      {
        "type": "price_without_insurance",
        "label": "Label",
        "value": 6.5
      }
    ]
  }
]
For users that have uploaded their own prices, the response will show the prices that have been uploaded. The response is an array of prices for all available receiver countries. If the to_country query parameter is present, the array will only contain one item. Note that price and currency will be null when no pricing is available for a receiver country.
If you have more than one active contract for a specific carrier, you must fill the contract attribute with your desired contract ID in your request. You can get your contract ID from the Retrieve a list of contracts endpoint.
In order to view remote surcharges, you are required to provide the to_country and to_postal_code. Similarly, to access zonal prices, you need to provide to_country, from_postal_code and to_postal_code. This information ensures accurate and customized pricing based on the specific location, enabling you to understand any additional charges associated with remote areas and access pricing based on their designated zones.

Authorizations

​
Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Query Parameters

​
shipping_method_id
integer
required

The id of the shipping method retrieved via shipping products or shipping methods.

​
from_country
string
required

The sender country of the shipment, as an ISO 3166-1 alpha-2.

​
to_country
string

The receiver country of the shipment, as an ISO 3166-1 alpha-2. Required if the carrier is zonal. Also required to see if remote surcharges apply.

​
weight
integer
required

The weight of the shipment, in weight_unit.

​
weight_unit
string
required

One of kilogram or gram.

​
contract
integer

Id of the contract that you would like to use to get the price. If you are requesting price for a direct contract then you need to upload your own price via the panel.

Required range: x >= 1
Example:

123

​
from_postal_code
string

Postal code of the sender. Required if the carrier is zonal.

Maximum string length: 12
Example:

"01000"

​
to_postal_code
string

Postal code of the recipient. Required if the carrier is zonal. Also required to see if remote surcharges apply.

Maximum string length: 12
Example:

"01000"

Response

OK

​
price
string<currency> | null

Shipping price

Example:

"6.50"

​
currency
string<iso-4217> | null

3 letter currency code as defined by ISO-4217

Example:

"EUR"

​
to_country
string<iso 3166-1>

The receiver country of the shipment, as an ISO 3166-1 alpha-2

Example:

"NL"

​
breakdown
Shipping Price Breakdown Object · object[]

A Sendcloud shipping price breakdown.