発注取得

GET

/purchase_orders/{purchase_order_id}

• サンドボックス
• 本番

発注情報を取得します。

対象プラン

• リテールビジネス

Authorizations

• AppAccessToken
  pos.orders:read

Parameters

Path Parameters

purchase_order_id

required

string

発注ID

Example

3

Query Parameters

fields

array

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

Example

storageInfoId,recipientOrderId

with_products

string

default: none

Allowed values: all none

発注対象商品、発注配送商品を付加するか(付加する場合はall, しない場合はnone)

Example

all

with_stores

string

default: none

Allowed values: all none

発注対象店舗を付加するか(付加する場合はall, しない場合はnone)

Example

all

Responses

200

取得成功

object

storageInfoId

発注ID

string

3

recipientOrderId

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

string

2

divisionUnit

分割単位：0:なし、1:部門グループ、2:仕入先

string

Allowed values: 0 1 2

0

categoryGroupId

部門グループID：nullの時は全部門グループ

string

nullable

orderedDate

発注日：YYYY-MM-DD形式

string

2025-01-01

memo

メモ

string

発注メモ

identificationNo

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

string

123456789

roundingDivision

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

string

Allowed values: 0 1 2

1

status

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

string

Allowed values: 2 3 4 5

2

staffId

スタッフID：発注処理時のスタッフ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:00:00+09:00

products

発注対象商品

Array<object>

object

storageInfoProductId

発注商品ID 自動採番

string

3

storageInfoId

発注ID 自動採番

string

3

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:00:00+09:00

deliveryStore

発注配送商品

Array<object>

object

storageInfoDeliveryProductId

発注配送商品ID：発注配送商品ID 自動採番

string

3

storeId

配送店舗ID

string

1

quantity

発注数量

string

5

stores

発注対象店舗

Array<object>

object

storageInfoDeliveryId

発注配送店舗ID 自動採番

string

3

storageInfoId

発注ID 自動採番

string

3

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:00:00+09:00

Example

{
  "storageInfoId": "3",
  "recipientOrderId": "2",
  "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:00:00+09:00",
  "products": [
    {
      "storageInfoProductId": "3",
      "storageInfoId": "3",
      "productId": "8000001",
      "taxRate": "10.000",
      "cost": "100.00000",
      "taxDivision": "0",
      "quantity": "5",
      "insDateTime": "2025-01-01T00:00:00+09:00",
      "updDateTime": "2025-01-01T00:00:00+09:00",
      "deliveryStore": [
        {
          "storageInfoDeliveryProductId": "3",
          "storeId": "1",
          "quantity": "5"
        }
      ]
    }
  ],
  "stores": [
    {
      "storageInfoDeliveryId": "3",
      "storageInfoId": "3",
      "storageStoreId": "1",
      "storageExpectedDateFrom": "2025-01-01",
      "storageExpectedDateTo": "2025-01-02",
      "insDateTime": "2025-01-01T00:00:00+09:00",
      "updDateTime": "2025-01-01T00:00:00+09:00"
    }
  ]
}

404

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

object

type

required

string

title

required

string

detail

string

status

integer

Examples

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