出荷取得

GET

/shipments/{shipment_id}

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/shipments/2?fields=shipmentStoreId%2CrecipientType&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/shipments/2?fields=shipmentStoreId%2CrecipientType&with_details=all'

出荷を取得します。

対象プラン

リテールビジネス

Authorizations

AppAccessToken
pos.orders:read

Parameters

Path Parameters

shipment_id

required

string

出荷ID

Example

Query Parameters

fields

array

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

Example

shipmentStoreId,recipientType

with_details

string

default: none

Allowed values: all none

出荷明細を付加するか(付加する場合はall, しない場合はnone)

Example

all

Responses

200

取得成功

application/json

object

shipmentId

出荷ID

string

shipmentStoreId

出荷店舗ID

string

recipientType

受取先タイプ：1：仕入先、3：その他

string

Allowed values: 1 3

recipientId

受取先ID：受取先タイプのID

string

recipientName

受取先名：登録時の受取先名

string

shipmentDivision

出荷区分：0:出荷、1:返品、2:販促品

string

Allowed values: 0 1 2

shipmentDate

出荷日：[YYYY-MM-DD]

string

memo

メモ

string

staffId

スタッフID

string

taxRate

税率：出荷時の税率

string

identificationNo

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

string

roundingDivision

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

string

Allowed values: 0 1 2

status

出荷ステータス：(0:未出荷、2:出荷済、3:出荷検品中)※3:出荷検品中はAPIでの指定のみ

string

Allowed values: 0 2 3

approvalStatus

承認ステータス：0:未承認, 1:承認済, 2:承認拒否

string

Allowed values: 0 1 2

approvalDateTime

承認日時：出荷承認日時／承認拒否日時

string

insDateTime

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

string

updDateTime

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

string

details

出荷明細一覧

Array<object>

object

shipmentDetailId

出荷明細ID 自動採番

string

shipmentId

出荷ID 自動採番

string

productId

商品ID

string

taxRate

税率：出荷時の商品税率

string

cost

原価(外税)

string

price

商品単価(内税)。商品マスタの価格が自動入力される

string

quantity

出荷数

string

memo

メモ

string

rfidTags

RFIDタグリスト

Array<string>

insDateTime

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

string

updDateTime

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

string

Example

{
  "shipmentId": "2",
  "shipmentStoreId": "2",
  "recipientType": "1",
  "recipientId": "2",
  "recipientName": "仕入先2",
  "shipmentDivision": "0",
  "shipmentDate": "2025-01-01",
  "memo": "出荷メモ",
  "staffId": "1",
  "taxRate": "10.000",
  "identificationNo": "123456789",
  "roundingDivision": "1",
  "status": "2",
  "approvalStatus": "1",
  "approvalDateTime": "2025-01-01T00:00:00+09:00",
  "insDateTime": "2025-01-01T00:00:00+09:00",
  "updDateTime": "2025-01-01T00:00:00+09:00",
  "details": [
    {
      "shipmentDetailId": "2",
      "shipmentId": "2",
      "productId": "8000001",
      "taxRate": "10.000",
      "cost": "100.00000",
      "price": "500",
      "quantity": "5",
      "memo": "出荷明細メモ2",
      "rfidTags": [
        "RFID001",
        "RFID002"
      ],
      "insDateTime": "2025-01-01T00:00:00+09:00",
      "updDateTime": "2025-01-01T00:00:00+09:00"
    }
  ]
}