Skip to content

Inventory snapshots

Inventory snapshots are used to provide product inventory saldo at specific point of time.

Operations

Upload list of inventory snapshots

Request

POST https://api.zoined.com/inventorySnapshots?dryRun=false&separator=%3B&encoding=utf-8

Security
bearerAuth
Query
dryRunbooleanrequired

Only validate the request without storing the data

Example:dryRun=false
separatorstringrequired

Column separator used when loading CSV data

Example:separator=;
encodingstringrequired

Character encoding used in the CSV data (default is utf-8)

Example:encoding=utf-8
Body
Any of:
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"
source_systemstring

Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.

Example:"ABCDEF"
curl -i -X POST \
  'https://zapi-api.zoined.com/_mock/inventorySnapshots?dryRun=false&separator=%3B&encoding=utf-8' \
  -H 'Authorization: Bearer <YOUR_token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "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",
    "source_system": "ABCDEF"
  }'

Responses

Request has been processed successfully.

Headers

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

Status of the operation OK / Not OK

Example:"OK"
msgstringrequired

Message describing result of operation

Example:"1 entity added"
Response
{
  "status": "OK",
  "msg": "1 entity added"
}