ukabis Wholesale API (4.0.0)
Download OpenAPI specification:Download
このAPIは、ukabisの卸売機能に関するエンドポイントを提供します。
認証について
APIの利用には以下の認証が必要です：
- ベンダーシステム認証：システム間連携用の認証
- OpenID認証：ユーザー個別の認証
get
指定した会社を取得します。
Authorizations:
ベンダーシステム認証OIDC認証
path Parameters
| eckaisyaCd required | string eckaisyaCd |
header Parameters
| X-Cache | string Example: 1 キャッシュを無視してリポジトリから直接データを取得する場合に指定 |
Responses
Response samples
- 200
- 400
- 404
Content type
application/json
{- "companyId": "63c7ce91-e383-e4fd-d45d-3748354326c0",
- "eckaisyaCd": "1001",
- "eckaisyaNm": "東京中央青果株式会社",
- "eckaisyaKana": "トウキョウチュウオウセイカ",
- "eckaisyaRm": "東京中央青果",
- "add1": "東京都中央区築地5-2-1",
- "mainTantoNm": "田中太郎",
- "tel": "03-3542-1234",
- "fax": "03-3542-5678",
- "oyakaisyaCd": "1000",
- "oyakaisyaNm": "日本中央青果株式会社",
- "maxRiyouid": 100,
- "ukabisSystemIdList": [
- "31ccd0cf-1589-febe-74ab-c79ca1901eec"
]
}register
新しい会社情報を登録します。
Authorizations:
ベンダーシステム認証OIDC認証
header Parameters
| X-Cache | string Example: 1 キャッシュを無視してリポジトリから直接データを取得する場合に指定 |
Request Body schema: application/jsonrequired
/api/traceability/v4/companies
Array
| companyId | string (companyId) |
| eckaisyaCd required | string (会社コード) |
| eckaisyaNm required | string (会社名) |
| eckaisyaKana | string (会社名カナ) |
| eckaisyaRm | string (略名) |
| add1 required | string (住所) |
| mainTantoNm | string (主担当者) |
| tel required | string (電話番号) |
| fax | string (FAX番号) |
| oyakaisyaCd | string (親会社コード) |
| oyakaisyaNm | string (親会社名) |
| maxRiyouid | number (最大利用者数) |
| ukabisSystemIdList required | Array of strings (ukabisシステムIDリスト) non-empty |
Responses
Request samples
- Payload
Content type
application/json
[- {
- "eckaisyaCd": "1001",
- "eckaisyaNm": "東京中央青果株式会社",
- "eckaisyaKana": "トウキョウチュウオウセイカ",
- "eckaisyaRm": "東京中央青果",
- "add1": "東京都中央区築地5-2-1",
- "mainTantoNm": "田中太郎",
- "tel": "03-3542-1234",
- "fax": "03-3542-5678",
- "oyakaisyaCd": "1000",
- "oyakaisyaNm": "日本中央青果株式会社",
- "maxRiyouid": 100,
- "ukabisSystemIdList": [
- "31ccd0cf-1589-febe-74ab-c79ca1901eec"
]
}
]Response samples
- 201
Content type
application/json
[- {
- "id": "63c7ce91-e383-e4fd-d45d-3748354326c0"
}
]get
指定したEC伝票番号の出荷情報を取得します。
Authorizations:
ベンダーシステム認証OIDC認証
path Parameters
| ecDenpyoNo required | string ecDenpyoNo |
query Parameters
| eckaisyaCd | string 会社コード |
header Parameters
| X-Cache | string Example: 1 キャッシュを無視してリポジトリから直接データを取得する場合に指定 |
Responses
Response samples
- 200
Content type
application/json
{- "shipmentId": "b86ee958-3a92-f7c2-faf0-68fe7231dca5",
- "motoEckaisyaCd": "1001",
- "sakiEckaisyaCd": "2001",
- "motoHanYmd": "2024-06-23",
- "motoNouYmd": "2024-06-24",
- "motoKanriNo": "MK20240624002",
- "motoKeda": 1,
- "ecDenpyoNo": "EC202406002",
- "hatuYmd": "2024-06-24",
- "cyakuYmd": "2024-06-25",
- "hanYmd": "2024-06-26",
- "tensoOkuriNo": "TO20240624002",
- "tohinCd": "001",
- "tohinNm": "トマト",
- "motoHinCd": "TM001",
- "motoHinNm": "桃太郎トマト",
- "details": [
- {
- "motoGyo": 1,
- "nijiru": "印01",
- "nisCd": "01",
- "nisNm": "箱",
- "ryomk": 10,
- "hakosu": 5,
- "suryo": 50,
- "kingaku": 7500
}
]
}getHistory
指定したEC伝票番号の出荷履歴を取得します。
Authorizations:
ベンダーシステム認証OIDC認証
path Parameters
| ecDenpyoNo required | string ecDenpyoNo |
query Parameters
| eckaisyaCd | string 会社コード |
header Parameters
| X-Cache | string Example: 1 キャッシュを無視してリポジトリから直接データを取得する場合に指定 |
Responses
Response samples
- 200
Content type
application/json
[- {
- "shipmentId": "b86ee958-3a92-f7c2-faf0-68fe7231dca5",
- "motoEckaisyaCd": "1001",
- "sakiEckaisyaCd": "2001",
- "motoHanYmd": "2024-06-23",
- "motoNouYmd": "2024-06-24",
- "motoKanriNo": "MK20240624002",
- "motoKeda": 1,
- "ecDenpyoNo": "EC202406002",
- "hatuYmd": "2024-06-24",
- "cyakuYmd": "2024-06-25",
- "hanYmd": "2024-06-26",
- "tensoOkuriNo": "TO20240624002",
- "tohinCd": "001",
- "tohinNm": "トマト",
- "motoHinCd": "TM001",
- "motoHinNm": "桃太郎トマト",
- "details": [
- {
- "motoGyo": 1,
- "nijiru": "印01",
- "nisCd": "01",
- "nisNm": "箱",
- "ryomk": 10,
- "hakosu": 5,
- "suryo": 50,
- "kingaku": 7500
}, - {
- "motoGyo": 2,
- "nijiru": "印01",
- "nisCd": "01",
- "nisNm": "箱",
- "ryomk": 20,
- "hakosu": 10,
- "suryo": 200,
- "kingaku": 30000
}
]
}, - {
- "shipmentId": "46e9e1b7-7301-daf3-bb06-03ad589133b3",
- "motoEckaisyaCd": "1001",
- "sakiEckaisyaCd": "2001",
- "motoHanYmd": "2024-06-23",
- "motoNouYmd": "2024-06-24",
- "motoKanriNo": "MK20240624002",
- "motoKeda": 1,
- "ecDenpyoNo": "EC202406002",
- "hatuYmd": "2024-06-24",
- "cyakuYmd": "2024-06-25",
- "hanYmd": "2024-06-26",
- "tensoOkuriNo": "TO20240624002",
- "tohinCd": "001",
- "tohinNm": "トマト",
- "motoHinCd": "TM001",
- "motoHinNm": "桃太郎トマト",
- "details": [
- {
- "motoGyo": 1,
- "nijiru": "印01",
- "nisCd": "01",
- "nisNm": "箱",
- "ryomk": 10,
- "hakosu": 5,
- "suryo": 50,
- "kingaku": 7500
}
]
}
]getList
指定した出荷日範囲に基づいて出荷情報を取得します。
Authorizations:
ベンダーシステム認証OIDC認証
query Parameters
| eckaisyaCd | string 会社コード |
| hatuYmdFrom | string 出荷日From |
| hatuYmdTo | string 出荷日To |
header Parameters
| X-Cache | string Example: 1 キャッシュを無視してリポジトリから直接データを取得する場合に指定 |
Responses
Response samples
- 200
Content type
application/json
[- {
- "shipmentId": "b86ee958-3a92-f7c2-faf0-68fe7231dca5",
- "motoEckaisyaCd": "1001",
- "sakiEckaisyaCd": "2001",
- "motoHanYmd": "2024-06-23",
- "motoNouYmd": "2024-06-24",
- "motoKanriNo": "MK20240624001",
- "motoKeda": 1,
- "ecDenpyoNo": "EC202406001",
- "hatuYmd": "2024-06-24",
- "tensoOkuriNo": "TO20240624001"
}
]register
新しい出荷情報を登録します。
Authorizations:
ベンダーシステム認証OIDC認証
header Parameters
| X-Cache | string Example: 1 キャッシュを無視してリポジトリから直接データを取得する場合に指定 |
Request Body schema: application/jsonrequired
/api/ukabis/traceability/v4/shipments
Array
| shipmentId | string (ukabis出荷ID) |
| motoEckaisyaCd required | string (出荷元EC会社コード) |
| sakiEckaisyaCd required | string (出荷先EC会社コード) |
| motoHanYmd required | string (元販売日) |
| motoNouYmd required | string (元納品日) |
| motoKanriNo required | string (元管理番号) |
| motoKeda required | number (元枝番) |
| ecDenpyoNo required | string (EC伝票番号) |
| hatuYmd required | string (出荷日) |
| cyakuYmd | string ( 着荷日) |
| hanYmd | string (販売予定日) |
| renkeiSykCd | string (連携出荷者コード) |
| chgMotoSykCd | number (元出荷者) |
| motoSykCd | string (元出荷者コード) |
| motoSykNm | string (元出荷者名) |
| motoSykKana | string (元出荷者名カナ) |
| motoSeisanNm | string (元生産者名) |
| motoKenrenCd | string (元県連コード) |
| motoNokyoCd | string (元農協コード) |
| chgOmotoSykCd | number (大元出荷者) |
| omotoSykCd | string (大元出荷者コード) |
| omotoSykNm | string (大元出荷者名) |
| omotoSykKana | string (大元出荷者名カナ) |
| omotoSeisanNm | string (大元生産者名) |
| omotoKenrenCd | string (大元県連コード) |
| omotoNokyoCd | string (大元農協コード) |
| motoKyosenKbn | string (元共選区分) |
| motoKyosenKbnNm | string (元共選区分名) |
| chgGsantiCd | number (元原産地) |
| gsantiCd | string (原産地コード) |
| gsantiNm | string (原産地名) |
| renkeiGsantiCd | string (連携原産地コード) |
| ikKbn | string (EC委託買付区分) |
| tensoOkuriNo required | string (転送送り状№) |
| tensoKasyaKigo | string (転送貨車記号) |
| tensoUnsoCd | string (転送運送店コード) |
| tensoUnsoNm | string (転送運送店名) |
| tensoTrackNo | string (転送トラック番号) |
| motoTantoCd | string (出荷元担当者コード) |
| motoTantoNm | string (出荷元担当者名) |
| bunkaKbn | string (分荷区分) |
| rerayEckaisyaCd | string (中継EC会社コード) |
| chgTohinCd | number (元統一品名) |
| tohinCd | string (統一品名コード) |
| tohinNm | string (統一品名) |
| tohinKana | string (統一品名カナ) |
| chgMotoHinCd | number (元品名) |
| motoHinCd | string (出荷元品名コード) |
| motoHinNm | string (出荷元品名) |
| renkeiHinCd | string (連携品名コード) |
| headBiko | string (元ヘッダ備考) |
| updtSts | number (更新状態) |
Array of objects (行明細) | |
| sendDate | string (送信日時) |
| dataKbn | string (データ区分) |
| recvDate | string (受信日時) |
| recvSts | number (受信状態) |
| toriDate | string (取込日時) |
| toriSts | number (取込状態) |
Responses
Request samples
- Payload
Content type
application/json
{- "motoEckaisyaCd": "1001",
- "sakiEckaisyaCd": "2001",
- "motoHanYmd": "2024-06-23",
- "motoNouYmd": "2024-06-24",
- "motoKanriNo": "MK20240624002",
- "motoKeda": 1,
- "ecDenpyoNo": "EC202406002",
- "hatuYmd": "2024-06-24",
- "cyakuYmd": "2024-06-25",
- "hanYmd": "2024-06-26",
- "tensoOkuriNo": "TO20240624002",
- "tohinCd": "001",
- "tohinNm": "トマト",
- "motoHinCd": "TM001",
- "motoHinNm": "桃太郎トマト",
- "details": [
- {
- "motoGyo": 1,
- "nijiru": "印01",
- "nisCd": "01",
- "nisNm": "箱",
- "ryomk": 10,
- "hakosu": 5,
- "suryo": 50,
- "kingaku": 7500
}
]
}Response samples
- 201
Content type
application/json
[- {
- "id": "63c7ce91-e383-e4fd-d45d-3748354326c0"
}
]get
指定したEC伝票番号の市況情報を取得します。
Authorizations:
ベンダーシステム認証OIDC認証
path Parameters
| ecDenpyoNo required | string ecDenpyoNo |
query Parameters
| eckaisyaCd | string 会社コード |
header Parameters
| X-Cache | string Example: 1 キャッシュを無視してリポジトリから直接データを取得する場合に指定 |
Responses
Response samples
- 200
Content type
application/json
[- {
- "$ref": "#/components/examples/SikyoBasicResponse"
}
]getByDate
指定した仕切日、受信フラグに基づいて市況情報を取得します。
Authorizations:
ベンダーシステム認証OIDC認証
query Parameters
| eckaisyaCd | string 会社コード |
| sikYmd | string 仕切日 |
| recvFlg | string 受信フラグ |
header Parameters
| X-Cache | string Example: 1 キャッシュを無視してリポジトリから直接データを取得する場合に指定 |
Responses
Response samples
- 200
Content type
application/json
[- {
- "$ref": "#/components/examples/SikyoListResponse"
}
]getList
指定した出荷日範囲に基づいて市況情報を取得します。
Authorizations:
ベンダーシステム認証OIDC認証
query Parameters
| eckaisyaCd | string 会社コード |
| hatuYmdFrom | string 出荷日From |
| hatuYmdTo | string 出荷日To |
header Parameters
| X-Cache | string Example: 1 キャッシュを無視してリポジトリから直接データを取得する場合に指定 |
Responses
Response samples
- 200
Content type
application/json
[- {
- "$ref": "#/components/examples/SikyoListResponse"
}
]markReceive
指定したsikyoIdに基づいて市況情報の受信フラグを更新します。
Authorizations:
ベンダーシステム認証OIDC認証
query Parameters
| eckaisyaCd | string 会社コード |
| sikYmd | string 仕切日 |
header Parameters
| X-Cache | string Example: 1 キャッシュを無視してリポジトリから直接データを取得する場合に指定 |
Request Body schema: application/jsonrequired
ukabis市況情報のフラグ更新用モデル
| sikyoId required | Array of strings (ukabis上で一意な市況情報ID。（UUID）) |
Responses
Request samples
- Payload
Content type
application/json
[- {
- "sikyoId": "68240daa-b6a5-8ed0-b864-1139c24b120e"
}
]Response samples
- 200
Content type
application/json
{- "updatedCount": 5,
- "message": "5 件のレコードを更新しました。"
}register
新たな市況情報を登録します。
Authorizations:
ベンダーシステム認証OIDC認証
header Parameters
| X-Cache | string Example: 1 キャッシュを無視してリポジトリから直接データを取得する場合に指定 |
Request Body schema: application/jsonrequired
ukabis市況情報のデータレイアウト
Array
| sikyoId | string (ukabis上で一意な市況情報ID。（UUID）) |
| orosiCd required | string (卸売会社コード。「出荷先EC会社コート゛」と同値になる) |
| sendEckaisyaCd required | string (送信先会社コード。「出荷元EC会社コート゛」と同値になる) |
| motoniuNo required | string (元荷受№。Marcheの伝票管理キー（卸売会社で発番）) |
| motoniuEda required | number (元荷受枝№。Marcheの伝票管理キー（卸売会社で発番）) |
| sikYmd required | string (仕切日。Marcheの伝票管理キー。委託は販売日、買付は仕入単価入力日) |
| sendDate required | string (市況送信日時（複数回送信を考慮）※YYYY/MM/DD HH24:MI:SS) |
| sendKbn | string (市況送信区分。１：速報、２：確報 ※基本的には「速報」「確報」どちらか一方の送信となる) Enum: "1" "2" |
| motoEckaisyaCd required | string (出荷元EC会社コート゛。ukabis経由で出荷情報連携時の出荷元伝票特定キー) |
| sakiEckaisyaCd required | string (出荷先EC会社コート゛。ukabis経由で出荷情報連携時の出荷元伝票特定キー) |
| motoHanYmd required | string (出荷元販売日。ukabis経由で出荷情報連携時の出荷元伝票特定キー) |
| motoNouYmd required | string (出荷元納品日。ukabis経由で出荷情報連携時の出荷元伝票特定キー) |
| motoKanriNo required | string (出荷元管理番号。ukabis経由で出荷情報連携時の出荷元伝票特定キー) |
| motoKeda required | number (出荷元枝番。ukabis経由で出荷情報連携時の出荷元伝票特定キー) |
| ecDenpyoNo required | string (出荷日。ukabis経由で出荷情報連携時の出荷元伝票特定キー) |
| hatuYmd required | string (出荷日。ukabis経由で出荷情報連携時の出荷元伝票特定キー) |
| tensoOkuriNo required | string (転送送り状№。ukabis経由で出荷情報連携時の出荷元伝票特定キー) |
| genpyoNo | string (検索番号。卸売会社への伝票・送金の問合せキー（卸売会社で発番）) |
| genpyoEda | number (検索番号枝番。卸売会社への伝票・送金の問合せキー（卸売会社で発番）) |
| kenrenCd | string (県連コード。ベジフルコード) |
| nokyoCd | string (農協コード。ベジフルコード) |
| sykCd | string (出荷者コード。卸売会社での出荷者マスタの社内コード) |
| sykNm | string (出荷者名。卸売会社での出荷者マスタの社内名称) |
| seisanNm | string (生産者名) |
| tohinCd | string (統一品名コード。ベジフルコード) |
| tohinNm | string (統一品名) |
| hinCd | string (品名コード。卸売会社での品名マスタの社内コード) |
| hinNm | string (品名。卸売会社での品名マスタの社内名称) |
| hinSyosai | string (品名詳細) |
| kyosenKbn | string (共選区分。ベジフルコード。0:共選 1:個選 2:安定 3:共計 4:安定共計 5:県共計 9:買付。※買付品の場合は「9:買付」固定。それ以外は委託品) Enum: "0" "1" "2" "3" "4" "5" "9" |
| kyosenKbnNm | string (共選区分名) |
| recvFlg | number (受信フラグ。0：未受信 1：受信済) Enum: 0 1 |
| recvDate | string (受信日時。市況受信日時 ※YYYY/MM/DD HH24:MI:SS) |
required | Array of objects (明細行情報) |
Responses
Request samples
- Payload
Content type
application/json
[- {
- "orosiCd": "13",
- "sendEckaisyaCd": "1001",
- "motoniuNo": "MN20240624001",
- "motoniuEda": 1,
- "sikYmd": "2024-06-24",
- "sendDate": "2024-06-24 09:00:00",
- "sendKbn": "1",
- "motoEckaisyaCd": "1001",
- "sakiEckaisyaCd": "2001",
- "motoHanYmd": "2024-06-23",
- "motoNouYmd": "2024-06-24",
- "motoKanriNo": "MK20240624001",
- "motoKeda": 1,
- "ecDenpyoNo": "EC202406001",
- "hatuYmd": "2024-06-24",
- "tensoOkuriNo": "TO20240624001",
- "details": [
- {
- "sikGyo": 1,
- "nijiru": "印01",
- "nisCd": "01",
- "nisNm": "箱",
- "ryomk": 10,
- "hakosu": 5,
- "tanka": 150,
- "kingaku": 7500
}
]
}
]Response samples
- 201
Content type
application/json
[- {
- "id": "63c7ce91-e383-e4fd-d45d-3748354326c0"
}
]