Skip to content

Price list detail

Request

The price list itself, not the prices in it. For those use /api/price-lists/{id}/prices.

isDefault marks the e-shop default price list, which is the only one where buyPrice is writable.

currency is the currency the price list is kept in; null means the e-shop default currency applies. Nothing in the e-shop reads it yet; it is recorded for the multishop work that will build on it.

salesChannels lists the channels the price list serves and which of them it is primary for. customerGroups lists the groups that have this price list as their default; it is read-only here and is set from the customer group side, via PATCH /api/customers/groups/{id}.

Security
shoptetAccessToken or shoptetPrivateApiToken
Path
idintegerrequired

Price list ID

Example:1
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/price-lists/1 \
  -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": {
    "priceList": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}