{"_id":"5544d76bd8833c0d00582820","category":{"_id":"5544d76ad8833c0d00582803","pages":["5544d76bd8833c0d00582815","5544d76bd8833c0d00582816","5544d76bd8833c0d00582817","5544d76bd8833c0d00582818","5544d76bd8833c0d00582819","5544d76bd8833c0d0058281a","5544d76bd8833c0d0058281b","5544d76bd8833c0d0058281c","5544d76bd8833c0d0058281d","5544d76bd8833c0d0058281e","5544d76bd8833c0d0058281f","5544d76bd8833c0d00582820","5544d76bd8833c0d00582821","5544d76bd8833c0d00582822","5544d76bd8833c0d00582823"],"__v":1,"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"},"project":"55227389b4a0de0d00de7e28","__v":0,"user":"552342f6e20da719000e7925","version":{"_id":"5544d76ad8833c0d00582801","__v":1,"project":"55227389b4a0de0d00de7e28","forked_from":"55227389b4a0de0d00de7e2b","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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-04-09T04:56:41.129Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":11,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"URLs\"\n}\n[/block]\n- [http://example.com/api/](link)**stores**—全てのストアを参照します。`GET`と`POST`のみサポートされています。\n- [http://example.com/api/](link)**stores/:id**—特定のストアを参照します。 メソッド(`GET`/`PUT`/`DELETE`)がサポートされています。\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"例\"\n}\n[/block]\n##全てのストアを参照\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --user admin:::at:::example.com:APIkey -X GET 'http://example.com/api/stores'\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n戻り値:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"[\\n    {\\n        \\\"company_id\\\": \\\"2\\\",\\n        \\\"lang_code\\\": \\\"en\\\",\\n        \\\"email\\\": \\\"acme_corp@example.com\\\",\\n        \\\"company\\\": \\\"ACME Corp\\\",\\n        \\\"timestamp\\\": \\\"1269610461\\\",\\n        \\\"status\\\": \\\"A\\\"\\n    },\\n    {\\n        \\\"company_id\\\": \\\"1\\\",\\n        \\\"lang_code\\\": \\\"en\\\",\\n        \\\"email\\\": \\\"simtech@example.com\\\",\\n        \\\"company\\\": \\\"Simtech\\\",\\n        \\\"timestamp\\\": \\\"1269610461\\\",\\n        \\\"status\\\": \\\"A\\\"\\n    }\\n]\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\n---------\n\n## ID2のストアのデータを参照\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --user admin@example.com:APIkey -X GET 'http://example.com/api/stores/2'\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n戻り値:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"company_id\\\": \\\"2\\\",\\n    \\\"lang_code\\\": \\\"en\\\",\\n    \\\"email\\\": \\\"acme_corp@example.com\\\",\\n    \\\"company\\\": \\\"ACME Corp\\\",\\n    \\\"timestamp\\\": \\\"1269610461\\\",\\n    \\\"status\\\": \\\"A\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n---------\n\n\n##ストアを作成\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --user admin@example.com:APIkey --header 'Content-Type: application/json'\\\\\\n-d '{\\\"company\\\": \\\"My Awesome Store\\\", \\\"storefront\\\": \\\"http://myawesomestore.com\\\"}'\\\\\\n-X POST 'http://example.com/api/stores'\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n戻り値:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"store_id\\\": \\\"3\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n---------\n\n##商品とカテゴリーを複製してストアを作成する\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --user admin@example.com:APIkey --header 'Content-Type: application/json'\\\\\\n-d '{\\\"company\\\": \\\"Another Awesome Store\\\", \\\"storefront\\\": \\\"http://anotherawesomestore.com\\\",\\\\\\n\\\"clone_from\\\": 2, \\\"clone\\\": {\\\"products\\\": \\\"Y\\\", \\\"categories\\\": \\\"Y\\\"}}'\\\\\\n-X POST 'http://example.com/api/stores'\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n戻り値:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"store_id\\\": \\\"4\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n---------\n\n##会社概要を更新する\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --user admin@example.com:APIkey --header 'Content-Type: application/json'\\n-d '{\\\"company_description\\\": \\\"This is my awesome store description\\\"}'\\n-X PUT 'http://example.com/api/stores/3'\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n戻り値:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"store_id\\\": \\\"3\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"フィールド\"\n}\n[/block]\nStoresは以下のプロパティを含んでいます。\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\": \"company*\",\n    \"1-0\": \"storefront*\",\n    \"2-0\": \"company_id\",\n    \"3-0\": \"email\",\n    \"4-0\": \"lang_code\",\n    \"5-0\": \"timestamp\",\n    \"6-0\": \"status\",\n    \"7-0\": \"secure_storefront\",\n    \"8-0\": \"company_description\",\n    \"9-0\": \"redirect_customer\",\n    \"10-0\": \"entry_page\",\n    \"11-0\": \"countries_list\",\n    \"12-0\": \"company_name\",\n    \"13-0\": \"company_address\",\n    \"14-0\": \"company_city\",\n    \"15-0\": \"company_country\",\n    \"16-0\": \"company_state\",\n    \"17-0\": \"company_zipcode\",\n    \"18-0\": \"company_phone\",\n    \"19-0\": \"company_phone_2\",\n    \"20-0\": \"company_fax\",\n    \"21-0\": \"company_website\",\n    \"22-0\": \"company_start_year\",\n    \"23-0\": \"company_users_department\",\n    \"24-0\": \"company_site_administrator\",\n    \"25-0\": \"company_orders_department\",\n    \"26-0\": \"company_support_department\",\n    \"27-0\": \"company_newsletter_email\",\n    \"28-0\": \"clone_from\",\n    \"29-0\": \"clone\",\n    \"0-1\": \"ストア名称\",\n    \"1-1\": \"ストアフロントURL\",\n    \"2-1\": \"ストアID\",\n    \"3-1\": \"メールアドレス\",\n    \"4-1\": \"言語コード\",\n    \"5-1\": \"ストア作成時のタイムスタンプ\",\n    \"6-1\": \"ステータス\",\n    \"7-1\": \"SSLアクセス時のストアフロントURL\",\n    \"8-1\": \"ストア説明文\",\n    \"9-1\": \"訪問者を国ごとのストアにリダイレクトさせるかどうかのフラグ (IPによる定義)\",\n    \"10-1\": \"グローバルエントリーページ (`redirect_customer `が `N`の場合)\",\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\": \"会社電話番号 2\",\n    \"20-1\": \"会社FAX番号\",\n    \"21-1\": \"会社ウェブサイト\",\n    \"22-1\": \"会社設立年\",\n    \"23-1\": \"顧客担当メールアドレス\",\n    \"24-1\": \"サイト管理者メールアドレス\",\n    \"25-1\": \"注文管理者メールアドレス\",\n    \"26-1\": \"ヘルプ/サポート担当メールアドレス\",\n    \"27-1\": \"メルマガの返信先メールアドレス\",\n    \"28-1\": \"クローン元のストアID\",\n    \"29-1\": \"複製の設定\",\n    \"0-2\": \"—\",\n    \"1-2\": \"—\",\n    \"3-2\": \"—\",\n    \"7-2\": \"—\",\n    \"28-2\": \"—\",\n    \"27-2\": \"‘’\",\n    \"26-2\": \"‘’\",\n    \"25-2\": \"‘’\",\n    \"24-2\": \"‘’\",\n    \"23-2\": \"‘’\",\n    \"22-2\": \"‘’\",\n    \"21-2\": \"‘’\",\n    \"20-2\": \"‘’\",\n    \"19-2\": \"‘’\",\n    \"18-2\": \"‘’\",\n    \"17-2\": \"‘’\",\n    \"16-2\": \"‘’\",\n    \"15-2\": \"‘’\",\n    \"14-2\": \"‘’\",\n    \"13-2\": \"‘’\",\n    \"12-2\": \"‘’\",\n    \"8-2\": \"‘’\",\n    \"4-2\": \"デフォルトの言語コード\",\n    \"2-2\": \"自動でセットされます\",\n    \"5-2\": \"自動でセットされます\",\n    \"6-2\": \"`A`\",\n    \"9-2\": \"`Y`\",\n    \"10-2\": \"index\",\n    \"11-2\": \"[]\",\n    \"29-2\": \"[]\",\n    \"29-3\": \"ストア属性オブジェクトのキーと `Y `値\\n利用可能な属性:\\n  \\n- layouts  \\n- settings  \\n- profile_fields  \\n- pages  \\n- promotions  \\n- shippings  \\n- payments  \\n- product_filters  \\n- product_features  \\n- sitemap  \\n- static_data_clone  \\n- products  \\n- categories\",\n    \"28-3\": \"正しいストアID\",\n    \"27-3\": \"string\",\n    \"26-3\": \"string\",\n    \"25-3\": \"string\",\n    \"24-3\": \"string\",\n    \"23-3\": \"string\",\n    \"22-3\": \"string\",\n    \"21-3\": \"string\",\n    \"20-3\": \"string\",\n    \"19-3\": \"string\",\n    \"18-3\": \"string\",\n    \"17-3\": \"string\",\n    \"16-3\": \"string\",\n    \"15-3\": \"string\",\n    \"14-3\": \"string\",\n    \"13-3\": \"string\",\n    \"12-3\": \"string\",\n    \"11-3\": \"国コードの配列 (‘DZ’, ‘AS’, 等)\",\n    \"10-3\": \"`all_pages`  \\n`none`  \\n`index`\",\n    \"9-3\": \"`Y`  \\n`N`\",\n    \"8-3\": \"string\",\n    \"7-3\": \"正しいURL\",\n    \"6-3\": \"`A` :有効  \\n`D `:無効  \\n`H`:非表示\",\n    \"5-3\": \"正しいUNIX形式のタイムスタンプ\",\n    \"4-3\": \"`en`  \\n`ja`  \\n等\",\n    \"3-3\": \"正しメールアドレス\",\n    \"2-3\": \"integer\",\n    \"0-3\": \"string\",\n    \"1-3\": \"正しいURL\"\n  },\n  \"cols\": 4,\n  \"rows\": 30\n}\n[/block]","excerpt":"","slug":"stores","type":"basic","title":"Stores"}
[block:api-header] { "type": "basic", "title": "URLs" } [/block] - [http://example.com/api/](link)**stores**—全てのストアを参照します。`GET`と`POST`のみサポートされています。 - [http://example.com/api/](link)**stores/:id**—特定のストアを参照します。 メソッド(`GET`/`PUT`/`DELETE`)がサポートされています。 [block:api-header] { "type": "basic", "title": "例" } [/block] ##全てのストアを参照 [block:code] { "codes": [ { "code": "curl --user admin@example.com:APIkey -X GET 'http://example.com/api/stores'", "language": "http" } ] } [/block] 戻り値: [block:code] { "codes": [ { "code": "[\n {\n \"company_id\": \"2\",\n \"lang_code\": \"en\",\n \"email\": \"acme_corp@example.com\",\n \"company\": \"ACME Corp\",\n \"timestamp\": \"1269610461\",\n \"status\": \"A\"\n },\n {\n \"company_id\": \"1\",\n \"lang_code\": \"en\",\n \"email\": \"simtech@example.com\",\n \"company\": \"Simtech\",\n \"timestamp\": \"1269610461\",\n \"status\": \"A\"\n }\n]", "language": "php" } ] } [/block] --------- ## ID2のストアのデータを参照 [block:code] { "codes": [ { "code": "curl --user admin@example.com:APIkey -X GET 'http://example.com/api/stores/2'", "language": "http" } ] } [/block] 戻り値: [block:code] { "codes": [ { "code": "{\n \"company_id\": \"2\",\n \"lang_code\": \"en\",\n \"email\": \"acme_corp@example.com\",\n \"company\": \"ACME Corp\",\n \"timestamp\": \"1269610461\",\n \"status\": \"A\"\n}", "language": "json" } ] } [/block] --------- ##ストアを作成 [block:code] { "codes": [ { "code": "curl --user admin@example.com:APIkey --header 'Content-Type: application/json'\\\n-d '{\"company\": \"My Awesome Store\", \"storefront\": \"http://myawesomestore.com\"}'\\\n-X POST 'http://example.com/api/stores'", "language": "http" } ] } [/block] 戻り値: [block:code] { "codes": [ { "code": "{\n \"store_id\": \"3\"\n}", "language": "json" } ] } [/block] --------- ##商品とカテゴリーを複製してストアを作成する [block:code] { "codes": [ { "code": "curl --user admin@example.com:APIkey --header 'Content-Type: application/json'\\\n-d '{\"company\": \"Another Awesome Store\", \"storefront\": \"http://anotherawesomestore.com\",\\\n\"clone_from\": 2, \"clone\": {\"products\": \"Y\", \"categories\": \"Y\"}}'\\\n-X POST 'http://example.com/api/stores'", "language": "http" } ] } [/block] 戻り値: [block:code] { "codes": [ { "code": "{\n \"store_id\": \"4\"\n}", "language": "json" } ] } [/block] --------- ##会社概要を更新する [block:code] { "codes": [ { "code": "curl --user admin@example.com:APIkey --header 'Content-Type: application/json'\n-d '{\"company_description\": \"This is my awesome store description\"}'\n-X PUT 'http://example.com/api/stores/3'", "language": "http" } ] } [/block] 戻り値: [block:code] { "codes": [ { "code": "{\n \"store_id\": \"3\"\n}", "language": "json" } ] } [/block] [block:api-header] { "type": "basic", "title": "フィールド" } [/block] Storesは以下のプロパティを含んでいます。 サポートされたフィールドは以下のリストで全部です(必須フィールドには*がついています) [block:callout] { "type": "info", "body": "JSONデータAPIリクエストが発生した場合、以下の表に記載されていないフィールドは無視されます。" } [/block] [block:parameters] { "data": { "h-0": "フィールド", "h-1": "説明", "h-2": "デフォルト値", "h-3": "サポートされる値", "0-0": "company*", "1-0": "storefront*", "2-0": "company_id", "3-0": "email", "4-0": "lang_code", "5-0": "timestamp", "6-0": "status", "7-0": "secure_storefront", "8-0": "company_description", "9-0": "redirect_customer", "10-0": "entry_page", "11-0": "countries_list", "12-0": "company_name", "13-0": "company_address", "14-0": "company_city", "15-0": "company_country", "16-0": "company_state", "17-0": "company_zipcode", "18-0": "company_phone", "19-0": "company_phone_2", "20-0": "company_fax", "21-0": "company_website", "22-0": "company_start_year", "23-0": "company_users_department", "24-0": "company_site_administrator", "25-0": "company_orders_department", "26-0": "company_support_department", "27-0": "company_newsletter_email", "28-0": "clone_from", "29-0": "clone", "0-1": "ストア名称", "1-1": "ストアフロントURL", "2-1": "ストアID", "3-1": "メールアドレス", "4-1": "言語コード", "5-1": "ストア作成時のタイムスタンプ", "6-1": "ステータス", "7-1": "SSLアクセス時のストアフロントURL", "8-1": "ストア説明文", "9-1": "訪問者を国ごとのストアにリダイレクトさせるかどうかのフラグ (IPによる定義)", "10-1": "グローバルエントリーページ (`redirect_customer `が `N`の場合)", "11-1": "ストアに割り当てられた国のリスト", "12-1": "会社名", "13-1": "会社所在地 住所", "14-1": "会社所在地 市町村", "15-1": "会社所在地 国名", "16-1": "会社所在地 都道府県・州", "17-1": "会社所在地 郵便番号", "18-1": "会社電話番号", "19-1": "会社電話番号 2", "20-1": "会社FAX番号", "21-1": "会社ウェブサイト", "22-1": "会社設立年", "23-1": "顧客担当メールアドレス", "24-1": "サイト管理者メールアドレス", "25-1": "注文管理者メールアドレス", "26-1": "ヘルプ/サポート担当メールアドレス", "27-1": "メルマガの返信先メールアドレス", "28-1": "クローン元のストアID", "29-1": "複製の設定", "0-2": "—", "1-2": "—", "3-2": "—", "7-2": "—", "28-2": "—", "27-2": "‘’", "26-2": "‘’", "25-2": "‘’", "24-2": "‘’", "23-2": "‘’", "22-2": "‘’", "21-2": "‘’", "20-2": "‘’", "19-2": "‘’", "18-2": "‘’", "17-2": "‘’", "16-2": "‘’", "15-2": "‘’", "14-2": "‘’", "13-2": "‘’", "12-2": "‘’", "8-2": "‘’", "4-2": "デフォルトの言語コード", "2-2": "自動でセットされます", "5-2": "自動でセットされます", "6-2": "`A`", "9-2": "`Y`", "10-2": "index", "11-2": "[]", "29-2": "[]", "29-3": "ストア属性オブジェクトのキーと `Y `値\n利用可能な属性:\n \n- layouts \n- settings \n- profile_fields \n- pages \n- promotions \n- shippings \n- payments \n- product_filters \n- product_features \n- sitemap \n- static_data_clone \n- products \n- categories", "28-3": "正しいストアID", "27-3": "string", "26-3": "string", "25-3": "string", "24-3": "string", "23-3": "string", "22-3": "string", "21-3": "string", "20-3": "string", "19-3": "string", "18-3": "string", "17-3": "string", "16-3": "string", "15-3": "string", "14-3": "string", "13-3": "string", "12-3": "string", "11-3": "国コードの配列 (‘DZ’, ‘AS’, 等)", "10-3": "`all_pages` \n`none` \n`index`", "9-3": "`Y` \n`N`", "8-3": "string", "7-3": "正しいURL", "6-3": "`A` :有効 \n`D `:無効 \n`H`:非表示", "5-3": "正しいUNIX形式のタイムスタンプ", "4-3": "`en` \n`ja` \n等", "3-3": "正しメールアドレス", "2-3": "integer", "0-3": "string", "1-3": "正しいURL" }, "cols": 4, "rows": 30 } [/block]