Skip to main content
GET
/
shipping_methods
Retrieve a list of shipping methods
curl --request GET \
  --url https://panel.sendcloud.sc/api/v2/shipping_methods \
  --header 'Authorization: Basic <encoded-value>'
{
  "next": null,
  "previous": null,
  "shipping_methods": [
    {
      "id": 8020,
      "name": "DHLForYou Drop Off - Agecheck 18+",
      "carrier": "dhl",
      "min_weight": "0.001",
      "max_weight": "23.001",
      "service_point_input": "none",
      "price": 0,
      "countries": [
        {
          "id": 2,
          "name": "Netherlands",
          "price": 9.75,
          "iso_2": "NL",
          "iso_3": "NLD",
          "lead_time_hours": 24,
          "price_breakdown": [
            {
              "type": "price_without_insurance",
              "label": "Label",
              "value": 8.55
            },
            {
              "type": "fuel",
              "label": "Fuel surcharge (14.00%)",
              "value": 1.2
            }
          ]
        }
      ]
    },
    {
      "id": 8021,
      "name": "DHLForYou - Agecheck 18+",
      "carrier": "dhl",
      "min_weight": "0.001",
      "max_weight": "23.001",
      "service_point_input": "none",
      "price": 0,
      "countries": [
        {
          "id": 2,
          "name": "Netherlands",
          "price": 10.01,
          "iso_2": "NL",
          "iso_3": "NLD",
          "lead_time_hours": 24,
          "price_breakdown": [
            {
              "type": "price_without_insurance",
              "label": "Label",
              "value": 8.78
            },
            {
              "type": "fuel",
              "label": "Fuel surcharge (14.00%)",
              "value": 1.23
            }
          ]
        }
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://sendcloud.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
sender_address
string

The ID of the sender address for which you would like to know the available shipping methods. If you want to retrieve all available shipping methods, please use all as a value for this parameter. Required if the carrier is zonal.

​
service_point_id
integer

The ID of the service point for which you would like to know the available shipping methods.

​
is_return
boolean

If set to true the endpoint will return shipping methods which can be used for making a return shipment.

​
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"

​
to_country
enum<string>

A country ISO 2 code for the recipient country. Required if the carrier is zonal. Also required to see if remote surcharges apply. A country represented by its ISO 3166-1 alpha-2 code

Available options:
AW,
AF,
AO,
AI,
AX,
AL,
AD,
AE,
AR,
AM,
AS,
AQ,
TF,
AG,
AU,
AT,
AZ,
BI,
BE,
BJ,
BQ,
BF,
BD,
BG,
BH,
BS,
BA,
BL,
BY,
BZ,
BM,
BO,
BR,
BB,
BN,
BT,
BV,
BW,
CF,
CA,
CC,
CH,
CL,
CN,
CI,
CM,
CD,
CG,
CK,
CO,
KM,
CV,
CR,
CU,
CW,
CX,
KY,
CY,
CZ,
DE,
DJ,
DM,
DK,
DO,
DZ,
EC,
EG,
ER,
EH,
ES,
EE,
ET,
FI,
FJ,
FK,
FR,
FO,
FM,
GA,
GB,
GE,
GG,
GH,
GI,
GN,
GP,
GM,
GW,
GQ,
GR,
GD,
GL,
GT,
GF,
GU,
GY,
HK,
HM,
HN,
HR,
HT,
HU,
ID,
IM,
IN,
IO,
IE,
IR,
IQ,
IS,
IL,
IT,
JM,
JE,
JO,
JP,
KZ,
KE,
KG,
KH,
KI,
KN,
KR,
KW,
LA,
LB,
LR,
LY,
LC,
LI,
LK,
LS,
LT,
LU,
LV,
MO,
MF,
MA,
MC,
MD,
MG,
MV,
MX,
MH,
MK,
ML,
MT,
MM,
ME,
MN,
MP,
MZ,
MR,
MS,
MQ,
MU,
MW,
MY,
YT,
NA,
NC,
NE,
NF,
NG,
NI,
NU,
NL,
NO,
NP,
NR,
NZ,
OM,
PK,
PA,
PN,
PE,
PH,
PW,
PG,
PL,
PR,
KP,
PT,
PY,
PS,
PF,
QA,
RE,
RO,
RU,
RW,
SA,
SD,
SN,
SG,
GS,
SH,
SJ,
SB,
SL,
SV,
SM,
SO,
PM,
RS,
SS,
ST,
SR,
SK,
SI,
SE,
SZ,
SX,
SC,
SY,
TC,
TD,
TG,
TH,
TJ,
TK,
TM,
TL,
TO,
TT,
TN,
TR,
TV,
TW,
TZ,
UG,
UA,
UM,
UY,
US,
UZ,
VA,
VC,
VE,
VG,
VI,
VN,
VU,
WF,
WS,
YE,
ZA,
ZM,
ZW,
IC,
XK
Example:

"NL"

​
cursor
integer

If limit is set, the result is divided into pages, cursor allows you to iterate over these pages. Next and previous page urls are returned in the result as well.

​
limit
integer

Sets amount of results to be returned per page, if not set all results are returned.

Response

200 - application/json

OK

​
shipping_methods
Shipping Method Object · object[]
required

Array of available shipping methods.

Minimum array length: 1