nimaruJA API Draft (0.0.1)

商品の一覧を取得します。最大で同時に 1000 件まで取得できます。

等級の一覧を取得します。最大で同時に 1000 件まで取得できます。

階級の一覧を取得します。最大で同時に 1000 件まで取得できます。

コミュニティの一覧を取得します。最大で同時に 1000 件まで取得できます。

職員が取込操作で確定した入荷情報を取得します。

差分取得

updated_after に日時を指定すると、その日時以降に作成・更新された入荷だけを取得できます。前回取得した日時から数分の重なりを持たせて指定し、重複した入荷は id をキーに上書きで取り込んでください。updated_after を指定しない場合は全件を返します（初回同期用）。

ページング

1 回のレスポンスで返す入荷は最大 1,000 件です。続きがある場合は nextCursor に文字列が入ります。その値を cursor に指定して再度リクエストすると続きを取得できます。nextCursor が null になるまで繰り返してください。cursor を指定した場合、updated_after は無視されます。

自動でポーリングする場合は 5 分以上の間隔を推奨します。現時点でレート制限は設けていませんが、将来導入する予定です（超過時は 429 を返します）。

指定した日の出荷情報を取得します。最大で同時に 1000 件まで取得できます。

指定した販売日（売立日）の売立を登録します。1 回のリクエストが 1 伝票で、date などのヘッダと items（売立明細）から成ります。明細を生産者ごとにまとめて入荷と出荷を作成し、出荷明細に売立価格を紐づけます。

登録の扱い

リクエストごとに新しい入荷・出荷・売立価格を追加します。既存のデータとの突き合わせや置き換えは行いません。同じ内容を再送すると同じ入荷・出荷・売立価格がもう一組登録されるため、再送する場合は事前に nimaru の売立入力画面で登録内容を確認してください。登録した内容の訂正や取り消しは、nimaru の売立入力画面から行います。

コードの指定

生産者・商品・等級・階級・荷姿は nimaru に登録されたマスタのコードで指定します。入荷情報を取得する API が返すコードと同じ値です。コードが見つからない場合や、同じコードを持つマスタが複数ある場合は、リクエスト全体を登録せずに 400 を返します。

作成する入荷の拠点と出荷の出荷先は、nimaru 側の設定で決まります。現時点でレート制限は設けていませんが、将来導入する予定です（超過時は 429 を返します）。

配信専用(返信不可)のお知らせの下書きを作成します。

作成済みのお知らせ下書きにファイルを添付します。

コミュニティのお知らせ配信カテゴリを取得します。最大で同時に 1000 件まで取得できます。

コミュニティに所属する生産者の一覧を取得します。最大で同時に 1000 件まで取得できます。

コミュニティに所属する生産者グループの一覧を取得します。最大で同時に 1000 件まで取得できます。

配信専用(返信不可)のお知らせの下書きを作成します。

作成済みのお知らせ下書きにファイルを添付します。

API アクセストークンの組織内の作付情報を取得します。1 件は 1 作付です。limit・差分取得は設けません。

ページング

1 回のレスポンスで返す作付は最大 1,000 件です。初回は cursor を省略してください。続きがある場合は nextCursor に文字列が入ります。その値を cursor に指定し、同じ組織・isActive 条件で再度リクエストすると続きを取得できます。nextCursor が null になるまで繰り返してください。件数では終了を判定しません。

全ページ取得後に、同じ条件の取得範囲だけを反映してください。検印日時・作付終了は出荷可否を表しません。

選果プロジェクトの一覧を取得します。

指定したプロジェクトの情報を規格一覧（productClasses）を含めて取得します。

選果機の一覧を取得します。

指定したプロジェクトのロット一覧を取得します。レスポンスには items（規格ごとの集計）が含まれます。

指定したプロジェクトに新しいロットを作成します。 items（規格ごとの集計）と details（個別果実の計測データ）はどちらも任意です。 details のみを送信した場合、items は productClassId ごとに自動集計されます。 items と details を両方送信した場合、items はそのまま保存されます。 details は別エンドポイント（PUT /details）でも後から登録・置換できます。

指定したロットの情報を items（規格ごとの集計）を含めて取得します。個別果実の計測データ（details）は別エンドポイントから取得してください。

指定したロットの情報を更新します。すべてのフィールドは任意です。 details のみを送信した場合、items は productClassId ごとに自動集計されます。 items と details を両方送信した場合、items はそのまま保存されます。

指定したロットを削除します。

指定したロットの個別果実の計測データ（details）をページネーション付きで取得します。

指定したロットに個別果実の計測データをバルクで追加します。既存の details に追記されます。

指定したロットの個別果実データを全件置換します。空配列を送信すると全件削除されます。