Keiz! Admin API (1.0.0)

Download OpenAPI specification:

Cars

Cars_list

Authorizations:
BearerAuth
query Parameters
filter
string
Enum: "lined_up" "recommended"

Responses

Response samples

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

Cars_create

Authorizations:
BearerAuth
Request Body schema: application/json
required
manufacturer_id
required
string <uuid>

メーカー; Choice ID

brand_name
required
string

車種名

grade_name
required
string

グレード名

body_type_id
required
string <uuid>

ボディタイプ; Choice ID

color_id
required
string <uuid>

ボディカラー; Choice ID

passengers
required
integer <uint32>

乗車定員

doors
required
integer <uint32>

ドア数

handle_position_id
required
string <uuid>

ハンドル位置; Choice ID

displacement
required
integer <uint32>

排気量 (cc)

driving_wheels_type_id
required
string <uuid>

駆動方式; Choice ID

transmission_type_id
required
string <uuid>

トランスミッション; Choice ID

fuel_type_id
required
string <uuid>

燃料; Choice ID

accessory_ids
required
Array of strings <uuid> (Foundation.uuid) [ items <uuid > ]

装備; Choice IDs

mileage
required
integer <uint32>

走行距離 (km)

required
object

修復歴

car_history_id
required
string <uuid>

車歴; Choice ID

required
object

登録情報

required
object

コスト

required
object

価格

required
object

アフターサービス

required
object

Webサイト情報

Responses

Request samples

Content type
application/json
{
  • "manufacturer_id": "cafecd41-5060-405f-a23d-b38c40f09e3f",
  • "brand_name": "string",
  • "grade_name": "string",
  • "body_type_id": "e53c3a59-debf-443b-b7fc-7a67b5a3cdb5",
  • "color_id": "3333830f-d3ea-47f8-a24d-3e8d3a1050d5",
  • "passengers": 0,
  • "doors": 0,
  • "handle_position_id": "c176b18e-7dd4-49ad-816a-a06b68c264f5",
  • "displacement": 0,
  • "driving_wheels_type_id": "12f50d63-7132-4dc6-babc-38b04d7de846",
  • "transmission_type_id": "33e549e9-2046-4055-8294-504875595292",
  • "fuel_type_id": "e1c7820e-d0b6-4e24-8620-1de479387438",
  • "accessory_ids": [
    ],
  • "mileage": 0,
  • "repair_history": {
    },
  • "car_history_id": "e47e4107-b6c3-4fc0-8057-517069d6f630",
  • "registration": {
    },
  • "cost": {
    },
  • "price": {
    },
  • "after_service": {
    },
  • "website": {
    }
}

Response samples

Content type
application/json
{
  • "car": {
    }
}

Cars_detail

Authorizations:
BearerAuth
path Parameters
carId
required
string <uuid> (Foundation.uuid)

Responses

Response samples

Content type
application/json
{
  • "car": {
    }
}

Cars_update

Authorizations:
BearerAuth
path Parameters
carId
required
string <uuid> (Foundation.uuid)
Request Body schema: application/json
required
manufacturer_id
string <uuid>

メーカー; Choice ID

brand_name
string

車種名

grade_name
string

グレード名

body_type_id
string <uuid>

ボディタイプ; Choice ID

color_id
string <uuid>

ボディカラー; Choice ID

passengers
integer <uint32>

乗車定員

doors
integer <uint32>

ドア数

handle_position_id
string <uuid>

ハンドル位置; Choice ID

displacement
integer <uint32>

排気量 (cc)

driving_wheels_type_id
string <uuid>

駆動方式; Choice ID

transmission_type_id
string <uuid>

トランスミッション; Choice ID

fuel_type_id
string <uuid>

燃料; Choice ID

accessory_ids
Array of strings <uuid> (Foundation.uuid) [ items <uuid > ]

装備; Choice IDs

mileage
integer <uint32>

走行距離 (km)

object

修復歴

car_history_id
string <uuid>

車歴; Choice ID

object

登録情報

object

コスト

object

アフターサービス

object

Webサイト情報

Responses

Request samples

Content type
application/json
{
  • "manufacturer_id": "cafecd41-5060-405f-a23d-b38c40f09e3f",
  • "brand_name": "string",
  • "grade_name": "string",
  • "body_type_id": "e53c3a59-debf-443b-b7fc-7a67b5a3cdb5",
  • "color_id": "3333830f-d3ea-47f8-a24d-3e8d3a1050d5",
  • "passengers": 0,
  • "doors": 0,
  • "handle_position_id": "c176b18e-7dd4-49ad-816a-a06b68c264f5",
  • "displacement": 0,
  • "driving_wheels_type_id": "12f50d63-7132-4dc6-babc-38b04d7de846",
  • "transmission_type_id": "33e549e9-2046-4055-8294-504875595292",
  • "fuel_type_id": "e1c7820e-d0b6-4e24-8620-1de479387438",
  • "accessory_ids": [
    ],
  • "mileage": 0,
  • "repair_history": {
    },
  • "car_history_id": "e47e4107-b6c3-4fc0-8057-517069d6f630",
  • "registration": {
    },
  • "cost": {
    },
  • "after_service": {
    },
  • "website": {
    }
}

Response samples

Content type
application/json
{
  • "car": {
    }
}

Cars_delete

Authorizations:
BearerAuth
path Parameters
carId
required
string <uuid> (Foundation.uuid)

Responses

Sold_sold

Authorizations:
BearerAuth
path Parameters
carId
required
string <uuid> (Foundation.uuid)
query Parameters
sold
required
boolean

Responses

Response samples

Content type
application/json
{
  • "car": {
    }
}

Images

Images_list

Authorizations:
BearerAuth
path Parameters
carId
required
string <uuid> (Foundation.uuid)

Responses

Response samples

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

Images_create

Authorizations:
BearerAuth
path Parameters
carId
required
string <uuid> (Foundation.uuid)
Request Body schema: application/json
required
display_order
required
integer <uint32>
is_public
required
boolean

Responses

Request samples

Content type
application/json
{
  • "display_order": 0,
  • "is_public": true
}

Response samples

Content type
application/json
{
  • "image": {
    }
}

Images_detail

Authorizations:
BearerAuth
path Parameters
carId
required
string <uuid> (Foundation.uuid)
imageId
required
string <uuid> (Foundation.uuid)

Responses

Response samples

Content type
application/json
{
  • "image": {
    }
}

Images_update

Authorizations:
BearerAuth
path Parameters
carId
required
string <uuid> (Foundation.uuid)
imageId
required
string <uuid> (Foundation.uuid)
Request Body schema: application/json
required
display_order
integer <uint32>
is_public
boolean

Responses

Request samples

Content type
application/json
{
  • "display_order": 0,
  • "is_public": true
}

Response samples

Content type
application/json
{
  • "image": {
    }
}

Images_delete

Authorizations:
BearerAuth
path Parameters
carId
required
string <uuid> (Foundation.uuid)
imageId
required
string <uuid> (Foundation.uuid)

Responses

Prices

Prices_list

Authorizations:
BearerAuth
path Parameters
carId
required
string <uuid> (Foundation.uuid)

Responses

Response samples

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

Prices_create

Authorizations:
BearerAuth
path Parameters
carId
required
string <uuid> (Foundation.uuid)
Request Body schema: application/json
required
start_from
required
string <date-time>
body_price
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "start_from": "2019-08-24T14:15:22Z",
  • "body_price": 0
}

Response samples

Content type
application/json
{
  • "price": {
    }
}

Prices_detail

Authorizations:
BearerAuth
path Parameters
carId
required
string <uuid> (Foundation.uuid)
priceId
required
string <uuid> (Foundation.uuid)

Responses

Response samples

Content type
application/json
{
  • "price": {
    }
}

Prices_update

Authorizations:
BearerAuth
path Parameters
carId
required
string <uuid> (Foundation.uuid)
priceId
required
string <uuid> (Foundation.uuid)
Request Body schema: application/json
required
start_from
string <date-time>
body_price
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "start_from": "2019-08-24T14:15:22Z",
  • "body_price": 0
}

Response samples

Content type
application/json
{
  • "price": {
    }
}

Prices_delete

Authorizations:
BearerAuth
path Parameters
carId
required
string <uuid> (Foundation.uuid)
priceId
required
string <uuid> (Foundation.uuid)

Responses

Attributes

Attributes_list

Authorizations:
BearerAuth

Responses

Response samples

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

Attributes_create

Authorizations:
BearerAuth
Request Body schema: application/json
required
key
required
string

Key (snake_case)

display_name_ja
required
string

表示名

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "display_name_ja": "string"
}

Response samples

Content type
application/json
{
  • "attribute": {
    }
}

Attributes_detail

Authorizations:
BearerAuth
path Parameters
attributeId
required
string <uuid> (Foundation.uuid)

Responses

Response samples

Content type
application/json
{
  • "attribute": {
    }
}

Attributes_update

Authorizations:
BearerAuth
path Parameters
attributeId
required
string <uuid> (Foundation.uuid)
Request Body schema: application/json
required
key
string

Key (snake_case)

display_name_ja
string

表示名

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "display_name_ja": "string"
}

Response samples

Content type
application/json
{
  • "attribute": {
    }
}

Attributes_delete

Authorizations:
BearerAuth
path Parameters
attributeId
required
string <uuid> (Foundation.uuid)

Responses

Choices

Choices_list

Authorizations:
BearerAuth
path Parameters
attributeId
required
string <uuid> (Foundation.uuid)

Responses

Response samples

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

Choices_create

Authorizations:
BearerAuth
path Parameters
attributeId
required
string <uuid> (Foundation.uuid)
Request Body schema: application/json
required
key
required
string

Key (snake_case)

display_name_ja
required
string

表示名

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "display_name_ja": "string"
}

Response samples

Content type
application/json
{
  • "choice": {
    }
}

Choices_detail

Authorizations:
BearerAuth
path Parameters
attributeId
required
string <uuid> (Foundation.uuid)
choiceId
required
string <uuid> (Foundation.uuid)

Responses

Response samples

Content type
application/json
{
  • "choice": {
    }
}

Choices_update

Authorizations:
BearerAuth
path Parameters
attributeId
required
string <uuid> (Foundation.uuid)
choiceId
required
string <uuid> (Foundation.uuid)
Request Body schema: application/json
required
key
string

Key (snake_case)

display_name_ja
string

表示名

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "display_name_ja": "string"
}

Response samples

Content type
application/json
{
  • "choice": {
    }
}

Choices_delete

Authorizations:
BearerAuth
path Parameters
attributeId
required
string <uuid> (Foundation.uuid)
choiceId
required
string <uuid> (Foundation.uuid)

Responses