Skip to content

Shipping methods

Managing shipping methods in the e-shop.

Operations

List of shipping methods

Request

Endpoint returns a list of all available shipping methods and details of their settings. Does not use paging,

it always returns all methods at once.

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
salesChannelGuidstring

Sales channel GUID. Optional parameter, if not provided, all shipping methods will be returned.

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?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": {
    "shippingMethods": [ … ],
    "wholesaleActive": true,
    "wholesaleSplitActive": true,
    "defaultRetailMethod": "b57f91bb-e920-11e0-baa3-7dc668b75ca8",
    "defaultWholesaleMethod": "b57f91bb-e920-11e0-baa3-7dc668b75ca8"
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}