{"docs":{"name":"Comestri Channel Manager API","info":"\u003cdl class=\"rdoc-list label-list\"\u003e\u003cdt\u003eAPI Account Based Authentication\n\u003cdd\u003e\n\u003cp\u003eCreate the API Account from \u003ca href=\"https://admin.comestri.com/cognito_api_accounts\"\u003eManage Api Accounts\u003c/a\u003e. Save the Client ID and Client Secret, and follow the instructions which will be shown after API Account is created to access the API.\u003c/p\u003e\n\u003c/dd\u003e\u003cdt\u003eStatic Token Based Authentication\u003ccode\u003eDEPRECATED\u003c/code\u003e\n\u003cdd\u003e\n\u003cp\u003eUse “Token token=%Your_API_Token%,email=%name@domain.com%” in the Http Header Authorization.\u003c/p\u003e\n\u003c/dd\u003e\u003c/dl\u003e\n\n\u003cp\u003eAll API related enquiries should be sent to support@comestri.com.\u003c/p\u003e\n","copyright":"\u0026copy; 2020 Comestri","doc_url":"/apidoc/1.0","api_url":"/api","resources":{"channel_items":{"doc_url":"/apidoc/1.0/channel_items","id":"channel_items","api_url":"/api","name":"Channel items","short_description":"Authentication for API channel: Use “Token token=%Your_endpoint_Token%,tenant=%tenant_name%,api_channel=true” in the Http Header Authorization.","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/1.0/channel_items/index","name":"index","apis":[{"api_url":"/api/channels/:channel_id/channel_items","http_method":"GET","short_description":"List channel items","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.","metadata":null},{"code":403,"description":"Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means \"unauthorized\", i.e. the user does not have the necessary permissions for the resource.","metadata":null},{"code":404,"description":"Not Found. The requested resource could not be found.","metadata":null},{"code":422,"description":"Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.","metadata":null},{"code":500,"description":"Internal Server Error. An unexpected condition was encountered.","metadata":null}],"params":[{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of objects in one response. Default is 50\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number. Default is 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_time_from","full_name":"created_time_from","description":"\n\u003cp\u003eISO_8601 format 2016-05-30T05:13:26Z\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_time_to","full_name":"created_time_to","description":"\n\u003cp\u003eISO_8601 format 2016-05-30T05:13:26Z\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_time_from","full_name":"updated_time_from","description":"\n\u003cp\u003eISO_8601 format 2016-05-30T05:13:26Z\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_time_to","full_name":"updated_time_to","description":"\n\u003cp\u003eISO_8601 format 2016-05-30T05:13:26Z\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n\u003cp\u003eChannel Item status\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eactive\u003c/code\u003e, \u003ccode\u003einactive\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"item_type","full_name":"item_type","description":"\n\u003cp\u003eChannel Item type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eproduct\u003c/code\u003e, \u003ccode\u003eshipment\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"code","full_name":"code","description":"\n\u003cp\u003eChannel Item code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_id","full_name":"external_id","description":"\n\u003cp\u003eChannel Item external id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_code","full_name":"external_code","description":"\n\u003cp\u003eChannel Item external code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_status","full_name":"external_status","description":"\n\u003cp\u003eChannel Item external status\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enot_added\u003c/code\u003e, \u003ccode\u003eadded\u003c/code\u003e, \u003ccode\u003edisabled\u003c/code\u003e, \u003ccode\u003eended\u003c/code\u003e, \u003ccode\u003edeleted\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"export_status","full_name":"export_status","description":"\n\u003cp\u003eChannel Item export status\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enot_exported\u003c/code\u003e, \u003ccode\u003eexport_pending\u003c/code\u003e, \u003ccode\u003eexport_ready\u003c/code\u003e, \u003ccode\u003eexporting\u003c/code\u003e, \u003ccode\u003eexported\u003c/code\u003e, \u003ccode\u003eexported_with_warnings\u003c/code\u003e, \u003ccode\u003eexport_failed\u003c/code\u003e, \u003ccode\u003eschedule_pending\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"display_name","full_name":"display_name","description":"\n\u003cp\u003eChannel Item display name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["Response:\n  {\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 2,\n    \"entries\": [\n      {\n        \"id\": 1,\n        \"channel_id\": 1,\n        \"status\": \"active\",\n        \"external_status\": \"not_added\",\n        \"export_status\": \"not_exported\",\n        \"external_code\": \"test-shirt-01-red-xl\",\n        \"external_id\": null,\n        \"data\": {\n          \"product_id\": \"1\",\n          \"code\": \"test-shirt-01-red-xl\",\n          \"name\": \"Test Shirt 01 Red XL\",\n          \"description\": null\n        },\n        \"created_at\": \"2018-06-18T15:57:57.940+10:00\",\n        \"updated_at\": \"2018-06-18T15:57:57.940+10:00\",\n        \"item_type\": 0,\n        \"code\": \"10\",\n        \"extras\": {}\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"channels":{"doc_url":"/apidoc/1.0/channels","id":"channels","api_url":"/api","name":"Channels","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/1.0/channels/latest_feed","name":"latest_feed","apis":[{"api_url":"/api/channels/:id/latest_feed","http_method":"GET","short_description":"Get latest feed for channel","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.","metadata":null},{"code":403,"description":"Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means \"unauthorized\", i.e. the user does not have the necessary permissions for the resource.","metadata":null},{"code":404,"description":"Not Found. The requested resource could not be found.","metadata":null},{"code":422,"description":"Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.","metadata":null},{"code":500,"description":"Internal Server Error. An unexpected condition was encountered.","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/1.0/channels/status","name":"status","apis":[{"api_url":"/api/channels","http_method":"GET","short_description":"Get channels information.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.","metadata":null},{"code":403,"description":"Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means \"unauthorized\", i.e. the user does not have the necessary permissions for the resource.","metadata":null},{"code":404,"description":"Not Found. The requested resource could not be found.","metadata":null},{"code":422,"description":"Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.","metadata":null},{"code":500,"description":"Internal Server Error. An unexpected condition was encountered.","metadata":null}],"params":[{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of objects in one response. Default is 50\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number. Default is 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_time_from","full_name":"created_time_from","description":"\n\u003cp\u003eISO_8601 format 2016-05-30T05:13:26Z\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_time_to","full_name":"created_time_to","description":"\n\u003cp\u003eISO_8601 format 2016-05-30T05:13:26Z\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_time_from","full_name":"updated_time_from","description":"\n\u003cp\u003eISO_8601 format 2016-05-30T05:13:26Z\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_time_to","full_name":"updated_time_to","description":"\n\u003cp\u003eISO_8601 format 2016-05-30T05:13:26Z\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n\u003cp\u003eChannel status\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eactive\u003c/code\u003e, \u003ccode\u003einactive\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["Response:\n  {\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 2,\n    total_channels_count: 2,\n    \"entries\": [\n      {\n        \"id\": 1,\n        \"name\": \"Google Feed Channel Test\",\n        \"status\": \"active\",\n        \"created_at\": \"2021-01-01T15:57:57.940+10:00\",\n        \"updated_at\": \"2021-01-01T15:57:57.940+10:00\"\n      },\n      {\n        \"id\": 2,\n        \"name\": \"BigCommerce Channel Test\",\n        \"status\": \"active\",\n        \"created_at\": \"2021-01-01T15:57:57.940+10:00\",\n        \"updated_at\": \"2021-01-01T15:57:57.940+10:00\"\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"export_jobs":{"doc_url":"/apidoc/1.0/export_jobs","id":"export_jobs","api_url":"/api","name":"Export jobs","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/1.0/export_jobs/index","name":"index","apis":[{"api_url":"/api/channels/:channel_id/export_jobs","http_method":"GET","short_description":"List export jobs","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.","metadata":null},{"code":403,"description":"Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means \"unauthorized\", i.e. the user does not have the necessary permissions for the resource.","metadata":null},{"code":404,"description":"Not Found. The requested resource could not be found.","metadata":null},{"code":422,"description":"Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.","metadata":null},{"code":500,"description":"Internal Server Error. An unexpected condition was encountered.","metadata":null}],"params":[{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of objects in one response. Default is 50\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number. Default is 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_time_from","full_name":"created_time_from","description":"\n\u003cp\u003eISO_8601 format 2016-05-30T05:13:26Z\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_time_to","full_name":"created_time_to","description":"\n\u003cp\u003eISO_8601 format 2016-05-30T05:13:26Z\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_time_from","full_name":"updated_time_from","description":"\n\u003cp\u003eISO_8601 format 2016-05-30T05:13:26Z\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_time_to","full_name":"updated_time_to","description":"\n\u003cp\u003eISO_8601 format 2016-05-30T05:13:26Z\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n\u003cp\u003eJob status\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003epending\u003c/code\u003e, \u003ccode\u003eprocessing\u003c/code\u003e, \u003ccode\u003ecompleted\u003c/code\u003e, \u003ccode\u003efailed\u003c/code\u003e, \u003ccode\u003eaborted\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["Response:\n  {\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 2,\n    \"entries\": [\n      {\n        \"id\": 1,\n        \"status\": \"failed\",\n        \"created_at\": \"2016-04-27T16:12:52.158+10:00\",\n        \"updated_at\": \"2016-04-27T16:21:57.283+10:00\",\n        \"job_id\": 1,\n        \"channel_id\": 1,\n        \"total\": 1,\n        \"total_failed\": 1\n      },\n      {\n        \"id\": 2,\n        \"status\": \"completed\",\n        \"created_at\": \"2016-04-27T17:10:59.318+10:00\",\n        \"updated_at\": \"2016-04-27T17:20:04.708+10:00\",\n        \"job_id\": 1,\n        \"channel_id\": 1,\n        \"total\": 1,\n        \"total_failed\": 0\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"import_jobs":{"doc_url":"/apidoc/1.0/import_jobs","id":"import_jobs","api_url":"/api","name":"Import jobs","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/1.0/import_jobs/index","name":"index","apis":[{"api_url":"/api/channels/:channel_id/import_jobs","http_method":"GET","short_description":"List import jobs","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.","metadata":null},{"code":403,"description":"Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means \"unauthorized\", i.e. the user does not have the necessary permissions for the resource.","metadata":null},{"code":404,"description":"Not Found. The requested resource could not be found.","metadata":null},{"code":422,"description":"Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.","metadata":null},{"code":500,"description":"Internal Server Error. An unexpected condition was encountered.","metadata":null}],"params":[{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of objects in one response. Default is 50\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number. Default is 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_time_from","full_name":"created_time_from","description":"\n\u003cp\u003eISO_8601 format 2016-05-30T05:13:26Z\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_time_to","full_name":"created_time_to","description":"\n\u003cp\u003eISO_8601 format 2016-05-30T05:13:26Z\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_time_from","full_name":"updated_time_from","description":"\n\u003cp\u003eISO_8601 format 2016-05-30T05:13:26Z\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_time_to","full_name":"updated_time_to","description":"\n\u003cp\u003eISO_8601 format 2016-05-30T05:13:26Z\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n\u003cp\u003eJob status\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003epending\u003c/code\u003e, \u003ccode\u003eprocessing\u003c/code\u003e, \u003ccode\u003ecompleted\u003c/code\u003e, \u003ccode\u003efailed\u003c/code\u003e, \u003ccode\u003eaborted\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["Response:\n  {\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 2,\n    \"entries\": [\n      {\n        \"id\": 11,\n        \"channel_id\": 3,\n        \"status\": \"failed\",\n        \"created_at\": \"2016-05-31T15:07:12.917+10:00\",\n        \"updated_at\": \"2016-05-31T15:07:15.834+10:00\",\n        \"created_by\": \"custom_import\",\n        \"job_type\": \"item\",\n        \"from\": \"2015-12-02T00:00:00.000+11:00\",\n        \"to\": \"2015-12-04T00:00:00.000+11:00\"\n      },\n      {\n        \"id\": 24,\n        \"channel_id\": 3,\n        \"status\": \"failed\",\n        \"created_at\": \"2016-05-31T17:02:32.049+10:00\",\n        \"updated_at\": \"2016-05-31T17:02:35.181+10:00\",\n        \"created_by\": \"custom_import\",\n        \"job_type\": \"item\",\n        \"from\": \"2016-05-31T17:02:00.000+10:00\",\n        \"to\": \"2015-12-02T00:00:00.000+11:00\"\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"inventories":{"doc_url":"/apidoc/1.0/inventories","id":"inventories","api_url":"/api","name":"Inventories","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/1.0/inventories/click_and_check","name":"click_and_check","apis":[{"api_url":"/api/inventories/click_and_check","http_method":"POST","short_description":"Inventory checking for channels","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.","metadata":null},{"code":403,"description":"Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means \"unauthorized\", i.e. the user does not have the necessary permissions for the resource.","metadata":null},{"code":404,"description":"Not Found. The requested resource could not be found.","metadata":null},{"code":422,"description":"Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.","metadata":null},{"code":500,"description":"Internal Server Error. An unexpected condition was encountered.","metadata":null}],"params":[{"name":"channel_id","full_name":"channel_id","description":"\n\u003cp\u003eChannel ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"site_id","full_name":"site_id","description":"\n\u003cp\u003eChannel store external code. For Magento2 channel, this is the website store view ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"store_group_code","full_name":"store_group_code","description":"\n\u003cp\u003eStore Group Code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"skus","full_name":"skus","description":"\n\u003cp\u003eA list of SKUs. Maximum 50\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"inventory_source_names","full_name":"inventory_source_names","description":"\n\u003cp\u003eInventory source names. If neither of “inventory_source_names” or “inventory_source_ids” is provided, total quantity from all available inventory sources for “store_group_id” will be returned\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"inventory_source_ids","full_name":"inventory_source_ids","description":"\n\u003cp\u003eInventory source IDs. If neither of “inventory_source_names” or “inventory_source_ids” is provided, total quantity from all available inventory sources for “store_group_id” will be returned\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of Integer","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of objects in one response. Default is 50. Maximum is 100.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number. Default is 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["Example 1: Return first 50 inventories for all sites, store groups and inventory sources\nrequest:\n  {\n      \"channel_id\": 5,\n      \"skus\": [\"product_1\", \"product_2\"]\n  }\n\nresponse:\n  {\n    \"product_1\": [\n      {\n        \"site_id\": \"0\",\n        \"store_group_code\": \"molini\",\n        \"inventory_source_id\": 1,\n        \"inventory_source_name\": \"Store1\",\n        \"stock_status\": \"In Stock\"\n      }\n    ],\n    \"product_2\": [\n      {\n        \"site_id\": \"0\",\n        \"store_group_code\": \"concession\",\n        \"inventory_source_id\": 3,\n        \"inventory_source_name\": \"Store2\",\n        \"stock_status\": \"In Stock\"\n      },\n      {\n        \"site_id\": \"0\",\n        \"store_group_code\": \"molini\",\n        \"inventory_source_id\": 3,\n        \"inventory_source_name\": \"Store2\",\n        \"stock_status\": \"In Stock\"\n      },\n      {\n        \"site_id\": \"0\",\n        \"store_group_code\": \"molini\",\n        \"inventory_source_id\": 1,\n        \"inventory_source_name\": \"Store1\",\n        \"stock_status\": \"Low Stock\"\n      }\n    ]\n  }\n\nExample 2: Return 101 - 200 inventories for all sites, store groups and inventory sources\nrequest:\n  {\n      \"channel_id\": 5,\n      \"skus\": [\"product_1\", \"product_2\"],\n      \"page\": 2,\n      \"per_page\": 100\n  }\n\nresponse:\n  {\n    \"product_1\": [\n      {\n        \"site_id\": \"0\",\n        \"store_group_code\": \"molini\",\n        \"inventory_source_id\": 1,\n        \"inventory_source_name\": \"Store1\",\n        \"stock_status\": \"In Stock\"\n      }\n    ],\n    \"product_2\": [\n      {\n        \"site_id\": \"0\",\n        \"store_group_code\": \"concession\",\n        \"inventory_source_id\": 3,\n        \"inventory_source_name\": \"Store2\",\n        \"stock_status\": \"In Stock\"\n      },\n      {\n        \"site_id\": \"0\",\n        \"store_group_code\": \"molini\",\n        \"inventory_source_id\": 3,\n        \"inventory_source_name\": \"Store2\",\n        \"stock_status\": \"In Stock\"\n      },\n      {\n        \"site_id\": \"0\",\n        \"store_group_code\": \"molini\",\n        \"inventory_source_id\": 1,\n        \"inventory_source_name\": \"Store1\",\n        \"stock_status\": \"Low Stock\"\n      }\n    ]\n  }\n\nExample 3: Return all inventories for one site\nrequest:\n  {\n      \"channel_id\": 5,\n      \"site_id\": \"0\",\n      \"skus\": [\"product_1\", \"product_2\"]\n  }\n\nresponse: (As above)\n\nExample 4: Return all inventories for one store group with buffered inventory\nrequest:\n  {\n      \"channel_id\": 5,\n      \"store_group_code\": \"concession\",\n      \"skus\": [\"product_1\", \"product_2\"]\n  }\n\nresponse:\n  {\n    \"product_1\": [],\n    \"product_2\": [\n      {\n        \"site_id\": \"0\",\n        \"store_group_code\": \"concession\",\n        \"inventory_source_id\": 3,\n        \"inventory_source_name\": \"Store2\",\n        \"qty\": 11\n      }\n    ]\n  }\n\nExample 5: Return inventories for specified inventory sources in one store group with actual inventory\nrequest:\n  {\n      \"channel_id\": 5,\n      \"store_group_code\": \"molini\",\n      \"inventory_source_ids\": [1]\n      \"skus\": [\"product_1\"]\n  }\n\nresponse:\n  {\n    \"product_1\": [\n      {\n        \"site_id\": \"0\",\n        \"store_group_code\": \"molini\",\n        \"inventory_source_id\": 1,\n        \"inventory_source_name\": \"Store1\",\n        \"qty\": 13\n      }\n    ]\n  }\n\nSample error message:\n  {\n    \"errors\": [\n      \"Missing parameter skus\"\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"lookups":{"doc_url":"/apidoc/1.0/lookups","id":"lookups","api_url":"/api","name":"Lookups","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/1.0/lookups/create","name":"create","apis":[{"api_url":"/api/channels/:channel_id/lookups","http_method":"POST","short_description":"Create or update a lookup table. If the lookup name already exists, the content will be updated.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.","metadata":null},{"code":403,"description":"Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means \"unauthorized\", i.e. the user does not have the necessary permissions for the resource.","metadata":null},{"code":404,"description":"Not Found. The requested resource could not be found.","metadata":null},{"code":422,"description":"Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.","metadata":null},{"code":500,"description":"Internal Server Error. An unexpected condition was encountered.","metadata":null}],"params":[],"returns":[],"examples":["request:\n  {\n      \"lookup\": {\n          \"name\": \"Colors\",\n          \"columns\": [\"Color\",\"Color Family\"],\n          \"rows\": [\n            {\"values\": [\"Red\", \"red\"]},\n            {\"values\": [\"Blue\", \"blue\"]}\n          ]\n      }\n  }\n\nresponse:\n  {\n    \"id\": 1,\n    \"name\": \"Colors\",\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/1.0/lookups/destroy","name":"destroy","apis":[{"api_url":"/api/channels/:channel_id/lookups/:id","http_method":"DELETE","short_description":"Delete a lookup table","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.","metadata":null},{"code":403,"description":"Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means \"unauthorized\", i.e. the user does not have the necessary permissions for the resource.","metadata":null},{"code":404,"description":"Not Found. The requested resource could not be found.","metadata":null},{"code":422,"description":"Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.","metadata":null},{"code":500,"description":"Internal Server Error. An unexpected condition was encountered.","metadata":null}],"params":[],"returns":[],"examples":["response:\n  {\n    \"id\": 1\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"orders":{"doc_url":"/apidoc/1.0/orders","id":"orders","api_url":"/api","name":"Orders","short_description":"Authentication for API channel: Use “Token token=%Your_endpoint_Token%,tenant=%tenant_name%,api_channel=true” in the Http Header Authorization.","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/1.0/orders/create","name":"create","apis":[{"api_url":"/api/channels/:channel_id/orders","http_method":"POST","short_description":"Create or update an order","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.","metadata":null},{"code":403,"description":"Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means \"unauthorized\", i.e. the user does not have the necessary permissions for the resource.","metadata":null},{"code":404,"description":"Not Found. The requested resource could not be found.","metadata":null},{"code":422,"description":"Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.","metadata":null},{"code":500,"description":"Internal Server Error. An unexpected condition was encountered.","metadata":null}],"params":[],"returns":[],"examples":["request:\n{\n  \"order\": {\n    \"source_primary_order_id\": \"121674964406-1653783255002\",\n    \"source_secondary_order_id\": \"480\",\n    \"status\": \"initial\",\n    \"external_status\": \"Completed\",\n    \"amount_paid\": 1.0,\n    \"currency_code\": \"AUD\",\n    \"external_created_at\": \"2016-07-01T04:05:39.000Z\",\n    \"external_updated_at\": null,\n    \"subtotal_price_ex_tax\": 1.0,\n    \"total_price_inc_tax\": 1.0,\n    \"external_payment_method\": \"PayPal\",\n    \"external_payment_status\": \"NoPaymentFailure\",\n    \"buyer\": {\n      \"personal_info\": {\n        \"external_id\": \"iahon_2\",\n        \"first_name\": \"Ian\",\n        \"last_name\": \"Hong\",\n        \"email\": \"ian.hong@fusionfactory.com\"\n      }\n    },\n    \"site\": \"Australia\",\n    \"order_lines\": [\n      {\n        \"order_line\": {\n          \"external_order_line_item_id\": \"121674964406-1653783255002\",\n          \"external_item_id\": \"121674964406\",\n          \"external_sku\": \"i::ming_static_inv_test_2\",\n          \"item_name\": \"Ming static inv test 2\",\n          \"product_code\": null,\n          \"parent_product_code\": null,\n          \"external_item_condition\": \"New with tags\",\n          \"external_transaction_id\": \"1653783255002\",\n          \"quantity\": 1,\n          \"base_price\": 1.0,\n          \"currency_code\": \"AUD\",\n          \"total_price_ex_tax\": 1.0,\n          \"total_price_inc_tax\": 1.0,\n          \"sequence_no\": 1.0\n        },\n        \"taxes\": [\n          {\n            \"external_tax_class\": \"SalesTax\",\n            \"tax_on\": \"total\",\n            \"amount\": \"0.0\",\n            \"currency_code\": \"AUD\",\n            \"description\": \"SalesTax\"\n          },\n          {\n            \"external_tax_class\": \"SalesTax\",\n            \"tax_on\": \"subtotal\",\n            \"amount\": \"0.0\",\n            \"currency_code\": \"AUD\",\n            \"description\": \"SalesTax\"\n          },\n          {\n            \"external_tax_class\": \"SalesTax\",\n            \"tax_on\": \"shipping\",\n            \"amount\": \"0.0\",\n            \"currency_code\": \"AUD\",\n            \"description\": \"SalesTax\"\n          },\n          {\n            \"external_tax_class\": \"SalesTax\",\n            \"tax_on\": \"handling\",\n            \"amount\": \"0.0\",\n            \"currency_code\": \"AUD\",\n            \"description\": \"SalesTax\"\n          },\n          {\n            \"external_tax_class\": \"WasteRecyclingFee\",\n            \"tax_on\": \"total\",\n            \"amount\": \"0.0\",\n            \"currency_code\": \"AUD\",\n            \"description\": \"ElectronicWasteRecyclingFee\"\n          }\n        ]\n      }\n    ],\n    \"shipping_address\": {\n      \"first_name\": \"Ian\",\n      \"last_name\": \"Hong\",\n      \"street_line_1\": \"1 Rawson St\",\n      \"street_line_2\": null,\n      \"city\": \"Epping\",\n      \"state_or_region\": \"New South Wales\",\n      \"country_code\": \"AU\",\n      \"country\": \"Australia\",\n      \"phone\": \"02 34875689\",\n      \"post_code\": \"2121\"\n    },\n    \"payments\": [\n      {\n        \"external_payment_method\": \"PayPal\",\n        \"amount_paid\": 1.0,\n        \"currency_code\": \"AUD\",\n        \"payment_time\": \"2016-07-01T04:05:36.000Z\",\n        \"reference_number\": \"88R38387SV200680D\",\n        \"reference_type\": \"ExternalTransactionID\",\n        \"payer\": \"iahon_2\",\n        \"payee\": \"121onlineptyltd\",\n        \"fee_or_credit\": \"0.33\"\n      }\n    ],\n    \"shipping_service\": {\n      \"external_shipping_method_code\": \"AU_Regular\",\n      \"price_inc_tax\": \"0.0\",\n      \"currency_code\": \"AUD\"\n    }\n  }\n    \n}\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}}}}