セール更新

PATCH

/bargain/{bargain_id}

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/bargain/example';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"bargainName":"string","termStart":"2000-01-23","termEnd":"2000-01-23"}'
};

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/bargain/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "bargainName": "string", "termStart": "2000-01-23", "termEnd": "2000-01-23" }'

セール情報を更新します。

対象プラン

スタンダード
プレミアム
プレミアムプラス
フードビジネス
リテールビジネス

Authorizations

AppAccessToken
pos.products:write
UserAccessToken
pos.products:write

Parameters

Path Parameters

bargain_id

required

string

セールID
※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で実施されるセールIDを指定してください。

Request Body

application/json

object

bargainName

セール名

セール名称

string

<= 85 characters

termStart

セール開始日

[YYYY-MM-DD] セールの開始日

string format: date

termEnd

セール終了日

[YYYY-MM-DD] セールの終了日

string format: date

Example

{
  "bargainName": "string",
  "termStart": "2000-01-23",
  "termEnd": "2000-01-23"
}

Responses

200

取得成功

application/json

object

bargainId

セールID

string

bargainName

セール名称

string

termStart

セールの開始日

string

termEnd

セールの終了日

string

insDateTime

登録時・更新時の日時

string

updDateTime

登録時・更新時の日時

string

Example

{
  "bargainId": "string",
  "bargainName": "string",
  "termStart": "string",
  "termEnd": "string",
  "insDateTime": "string",
  "updDateTime": "string"
}

400

セール終了日が開始日以前の場合

application/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

セール終了日が開始日以前の場合

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "[適用期間] 開始日は終了日時以前の日を入力してください。",
  "status": 400
}