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. Pricing is defined per method, not per channel, so the returned pricelist is the same regardless of salesChannelGuid.

The visible field, like on the list endpoint (/api/shipping-methods), reflects sales-channel membership. When salesChannelGuid is omitted, visible is true if the method is attached to any of the project's sales channels; pass salesChannelGuid to scope it to one specific channel.

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
salesChannelGuidstring

Sales channel GUID. Optional parameter; if not provided, visible reflects membership in any of the project's sales channels.

Example:salesChannelGuid=0199bdfd-0979-71fb-85ce-e483c61d391b
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&salesChannelGuid=0199bdfd-0979-71fb-85ce-e483c61d391b' \
  -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",
    "salesChannelGuids": [ … ],
    "priceList": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}