出荷更新
const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/shipments/4';const options = { method: 'PATCH', headers: {'Content-Type': 'application/json'}, body: '{"shipmentStoreId":"2","recipientType":"1","recipientId":"2","recipientName":null,"shipmentDivision":"0","shipmentDate":"2025-01-01","memo":"出荷メモ","taxRate":"10.000","identificationNo":"123456789","roundingDivision":"1","status":"2","approvalStatus":"1","details":[{"shipmentDetailId":"4","productId":"8000001","taxRate":"10.000","cost":"100","quantity":"5","memo":"出荷明細メモ4"}]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/shipments/4 \ --header 'Content-Type: application/json' \ --data '{ "shipmentStoreId": "2", "recipientType": "1", "recipientId": "2", "recipientName": null, "shipmentDivision": "0", "shipmentDate": "2025-01-01", "memo": "出荷メモ", "taxRate": "10.000", "identificationNo": "123456789", "roundingDivision": "1", "status": "2", "approvalStatus": "1", "details": [ { "shipmentDetailId": "4", "productId": "8000001", "taxRate": "10.000", "cost": "100", "quantity": "5", "memo": "出荷明細メモ4" } ] }'出荷を更新します。
対象プラン
- リテールビジネス
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”出荷ID
Example
4Request Body
Section titled “Request Body”object
出荷店舗ID
受取先タイプ：1：仕入先、3：その他(1,3のみ有効)
受取先ID：仕入先IDを入力(受取先タイプ=1の場合、入力必須。それ以外入力不可)
受取先名：登録時の受取先名 受取先タイプ=3の場合、入力必須。それ以外入力不可 受取先タイプ=1の場合、仕入先名を自動で設定。
出荷区分：0:出荷、1:返品、2:販促品
出荷日：[YYYY-MM-DD]
メモ
税率：出荷時の税率
小数点3桁まで
出荷情報を管理するための任意の文字列を設定出来る項目。
税丸め（0:四捨五入、1:切り捨て、2:切り上げ）
出荷ステータス：(0:未出荷、2:出荷済、3:出荷検品中)
※2:出荷済の出荷を編集する場合は出荷済のみ指定できます。
※3:出荷検品中はAPIからのみ指定できます。
承認ステータス：0:未承認, 1:承認済, 2:承認拒否
未設定の場合かつ在庫管理設定の「承認機能」を利用しない場合、1:承認済が設定されます。
未設定の場合かつ在庫管理設定の「承認機能」を利用する場合、出荷ステータスが 0:未出荷 の場合は 0:未承認 、出荷ステータスが 2:出荷済 または 3:出荷検品中 の場合は 1:承認済 が設定されます。
1:承認済, 2:承認拒否の場合、変更できません。
出荷明細
※明細は既存件数と追加件数の合計が500件以下になるようにしてください
object
出荷明細ID 更新の場合は指定、新規追加の場合は設定しないこと（自動採番されます。）
商品ID 新規追加時には必須。
※ 出荷済レコードを更新する場合は商品を変更できません。
税率：出荷時の商品税率
小数点3桁まで
新規追加かつ未設定の場合、出荷更新時の税率を設定。
原価(外税) 未指定時には商品マスタの原価が自動入力される
出荷数
メモ
Example
{ "shipmentStoreId": "2", "recipientType": "1", "recipientId": "2", "recipientName": null, "shipmentDivision": "0", "shipmentDate": "2025-01-01", "memo": "出荷メモ", "taxRate": "10.000", "identificationNo": "123456789", "roundingDivision": "1", "status": "2", "approvalStatus": "1", "details": [ { "shipmentDetailId": "4", "productId": "8000001", "taxRate": "10.000", "cost": "100", "quantity": "5", "memo": "出荷明細メモ4" } ]}Responses
Section titled “Responses”取得成功
object
出荷ID 自動採番
出荷店舗ID
受取先タイプ：1：仕入先、3：その他(1,3のみ有効)
受取先ID：仕入先IDを入力(受取先タイプ=1の場合、入力必須。それ以外入力不可)
受取先名：登録時の受取先名 受取先タイプ=3の場合、入力必須。それ以外入力不可 受取先タイプ=1の場合、仕入先名を自動で設定。
出荷区分：0:出荷、1:返品、2:販促品
出荷日：[YYYY-MM-DD]
メモ
スタッフID
税率
識別番号：出荷情報を管理するための任意の文字列を設定出来る項目。
税丸め（0:四捨五入、1:切り捨て、2:切り上げ）
出荷ステータス：(0:未出荷、2:出荷済、3:出荷検品中)
※3:出荷検品中はAPIからのみ指定できます。
承認ステータス：0:未承認, 1:承認済, 2:承認拒否
未設定の場合かつ在庫管理設定の「承認機能」を利用しない場合、1:承認済が設定されます。
未設定の場合かつ在庫管理設定の「承認機能」を利用する場合、出荷ステータスが 0:未出荷 の場合は 0:未承認 、出荷ステータスが 2:出荷済 または 3:出荷検品中 の場合は 1:承認済 が設定されます。
1:承認済, 2:承認拒否の場合、変更できません。
承認日時：出荷承認日時／承認拒否日時 ※承認ステータス=1,2の場合、自動設定されます。
作成日時：登録時の日時。[YYYY-MM-DDThh:mm:ssTZD]
登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]
出荷明細
object
出荷明細ID 更新の場合は指定、新規追加の場合は設定しないこと（自動採番されます。）
出荷ID 自動採番
商品ID 新規追加時には必須。
税率
原価(外税) 未指定時には商品マスタの原価が自動入力される
商品単価(内税)。商品マスタの価格が自動入力される
出荷数
メモ
作成日時：登録時の日時。[YYYY-MM-DDThh:mm:ssTZD]
更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]
Example
{ "shipmentId": "4", "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:01:00+09:00", "insDateTime": "2025-01-01T00:00:00+09:00", "updDateTime": "2025-01-01T00:01:00+09:00", "details": [ { "shipmentDetailId": "4", "shipmentId": "4", "productId": "8000001", "taxRate": "10.000", "cost": "100.00000", "price": "500", "quantity": "5", "memo": "出荷明細メモ4", "insDateTime": "2025-01-01T00:00:00+09:00", "updDateTime": "2025-01-01T00:01:00+09:00" } ]}- 出荷店舗IDが存在しない場合
- 商品IDが存在しない場合
- 受取先IDが存在しない場合
- スタッフIDが存在しない場合
- 出荷明細IDが存在しない場合
- 出荷明細件数が500件を超過した場合
- 出荷完了編集不可設定でステータスが出荷済のレコードを更新しようとした場合
- 出荷承認ステータスが未承認以外のレコードの出荷承認ステータスを変更しようとした場合
- 受取先タイプがその他の場合に受取先IDを設定している場合
- 受取先タイプが仕入先の場合に受取先名を設定している場合
- 出荷済のレコードを出荷済以外で更新しようとした場合
- 出荷済のレコードの明細の商品を変更しようとした場合
object
Examples
{ "type": "about:blank", "title": "Bad Request", "detail": "shipmentStoreId:171 出荷店舗が存在しません", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "details: productId[171]が見つかりません", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "recipientId:171 受取先が存在しません", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "staffId:171 スタッフが存在しません", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "details: 出荷明細が存在しません shipmentDetailId-[171]", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "details: 出荷明細は500件以内にしてください", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "status:[171]出荷済の出荷は更新できません。", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "approvalStatus:1 出荷承認ステータスが未承認以外の場合、変更できません", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "[受取先ID] 受取先タイプがその他の場合は値を入力しないでください", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "[受取先名] 受取先タイプが仕入先の場合は値を入力しないでください", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "status:[2]出荷済の出荷は出荷済以外に変更できません。", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "details: 出荷完了編集では商品の変更はできません shipmentDetailId-[150]", "status": 400}- リソースが存在しない場合
object
Examples
{ "type": "about:blank", "title": "NotFound", "detail": "指定されたIDのリソースが見つかりません", "status": 404}