Skip to main content
GET
/
shipping_methods
/
{id}
Retrieve a shipping method
curl --request GET \
  --url https://panel.sendcloud.sc/api/v2/shipping_methods/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "shipping_method": {
    "id": 117,
    "name": "DHLForYou Drop Off",
    "carrier": "dhl",
    "min_weight": "0.001",
    "max_weight": "20.000",
    "service_point_input": "none",
    "price": 0,
    "countries": [
      {
        "id": 1,
        "name": "Belgium",
        "price": 7.9,
        "iso_2": "BE",
        "iso_3": "BEL",
        "lead_time_hours": 24
      },
      {
        "id": 2,
        "name": "Netherlands",
        "price": 5.2,
        "iso_2": "NL",
        "iso_3": "NLD",
        "lead_time_hours": 24
      }
    ]
  }
}
API v2 is entering maintenance mode. New users should start with API v3 to access our latest features and improved performance. Already using v2? Don’t worry, your current integration remains fully functional. Read more about maintenance mode, or check out the migration guide for API v3.
As described in the Retrieve a list of shipping methods endpoint, to retrieve information about a shipping method which operates in a different country than your default sender address, provide a different sender_address id.
To see zonal carrier shipping methods, you need to provide the to_country, from_postal_code and to_postal_code query parameters.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
integer
required

Shipping method id

Query Parameters

​
sender_address
string

The ID of the sender address for which you would like to know if the given shipping method is available.

​
service_point_id
integer

The ID of the service point for which you would like to know if the given shipping method is available.

​
is_return
boolean

If set to true the endpoint will return the shipping method only if it is a return shipping method.

​
from_postal_code
string

Postal code of the sender.

Maximum string length: 12
Example:

"01000"

​
to_postal_code
string

Postal code of the recipient.

Maximum string length: 12
Example:

"01000"

​
to_country
enum<string>

A country ISO 2 code for the recipient country. 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"

Response

OK

​
shipping_method
Shipping Method Object · object

A Sendcloud shipping method