商品の一覧

GET /products

ショップに登録した商品の一覧を取得するには、/api/productsに対してGETを送信します。

リクエスト：ヘッダー

Name	Value
Content-Type	application/json
Authorization	Basic <認証情報>

認証情報について

認証情報は、ユーザーのEメールアドレスとAPIキーをコロンで連結したものをBase64エンコードしたものです。

クエリ パラメータ

Name	Type	説明	デフォルト値
page	integer	ページ番号	1
items_per_page	integer	1ページあたりの表示数	10
pname	string	商品名
subcats	string	サブカテゴリーの商品も表示するか	Y
order_ids	string	注文ID
free_shipping	string	無料配送の商品のみ表示するか Y/N
status	string	ステータス
sort_by	string	ソートする項目
sort_order	string	ソート順
q	string	検索キーワード

レスポンス

200

{
  "products": [
    {
      "product_id": "12",
      "product": "100g パンツ",
      "product_type": "P",
      "parent_product_id": "0",
      "product_code": "U0012O5AF0",
      "status": "A",
      "company_id": "1",
      "list_price": "4000.00",
      "amount": "10",
      "weight": "0.000",
      "length": "0",
      "width": "0",
      "height": "0",
      "shipping_freight": "0.00",
      "low_avail_limit": "0",
      "timestamp": "1328558400",
      "updated_timestamp": "1383893547",
      "usergroup_ids": "0",
      "is_edp": "N",
      "edp_shipping": "N",
      "unlimited_download": "N",
      "tracking": "B",
      "free_shipping": "N",
      "zero_price_action": "R",
      "is_pbp": "Y",
      "is_op": "N",
      "is_oper": "N",
      "is_returnable": "Y",
      "return_period": "10",
      "avail_since": "0",
      "out_of_stock_actions": "N",
      "localization": "",
      "min_qty": "0",
      "max_qty": "0",
      "qty_step": "0",
      "list_qty_count": "0",
      "tax_ids": "",
      "age_verification": "N",
      "age_limit": "0",
      "options_type": "P",
      "exceptions_type": "F",
      "details_layout": "default",
      "shipping_params": "a:5:{s:16:\"min_items_in_box\";i:0;s:16:\"max_items_in_box\";i:0;s:10:\"box_length\";i:0;s:9:\"box_width\";i:0;s:10:\"box_height\";i:0;}",
      "price": "3600.000000",
      "category_ids": [
        224
      ],
      "seo_name": "100g-",
      "seo_path": "223/224",
      "main_category": 224,
      "variation_features": [],
      "main_pair": {
        "pair_id": "823",
        "image_id": "0",
        "detailed_id": "879",
        "position": "0",
        "detailed": {
          "object_id": "12",
          "object_type": "product",
          "type": "M",
          "image_path": "https://your-shop.jp/images/detailed/0/173283_0113298267324f438bac97eaf.jpg",
          "alt": "",
          "image_x": "500",
          "image_y": "500",
          "http_image_path": "http://your-shop.jp/images/detailed/0/173283_0113298267324f438bac97eaf.jpg",
          "https_image_path": "https://your-shop.jp/images/detailed/0/173283_0113298267324f438bac97eaf.jpg",
          "absolute_path": "/home/your-shop.jp/public_html/images/detailed/0/173283_0113298267324f438bac97eaf.jpg",
          "relative_path": "detailed/0/173283_0113298267324f438bac97eaf.jpg"
        }
      },
      "base_price": "3600.000000",
      "selected_options": [],
      "has_options": true,
      "product_options": [],
      "list_discount": 400,
      "list_discount_prc": "10",
      "discounts": {
        "A": 0,
        "P": 0
      },
      "product_features": {
        "18": {
          "feature_id": "18",
          "value": "",
          "value_int": null,
          "variant_id": "86",
          "feature_type": "E",
          "description": "ブランド",
          "prefix": "",
          "suffix": "",
          "variant": "アディダス",
          "parent_id": "0",
          "display_on_header": "Y",
          "display_on_catalog": "N",
          "display_on_product": "N",
          "features_hash": "10-86",
          "variants": {
            "86": {
              "value": "",
              "value_int": null,
              "variant_id": "86",
              "variant": "アディダス",
              "image_pairs": {
                "pair_id": "875",
                "image_id": "1006",
                "detailed_id": "0",
                "position": "0",
                "icon": {
                  "image_path": "https://your-shop.jp/images/feature_variant/1/Adidas_Logo.svg.png",
                  "alt": "",
                  "image_x": "200",
                  "image_y": "133",
                  "http_image_path": "https://your-shop.jp/images/feature_variant/1/Adidas_Logo.svg.png",
                  "https_image_path": "http://your-shop.jp/images/feature_variant/1/Adidas_Logo.svg.png",
                  "absolute_path": "/home/your-shop.jp/public_html/images/feature_variant/1/Adidas_Logo.svg.png",
                  "relative_path": "feature_variant/1/Adidas_Logo.svg.png"
                }
              }
            }
          }
        }
      },
      "qty_content": []
    },
    {
      "product_id": "162",
      "product": "AIKO オフィス用耐火金庫 AS180 シェルフ＆引き出し付き",
      "product_type": "P",
      "parent_product_id": "0",
      "product_code": "A0162LEU0L",
      "status": "A",
      "company_id": "1",
      "list_price": "0.00",
      "amount": "3",
      "weight": "0.000",
      "length": "0",
      "width": "0",
      "height": "0",
      "shipping_freight": "0.00",
      "low_avail_limit": "0",
      "timestamp": "1328644800",
      "updated_timestamp": "1329220610",
      "usergroup_ids": "0",
      "is_edp": "N",
      "edp_shipping": "N",
      "unlimited_download": "N",
      "tracking": "B",
      "free_shipping": "N",
      "zero_price_action": "R",
      "is_pbp": "Y",
      "is_op": "N",
      "is_oper": "N",
      "is_returnable": "Y",
      "return_period": "10",
      "avail_since": "0",
      "out_of_stock_actions": "N",
      "localization": "",
      "min_qty": "0",
      "max_qty": "0",
      "qty_step": "0",
      "list_qty_count": "0",
      "tax_ids": "",
      "age_verification": "N",
      "age_limit": "0",
      "options_type": "P",
      "exceptions_type": "F",
      "details_layout": "default",
      "shipping_params": "a:5:{s:16:\"min_items_in_box\";i:0;s:16:\"max_items_in_box\";i:0;s:10:\"box_length\";i:0;s:9:\"box_width\";i:0;s:10:\"box_height\";i:0;}",
      "price": "3930000.000000",
      "category_ids": [
        253
      ],
      "main_category": 253,
      "variation_features": [],
      "main_pair": {
        "pair_id": "561",
        "image_id": "0",
        "detailed_id": "617",
        "position": "0",
        "detailed": {
          "object_id": "162",
          "object_type": "product",
          "type": "M",
          "image_path": "https://your-shop.jp/images/detailed/0/cs-180.jpg",
          "alt": "",
          "image_x": "500",
          "image_y": "511",
          "http_image_path": "https://your-shop.jp/images/detailed/0/cs-180.jpg",
          "https_image_path": "http://your-shop.jp/images/detailed/0/cs-180.jpg",
          "absolute_path": "/home/your-shop.jp/public_html/images/detailed/0/cs-180.jpg",
          "relative_path": "detailed/0/cs-180.jpg"
        }
      },
      "base_price": "3930000.000000",
      "selected_options": [],
      "has_options": false,
      "product_options": [],
      "discounts": {
        "A": 0,
        "P": 0
      },
      "product_features": {
        "18": {
          "feature_id": "18",
          "value": "",
          "value_int": null,
          "variant_id": "129",
          "feature_type": "E",
          "description": "ブランド",
          "prefix": "",
          "suffix": "",
          "variant": "アイコ・コネックス・セーフ",
          "parent_id": "0",
          "display_on_header": "Y",
          "display_on_catalog": "N",
          "display_on_product": "N",
          "features_hash": "10-129",
          "variants": {
            "129": {
              "value": "",
              "value_int": null,
              "variant_id": "129",
              "variant": "アイコ・コネックス・セーフ",
              "image_pairs": {
                "pair_id": "917",
                "image_id": "1048",
                "detailed_id": "0",
                "position": "0",
                "icon": {
                  "image_path": "https://your-shop.jp/images/feature_variant/1/aiko_safe_t.gif",
                  "alt": "",
                  "image_x": "80",
                  "image_y": "50",
                  "http_image_path": "http://your-shop.jp/images/feature_variant/1/aiko_safe_t.gif",
                  "https_image_path": "https://your-shop.jp/images/feature_variant/1/aiko_safe_t.gif",
                  "absolute_path": "/home/your-shop.jp/public_html/images/feature_variant/1/aiko_safe_t.gif",
                  "relative_path": "feature_variant/1/aiko_safe_t.gif"
                }
              }
            }
          }
        }
      },
      "qty_content": []
    }
  ],
  "params": {
    "area": "A",
    "use_caching": true,
    "extend": [
      "product_name",
      "prices",
      "categories",
      "categories"
    ],
    "custom_extend": [],
    "pname": "",
    "pshort": "",
    "pfull": "",
    "pkeywords": "",
    "feature": [],
    "type": "simple",
    "page": 1,
    "action": "",
    "filter_variants": [],
    "features_hash": "",
    "limit": 0,
    "bid": 0,
    "match": "any",
    "tracking": [],
    "get_frontend_urls": false,
    "items_per_page": 3,
    "apply_disabled_filters": "",
    "load_products_extra_data": true,
    "sort_by": "product",
    "sort_order": "asc",
    "include_child_variations": true,
    "group_child_variations": false,
    "sort_order_rev": "desc",
    "total_items": "247"
  }
}

400