商品SKU更新

PATCH

/products_sku/{product_sku_id}

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-oms/products_sku/example';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"shipperId":"1","productSkuCode":"pf_api_test_product","makerProductSkuCode":"makerProductSkuCode","janCode":"123","detailKbn":1,"productSkuName":"PFAPIテスト商品","productSkuName2":"プラットフォームエーピーアイテスト商品","productSkuKana":"PFAPIテストショウヒン","taxFlag":1,"price01":800,"price02":1000,"stockPrice":800,"costPrice":700,"stockFlag":0,"stockReserveFlag":1,"yukoFlag":1,"productPrintFlag":0,"unitName":1,"stockQuantity":30,"secureStock":10,"placingOrderPoint":5,"safetyStockPoint":10,"placingYoteiQuantity":10,"stockLotUnit":1,"memo":"メモ","posProductId":1,"changeMemo":"PFAPI用にテスト更新"}'
};

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/ec-oms/products_sku/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "shipperId": "1", "productSkuCode": "pf_api_test_product", "makerProductSkuCode": "makerProductSkuCode", "janCode": "123", "detailKbn": 1, "productSkuName": "PFAPIテスト商品", "productSkuName2": "プラットフォームエーピーアイテスト商品", "productSkuKana": "PFAPIテストショウヒン", "taxFlag": 1, "price01": 800, "price02": 1000, "stockPrice": 800, "costPrice": 700, "stockFlag": 0, "stockReserveFlag": 1, "yukoFlag": 1, "productPrintFlag": 0, "unitName": 1, "stockQuantity": 30, "secureStock": 10, "placingOrderPoint": 5, "safetyStockPoint": 10, "placingYoteiQuantity": 10, "stockLotUnit": 1, "memo": "メモ", "posProductId": 1, "changeMemo": "PFAPI用にテスト更新" }'

商品SKUを更新します。

Authorizations

AppAccessToken
ec-oms.products-sku:write

Parameters

Path Parameters

product_sku_id

required

string

>= 1 characters

商品SKUID

Request Body^required

application/json

ProductsSku

object

shipperId

required

荷主ID

string

>= 1 characters <= 9 characters

productSkuCode

required

商品SKUコード

string

>= 1 characters <= 50 characters

makerProductSkuCode

メーカー品番

string

0 <= 50 characters

janCode

JANコード

string

0 <= 200 characters

detailKbn

商品SKU種別

integer

<= 999999999

productSkuName

商品SKU名

string

>= 1 characters <= 200 characters

productSkuName2

商品SKU名（お客様用）

string

>= 1 characters <= 200 characters

productSkuKana

商品SKU名（カナ）

string

0 <= 200 characters

taxFlag

消費税フラグ

0: 税別
1: 税込

integer

Allowed values: 0 1

price01

通常価格

integer

<= 999999999

price02

販売価格

integer

<= 999999999

stockPrice

売上原価

integer

<= 999999999

costPrice

仕入価格

integer

<= 999999999

stockFlag

在庫管理対象

integer

<= 999999999

stockReserveFlag

在庫引当区分

integer

<= 999999999

yukoFlag

有効フラグ

integer

<= 999999999

productPrintFlag

伝票出力フラグ

0: 出力しない
1: 出力する

integer

Allowed values: 0 1

unitName

単位

integer

<= 999999999

stockQuantity

実在庫

integer

<= 999999999

secureStock

確保在庫

integer

<= 999999999

placingOrderPoint

発注点

integer

<= 999999999

safetyStockPoint

安全在庫量

integer

<= 999999999

placingYoteiQuantity

発注予定数

integer

>= -99999999 <= 999999999

stockLotUnit

仕入単位

integer

<= 999999999

memo

備考

string

0 <= 3000 characters

posProductId

スマレジ商品ID

integer

<= 999999999

changeMemo

required

変更理由

string

>= 1 characters <= 200 characters

Example

{
  "shipperId": "1",
  "productSkuCode": "pf_api_test_product",
  "makerProductSkuCode": "makerProductSkuCode",
  "janCode": "123",
  "detailKbn": 1,
  "productSkuName": "PFAPIテスト商品",
  "productSkuName2": "プラットフォームエーピーアイテスト商品",
  "productSkuKana": "PFAPIテストショウヒン",
  "taxFlag": 1,
  "price01": 800,
  "price02": 1000,
  "stockPrice": 800,
  "costPrice": 700,
  "stockFlag": 0,
  "stockReserveFlag": 1,
  "yukoFlag": 1,
  "productPrintFlag": 0,
  "unitName": 1,
  "stockQuantity": 30,
  "secureStock": 10,
  "placingOrderPoint": 5,
  "safetyStockPoint": 10,
  "placingYoteiQuantity": 10,
  "stockLotUnit": 1,
  "memo": "メモ",
  "posProductId": 1,
  "changeMemo": "PFAPI用にテスト更新"
}

Responses

200

更新成功

application/json

ProductSku

object

productSkuId

商品SKUID

string

>= 1 characters <= 9 characters

shipperId

荷主ID

string

>= 1 characters <= 9 characters

shipper

荷主会社名

string

nullable >= 1 characters <= 50 characters

productSkuCode

商品SKUコード

string

>= 1 characters <= 50 characters

makerProductSkuCode

メーカー品番

string

nullable 0 <= 50 characters

janCode

JANコード

string

nullable 0 <= 200 characters

detailKbn

商品SKU種別

string

>= 1 characters <= 9 characters

productCategory

商品SKU種別（和名）

string

nullable >= 1 characters <= 50 characters

productSkuName

商品SKU名

string

>= 1 characters <= 200 characters

productSkuName2

商品SKU名（お客様用）

string

>= 1 characters <= 200 characters

productSkuKana

商品SKU名カナ

string

nullable 0 <= 200 characters

taxFlag

消費税

string

>= 1 characters <= 1 characters

price01

通常価格（税抜・税込）

string

nullable >= 1 characters <= 9 characters

price02

販売価格（税抜・税込）

string

nullable >= 1 characters <= 9 characters

stockPrice

売上原価（税抜）

string

nullable >= 1 characters <= 9 characters

costPrice

仕入価格（税抜）

string

nullable >= 1 characters <= 9 characters

stockFlag

在庫管理対象

string

>= 1 characters <= 9 characters

stockFlagJa

在庫管理対象（和名）

string

nullable >= 1 characters <= 50 characters

stockReserveFlag

在庫引当区分

string

>= 1 characters <= 9 characters

stockReserveFlagJa

在庫引当区分（和名）

string

nullable >= 1 characters <= 50 characters

yukoFlag

有効フラグ

string

>= 1 characters <= 9 characters

yukoFlagJa

有効フラグ（和名）

string

nullable >= 1 characters <= 50 characters

productPrintFlag

伝票出力フラグ

string

>= 1 characters <= 1 characters

unitName

単位コード

string

>= 1 characters <= 9 characters

unitNameJa

単位（和名）

string

nullable >= 1 characters <= 50 characters

stockQuantity

実在庫

string

>= 1 characters <= 9 characters

stockQuantityLogical

有効在庫

string

>= 1 characters <= 9 characters

secureStock

確保在庫

string

>= 1 characters <= 9 characters

placingOrderPoint

発注点

string

nullable >= 1 characters <= 9 characters

safetyStockPoint

安全在庫量

string

nullable >= 1 characters <= 9 characters

placingYoteiQuantity

発注予定数

string

nullable >= 1 characters <= 9 characters

stockLotUnit

仕入単位

string

nullable >= 1 characters <= 9 characters

memo

備考

string

nullable 0 <= 3000 characters

posProductId

スマレジ商品ID

string

nullable >= 1 characters <= 9 characters

Examples

default

{
  "productSkuId": "1",
  "shipperId": "1",
  "shipper": "荷主会社名",
  "productSkuCode": "pf_api_test_product",
  "makerProductSkuCode": "makerProductSkuCode",
  "janCode": "123",
  "detailKbn": "1",
  "productCategory": "通常商品",
  "productSkuName": "PFAPIテスト商品",
  "productSkuName2": "プラットフォームエーピーアイテスト商品",
  "productSkuKana": "PFAPIテストショウヒン",
  "taxFlag": "1",
  "price01": "800",
  "price02": "1000",
  "stockPrice": "800",
  "costPrice": "700",
  "stockFlag": "0",
  "stockFlagJa": "管理しない",
  "stockReserveFlag": "1",
  "stockReserveFlagJa": "即時",
  "yukoFlag": "1",
  "yukoFlagJa": "有効",
  "productPrintFlag": "0",
  "unitName": "1",
  "unitNameJa": "個",
  "stockQuantity": "30",
  "stockQuantityLogical": "20",
  "secureStock": "10",
  "placingOrderPoint": "5",
  "safetyStockPoint": "10",
  "placingYoteiQuantity": "10",
  "stockLotUnit": "1",
  "memo": "メモ",
  "posProductId": "1"
}

400

指定された項目が不正な場合
指定された商品種別が存在しない場合
指定された在庫管理区分が存在しない場合
指定された在庫引当区分が存在しない場合
指定された単位が存在しない場合
指定された有効フラグが存在しない場合
指定された荷主が存在しない場合

application/json

object

type

required

string

title

required

string

detail

One of:

string
Array<string>

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "BadRequest",
  "detail": [
    "指定された項目が不正です: invalidKey"
  ],
  "status": 400
}

{
  "type": "about:blank",
  "title": "BadRequest",
  "detail": "該当する商品種別が見つかりませんでした",
  "status": 400
}

{
  "type": "about:blank",
  "title": "BadRequest",
  "detail": "該当する在庫管理区分が見つかりませんでした",
  "status": 400
}

{
  "type": "about:blank",
  "title": "BadRequest",
  "detail": "該当する在庫引当区分が見つかりませんでした",
  "status": 400
}

{
  "type": "about:blank",
  "title": "BadRequest",
  "detail": "該当する単位が見つかりませんでした",
  "status": 400
}

{
  "type": "about:blank",
  "title": "BadRequest",
  "detail": "該当する有効フラグが見つかりませんでした",
  "status": 400
}

{
  "type": "about:blank",
  "title": "BadRequest",
  "detail": "該当する荷主が見つかりませんでした",
  "status": 400
}

404

指定された商品SKUが存在しない場合

application/json

object

type

required

string

title

required

string

detail

One of:

string
Array<string>

string

status

integer

Examples

指定された商品SKUが存在しない場合

{
  "type": "about:blank",
  "title": "NotFound",
  "detail": "該当する商品SKUデータが見つかりませんでした",
  "status": 404
}

409

商品SKUコードが既に登録されている場合

application/json

object

type

required

string

title

required

string

detail

One of:

string
Array<string>

string

status

integer

Examples

商品SKUコードが重複している場合

{
  "type": "about:blank",
  "title": "Conflict",
  "detail": [
    "商品SKUコードが重複しています"
  ],
  "status": 409
}

500

サーバー内部エラー

application/json

object

type

required

string

title

required

string

detail

One of:

string
Array<string>

string

status

integer

Examples

default

{
  "type": "about:blank",
  "title": "InternalServerError",
  "status": 500
}

商品SKU更新

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Example

Responses

200

Examples

400

Examples

404

Examples

409

Examples

500

Examples

Request Body^required