Documentation Powered by ReDoc

GoNOWマスターAPI (2.76.1-SNAPSHOT-1749533186586)

Download OpenAPI specification:Download

Authentication

tokenAuth

Security Scheme Type API Key
Header parameter name: X-API-Key

cookieAuth

Security Scheme Type API Key
Cookie parameter name: SESSION_ID

Batch

既存の住所とロケーションAPIの住所の整合性を取ることができる。

Request Body schema: application/json

EnsureAddressRequest

address
required
string non-empty

指定された住所

Responses

Request samples

Content type
application/json
{
  • "address": "string"
}

Response samples

Content type
application/json
{
  • "address": "string",
  • "result": "OK"
}

Amount Unit

数量単位を検索することができる。

Authorizations:
tokenAuthcookieAuth

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "amountUnits": [
    ],
  • "options": {
    }
}

Areas

配送エリアを検索して返す

Authorizations:
tokenAuthcookieAuth
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
name
string

エリア名

include
string

エリアに含める情報

order
string

ソート順

page
number

取得するページ。1から始まる。

pagesize
number

1ページあたりの項目数。指定しなければ1000

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "options": {
    },
  • "areas": [
    ]
}

配送エリアを作成します。

Authorizations:
tokenAuthcookieAuth
Request Body schema: application/json

AreaCreateBody

name
required
string non-empty

作成する配送エリアの名称

groupId
required
string non-empty

作成する配送エリアが紐づくグループのID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "groupId": "string"
}

Response samples

Content type
application/json
{
  • "area": {
    },
  • "result": "OK"
}

IDで指定した配送エリアを返します。

Authorizations:
tokenAuthcookieAuth
path Parameters
areaId
required
string
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
include
string

配送エリアに含める情報

Responses

Response samples

Content type
application/json
{
  • "area": {
    },
  • "users": [
    ],
  • "result": "OK",
  • "options": {
    }
}

配送エリアを更新します。

Authorizations:
tokenAuthcookieAuth
path Parameters
areaId
required
string
Request Body schema: application/json

AreaUpdateBody

name
required
string non-empty

配送エリアの名称

updatedAt
number

この配送エリアの最終更新時刻

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "updatedAt": 0
}

Response samples

Content type
application/json
{
  • "area": {
    },
  • "result": "OK"
}

配送エリアを削除します。

Authorizations:
tokenAuthcookieAuth
path Parameters
areaId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "result": "OK"
}

配送エリアに配送担当を設定する。

Authorizations:
tokenAuthcookieAuth
path Parameters
areaId
required
string
Request Body schema: application/json

DeliveryPersonPutToAreaBody

userId
required
string non-empty

配送員のユーザーID

Responses

Request samples

Content type
application/json
{
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "area": {
    },
  • "result": "OK"
}

エリアの配送担当を取得する

Authorizations:
tokenAuthcookieAuth
path Parameters
areaId
required
string
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "options": {
    },
  • "users": [
    ]
}

IDでエリアの営業曜日を返します。

Authorizations:
tokenAuthcookieAuth
path Parameters
areaId
required
string
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール

Responses

Response samples

Content type
application/json
{
  • "options": {
    },
  • "businessDays": [
    ],
  • "result": "OK"
}

IDでエリアの営業曜日を更新します。

Authorizations:
tokenAuthcookieAuth
path Parameters
areaId
required
string
Request Body schema: application/json

AreaUpdateBusinessDaysBody

businessDays
required
Array of numbers

曜日（0～6、日曜日が 0)

Responses

Request samples

Content type
application/json
{
  • "businessDays": [
    ]
}

Response samples

Content type
application/json
{
  • "businessDays": [
    ],
  • "result": "OK"
}

配送エリアから配送担当を外します。

Authorizations:
tokenAuthcookieAuth
path Parameters
areaId
required
string
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "areaId": "string",
  • "userId": "string",
  • "result": "OK"
}

Authorization

ログインします。

Request Body schema: application/json

LoginRequest

type
required
string non-empty
Enum: "mailAddress" "userCode"

ログイン方法の種類

mailAddress
string non-empty

Eメールアドレス

companyCode
string non-empty

会社コード

userCode
string non-empty

ユーザーコード

password
required
string non-empty

パスワード

include
string

要求する追加情報

with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール

Responses

Request samples

Content type
application/json
{
  • "type": "mailAddress",
  • "mailAddress": "string",
  • "companyCode": "string",
  • "userCode": "string",
  • "password": "string",
  • "include": "string",
  • "with": "string"
}

Response samples

Content type
application/json
{
  • "whoami": {
    },
  • "result": "OK",
  • "options": {
    }
}

現在の認証情報を確認します。

Authorizations:
tokenAuthcookieAuth

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "whoami": {
    }
}

ログアウトします。

Authorizations:
tokenAuthcookieAuth

Responses

Response samples

Content type
application/json
{
  • "whoami": {
    },
  • "result": "OK",
  • "options": {
    }
}

Delivery

配送エリアを分割します

Authorizations:
tokenAuthcookieAuth
Request Body schema: application/json

DivideAreaRequest

deliveredOn
number

配送日付

sourceDeliveryAreaIds
required
string non-empty

分割元エリアのIDのリスト

destinationDeliveryAreaIds
required
string non-empty

分割後エリアのIDのリスト

Responses

Request samples

Content type
application/json
{
  • "deliveredOn": 0,
  • "sourceDeliveryAreaIds": "string",
  • "destinationDeliveryAreaIds": "string"
}

Response samples

Content type
application/json
{
  • "deliveryPlans": [
    ],
  • "result": "OK"
}

配送カレンダーを返します。

検索条件に合致する配送カレンダーを返します。

Authorizations:
tokenAuthcookieAuth
query Parameters
from
string <date>
Example: from=2024-10-01

取得する配送カレンダーの開始日。この日を含む。デフォルトは今日の6日前。

to
string <date>
Example: to=2024-10-01

取得する配送カレンダーの終了日。デフォルトはfromの6日後。

deliveryAreaId
string

取得する配送カレンダーの配送エリアID。指定しない場合は全ての配送エリアを取得する。

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "calendars": [
    ],
  • "customers": [
    ],
  • "users": [
    ]
}

検索条件に該当する配送先を返します。

Authorizations:
tokenAuthcookieAuth
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
areaId
string

配送計画を取得するエリアのID

from
number

配送先を取得する期間の開始時刻(inclusive)。指定がない場合、

  • dateがあればその日
  • リクエストした日 の順で値を適用する。
to
number

配送先を取得する期間の終了時刻(inclusive)。指定がない場合、

  • dateがあればその日。
  • リクエストした日の7日後 の順で値を適用する。
date
number

配送先を取得する日付。

customerId
string

配送先になる顧客のID。

reserved
boolean

指定日配送かどうかを指定します。 trueのとき、指定日配送のみを取得します。 falseのとき、定期配送のみを取得します。 設定しない場合はすべての配送先を取得します。

shadow
boolean

影かどうかを指定します。 trueのとき、影のみを取得します。 falseのとき、影でないもののみを取得します。 設定しない場合はすべての配送先を取得します。

supplyLimitBefore
number

補給期限がこの値以前の配送先を取得します。

onlyNextDelivery
boolean

顧客ごとに指定した日付以降で最も小さい deliveredOnをもつ配送予定だけを返す

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "options": {
    },
  • "deliveryDestinations": [
    ]
}

配送先を作成します。

Authorizations:
tokenAuthcookieAuth
Request Body schema: application/json

DeliveryDestinationCreateBody

deliveryPlanId
string

配送先を関連付ける配送計画

date
number

配送日

deliveryAreaId
string

配送エリア

customerId
required
string non-empty

配送を行う顧客のID

isReserved
required
boolean

配送指定かどうか

description
string

備考

Responses

Request samples

Content type
application/json
{
  • "deliveryPlanId": "string",
  • "date": 0,
  • "deliveryAreaId": "string",
  • "customerId": "string",
  • "isReserved": true,
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "deliveryDestination": {
    }
}

配送先を更新します。

Authorizations:
tokenAuthcookieAuth
path Parameters
deliveryDestinationId
required
string
Request Body schema: application/json

DeliveryDestinationUpdateBody

deliveryPlanId
string

配送先を関連付ける配送計画

date
number

配送日

deliveryAreaId
string

配送エリア

description
string

備考

Responses

Request samples

Content type
application/json
{
  • "deliveryPlanId": "string",
  • "date": 0,
  • "deliveryAreaId": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "deliveryDestination": {
    }
}

配送先を削除します。

Authorizations:
tokenAuthcookieAuth
path Parameters
deliveryDestinationId
required
string

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "deliveryDestinationId": "string"
}

検索条件に該当する配送計画を返します。

Authorizations:
tokenAuthcookieAuth
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
areaId
string

配送計画を取得するエリアのID

from
number

配送計画を取得する期間の開始時刻(inclusive)。指定がない場合、

  • dateがあればその日
  • リクエストした日 の順で値を適用する。
to
number

配送計画を取得する期間の終了時刻(inclusive)。指定がない場合、

  • dateがあればその日。
  • リクエストした日の7日後 の順で値を適用する。
date
number

配送計画を取得する日付。

include
string

配送計画に含める情報。以下の項目をカンマ区切りで渡します。

  • delivery-report 各配送計画に対応する配送実績
  • delivery-destination 各配送計画の行き先
  • delivery-destination.detail 行き先の詳細情報。タンク及びタンク情報を取得する。
operatorId
string

配送計画を取得する担当者のID

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "options": {
    },
  • "deliveryPlans": [
    ]
}

IDで指定した配送計画を返します。

Authorizations:
tokenAuthcookieAuth
path Parameters
deliveryPlanId
required
string
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
include
string

配送計画に含める情報。以下の項目をカンマ区切りで渡します。

  • report 各配送計画に対応する配送実績
  • destination 各配送計画の行き先

Responses

Response samples

Content type
application/json
{
  • "deliveryPlan": {
    },
  • "result": "OK",
  • "options": {
    }
}

配送計画を更新します

Authorizations:
tokenAuthcookieAuth
path Parameters
deliveryPlanId
required
string
Request Body schema: application/json

DeliveryPlanUpdateBody

isOptimized
required
boolean

今の行き先にルート最適化が適用されたかどうか

isOrderDefined
required
boolean

今の行き先にユーザーによる順序定義が設定されたかどうか

operatorMemo
string

配送担当者から配送員への申し送りメモ

required
Array of objects (DeliveryPlanUpdateBodyDestination)

配送先

Responses

Request samples

Content type
application/json
{
  • "isOptimized": true,
  • "isOrderDefined": true,
  • "operatorMemo": "string",
  • "destinations": [
    ]
}

Response samples

Content type
application/json
{
  • "deliveryPlan": {
    },
  • "result": "OK"
}

IDで指定した配送計画を更新します。

Authorizations:
tokenAuthcookieAuth
path Parameters
deliveryPlanId
required
string
Request Body schema: application/json

DeliveryPlanPutOperatorBody

operatorId
required
string non-empty

担当ユーザーのID

Responses

Request samples

Content type
application/json
{
  • "operatorId": "string"
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "deliveryPlanId": "string",
  • "operatorId": "string"
}

配送計画に指定した配送先を追加します。

Authorizations:
tokenAuthcookieAuth
path Parameters
deliveryPlanId
required
string
Request Body schema: application/json

DeliveryDestinationPutToDeliveryPlanBody

id
string

計画を移動する行き先

updatedAt
number

行き先の最終更新時刻

customerId
string non-empty

行き先となる顧客

placeId
string non-empty

行き先となる場所

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "updatedAt": 0,
  • "customerId": "string",
  • "placeId": "string"
}

Response samples

Content type
application/json
{
  • "deliveryDestination": {
    },
  • "result": "OK"
}

配送実績を作成します。

Authorizations:
tokenAuthcookieAuth
Request Body schema: application/json

DeliveryReportResultCreateBody

deliveryReportId
required
string non-empty

実績を追加する日報のID

customerId
required
string non-empty

顧客ID

isDelivered
required
boolean

この実績で配送を実際にしたかどうか。 計画にあるにもかかわらず配送を行わなかった場合はfalse。

object (DeliveryReportResultCreateBodySupply)

補給

nextDeliveredOn
number

次回配送予定日

skipReason
string

配送を行わなかった場合、その理由

deliveryPersonMemo
string

配送員から配送担当者への申し送りメモ

Responses

Request samples

Content type
application/json
{
  • "deliveryReportId": "string",
  • "customerId": "string",
  • "isDelivered": true,
  • "supply": {
    },
  • "nextDeliveredOn": 0,
  • "skipReason": "string",
  • "deliveryPersonMemo": "string"
}

Response samples

Content type
application/json
{
  • "deliveryReportResult": {
    },
  • "result": "OK"
}

配送実績を更新します。

Authorizations:
tokenAuthcookieAuth
path Parameters
deliveryReportResultId
required
string
Request Body schema: application/json

DeliveryReportResultUpdateBody

customerId
required
string non-empty

顧客ID

isDelivered
required
boolean

この実績で配送を実際にしたかどうか。 計画にあるにもかかわらず配送を行わなかった場合はfalse。

object (DeliveryReportResultUpdateBodySupply)

補給

nextDeliveredOn
number

次回配送予定日

skipReason
string

配送を行わなかった場合、その理由

deliveryPersonMemo
string

配送員から配送担当者への申し送りメモ

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "isDelivered": true,
  • "supply": {
    },
  • "nextDeliveredOn": 0,
  • "skipReason": "string",
  • "deliveryPersonMemo": "string"
}

Response samples

Content type
application/json
{
  • "deliveryReportResult": {
    },
  • "result": "OK"
}

配送実績を削除します。

Authorizations:
tokenAuthcookieAuth
path Parameters
deliveryReportResultId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "result": "OK"
}

検索条件に該当する配送日報を返します。

Authorizations:
tokenAuthcookieAuth
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
include
string

配送日報の結果に含める情報

from
number

検索に含める配送日報の日付。設定しなければtoの7日前。

to
number

検索に含める配送日報の日付。設定しなければ今日。

date
number

検索に含める配送日報の日付。

deliveryAreaId
string

配送エリアのID

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "options": {
    },
  • "deliveryReports": [
    ]
}

配送日報を作成します。

Authorizations:
tokenAuthcookieAuth
Request Body schema: application/json

DeliveryReportCreateBody

deliveryAreaId
required
string non-empty

配送エリアのID

date
number

配送日報の日付

isApproved
boolean
Default: false

配送日報を承認するかどうか

required
Array of objects (DeliveryReportCreateBodyResult)

配送実績

Responses

Request samples

Content type
application/json
{
  • "deliveryAreaId": "string",
  • "date": 0,
  • "isApproved": false,
  • "results": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "deliveryReport": {
    }
}

IDで指定した配送日報を返します。

Authorizations:
tokenAuthcookieAuth
path Parameters
deliveryReportId
required
string
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
include
string

配送実績に含める情報

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "options": {
    },
  • "deliveryReport": {
    }
}

IDで指定した配送日報を更新します。

Authorizations:
tokenAuthcookieAuth
path Parameters
deliveryReportId
required
string
Request Body schema: application/json

DeliveryReportUpdateBody

isApproved
boolean
Default: false

配送日報を承認するかどうか

odometerStart
number <= 999999.9

一日の配送が始まる前にオドメーターが表示する走行距離

odometerEnd
number <= 999999.9

一日の配送が終わった後オドメーターが表示する走行距離

required
Array of objects (DeliveryReportUpdateBodyResult)

配送実績

Responses

Request samples

Content type
application/json
{
  • "isApproved": false,
  • "odometerStart": 999999.9,
  • "odometerEnd": 999999.9,
  • "results": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "deliveryReport": {
    }
}

IDで指定した配送日報のodometerStartを更新します。

Authorizations:
tokenAuthcookieAuth
path Parameters
deliveryReportId
required
string
Request Body schema: application/json

OdometerStartUpdateBody

odometerStart
string non-empty

配送が始まる前にオドメーターが表示する走行距離

Responses

Request samples

Content type
application/json
{
  • "odometerStart": "string"
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "deliveryReport": {
    }
}

IDで指定した配送日報のodometerEndを更新します。

Authorizations:
tokenAuthcookieAuth
path Parameters
deliveryReportId
required
string
Request Body schema: application/json

OdometerEndUpdateBody

odometerEnd
string non-empty

配送が終わった後オドメーターが表示する走行距離

Responses

Request samples

Content type
application/json
{
  • "odometerEnd": "string"
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "deliveryReport": {
    }
}

Car

検索条件に該当する車両を返します。

Authorizations:
tokenAuthcookieAuth
query Parameters
id
string

車両のID

name
string

車両の名称

code
string

車両のコード

groupId
string

グループID

Responses

Response samples

Content type
application/json
{
  • "cars": [
    ],
  • "result": "OK"
}

Company Config

会社設定を取得します。

Authorizations:
tokenAuthcookieAuth
path Parameters
companyConfigId
required
string

Responses

Response samples

Content type
application/json
{
  • "companyConfig": {
    },
  • "result": "OK"
}

会社設定を更新します。

Authorizations:
tokenAuthcookieAuth
path Parameters
companyConfigId
required
string
Request Body schema: application/json

CompanyConfigUpdateRequest

receiptTemplateId
string

伝票テンプレートのID。指定しない場合は変更されない。

updatedAt
number

会社設定を取得した時点の更新時刻

Responses

Request samples

Content type
application/json
{
  • "receiptTemplateId": "string",
  • "updatedAt": 0
}

Response samples

Content type
application/json
{
  • "companyConfig": {
    },
  • "result": "OK"
}

Contracts

契約を全件取得する

Authorizations:
tokenAuthcookieAuth
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
id
Array of strings

顧客ID

name
string

契約名 (部分一致)

address
string

住所 (部分一致)

code
string

契約コード (部分一致)

include
string

契約に含める情報

order
string

ソート順

page
number

取得するページ。1から始まる。

pagesize
number

1ページあたりの項目数。指定しなければ1000

Responses

Response samples

Content type
application/json
{
  • "contracts": [
    ],
  • "result": "OK",
  • "options": {
    },
  • "count": 0
}

契約を更新する

Authorizations:
tokenAuthcookieAuth
path Parameters
contractId
required
string
Request Body schema: application/json

ContractUpdateBody

code
string

契約コード

name
string

契約名

address
string

住所

tel
string

電話番号

mailAddress
string

メールアドレス

groupId
string

グループID

validFrom
required
number

この契約が有効になった日 (この日を含む)

validTo
number

この契約が無効になった日

updatedAt
required
number

契約を更新した時刻

companyId
string
Deprecated
customerId
string
Deprecated
customerCode
string
Deprecated

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "address": "string",
  • "tel": "string",
  • "mailAddress": "string",
  • "groupId": "string",
  • "validFrom": 0,
  • "validTo": 0,
  • "updatedAt": 0,
  • "companyId": "string",
  • "customerId": "string",
  • "customerCode": "string"
}

Response samples

Content type
application/json
{
  • "contract": {
    },
  • "result": "OK"
}

IDで指定した契約にタグを付与します。

Authorizations:
tokenAuthcookieAuth
path Parameters
contractId
required
string
Request Body schema: application/json

TagPutToContractBody

tagId
string

付与するタグをあらわすID

tagName
string

付与するタグの名称をあらわす文字列

tagColor
string

付与するタグの色をあらわす文字列

Responses

Request samples

Content type
application/json
{
  • "tagId": "string",
  • "tagName": "string",
  • "tagColor": "string"
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "contract": {
    }
}

Contract

契約を登録する

Authorizations:
tokenAuthcookieAuth
Request Body schema: application/json

ContractCreateBody

code
string

契約コード

name
string

契約名

address
string

住所

tel
string

電話番号

mailAddress
string

メールアドレス

groupId
string

グループID

validFrom
required
number

この契約が有効になった日 (この日を含む)

validTo
number

この契約が無効になった日

companyId
string
Deprecated
customerId
string
Deprecated
customerCode
string
Deprecated

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "address": "string",
  • "tel": "string",
  • "mailAddress": "string",
  • "groupId": "string",
  • "validFrom": 0,
  • "validTo": 0,
  • "companyId": "string",
  • "customerId": "string",
  • "customerCode": "string"
}

Response samples

Content type
application/json
{
  • "contract": {
    },
  • "result": "OK"
}

契約を1件取得する

Authorizations:
tokenAuthcookieAuth
path Parameters
contractId
required
string
query Parameters
include
string

契約に含める内容

with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール

Responses

Response samples

Content type
application/json
{
  • "contract": {
    },
  • "result": "OK",
  • "options": {
    }
}

契約を削除する

Authorizations:
tokenAuthcookieAuth
path Parameters
contractId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "result": "OK"
}

IDで指定した契約からタグを削除します。

Authorizations:
tokenAuthcookieAuth
path Parameters
contractId
required
string
tagIdOrName
required
string

Responses

Response samples

Content type
application/json
{
  • "result": "OK"
}

Customers

検索条件に該当する顧客を返します。

顧客を検索します。検索条件はすべてAND条件として扱われます。

Authorizations:
tokenAuthcookieAuth
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
page
number

取得するページ。1から始まる。

pagesize
number

1ページあたりの項目数。指定しなければ1000

groupId
string

顧客が含まれているグループ

areaId
string

顧客が含まれているエリアID

address
string

住所 (部分一致)

name
string

名称 (部分一致)

text
string

フリーワード。検索対象は住所、名称、電話番号、顧客番号とする。

tagName
string

顧客がもつタグの名称。完全一致

contractTypeId
string

契約種別ID

hasSensor
boolean

センサーの有無。センサーが取り付けられているタンクを1つでももつか。

untilForMargin
number

猶予の期限

include
string

顧客に含めるべき情報("delivery-destination" など)

deliveryDestinationIsReserved
boolean

指定配送のみを取得するかどうか

includeDescendants
boolean

指定したグループの下位グループに紐づく顧客を取得するかどうか

deliveryDestinationFrom
number

配送先情報の絞り込み: この日から

deliveryDestinationTo
number

配送先情報の絞り込み: この日まで

order
string
Enum: "code" "margin" "volume"

顧客の並び順。指定されない場合はcodeが指定されたものとする。

  • code 顧客コードの昇順
  • margin 猶予の昇順
  • volume 残量/容量の昇順
lat
number

緯度

lng
number

経度

distanceWithin
number

距離

code
string

顧客コード

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "options": {
    },
  • "count": 0,
  • "customers": [
    ]
}

顧客を作成します。

Authorizations:
tokenAuthcookieAuth
Request Body schema: application/json

CustomerCreateBody

contractId
string

契約ID

groupId
required
string non-empty

顧客を設定するグループ

deliveryAreaId
string

顧客の所属するエリア

customerType
string

顧客の紐づく分類

mailAddress
string

顧客のメールアドレス

polyTankCount
number >= 0

顧客のポリタンクの数

name
required
string non-empty

名称

code
required
string non-empty

コード

address
string

住所

tels
Array of strings

電話番号

description
string

備考

contractTypeId
required
string non-empty

この顧客の契約の種類ID

required
Array of objects (DeliveryPatternBody)

配送パターン

Responses

Request samples

Content type
application/json
{
  • "contractId": "string",
  • "groupId": "string",
  • "deliveryAreaId": "string",
  • "customerType": "string",
  • "mailAddress": "string",
  • "polyTankCount": 0,
  • "name": "string",
  • "code": "string",
  • "address": "string",
  • "tels": [
    ],
  • "description": "string",
  • "contractTypeId": "string",
  • "deliveryPatterns": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "customer": {
    }
}

IDで指定した顧客を返します。

Authorizations:
tokenAuthcookieAuth
path Parameters
customerId
required
string
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
include
string

顧客に含めるべき情報("delivery-destination" など)

deliveryDestinationIsReserved
boolean

指定配送のみを取得するかどうか

deliveryDestinationFrom
number

配送先情報の絞り込み: この日から

deliveryDestinationTo
number

配送先情報の絞り込み: この日まで

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "options": {
    },
  • "customer": {
    }
}

IDで指定した顧客を変更します。

Authorizations:
tokenAuthcookieAuth
path Parameters
customerId
required
string
Request Body schema: application/json

CustomerUpdateBody

name
required
string non-empty

名称

deliveryAreaId
string

顧客の所属するエリア

customerType
string

顧客の紐づく分類

mailAddress
string

顧客のメールアドレス

polyTankCount
number >= 0

顧客のポリタンクの数

code
required
string non-empty

コード

groupId
required
string non-empty

グループID

address
string

住所

tels
Array of strings

電話番号

description
string

備考

updatedAt
number

この顧客の最終更新時刻

contractTypeId
required
string non-empty

この顧客の契約の種類ID

required
Array of objects (DeliveryPatternBody)

配送パターン

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "deliveryAreaId": "string",
  • "customerType": "string",
  • "mailAddress": "string",
  • "polyTankCount": 0,
  • "code": "string",
  • "groupId": "string",
  • "address": "string",
  • "tels": [
    ],
  • "description": "string",
  • "updatedAt": 0,
  • "contractTypeId": "string",
  • "deliveryPatterns": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "customer": {
    }
}

IDで指定した顧客を削除します。

Authorizations:
tokenAuthcookieAuth
path Parameters
customerId
required
string

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "id": "string"
}

タンクのセンサーを交換する

Authorizations:
tokenAuthcookieAuth
path Parameters
customerId
required
string
tankId
required
string
query Parameters
dryrun
string

Responses

Response samples

Content type
application/json
{
  • "replace": {
    },
  • "result": "OK"
}

IDで指定した顧客にタグを付与します。

Authorizations:
tokenAuthcookieAuth
path Parameters
customerId
required
string
Request Body schema: application/json

TagPutToCustomerBody

tagId
string

付与するタグをあらわすID

tagName
string

付与するタグの名称をあらわす文字列

color
string

付与するタグの色をあらわす文字列

Responses

Request samples

Content type
application/json
{
  • "tagId": "string",
  • "tagName": "string",
  • "color": "string"
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "customer": {
    }
}

IDで指定した顧客からタグを削除します。

Authorizations:
tokenAuthcookieAuth
path Parameters
customerId
required
string
tagId
required
string

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "customer": "string"
}

Supplies

IDで指定した顧客の補給を返します。

Authorizations:
tokenAuthcookieAuth
path Parameters
customerId
required
string
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
from
number

検索期間(from)

to
number

検索期間(to)

Responses

Response samples

Content type
application/json
{
  • "supplies": [
    ],
  • "result": "OK",
  • "options": {
    },
  • "count": 0
}

給油情報を検索して取得する

Authorizations:
tokenAuthcookieAuth
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
areaId
string

エリアID (完全一致)

customerId
string

顧客ID (完全一致)

groupId
string

グループ(会社)ID (完全一致)

suppliedFrom
number

給油日時の検索対象期間 - この日時から

suppliedTo
number

給油日時の検索対象期間 - この日時まで

minAmount
string

給油量の検索 - この量以上

maxAmount
string

給油量の検索 - この量以下

include
string

契約に含める情報

order
string

ソート順

page
number

取得するページ。1から始まる。

pagesize
number

1ページあたりの項目数。指定しなければ1000

Responses

Response samples

Content type
application/json
{
  • "supplies": [
    ],
  • "result": "OK",
  • "options": {
    },
  • "count": 0
}

給油情報を登録する

Authorizations:
tokenAuthcookieAuth
Request Body schema: application/json

SupplyCreateBody

customerId
required
string non-empty

顧客ID

suppliedAt
number

給油日時

amount
required
string non-empty

給油量

productId
string

商品ID

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "suppliedAt": 0,
  • "amount": "string",
  • "productId": "string"
}

Response samples

Content type
application/json
{
  • "supply": {
    },
  • "result": "OK"
}

給油情報を更新する

Authorizations:
tokenAuthcookieAuth
path Parameters
supplyId
required
string
Request Body schema: application/json

SupplyUpdateBody

suppliedAt
number

給油日時

amount
required
string non-empty

給油量

Responses

Request samples

Content type
application/json
{
  • "suppliedAt": 0,
  • "amount": "string"
}

Response samples

Content type
application/json
{
  • "supply": {
    },
  • "result": "OK"
}

給油情報を削除する

Authorizations:
tokenAuthcookieAuth
path Parameters
supplyId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "result": "OK"
}

Tanks

顧客IDで指定した顧客が所有するタンクを返します。

Authorizations:
tokenAuthcookieAuth
path Parameters
customerId
required
string
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール

Responses

Response samples

Content type
application/json
{
  • "tanks": [
    ],
  • "result": "OK",
  • "options": {
    },
  • "count": 0
}

顧客IDとタンクIDで指定した顧客が所有するタンクを返します。

Authorizations:
tokenAuthcookieAuth
path Parameters
customerId
required
string
tankId
required
string
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
rangeFrom
number

期間開始

rangeTo
number

期間終了

include
string

追加情報

Responses

Response samples

Content type
application/json
{
  • "tank": {
    },
  • "result": "OK",
  • "options": {
    }
}

検索条件に該当するタンクを返します。

Authorizations:
tokenAuthcookieAuth
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
customerId
string

顧客ID

tankId
Array of strings

タンクID

areaId
string

エリアID

tankTypeId
string

タンクタイプID

minLegalCapacity
number

タンクの最小容量

maxLegalCapacity
number

タンクの最大容量

order
string

ソート順

include
string

タンクに含める情報。以下の項目をカンマ区切りで渡します。

  • customer このタンクを所有する顧客
  • sensor-replace タンクに設定されたセンサー
  • remaining-volume タンクの残量
remainingVolumeFrom
number

残量の検索期間開始

remainingVolumeTo
number

残量の検索期間終了

page
number

取得するページ。1から始まる。

pagesize
number

1ページあたりの項目数。指定しなければ1000

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "tanks": [
    ],
  • "options": {
    },
  • "count": 0
}

タンクを作成する

Authorizations:
tokenAuthcookieAuth
Request Body schema: application/json

TankCreateBody

customerId
required
string non-empty

顧客ID

name
string

タンク名

volumeThreshold
number

しきい値

description
string

備考

position
string

タンクの位置

purpose
string

タンクの使用目的

tankTypeId
required
string non-empty

タンクタイプID

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "name": "string",
  • "volumeThreshold": 0,
  • "description": "string",
  • "position": "string",
  • "purpose": "string",
  • "tankTypeId": "string"
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "tank": {
    }
}

センサー取り付け履歴を取得する。

Authorizations:
tokenAuthcookieAuth
path Parameters
tankId
required
string
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
include
string

センサーに含める情報。以下の項目をカンマ区切りで渡します。

  • records 対象のセンサーのレコード

Responses

Response samples

Content type
application/json
{
  • "options": {
    },
  • "sensorHistories": [
    ],
  • "result": "OK"
}

タンクにセンサーを取り付けます。

Authorizations:
tokenAuthcookieAuth
path Parameters
tankId
required
string
Request Body schema: application/json

SensorPutToTankBody

sensorId
required
string non-empty

センサーをあらわすID

validFrom
number

交換履歴の開始時刻

validTo
number

交換履歴の終了時刻

Responses

Request samples

Content type
application/json
{
  • "sensorId": "string",
  • "validFrom": 0,
  • "validTo": 0
}

Response samples

Content type
application/json
{
  • "sensorReplace": {
    },
  • "result": "OK"
}

タンクからセンサーを取り外します。

Authorizations:
tokenAuthcookieAuth
path Parameters
tankId
required
string

Responses

Response samples

Content type
application/json
{
  • "sensorReplace": {
    },
  • "result": "OK"
}

タンクを更新する

Authorizations:
tokenAuthcookieAuth
path Parameters
tankId
required
string
Request Body schema: application/json

TankUpdateBody

customerId
required
string non-empty

顧客ID

name
string

タンク名

volumeThreshold
number

しきい値

description
string

備考

position
string

タンクの位置

purpose
string

タンクの使用目的

tankTypeId
required
string non-empty

タンクタイプID

updatedAt
number

タンクを更新した時刻

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "name": "string",
  • "volumeThreshold": 0,
  • "description": "string",
  • "position": "string",
  • "purpose": "string",
  • "tankTypeId": "string",
  • "updatedAt": 0
}

Response samples

Content type
application/json
{
  • "tank": {
    },
  • "result": "OK"
}

タンクを削除する

Authorizations:
tokenAuthcookieAuth
path Parameters
tankId
required
string

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "tankId": "string"
}

センサー取り付け履歴を更新する

Authorizations:
tokenAuthcookieAuth
path Parameters
tankId
required
string
sensorReplaceId
required
string
Request Body schema: application/json

SensorReplaceUpdateBody

validFrom
number

この交換履歴の開始時刻

validTo
number

この交換履歴の終了時刻

sensorId
required
string non-empty

センサーID

updatedAt
number

センサー交換履歴を更新した時刻

Responses

Request samples

Content type
application/json
{
  • "validFrom": 0,
  • "validTo": 0,
  • "sensorId": "string",
  • "updatedAt": 0
}

Response samples

Content type
application/json
{
  • "sensorReplace": {
    },
  • "result": "OK"
}

センサー取り付け履歴を削除する

Authorizations:
tokenAuthcookieAuth
path Parameters
tankId
required
string
sensorReplaceId
required
string

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "sensorReplaceId": "string"
}

Receipt

指定した配送実績に紐づく最新の伝票を取得します。

Authorizations:
tokenAuthcookieAuth
path Parameters
deliveryReportResultId
required
string
query Parameters
format
required
string non-empty
Enum: "svg" "pdf"

伝票のフォーマット

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "receipt": "string",
  • "isBase64Encoded": true
}

伝票テンプレートを全て取得します。

Authorizations:
tokenAuthcookieAuth

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "templates": [
    ]
}

伝票テンプレートのSVGプレビューを取得します。

Authorizations:
tokenAuthcookieAuth
path Parameters
receiptTemplateId
required
string
query Parameters
receiptNo
required
string non-empty

伝票番号文字列

companyName
required
string non-empty

会社名

groupName
required
string non-empty

グループ名

groupTel
required
string non-empty

グループ電話番号

customerCode
required
string non-empty

顧客番号

customerName
required
string non-empty

顧客名

operatorName
required
string non-empty

担当者名

issuedAt
required
number

発行時刻

detailProductName
required
string non-empty

品名

detailAmount
required
number

数量

detailConsumptionTaxRate
required
number

消費税率

detailUnitPrice
required
number

単価

detailPriceIncludeTax
required
number

税込み価格

detailPriceExcludeTax
required
number

税別価格

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "svg": "string"
}

Groups

検索条件に該当するグループを返します。

Authorizations:
tokenAuthcookieAuth
query Parameters
name
string

グループ名 (部分一致)

typeId
string

グループ種別のID

include
string

グループに含める詳細情報。以下の文字列をカンマ区切りで指定します。

  • area グループがもつ配送エリア
order
string

ソート順

page
number

取得するページ。1から始まる。

pagesize
number

1ページあたりの項目数。指定しなければ1000

with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
onlyCompany
boolean

companyのみ取得する

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "options": {
    },
  • "count": 0,
  • "groups": [
    ]
}

グループを作成します。

Authorizations:
tokenAuthcookieAuth
Request Body schema: application/json

GroupCreateBody

groupTypeId
required
string non-empty

グループ種別ID

code
string >= 8 characters ^[a-z][-a-z0-9]+$

グループのコード

name
required
string non-empty

グループ名

address
string

住所

tel
string

電話番号

parentGroupId
required
string non-empty

親グループID

managerId
string

担当ユーザーのID

adminMailAddress
string

グループ管理者のメールアドレス。ルートを作成するときには必須。

adminPassword
string

グループ管理者のパスワード。ルートを作成するときには必須。

description
string

備考

Responses

Request samples

Content type
application/json
{
  • "groupTypeId": "string",
  • "code": "stringst",
  • "name": "string",
  • "address": "string",
  • "tel": "string",
  • "parentGroupId": "string",
  • "managerId": "string",
  • "adminMailAddress": "string",
  • "adminPassword": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "group": {
    }
}

IDで指定したグループを返します。

Authorizations:
tokenAuthcookieAuth
path Parameters
groupId
required
string
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
include
string

グループに含める情報

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "options": {
    },
  • "group": {
    }
}

IDで指定したグループを変更します。

Authorizations:
tokenAuthcookieAuth
path Parameters
groupId
required
string
Request Body schema: application/json

GroupUpdateBody

name
required
string non-empty

グループ名

address
string

住所

tel
string

電話番号

parentGroupId
string

親グループID

managerId
string

担当ユーザーID

deliveryLimit
number >= 1

1日の最大配送件数

description
string

備考

invoiceRegistrationNumber
string

適格請求書発行事業者登録番号

updatedAt
number

グループの最終更新時刻

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address": "string",
  • "tel": "string",
  • "parentGroupId": "string",
  • "managerId": "string",
  • "deliveryLimit": 1,
  • "description": "string",
  • "invoiceRegistrationNumber": "string",
  • "updatedAt": 0
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "group": {
    }
}

IDで指定したグループを削除します。

Authorizations:
tokenAuthcookieAuth
path Parameters
groupId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "result": "OK"
}

IDで指定したグループにおけるデータの取得元を設定します。

Authorizations:
tokenAuthcookieAuth
path Parameters
groupId
required
string
Request Body schema: application/json

PutDataSourceRequest

dataSourceCode
required
string non-empty
Enum: "the-touyu" "web-the-touyu" "yukinko" "none"

上流のシステムを指定します。以下の文字列から選びます。

  • the-touyu システムニーズ株式会社製「ザ･灯油」を使用している場合に指定します。
  • web-the-touyu システムニーズ株式会社製「Web-ザ･灯油」を使用している場合に指定します。
  • yukinko コンフィデンスソリューションシステムズ株式会社製「雪ん子」を使用している場合に指定します。
  • none 上流システムが存在しない場合に指定します。

ザ･灯油、Web-ザ･灯油はシステムニーズ株式会社の登録商標です。

Responses

Request samples

Content type
application/json
{
  • "dataSourceCode": "the-touyu"
}

Response samples

Content type
application/json
{
  • "fileConfigs": [
    ],
  • "result": "OK"
}

IDで指定したグループの設定を取得します。

Authorizations:
tokenAuthcookieAuth
path Parameters
groupId
required
string
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール

Responses

Response samples

Content type
application/json
{
  • "config": {
    },
  • "result": "OK",
  • "options": {
    }
}

IDで指定したグループにタグを設定します。

Authorizations:
tokenAuthcookieAuth
path Parameters
groupId
required
string
Request Body schema: application/json

TagPutToGroupBody

tagId
string

付与するタグをあらわすID

tagName
string

付与するタグの名称をあらわす文字列

tagColor
string

付与するタグの色をあらわす文字列

Responses

Request samples

Content type
application/json
{
  • "tagId": "string",
  • "tagName": "string",
  • "tagColor": "string"
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "group": {
    }
}

IDで指定したグループからタグを削除します。

Authorizations:
tokenAuthcookieAuth
path Parameters
groupId
required
string
tagIdOrName
required
string

Responses

Response samples

Content type
application/json
{
  • "result": "OK"
}

Others

Health check

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "result": "OK"
}

指定した選択項目を返します。

Authorizations:
tokenAuthcookieAuth
query Parameters
with
required
string non-empty

選択項目

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "contractTypes": [
    ],
  • "deliveryPatternTypes": [
    ],
  • "fileTypes": [
    ],
  • "groupTypes": [
    ],
  • "jobTypes": [
    ],
  • "placeTypes": [
    ],
  • "tankTypes": [
    ],
  • "deliveryAreas": [
    ],
  • "roles": [
    ],
  • "fileConfigs": [
    ],
  • "receiptTemplates": [
    ],
  • "consumptionTaxes": [
    ],
  • "roundingModes": [
    ],
  • "puttableRoles": [
    ]
}

Jobs

検索条件に該当するジョブを返します。

Authorizations:
tokenAuthcookieAuth
query Parameters
registeredFrom
number

この時刻以降に作られたジョブを検索対象にします。デフォルトはregisteredToの7日前。

registeredTo
number

この時刻以前に作られたジョブを検索対象にします。デフォルトは現在時刻。

status
string
Enum: "waiting" "running" "succeeded" "failed"

この状態をもつジョブを検索対象にします。デフォルトはすべての状態。

include
string

ジョブに含める情報を指定します。以下の項目のカンマ区切りで指定します。

  • message ジョブの実行に関するメッセージ
  • response-body ジョブの実行結果で生成されたファイル
order
string

ソート順。 フォーマットは item(:(asc|desc))?(,item(:asc|desc))* itemは以下の内容が指定できる。デフォルトはregisteredAt

  • registeredAt: 登録時刻
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
page
number

取得するページ。1から始まる。

pagesize
number

1ページあたりの項目数。指定しなければ1000

Responses

Response samples

Content type
application/json
{
  • "jobs": [
    ],
  • "result": "OK",
  • "options": {
    },
  • "count": 0
}

ジョブを作成します。

Authorizations:
tokenAuthcookieAuth
Request Body schema: application/json

JobCreateBody

jobTypeId
required
string non-empty

このリクエストで要求するジョブの種類

fileConfigId
string non-empty

このリクエストに含まれるファイルの解析に使用する設定

fileName
string

このリクエストに含まれるファイルの名前

body
string

このリクエストで要求するジョブに使用するファイルの内容をbase64でエンコードした文字列

suppliedFrom
number

このリクエストが補給登録の場合、登録する補給の開始日。この日を含みます。

suppliedTo
number

このリクエストが補給登録の場合、登録する補給の終了日。この日を含みます。

Responses

Request samples

Content type
application/json
{
  • "jobTypeId": "string",
  • "fileConfigId": "string",
  • "fileName": "string",
  • "body": "string",
  • "suppliedFrom": 0,
  • "suppliedTo": 0
}

Response samples

Content type
application/json
{
  • "job": {
    },
  • "result": "OK"
}

IDで指定したジョブを返します。

Authorizations:
tokenAuthcookieAuth
path Parameters
jobId
required
string
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
include
string

ジョブに含める情報を指定します。以下の項目のカンマ区切りで指定します。

  • message ジョブの実行に関するメッセージ
  • response-body ジョブの実行結果で生成されたファイル

Responses

Response samples

Content type
application/json
{
  • "job": {
    },
  • "result": "OK",
  • "options": {
    }
}

Payment Method

支払い方法を検索することができる。

Authorizations:
tokenAuthcookieAuth

Responses

Response samples

Content type
application/json
{
  • "paymentMethods": [
    ],
  • "result": "OK",
  • "options": {
    }
}

Places

場所を検索して返す

Authorizations:
tokenAuthcookieAuth
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
placeName
string

場所名。部分一致です。

placeTypeId
Array of strings

場所種別のID。複数ID指定できる。

areaId
Array of strings

場所と紐付けるエリアのID。複数ID指定できる。

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "options": {
    },
  • "places": [
    ]
}

IDで指定した場所にエリアを紐付けます。

Authorizations:
tokenAuthcookieAuth
path Parameters
placeId
required
string
Request Body schema: application/json

PlaceAssignPutToPlaceBody

areaId
required
string non-empty

紐付けるエリアをあらわすID

Responses

Request samples

Content type
application/json
{
  • "areaId": "string"
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "place": {
    }
}

場所からエリアを削除する。

Authorizations:
tokenAuthcookieAuth
path Parameters
placeId
required
string
areaId
required
string

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "placeId": "string",
  • "areaId": "string"
}

Price

価格を登録します。

Authorizations:
tokenAuthcookieAuth
Request Body schema: application/json

PriceCreateRequest

productId
required
string non-empty

品目のID

unitPrice
required
string non-empty

単価。0以上の数。

unitLabel
required
string non-empty

単価に使用する単位。

taxId
required
string non-empty

適用される消費税率のID

validFrom
required
number

この価格の適用開始時刻。この時刻を含む。

validTo
number

この価格の適用終了時刻。この時刻を含まない。設定されていない場合は無制限。

Responses

Request samples

Content type
application/json
{
  • "productId": "string",
  • "unitPrice": "string",
  • "unitLabel": "string",
  • "taxId": "string",
  • "validFrom": 0,
  • "validTo": 0
}

Response samples

Content type
application/json
{
  • "price": {
    },
  • "result": "OK"
}

価格を更新します。

Authorizations:
tokenAuthcookieAuth
path Parameters
priceId
required
string
Request Body schema: application/json

PriceUpdateRequest

unitPrice
required
string non-empty

単価。0以上の数。

unitLabel
required
string non-empty

単価に使用する単位。

taxId
required
string non-empty

適用される消費税率のID

validFrom
number

この価格の適用開始時刻。この時刻を含む。

validTo
number

この価格の適用終了時刻。この時刻を含まない。設定されていない場合は無制限。

updatedAt
number

価格を取得した時点での最終更新時刻。

Responses

Request samples

Content type
application/json
{
  • "unitPrice": "string",
  • "unitLabel": "string",
  • "taxId": "string",
  • "validFrom": 0,
  • "validTo": 0,
  • "updatedAt": 0
}

Response samples

Content type
application/json
{
  • "price": {
    },
  • "result": "OK"
}

価格を削除します。

Authorizations:
tokenAuthcookieAuth
path Parameters
priceId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "result": "OK"
}

Product

検索条件に該当する品目を返します。

Authorizations:
tokenAuthcookieAuth
query Parameters
page
number

取得するページ。1から始まる。

pagesize
number

1ページあたりの項目数。指定しなければ1000

Responses

Response samples

Content type
application/json
{
  • "products": [
    ],
  • "result": "OK"
}

品目を登録します。

Authorizations:
tokenAuthcookieAuth
Request Body schema: application/json

ProductCreateRequest

name
required
string non-empty

品目の名称

validFrom
required
number

品目の適用開始日。この日を含む。

validTo
number

品目の適用終了日。この日を含む。設定されていない場合は無制限。

groupId
required
string non-empty

この品目を登録するグループ

amountUnitId
required
string non-empty

この品目の数量単位

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "validFrom": 0,
  • "validTo": 0,
  • "groupId": "string",
  • "amountUnitId": "string"
}

Response samples

Content type
application/json
{
  • "product": {
    },
  • "result": "OK"
}

品目を返します。

Authorizations:
tokenAuthcookieAuth
path Parameters
productId
required
string

Responses

Response samples

Content type
application/json
{
  • "product": {
    },
  • "result": "OK"
}

品目を更新します。

Authorizations:
tokenAuthcookieAuth
path Parameters
productId
required
string
Request Body schema: application/json

ProductUpdateRequest

name
required
string non-empty

品目の名称

validFrom
required
number

品目の適用開始日。この日を含む。

validTo
number

品目の適用終了日。この日を含む。設定されていない場合は無制限。

updatedAt
required
number

品目を取得した時点での最終更新時刻。

amountUnitId
required
string non-empty

この品目の数量単位

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "validFrom": 0,
  • "validTo": 0,
  • "updatedAt": 0,
  • "amountUnitId": "string"
}

Response samples

Content type
application/json
{
  • "product": {
    },
  • "result": "OK"
}

品目を削除します。

Authorizations:
tokenAuthcookieAuth
path Parameters
productId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "result": "OK"
}

品目にタグを設定します。

Authorizations:
tokenAuthcookieAuth
path Parameters
productId
required
string
Request Body schema: application/json

TagPutToProductBody

tagId
string

付与するタグをあらわすID

tagName
string

付与するタグの名称をあらわす文字列

tagColor
string

付与するタグの色をあらわす文字列

Responses

Request samples

Content type
application/json
{
  • "tagId": "string",
  • "tagName": "string",
  • "tagColor": "string"
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "product": {
    }
}

品目からタグを削除します。

Authorizations:
tokenAuthcookieAuth
path Parameters
productId
required
string
tagIdOrName
required
string

Responses

Response samples

Content type
application/json
{
  • "result": "OK"
}

Sensors

センサー交換履歴を検索して返します。

Authorizations:
tokenAuthcookieAuth
query Parameters
id
Array of strings

センサー交換履歴のID

tankId
Array of strings

設置したタンクのID

sensorId
Array of strings

設置したセンサーのID

order
string

ソート順

include
string

検索結果に含める情報

with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
page
number

取得するページ。1から始まる。

pagesize
number

1ページあたりの項目数。指定しなければ1000

Responses

Response samples

Content type
application/json
{
  • "sensorReplaces": [
    ],
  • "result": "OK",
  • "options": {
    },
  • "count": 0
}

センサーを全件取得する

Authorizations:
tokenAuthcookieAuth
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
install
boolean

設置状況

serialNo
string

シリアルNo

order
string

ソート順

include
string

センサーに含める情報

addReplace
boolean
Default: false

交換履歴を追加

requestedReplaceDate
number

交換履歴の時刻

page
number

取得するページ。1から始まる。

pagesize
number

1ページあたりの項目数。指定しなければ1000

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "options": {
    },
  • "count": 0,
  • "sensors": [
    ]
}

センサーを1件取得する

Authorizations:
tokenAuthcookieAuth
path Parameters
sensorId
required
string
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
include
string

センサーに含める情報

Responses

Response samples

Content type
application/json
{
  • "sensor": {
    },
  • "result": "OK",
  • "options": {
    }
}

センサーのグループを更新します。

Authorizations:
tokenAuthcookieAuth
path Parameters
sensorId
required
string
Request Body schema: application/json

SensorUpdateGroupBody

groupId
required
string non-empty

グループID

updatedAt
required
number

更新時刻

Responses

Request samples

Content type
application/json
{
  • "groupId": "string",
  • "updatedAt": 0
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "id": "string"
}

Statistics

レイアウトを取得する

Authorizations:
tokenAuthcookieAuth

Responses

Response samples

Content type
application/json
{
  • "components": [
    ],
  • "result": "OK"
}

SupplyBases

補給所を作成します。

Authorizations:
tokenAuthcookieAuth
Request Body schema: application/json

SupplyBaseCreateBody

name
required
string non-empty

補給所の名称

address
required
string non-empty

補給所の住所

groupId
required
string non-empty

補給所と紐づくグループのID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address": "string",
  • "groupId": "string"
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "supplyBase": {
    }
}

補給所を更新します。

Authorizations:
tokenAuthcookieAuth
path Parameters
supplyBaseId
required
string
Request Body schema: application/json

SupplyBaseUpdateBody

name
required
string non-empty

補給所の名称

address
required
string non-empty

補給所の住所

updatedAt
number

補給所の最終更新時刻

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address": "string",
  • "updatedAt": 0
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "supplyBase": {
    }
}

補給所を削除します。

Authorizations:
tokenAuthcookieAuth
path Parameters
supplyBaseId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "result": "OK"
}

IDで指定した補給所にグループを付与します。

Authorizations:
tokenAuthcookieAuth
path Parameters
supplyBaseId
required
string
Request Body schema: application/json

GroupPutToSupplyBaseBody

groupId
required
string non-empty

紐づく対象グループのID

Responses

Request samples

Content type
application/json
{
  • "groupId": "string"
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "groupBase": {
    }
}

補給所とグループの紐づけを削除します。

Authorizations:
tokenAuthcookieAuth
path Parameters
supplyBaseId
required
string
groupId
required
string

Responses

Response samples

Content type
application/json
{
  • "groupId": "string",
  • "supplyBaseId": "string",
  • "result": "OK"
}

Tags

タグを作成する

Authorizations:
tokenAuthcookieAuth
Request Body schema: application/json

TagCreateBody

name
required
string non-empty

タグ名

color
string

タグ色

companyId
required
string non-empty

このタグを所有する会社のID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "color": "string",
  • "companyId": "string"
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "tag": {
    }
}

タグを検索する

Authorizations:
tokenAuthcookieAuth
query Parameters
name
string

タグに含まれる名称 (部分一致)

target
string
Enum: "contract" "customer" "group" "product" "user"

タグを設置するエンティティ

Responses

Response samples

Content type
application/json
{
  • "tags": [
    ],
  • "result": "OK",
  • "options": {
    }
}

Update tag

タグを更新します。

Authorizations:
tokenAuthcookieAuth
path Parameters
tagId
required
string
Request Body schema: application/json

TagUpdateBody

name
required
string non-empty

タグの名称

color
required
string non-empty ^#[A-Fa-f0-9]{6}$

タグの色

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "color": "string"
}

Response samples

Content type
application/json
{
  • "result": "OK"
}

TankType

タンクタイプを全件取得する

Authorizations:
tokenAuthcookieAuth
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
name
string

名称

makerName
string

メーカー名

volume
number

容量

order
string

ソート順

include
string

タンクタイプに含める情報

page
number

取得するページ。1から始まる。

pagesize
number

1ページあたりの項目数。指定しなければ1000

Responses

Response samples

Content type
application/json
{
  • "tankTypes": [
    ],
  • "result": "OK",
  • "options": {
    },
  • "count": 0
}

タンクタイプを作成する

Authorizations:
tokenAuthcookieAuth
Request Body schema: application/json

TankTypeCreateBody

code
required
string non-empty

タンクタイプコード

name
required
string non-empty

タンクタイプ名

makerName
required
string non-empty

メーカー名

description
string

備考

legalCapacity
required
string non-empty

容量

physicalCapacity
required
string non-empty

容積

defaultVolumeThreshold
required
string non-empty

デフォルトしきい値

defaultDeliveryFrequency
number

デフォルト配送頻度

height
required
string non-empty

高さ

defaultModuleHeight
required
string non-empty

デフォルトファームウェアでモジュールの高さ

c40ModuleHeight
required
string non-empty

C40ファームウェアでモジュールの高さ

c41ModuleHeight
required
string non-empty

C41ファームウェアでモジュールの高さ

c42ModuleHeight
required
string non-empty

C42ファームウェアでモジュールの高さ

c43ModuleHeight
required
string non-empty

C43ファームウェアでモジュールの高さ

c44ModuleHeight
required
string non-empty

C44ファームウェアでモジュールの高さ

required
object (TankVolumeCreateBody)

タンクの距離ごとの灯油量を作成するリクエスト

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "makerName": "string",
  • "description": "string",
  • "legalCapacity": "string",
  • "physicalCapacity": "string",
  • "defaultVolumeThreshold": "string",
  • "defaultDeliveryFrequency": 0,
  • "height": "string",
  • "defaultModuleHeight": "string",
  • "c40ModuleHeight": "string",
  • "c41ModuleHeight": "string",
  • "c42ModuleHeight": "string",
  • "c43ModuleHeight": "string",
  • "c44ModuleHeight": "string",
  • "tankVolumes": {
    }
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "tankTypeId": "string"
}

タンクタイプを1件取得する

Authorizations:
tokenAuthcookieAuth
path Parameters
tankTypeId
required
string
query Parameters
include
string

タンクタイプに含める情報

with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール

Responses

Response samples

Content type
application/json
{
  • "tankType": {
    },
  • "result": "OK",
  • "options": {
    }
}

タンクタイプを更新する

Authorizations:
tokenAuthcookieAuth
path Parameters
tankTypeId
required
string
Request Body schema: application/json

TankTypeUpdateBody

code
required
string non-empty

タンクタイプコード

name
required
string non-empty

タンクタイプ名

makerName
required
string non-empty

メーカー名

description
string

備考

legalCapacity
required
string non-empty

容量

physicalCapacity
required
string non-empty

容積

defaultVolumeThreshold
required
string non-empty

デフォルトしきい値

defaultDeliveryFrequency
number

デフォルト配送頻度

height
required
string non-empty

高さ

defaultModuleHeight
required
string non-empty

デフォルトファームウェアでモジュールの高さ

c40ModuleHeight
required
string non-empty

C40ファームウェアでモジュールの高さ

c41ModuleHeight
required
string non-empty

C41ファームウェアでモジュールの高さ

c42ModuleHeight
required
string non-empty

C42ファームウェアでモジュールの高さ

c43ModuleHeight
required
string non-empty

C43ファームウェアでモジュールの高さ

c44ModuleHeight
required
string non-empty

C44ファームウェアでモジュールの高さ

required
object (TankVolumeUpdateBody)

タンクの距離ごとの灯油量を作成するリクエスト

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "makerName": "string",
  • "description": "string",
  • "legalCapacity": "string",
  • "physicalCapacity": "string",
  • "defaultVolumeThreshold": "string",
  • "defaultDeliveryFrequency": 0,
  • "height": "string",
  • "defaultModuleHeight": "string",
  • "c40ModuleHeight": "string",
  • "c41ModuleHeight": "string",
  • "c42ModuleHeight": "string",
  • "c43ModuleHeight": "string",
  • "c44ModuleHeight": "string",
  • "tankVolumes": {
    }
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "tankTypeId": "string"
}

Users

ユーザーを全件取得する

Authorizations:
tokenAuthcookieAuth
query Parameters
with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール
name
string

ユーザー名 (部分一致)

include
string

ユーザーに含める情報

order
string

ソート順

page
number

取得するページ。1から始まる。

pagesize
number

1ページあたりの項目数。指定しなければ1000

Responses

Response samples

Content type
application/json
{
  • "users": [
    ],
  • "result": "OK",
  • "options": {
    },
  • "count": 0
}

ユーザーを登録する

Authorizations:
tokenAuthcookieAuth
Request Body schema: application/json

UserCreateBody

name
required
string non-empty

ユーザー名

mailAddress
string non-empty

メールアドレス

tel
string non-empty

電話番号

loginCode
string non-empty

ログイン用コード

password
required
string non-empty

パスワード

description
string

備考

groupId
required
string non-empty

このユーザーを登録するグループ

roleId
required
string non-empty

このユーザーのロール

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "mailAddress": "string",
  • "tel": "string",
  • "loginCode": "string",
  • "password": "string",
  • "description": "string",
  • "groupId": "string",
  • "roleId": "string"
}

Response samples

Content type
application/json
{
  • "user": {
    },
  • "result": "OK"
}

ユーザーを1件取得する

Authorizations:
tokenAuthcookieAuth
path Parameters
userId
required
string
query Parameters
include
string

ユーザーに含める情報

with
string

取得する選択項目を指定します。カンマ区切りで以下の項目を設定します。

  • contract-type 契約の種類
  • delivery-pattern-type 配送パターンの種類
  • file-type ファイルの種類
  • group-type グループの種類
  • job-type ジョブの種類
  • place-type 場所種別
  • tank-type タンクタイプ
  • delivery-area 配送エリア
  • role ロール

Responses

Response samples

Content type
application/json
{
  • "user": {
    },
  • "result": "OK",
  • "options": {
    }
}

ユーザーを更新する

Authorizations:
tokenAuthcookieAuth
path Parameters
userId
required
string
Request Body schema: application/json

UserUpdateBody

groupId
required
string non-empty

グループID

roleId
required
string non-empty

ロールID

name
required
string non-empty

ユーザー名

loginCode
string non-empty

ログインID

updatedAt
number

ユーザーを更新した時刻

mailAddress
string non-empty

メールアドレス

tel
string

電話番号

description
string

備考

Responses

Request samples

Content type
application/json
{
  • "groupId": "string",
  • "roleId": "string",
  • "name": "string",
  • "loginCode": "string",
  • "updatedAt": 0,
  • "mailAddress": "string",
  • "tel": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "user": {
    },
  • "result": "OK"
}

ユーザーを無効化する

Authorizations:
tokenAuthcookieAuth
path Parameters
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "result": "OK"
}

パスワードを更新する

Authorizations:
tokenAuthcookieAuth
path Parameters
userId
required
string
Request Body schema: application/json

PasswordUpdateBody

currentPassword
required
string non-empty

現在のパスワード

newPassword
required
string non-empty

新しいパスワード

updatedAt
number

ユーザーを更新した時刻

Responses

Request samples

Content type
application/json
{
  • "currentPassword": "string",
  • "newPassword": "string",
  • "updatedAt": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "result": "OK"
}

タグをユーザーに付与します。

Authorizations:
tokenAuthcookieAuth
path Parameters
userId
required
string
Request Body schema: application/json

TagPutToUserBody

tagId
string

付与するタグをあらわすID

tagName
string

付与するタグの名称をあらわす文字列

tagColor
string

付与するタグの色をあらわす文字列

Responses

Request samples

Content type
application/json
{
  • "tagId": "string",
  • "tagName": "string",
  • "tagColor": "string"
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "user": {
    }
}

タグをユーザーから削除します。

Authorizations:
tokenAuthcookieAuth
path Parameters
userId
required
string
tagIdOrName
required
string

Responses

Response samples

Content type
application/json
{
  • "result": "OK"
}