Shipping method ID | API reference

Basic information

GET /{shopId}/shipping-methods/{shippingMethodId}

Returns a specific shipping method of a shop identified by the provided shipping method Id.

Authorisation

OAuth 2.0 Token required with scopes:

products_read

URI parameters

Name	Type	Description
`shopId`	string	The unique identifier of the shop. Required: `true` Example: `DemoShop`
`shippingMethodId`	string	The unique identifier for the shipping method. Required: `true` Example: `52F221E0-36F6-DC4E-384A-AC1504050C04`

Query parameters

Name	Type	Description
`locale`	string	Represents the language code according to ISO 639-1 and the country code according to ISO 3166-1. If not provided, the shop’s default language is used. We recommend to always send this parameter with your request. If the default language had been changed in the administration, it might take up to 1 day until this change affects the shop. Required: `false` Example: `en_US`

Response attributes

Name	Type	Description
`shippingMethodId`	string	The unique identifier of the shipping method.
`name`	string	The name of the shipping method.
`description`	string	The description of the shipping method.
`logo`	string	The logo of the shipping method.
`price`	object of price	The costs for the shipping. If the costs for the shipping can differ, for example for weight-based shipping methods, the minimum costs will be returned.

Response

HTTP 200

Media type application/json

{
  "shippingMethodId": "5171DD86-C077-0726-C448-AC14145F9026",
  "name": "Standard delivery",
  "description": null,
  "logo": null,
  "price": {
    "taxType": "GROSS",
    "formatted": "7.00 €",
    "amount": 7,
    "currency": "EUR"
}