Skip to content

Last updated

This end point allows you to send information about last update time stamps for different entities you send to Zoined.

After uploading entities you can post last update time stamp for each entity here, optionally on store level.

This information is used to report to end users when certain data set was last updated. Times should be posted in UTC time as they will be converted to user local time zone when presented in portal.

Similarly entity keys will be localized in user's selected language provided that correct key names are used.

Operations

Upload last updated time stamps

Request

POST https://api.zoined.com/updateTime?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:
entitystringrequired

Key of entity updated. Generally One of Zapi end point names in lower case eg. workshifts, sales, salessummaries, inventorysnapshots, visitors etc. Special key 'last_updated' can be used to send aggregated update time for all data sets.

Example:"workshifts"
organisation_idstring

Optional organisation unit this update refers to only

Example:"123"
last_updatedstringrequired

Last time stamp when entity was successfully updated

Example:"2019-08-21T02:25:31"
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/updateTime?dryRun=false&separator=%3B&encoding=utf-8' \
  -H 'Authorization: Bearer <YOUR_token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "entity": "workshifts",
    "organisation_id": "123",
    "last_updated": "2019-08-21T02:25:31",
    "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"
}