> ## Documentation Index
> Fetch the complete documentation index at: https://sendcloud.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Retrieve a shipping method
> Get information about a shipping method based on its `id` and your default sender address.
**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](/docs/getting-started/api-version-guide), or check out the [migration guide for API v3](/docs/getting-started/migration-guidelines-for-api-v3).
As described in the [Retrieve a list of shipping methods](/api/v2/shipping-methods/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.
## OpenAPI
````yaml /.openapi/v2/shipping-methods/openapi.yaml get /shipping_methods/{id}
openapi: 3.1.0
info:
title: Shipping methods
version: 2.0.0
description: >-
The Shipping methods API allows you to retrieve available shipping methods
for your Sendcloud account and get detailed information about each one.
contact:
name: Sendcloud API Support
url: https://www.sendcloud.dev
email: contact@sendcloud.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://panel.sendcloud.sc/api/v2
description: Sendcloud Production
security: []
tags:
- name: Shipping Methods
paths:
/shipping_methods/{id}:
parameters:
- schema:
type: integer
name: id
in: path
required: true
description: Shipping method id
get:
tags:
- Shipping Methods
summary: Retrieve a shipping method
description: >-
Get information about a shipping method based on its `id` and your
default sender address.
operationId: sc-public-v2-scp-get-shipping_method_by_id
parameters:
- schema:
type: string
in: query
name: sender_address
description: >-
The ID of the sender address for which you would like to know if the
given shipping method is available.
- schema:
type: integer
in: query
name: service_point_id
description: >-
The ID of the service point for which you would like to know if the
given shipping method is available.
- schema:
type: boolean
in: query
name: is_return
description: >-
If set to `true` the endpoint will return the shipping method only
if it is a return shipping method.
- schema:
type: string
maxLength: 12
example: '01000'
in: query
name: from_postal_code
description: Postal code of the sender.
- schema:
type: string
maxLength: 12
example: '01000'
in: query
description: Postal code of the recipient.
name: to_postal_code
- schema:
$ref: '#/components/schemas/country-codes'
in: query
name: to_country
description: A country ISO 2 code for the recipient country.
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
shipping_method:
$ref: '#/components/schemas/shipping-method'
examples:
RetrieveShippingMethod:
summary: Retrieve a shipping method
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
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
request:
type: string
code:
type: integer
message:
type: string
examples:
NotFound:
summary: Not Found
value:
error:
request: api/v2/shipping_methods/0
code: 404
message: Not found.
security:
- HTTPBasicAuth: []
- OAuth2ClientCreds: []
components:
schemas:
country-codes:
type: string
title: Country Code Object
enum:
- 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
description: A country represented by its ISO 3166-1 alpha-2 code
example: NL
shipping-method:
title: Shipping Method Object
description: A Sendcloud shipping method
type: object
properties:
id:
type: integer
minimum: 1
description: Unique identifier of the shipping method.
format: int64
name:
type: string
minLength: 1
description: >-
Name of the shipping method, it should give an idea what the
shipping method can be used for.
carrier:
type: string
minLength: 1
description: >-
A `carrier_code` which will indicate which carrier provides the
shipping method.
min_weight:
type: string
minLength: 5
description: Minimum allowed weight of the parcel for this shipping method.
max_weight:
type: string
minLength: 5
description: Maximum allowed weight of the parcel for this shipping method.
service_point_input:
type: string
minLength: 1
enum:
- required
- none
description: >-
Will be either `required` when the shipping method is meant to ship
a parcel to a service point, or `none` when this is not the case.
price:
type: integer
description: A legacy property which will always be `0`, should not be used!
format: int64
minimum: 0
maximum: 0
deprecated: true
countries:
type: array
description: A list of countries that you can ship to with the shipping method.
items:
type: object
properties:
id:
type: integer
format: int64
minimum: 1
description: Countries that you can ship to with the shipping method.
name:
type: string
description: Name of the country.
price:
type: number
description: >-
Indicates what it will cost to use the shipping method. Will
be 0 if the user has enabled a direct contract for
corresponding the carrier.
iso_2:
type: string
minLength: 2
maxLength: 2
example: NL
description: ISO 3166-1 alpha-2 code of the country.
iso_3:
type: string
example: NLD
minLength: 3
maxLength: 3
description: ISO 3166-1 alpha-3 code of the country.
lead_time_hours:
type: integer
description: Lead time of the shipping method in hours
nullable: true
price_breakdown:
$ref: '#/components/schemas/shipping-price-breakdown'
required:
- id
- name
- carrier
- min_weight
- max_weight
- service_point_input
- price
shipping-price-breakdown:
title: Shipping Price Breakdown Object
description: A Sendcloud shipping price breakdown.
type: array
items:
type: object
properties:
type:
type: string
example: price_without_insurance
description: Type of the price. It is an identifier of category of the price.
label:
type: string
example: Initial price per parcel
description: >-
This label is a friendly name for type of the price type and can
be used to represent it.
value:
type: number
format: float
example: 6.4
description: Price amount of the breakdown item.
securitySchemes:
HTTPBasicAuth:
type: http
description: >-
Basic Authentication using API key and secrets is currently the main
authentication mechanism.
scheme: basic
OAuth2ClientCreds:
type: oauth2
description: >-
OAuth2 is a standardized protocol for authorization that allows users to
share their private resources stored on one site with another site
without having to provide their credentials. OAuth2 Client Credentials
Grant workflow. This workflow is typically used for server-to-server
interactions that require authorization to access specific resources.
flows:
clientCredentials:
tokenUrl: https://account.sendcloud.com/oauth2/token/
scopes:
api: Default OAuth scope required to access Sendcloud API.
````