{"id":"55227389b4a0de0d00de7e28","name":"CS-Cart開発者ドキュメント","subdomain":"csdev-docs","versions":[{"_id":"55227389b4a0de0d00de7e2b","releaseDate":"2015-04-06T11:52:41.506Z","is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"","version_clean":"1.0.0","version":"1.0"},{"_id":"5544d76ad8833c0d00582801","releaseDate":"2015-05-02T13:55:54.059Z","is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"4.0.0","version":"4.0"}],"current_version":{"version_clean":"4.0.0","version":"4.0"},"oauth":{"enabled":false},"api":{"name":"","url":"http://mp.cs-cart.jp/themes/api.php","contenttype":"json","auth":"basic","explorer":true,"proxyEnabled":true,"jwt":false,"authextra":[{"_id":"5523453ee2de0a3500f0a309","type":"ba_username","default":"yoshiura:::at:::frogman.co.jp","key":"username"},{"_id":"5523453ee2de0a3500f0a308","type":"ba_password","default":"jb942266","key":"password"},{"_id":"56455774da14e70d0027cd40","type":"header","default":"NOKht2B39QkZ952m038jG1G6UU93vRPC","key":"APIkey"}],"headers":[],"object_definitions":[]},"apiAlt":[],"plan_details":{"name":"Developer Hub","is_active":true,"cost":59,"versions":10000,"custom_domain":true,"custom_pages":true,"whitelabel":false,"errors":false,"password":true,"landing_page":true,"themebuilder":true,"stylesheet":true,"javascript":false,"html":true,"extra_html":false,"admins":true},"intercom":"","intercom_secure_emailonly":false,"flags":{"allow_hub2":false,"hub2":false,"migrationRun":false,"oauth":false,"swagger":false,"correctnewlines":false,"speedyRender":false,"allowXFrame":false,"jwt":false,"hideGoogleAnalytics":false,"stripe":false,"disableDiscuss":false,"ssl":false,"autoSslGeneration":true},"asset_base_url":""}

{"_id":"5544d76bd8833c0d0058281d","project":"55227389b4a0de0d00de7e28","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"},"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"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-04-09T02:25:12.100Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":8,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"URLs\"\n}\n[/block]\n- [http://example.com/api/](link)**shipments** —全ての配送を参照します。 `GET`と`POST`のみサポートします。\n- [http://example.com/api/](link)**shipments/:id** —特定の配送のみ参照します。 `GET`/`PUT`/`DELETE`がサポートされます。\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"フィールド\"\n}\n[/block]\n配送方法には以下のプロパティがあります。\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\": \"carrier*\",\n    \"1-0\": \"order_id*\",\n    \"2-0\": \"products*\",\n    \"3-0\": \"shipping*\",\n    \"4-0\": \"shipping_id*\",\n    \"5-0\": \"user_id*\",\n    \"6-0\": \"tracking_number\",\n    \"7-0\": \"comments\",\n    \"8-0\": \"group_key\",\n    \"9-0\": \"order_timestamp\",\n    \"0-1\": \"配送業者名\",\n    \"1-1\": \"注文ID\",\n    \"2-1\": \"出荷された商品\",\n    \"3-1\": \"配送方法名\",\n    \"4-1\": \"敗走方法ID\",\n    \"5-1\": \"お客様のユーザーID\",\n    \"6-1\": \"追跡番号\",\n    \"7-1\": \"コメント\",\n    \"8-1\": \"サプライヤーグループキー\",\n    \"9-1\": \"注文作成日時のタイムスタンプ\",\n    \"0-2\": \"‘’\",\n    \"1-2\": \"—\",\n    \"2-2\": \"—\",\n    \"5-2\": \"—\",\n    \"3-2\": \"例）カスタム配送方法\",\n    \"4-2\": \"1\",\n    \"6-2\": \"‘’\",\n    \"7-2\": \"‘’\",\n    \"8-2\": \"自動でセットされます\",\n    \"9-2\": \"自動でセットされます\",\n    \"0-3\": \"有効な配送業者名\",\n    \"1-3\": \"有効な注文ID\",\n    \"2-3\": \"JSON object with cart item ID as key and its quantity as value  \\n\\nカートの商品IDをキーとし、数量をバリューとしたJSONオブジェクト\",\n    \"3-3\": \"有効な配送方法名\",\n    \"4-3\": \"有効な配送方法ID\",\n    \"5-3\": \"有効なお客様ID\",\n    \"6-3\": \"string\",\n    \"7-3\": \"string\",\n    \"8-3\": \"有効なサプライヤーグループキー\",\n    \"9-3\": \"UNIXフォーマットの有効な日時\"\n  },\n  \"cols\": 4,\n  \"rows\": 10\n}\n[/block]","excerpt":"","slug":"shipments","type":"basic","title":"Shipments"}

Shipments

[block:api-header] { "type": "basic", "title": "URLs" } [/block] - [http://example.com/api/](link)**shipments** —全ての配送を参照します。 `GET`と`POST`のみサポートします。 - [http://example.com/api/](link)**shipments/:id** —特定の配送のみ参照します。 `GET`/`PUT`/`DELETE`がサポートされます。 [block:api-header] { "type": "basic", "title": "フィールド" } [/block] 配送方法には以下のプロパティがあります。サポートされたフィールドのリストは以下で全部です(必須フィールドには＊がついています)。 [block:callout] { "type": "info", "body": "JSONデータAPIリクエストが発生した場合、以下の表に記載されていないフィールドは無視されます。" } [/block] [block:parameters] { "data": { "h-0": "フィールド", "h-1": "説明", "h-2": "デフォルト値", "h-3": "サポートされる値", "0-0": "carrier*", "1-0": "order_id*", "2-0": "products*", "3-0": "shipping*", "4-0": "shipping_id*", "5-0": "user_id*", "6-0": "tracking_number", "7-0": "comments", "8-0": "group_key", "9-0": "order_timestamp", "0-1": "配送業者名", "1-1": "注文ID", "2-1": "出荷された商品", "3-1": "配送方法名", "4-1": "敗走方法ID", "5-1": "お客様のユーザーID", "6-1": "追跡番号", "7-1": "コメント", "8-1": "サプライヤーグループキー", "9-1": "注文作成日時のタイムスタンプ", "0-2": "‘’", "1-2": "—", "2-2": "—", "5-2": "—", "3-2": "例）カスタム配送方法", "4-2": "1", "6-2": "‘’", "7-2": "‘’", "8-2": "自動でセットされます", "9-2": "自動でセットされます", "0-3": "有効な配送業者名", "1-3": "有効な注文ID", "2-3": "JSON object with cart item ID as key and its quantity as value \n\nカートの商品IDをキーとし、数量をバリューとしたJSONオブジェクト", "3-3": "有効な配送方法名", "4-3": "有効な配送方法ID", "5-3": "有効なお客様ID", "6-3": "string", "7-3": "string", "8-3": "有効なサプライヤーグループキー", "9-3": "UNIXフォーマットの有効な日時" }, "cols": 4, "rows": 10 } [/block]