出庫取得

GET

/shipping/{shipping_id}

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/shipping/4?fields=shippingId%2CreceivingStoreId&with_details=all';
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/shipping/4?fields=shippingId%2CreceivingStoreId&with_details=all'

出庫情報を取得します。

対象プラン

リテールビジネス

Authorizations

AppAccessToken
pos.transfers:read

Parameters

Path Parameters

shipping_id

required

string

出庫ID

Example

Query Parameters

fields

array

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

Example

shippingId,receivingStoreId

with_details

string

default: none

Allowed values: all none

明細取得フラグ：出庫明細を付加するか(付加する場合はall, しない場合はnone)

Example

all

Responses

200

取得成功

application/json

object

shippingId

出庫ID：自動採番

string

receivingStoreId

入庫店舗ID

string

shippingStoreId

出庫店舗ID

string

receivingDesiredDate

入庫希望日：[YYYY-MM-DD]

string

nullable

receivingExpectedDateFrom

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

string

receivingExpectedDateTo

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

string

shippingDate

出庫日：[YYYY-MM-DD]

string

staffId

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

string

requestStaffId

出庫依頼スタッフID：出庫依頼登録時のスタッフID

string

nullable

memo

入庫/出庫メモ

string

identificationNo

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

string

status

状態：出庫/入庫の状況を設定。
0:未出庫、1:未入庫、2:入庫検品中、3:入庫完了

string

approvalStatus

承認ステータス：未設定の場合 0:未承認を設定。
0:未承認、1:承認済、2:承認拒否、3:依頼未承認

string

approvalDateTime

承認日時：出庫承認日時／承認拒否日時。[YYYY-MM-DDThh:mm:ssTZD]

string

modificationRequestStatus

修正依頼ステータス：出庫情報の修正依頼ステータスを設定。
0:修正依頼なし、1:修正依頼あり、2:修正完了

string

modificationRequestDateTime

修正依頼日時：修正依頼を行った日時を設定。[YYYY-MM-DDThh:mm:ssTZD]

string

nullable

modificationRequestCheckedDateTime

修正依頼確認完了日時：修正依頼ステータスが修正完了になった日時を設定。[YYYY-MM-DDThh:mm:ssTZD]

string

nullable

insDateTime

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

string

updDateTime

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

string

details

出庫明細

Array<object>

object

shippingDetailId

出庫明細ID

string

shippingId

出庫ID

string

productId

商品ID

string

requestQuantity

出庫依頼数：出庫依頼された数量を設定。

string

nullable

quantity

出庫数：出庫した数量を設定。

string

rfidTags

RFIDタグリスト

Array<string>

insDateTime

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

string

updDateTime

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

string

Example

{
  "shippingId": "4",
  "receivingStoreId": "2",
  "shippingStoreId": "1",
  "receivingDesiredDate": null,
  "receivingExpectedDateFrom": "2025-01-01",
  "receivingExpectedDateTo": "2025-01-02",
  "shippingDate": "2025-01-01",
  "staffId": "1",
  "requestStaffId": null,
  "memo": "出庫メモ",
  "identificationNo": "123456789",
  "status": "1",
  "approvalStatus": "1",
  "approvalDateTime": "2025-01-01T00:00:00+09:00",
  "modificationRequestStatus": "0",
  "modificationRequestDateTime": null,
  "modificationRequestCheckedDateTime": null,
  "insDateTime": "2025-01-01T00:00:00+09:00",
  "updDateTime": "2025-01-01T00:00:00+09:00",
  "details": [
    {
      "shippingDetailId": "4",
      "shippingId": "4",
      "productId": "8000001",
      "requestQuantity": null,
      "quantity": "2",
      "rfidTags": [
        "RFID001",
        "RFID002"
      ],
      "insDateTime": "2025-01-01T00:00:00+09:00",
      "updDateTime": "2025-01-01T00:00:00+09:00"
    }
  ]
}

404

リソースが存在しない場合

application/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

リソースが存在しない場合

{
  "type": "about:blank",
  "title": "NotFound",
  "detail": "指定されたIDのリソースが見つかりません",
  "status": 404
}