受注確認内容更新

POST

/api_v1_receiveorder_confirm/update

curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&confirm_id=xxx&confirm_value=xxx&confirm_last_modified_date=xxx' \ https://api.next-engine.org/api_v1_receiveorder_confirm/update

// POST /api_v1_receiveorder_confirm/update - 受注確認内容更新
const params = new URLSearchParams({
  access_token: '<access_token>',
  confirm_id: '<confirm_id>',
  confirm_value: '<confirm_value>',
  confirm_last_modified_date: '<confirm_last_modified_date>',
})
const res = await fetch('https://api.next-engine.org/api_v1_receiveorder_confirm/update', {
  method: 'POST',
  headers: { 'content-type': 'application/x-www-form-urlencoded' },
  body: params,
})
const json = await res.json()
if (json.result !== 'success') throw new Error(json.message ?? json.code)
console.log(json.data)

# POST /api_v1_receiveorder_confirm/update - 受注確認内容更新
import requests

params = {
    'access_token': '<access_token>',
    'confirm_id': '<confirm_id>',
    'confirm_value': '<confirm_value>',
    'confirm_last_modified_date': '<confirm_last_modified_date>',
}
res = requests.post(
    'https://api.next-engine.org/api_v1_receiveorder_confirm/update',
    data=params,
)
json = res.json()
if json['result'] != 'success':
    raise RuntimeError(json.get('message') or json.get('code'))
print(json.get('data'))

Request Body^required

application/x-www-form-urlencoded

object

access_token

required

OAuth2 アクセストークン (必須)

string

refresh_token

OAuth2 リフレッシュトークン (access_token 期限切れ時の自動更新に使用)

string

wait_flag

同期実行フラグ。“1” 指定で処理完了を待つ

string

Allowed values: 0 1

fields

取得するフィールドをカンマ区切りで指定 (search 系のみ)

string

offset

検索開始位置 (search 系のみ)

integer

limit

取得件数 (search 系のみ)

integer

>= 1

confirm_id

required

受注確認内容ID / 更新する受注確認内容のconfirm_id。設定値が有効(confirm_valid_flagが’1’)の受注確認内容のみ指定可能です

string

confirm_value

required

設定値 / 更新する受注確認内容のconfirm_value。値を空に更新することは出来ません

string

confirm_last_modified_date

required

最終更新日 / 更新する店舗のconfirm_last_modified_date API実行時にメイン機能またはアプリで、受注確認内容が更新されていないかを確認するために利用しますメイン機能またはアプリで受注確認内容が更新されている場合はエラーになりますエラーになったら再度、受注確認内容を検索してAPIを実行して下さい

string

Responses

200

実行結果 (result が success / error / redirect のいずれか)

application/json

object

result

required

実行結果ステータス

string

Allowed values: success error redirect

code

エラー時のエラーコード

string

message

One of:

string
Array<object>

string

access_token

更新後のアクセストークン

string

access_token_end_date

アクセストークン有効期限 (YYYY-MM-DD HH:MM:SS)

string

refresh_token

更新後のリフレッシュトークン

string

refresh_token_end_date

リフレッシュトークン有効期限

string

data

エンドポイント固有のレスポンスデータ

count

Count/search 系のヒット件数 (form-urlencoded レスポンスでは文字列で返ることがある)

integer | string

Example

{
  "result": "success",
  "access_token": "xxx",
  "access_token_end_date": "2017-04-18 11:19:26",
  "refresh_token": "xxx",
  "refresh_token_end_date": "2017-04-20 11:19:26"
}

4XX

クライアントエラー (HTTP ステータス自体は 200 + result=error で返ることが多い)

application/json

object

result

required

実行結果ステータス

string

Allowed values: success error redirect

code

エラー時のエラーコード

string

message

One of:

string
Array<object>

string

access_token

更新後のアクセストークン

string

access_token_end_date

アクセストークン有効期限 (YYYY-MM-DD HH:MM:SS)

string

refresh_token

更新後のリフレッシュトークン

string

refresh_token_end_date

リフレッシュトークン有効期限

string

data

エンドポイント固有のレスポンスデータ

count

Count/search 系のヒット件数 (form-urlencoded レスポンスでは文字列で返ることがある)

integer | string

Example

{
  "result": "success"
}

受注確認内容更新

Request Bodyrequired

Responses

200

Example

4XX

Example

Request Body^required