Skip to content

Shipping method detail

Request

Endpoint returns the detail of a single shipping method identified by its GUID.

Pricing and pricelist settings (price tiers by weight/price, per-country/region pricing and paired payment methods) are returned only when requested via the include=priceList query parameter.

Unlike the list endpoint (/api/shipping-methods, which can be filtered by salesChannelGuid), this detail endpoint is channel-agnostic: it returns the method by GUID regardless of sales channel. Pricing is defined per method, not per channel, so the returned pricelist is the same across channels.

Security
shoptetAccessToken or shoptetPrivateApiToken
Path
guidstringrequired

Unique identifier of the shipping method.

Example:b57f91bb-e920-11e0-baa3-7dc668b75ca8
Query
includestring

Comma-separated list of additional data to include in the response. Supported value: priceList.

Value:"priceList"
Example:include=priceList
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/shipping-methods/b57f91bb-e920-11e0-baa3-7dc668b75ca8?include=priceList' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
dataobjectrequired
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {
    "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
    "name": "Shipping company",
    "description": "Delivery within 48 hours",
    "shippingCompany": { … },
    "trackingUrl": "http://www.ppl.cz/main2.aspx?cls=Package&idSearch=#PACKAGE_NUMBER#",
    "visible": true,
    "priority": 16,
    "wholesale": true,
    "logoUrl": "https://www.example.com/logo.png",
    "priceList": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}