Skip to content

Inventory snapshots

Returns list of inventory snapshots in the system. Returned data can be limited with start and end query parameters.

Operations

Download inventory snapshots as JSON

Request

GET https://api.zoined.com/v2/download/inventorySnapshots.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31

Security
bearerAuth
Query
limitnumber

How many entries to return

Example:limit=1000
offsetnumber

Which offset to return data from

Example:offset=0
startstring

Return data starting from given date

Example:start=2017-01-01
endstring

Return data ending to given date

Example:end=2017-01-31
curl -i -X GET \
  'https://zapi-api.zoined.com/_mock/v2/download/inventorySnapshots.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
organisation_idstringrequired

Organisation / Store ID

Example:"540"
snapshot_datestringrequired

Date of snapshot (yyyy-mm-dd)

Example:"2016-01-01"
snapshot_timestring

Time of snapshot (HH:mm:ss). Needed if inter-day inventory saldos are tracked.

Example:"15:00:00"
product_idstringrequired

Product ID

Example:"My product ID"
supplier_idstring

Supplier ID

Example:"221"
quantitynumberrequired

On hand quantity in inventory

Example:100
available_quantitynumber

Available quantity in inventory (after pending/reserved orders)

Example:90
reorder_pointnumber

Quantity threshold for this item to order more into inventory

Example:5
max_reorder_quantitynumber

Max quantity threshold for this item after reordering

Example:10
unit_purchase_pricenumber

Unit purchase price

Example:12.4
unit_purchase_price_wo_vatnumber

Unit purchase price without tax

Example:10
unit_sales_pricenumber

Unit sales price

Example:22.4
unit_sales_price_wo_vatnumber

Unit sales price without tax

Example:20
currencystring

Currency for the purchase price as ISO 4217 currency code. Required if multiple currencies are used.

Example:"EUR"
Response
{
  "organisation_id": "540",
  "snapshot_date": "2016-01-01",
  "snapshot_time": "15:00:00",
  "product_id": "My product ID",
  "supplier_id": "221",
  "quantity": 100,
  "available_quantity": 90,
  "reorder_point": 5,
  "max_reorder_quantity": 10,
  "unit_purchase_price": 12.4,
  "unit_purchase_price_wo_vat": 10,
  "unit_sales_price": 22.4,
  "unit_sales_price_wo_vat": 20,
  "currency": "EUR"
}