API docs by Redocly

ZAICO Public API V2 (2.0.0)

Download OpenAPI specification:

認証

BearerAuth

リクエストの Authorization ヘッダーに、APIトークンを Bearer スキームで指定してください。

Authorization: Bearer {APIトークン}

APIトークンの確認場所

APIトークンは、zaico にログインしたご自身の「アカウント設定」画面で確認できます（画面右上のユーザー名 →「アカウント設定」）。

APIトークン 対象 表示される場所
組織向けAPIトークン 新プラン 「APIトークン」欄
拠点向けAPIトークン（従来） 旧プラン 「APIトークン」欄
拠点向けAPIトークン（従来） 旧プランから新プランへ移行した拠点 「拠点権限を設定」を開き、該当拠点の「(旧) APIトークン」欄（組織権限が「管理」のユーザーのみ）
  • APIトークンは、APIを利用できるプランで、管理者が「設定」→「利用機能設定」でAPIを有効にしている場合にのみ表示されます。
  • 「再生成」すると、それまでのAPIトークンは使えなくなります。
  • APIトークンの種別ごとの違いは v1→v2 マイグレーションガイド の「3. 認証方式の移行ガイド」を参照してください。

OAuth 2.0 のアクセストークンを使う場合

APIトークンの代わりに、OAuth 2.0 で発行したアクセストークンを、同じ Authorization ヘッダーに Bearer スキームで指定することもできます。以下の「アプリ」は、zaico に登録した OAuth 2.0 のクライアントを指します。

Authorization: Bearer {アクセストークン}

エンドポイント

用途 メソッド URL
認可 GET https://web.zaico.co.jp/oauth/authorize
トークンの発行・リフレッシュ POST https://web.zaico.co.jp/oauth/token
トークンの失効 POST https://web.zaico.co.jp/oauth/revoke

使えるフロー

認可コードフロー（PKCE に対応）とリフレッシュトークンを使えます。

  1. ユーザーを認可エンドポイントへ誘導します（response_type=code・client_id・redirect_uri・scope・state）。PKCE を使う場合は code_challenge と code_challenge_method=S256 も付けます。
  2. ユーザーが許可すると、redirect_uri に認可コード（code）と state が返ります。state が送った値と一致することを確かめてください。
  3. トークンエンドポイントに grant_type=authorization_code・code・redirect_uri・client_id を送り、アクセストークンとリフレッシュトークンを受け取ります。client_secret を持つアプリは client_secret も送ります（Basic 認証ヘッダーでも送れます）。PKCE を使った場合は code_verifier も送ります。

client_secret を安全に保管できないアプリ（利用者の端末に配布するアプリなど）は、client_secret を持たない公開クライアントとして PKCE（S256）を使ってください。

有効期限とリフレッシュ

  • 認可コードの有効期限は 10 分です。
  • アクセストークンの有効期限は 2 時間です。トークンエンドポイントのレスポンスの expires_in に秒数で返ります。有効期限が切れた、または失効したアクセストークンで呼ぶと 401 Unauthorized が返ります。
  • 新しいアクセストークンは、トークンエンドポイントに grant_type=refresh_token・refresh_token・client_id（client_secret を持つアプリは client_secret も。Basic 認証ヘッダーでも送れます）を送ると受け取れます（有効期限が切れる前でも受け取れます）。レスポンスには新しいリフレッシュトークンも含まれるため、以後はそちらを使ってください。
  • 新しいアクセストークンで API を一度呼ぶと、リフレッシュ前のアクセストークンとリフレッシュトークンは失効し、有効期限内でも使えなくなります。リフレッシュした後は、新しいアクセストークンとリフレッシュトークンだけを使ってください。
  • 新しいアクセストークンを使う前であれば、レスポンスを受け取れなかった場合などに、リフレッシュ前のリフレッシュトークンで再度リフレッシュできます。
  • 別のログイン（別の端末や別の認可）で取得したトークンには影響しません。
  • 不要になったトークンは、失効エンドポイントに token・client_id（client_secret を持つアプリは client_secret も。Basic 認証ヘッダーでも送れます）を送ると失効できます。client_id が無いと失効できません。

スコープ

スコープは {リソース}.{操作} の形式（profile を除く）で、認可リクエストの scope にスペース区切りで指定します。

操作 許可される操作
read 一覧・詳細の取得
write 作成・更新（確定・送信などの状態を変える操作を含む）
destroy 削除・キャンセル
admin そのリソースに対するすべての操作
  • scope には、アプリに登録されているスコープの中から指定します（admin を登録していても、read などを個別に指定するにはそのスコープの登録が必要です）。scope を省略すると、アプリに登録されているスコープで認可されます。
  • 必要なスコープが無い操作を呼ぶと 403 Forbidden が返ります。
  • スコープがあっても、認可したユーザーの権限で許されない操作（編集権限の無いユーザーによる作成・更新・削除など）はできず、403 Forbidden が返ります。403 の理由はレスポンスの detail に入ります。
Security Scheme Type: HTTP
HTTP Authorization Scheme: bearer

プロフィール

Profile_me

プロフィール取得

認証ユーザーのプロフィール情報を取得します。 所属する拠点一覧を含みます。

Authorizations:
BearerAuth

Responses

Response samples

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

Subscriptions_current

現在のサブスクリプション取得

認証ユーザーの現在のサブスクリプション情報を取得します。

Authorizations:
BearerAuth

Responses

Response samples

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

拠点

Companies_list

拠点一覧取得

org配下の拠点一覧を取得します。 新プラン（orgあり）の場合、組織配下の全拠点を返します。 旧プラン（orgなし）の場合、自身の拠点1件のみを返します。

Authorizations:
BearerAuth
query Parameters
keyword
string

検索キーワード（拠点名の部分一致）

page
integer <int32>

ページ番号（デフォルト: 1）

per_page
integer <int32>

1ページあたりの件数（デフォルト: 20）

sort_by
string
Enum: "id" "name" "updated_at"

ソート対象カラム

sort_order
string
Enum: "asc" "desc"

ソート順序

include_deleted
boolean

論理削除済み拠点も含めるか（一部のアプリケーションでのみ有効）

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

物品マスタ

ItemMasters_list

物品マスタ一覧取得

組織の物品マスタ一覧を取得します。

Authorizations:
BearerAuth
query Parameters
keyword
string

キーワード検索（ID完全一致 or 物品名部分一致）

page
integer <int32>

ページ番号（デフォルト: 1）

per_page
integer <int32>

1ページあたりの件数（デフォルト: 50、許可値: 10, 50, 100）

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

ItemMasters_create

物品マスタ作成

新しい物品マスタを作成します。

Authorizations:
BearerAuth
Request Body schema: application/json
required

物品マスタ作成リクエスト

common_id
string

共通ID（省略時はUUID自動生成）

title
required
string [ 1 .. 200 ] characters

物品名（最大200文字）

etc
string <= 2000 characters

備考（最大2000文字）

item_image_cache
string

画像キャッシュ

remove_item_image
boolean

画像を削除する

Responses

Request samples

Content type
application/json
{
  • "common_id": "string",
  • "title": "string",
  • "etc": "string",
  • "item_image_cache": "string",
  • "remove_item_image": true
}

Response samples

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

ItemMasters_get

物品マスタ詳細取得

指定した物品マスタの詳細を取得します。

Authorizations:
BearerAuth
path Parameters
id
required
integer <int32>

物品マスタID

Responses

Response samples

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

ItemMasters_update

物品マスタ更新

既存の物品マスタを更新します。

Authorizations:
BearerAuth
path Parameters
id
required
integer <int32>

物品マスタID

Request Body schema: application/json
required

物品マスタ更新リクエスト

common_id
string

共通ID

title
string [ 1 .. 200 ] characters

物品名（最大200文字）

etc
string <= 2000 characters

備考（最大2000文字）

item_image_cache
string

画像キャッシュ

remove_item_image
boolean

画像を削除する

Responses

Request samples

Content type
application/json
{
  • "common_id": "string",
  • "title": "string",
  • "etc": "string",
  • "item_image_cache": "string",
  • "remove_item_image": true
}

Response samples

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

ItemMasters_delete

物品マスタ削除

物品マスタを論理削除します。

Authorizations:
BearerAuth
path Parameters
id
required
integer <int32>

物品マスタID

query Parameters
delete_inventories_option
required
string
Value: "unlink"

在庫の取り扱い方法（unlink: 紐付け解除）

Responses

Response samples

Content type
application/json
{
  • "title": "Unauthorized",
  • "status": 401,
  • "detail": "トークンが無効または未指定です"
}

在庫データ

Inventories_list

在庫一覧取得

指定した拠点の在庫一覧を取得します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

query Parameters
title
string

物品名（部分一致）

category
string

カテゴリ（完全一致）

place
string

保管場所（部分一致）

code
string

コード（完全一致）

optional_attributes_name
string

追加項目名（追加項目値とセットで指定したときのみ完全一致絞り込み有効）。 optional_attributes_value と両方指定された場合のみ絞り込まれます。片方のみの指定では無視されます。

optional_attributes_value
string

追加項目値（追加項目名とセットで指定したときのみ完全一致絞り込み有効）。 optional_attributes_name と両方指定された場合のみ絞り込まれます。片方のみの指定では無視されます。

state
string

状態で絞り込み

page
integer <int32>

ページ番号（デフォルト: 1）

per_page
integer <int32>

1ページあたりの件数（デフォルト: 100、最大: 1000）

sort_by
string
Enum: "id" "title" "quantity" "updated_at"

ソート対象カラム

sort_order
string
Enum: "asc" "desc"

ソート順序

start_updated_at
string <date-time>

レコード更新日時の下限（差分同期用、ISO8601形式、updated_at >= 指定値、指定日時を含む）

end_updated_at
string <date-time>

レコード更新日時の上限（差分同期用、ISO8601形式、updated_at < 指定値、指定日時は含まない）。 半開区間 [start_updated_at, end_updated_at) で範囲指定します。 差分同期の推奨: 次回リクエストの start_updated_at に前回の end_updated_at と同じ値を指定すれば、レコードが重複しません。

include_deleted
boolean

削除済みデータも含める（デフォルト: false）。 差分同期用途では start_updated_at と併用することを推奨します。

受理される値:

  • true として扱う値: true, "true", "1"
  • false として扱う値: false, "false", "0", 未指定, 空文字
  • 上記以外の値（例: "TRUE", "yes", "invalid"）は OpenAPI の boolean 型バリデーションで 400 エラーとなります

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Inventories_create

在庫作成

新しい在庫データを作成します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

Request Body schema: application/json
required

在庫作成リクエスト

title
required
string

物品名（必須）

quantity
string

数量

place
string

保管場所

state
string

状態

category
string

カテゴリ

unit
string

単位

code
string

コード

item_image
string

画像（Data URI形式: data:;base64,<データ>）

etc
string

備考

group_tag
string

グループタグ

object

追加項目

object

棚卸属性

object

発注点属性

is_quantity_auto_conversion_by_unit
boolean

単位換算有効

quantity_auto_conversion_by_unit_name
string

単位換算単位名

quantity_auto_conversion_by_unit_factor
string

単位換算係数

org_item_master_id
integer <int32>

物品マスタID

user_group
string

ユーザーグループ（管理者のみ設定可）

object

バリエーション設定

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "quantity": "string",
  • "place": "string",
  • "state": "string",
  • "category": "string",
  • "unit": "string",
  • "code": "string",
  • "item_image": "string",
  • "etc": "string",
  • "group_tag": "string",
  • "optional_attributes": {
    },
  • "stocktake_attributes": {
    },
  • "quantity_management_attributes": {
    },
  • "is_quantity_auto_conversion_by_unit": true,
  • "quantity_auto_conversion_by_unit_name": "string",
  • "quantity_auto_conversion_by_unit_factor": "string",
  • "org_item_master_id": 0,
  • "user_group": "string",
  • "variant_setting": {
    }
}

Response samples

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

Inventories_get

在庫詳細取得

指定した在庫データの詳細を取得します。

注意: 削除済み在庫データの詳細取得は本エンドポイントでは非対応です。 論理削除済みの在庫 ID を指定した場合、include_deleted パラメータの値にかかわらず 404 が返ります。 削除済み在庫の確認は GET /inventories に include_deleted=true を指定して一覧取得を利用してください。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

id
required
integer <int32>

在庫ID

Responses

Response samples

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

Inventories_update

在庫更新

既存の在庫データを更新します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

id
required
integer <int32>

在庫ID

Request Body schema: application/json
required

在庫更新リクエスト

title
string

物品名

quantity
string

数量

place
string

保管場所

state
string

状態

category
string

カテゴリ

unit
string

単位

code
string

コード

item_image
string

画像（Data URI形式: data:;base64,<データ>）

etc
string

備考

group_tag
string

グループタグ

object

追加項目

object

棚卸属性

object

発注点属性

is_quantity_auto_conversion_by_unit
boolean

単位換算有効

quantity_auto_conversion_by_unit_name
string

単位換算単位名

quantity_auto_conversion_by_unit_factor
string

単位換算係数

org_item_master_id
integer or null <int32>

物品マスタID。整数IDで紐付け、nullで紐付け解除、省略時は既存の紐付けを維持します。

user_group
string

ユーザーグループ（管理者のみ設定可）

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "quantity": "string",
  • "place": "string",
  • "state": "string",
  • "category": "string",
  • "unit": "string",
  • "code": "string",
  • "item_image": "string",
  • "etc": "string",
  • "group_tag": "string",
  • "optional_attributes": {
    },
  • "stocktake_attributes": {
    },
  • "quantity_management_attributes": {
    },
  • "is_quantity_auto_conversion_by_unit": true,
  • "quantity_auto_conversion_by_unit_name": "string",
  • "quantity_auto_conversion_by_unit_factor": "string",
  • "org_item_master_id": 0,
  • "user_group": "string"
}

Response samples

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

Inventories_delete

在庫削除

在庫データを論理削除します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

id
required
integer <int32>

在庫ID

Responses

Response samples

Content type
application/json
{
  • "title": "Unauthorized",
  • "status": 401,
  • "detail": "トークンが無効または未指定です"
}

セット品

InventoriesSets_list

セット品一覧取得

指定した拠点のセット品一覧を取得します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

query Parameters
page
integer <int32>

ページ番号

per_page
integer <int32>

1ページあたりの件数（デフォルト: 100, 最大: 100）

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

InventoriesSets_create

セット品作成

新しいセット品を作成します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

Request Body schema: application/json
required
title
required
string

セット品名（必須）

price
number <double>

価格

code
string

管理コード（空欄の場合はランダム値が生成される）

memo
string

メモ

required
Array of objects (Models.InventoriesSet.InventoriesSetItemRequest)

セット品明細

Responses

Request samples

Content type
application/json
{
  • "title": "テストセット",
  • "price": 1000,
  • "code": "000",
  • "memo": "メモ",
  • "inventories_set_items_attributes": [
    ]
}

Response samples

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

InventoriesSets_show

セット品詳細取得

指定したセット品の詳細を取得します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

id
required
integer <int32>

セット品ID

Responses

Response samples

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

InventoriesSets_update

セット品更新

指定したセット品を更新します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

id
required
integer <int32>

セット品ID

Request Body schema: application/json
required
title
string

セット品名

price
number <double>

価格

code
string

管理コード

memo
string

メモ

Array of objects (Models.InventoriesSet.InventoriesSetItemRequest)

セット品明細（指定した場合、既存の明細は全て削除され新しい明細に置き換わる。空配列を指定すると明細は0件になる。省略した場合、既存の明細は変更されない）

Responses

Request samples

Content type
application/json
{
  • "title": "テストセット",
  • "price": 3000,
  • "code": "003",
  • "memo": "更新メモ",
  • "inventories_set_items_attributes": [
    ]
}

Response samples

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

InventoriesSets_destroy

セット品削除

指定したセット品を物理削除します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

id
required
integer <int32>

セット品ID

Responses

Response samples

Content type
application/json
{
  • "title": "Unauthorized",
  • "status": 401,
  • "detail": "トークンが無効または未指定です"
}

在庫添付ファイル

InventoryAttachments_list

添付ファイル一覧取得

指定した在庫の添付ファイル一覧を取得します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

inventory_id
required
integer <int32>

在庫ID

Responses

Response samples

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

InventoryAttachments_create

添付ファイル作成

在庫に添付ファイルをアップロードします。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

inventory_id
required
integer <int32>

在庫ID

Request Body schema: application/json
required

添付ファイル作成リクエスト

item_file
required
string

添付ファイル（Data URI形式: data:;base64,<データ>）

original_filename
string

元のファイル名。未指定の場合はサーバー側で自動生成。拡張子がファイルのMIMEタイプと異なる場合は正しい拡張子が自動付与される。

Responses

Request samples

Content type
application/json
{
  • "item_file": "string",
  • "original_filename": "string"
}

Response samples

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

InventoryAttachments_delete

添付ファイル削除

添付ファイルを物理削除します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

inventory_id
required
integer <int32>

在庫ID

id
required
integer <int32>

添付ファイルID

Responses

Response samples

Content type
application/json
{
  • "title": "Unauthorized",
  • "status": 401,
  • "detail": "トークンが無効または未指定です"
}

追加項目

InventoryAttributes_list

在庫属性一覧取得

指定した拠点の在庫属性データ（追加項目）一覧を取得します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

query Parameters
page
integer <int32>

ページ番号

per_page
integer <int32>

1ページあたりの件数（デフォルト: 100, 最大: 100）

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

バリエーション

InventoryVariants_list

バリアント一覧取得

指定した在庫のバリアント一覧を取得します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

inventory_id
required
integer <int32>

在庫ID

query Parameters
page
integer <int32>

ページ番号（デフォルト: 1）

per_page
integer <int32>

1ページあたりの件数（デフォルト: 100、最大: 1000）

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

InventoryVariants_create

バリアント作成

指定した在庫に新しいバリアントを作成します。 variant_settingが有効な在庫のみ操作可能です。 同一data_keyの既存バリアントが存在する場合はマージされます。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

inventory_id
required
integer <int32>

在庫ID

Request Body schema: application/json
required

リクエストボディ

required
Array of objects (CreateInventoryVariantItemInput)

バリアント項目値

quantity
string

数量

code
string

バリアントコード

purchase_unit_price
string

仕入単価

packing_slip_unit_price
string

出庫単価

item_image
string

画像（base64エンコード）

Responses

Request samples

Content type
application/json
{
  • "items": [
    ],
  • "quantity": "string",
  • "code": "string",
  • "purchase_unit_price": "string",
  • "packing_slip_unit_price": "string",
  • "item_image": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "inventory_id": 0,
  • "data_key": "string",
  • "code": "string",
  • "items": [
    ],
  • "quantity": "string",
  • "logical_quantity": "string",
  • "purchase_unit_price": "string",
  • "packing_slip_unit_price": "string",
  • "item_image": {
    },
  • "update_user_name": "string",
  • "create_user_name": "string",
  • "created_at": "2025-01-01T00:00:00.000+09:00",
  • "updated_at": "2025-01-01T00:00:00.000+09:00",
  • "update_date": "2025-01-01T00:00:00.000+09:00"
}

InventoryVariants_show

バリアント詳細取得

指定した在庫バリアントの詳細を取得します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

inventory_id
required
integer <int32>

在庫ID

id
required
integer <int32>

バリアントID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "inventory_id": 0,
  • "data_key": "string",
  • "code": "string",
  • "items": [
    ],
  • "quantity": "string",
  • "logical_quantity": "string",
  • "purchase_unit_price": "string",
  • "packing_slip_unit_price": "string",
  • "item_image": {
    },
  • "update_user_name": "string",
  • "create_user_name": "string",
  • "created_at": "2025-01-01T00:00:00.000+09:00",
  • "updated_at": "2025-01-01T00:00:00.000+09:00",
  • "update_date": "2025-01-01T00:00:00.000+09:00"
}

InventoryVariants_update

バリアント更新

指定した在庫バリアントを更新します。 variant_settingが有効な在庫のみ操作可能です。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

inventory_id
required
integer <int32>

在庫ID

id
required
integer <int32>

バリアントID

Request Body schema: application/json
required

リクエストボディ

Array of objects (CreateInventoryVariantItemInput)

バリアント項目値

quantity
string

数量

code
string

バリアントコード

purchase_unit_price
string

仕入単価

packing_slip_unit_price
string

出庫単価

item_image
string

画像（base64エンコード）

Responses

Request samples

Content type
application/json
{
  • "items": [
    ],
  • "quantity": "string",
  • "code": "string",
  • "purchase_unit_price": "string",
  • "packing_slip_unit_price": "string",
  • "item_image": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "inventory_id": 0,
  • "data_key": "string",
  • "code": "string",
  • "items": [
    ],
  • "quantity": "string",
  • "logical_quantity": "string",
  • "purchase_unit_price": "string",
  • "packing_slip_unit_price": "string",
  • "item_image": {
    },
  • "update_user_name": "string",
  • "create_user_name": "string",
  • "created_at": "2025-01-01T00:00:00.000+09:00",
  • "updated_at": "2025-01-01T00:00:00.000+09:00",
  • "update_date": "2025-01-01T00:00:00.000+09:00"
}

InventoryVariants_destroy

バリアント削除

指定した在庫バリアントを論理削除します。 variant_settingが有効な在庫のみ操作可能です。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

inventory_id
required
integer <int32>

在庫ID

id
required
integer <int32>

バリアントID

Responses

Response samples

Content type
application/json
{
  • "title": "Unauthorized",
  • "status": 401,
  • "detail": "トークンが無効または未指定です"
}

カテゴリ

Categories_list

カテゴリ一覧取得

指定した拠点のカテゴリ一覧を取得します。 デフォルトの並び順は position ASC, created_at ASC です。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

query Parameters
page
integer <int32>

ページ番号（デフォルト: 1）

per_page
integer <int32>

1ページあたりの件数（デフォルト: 100, 最大: 100）

include_deleted
boolean

削除済みデータも含める（デフォルト: false）。

受理される値:

  • true として扱う値: true, "true", "1"
  • false として扱う値: false, "false", "0", 未指定, 空文字

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Categories_create

カテゴリ作成

新しいカテゴリを作成します。

同名の論理削除済カテゴリが存在する場合の挙動（復活ロジック）:

  • 同名の論理削除済カテゴリ（deleted: true）が同一拠点に存在する場合、 そのレコードを復活させて deleted: false で返します。新しい id は採番されず、 既存の id が返却される点に注意してください。
  • 復活した場合も新規作成と同じ HTTP 201 で応答します。 レスポンスから「新規作成」「復活」を区別する必要がある場合は、 クライアント側で id を事前管理してください（同じ id が返ると復活）。
  • 復活時、position は末尾（既存有効カテゴリの最大 position + 1）に再設定されます。 削除前の position には戻りません。
Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

Request Body schema: application/json
required

カテゴリ作成リクエスト

name
required
string [ 1 .. 50 ] characters ^[^,\n]*$

カテゴリ名（必須、最大50文字、, を含まない）。

同名の論理削除済カテゴリが既に存在する場合は復活させ、同IDで返却する。 position は自動採番（既存カテゴリの最大 position + 1。空なら 0）。

Responses

Request samples

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

Response samples

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

Categories_update

カテゴリ更新（部分更新）

カテゴリ名を更新します。

Web 画面での挙動との差異（重要）: Web 画面でのカテゴリ名変更とは異なり、過去の在庫データの category 文字列は 更新されません。古い名称の在庫データを新しいカテゴリ名に紐付け直す場合は、 別途在庫 API 経由で各レコードの category を更新してください。

冪等性: リクエストボディが空 {} または name 未指定の場合、リソースは変更されず HTTP 200 を返します（idempotent）。updated_at は更新されます。

論理削除済への更新: deleted: true のカテゴリの id を指定すると HTTP 404 を返します。 論理削除済を復活させたい場合は、同名で POST してください（復活ロジック）。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

id
required
integer <int32>

カテゴリID

Request Body schema: application/json
required

カテゴリ更新リクエスト

name
string [ 1 .. 50 ] characters ^[^,\n]*$

カテゴリ名（指定時のみ更新。最大50文字、, を含まない）。

注: API V2 ではカテゴリ名を変更しても、過去の在庫データの category 文字列は更新されない。

Responses

Request samples

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

Response samples

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

Categories_destroy

カテゴリ削除（論理削除）

カテゴリを論理削除します（DBレコードは残ります）。 在庫データの category 文字列はそのまま残ります。

二重削除: 既に論理削除済の id を指定すると HTTP 404 を返します。 削除済カテゴリを再利用したい場合は、同名で POST して復活させてください。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

id
required
integer <int32>

カテゴリID

Responses

Response samples

Content type
application/json
{
  • "title": "Unauthorized",
  • "status": 401,
  • "detail": "トークンが無効または未指定です"
}

出庫

PackingSlips_list

出庫データ一覧取得

出庫データの一覧を取得します。 ページネーションに対応しており、デフォルトで1ページあたり100件を返します。 出庫物品（明細）をネストして返します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

query Parameters
page
integer <int32>

ページ番号（デフォルト: 1）

per_page
integer <int32>

1ページあたりの件数（デフォルト: 100, 最大: 100）

status
string (Models.PackingSlip.PackingSlipStatus)
Enum: "before_delivery" "during_delivery" "completed_delivery"

ステータスで絞り込み

num
string

出庫番号

start_updated_at
string <date-time>

レコード更新日時の下限（差分同期用、ISO8601形式、updated_at >= 指定値、指定日時を含む）

end_updated_at
string <date-time>

レコード更新日時の上限（差分同期用、ISO8601形式、updated_at < 指定値、指定日時は含まない）。 半開区間 [start_updated_at, end_updated_at) で範囲指定します。 差分同期の推奨: 次回リクエストの start_updated_at に前回の end_updated_at と同じ値を指定すれば、レコードが重複しません。

include_deleted
boolean

削除済みデータも含める（デフォルト: false）。 差分同期用途では start_updated_at と併用することを推奨します。 include_deleted=true 時、ネストされた deliveries も削除済み明細を含めて返却します。

受理される値:

  • true として扱う値: true, "true", "1"
  • false として扱う値: false, "false", "0", 未指定, 空文字
  • 上記以外の値（例: "TRUE", "yes", "invalid"）は OpenAPI の boolean 型バリデーションで 400 エラーとなります

注意: サブスクリプションプランに応じた保持期間制限が適用されます （Free / Entry / Minimum: 2年、Lite: 5年、Full / Pro: 7年）。 保持期間を超えた古いデータは include_deleted=true でも取得できません。

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

PackingSlips_create

出庫データ作成

出庫データを作成します。 出庫物品（明細）を含めて一括作成します。 ステータスがcompleted_deliveryの場合、在庫数量が減算されます。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

Request Body schema: application/json
required

作成パラメータ

association
string
Value: "inventory_title"

在庫データ関連付け方法。 inventory_title 指定時は deliveries[].inventory_title で同名の有効在庫を検索し、 見つからない場合は在庫を自動作成します。

num
string

出庫番号

customer_name
string

取引先名

status
string
Enum: "before_delivery" "during_delivery" "completed_delivery"

ステータス

明細(deliveries[].status)に値を指定しなかった場合の初期値として伝播されます。 最終的な packing_slip 全体のステータスは、明細のステータスから自動的に再決定されます。

delivery_date
string or null <date>

出庫日（YYYY-MM-DD形式）。status が completed_delivery のとき必須。

date_of_issue
string or null <date>

発行日（YYYY-MM-DD形式）

memo
string

社内メモ（最大250文字）

note
string

備考（最大250文字）

required
Array of objects (Models.PackingSlip.CreatePackingSlipItemRequest)

出庫物品の配列。 association未指定時は各明細に inventory_id を指定し、 association=inventory_title 時は各明細に inventory_title を指定します。

Responses

Request samples

Content type
application/json
{
  • "association": "inventory_title",
  • "num": "string",
  • "customer_name": "string",
  • "status": "before_delivery",
  • "delivery_date": "2019-08-24",
  • "date_of_issue": "2019-08-24",
  • "memo": "string",
  • "note": "string",
  • "deliveries": [
    ]
}

Response samples

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

PackingSlips_show

出庫データ詳細取得

指定されたIDの出庫データを取得します。 出庫物品（明細）をネストして返します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

id
required
integer <int32>

出庫データID

query Parameters
include_deleted
boolean

削除済みデータも含める（デフォルト: false）。 include_deleted=true の場合、削除済みの親 PackingSlip と、ネストされた deliveries の削除済み明細も含めて返却します。

受理される値:

  • true として扱う値: true, "true", "1"
  • false として扱う値: false, "false", "0", 未指定, 空文字
  • 上記以外の値（例: "TRUE", "yes", "invalid"）は OpenAPI の boolean 型バリデーションで 400 エラーとなります

Responses

Response samples

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

PackingSlips_update

出庫データ更新

指定されたIDの出庫データを更新します。 出庫済みの物品は数量・ステータスの変更ができません。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

id
required
integer <int32>

出庫データID

Request Body schema: application/json
required

更新パラメータ

num
string

出庫番号

customer_name
string

取引先名

memo
string

社内メモ（最大250文字）

note
string

備考（最大250文字）

date_of_issue
string or null <date>

発行日（YYYY-MM-DD形式）

Array of objects (Models.PackingSlip.UpdatePackingSlipItemRequest)

出庫物品の配列

Responses

Request samples

Content type
application/json
{
  • "num": "string",
  • "customer_name": "string",
  • "memo": "string",
  • "note": "string",
  • "date_of_issue": "2019-08-24",
  • "deliveries": [
    ]
}

Response samples

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

PackingSlips_destroy

出庫データ削除

指定されたIDの出庫データを取消します。 出庫済みの物品がある場合、在庫数量が戻されます。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

id
required
integer <int32>

出庫データID

Responses

Response samples

Content type
application/json
{
  • "title": "Unauthorized",
  • "status": 401,
  • "detail": "トークンが無効または未指定です"
}

出庫物品

Deliveries_list

出庫物品一覧取得

出庫物品（明細）の一覧を取得します。 ページネーションに対応しており、デフォルトで1ページあたり1000件を返します。 ステータス・日付による絞り込みが可能です。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

query Parameters
page
integer <int32>

ページ番号（デフォルト: 1）

per_page
integer <int32>

1ページあたりの件数（デフォルト: 100, 最大: 100）

status
string

ステータスで絞り込み（before_delivery / during_delivery / completed_delivery）

start_date
string <date>

開始日で絞り込み（YYYY-MM-DD形式、delivery_date >= start_date）

end_date
string <date>

終了日で絞り込み（YYYY-MM-DD形式、delivery_date <= end_date）

include_deleted
boolean

削除済みデータも含める（デフォルト: false）。 差分同期用途では start_updated_at と併用することを推奨します。

取得範囲（出庫は親 PackingSlip と明細 Delivery の2段階フィルタを持つ）:

  • false (デフォルト): 有効な親 PackingSlip に紐づく、有効な Delivery のみ取得
  • true: 削除済み PackingSlip に紐づく Delivery も含め、かつ削除済み Delivery も含めて取得 （親削除時は配下の Delivery も自動的に削除状態となる既存仕様のため、実質的に全 Delivery 履歴が取得可能）

受理される値:

  • true として扱う値: true, "true", "1"
  • false として扱う値: false, "false", "0", 未指定, 空文字
  • 上記以外の値（例: "TRUE", "yes", "invalid"）は OpenAPI の boolean 型バリデーションで 400 エラーとなります
start_updated_at
string <date-time>

レコード更新日時の下限（差分同期用、ISO8601形式、updated_at >= 指定値、指定日時を含む）

end_updated_at
string <date-time>

レコード更新日時の上限（差分同期用、ISO8601形式、updated_at < 指定値、指定日時は含まない）。 半開区間 [start_updated_at, end_updated_at) で範囲指定します。 差分同期の推奨: 次回リクエストの start_updated_at に前回の end_updated_at と同じ値を指定すれば、レコードが重複しません。

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Deliveries_destroy

出庫物品削除

指定されたIDの出庫物品（明細）を取消します。 出庫済みの物品の場合、在庫数量が戻されます。 全ての明細が削除された場合、親の出庫データも論理削除されます。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

id
required
integer <int32>

出庫物品ID

Responses

Response samples

Content type
application/json
{
  • "title": "Unauthorized",
  • "status": 401,
  • "detail": "トークンが無効または未指定です"
}

入庫

Purchases_list

入庫一覧取得

入庫データの一覧を取得します。 論理削除済みのデータは除外されます。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

query Parameters
page
integer <int32>

ページ番号（デフォルト: 1）

per_page
integer <int32>

1ページあたりの件数（デフォルト: 100, 最大: 100）

status
string (PurchaseStatus)
Enum: "none" "not_ordered" "ordered" "purchased" "quotation_requested"

ステータスフィルタ

start_date
string <date>

入庫日の開始日（YYYY-MM-DD）

end_date
string <date>

入庫日の終了日（YYYY-MM-DD）

num
string

入庫番号

inventory_id
integer <int32>

在庫ID

memo
string

メモ（部分一致検索）

start_updated_at
string <date-time>

レコード更新日時の下限（差分同期用、ISO8601形式、updated_at >= 指定値、指定日時を含む）

end_updated_at
string <date-time>

レコード更新日時の上限（差分同期用、ISO8601形式、updated_at < 指定値、指定日時は含まない）。 半開区間 [start_updated_at, end_updated_at) で範囲指定します。 差分同期の推奨: 次回リクエストの start_updated_at に前回の end_updated_at と同じ値を指定すれば、レコードが重複しません。

include_deleted
boolean

削除済みデータも含める（デフォルト: false）。 差分同期用途では start_updated_at と併用することを推奨します。 include_deleted=true 時、ネストされた purchase_items も削除済み明細を含めて返却します。

受理される値:

  • true として扱う値: true, "true", "1"
  • false として扱う値: false, "false", "0", 未指定, 空文字
  • 上記以外の値（例: "TRUE", "yes", "invalid"）は OpenAPI の boolean 型バリデーションで 400 エラーとなります

注意: サブスクリプションプランに応じた保持期間制限が適用されます （Free / Entry / Minimum: 2年、Lite: 5年、Full / Pro: 7年）。 保持期間を超えた古いデータは include_deleted=true でも取得できません。

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Purchases_create

入庫作成

新しい入庫データを作成します。 statusがpurchasedの場合、在庫数量が加算されます。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

Request Body schema: application/json
required

入庫データ

association
string
Value: "inventory_title"

在庫データ関連付け方法。 inventory_title 指定時は purchase_items[].inventory_title で同名の有効在庫を検索し、 見つからない場合は在庫を自動作成します。

customer_name
string

取引先名

status
string
Enum: "none" "not_ordered" "ordered" "purchased" "quotation_requested"

ステータス

purchase_date
string or null <date>

入庫日（YYYY-MM-DD）。status が purchased のとき必須。

estimated_purchase_date
string or null <date>

入庫予定日（YYYY-MM-DD）。status に関係なく指定可能。

memo
string

メモ

etc
string

備考

required
Array of objects (CreatePurchaseItemRequest)

入庫明細（1件以上必須）。 association未指定時は各明細に inventory_id を指定し、 association=inventory_title 時は各明細に inventory_title を指定します。

Responses

Request samples

Content type
application/json
{
  • "association": "inventory_title",
  • "customer_name": "string",
  • "status": "none",
  • "purchase_date": "2019-08-24",
  • "estimated_purchase_date": "2019-08-24",
  • "memo": "string",
  • "etc": "string",
  • "purchase_items": [
    ]
}

Response samples

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

Purchases_show

入庫詳細取得

指定された入庫データの詳細を取得します。 論理削除済みの明細は除外されます。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

id
required
integer <int32>

入庫ID

query Parameters
include_deleted
boolean

削除済みデータも含める（デフォルト: false）。 include_deleted=true の場合、削除済みの親 Purchase と、ネストされた purchase_items の削除済み明細も含めて返却します。

受理される値:

  • true として扱う値: true, "true", "1"
  • false として扱う値: false, "false", "0", 未指定, 空文字
  • 上記以外の値（例: "TRUE", "yes", "invalid"）は OpenAPI の boolean 型バリデーションで 400 エラーとなります

Responses

Response samples

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

Purchases_update

入庫更新

既存の入庫データを更新します。 purchasedステータスの明細は数量・ステータスの変更が制限されます。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

id
required
integer <int32>

入庫ID

Request Body schema: application/json
required

更新データ

customer_name
string

取引先名

purchase_date
string or null <date>

入庫日（YYYY-MM-DD）。status が purchased のとき必須。

estimated_purchase_date
string or null <date>

入庫予定日（YYYY-MM-DD）。status に関係なく指定可能。

memo
string

メモ

etc
string

備考

Array of objects (CreatePurchaseItemRequest)

入庫明細

Responses

Request samples

Content type
application/json
{
  • "customer_name": "string",
  • "purchase_date": "2019-08-24",
  • "estimated_purchase_date": "2019-08-24",
  • "memo": "string",
  • "etc": "string",
  • "purchase_items": [
    ]
}

Response samples

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

Purchases_destroy

入庫削除

入庫データを論理削除します。 入庫済み明細の在庫数量は逆算されます。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

拠点ID

id
required
integer <int32>

入庫ID

Responses

Response samples

Content type
application/json
{
  • "title": "Unauthorized",
  • "status": 401,
  • "detail": "トークンが無効または未指定です"
}

入庫物品

PurchaseItems_list

入庫物品一覧取得

入庫物品（明細）の一覧を取得します。 ページネーションに対応しており、デフォルトで1ページあたり1000件を返します。 ステータス・日付による絞り込みが可能です。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

query Parameters
page
integer <int32>

ページ番号（デフォルト: 1）

per_page
integer <int32>

1ページあたりの件数（デフォルト: 100, 最大: 100）

status
string (PurchaseStatus)
Enum: "none" "not_ordered" "ordered" "purchased" "quotation_requested"

ステータスで絞り込み

start_date
string <date>

開始日で絞り込み（YYYY-MM-DD形式、purchase_date >= start_date）

end_date
string <date>

終了日で絞り込み（YYYY-MM-DD形式、purchase_date <= end_date）

include_deleted
boolean

削除済みデータも含める（デフォルト: false）。 差分同期用途では start_updated_at と併用することを推奨します。

取得範囲（入庫明細は親 Purchase と明細 PurchaseItem の2段階フィルタを持つ）:

  • false (デフォルト): 有効な親 Purchase に紐づく、有効な PurchaseItem のみ取得
  • true: 削除済み Purchase に紐づく PurchaseItem も含め、かつ削除済み PurchaseItem も含めて取得

受理される値:

  • true として扱う値: true, "true", "1"
  • false として扱う値: false, "false", "0", 未指定, 空文字
  • 上記以外の値（例: "TRUE", "yes", "invalid"）は OpenAPI の boolean 型バリデーションで 400 エラーとなります
start_updated_at
string <date-time>

レコード更新日時の下限（差分同期用、ISO8601形式、updated_at >= 指定値、指定日時を含む）

end_updated_at
string <date-time>

レコード更新日時の上限（差分同期用、ISO8601形式、updated_at < 指定値、指定日時は含まない）。 半開区間 [start_updated_at, end_updated_at) で範囲指定します。 差分同期の推奨: 次回リクエストの start_updated_at に前回の end_updated_at と同じ値を指定すれば、レコードが重複しません。

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

PurchaseItems_destroy

入庫物品削除

指定されたIDの入庫物品（明細）を取消します。 入庫済みの物品の場合、在庫数量が戻されます。 全ての明細が削除された場合、親の入庫データも論理削除されます。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

id
required
integer <int32>

入庫物品ID

Responses

Response samples

Content type
application/json
{
  • "title": "Unauthorized",
  • "status": 401,
  • "detail": "トークンが無効または未指定です"
}

発注

PurchaseOrders_Orders_list

発注一覧取得

指定した会社の発注一覧を取得します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

query Parameters
keyword
string

キーワード検索

statuses
Array of strings

ステータスフィルター

start_date
string <date>

発注日の開始日（YYYY-MM-DD）

end_date
string <date>

発注日の終了日（YYYY-MM-DD）

start_updated_at
string <date-time>

レコード更新日時の下限（差分同期用、ISO8601形式、updated_at >= 指定値）

end_updated_at
string <date-time>

レコード更新日時の上限（差分同期用、ISO8601形式、updated_at <= 指定値）

page
integer <int32>

ページ番号（デフォルト: 1）

per_page
integer <int32>

1ページあたりの件数（デフォルト: 20、最大: 50）

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

PurchaseOrders_Orders_create

発注作成

新しい発注を作成します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

Request Body schema: application/json
required

発注作成リクエスト

ordered_at
string <date-time>

発注日（省略時は現在日時）

order_number
string

発注番号

request_delivery_date
string <date>

希望納期

estimated_delivery_date
string <date>

納品予定日

note
string

備考

required
object

仕入先情報（必須）

object

発注元情報

object

配送指示情報

required
Array of objects (PurchaseOrderItemRequest) non-empty

発注明細（1件以上必須）

Responses

Request samples

Content type
application/json
{
  • "ordered_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "request_delivery_date": "2019-08-24",
  • "estimated_delivery_date": "2019-08-24",
  • "note": "string",
  • "supplier": {
    },
  • "buyer": {
    },
  • "shipping_instruction": {
    },
  • "purchase_order_items": [
    ]
}

Response samples

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

PurchaseOrders_Orders_get

発注詳細取得

指定した発注の詳細を取得します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

id
required
integer <int32>

発注ID

Responses

Response samples

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

PurchaseOrders_Orders_update

発注更新

既存の発注を更新します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

id
required
integer <int32>

発注ID

Request Body schema: application/json
required

発注更新リクエスト

ordered_at
string <date-time>

発注日

order_number
string

発注番号

request_delivery_date
string <date>

希望納期

estimated_delivery_date
string <date>

納品予定日

note
string

備考

object

仕入先情報

object

発注元情報

object

配送指示情報

Array of objects (PurchaseOrderItemRequest)

発注明細

Responses

Request samples

Content type
application/json
{
  • "ordered_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "request_delivery_date": "2019-08-24",
  • "estimated_delivery_date": "2019-08-24",
  • "note": "string",
  • "supplier": {
    },
  • "buyer": {
    },
  • "shipping_instruction": {
    },
  • "purchase_order_items": [
    ]
}

Response samples

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

PurchaseOrders_Orders_accept

発注受領

発注を受領します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

id
required
integer <int32>

発注ID

Request Body schema: application/json
optional

発注受領リクエスト

estimated_delivery_date
string <date>

納品予定日

Responses

Request samples

Content type
application/json
{
  • "estimated_delivery_date": "2019-08-24"
}

Response samples

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

PurchaseOrders_Orders_cancel

発注キャンセル

発注をキャンセルします。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

id
required
integer <int32>

発注ID

Request Body schema: application/json
required

発注キャンセルリクエスト

cancel_reason
string

キャンセル理由

Responses

Request samples

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

Response samples

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

PurchaseOrders_Orders_complete

発注完了

発注を完了します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

id
required
integer <int32>

発注ID

Responses

Response samples

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

PurchaseOrders_Orders_submit

発注送信

発注を仕入先に送信します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

id
required
integer <int32>

発注ID

Responses

Response samples

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

受注

SalesOrders_Orders_list

受注一覧取得

指定した会社の受注一覧を取得します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

query Parameters
keyword
string

キーワード検索

transaction_type
string

取引区分フィルター

start_updated_at
string <date-time>

レコード更新日時の下限（差分同期用、ISO8601形式、updated_at >= 指定値）

end_updated_at
string <date-time>

レコード更新日時の上限（差分同期用、ISO8601形式、updated_at <= 指定値）

page
integer <int32>

ページ番号（デフォルト: 1）

per_page
integer <int32>

1ページあたりの件数（デフォルト: 20、最大: 50）

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

SalesOrders_Orders_create

受注作成

新しい受注を作成します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

Request Body schema: application/json
required

受注作成リクエスト

order_number
string

受注番号

ordered_at
string <date-time>

受注日

transaction_type
string
Enum: "internal" "external"

取引区分

estimated_delivery_date
string <date>

希望納期

request_delivery_date
string <date>

依頼納期

note
string

備考

required
object

発注元情報

object

出荷先情報

required
Array of objects (SalesOrderItemRequest) non-empty

受注明細（1件以上必須）

Array of objects (SalesOrderChargeRequest) <= 20 items

受注費用明細（送料・値引き等。省略時は費用行なし。最大20件）

Responses

Request samples

Content type
application/json
{
  • "order_number": "string",
  • "ordered_at": "2019-08-24T14:15:22Z",
  • "transaction_type": "internal",
  • "estimated_delivery_date": "2019-08-24",
  • "request_delivery_date": "2019-08-24",
  • "note": "string",
  • "buyer": {
    },
  • "shipping_instruction": {
    },
  • "sales_order_items": [
    ],
  • "sales_order_charges": [
    ]
}

Response samples

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

SalesOrders_Orders_get

受注詳細取得

指定した受注の詳細を取得します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

id
required
integer <int32>

受注ID

Responses

Response samples

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

SalesOrders_Orders_update

受注更新

既存の受注を更新します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

id
required
integer <int32>

受注ID

Request Body schema: application/json
required

受注更新リクエスト

order_number
string

受注番号

ordered_at
string <date-time>

受注日

transaction_type
string
Enum: "internal" "external"

取引区分

estimated_delivery_date
string <date>

希望納期

request_delivery_date
string <date>

依頼納期

note
string

備考

object

発注元情報

object

出荷先情報

Array of objects (SalesOrderItemRequest)

受注明細

Array of objects (SalesOrderChargeRequest) <= 20 items

受注費用明細。キー自体を省略すると既存の費用行を変更しない。[] は全削除。id 有りは更新、無しは追加、配列に無い既存 id は削除。最大20件。 受注ステータスにより反映範囲が変わる: unconfirmed / confirmed は全項目・追加・削除、completed は既存 id の note のみ（追加・削除・金額項目は無視）、cancelled は変更不可。 費用明細だけを更新する場合も sales_order_items（既存明細の id を含む）は必須

Responses

Request samples

Content type
application/json
{
  • "order_number": "string",
  • "ordered_at": "2019-08-24T14:15:22Z",
  • "transaction_type": "internal",
  • "estimated_delivery_date": "2019-08-24",
  • "request_delivery_date": "2019-08-24",
  • "note": "string",
  • "buyer": {
    },
  • "shipping_instruction": {
    },
  • "sales_order_items": [
    ],
  • "sales_order_charges": [
    ]
}

Response samples

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

SalesOrders_Orders_cancel

受注キャンセル

受注をキャンセルします。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

id
required
integer <int32>

受注ID

Request Body schema: application/json
required

受注キャンセルリクエスト

cancel_reason
required
string <= 1000 characters

キャンセル理由（必須）

Responses

Request samples

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

Response samples

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

SalesOrders_Orders_confirm

受注確定

受注を確定します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

id
required
integer <int32>

受注ID

Request Body schema: application/json
optional

受注確定リクエスト

agree_warning
boolean

上限超過時の警告同意フラグ

Responses

Request samples

Content type
application/json
{
  • "agree_warning": true
}

Response samples

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

商品マスタ

SalesOrders_ItemMasters_list

商品マスタ一覧取得

指定した会社の商品マスタ一覧を取得します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

query Parameters
item_code
string

商品コード（部分一致検索）

title
string

商品名（部分一致検索）

sort_by
string

ソート対象（id, item_code, title, created_at, updated_at）

sort_order
string

ソート順序（asc, desc）

page
integer <int32>

ページ番号（デフォルト: 1）

per_page
integer <int32>

1ページあたりの件数（デフォルト: 20、最大: 50）

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

SalesOrders_ItemMasters_create

商品マスタ作成

新しい商品マスタを作成します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

Request Body schema: application/json
required

商品マスタ作成リクエスト

item_code
required
string

商品コード（会社内で一意）

title
required
string

商品名

unit_id
required
integer <int32>

単位ID

quantity_per_package
required
number <double>

入数

inventory_id
required
integer <int32>

在庫ID（デフォルトSalesItemSetに紐付け）

price
number <double>

金額

description
string

商品説明

Responses

Request samples

Content type
application/json
{
  • "item_code": "string",
  • "title": "string",
  • "unit_id": 0,
  • "quantity_per_package": 0.1,
  • "inventory_id": 0,
  • "price": 0.1,
  • "description": "string"
}

Response samples

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

SalesOrders_ItemMasters_get

商品マスタ詳細取得

指定した商品マスタの詳細を取得します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

id
required
integer <int32>

商品マスタID

Responses

Response samples

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

SalesOrders_ItemMasters_update

商品マスタ更新

既存の商品マスタを更新します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

id
required
integer <int32>

商品マスタID

Request Body schema: application/json
required

商品マスタ更新リクエスト

item_code
string

商品コード

title
string

商品名

unit_id
integer <int32>

単位ID

quantity_per_package
number <double>

入数

inventory_id
integer <int32>

在庫ID

price
number <double>

金額

description
string

商品説明

remove_thumbnail
boolean

サムネイル削除フラグ

Responses

Request samples

Content type
application/json
{
  • "item_code": "string",
  • "title": "string",
  • "unit_id": 0,
  • "quantity_per_package": 0.1,
  • "inventory_id": 0,
  • "price": 0.1,
  • "description": "string",
  • "remove_thumbnail": true
}

Response samples

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

SalesOrders_ItemMasters_delete

商品マスタ削除

商品マスタを論理削除します。

Authorizations:
BearerAuth
path Parameters
company_id
required
integer <int32>

会社ID

id
required
integer <int32>

商品マスタID

Responses

Response samples

Content type
application/json
{
  • "title": "Unauthorized",
  • "status": 401,
  • "detail": "トークンが無効または未指定です"
}

Webhook

zaico のデータが変わったときに、あらかじめ設定した通知先 URL へ HTTP リクエストで通知します。通知するイベントは次の 4 つです。通知する条件とペイロードは、このグループの各イベントを参照してください。

  • 数量変更（changed_quantity）: 在庫データの数量が変わったとき
  • 在庫データ変更（changed_inventory）: 在庫データの項目が変わったとき
  • 入庫ステータス変更（changed_purchase_status）: 入庫データのステータスが変わったとき
  • 出庫ステータス変更（changed_packing_slip_status）: 出庫データのステータスが変わったとき

設定方法

Web版 zaico の「設定」→「環境設定」→「利用機能設定」にある Webhook から設定画面を開き、イベントごとに通知の有効・無効と通知先 URL を設定します。設定は拠点ごとに行い、管理者だけが変更できます。手順は、ヘルプ記事「Webhook機能の使い方」を参照してください。

利用できるプラン

新プランのベーシック・プロフェッショナルと、旧プランのフル・pro で利用できます。

送信元の検証

通知が zaico から送られたものかどうかは、リクエストヘッダー x-zaico-signature-256 で検証できます。値は、sha256= に続けて、リクエストボディをシークレットトークンで HMAC-SHA256 した結果を 16 進数で表したものです。シークレットトークンは Webhook の設定画面で確認できます。

受け取ったリクエストボディ（パースする前の文字列）から同じ方法で計算し、ヘッダーの値と一致することを確かめてください。Ruby の例:

def verify_signature(payload_body)
  signature = 'sha256=' + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), ENV['SECRET_TOKEN'], payload_body)
  return halt 500, "Invalid signature" unless Rack::Utils.secure_compare(signature, request.env['HTTP_X_ZAICO_SIGNATURE_256'])
end

zaico は送信元の IP アドレスを公開していません。送信元の検証にはこのヘッダーを使ってください。

シークレットトークンの再生成

シークレットトークンは Webhook の設定画面で再生成できます。再生成した後に発生したイベントの通知は、新しいシークレットトークンで署名されます。再生成の時点で送信中・再送中だった通知は、再生成する前のシークレットトークンで署名されたまま届きます。稼働中の受け口でシークレットトークンを再生成する場合は、しばらくの間、再生成する前のシークレットトークンでも検証することをおすすめします。

レスポンス

通知を受け取れたかどうかは、レスポンスのステータスコードで判断します。

ステータスコード 扱い
2xx 成功
それ以外 失敗（再送します）

処理する必要のない通知を受け取った場合も、2xx を返してください。2xx 以外を返すと再送されます。

リダイレクト（3xx）を返した場合は転送先へリクエストし直し、転送先のステータスコードで判断します。リダイレクトの種類によってはペイロードが転送先へ送られないため、通知先 URL にはリダイレクトを返さない URL を設定してください。

タイムアウト

通知を受け取ったら、1 秒以内に 2xx を返してください。2 秒以内に応答が無い場合は失敗として扱い、再送します。

再送

失敗した通知は、約 1 分間隔で再送します。最初の送信から 1 日が過ぎると、再送を打ち切ります。間隔と期間は予告なく変わることがあります。

通知順序

通知が届く順序は、イベントが発生した順序と前後することがあります。

処理の冪等性

同じ通知が 2 回以上届くことがあります。通知を受け取ったときの処理は、同じ通知を繰り返し受け取っても結果が変わらないようにしてください。同じ通知は、リクエストヘッダー x-zaico-request-id の値が同じです。

共通のリクエストヘッダー

通知は POST で送られ、次のヘッダーが付きます。

ヘッダー 値
user-agent ZaicoWebhook/1.0
content-type application/json
x-zaico-company-id 拠点 ID。公開API v2 のパスの company_id と同じ値です。例: 123456
x-zaico-event イベントの種別。例: changed_quantity
x-zaico-request-id 通知ごとの ID（UUID）。再送でも同じ値が送られます。例: 432dc9c5-7d14-49e7-8199-05c2a76fddd3
x-zaico-signature-256 sha256= に続けて、リクエストボディをシークレットトークンで HMAC-SHA256 した結果を 16 進数で表したもの。例: sha256=43bb5cf48442edfd14d6d97fa81cb563569e4992666bf75730334477f473e5ff

ヘッダー名は、大文字と小文字を区別せずに読んでください。通信の方式によって、X-Zaico-Event のように先頭が大文字で届くことがあります。

通知先 URL の制限

  • スキームは http または https です。
  • 長さは 1,024 文字までです。
  • ホストに IP アドレスを直接指定することはできません。
  • localhost、名前解決できないホスト、内部のアドレスに解決されるホストは指定できません。

数量変更 Webhook

在庫データの数量が変わったときに通知します。x-zaico-event ヘッダーの値は changed_quantity です。

通知するのは、登録済みの在庫データの数量が変わったときです。在庫データを新しく作成したときは通知しません。

Request Body schema: application/json
required
required
object

数量が変わった在庫データ

Responses

Request samples

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

在庫データ変更 Webhook

在庫データの項目が変わったときに通知します。x-zaico-event ヘッダーの値は changed_inventory です。

通知するのは、登録済みの在庫データで、追加項目か下の表の項目のいずれかが変わったときです。次の場合は通知しません。

  • 在庫データを新しく作成したとき
  • 在庫データを削除・復元したとき、削除済みの在庫データを更新したとき
  • 値を変えずに保存し直したとき、下の表に無い項目だけが変わったとき

changed_attributes には、変わった項目に対応する下の表の値が入ります。追加項目が変わった場合は、changed_optional_attributes に追加項目の名前が入ります（changed_attributes には入りません）。

changed_attributes の値 項目
title 物品名
quantity 数量
category カテゴリ
state 状態
code コード（QRコード・バーコードの値）
etc 備考
group_tag グループタグ
place 保管場所
unit 単位
is_quantity_auto_conversion_by_unit 単位換算有効
quantity_auto_conversion_by_unit_name 単位換算単位名
quantity_auto_conversion_by_unit_factor 単位換算係数
user_group ユーザーグループ

通知の対象になる項目は予告なく増えることがあります。この表に無い値が入っていても処理できるようにしてください。

Request Body schema: application/json
required
inventory_id
required
integer <int32>

在庫ID

changed_attributes
required
Array of strings

変更された標準の項目の名前。入りうる値はイベントの説明を参照

changed_optional_attributes
required
Array of strings

変更された追加項目の名前

updated_at
required
string <date-time>

更新日時（ISO 8601形式。マイクロ秒まで）

Responses

Request samples

Content type
application/json
{
  • "inventory_id": 123,
  • "changed_attributes": [
    ],
  • "changed_optional_attributes": [
    ],
  • "updated_at": "2024-11-08T16:26:54.493728+09:00"
}

入庫ステータス変更 Webhook

入庫データのステータスが変わったときに通知します。入庫データを新しく作成したときも通知します。x-zaico-event ヘッダーの値は changed_purchase_status です。

  • ペイロードに入庫物品（明細）は含まれません。明細は、公開API v2 の入庫詳細取得（GET /api/v2/orgs/companies/{company_id}/purchases/{id}.json）で取得してください。パスの company_id には x-zaico-company-id ヘッダーの値を、id にはペイロードの purchase.id を指定します。
  • 入庫データ全体のステータスは、明細のステータスから決まります。たとえば、すべての明細が入庫済みになるまで、全体のステータスは purchased になりません。このため、一部の明細だけが入庫済みになっても、通知されないことがあります。
Request Body schema: application/json
required
required
object

ステータスが変わった入庫データ（明細は含まない）

Responses

Request samples

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

出庫ステータス変更 Webhook

出庫データのステータスが変わったときに通知します。出庫データを新しく作成したときも通知します。x-zaico-event ヘッダーの値は changed_packing_slip_status です。

  • ペイロードに出庫物品（明細）は含まれません。明細は、公開API v2 の出庫データ詳細取得（GET /api/v2/orgs/companies/{company_id}/packing_slips/{id}.json）で取得してください。パスの company_id には x-zaico-company-id ヘッダーの値を、id にはペイロードの packing_slip.id を指定します。
  • 出庫データ全体のステータスは、明細のステータスから決まります。たとえば、すべての明細が出庫済みになるまで、全体のステータスは completed_delivery になりません。このため、一部の明細だけが出庫済みになっても、通知されないことがあります。
Request Body schema: application/json
required
required
object

ステータスが変わった出庫データ（明細は含まない）

Responses

Request samples

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