コンテンツにスキップ
スマレジ・プラットフォームAPI リファレンス

出荷登録

POST
/shipments
curl --request POST \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/shipments \
  --header 'Content-Type: application/json' \
  --data '{ "shipmentStoreId": "2", "recipientType": "1", "recipientId": "2", "recipientName": null, "shipmentDivision": "0", "shipmentDate": "2025-01-01", "memo": "出荷メモ", "staffId": "1", "taxRate": "10.000", "identificationNo": "123456789", "roundingDivision": "1", "status": "2", "approvalStatus": "1", "details": [ { "productId": "8000001", "taxRate": "10.000", "cost": "100", "quantity": "5", "memo": "出荷明細メモ1" } ] }'

出荷を登録します。

対象プラン

  • リテールビジネス

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”
Media typeapplication/json
object
shipmentStoreId
required
出荷店舗ID

出荷店舗ID

string format: int
>= 1 <= 999999999
recipientType
required
受取先タイプ

受取先タイプ：1：仕入先、3：その他(1,3のみ有効)

string
Allowed values: 1 3
recipientId
受取先ID

受取先ID：仕入先IDを入力(受取先タイプ=1の場合、入力必須。それ以外入力不可)

string format: int
>= 1 <= 9999999999
recipientName
受取先名

受取先名：登録時の受取先名 受取先タイプ=3の場合、入力必須。それ以外入力不可 受取先タイプ=1の場合、仕入先名を自動で設定。

string
nullable <= 85 characters
shipmentDivision
required
出荷区分

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

string
Allowed values: 0 1 2
shipmentDate
出荷日

出荷日：[YYYY-MM-DD]
未設定の場合、登録日で設定。

string format: date
memo
メモ

メモ

string
<= 1000 characters
staffId
スタッフID

スタッフID

string format: int
>= 1 <= 9999999999
taxRate
税率

税率：出荷時の税率
小数点3桁まで
未設定の場合、出荷登録時の税率を設定。

string format: decimal
<= 100
identificationNo
識別番号

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

string
<= 32 characters
roundingDivision
税丸め

税丸め（0:四捨五入、1:切り捨て、2:切り上げ）
未設定の場合、1:切り捨てで設定する。

string
Allowed values: 0 1 2
status
required
出荷ステータス

出荷ステータス：(0:未出荷、2:出荷済、3:出荷検品中)
※2:出荷済を指定すると、確定データとなり更新不可になります
※3:出荷検品中はAPIからのみ指定できます。

string
Allowed values: 0 2 3
approvalStatus
承認ステータス

承認ステータス：0:未承認, 1:承認済, 2:承認拒否
未設定の場合かつ在庫管理設定の「承認機能」を利用しない場合、1:承認済が設定されます。
未設定の場合かつ在庫管理設定の「承認機能」を利用する場合、出荷ステータスが 0:未出荷 の場合は 0:未承認 、出荷ステータスが 2:出荷済 または 3:出荷検品中 の場合は 1:承認済 が設定されます。

string
Allowed values: 0 1 2
details
required
出荷明細

出荷明細
※明細の最大件数は500件です

Array<object>
object
productId
商品ID

商品ID

string format: int
>= 1 <= 999999999999999
taxRate
税率

税率：出荷時の商品税率
小数点3桁まで
未設定の場合、出荷登録時の税率を設定。

string format: decimal
<= 100
cost
原価(外税)

原価(外税) 未指定時には商品マスタの原価が自動入力される

string format: decimal
>= -99999999.99999 <= 99999999.99999
quantity
出荷数

出荷数

string format: int
>= 1 <= 99999
memo
メモ

メモ

string
<= 1000 characters
Example
{
  "shipmentStoreId": "2",
  "recipientType": "1",
  "recipientId": "2",
  "recipientName": null,
  "shipmentDivision": "0",
  "shipmentDate": "2025-01-01",
  "memo": "出荷メモ",
  "staffId": "1",
  "taxRate": "10.000",
  "identificationNo": "123456789",
  "roundingDivision": "1",
  "status": "2",
  "approvalStatus": "1",
  "details": [
    {
      "productId": "8000001",
      "taxRate": "10.000",
      "cost": "100",
      "quantity": "5",
      "memo": "出荷明細メモ1"
    }
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

取得成功

Media typeapplication/json
object
shipmentId

出荷ID 自動採番

string
shipmentStoreId

出荷店舗ID

string
recipientType

受取先タイプ：1：仕入先、3：その他(1,3のみ有効)

string
Allowed values: 1 3
recipientId

受取先ID：仕入先IDを入力(受取先タイプ=1の場合、入力必須。それ以外入力不可)

string
recipientName

受取先名：登録時の受取先名 受取先タイプ=3の場合、入力必須。それ以外入力不可 受取先タイプ=1の場合、仕入先名を自動で設定。

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:出荷検品中)
※2:出荷済を指定すると、確定データとなり更新不可になります
※3:出荷検品中はAPIからのみ指定できます。

string
Allowed values: 0 2 3
approvalStatus

承認ステータス：0:未承認, 1:承認済, 2:承認拒否
未設定の場合かつ在庫管理設定の「承認機能」を利用しない場合、1:承認済が設定されます。
未設定の場合かつ在庫管理設定の「承認機能」を利用する場合、出荷ステータスが 0:未出荷 の場合は 0:未承認 、出荷ステータスが 2:出荷済 または 3:出荷検品中 の場合は 1:承認済 が設定されます。

string
Allowed values: 0 1 2
approvalDateTime

承認日時：出荷承認日時／承認拒否日時 ※承認ステータス=1,2の場合、自動設定されます。

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
insDateTime

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

string
updDateTime

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

string
Example
{
  "shipmentId": "1",
  "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": "1",
      "shipmentId": "1",
      "productId": "8000001",
      "taxRate": "10.000",
      "cost": "100.00000",
      "price": "500",
      "quantity": "5",
      "memo": "出荷明細メモ1",
      "insDateTime": "2025-01-01T00:00:00+09:00",
      "updDateTime": "2025-01-01T00:00:00+09:00"
    }
  ]
}

400

Section titled “400”
  • 店舗IDが存在しない場合
  • 商品IDが存在しない場合
  • スタッフIDが存在しない場合
  • 受取先IDが存在しない場合
  • 出荷明細がない場合
  • 出荷明細件数が500件を超過した場合
  • 受取先タイプがその他の場合に受取先IDを設定している場合
  • 受取先タイプが仕入先の場合に受取先名を設定している場合
Media typeapplication/json
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "shipmentStoreId:171 出荷店舗が存在しません",
  "status": 400
}