{"version":{"__v":1,"_id":"5544d76ad8833c0d00582801","forked_from":"55227389b4a0de0d00de7e2b","project":"55227389b4a0de0d00de7e28","createdAt":"2015-05-02T13:55:54.059Z","releaseDate":"2015-05-02T13:55:54.059Z","categories":["5544d76ad8833c0d00582802","5544d76ad8833c0d00582803","5544d76ad8833c0d00582804","5544d76ad8833c0d00582805","5544d76ad8833c0d00582806"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"4.0.0","version":"4.0"},"category":{"__v":1,"_id":"5544d76ad8833c0d00582803","pages":["5544d76bd8833c0d00582815","5544d76bd8833c0d00582816","5544d76bd8833c0d00582817","5544d76bd8833c0d00582818","5544d76bd8833c0d00582819","5544d76bd8833c0d0058281a","5544d76bd8833c0d0058281b","5544d76bd8833c0d0058281c","5544d76bd8833c0d0058281d","5544d76bd8833c0d0058281e","5544d76bd8833c0d0058281f","5544d76bd8833c0d00582820","5544d76bd8833c0d00582821","5544d76bd8833c0d00582822","5544d76bd8833c0d00582823"],"project":"55227389b4a0de0d00de7e28","version":"5544d76ad8833c0d00582801","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-04-07T08:14:54.351Z","from_sync":false,"order":1,"slug":"api","title":"API"},"__v":0,"project":"55227389b4a0de0d00de7e28","user":"552342f6e20da719000e7925","_id":"5544d76bd8833c0d0058281b","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-04-08T05:52:11.307Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"URLs\"\n}\n[/block]\n- [http://example.com/api/](link)**products**—全ての商品を参照します。`GET`と`POST`のみサポートされています。\n\n- [http://example.com/api/](link)**products/:id**—特定の商品を参照します。 すべてのメソッド(`GET`/`PUT`/`DELETE`)がサポートされています。\n\n- [http://example.com/api/](link)**categories/:id/products**—特定の[カテゴリー](doc:category)に属している商品全てを参照します。\n\n- [http://example.com/api/](link)**categories/:id/products/:id**—特定のカテゴリーに属している特定の商品を参照します。\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"入れ子のオブジェクト\"\n}\n[/block]\n- [追加情報](doc;product-features)\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"フィルタリング\"\n}\n[/block]\nフィルターを基にして商品を取得するため、利用可能なフィルターの1つを使用することができます。商品のフィルタリングは管理パネルで行われる高度な検索に似ています。\n\nリクエストURLは以下です(読みやすいようにいくつかの行に分かれています)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"http://example.com/api/products?\\n<filter>=Y&\\n<additional_param>=<value>&\\n<another_param>=<value>&\\n...\\nsort_by=<sorting>&\\nsort_order=<sort_order>&\\nq=<query>\",\n      \"language\": \"html\"\n    }\n  ]\n}\n[/block]\n- `filter`は使用可能な[フィルター](link)の1つです。`&<another_filter>=Y`を持つURLを追加することにより、一度に任意の数のフィルターを使用することが可能です。\n\nadditional_param is one of the available additional params. It is possible to use any number of additional params at a time by appending the URL with &=  \n- `additional_param`は使用可能な[追加パラメーター](link)の1つです。`&<another_param>=<value>`を持つURLを追加することにより、一度に任意の数の追加パラメーターを使用することができます。\n\nsorting is one of the available sortings  \n- `sorting` は利用可能な[ソーティング](link)の1つです。\nsort_order is the sort direction; asc or desc for ascending and descending accordingly  \n- `sort_order`はソートのディレクションです:昇順や降順に応じた`asc`や`desc`\n\n- `query` は検索クエリです。\n\n\nCS-Cartの複数店舗機能やマーケットプレイス版で特定のストアを参照した結果を得るため、`stores`や `vendors`エンティティーを使用します:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"http://example.com/api/stores/1/products?pname=foo\\nhttp://example.com/api/vendors/1/products?pname=bar\",\n      \"language\": \"html\"\n    }\n  ]\n}\n[/block]\n##例\n\n最初のショップの商品で説明文に「foo」が記述されており、10ドル以上の商品で商品名をアルファベット順で取得する:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --user admin:::at:::example.com:APIkey -X GET 'http://example.com/api/store/1/products?pfull=Y&price_from=10&sort_by=product&sort_order=asc&q=foo'\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"フィルター\"\n}\n[/block]\n利用可能な`filter`属性の値:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"フィルター\",\n    \"h-1\": \"説明\",\n    \"0-0\": \"pname\",\n    \"1-0\": \"pshort\",\n    \"2-0\": \"pfull\",\n    \"3-0\": \"pkeywords\",\n    \"4-0\": \"pcode\",\n    \"5-0\": \"cid\",\n    \"6-0\": \"amount_from\",\n    \"7-0\": \"amount_to\",\n    \"8-0\": \"price_from\",\n    \"9-0\": \"price_to\",\n    \"0-1\": \"商品名\",\n    \"1-1\": \"短い説明\",\n    \"2-1\": \"完全な説明\",\n    \"3-1\": \"メタキーワード\",\n    \"4-1\": \"商品コード\",\n    \"5-1\": \"カテゴリーID\",\n    \"6-1\": \"在庫の最低値\",\n    \"7-1\": \"在庫の最高値\",\n    \"8-1\": \"値段の最低値\",\n    \"9-1\": \"値段の最高値\"\n  },\n  \"cols\": 2,\n  \"rows\": 10\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"追加パラメーター\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"パラメーター\",\n    \"h-1\": \"説明\",\n    \"h-2\": \"サポートされる値\",\n    \"0-0\": \"subcats\",\n    \"1-0\": \"order_ids\",\n    \"2-0\": \"free_shipping\",\n    \"3-0\": \"status\",\n    \"0-1\": \"サブカテゴリーを含むかどうかのフラグ\",\n    \"1-1\": \"注文IDで商品検索をする\",\n    \"2-1\": \"送料無料かどうかのフラグ\",\n    \"3-1\": \"商品ステータス:   \\n`A` :有効  \\n`D` :無効   \\n`H`:非表示\",\n    \"0-2\": \"`Y`\\n`N`\",\n    \"1-2\": \"オーダーIDのカンマ区切りのリスト、例:`1,13,24`\",\n    \"2-2\": \"`Y`\\n`N`\",\n    \"3-2\": \"`A`\\n`D`\\n`H`\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"ソート順\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Sort param\",\n    \"h-1\": \"説明\",\n    \"0-0\": \"status\",\n    \"1-0\": \"list_price\",\n    \"2-0\": \"product\",\n    \"3-0\": \"price\",\n    \"4-0\": \"code\",\n    \"5-0\": \"amount\",\n    \"0-1\": \"商品ステータス\",\n    \"1-1\": \"リスト価格\",\n    \"2-1\": \"商品名\",\n    \"3-1\": \"価格\",\n    \"4-1\": \"商品コード\",\n    \"5-1\": \"在庫の量\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n`asc` や `desc`に`sort_order`URLパラメーターを定義することで、降順昇順を設定することが可能です。\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"フィールド\"\n}\n[/block]\nProducts(商品)には、以下の表のプロパティーがあります。\n(必須フィールドには*が付いています)\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"JSONデータAPIリクエストが発生した場合、以下の表に記載されていないフィールドは無視されます。\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"フィールド\",\n    \"h-1\": \"説明\",\n    \"h-2\": \"デフォルト値\",\n    \"h-3\": \"サポートされる値\",\n    \"0-0\": \"product*\",\n    \"1-0\": \"category_ids\",\n    \"2-0\": \"main_category*\",\n    \"3-0\": \"price*\",\n    \"4-0\": \"company_id*\",\n    \"5-0\": \"status*\",\n    \"6-0\": \"amount\",\n    \"7-0\": \"avail_since\",\n    \"8-0\": \"box_height\",\n    \"9-0\": \"box_length\",\n    \"10-0\": \"box_width\",\n    \"11-0\": \"details_layout\",\n    \"12-0\": \"edp_shipping\",\n    \"13-0\": \"exceptions_type\",\n    \"14-0\": \"feature_comparison\",\n    \"15-0\": \"free_shipping\",\n    \"16-0\": \"full_description\",\n    \"17-0\": \"image_pairs\",\n    \"18-0\": \"is_edp\",\n    \"19-0\": \"lang_code\",\n    \"20-0\": \"list_price\",\n    \"21-0\": \"list_qty_count\",\n    \"22-0\": \"localization\",\n    \"23-0\": \"low_avail_limit\",\n    \"24-0\": \"main_pair\",\n    \"25-0\": \"max_items_in_box\",\n    \"26-0\": \"max_qty\",\n    \"27-0\": \"meta_description\",\n    \"28-0\": \"meta_keywords\",\n    \"29-0\": \"min_items_in_box\",\n    \"30-0\": \"min_qty\",\n    \"31-0\": \"options_type\",\n    \"32-0\": \"out_of_stock_actions\",\n    \"33-0\": \"page_title\",\n    \"34-0\": \"point_price\",\n    \"35-0\": \"popularity\",\n    \"36-0\": \"product_code\",\n    \"37-0\": \"product_features\",\n    \"38-0\": \"product_id\",\n    \"39-0\": \"promo_text\",\n    \"40-0\": \"qty_step\",\n    \"41-0\": \"return_period\",\n    \"42-0\": \"sales_amount\",\n    \"43-0\": \"search_words\",\n    \"44-0\": \"seo_name\",\n    \"45-0\": \"shared_product\",\n    \"46-0\": \"shipping_freight\",\n    \"47-0\": \"shipping_params\",\n    \"48-0\": \"short_description\",\n    \"49-0\": \"tax_ids\",\n    \"50-0\": \"timestamp\",\n    \"51-0\": \"tracking\",\n    \"52-0\": \"unlimited_download\",\n    \"53-0\": \"updated_timestamp\",\n    \"54-0\": \"usergroup_ids\",\n    \"55-0\": \"weight\",\n    \"56-0\": \"zero_price_action\",\n    \"0-1\": \"商品名\",\n    \"1-1\": \"商品が属するカテゴリーID\",\n    \"2-1\": \"メインカテゴリーID\",\n    \"3-1\": \"価格\",\n    \"4-1\": \"カテゴリーが属するストアIDまたは出品者ID\",\n    \"5-1\": \"商品ステータス:\\n`A` :有効\\n`D`:無効\\n`H` :非表示\",\n    \"6-1\": \"在庫数\",\n    \"7-1\": \"商品の提供開始日\",\n    \"8-1\": \"配送用外箱の高さ\",\n    \"9-1\": \"配送用外箱の奥行き\",\n    \"10-1\": \"配送用外箱の横幅\",\n    \"11-1\": \"商品詳細ページのレイアウト\",\n    \"12-1\": \"ダウンロード商品かどうかのフラグ\",\n    \"13-1\": \"例外のタイプ(許可するコンビネーションを指定/禁止するコンビネーションを指定)\",\n    \"14-1\": \"商品比較リストへの追加:有効/無効\",\n    \"15-1\": \"送料無料商品\",\n    \"16-1\": \"商品説明(完全)\",\n    \"17-1\": \"追加画像のペア\",\n    \"18-1\": \"ダウンロード:可能/不可能かのフラグ\",\n    \"19-1\": \"言語コード\",\n    \"20-1\": \"メーカー希望小売価格\",\n    \"21-1\": \"販売単位のリスト表示\",\n    \"22-1\": \"ローカライズID(複数ある場合はカンマで区切る)\",\n    \"23-1\": \"Minimal availability in stock value  \\n最小在庫数\",\n    \"24-1\": \"メイン画像とサムネイルペア\",\n    \"25-1\": \"配送用外箱に収めることのできる最大商品個数\",\n    \"26-1\": \"最大注文数\",\n    \"27-1\": \"メタディスクリプション\",\n    \"28-1\": \"メタキーワード\",\n    \"29-1\": \"配送用外箱に収めることのできる最小商品個数\",\n    \"30-1\": \"最小注文数\",\n    \"31-1\": \"オプションの指定方法  \\n同時 (P) /連続 (S)\",\n    \"32-1\": \"在庫切れ時の対応:\\nN :なし  \\nB :予約注文  \\nS :入荷通知\",\n    \"33-1\": \"商品ページタイトル\",\n    \"34-1\": \"ポイント数\",\n    \"35-1\": \"人気度(商品の人気度はページビュー、カートへの投入回数、購入件数に基づき算出されます)\",\n    \"36-1\": \"商品型番\",\n    \"37-1\": \"商品追加情報\",\n    \"38-1\": \"商品ID\",\n    \"39-1\": \"プロモーションテキスト(Promo text)\",\n    \"40-1\": \"販売単位\",\n    \"41-1\": \"返品可能期間\",\n    \"42-1\": \"販売個数\",\n    \"43-1\": \"商品に対するキーワード検索\",\n    \"44-1\": \"SEO用名称(SEOアドオン)\",\n    \"45-1\": \"商品をシェア(シェア可能かどうか)\",\n    \"46-1\": \"追加送料\",\n    \"47-1\": \"配送出荷データ\",\n    \"48-1\": \"一覧に表示する商品概要\",\n    \"49-1\": \"税金IDの配列\",\n    \"50-1\": \"商品追加(データ作成)タイムスタンプ\",\n    \"51-1\": \"在庫追跡モード\\nO :オプションありで追跡  \\nB :オプションなしでの追跡  \\nD :追跡しない\",\n    \"52-1\": \"ダウンロード期間の制限なしかどうかのフラグ\",\n    \"53-1\": \"最新更新日時\",\n    \"54-1\": \"ユーザーグループID\",\n    \"55-1\": \"重量\",\n    \"56-1\": \"価格ゼロ商品の取り扱い  \\n`R` :カートへの追加を禁止  \\n`P `:カートへの追加を許可  \\n`A` :お客様が価格を入力\",\n    \"0-3\": \"string\",\n    \"1-3\": \"有効なカテゴリーIDの配列\",\n    \"2-3\": \"存在するカテゴリーID\",\n    \"0-2\": \"—\",\n    \"1-2\": \"—\",\n    \"2-2\": \"—\",\n    \"3-2\": \"0\",\n    \"5-2\": \"`A`\",\n    \"6-2\": \"1\",\n    \"7-2\": \"—\",\n    \"8-2\": \"0\",\n    \"9-2\": \"0\",\n    \"10-2\": \"0\",\n    \"4-2\": \"デフォルトのカンパニーID\",\n    \"11-2\": \"‘default’\",\n    \"12-2\": \"`N`\",\n    \"13-2\": \"`F`\",\n    \"14-2\": \"`N`\",\n    \"15-2\": \"`N`\",\n    \"17-2\": \"空の配列\",\n    \"18-2\": \"`N`\",\n    \"19-2\": \"デフォルト言語コード\",\n    \"20-2\": \"0\",\n    \"21-2\": \"0\",\n    \"23-2\": \"0\",\n    \"24-2\": \"空の配列\",\n    \"25-2\": \"0\",\n    \"26-2\": \"0\",\n    \"29-2\": \"0\",\n    \"30-2\": \"0\",\n    \"31-2\": \"`P`\",\n    \"32-2\": \"`N`\",\n    \"34-2\": \"0\",\n    \"35-2\": \"3\",\n    \"37-2\": \"empty array\",\n    \"38-2\": \"自動でセットされます\",\n    \"40-2\": \"0\",\n    \"41-2\": \"10\",\n    \"42-2\": \"0\",\n    \"45-2\": \"`N`\",\n    \"46-2\": \"0\",\n    \"47-2\": \"配送データを元に自動生成\",\n    \"49-2\": \"空の配列\",\n    \"50-2\": \"自動でセットされます\",\n    \"51-2\": \"`B`\",\n    \"52-2\": \"`N`\",\n    \"53-2\": \"最終更新日時のタイムスタンプ\",\n    \"54-2\": \"‘0’\",\n    \"55-2\": \"0\",\n    \"56-2\": \"`R`\",\n    \"16-2\": \"‘’\",\n    \"22-2\": \"‘’\",\n    \"27-2\": \"‘’\",\n    \"28-2\": \"‘’\",\n    \"33-2\": \"‘’\",\n    \"36-2\": \"‘’\",\n    \"39-2\": \"‘’\",\n    \"43-2\": \"‘’\",\n    \"44-2\": \"‘’\",\n    \"48-2\": \"‘’\",\n    \"16-3\": \"string\",\n    \"22-3\": \"string\",\n    \"27-3\": \"string\",\n    \"28-3\": \"string\",\n    \"33-3\": \"string\",\n    \"36-3\": \"string\",\n    \"39-3\": \"string\",\n    \"43-3\": \"string\",\n    \"44-3\": \"string\",\n    \"47-3\": \"string\",\n    \"48-3\": \"string\",\n    \"56-3\": \"`R`\\n`P`\\n`A`\",\n    \"55-3\": \"float\",\n    \"54-3\": \"複数の場合は、ユザーグループIDをカンマで区切る\",\n    \"53-3\": \"正しいタイムスタンプ(UNIXタイムスタンプ)\",\n    \"52-3\": \"`Y`\\n`N`\",\n    \"51-3\": \"`O`\\n`B`\\n`D`\",\n    \"50-3\": \"正しいタイムスタンプ(UNIXタイムスタンプ)\",\n    \"49-3\": \"array\",\n    \"46-3\": \"float\",\n    \"45-3\": \"`Y`\\n`N`\",\n    \"42-3\": \"integer\",\n    \"41-3\": \"integer\",\n    \"40-3\": \"integer\",\n    \"38-3\": \"integer\",\n    \"37-3\": \"array of product features with feature ID as key and feature data as value\",\n    \"35-3\": \"integer\",\n    \"34-3\": \"float\",\n    \"32-3\": \"`N`\\n`B`\\n`S`\",\n    \"31-3\": \"`S`\\n`P`\",\n    \"30-3\": \"integer\",\n    \"29-3\": \"integer\",\n    \"26-3\": \"integer\",\n    \"25-3\": \"integer\",\n    \"24-3\": \"メイン画像ペア配列 (以下を参照)\",\n    \"23-3\": \"integer\",\n    \"21-3\": \"integer\",\n    \"20-3\": \"float\",\n    \"19-3\": \"`en`\\n`ru`\\n等\",\n    \"18-3\": \"`Y`\\n`N`\",\n    \"17-3\": \"array with image pair ID as key and image pair as value   \\n\\nイメージペアIDをキーとし、イメージペアの値をバリューとした配列\",\n    \"15-3\": \"`Y`\\n`N`\",\n    \"14-3\": \"`Y`\\n`N`\",\n    \"13-3\": \"`A`\\n`F`\",\n    \"12-3\": \"`Y`\\n`N`\",\n    \"11-3\": \"有効な商品テンプレート名\",\n    \"10-3\": \"integer\",\n    \"9-3\": \"integer\",\n    \"8-3\": \"integer\",\n    \"6-3\": \"integer\",\n    \"7-3\": \"UNIXフォーマットの日付\",\n    \"5-3\": \"`A`\\n`D`\\n`H`\",\n    \"4-3\": \"integer\",\n    \"3-3\": \"float\"\n  },\n  \"cols\": 4,\n  \"rows\": 57\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"メイン画像のペア\"\n}\n[/block]\n全ての画像とサムネイルのペア\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"フィールド\",\n    \"h-1\": \"説明\",\n    \"h-2\": \"デフォルト値\",\n    \"h-3\": \"サポートされる値\",\n    \"0-0\": \"detailed_id\",\n    \"1-0\": \"image_id\",\n    \"2-0\": \"pair_id\",\n    \"3-0\": \"position\",\n    \"4-0\": \"icon\",\n    \"5-0\": \"detailed\",\n    \"6-0\": \"absolute_path\",\n    \"7-0\": \"alt\",\n    \"8-0\": \"http_image_path\",\n    \"9-0\": \"image_path\",\n    \"10-0\": \"image_x\",\n    \"11-0\": \"image_y\",\n    \"0-1\": \"詳細画像のID\",\n    \"1-1\": \"サムネイルID\",\n    \"2-1\": \"画像のペアID\",\n    \"3-1\": \"画像のペアの位置\",\n    \"4-1\": \"サムネイルデータ\",\n    \"5-1\": \"詳細画像のデータ\",\n    \"6-1\": \"画像への絶対的なファイルシステムパス\",\n    \"7-1\": \"代替テキスト(画像の読み込みに失敗した際に表示)\",\n    \"8-1\": \"画像へのHTTPパス\",\n    \"9-1\": \"実際の画像パス(HTTPまたはHTTPSは、`http_images_path`と同じでよい)\",\n    \"10-1\": \"イメージの横幅をピクセル数で\",\n    \"11-1\": \"イメージの高さをピクセル数で\",\n    \"0-2\": \"自動でセットされます\",\n    \"0-3\": \"integer\",\n    \"1-3\": \"integer\",\n    \"2-3\": \"integer\",\n    \"3-3\": \"integer\",\n    \"10-3\": \"integer\",\n    \"11-3\": \"integer\",\n    \"9-3\": \"画像を指定する有効なURLは\",\n    \"8-3\": \"有効な画像のURLを指定\",\n    \"7-3\": \"string\",\n    \"6-3\": \"有効なファイルシステムパス\",\n    \"5-3\": \"配列(次のような値を含む)\",\n    \"4-3\": \"配列(`detailed`のような)詳細は以下参照\",\n    \"7-2\": \"‘’\",\n    \"4-2\": \"—\",\n    \"5-2\": \"—\",\n    \"8-2\": \"—\",\n    \"10-2\": \"—\",\n    \"11-2\": \"—\",\n    \"3-2\": \"0\",\n    \"1-2\": \"0\",\n    \"2-2\": \"自動でセットされます\",\n    \"6-2\": \"ー\",\n    \"9-2\": \"ー\"\n  },\n  \"cols\": 4,\n  \"rows\": 12\n}\n[/block]","excerpt":"","slug":"products","type":"basic","title":"Products"}
[block:api-header] { "type": "basic", "title": "URLs" } [/block] - [http://example.com/api/](link)**products**—全ての商品を参照します。`GET`と`POST`のみサポートされています。 - [http://example.com/api/](link)**products/:id**—特定の商品を参照します。 すべてのメソッド(`GET`/`PUT`/`DELETE`)がサポートされています。 - [http://example.com/api/](link)**categories/:id/products**—特定の[カテゴリー](doc:category)に属している商品全てを参照します。 - [http://example.com/api/](link)**categories/:id/products/:id**—特定のカテゴリーに属している特定の商品を参照します。 [block:api-header] { "type": "basic", "title": "入れ子のオブジェクト" } [/block] - [追加情報](doc;product-features) [block:api-header] { "type": "basic", "title": "フィルタリング" } [/block] フィルターを基にして商品を取得するため、利用可能なフィルターの1つを使用することができます。商品のフィルタリングは管理パネルで行われる高度な検索に似ています。 リクエストURLは以下です(読みやすいようにいくつかの行に分かれています) [block:code] { "codes": [ { "code": "http://example.com/api/products?\n<filter>=Y&\n<additional_param>=<value>&\n<another_param>=<value>&\n...\nsort_by=<sorting>&\nsort_order=<sort_order>&\nq=<query>", "language": "html" } ] } [/block] - `filter`は使用可能な[フィルター](link)の1つです。`&<another_filter>=Y`を持つURLを追加することにより、一度に任意の数のフィルターを使用することが可能です。 additional_param is one of the available additional params. It is possible to use any number of additional params at a time by appending the URL with &= - `additional_param`は使用可能な[追加パラメーター](link)の1つです。`&<another_param>=<value>`を持つURLを追加することにより、一度に任意の数の追加パラメーターを使用することができます。 sorting is one of the available sortings - `sorting` は利用可能な[ソーティング](link)の1つです。 sort_order is the sort direction; asc or desc for ascending and descending accordingly - `sort_order`はソートのディレクションです:昇順や降順に応じた`asc`や`desc` - `query` は検索クエリです。 CS-Cartの複数店舗機能やマーケットプレイス版で特定のストアを参照した結果を得るため、`stores`や `vendors`エンティティーを使用します: [block:code] { "codes": [ { "code": "http://example.com/api/stores/1/products?pname=foo\nhttp://example.com/api/vendors/1/products?pname=bar", "language": "html" } ] } [/block] ##例 最初のショップの商品で説明文に「foo」が記述されており、10ドル以上の商品で商品名をアルファベット順で取得する: [block:code] { "codes": [ { "code": "curl --user admin@example.com:APIkey -X GET 'http://example.com/api/store/1/products?pfull=Y&price_from=10&sort_by=product&sort_order=asc&q=foo'", "language": "http" } ] } [/block] [block:api-header] { "type": "basic", "title": "フィルター" } [/block] 利用可能な`filter`属性の値: [block:parameters] { "data": { "h-0": "フィルター", "h-1": "説明", "0-0": "pname", "1-0": "pshort", "2-0": "pfull", "3-0": "pkeywords", "4-0": "pcode", "5-0": "cid", "6-0": "amount_from", "7-0": "amount_to", "8-0": "price_from", "9-0": "price_to", "0-1": "商品名", "1-1": "短い説明", "2-1": "完全な説明", "3-1": "メタキーワード", "4-1": "商品コード", "5-1": "カテゴリーID", "6-1": "在庫の最低値", "7-1": "在庫の最高値", "8-1": "値段の最低値", "9-1": "値段の最高値" }, "cols": 2, "rows": 10 } [/block] [block:api-header] { "type": "basic", "title": "追加パラメーター" } [/block] [block:parameters] { "data": { "h-0": "パラメーター", "h-1": "説明", "h-2": "サポートされる値", "0-0": "subcats", "1-0": "order_ids", "2-0": "free_shipping", "3-0": "status", "0-1": "サブカテゴリーを含むかどうかのフラグ", "1-1": "注文IDで商品検索をする", "2-1": "送料無料かどうかのフラグ", "3-1": "商品ステータス: \n`A` :有効 \n`D` :無効 \n`H`:非表示", "0-2": "`Y`\n`N`", "1-2": "オーダーIDのカンマ区切りのリスト、例:`1,13,24`", "2-2": "`Y`\n`N`", "3-2": "`A`\n`D`\n`H`" }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "ソート順" } [/block] [block:parameters] { "data": { "h-0": "Sort param", "h-1": "説明", "0-0": "status", "1-0": "list_price", "2-0": "product", "3-0": "price", "4-0": "code", "5-0": "amount", "0-1": "商品ステータス", "1-1": "リスト価格", "2-1": "商品名", "3-1": "価格", "4-1": "商品コード", "5-1": "在庫の量" }, "cols": 2, "rows": 6 } [/block] `asc` や `desc`に`sort_order`URLパラメーターを定義することで、降順昇順を設定することが可能です。 [block:api-header] { "type": "basic", "title": "フィールド" } [/block] Products(商品)には、以下の表のプロパティーがあります。 (必須フィールドには*が付いています) [block:callout] { "type": "info", "body": "JSONデータAPIリクエストが発生した場合、以下の表に記載されていないフィールドは無視されます。" } [/block] [block:parameters] { "data": { "h-0": "フィールド", "h-1": "説明", "h-2": "デフォルト値", "h-3": "サポートされる値", "0-0": "product*", "1-0": "category_ids", "2-0": "main_category*", "3-0": "price*", "4-0": "company_id*", "5-0": "status*", "6-0": "amount", "7-0": "avail_since", "8-0": "box_height", "9-0": "box_length", "10-0": "box_width", "11-0": "details_layout", "12-0": "edp_shipping", "13-0": "exceptions_type", "14-0": "feature_comparison", "15-0": "free_shipping", "16-0": "full_description", "17-0": "image_pairs", "18-0": "is_edp", "19-0": "lang_code", "20-0": "list_price", "21-0": "list_qty_count", "22-0": "localization", "23-0": "low_avail_limit", "24-0": "main_pair", "25-0": "max_items_in_box", "26-0": "max_qty", "27-0": "meta_description", "28-0": "meta_keywords", "29-0": "min_items_in_box", "30-0": "min_qty", "31-0": "options_type", "32-0": "out_of_stock_actions", "33-0": "page_title", "34-0": "point_price", "35-0": "popularity", "36-0": "product_code", "37-0": "product_features", "38-0": "product_id", "39-0": "promo_text", "40-0": "qty_step", "41-0": "return_period", "42-0": "sales_amount", "43-0": "search_words", "44-0": "seo_name", "45-0": "shared_product", "46-0": "shipping_freight", "47-0": "shipping_params", "48-0": "short_description", "49-0": "tax_ids", "50-0": "timestamp", "51-0": "tracking", "52-0": "unlimited_download", "53-0": "updated_timestamp", "54-0": "usergroup_ids", "55-0": "weight", "56-0": "zero_price_action", "0-1": "商品名", "1-1": "商品が属するカテゴリーID", "2-1": "メインカテゴリーID", "3-1": "価格", "4-1": "カテゴリーが属するストアIDまたは出品者ID", "5-1": "商品ステータス:\n`A` :有効\n`D`:無効\n`H` :非表示", "6-1": "在庫数", "7-1": "商品の提供開始日", "8-1": "配送用外箱の高さ", "9-1": "配送用外箱の奥行き", "10-1": "配送用外箱の横幅", "11-1": "商品詳細ページのレイアウト", "12-1": "ダウンロード商品かどうかのフラグ", "13-1": "例外のタイプ(許可するコンビネーションを指定/禁止するコンビネーションを指定)", "14-1": "商品比較リストへの追加:有効/無効", "15-1": "送料無料商品", "16-1": "商品説明(完全)", "17-1": "追加画像のペア", "18-1": "ダウンロード:可能/不可能かのフラグ", "19-1": "言語コード", "20-1": "メーカー希望小売価格", "21-1": "販売単位のリスト表示", "22-1": "ローカライズID(複数ある場合はカンマで区切る)", "23-1": "Minimal availability in stock value \n最小在庫数", "24-1": "メイン画像とサムネイルペア", "25-1": "配送用外箱に収めることのできる最大商品個数", "26-1": "最大注文数", "27-1": "メタディスクリプション", "28-1": "メタキーワード", "29-1": "配送用外箱に収めることのできる最小商品個数", "30-1": "最小注文数", "31-1": "オプションの指定方法 \n同時 (P) /連続 (S)", "32-1": "在庫切れ時の対応:\nN :なし \nB :予約注文 \nS :入荷通知", "33-1": "商品ページタイトル", "34-1": "ポイント数", "35-1": "人気度(商品の人気度はページビュー、カートへの投入回数、購入件数に基づき算出されます)", "36-1": "商品型番", "37-1": "商品追加情報", "38-1": "商品ID", "39-1": "プロモーションテキスト(Promo text)", "40-1": "販売単位", "41-1": "返品可能期間", "42-1": "販売個数", "43-1": "商品に対するキーワード検索", "44-1": "SEO用名称(SEOアドオン)", "45-1": "商品をシェア(シェア可能かどうか)", "46-1": "追加送料", "47-1": "配送出荷データ", "48-1": "一覧に表示する商品概要", "49-1": "税金IDの配列", "50-1": "商品追加(データ作成)タイムスタンプ", "51-1": "在庫追跡モード\nO :オプションありで追跡 \nB :オプションなしでの追跡 \nD :追跡しない", "52-1": "ダウンロード期間の制限なしかどうかのフラグ", "53-1": "最新更新日時", "54-1": "ユーザーグループID", "55-1": "重量", "56-1": "価格ゼロ商品の取り扱い \n`R` :カートへの追加を禁止 \n`P `:カートへの追加を許可 \n`A` :お客様が価格を入力", "0-3": "string", "1-3": "有効なカテゴリーIDの配列", "2-3": "存在するカテゴリーID", "0-2": "—", "1-2": "—", "2-2": "—", "3-2": "0", "5-2": "`A`", "6-2": "1", "7-2": "—", "8-2": "0", "9-2": "0", "10-2": "0", "4-2": "デフォルトのカンパニーID", "11-2": "‘default’", "12-2": "`N`", "13-2": "`F`", "14-2": "`N`", "15-2": "`N`", "17-2": "空の配列", "18-2": "`N`", "19-2": "デフォルト言語コード", "20-2": "0", "21-2": "0", "23-2": "0", "24-2": "空の配列", "25-2": "0", "26-2": "0", "29-2": "0", "30-2": "0", "31-2": "`P`", "32-2": "`N`", "34-2": "0", "35-2": "3", "37-2": "empty array", "38-2": "自動でセットされます", "40-2": "0", "41-2": "10", "42-2": "0", "45-2": "`N`", "46-2": "0", "47-2": "配送データを元に自動生成", "49-2": "空の配列", "50-2": "自動でセットされます", "51-2": "`B`", "52-2": "`N`", "53-2": "最終更新日時のタイムスタンプ", "54-2": "‘0’", "55-2": "0", "56-2": "`R`", "16-2": "‘’", "22-2": "‘’", "27-2": "‘’", "28-2": "‘’", "33-2": "‘’", "36-2": "‘’", "39-2": "‘’", "43-2": "‘’", "44-2": "‘’", "48-2": "‘’", "16-3": "string", "22-3": "string", "27-3": "string", "28-3": "string", "33-3": "string", "36-3": "string", "39-3": "string", "43-3": "string", "44-3": "string", "47-3": "string", "48-3": "string", "56-3": "`R`\n`P`\n`A`", "55-3": "float", "54-3": "複数の場合は、ユザーグループIDをカンマで区切る", "53-3": "正しいタイムスタンプ(UNIXタイムスタンプ)", "52-3": "`Y`\n`N`", "51-3": "`O`\n`B`\n`D`", "50-3": "正しいタイムスタンプ(UNIXタイムスタンプ)", "49-3": "array", "46-3": "float", "45-3": "`Y`\n`N`", "42-3": "integer", "41-3": "integer", "40-3": "integer", "38-3": "integer", "37-3": "array of product features with feature ID as key and feature data as value", "35-3": "integer", "34-3": "float", "32-3": "`N`\n`B`\n`S`", "31-3": "`S`\n`P`", "30-3": "integer", "29-3": "integer", "26-3": "integer", "25-3": "integer", "24-3": "メイン画像ペア配列 (以下を参照)", "23-3": "integer", "21-3": "integer", "20-3": "float", "19-3": "`en`\n`ru`\n等", "18-3": "`Y`\n`N`", "17-3": "array with image pair ID as key and image pair as value \n\nイメージペアIDをキーとし、イメージペアの値をバリューとした配列", "15-3": "`Y`\n`N`", "14-3": "`Y`\n`N`", "13-3": "`A`\n`F`", "12-3": "`Y`\n`N`", "11-3": "有効な商品テンプレート名", "10-3": "integer", "9-3": "integer", "8-3": "integer", "6-3": "integer", "7-3": "UNIXフォーマットの日付", "5-3": "`A`\n`D`\n`H`", "4-3": "integer", "3-3": "float" }, "cols": 4, "rows": 57 } [/block] [block:api-header] { "type": "basic", "title": "メイン画像のペア" } [/block] 全ての画像とサムネイルのペア [block:parameters] { "data": { "h-0": "フィールド", "h-1": "説明", "h-2": "デフォルト値", "h-3": "サポートされる値", "0-0": "detailed_id", "1-0": "image_id", "2-0": "pair_id", "3-0": "position", "4-0": "icon", "5-0": "detailed", "6-0": "absolute_path", "7-0": "alt", "8-0": "http_image_path", "9-0": "image_path", "10-0": "image_x", "11-0": "image_y", "0-1": "詳細画像のID", "1-1": "サムネイルID", "2-1": "画像のペアID", "3-1": "画像のペアの位置", "4-1": "サムネイルデータ", "5-1": "詳細画像のデータ", "6-1": "画像への絶対的なファイルシステムパス", "7-1": "代替テキスト(画像の読み込みに失敗した際に表示)", "8-1": "画像へのHTTPパス", "9-1": "実際の画像パス(HTTPまたはHTTPSは、`http_images_path`と同じでよい)", "10-1": "イメージの横幅をピクセル数で", "11-1": "イメージの高さをピクセル数で", "0-2": "自動でセットされます", "0-3": "integer", "1-3": "integer", "2-3": "integer", "3-3": "integer", "10-3": "integer", "11-3": "integer", "9-3": "画像を指定する有効なURLは", "8-3": "有効な画像のURLを指定", "7-3": "string", "6-3": "有効なファイルシステムパス", "5-3": "配列(次のような値を含む)", "4-3": "配列(`detailed`のような)詳細は以下参照", "7-2": "‘’", "4-2": "—", "5-2": "—", "8-2": "—", "10-2": "—", "11-2": "—", "3-2": "0", "1-2": "0", "2-2": "自動でセットされます", "6-2": "ー", "9-2": "ー" }, "cols": 4, "rows": 12 } [/block]