Retrieve a shipping method

GET {{baseUrl}}/shipping_methods/:id?sender_address=<string>&service_point_id=<integer>&is_return=<boolean>&from_postal_code=<string>&to_postal_code=<string>&to_country=IO

This endpoint will return information about a shipping method based on the provided shipping method id and your default sender address.

As described in Retrieve a list of shipping methods, 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 to_country, from_postal_code and to_postal_code query parameters.

Example:

GET https://panel.sendcloud.sc/api/v2/shipping_methods/365?sender_address=102964

{
    "shipping_method": {
        "id": 365,
        "name": "Colissimo Service Point 0.75-1kg",
        "carrier": "colissimo",
        "min_weight": "0.751",
        "max_weight": "1.001",
        "service_point_input": "required",
        "price": 0,
        "countries": [

Request Params

HEADERS

RESPONSES

status: OK

{"shipping_method":{"id":"\u003clong\u003e","name":"\u003cstring\u003e","carrier":"\u003cstring\u003e","min_weight":"\u003cstring\u003e","max_weight":"\u003cstring\u003e","service_point_input":"none","price":"\u003clong\u003e","countries":[{"id":"\u003clong\u003e","name":"\u003cstring\u003e","price":"\u003cnumber\u003e","iso_2":"\u003cstring\u003e","iso_3":"\u003cstring\u003e","lead_time_hours":"\u003cinteger\u003e","price_breakdown":[{"type":"\u003cstring\u003e","label":"\u003cstring\u003e","value":"\u003cfloat\u003e"},{"type":"\u003cstring\u003e","label":"\u003cstring\u003e","value":"\u003cfloat\u003e"}]},{"id":"\u003clong\u003e","name":"\u003cstring\u003e","price":"\u003cnumber\u003e","iso_2":"\u003cstring\u003e","iso_3":"\u003cstring\u003e","lead_time_hours":"\u003cinteger\u003e","price_breakdown":[{"type":"\u003cstring\u003e","label":"\u003cstring\u003e","value":"\u003cfloat\u003e"},{"type":"\u003cstring\u003e","label":"\u003cstring\u003e","value":"\u003cfloat\u003e"}]}]}}