Skip to content

List of all price list details

Request

Using this endpoint, you can get list of all price list details with information on each price (like in Price list Detail endpoint) asynchronously. See how Asynchronous requests work on our developer’s portal.

Response will be in jsonlines format with each price list taking one line of output file.

One price list in response has the same format as price list detail response. See Price list snapshot schema for more details.

Result file is compressed using GZIP.

Security
shoptetAccessToken or shoptetPrivateApiToken
Path
idintegerrequired

Price list ID

Example:1
Query
codeFromstring

Export price list items with code after given value

Example:codeFrom=0000000006
codeTostring

Export price list items with code before given value

Example:codeTo=0000000006
actionPriceDateFromstring

Export price list items with active action price date after date

Example:actionPriceDateFrom=2019-09-05
actionPriceDateTostring

Export price list items with active action price before date

Example:actionPriceDateTo=2019-09-05
vatRatestring

Export price list items with given vat rate

Example:vatRate=21.0
currencyCodestring

Export price list items with given currency code

Example:currencyCode=CZK
orderableMinAmountnumber

Export price list items with orderable minimal amount

Example:orderableMinAmount=10
orderableMinAmountFromnumber

Export price list items with orderable minimal amount amount after given value

Example:orderableMinAmountFrom=10
orderableMinAmountTonumber

Export price list items with orderable minimal amount before given value

Example:orderableMinAmountTo=100
orderableMaxAmountnumber

Export price list items with orderable maximal amount

Example:orderableMaxAmount=20
orderableMaxAmountFromnumber

Export price list items with orderable maximal amount after given value

Example:orderableMaxAmountFrom=20
orderableMaxAmountTonumber

Export price list items with orderable maximal amount before given value

Example:orderableMaxAmountTo=200
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/pricelists/1/snapshot?codeFrom=0000000006&codeTo=0000000006&actionPriceDateFrom=2019-09-05&actionPriceDateTo=2019-09-05&vatRate=21.0&currencyCode=CZK&orderableMinAmount=10&orderableMinAmountFrom=10&orderableMinAmountTo=100&orderableMaxAmount=20&orderableMaxAmountFrom=20&orderableMaxAmountTo=200' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

Accepted

Bodyapplication/json
dataobject
errorsArray of objects or null(Errors)
metadataobject(Metadata)
Response
{
  "data": {
    "jobId": "ad24xod"
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}