コンテンツにスキップ

商品画像検索

POST

/api_v1_master_goodsimage/search

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxx&refresh_token=xxxxxxxxx&fields=xxxxxxxx,xxxxxxx&goods_image_creator_name-like=xxxxx&offset=0&limit=2' https://api.next-engine.org/api_v1_master_goodsimage/search

// POST /api_v1_master_goodsimage/search - 商品画像検索
const params = new URLSearchParams({
  access_token: '<access_token>',
  fields: 'field1,field2',
  offset: '0',
  limit: '50',
})
const res = await fetch('https://api.next-engine.org/api_v1_master_goodsimage/search', {
  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_master_goodsimage/search - 商品画像検索
import requests

params = {
    'access_token': '<access_token>',
    'fields': 'field1,field2',
    'offset': '0',
    'limit': '50',
}
res = requests.post(
    'https://api.next-engine.org/api_v1_master_goodsimage/search',
    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

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

data

Array<object>

object

goods_image_id

商品画像ID / 数値型

string | integer | number | boolean | null

goods_image_goods_id

商品コード / 文字列型

string | integer | number | boolean | null

goods_image_file_name

ファイル名 / 文字列型

string | integer | number | boolean | null

goods_image_url_http

画像URL(HTTP) / 文字列型

string | integer | number | boolean | null

goods_image_url_https

画像URL(HTTPS) / 文字列型

string | integer | number | boolean | null

goods_image_size

サイズ / 数値型 / 単位はバイト。500KB(1024計算)以下

string | integer | number | boolean | null

goods_image_width

幅 / 数値型 / 単位：ピクセル。2100px以下

string | integer | number | boolean | null

goods_image_height

高さ / 数値型 / 単位：ピクセル。2100px以下

string | integer | number | boolean | null

goods_image_alt

画像説明 / 文字列型 / HTMLのimg要素のalt属性

string | integer | number | boolean | null

goods_image_convert_flg

自動変換フラグ / 数値型 / 自動作成したJPEG画像がある場合、1。このフラグが1の場合、URLはjpg以外が設定されており、拡張子をjpgにしてアクセスすることでjpgファイルにもアクセス出来ます

string | integer | number | boolean | null

goods_image_display_order

並び順 / 文字列型

string | integer | number | boolean | null

goods_image_status

ファイル状態 / 数値型 / 0:未ダウンロード 1:ダウンロード中 2:ダウンロード済み 3:アップロード済み 4:アップロード中 9:削除済み ※ファイル選択でアップロードされた場合は、1になります

string | integer | number | boolean | null

goods_image_deleted_flag

削除フラグ / 文字列型

string | integer | number | boolean | null

goods_image_creation_date

作成日 / 日時型

string | integer | number | boolean | null

goods_image_last_modified_date

最終更新日 / 日時型

string | integer | number | boolean | null

goods_image_last_modified_null_safe_date

最終更新日 / 日時型 / NULLの場合作成日

string | integer | number | boolean | null

goods_image_creator_id

作成担当者ID / 数値型

string | integer | number | boolean | null

goods_image_creator_name

作成担当者名 / 文字列型

string | integer | number | boolean | null

goods_image_last_modified_by_id

最終更新者ID / 数値型

string | integer | number | boolean | null

goods_image_last_modified_by_null_safe_id

最終更新者ID / 数値型 / NULLの場合作成者ID

string | integer | number | boolean | null

goods_image_last_modified_by_name

最終更新者名 / 文字列型

string | integer | number | boolean | null

goods_image_last_modified_by_null_safe_name

最終更新者名 / 文字列型 / NULLの場合作成者名

string | integer | number | boolean | null

key

additional properties

any

Example

{
  "result": "success",
  "count": "2",
  "data": [
    {
      "goods_image_id": "1",
      "goods_image_goods_id": "T101",
      "goods_image_file_name": "2af4aec82a6f7f67fa09b2ae5e84c87e_201701181.jpg",
      "goods_image_url_http": "xxxxx",
      "goods_image_url_https": "xxxxx",
      "goods_image_size": "219519",
      "goods_image_width": "2048",
      "goods_image_height": "1152",
      "goods_image_alt": "",
      "goods_image_convert_flg": "0",
      "goods_image_display_order": "1",
      "goods_image_status": "3",
      "goods_image_deleted_flag": "0",
      "goods_image_creation_date": "2017-01-18 15:44:50",
      "goods_image_last_modified_date": "2017-01-18 16:01:50",
      "goods_image_last_modified_null_safe_date": "2017-01-18 16:01:50",
      "goods_image_creator_id": "10004",
      "goods_image_creator_name": "xxxxx",
      "goods_image_last_modified_by_id": "10004",
      "goods_image_last_modified_by_null_safe_id": "10004",
      "goods_image_last_modified_by_name": "xxxxx",
      "goods_image_last_modified_by_null_safe_name": "xxxxx",
      "goods_image_tag_id": "1",
      "goods_image_tag_goods_image_id": "1",
      "goods_image_tag_image_tag_id": "1",
      "goods_image_tag_deleted_flag": "0",
      "goods_image_tag_creation_date": "2017-01-18 15:44:50",
      "goods_image_tag_last_modified_date": "2017-01-18 15:44:50",
      "goods_image_tag_last_modified_null_safe_date": "2017-01-18 15:44:50",
      "goods_image_tag_creator_id": "0",
      "goods_image_tag_creator_name": "System",
      "goods_image_tag_last_modified_by_id": "0",
      "goods_image_tag_last_modified_by_null_safe_id": "0",
      "goods_image_tag_last_modified_by_name": "System",
      "goods_image_tag_last_modified_by_null_safe_name": "System",
      "image_tag_id": "1",
      "image_tag_mall_id": "0",
      "image_tag_mall_sub_id": "0",
      "image_tag_text": "基本-画像1",
      "image_tag_auto_register_no": "1",
      "image_tag_display_order": "1",
      "image_tag_deleted_flag": "0",
      "image_tag_creation_date": "2014-10-17 17:08:45",
      "image_tag_last_modified_date": "2014-10-17 17:08:45",
      "image_tag_last_modified_null_safe_date": "2014-10-17 17:08:45",
      "image_tag_creator_id": "0",
      "image_tag_creator_name": "System",
      "image_tag_last_modified_by_id": "0",
      "image_tag_last_modified_by_null_safe_id": "0",
      "image_tag_last_modified_by_name": "System",
      "image_tag_last_modified_by_null_safe_name": "System"
    },
    {
      "goods_image_id": "2",
      "goods_image_goods_id": "T101",
      "goods_image_file_name": "e4213e243da9497baffb3e0db8a3f167_201702102.jpg",
      "goods_image_url_http": "xxxxx",
      "goods_image_url_https": "xxxxx",
      "goods_image_size": "130186",
      "goods_image_width": "800",
      "goods_image_height": "489",
      "goods_image_alt": "",
      "goods_image_convert_flg": "0",
      "goods_image_display_order": "2",
      "goods_image_status": "3",
      "goods_image_deleted_flag": "0",
      "goods_image_creation_date": "2017-02-10 16:08:41",
      "goods_image_last_modified_date": "2017-02-10 16:28:11",
      "goods_image_last_modified_null_safe_date": "2017-02-10 16:28:11",
      "goods_image_creator_id": "10002",
      "goods_image_creator_name": "xxxxx",
      "goods_image_last_modified_by_id": "10002",
      "goods_image_last_modified_by_null_safe_id": "10002",
      "goods_image_last_modified_by_name": "xxxxx",
      "goods_image_last_modified_by_null_safe_name": "xxxxx",
      "goods_image_tag_id": "2",
      "goods_image_tag_goods_image_id": "2",
      "goods_image_tag_image_tag_id": "2",
      "goods_image_tag_deleted_flag": "0",
      "goods_image_tag_creation_date": "2017-02-10 16:08:41",
      "goods_image_tag_last_modified_date": "2017-02-10 16:08:41",
      "goods_image_tag_last_modified_null_safe_date": "2017-02-10 16:08:41",
      "goods_image_tag_creator_id": "10002",
      "goods_image_tag_creator_name": "xxxxx",
      "goods_image_tag_last_modified_by_id": "10002",
      "goods_image_tag_last_modified_by_null_safe_id": "10002",
      "goods_image_tag_last_modified_by_name": "xxxxx",
      "goods_image_tag_last_modified_by_null_safe_name": "xxxxx",
      "image_tag_id": "2",
      "image_tag_mall_id": "0",
      "image_tag_mall_sub_id": "0",
      "image_tag_text": "基本-画像2",
      "image_tag_auto_register_no": "2",
      "image_tag_display_order": "2",
      "image_tag_deleted_flag": "0",
      "image_tag_creation_date": "2014-10-17 17:08:45",
      "image_tag_last_modified_date": "2014-10-17 17:08:45",
      "image_tag_last_modified_null_safe_date": "2014-10-17 17:08:45",
      "image_tag_creator_id": "0",
      "image_tag_creator_name": "System",
      "image_tag_last_modified_by_id": "0",
      "image_tag_last_modified_by_null_safe_id": "0",
      "image_tag_last_modified_by_name": "System",
      "image_tag_last_modified_by_null_safe_name": "System"
    }
  ],
  "access_token": "xxxxx",
  "access_token_end_date": "2017-04-18 11:19:26",
  "refresh_token": "xxxxx",
  "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"
}