Skip to content

Product supplies in stock

Request

Returns the product supplies in stock for all products in a specific stock, contains GUID, code and quantity in stock for a specific product variant. It is possible to filter the specific GUID of a product, possibly a variant code. The endpoint supports Paging, in case of filtering, the amount of items per page increases. This endpoint supports optional parts using the include parameter (see Section on demand). The changeTime item is always temporarily returned, however as of 16. 3. 2019 only upon using the include parameter.

If you defined the include=changeTime parameter within the URL, the response will also contain the time when the last quantity in stock was changed.

Security
shoptetAccessToken or shoptetPrivateApiToken
Path
stockIdintegerrequired
Example:1
Query
productGuidstring
Example:productGuid=0023368f-d97b-11e0-b04f-57a43310b768
codestring
Example:code=26/BIL
onlyWithClaimboolean

whether only products with claim greater than 0 should be returned. Defaults to false

changedFromstring

return only product supplies, which amount has been changed since date value of this parameter.

It support maximum of 30 days in history. (optional, string). ISO 8601 format ("2017-12-12T22:08:01+0100"). Optional.

itemsPerPageinteger

Returned items per page. Default and max value is 1000.

Example:itemsPerPage=50
pageinteger

Page number to return. Default value is 1.

Example:page=3
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/stocks/1/supplies?productGuid=0023368f-d97b-11e0-b04f-57a43310b768&code=26%2FBIL&onlyWithClaim=true&changedFrom=string&itemsPerPage=50&page=3' \
  -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": {
    "supplies": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}