入庫一覧取得

GET

/receiving

curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/receiving?fields=receivingId%2CreceivingStoreId&sort=receivingId&limit=10&page=2&receiving_id=1&shipping_id=1&receiving_store_id=2&shipping_store_id=1&receiving_date=2025-01-01&identification_no=123456789&status=0'

• サンドボックス
• 本番

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

対象プラン

• リテールビジネス

Authorizations

• AppAccessToken
  pos.transfers:read

Parameters

Query Parameters

fields

array

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

Example

receivingId,receivingStoreId

sort

string

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

指定可能なパラメータ

• receivingId：入庫ID
• shippingId：出庫ID
• shippingStoreId：出庫店舗ID
• receivingStoreId：入庫店舗ID
• receivingDate：入庫日：[YYYY-MM-DD]
• status：状態：入庫状態を設定。 0：未入庫、1：検品中、2：入庫完了
• identificationNo：識別番号：出庫/入庫情報を管理するための任意の文字列を設定出来る項目。
• updDateTime：更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

Example

receivingId

limit

integer

上限数

Example

10

page

integer

ページ

Example

2

receiving_id

string

入庫ID

Example

1

shipping_id

string

出庫ID

Example

1

receiving_store_id

string

入庫店舗ID

Example

2

shipping_store_id

string

出庫店舗ID

Example

1

receiving_date

string

入庫日：[YYYY-MM-DD]

Example

2025-01-01

identification_no

string

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

Example

123456789

status

string

Allowed values: 0 1 2

状態：入庫状態を設定。 0：未入庫、1：検品中、2：入庫完了

Example

0

Responses

200

取得成功

Media typeapplication/json

Array<object>

object

receivingId

入庫ID

string

shippingId

出庫ID

string

receivingStoreId

入庫店舗ID

string

shippingStoreId

出庫店舗ID

string

receivingExpectedDateFrom

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

string

receivingExpectedDateTo

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

string

receivingDate

入庫日：[YYYY-MM-DD]

string

memo

入庫/出庫メモ

string

staffId

スタッフID：入庫登録時のスタッフID

string

status

状態：入庫状態を設定。 0：未入庫、1：検品中、2：入庫完了

string

Allowed values: 0 1 2

identificationNo

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

string

insDateTime

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

string

updDateTime

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

string

Example

[
  {
    "receivingId": "1",
    "shippingId": "1",
    "receivingStoreId": "2",
    "shippingStoreId": "1",
    "receivingExpectedDateFrom": "2025-01-01",
    "receivingExpectedDateTo": "2025-01-02",
    "receivingDate": "2025-01-01",
    "memo": "入庫メモ",
    "staffId": "2",
    "status": "2",
    "identificationNo": "123456789",
    "insDateTime": "2025-01-01T00:00:00+09:00",
    "updDateTime": "2025-01-01T00:01:00+09:00"
  }
]