入荷一覧取得

GET

/storage

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/storage?fields=storageId%2CsupplierId&sort=storageId&limit=10&page=2&storage_info_id=100&supplier_id=2&storage_store_id=1&storage_date=2025-01-01';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/storage?fields=storageId%2CsupplierId&sort=storageId&limit=10&page=2&storage_info_id=100&supplier_id=2&storage_store_id=1&storage_date=2025-01-01'

入荷情報一覧を取得します。

対象プラン

リテールビジネス

Authorizations

AppAccessToken
pos.orders:read

Parameters

Query Parameters

fields

array

検索パラメータ（カンマ区切りで指定可）
Response項目を指定可能
※一部項目(withで指定する項目、2階層目以降の項目)については指定不可

Example

storageId,supplierId

sort

string

並び順（カンマ区切りで指定可）

指定可能なパラメータ

storageId：入荷ID
storageInfoId：発注ID：発注登録から作成された入荷の場合のみ、発注IDを設定。
supplierId：仕入先ID
storageStoreId：入荷店舗ID
storageDate：入荷日：
updDateTime：更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

Example

storageId

limit

integer

上限数

Example

page

integer

ページ

Example

storage_info_id

string

発注ID：発注登録から作成された入荷の場合のみ、発注IDを設定。

Example

supplier_id

string

仕入先ID

Example

storage_store_id

string

入荷店舗ID

Example

storage_date

string

入荷日：

Example

2025-01-01

Responses

200

取得成功

application/json

Array<object>

object

storageId

入荷ID

string

storageInfoId

発注ID：発注登録から作成された入荷の場合のみ、発注IDを設定。

string

supplierId

仕入先ID

string

storageStoreId

入荷店舗ID

string

storageExpectedDateFrom

入荷予定日From：[YYYY-MM-DD]

string

storageExpectedDateTo

入荷予定日To：[YYYY-MM-DD]

string

storageDate

入荷日

string

memo

メモ

string

staffId

スタッフID

string

identificationNo

識別番号：入荷情報を管理するための任意の文字列を設定出来る項目。

string

roundingDivision

税丸め（0:四捨五入、1:切り捨て、2:切り上げ）

string

Allowed values: 0 1 2

status

ステータス：入荷ステータス(0:未入荷、1:検品中、2:入荷完了)

string

Allowed values: 0 1 2

insDateTime

作成日時：登録時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string

updDateTime

更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string

Example

[
  {
    "storageId": "1",
    "storageInfoId": "100",
    "supplierId": "2",
    "storageStoreId": "1",
    "storageExpectedDateFrom": "2025-01-01",
    "storageExpectedDateTo": "2025-01-02",
    "storageDate": "2025-01-01",
    "memo": "入荷メモ",
    "staffId": "1",
    "identificationNo": "123456789",
    "roundingDivision": "1",
    "status": "2",
    "insDateTime": "2025-01-01T00:00:00+09:00",
    "updDateTime": "2025-01-01T00:00:00+09:00"
  }
]