Skip to main content
POST
/
fetch-shipping-options
curl --request POST \
  --url https://panel.sendcloud.sc/api/v3/fetch-shipping-options \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from_country_code": "NL",
  "to_country_code": "NL",
  "weight": {
    "value": "2",
    "unit": "kg"
  },
  "carrier_code": "postnl",
  "functionalities": {
    "signature": true
  }
}
'
{
  "data": [
    {
      "code": "postnl:small/home_address_only,signature",
      "name": "PostNL Klein Pakket - 10 liter - Alleen Huisadres + Handtekening",
      "carrier": {
        "code": "postnl",
        "name": "PostNL"
      },
      "product": {
        "code": "postnl:small",
        "name": "PostNL Klein Pakket"
      },
      "functionalities": {
        "b2b": true,
        "b2c": true,
        "ers": false,
        "size": null,
        "tyres": false,
        "sorted": false,
        "boxable": false,
        "premium": false,
        "returns": false,
        "segment": null,
        "tracked": true,
        "id_check": false,
        "incoterm": null,
        "manually": false,
        "priority": null,
        "age_check": null,
        "insurance": null,
        "labelless": false,
        "last_mile": "home_delivery",
        "signature": true,
        "surcharge": false,
        "first_mile": "pickup_dropoff",
        "multicollo": true,
        "bulky_goods": false,
        "form_factor": "parcel",
        "fresh_goods": false,
        "eco_delivery": false,
        "service_area": "domestic",
        "flex_delivery": false,
        "fragile_goods": false,
        "non_conveyable": false,
        "dangerous_goods": false,
        "delivery_before": null,
        "cash_on_delivery": null,
        "harmonized_label": false,
        "weekend_delivery": null,
        "carrier_insurance": false,
        "delivery_attempts": null,
        "delivery_deadline": "best_effort",
        "neighbor_delivery": false,
        "customs_value_limit": null,
        "registered_delivery": false,
        "carrier_billing_type": null,
        "personalized_delivery": false,
        "pick_up": false,
        "direct_contract_only": false
      },
      "contract": {
        "id": 60,
        "client_id": "",
        "carrier_code": "postnl",
        "name": "PostNL Test"
      },
      "weight": {
        "min": {
          "value": "0.001",
          "unit": "kg"
        },
        "max": {
          "value": "23.001",
          "unit": "kg"
        }
      },
      "max_dimensions": {
        "length": "0.00",
        "width": "0.00",
        "height": "0.00",
        "unit": "cm"
      },
      "billed_weight": {
        "unit": "kg",
        "value": "2.000",
        "volumetric": false
      },
      "requirements": {
        "fields": [],
        "export_documents": false,
        "is_service_point_required": false
      },
      "charging_type": "label_creation",
      "quotes": [
        {
          "weight": {
            "min": {
              "value": "0.001",
              "unit": "kg"
            },
            "max": {
              "value": "23.001",
              "unit": "kg"
            }
          },
          "price": {
            "breakdown": [
              {
                "type": "price_without_insurance",
                "label": "Label",
                "price": {
                  "value": "0",
                  "currency": "EUR"
                }
              },
              {
                "type": "insurance_price",
                "label": "Shipment protection (incl. taxes)",
                "price": {
                  "value": "0",
                  "currency": "EUR"
                }
              }
            ],
            "total": {
              "value": "0",
              "currency": "EUR"
            }
          },
          "lead_time": 24
        }
      ]
    },
    {
      "code": "postnl:small/signature",
      "carrier": {
        "code": "postnl",
        "name": "PostNL"
      },
      "product": {
        "code": "postnl:small",
        "name": "PostNL Klein Pakket"
      },
      "functionalities": {
        "b2b": true,
        "b2c": true,
        "ers": false,
        "size": null,
        "tyres": false,
        "sorted": false,
        "boxable": false,
        "premium": false,
        "returns": false,
        "segment": null,
        "tracked": true,
        "id_check": false,
        "incoterm": null,
        "manually": false,
        "priority": null,
        "age_check": null,
        "insurance": null,
        "labelless": false,
        "last_mile": "home_delivery",
        "signature": true,
        "surcharge": false,
        "first_mile": "pickup_dropoff",
        "multicollo": true,
        "bulky_goods": false,
        "form_factor": "parcel",
        "fresh_goods": false,
        "eco_delivery": false,
        "service_area": "domestic",
        "flex_delivery": false,
        "fragile_goods": false,
        "non_conveyable": false,
        "dangerous_goods": false,
        "delivery_before": null,
        "cash_on_delivery": null,
        "harmonized_label": false,
        "weekend_delivery": null,
        "carrier_insurance": false,
        "delivery_attempts": null,
        "delivery_deadline": "best_effort",
        "neighbor_delivery": true,
        "customs_value_limit": null,
        "registered_delivery": false,
        "carrier_billing_type": null,
        "personalized_delivery": false,
        "pick_up": false,
        "direct_contract_only": false
      },
      "contract": {
        "id": 60,
        "client_id": "",
        "carrier_code": "postnl",
        "name": "PostNL Test"
      },
      "weight": {
        "min": {
          "value": "0.001",
          "unit": "kg"
        },
        "max": {
          "value": "23.001",
          "unit": "kg"
        }
      },
      "max_dimensions": {
        "length": "0.00",
        "width": "0.00",
        "height": "0.00",
        "unit": "cm"
      },
      "billed_weight": {
        "unit": "kg",
        "value": "2.000",
        "volumetric": false
      },
      "requirements": {
        "fields": [],
        "export_documents": false,
        "is_service_point_required": false
      },
      "charging_type": "label_creation",
      "quotes": [
        {
          "weight": {
            "min": {
              "value": "0.001",
              "unit": "kg"
            },
            "max": {
              "value": "23.001",
              "unit": "kg"
            }
          },
          "price": {
            "breakdown": [
              {
                "type": "price_without_insurance",
                "label": "Label",
                "price": {
                  "value": "0",
                  "currency": "EUR"
                }
              },
              {
                "type": "insurance_price",
                "label": "Shipment protection (incl. taxes)",
                "price": {
                  "value": "0",
                  "currency": "EUR"
                }
              }
            ],
            "total": {
              "value": "0",
              "currency": "EUR"
            }
          },
          "lead_time": 24
        }
      ]
    },
    {
      "code": "postnl:pakjegemak/agecheck=18",
      "carrier": {
        "code": "postnl",
        "name": "PostNL"
      },
      "product": {
        "code": "postnl:pakjegemak",
        "name": "PostNL Service Point"
      },
      "functionalities": {
        "b2b": true,
        "b2c": true,
        "ers": false,
        "size": null,
        "tyres": false,
        "sorted": false,
        "boxable": false,
        "premium": false,
        "returns": false,
        "segment": null,
        "tracked": true,
        "id_check": false,
        "incoterm": null,
        "manually": false,
        "priority": null,
        "age_check": 18,
        "insurance": null,
        "labelless": false,
        "last_mile": "service_point",
        "signature": true,
        "surcharge": false,
        "first_mile": "pickup_dropoff",
        "multicollo": true,
        "bulky_goods": false,
        "form_factor": "parcel",
        "fresh_goods": false,
        "eco_delivery": false,
        "service_area": "domestic",
        "flex_delivery": false,
        "fragile_goods": false,
        "non_conveyable": false,
        "dangerous_goods": false,
        "delivery_before": null,
        "cash_on_delivery": null,
        "harmonized_label": false,
        "weekend_delivery": null,
        "carrier_insurance": false,
        "delivery_attempts": null,
        "delivery_deadline": "best_effort",
        "neighbor_delivery": false,
        "customs_value_limit": null,
        "registered_delivery": false,
        "carrier_billing_type": null,
        "personalized_delivery": false,
        "pick_up": false,
        "direct_contract_only": false
      },
      "contract": {
        "id": 60,
        "client_id": "",
        "carrier_code": "postnl",
        "name": "PostNL Test"
      },
      "weight": {
        "min": {
          "value": "0.001",
          "unit": "kg"
        },
        "max": {
          "value": "23.001",
          "unit": "kg"
        }
      },
      "max_dimensions": {
        "length": "100.00",
        "width": "70.00",
        "height": "58.00",
        "unit": "cm"
      },
      "billed_weight": {
        "unit": "kg",
        "value": "2.000",
        "volumetric": false
      },
      "requirements": {
        "fields": [],
        "export_documents": false,
        "is_service_point_required": true
      },
      "charging_type": "label_creation",
      "quotes": [
        {
          "weight": {
            "min": {
              "value": "0.001",
              "unit": "kg"
            },
            "max": {
              "value": "23.001",
              "unit": "kg"
            }
          },
          "price": {
            "breakdown": [
              {
                "type": "price_without_insurance",
                "label": "Label",
                "price": {
                  "value": "0",
                  "currency": "EUR"
                }
              },
              {
                "type": "insurance_price",
                "label": "Shipment protection (incl. taxes)",
                "price": {
                  "value": "0",
                  "currency": "EUR"
                }
              }
            ],
            "total": {
              "value": "0",
              "currency": "EUR"
            }
          },
          "lead_time": 24
        }
      ]
    },
    {
      "code": "postnl:standard/signature,home_only,eve",
      "carrier": {
        "code": "postnl",
        "name": "PostNL"
      },
      "product": {
        "code": "postnl:standard",
        "name": "PostNL Standard"
      },
      "functionalities": {
        "b2b": true,
        "b2c": true,
        "ers": false,
        "size": null,
        "tyres": false,
        "sorted": false,
        "boxable": false,
        "premium": false,
        "returns": false,
        "segment": null,
        "tracked": true,
        "id_check": false,
        "incoterm": null,
        "manually": false,
        "priority": null,
        "age_check": null,
        "insurance": null,
        "labelless": false,
        "last_mile": "home_delivery",
        "signature": true,
        "surcharge": false,
        "first_mile": "pickup_dropoff",
        "multicollo": true,
        "bulky_goods": false,
        "form_factor": "parcel",
        "fresh_goods": false,
        "eco_delivery": false,
        "service_area": "domestic",
        "flex_delivery": false,
        "fragile_goods": false,
        "non_conveyable": false,
        "dangerous_goods": false,
        "delivery_before": "2000",
        "cash_on_delivery": null,
        "harmonized_label": false,
        "weekend_delivery": null,
        "carrier_insurance": false,
        "delivery_attempts": null,
        "delivery_deadline": "best_effort",
        "neighbor_delivery": false,
        "customs_value_limit": null,
        "registered_delivery": false,
        "carrier_billing_type": null,
        "personalized_delivery": false,
        "pick_up": false,
        "direct_contract_only": false
      },
      "contract": {
        "id": 60,
        "client_id": "",
        "carrier_code": "postnl",
        "name": "PostNL Test"
      },
      "weight": {
        "min": {
          "value": "0.001",
          "unit": "kg"
        },
        "max": {
          "value": "23.001",
          "unit": "kg"
        }
      },
      "max_dimensions": {
        "length": "175.00",
        "width": "78.00",
        "height": "58.00",
        "unit": "cm"
      },
      "billed_weight": {
        "unit": "kg",
        "value": "2.000",
        "volumetric": false
      },
      "requirements": {
        "fields": [],
        "export_documents": false,
        "is_service_point_required": false
      },
      "charging_type": "label_creation",
      "quotes": [
        {
          "weight": {
            "min": {
              "value": "0.001",
              "unit": "kg"
            },
            "max": {
              "value": "23.001",
              "unit": "kg"
            }
          },
          "price": {
            "breakdown": [
              {
                "type": "price_without_insurance",
                "label": "Label",
                "price": {
                  "value": "0",
                  "currency": "EUR"
                }
              },
              {
                "type": "insurance_price",
                "label": "Shipment protection (incl. taxes)",
                "price": {
                  "value": "0",
                  "currency": "EUR"
                }
              }
            ],
            "total": {
              "value": "0",
              "currency": "EUR"
            }
          },
          "lead_time": 24
        }
      ]
    },
    {
      "code": "postnl:pakjegemak",
      "carrier": {
        "code": "postnl",
        "name": "PostNL"
      },
      "product": {
        "code": "postnl:pakjegemak",
        "name": "PostNL Service Point"
      },
      "functionalities": {
        "b2b": true,
        "b2c": true,
        "ers": false,
        "size": null,
        "tyres": false,
        "sorted": false,
        "boxable": false,
        "premium": false,
        "returns": false,
        "segment": null,
        "tracked": true,
        "id_check": false,
        "incoterm": null,
        "manually": false,
        "priority": null,
        "age_check": null,
        "insurance": null,
        "labelless": false,
        "last_mile": "service_point",
        "signature": true,
        "surcharge": false,
        "first_mile": "pickup_dropoff",
        "multicollo": true,
        "bulky_goods": false,
        "form_factor": "parcel",
        "fresh_goods": false,
        "eco_delivery": false,
        "service_area": "domestic",
        "flex_delivery": false,
        "fragile_goods": false,
        "non_conveyable": false,
        "dangerous_goods": false,
        "delivery_before": null,
        "cash_on_delivery": null,
        "harmonized_label": false,
        "weekend_delivery": null,
        "carrier_insurance": false,
        "delivery_attempts": null,
        "delivery_deadline": "best_effort",
        "neighbor_delivery": false,
        "customs_value_limit": null,
        "registered_delivery": false,
        "carrier_billing_type": null,
        "personalized_delivery": false,
        "pick_up": false,
        "direct_contract_only": false
      },
      "contract": {
        "id": 60,
        "client_id": "",
        "carrier_code": "postnl",
        "name": "PostNL Test"
      },
      "weight": {
        "min": {
          "value": "0.001",
          "unit": "kg"
        },
        "max": {
          "value": "23.001",
          "unit": "kg"
        }
      },
      "max_dimensions": {
        "length": "175.00",
        "width": "78.00",
        "height": "58.00",
        "unit": "cm"
      },
      "billed_weight": {
        "unit": "kg",
        "value": "2.000",
        "volumetric": false
      },
      "requirements": {
        "fields": [],
        "export_documents": false,
        "is_service_point_required": true
      },
      "charging_type": "label_creation",
      "quotes": [
        {
          "weight": {
            "min": {
              "value": "0.001",
              "unit": "kg"
            },
            "max": {
              "value": "23.001",
              "unit": "kg"
            }
          },
          "price": {
            "breakdown": [
              {
                "type": "price_without_insurance",
                "label": "Label",
                "price": {
                  "value": "0",
                  "currency": "EUR"
                }
              },
              {
                "type": "insurance_price",
                "label": "Shipment protection (incl. taxes)",
                "price": {
                  "value": "0",
                  "currency": "EUR"
                }
              }
            ],
            "total": {
              "value": "0",
              "currency": "EUR"
            }
          },
          "lead_time": 24
        }
      ]
    },
    {
      "code": "postnl:standard/signature,home_only",
      "carrier": {
        "code": "postnl",
        "name": "PostNL"
      },
      "product": {
        "code": "postnl:standard",
        "name": "PostNL Standard"
      },
      "functionalities": {
        "b2b": true,
        "b2c": true,
        "ers": false,
        "size": null,
        "tyres": false,
        "sorted": false,
        "boxable": false,
        "premium": false,
        "returns": false,
        "segment": null,
        "tracked": true,
        "id_check": false,
        "incoterm": null,
        "manually": false,
        "priority": null,
        "age_check": null,
        "insurance": null,
        "labelless": false,
        "last_mile": "home_delivery",
        "signature": true,
        "surcharge": false,
        "first_mile": "pickup_dropoff",
        "multicollo": true,
        "bulky_goods": false,
        "form_factor": "parcel",
        "fresh_goods": false,
        "eco_delivery": false,
        "service_area": "domestic",
        "flex_delivery": false,
        "fragile_goods": false,
        "non_conveyable": false,
        "dangerous_goods": false,
        "delivery_before": null,
        "cash_on_delivery": null,
        "harmonized_label": false,
        "weekend_delivery": null,
        "carrier_insurance": false,
        "delivery_attempts": null,
        "delivery_deadline": "best_effort",
        "neighbor_delivery": false,
        "customs_value_limit": null,
        "registered_delivery": false,
        "carrier_billing_type": null,
        "personalized_delivery": false,
        "pick_up": false,
        "direct_contract_only": false
      },
      "contract": {
        "id": 60,
        "client_id": "",
        "carrier_code": "postnl",
        "name": "PostNL Test"
      },
      "weight": {
        "min": {
          "value": "0.001",
          "unit": "kg"
        },
        "max": {
          "value": "23.001",
          "unit": "kg"
        }
      },
      "max_dimensions": {
        "length": "175.00",
        "width": "78.00",
        "height": "58.00",
        "unit": "cm"
      },
      "billed_weight": {
        "unit": "kg",
        "value": "2.000",
        "volumetric": false
      },
      "requirements": {
        "fields": [],
        "export_documents": false,
        "is_service_point_required": false
      },
      "charging_type": "label_creation",
      "quotes": [
        {
          "weight": {
            "min": {
              "value": "0.001",
              "unit": "kg"
            },
            "max": {
              "value": "23.001",
              "unit": "kg"
            }
          },
          "price": {
            "breakdown": [
              {
                "type": "price_without_insurance",
                "label": "Label",
                "price": {
                  "value": "0",
                  "currency": "EUR"
                }
              },
              {
                "type": "insurance_price",
                "label": "Shipment protection (incl. taxes)",
                "price": {
                  "value": "0",
                  "currency": "EUR"
                }
              }
            ],
            "total": {
              "value": "0",
              "currency": "EUR"
            }
          },
          "lead_time": 24
        }
      ]
    },
    {
      "code": "postnl:standard/signature",
      "carrier": {
        "code": "postnl",
        "name": "PostNL"
      },
      "product": {
        "code": "postnl:standard",
        "name": "PostNL Standard"
      },
      "functionalities": {
        "b2b": true,
        "b2c": true,
        "ers": false,
        "size": null,
        "tyres": false,
        "sorted": false,
        "boxable": false,
        "premium": false,
        "returns": false,
        "segment": null,
        "tracked": true,
        "id_check": false,
        "incoterm": null,
        "manually": false,
        "priority": null,
        "age_check": null,
        "insurance": null,
        "labelless": false,
        "last_mile": "home_delivery",
        "signature": true,
        "surcharge": false,
        "first_mile": "pickup_dropoff",
        "multicollo": true,
        "bulky_goods": false,
        "form_factor": "parcel",
        "fresh_goods": false,
        "eco_delivery": false,
        "service_area": "domestic",
        "flex_delivery": false,
        "fragile_goods": false,
        "non_conveyable": false,
        "dangerous_goods": false,
        "delivery_before": null,
        "cash_on_delivery": null,
        "harmonized_label": false,
        "weekend_delivery": null,
        "carrier_insurance": false,
        "delivery_attempts": null,
        "delivery_deadline": "best_effort",
        "neighbor_delivery": true,
        "customs_value_limit": null,
        "registered_delivery": false,
        "carrier_billing_type": null,
        "personalized_delivery": false,
        "pick_up": false,
        "direct_contract_only": false
      },
      "contract": {
        "id": 60,
        "client_id": "",
        "carrier_code": "postnl",
        "name": "PostNL Test"
      },
      "weight": {
        "min": {
          "value": "0.001",
          "unit": "kg"
        },
        "max": {
          "value": "23.001",
          "unit": "kg"
        }
      },
      "max_dimensions": {
        "length": "175.00",
        "width": "78.00",
        "height": "58.00",
        "unit": "cm"
      },
      "billed_weight": {
        "unit": "kg",
        "value": "2.000",
        "volumetric": false
      },
      "requirements": {
        "fields": [],
        "export_documents": false,
        "is_service_point_required": false
      },
      "charging_type": "label_creation",
      "quotes": [
        {
          "weight": {
            "min": {
              "value": "0.001",
              "unit": "kg"
            },
            "max": {
              "value": "23.001",
              "unit": "kg"
            }
          },
          "price": {
            "breakdown": [
              {
                "type": "price_without_insurance",
                "label": "Label",
                "price": {
                  "value": "0",
                  "currency": "EUR"
                }
              },
              {
                "type": "insurance_price",
                "label": "Shipment protection (incl. taxes)",
                "price": {
                  "value": "0",
                  "currency": "EUR"
                }
              }
            ],
            "total": {
              "value": "0",
              "currency": "EUR"
            }
          },
          "lead_time": 24
        }
      ]
    }
  ]
}
A shipping option is a shipping product that the carrier offers in combination with a unique set of shipping functionalities. The quotes serve to indicate the cost of this shipping option. You must have either enabled a carrier in your Sendcloud account, or connected your own direct carrier contract, in order to be able to retrieve shipping options related to that carrier via this endpoint. When shipping to a remote area, it’s possible that a remote surcharge will be invoiced. Make sure to provide the from_country_code, to_country_code and to_postal_code to see remote surcharges in the price breakdown. Similarly, to access zonal prices, provide from_country_code, to_country_code, 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.

Body

application/json
​
from_country_code
string | null

Sender country code in ISO 3166-1 alpha-2 format.

​
to_country_code
string | null

Destination country code in ISO 3166-1 alpha-2 format.

​
functionalities
Shipping Functionalities Object · object

Shipping functionalities

​
carrier_code
string | null

Carrier code.

​
contract_id
integer | null

Contract id.

​
shipping_product_code
string | null
​
dimensions
Dimension · object

Dimension in the specified unit

​
weight
Weight · object

Weight in the specified unit

​
from_postal_code
string | null

The postal code of the sender address. Should be provided, to make quotes as accurate as possible.

Maximum string length: 12
​
to_postal_code
string | null

The postal code of the destination address. Should be provided, to make quotes as accurate as possible.

Maximum string length: 12
​
total_insurance
number | null

Total value that you want to insure the parcel for.

​
lead_time
Lead Time Filter Object · object

Filter to trim down shipping options with a specific lead time.

Response

List of shipping options.

​
data
Shipping Option · object[] | null
required

A list of options to ship a parcel. A shipping option is a shipping product that the carrier offers in combination with a unique set of shipping functionalities. Each shipping option will indicate the fully allowed weight range, the requirements, the contract and the billed weight (in case weight and dimensions are passed in the request) for this option. If the request doesn't pass basic details about the parcel (e.g. from_country, to_country, and weight), it's possible that the data will be null. This is to prevent sending too many results in the response.