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

発注更新

PATCH
/purchase_orders/{purchase_order_id}

発注を更新します。

※本APIでは配送ルートを設定した発注データは対象外となります

対象プラン

  • リテールビジネス

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
purchase_order_id
required
string

発注ID

Example
5

Request Body

Section titled “Request Body ”
object
recipientOrderId
発注先

発注先ID：発注先となる仕入先ID
※在庫管理設定の発注分割単位設定に仕入先を設定している場合、必須です。

string format: int
>= 1 <= 9999999999 
2
orderSourceStoreId
発注元店舗ID

発注元店舗ID：発注元となる店舗ID

string format: int
nullable >= 1 <= 999999999 
3
orderStaffName
発注担当者

発注担当者：発注の担当者名

string
nullable <= 50 characters 
須磨　礼司
orderedDate
発注日

発注日 [YYYY-MM-DD]

string format: date 
2025-01-01
memo
メモ

メモ 1000文字以内

string
<= 1000 characters 
発注メモ
identificationNo
識別番号

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

string
<= 32 characters 
123456789
roundingDivision
税丸め

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

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

ステータス(2:発注済、3:入荷検品中、4:入荷完了、5:仮発注)
発注更新で指定できるのは、2:発注済と5:仮発注。
2:発注済の場合、5:仮発注に更新できません。

string
Allowed values: 2 5 
2
staffId
スタッフID

発注処理時のスタッフID

string format: int 
1
products
発注対象商品

発注対象商品
※発注対象商品の既存件数と追加件数の合計が1000件以下になるようにしてください

Array<object>
object
storageInfoProductId
発注商品ID

発注商品ID 更新の場合は指定、新規追加の場合は設定しないこと（自動採番されます。）

string format: int 
5
productId
商品ID

商品ID 新規追加の場合は必須

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

税率
小数点3桁まで

<= 100 
10.000
cost
原価(外税)

原価(外税) 更新時、未設定の場合更新されません。 新規追加時、未設定の場合、商品マスタの原価を自動で設定する。

string format: decimal
>= -9999999999.99999 <= 9999999999.99999 
100
deliveryStore
発注配送商品

発注配送商品 新規追加の場合は必須

Array<object>
object
storageInfoDeliveryProductId
発注配送商品ID

発注配送商品ID 更新の場合は指定、新規追加の場合は設定しないこと（自動採番されます。）

string format: int
>= 1 <= 999999999999999 
5
storeId
配送店舗ID

配送店舗ID ※発注対象店舗の配送店舗IDと同じ値を設定する。 新規追加の場合は必須

string format: int
>= 1 <= 999999999 
1
quantity
発注数量

発注数量 新規追加の場合は必須

string format: int
<= 99999 
5
stores
発注対象店舗

発注対象店舗

Array<object>
object
storageInfoDeliveryId
発注配送店舗ID

発注配送店舗ID 更新の場合は指定、新規追加の場合は設定しないこと（自動採番されます。）

string format: int
>= 1 <= 999999999999999 
5
storageStoreId
配送店舗ID

配送店舗ID 新規追加の場合は必須

string format: int
>= 1 <= 999999999 
1
storageExpectedDateFrom
入荷予定日From

入荷予定日From 更新時、未設定の場合更新されません。 新規追加時、未設定の場合、登録日を設定します。

string format: date 
2025-01-01
storageExpectedDateTo
入荷予定日To

入荷予定日To 更新時、未設定の場合更新されません。 新規追加時、未設定の場合、登録日を設定します。

string format: date 
2025-01-02
Example
{
  "recipientOrderId": "2",
  "orderSourceStoreId": "3",
  "orderStaffName": "須磨　礼司",
  "orderedDate": "2025-01-01",
  "memo": "発注メモ",
  "identificationNo": "123456789",
  "roundingDivision": "1",
  "status": "2",
  "staffId": "1",
  "products": [
    {
      "storageInfoProductId": "5",
      "productId": "8000001",
      "taxRate": "10.000",
      "cost": "100",
      "deliveryStore": [
        {
          "storageInfoDeliveryProductId": "5",
          "storeId": "1",
          "quantity": "5"
        }
      ]
    }
  ],
  "stores": [
    {
      "storageInfoDeliveryId": "5",
      "storageStoreId": "1",
      "storageExpectedDateFrom": "2025-01-01",
      "storageExpectedDateTo": "2025-01-02"
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

取得成功

object
storageInfoId

発注ID 自動採番

string
5
recipientOrderId

発注先ID：発注先となる仕入先ID

string
2
orderSourceStoreId

発注元店舗ID：発注元となる店舗ID

string
nullable 
3
orderStaffName

発注担当者：発注の担当者名

string
nullable 
須磨　礼司
divisionUnit

分割単位(0:なし、1:部門グループ、2:仕入先) ※未設定の場合、0:なし

string
0
categoryGroupId

分割コード（部門グループIDを設定） 部門グループIDに含まれる商品のみをこの発注データでは指定できる。 補充発注の場合にのみ設定可能。

string
nullable
orderedDate

発注日 [YYYY-MM-DD]

string
2025-01-01
memo

メモ 1000文字以内

string
発注メモ
identificationNo

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

string
123456789
roundingDivision

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

string
Allowed values: 0 1 2 
1
status

ステータス(2:発注済、3:入荷検品中、4:入荷完了、5:仮発注)

string
2
staffId

発注処理時のスタッフID

string
1
insDateTime

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

string
2025-01-01T00:00:00+09:00
updDateTime

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

string
2025-01-01T00:01:00+09:00
products

発注対象商品

Array<object>
object
storageInfoProductId

発注商品ID 更新の場合は指定、新規追加の場合は設定しないこと（自動採番されます。）

string
5
storageInfoId

発注ID 自動採番

string
5
productId

商品ID 新規追加時は必須。

string
8000001
taxRate

税率

string
10.000
cost

原価(外税) 更新時、未設定の場合更新されません。 新規追加時、未設定の場合、商品マスタの原価を自動で設定する。

string
100.00000
taxDivision

税区分：(0：税込、1：税抜、2：非課税)

string
0
quantity

発注数量 発注配送商品の発注数量の合計が自動で設定されます。

string
5
insDateTime

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

string
2025-01-01T00:00:00+09:00
updDateTime

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

string
2025-01-01T00:01:00+09:00
deliveryStore

発注配送商品

Array<object>
object
storageInfoDeliveryProductId

発注配送商品ID 自働採番

string
5
storeId

配送店舗ID

string
1
quantity

発注数量

string
5
stores

発注対象店舗

Array<object>
object
storageInfoDeliveryId

発注配送店舗ID 更新の場合は指定、新規追加の場合は設定しないこと（自動採番されます。）

string
5
storageInfoId

発注ID 自動採番

string
5
storageStoreId

配送店舗ID 新規追加時は必須。

string
1
storageExpectedDateFrom

入荷予定日From 更新時、未設定の場合更新されません。 新規追加時、未設定の場合、登録日を設定します。

string
2025-01-01
storageExpectedDateTo

入荷予定日To 更新時、未設定の場合更新されません。 新規追加時、未設定の場合、登録日を設定します。

string
2025-01-02
insDateTime

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

string
2025-01-01T00:00:00+09:00
updDateTime

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

string
2025-01-01T00:01:00+09:00
Example
{
  "storageInfoId": "5",
  "recipientOrderId": "2",
  "orderSourceStoreId": "3",
  "orderStaffName": "須磨　礼司",
  "divisionUnit": "0",
  "categoryGroupId": null,
  "orderedDate": "2025-01-01",
  "memo": "発注メモ",
  "identificationNo": "123456789",
  "roundingDivision": "1",
  "status": "2",
  "staffId": "1",
  "insDateTime": "2025-01-01T00:00:00+09:00",
  "updDateTime": "2025-01-01T00:01:00+09:00",
  "products": [
    {
      "storageInfoProductId": "5",
      "storageInfoId": "5",
      "productId": "8000001",
      "taxRate": "10.000",
      "cost": "100.00000",
      "taxDivision": "0",
      "quantity": "5",
      "insDateTime": "2025-01-01T00:00:00+09:00",
      "updDateTime": "2025-01-01T00:01:00+09:00",
      "deliveryStore": [
        {
          "storageInfoDeliveryProductId": "5",
          "storeId": "1",
          "quantity": "5"
        }
      ]
    }
  ],
  "stores": [
    {
      "storageInfoDeliveryId": "5",
      "storageInfoId": "5",
      "storageStoreId": "1",
      "storageExpectedDateFrom": "2025-01-01",
      "storageExpectedDateTo": "2025-01-02",
      "insDateTime": "2025-01-01T00:00:00+09:00",
      "updDateTime": "2025-01-01T00:01:00+09:00"
    }
  ]
}

400

Section titled “400 ”
  • 発注対象店舗IDが存在しない場合
  • 商品IDが存在しない場合
  • スタッフIDが存在しない場合
  • 発注先マスタIDが存在しない場合
  • 発注元店舗IDが存在しない場合
  • 同一発注IDの範囲で商品IDがユニークでない場合(products)
  • 発注対象店舗に指定されていない配送先店舗の店舗に指定した場合
  • 同一商品に対して同一店舗を複数回指定した場合(deliveryStore)
  • statusが2または5以外の時に更新しようとした場合
  • statusが2:発注済の発注データを5:仮発注に更新しようとした場合
  • statusが2:発注済の発注データで入荷データが未検品以外の場合
  • 指定した発注商品IDが存在しない場合
  • 指定した発注配送商品IDが存在しない場合
  • 指定した発注配送店舗IDが存在しない場合
  • 配送ルートが設定された発注データを更新しようとした場合
  • 発注設定で発注状態が発注不可となっている商品が指定された場合
  • 発注設定で発注表示が表示しないとなっている商品が指定された場合
  • 発注設定の発注制限数が0の商品が指定された場合
  • 発注設定の発注制限数に入荷予定数が達している場合
  • 発注設定の発注制限数を超える発注数量が指定された場合
  • 発注対象商品が1000件を超過した場合
  • 発注分割単位設定で仕入先が設定されていて、発注先が設定されていない場合
  • 発注分割単位設定で仕入先が設定されていて、発注対象商品に仕入先に発注先が登録されていない商品がある場合
  • 発注分割単位設定で部門グループが設定されていて、異なる部門グループの商品が混在している場合
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "stores: storageStoreId[513] の店舗が見つかりません",
  "status": 400
}

404

Section titled “404 ”

指定した発注データが存在しない場合

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