企業情報APIでは、企業の情報を取得、登録、更新、削除するためのエンドポイントを提供します。
企業情報を検索します。
リクエストには、以下のいずれか一つ以上のパラメータが必要です。すべてのパラメータはオプションですが、少なくとも一つは指定する必要があります。
名前 | タイプ | 必須 | 説明 | 備考 |
---|---|---|---|---|
keyword | 文字列 | 検索キーワード | ||
id | 文字列 | フィルター式(完全一致のみ) | ||
duns | 文字列 | DUNS番号 | フィルター式(完全一致のみ) | |
taxId | 文字列 | 適格請求書発行事業者番号 | フィルター式(完全一致のみ) | |
vatId | 文字列 | 適格請求書発行事業者番号 | フィルター式(完全一致のみ) | |
memberId | 文字列 | 企業Id | コンマ区切りの複数企業指定可能 | |
brandId | 文字列 | ブランドId | コンマ区切りの複数ブランド指定可能 | |
storeId | 文字列 | 店舗Id | コンマ区切りの複数店舗指定可能 | |
addressCountry | 文字列 | 住所・国 | フィルター式(完全一致のみ) | |
postalCode | 文字列 | 住所・郵便番号 | フィルター式(完全一致のみ) | |
addressRegion | 文字列 | 住所・都道府県 | フィルター式(完全一致のみ) | |
addressLocality | 文字列 | 住所・市区町村 | フィルター式(完全一致のみ) | |
additionalType | 文字列 | 法人タイプ | フィルター式(完全一致のみ) | |
itemsPerPage | 数値 | ページごとの取得件数 | 1-100の範囲、指定なしの場合は10件を取得 | |
currentPage | 数値 | 取得するページ番号 | 範囲外または指定なしの場合は1ページ目を取得 |
リクエストが適切に処理されなかった場合、APIは以下のようなエラーレスポンスを返します。
400 Bad Request | リクエストが不正、またはパラメータが指定されていない場合。 |
401 Unauthorized | 認証に失敗した場合。 |
404 Not Found | 指定したリソースが見つからない場合。 |
500 Internal Server Error | サーバー側の問題でリクエストを処理できない場合。 |
名前 | タイプ | 説明 | 備考 |
---|---|---|---|
organizations | オブジェクト | Organization型 | |
keyword | 文字列 | 検索キーワード | |
filters | 文字列 | 検索フィルター文字列 | |
totalItems | 数値 | 結果の総件数 | |
totalPages | 数値 | 結果の総ページ数 | |
currentPage | 数値 | 取得したページ番号 | |
itemsPerPage | 数値 | 取得したページ内の件数 |
名前 | タイプ | 説明 | 備考 |
---|---|---|---|
score | 数値 | 検索スコア | 検索結果の関連度スコア(例: 4.0002) |
id | 文字列 | Id | |
name | 文字列 | 企業名 | |
legalName | 文字列 | 企業法人名 | |
slogan | 文字列 | 企業キャッチコピー | |
duns | 文字列 | DUNS番号 | |
taxId | 文字列 | 適格請求書発行事業者番号 | |
vatId | 文字列 | VAT番号 | |
parentOrganizationId | 文字列 | 親企業Id | |
memberIds | 文字列 | 子企業Id | コンマ区切りの複数子企業Id(最大100件、100件以上取得の場合は詳細APIから取得してください) |
brandIds | 文字列 | ブランドId | コンマ区切りの複数ブランドId(最大100件、100件以上取得の場合は詳細APIから取得してください) |
storeIds | 文字列 | 店舗Id | コンマ区切りの複数店舗Id(最大100件、100件以上取得の場合は詳細APIから取得してください) |
addressCountry | 文字列 | 住所・国 | |
postalCode | 文字列 | 郵便番号 | |
addressRegion | 文字列 | 住所・都道府県 | |
addressLocality | 文字列 | 住所・市区町村 | |
streetAddress | 文字列 | 住所・番地、建物名 | |
additionalType | 文字列 | 法人タイプ | |
description | 文字列 | 備考 | |
disambiguatingDescription | 文字列 | 備考(追記) | |
sameAs | 文字列 | 同じ企業がある場合のURL | |
url | 文字列 | 企業URL |
指定したIDの企業情報を取得します。
URLパスに指定した企業のIDを含めてリクエストします。
リクエストが適切に処理されなかった場合、APIは以下のようなエラーレスポンスを返します。
400 Bad Request | リクエストが不正、またはパラメータが指定されていない場合。 |
401 Unauthorized | 認証に失敗した場合。 |
404 Not Found | 指定したリソースが見つからない場合。 |
500 Internal Server Error | サーバー側の問題でリクエストを処理できない場合。 |
名前 | タイプ | 説明 | 備考 |
---|---|---|---|
id | 文字列 | 企業ID | |
name | 文字列 | 一般的な企業名 | |
legalName | 文字列 | 企業の法的名称 | |
slogan | 文字列 | 企業キャッチコピー | |
duns | 文字列 | DUNS番号 | |
taxId | 文字列 | 税金識別番号 | |
vatId | 文字列 | 付加価値税ID | |
parentOrganizationId | 文字列 | 親企業のID(該当する場合) | |
memberIds | 文字列 | メンバー企業のIDのリスト(該当する場合) | |
brandIds | 文字列 | ブランドのIDのリスト(該当する場合) | |
storeIds | 文字列 | 店舗のIDのリスト(該当する場合) | |
addressCountry | 文字列 | 国 | |
addressLocality | 文字列 | 市区町村 | |
addressRegion | 文字列 | 都道府県または州 | |
postalCode | 文字列 | 郵便番号 | |
streetAddress | 文字列 | 番地や建物名を含む詳細な住所 | |
description | 文字列 | 企業に関する説明 | |
disambiguatingDescription | 文字列 | 類似する他の企業と区別するための説明 | |
url | 文字列 | 企業の公式ウェブサイトのURL | |
logo | 文字列 | 企業のロゴ画像のURL | |
foundingDate | 日付 | 設立日 | |
lastModified | 日付 | 最終更新日 | |
dissolutionDate | 日付 | 解散日(該当する場合) | |
dissolutionReason | 文字列 | 解散理由(該当する場合) | |
successorOrganizationId | 文字列 | 後継企業のID(該当する場合) |
企業情報を作成します。
名前 | タイプ | 必須 | 説明 | 備考 |
---|---|---|---|---|
id | 文字列 | 必須 | ||
name | 文字列 | 必須 | ||
legalName | 文字列 | |||
slogan | 文字列 | |||
duns | 文字列 | DUNS番号 | ||
taxId | 文字列 | |||
vatId | 文字列 | |||
parentOrganizationId | 文字列 | |||
addressCountry | 文字列 | 住所・国 | ||
postalCode | 文字列 | 住所・郵便番号 | ||
addressRegion | 文字列 | 住所・都道府県 | ||
addressLocality | 文字列 | 住所・市区町村 | ||
streetAddress | 文字列 | |||
description | 文字列 | |||
disambiguatingDescription | 文字列 | |||
url | 文字列 | |||
logo | 文字列 | |||
foundingDate | 日付 | |||
dissolutionDate | 日付 | |||
dissolutionDate | 日付 | |||
additionalType | 文字列 | 必須 | 法人タイプ |
リクエストが適切に処理されなかった場合、APIは以下のようなエラーレスポンスを返します。
400 Bad Request | リクエストが不正、またはパラメータが指定されていない場合。 |
401 Unauthorized | 認証に失敗した場合。 |
404 Not Found | 指定したリソースが見つからない場合。 |
500 Internal Server Error | サーバー側の問題でリクエストを処理できない場合。 |
名前 | タイプ | 説明 | 備考 |
---|---|---|---|
id | 文字列 | 企業ID | |
name | 文字列 | 一般的な企業名 | |
legalName | 文字列 | 企業の法的名称 | |
slogan | 文字列 | 企業キャッチコピー | |
duns | 文字列 | DUNS番号 | |
taxId | 文字列 | 税金識別番号 | |
vatId | 文字列 | 付加価値税ID | |
parentOrganizationId | 文字列 | 親企業のID(該当する場合) | |
addressCountry | 文字列 | 国 | |
addressLocality | 文字列 | 市区町村 | |
addressRegion | 文字列 | 都道府県または州 | |
postalCode | 文字列 | 郵便番号 | |
streetAddress | 文字列 | 番地や建物名を含む詳細な住所 | |
description | 文字列 | 企業に関する説明 | |
disambiguatingDescription | 文字列 | 類似する他の企業と区別するための説明 | |
url | 文字列 | 企業の公式ウェブサイトのURL | |
logo | 文字列 | 企業のロゴ画像のURL | |
foundingDate | 日付 | 設立日 | |
lastModified | 日付 | 最終更新日 | |
dissolutionDate | 日付 | 解散日(該当する場合) | |
dissolutionReason | 文字列 | 解散理由(該当する場合) | |
successorOrganizationId | 文字列 | 後継企業のID(該当する場合) |
企業情報を更新します。
名前 | タイプ | 必須 | 説明 | 備考 |
---|---|---|---|---|
name | 文字列 | 必須 | ||
legalName | 文字列 | |||
slogan | 文字列 | |||
duns | 文字列 | DUNS番号 | ||
taxId | 文字列 | |||
vatId | 文字列 | |||
parentOrganizationId | 文字列 | |||
addressCountry | 文字列 | 住所・国 | ||
postalCode | 文字列 | 住所・郵便番号 | ||
addressRegion | 文字列 | 住所・都道府県 | ||
addressLocality | 文字列 | 住所・市区町村 | ||
streetAddress | 文字列 | |||
description | 文字列 | |||
disambiguatingDescription | 文字列 | |||
url | 文字列 | |||
logo | 文字列 | |||
foundingDate | 日付 | |||
dissolutionDate | 日付 | |||
dissolutionDate | 日付 | |||
additionalType | 文字列 | 必須 | 法人タイプ |
リクエストが適切に処理されなかった場合、APIは以下のようなエラーレスポンスを返します。
400 Bad Request | リクエストが不正、またはパラメータが指定されていない場合。 |
401 Unauthorized | 認証に失敗した場合。 |
404 Not Found | 指定したリソースが見つからない場合。 |
500 Internal Server Error | サーバー側の問題でリクエストを処理できない場合。 |
名前 | タイプ | 説明 | 備考 |
---|---|---|---|
id | 文字列 | 企業ID | |
name | 文字列 | 一般的な企業名 | |
legalName | 文字列 | 企業の法的名称 | |
slogan | 文字列 | 企業キャッチコピー | |
duns | 文字列 | DUNS番号 | |
taxId | 文字列 | 税金識別番号 | |
vatId | 文字列 | 付加価値税ID | |
parentOrganizationId | 文字列 | 親企業のID(該当する場合) | |
addressCountry | 文字列 | 国 | |
addressLocality | 文字列 | 市区町村 | |
addressRegion | 文字列 | 都道府県または州 | |
postalCode | 文字列 | 郵便番号 | |
streetAddress | 文字列 | 番地や建物名を含む詳細な住所 | |
description | 文字列 | 企業に関する説明 | |
disambiguatingDescription | 文字列 | 類似する他の企業と区別するための説明 | |
url | 文字列 | 企業の公式ウェブサイトのURL | |
logo | 文字列 | 企業のロゴ画像のURL | |
foundingDate | 日付 | 設立日 | |
lastModified | 日付 | 最終更新日 | |
dissolutionDate | 日付 | 解散日(該当する場合) | |
dissolutionReason | 文字列 | 解散理由(該当する場合) | |
successorOrganizationId | 文字列 | 後継企業のID(該当する場合) |
企業情報を削除します。
リクエストが適切に処理されなかった場合、APIは以下のようなエラーレスポンスを返します。
400 Bad Request | リクエストが不正、またはパラメータが指定されていない場合。 |
401 Unauthorized | 認証に失敗した場合。 |
404 Not Found | 指定したリソースが見つからない場合。 |
500 Internal Server Error | サーバー側の問題でリクエストを処理できない場合。 |
名前 | タイプ | 説明 | 備考 |
---|---|---|---|
id | 文字列 | 削除した企業ID |