Skip to content

Calendar

Custom calendar attributes can be used to define custom retail calendar like 4-4-5 etc. with year starting and ending at desirable dates. Supported attributes include year, period (month), season and week number.

Operations

Upload custom calendar attributes

Request

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

Calendar date (yyyy-mm-dd)

Example:"2016-01-01"
calendar_yearstring

Calendar year

Example:"2016/2017"
period_namestring

Period name

Example:"January"
period_numbernumber

Period number

Example:1
week_numbernumber

Week number

Example:1
seasonstring

Season name

Example:"Spring 2016"
season_labelstring

Season identifier

Example:"Spring"
lfl_datestring

Comparable sales date year ago (yyyy-mm-dd)

Example:"2014-12-30"
bank_holiday_namestring

Name of bank holiday if any

Example:"New year Day"
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/calendar?dryRun=false&separator=%3B&encoding=utf-8' \
  -H 'Authorization: Bearer <YOUR_token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "calendar_date": "2016-01-01",
    "calendar_year": "2016/2017",
    "period_name": "January",
    "period_number": 1,
    "week_number": 1,
    "season": "Spring 2016",
    "season_label": "Spring",
    "lfl_date": "2014-12-30",
    "bank_holiday_name": "New year Day",
    "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"
}