Upload list of open hours

Request

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

Security

bearerAuth

Query

dryRunbooleanrequired

Only validate the request without storing the data

Example:dryRun=true

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_idstring

Organisation / Store ID. If omitted entry is treated as company default hours.

Example:"540"

start_datestringrequired

Start date of opening hour season (yyyy-mm-dd)

Example:"2024-01-01"

end_datestring

End date of opening hour season (yyyy-mm-dd)

Example:"2025-01-01"

weekdaynumberrequired

Weekday as integer (1 = Monday, 7 = Sunday)

Example:1

open_startstringrequired

Open start time (hh:mm:ss)

Example:"08:00:00"

open_endstringrequired

Open end time (hh:mm:ss)

Example:"15:00:00"

special_periodboolean

Is this a special opening period

Example:false

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/openHours?dryRun=true&separator=%3B&encoding=utf-8' \
  -H 'Authorization: Bearer <YOUR_token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "organisation_id": "540",
    "start_date": "2024-01-01",
    "end_date": "2025-01-01",
    "weekday": 1,
    "open_start": "08:00:00",
    "open_end": "15:00:00",
    "special_period": false,
    "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"
}