マスタ
ブランドや色など、品番が参照するコードを登録・参照します。
マスタは、品番や伝票が参照するコードです。参照には kikan_masters_read、登録と更新には kikan_masters_write が必要です。
各リソースは次の3つです。{code} は、そのマスタのコードです。単体の PUT では、コードはパスに書きます。一括登録では、各要素の中にコードの項目を書きます。
| メソッド | パス |
|---|---|
| GET | /{リソース} |
| GET | /{リソース}/{code} |
| PUT | /{リソース}/{code} |
共通の項目は name（作成時は必須）です。一覧と1件の取得では、created_at と updated_at も返ります。
リソース
| パス | コードの項目 | 追加の項目 |
|---|---|---|
/brands | brand_code | なし |
/seasons | season_code | なし |
/categories | category_code | なし |
/colors | color_code | なし |
/sizes | size_code | なし |
/suppliers | supplier_code | なし |
/channels | code | sort_order（整数、省略時 0） |
/currencies | code | rate（数値、省略時 1） |
/order_purposes | purpose_code | requires_launch_date（真偽、省略時 false）、sort_order |
/customers | customer_code | type、default_rate |
/lessees | name | contact_person、tel、email、address、note、sort_order |
リース先だけ、コードの項目が name です。パスも名前です。
通貨は削除状態を持ちません。それ以外は、画面から削除した行は API の一覧に出ません。同じコードで PUT すると、また有効になります。
{ "name": "ブランドA" }PUT /v1/brands/BR01 のように送ります。