コンテンツにスキップ
スマレジ・プラットフォームAPI 仕様書

勤怠登録

POST
/shifts/{store_id}/{staff_id}

勤怠を登録します

対象

  • プラン
    • プレミアム
    • プレミアムプラス
    • エンタープライズ、旧有料

対象ユーザー権限

  • シフト編集
  • 実績編集

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
staff_id
required
string

従業員ID

Example
1
store_id
required
string

事業所ID

Example
1

Request Body

Section titled “Request Body ”
object
One of:
勤務パターンによる登録
object
shiftDate
required

シフト/実績日 [YYYY-MM-DD]

string format: date
division
required

シフト/実績区分

  • schedule: シフト
  • result: 実績
string
Allowed values: schedule result
shiftPatternId
required

勤務パターンID

string
Examples

勤務パターンによる登録

{
  "shiftDate": "2019-08-24",
  "division": "schedule",
  "shiftPatternId": "1"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

登録成功

勤怠
object
shiftResultId

シフト実績ID

string
shiftDate

シフト/実績日 [YYYY-MM-DD]

string format: date
division

シフト/実績区分

  • schedule: シフト
  • result: 実績
string
Allowed values: schedule result
storeId

事業所ID

string
staffId

従業員ID

string
attendance

出勤時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time
leaving

退勤時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time
breakStartTime1

休憩1 開始時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time
nullable
breakEndTime1

休憩1 終了時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time
nullable
breakStartTime2

休憩2 開始時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time
nullable
breakEndTime2

休憩2 終了時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time
nullable
tardyFlag

遅刻の有無

  • 0: 遅刻なし
  • 1: 遅刻あり
string
Allowed values: 0 1
earlyLeavingFlag

早退の有無

  • 0: 早退なし
  • 1: 早退あり
string
Allowed values: 0 1 
{
  "shiftResultId": "123",
  "shiftDate": "2020-05-01",
  "division": "result",
  "storeId": "1",
  "staffId": "1",
  "attendance": "2020-05-01T09:00:00+09:00",
  "leaving": "2020-05-01T18:00:00+09:00",
  "breakStartTime1": "2020-05-01T12:00:00+09:00",
  "breakEndTime1": "2020-05-01T13:00:00+09:00",
  "breakStartTime2": "2020-05-01T14:00:00+09:00",
  "breakEndTime2": "2020-05-01T15:00:00+09:00",
  "tardyFlag": "1",
  "earlyLeavingFlag": "1"
}

400

Section titled “400 ”
  • 登録に失敗した場合
  • 勤務パターンと勤務時間を同時に指定した場合
  • 事業所に従業員が所属していない場合
  • 勤務時間が重複している場合（実績のみ）
  • 出勤データが既に存在している場合
  • 事務所に紐づかない勤務パターンIDを指定した場合
object
type

エラータイプを識別するURI、もしくはabout:blank

string
title

エラーの概要

string
detail

エラーの詳細

string
Example
{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "[スマレジ太郎]:勤務時間が重複しています。"
}

404

Section titled “404 ”
  • 指定したIDのデータが存在しない場合
object
type

エラータイプを識別するURI、もしくはabout:blank

string
title

エラーの概要

string
detail

エラーの詳細

string
Example
{
  "type": "about:blank",
  "title": "Not Found",
  "detail": "事業所が存在しません"
}