{"docs":{"name":"Comestri Product Manager API","info":"\n\u003cp\u003eWe support both RESTful endpoints and bulk jobs. We strongly recommend to use the jobs endpoint for large data sets.\u003c/p\u003e\n\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/2.0","api_url":"/api","resources":{"alias_products":{"doc_url":"/apidoc/2.0/alias_products","id":"alias_products","api_url":"/api","name":"Alias products","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003e{\n  \u0026quot;en\u0026quot;: {\n    \u0026quot;id\u0026quot;: 1,\n    \u0026quot;product_type\u0026quot;: \u0026quot;product\u0026quot;,\n    \u0026quot;code\u0026quot;: \u0026quot;12345\u0026quot;,\n    \u0026quot;status\u0026quot;: \u0026quot;active\u0026quot;,\n    \u0026quot;product_attributes\u0026quot;: {\n      \u0026quot;description\u0026quot;: {\n        \u0026quot;base_type\u0026quot;: \u0026quot;html\u0026quot;,\n        \u0026quot;value\u0026quot;: \u0026quot;\u0026lt;p style=\u0026quot;line-height: 18.5714px;\u0026quot;\u0026gt;This is a description.\u0026lt;/p\u0026gt;\u0026quot;\n      },\n      \u0026quot;short_description\u0026quot;: {\n        \u0026quot;base_type\u0026quot;: \u0026quot;html\u0026quot;,\n        \u0026quot;value\u0026quot;: \u0026quot;\u0026lt;span style=\u0026quot;line-height: 18.5714px;\u0026quot;\u0026gt;This is a short description.\u0026lt;/span\u0026gt;\u0026quot;\n      }\n    },\n    \u0026quot;name\u0026quot;: \u0026quot;Product 12345\u0026quot;,\n    \u0026quot;is_complete\u0026quot;: true,\n    \u0026quot;incomplete_fields\u0026quot;: {\n      \u0026quot;missing_image\u0026quot;: false,\n      \u0026quot;missing_category\u0026quot;: false,\n      \u0026quot;missing_price\u0026quot;: false,\n      \u0026quot;missing_attributes\u0026quot;: []\n    },\n    \u0026quot;discontinued\u0026quot;: false,\n    \u0026quot;catalogs\u0026quot;: [\n      {\n        \u0026quot;id\u0026quot;: 1,\n        \u0026quot;name\u0026quot;: \u0026quot;Catalog Name\u0026quot;\n      }\n    ]\n  },\n  \u0026quot;created_at\u0026quot;: \u0026quot;2016-04-15T14:25:38.489+10:00\u0026quot;,\n  \u0026quot;updated_at\u0026quot;: \u0026quot;2016-04-27T16:10:51.655+10:00\u0026quot;\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/alias_products/index","name":"index","apis":[{"api_url":"/api/v2/alias_products","http_method":"GET","short_description":"List alias products","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":"id","full_name":"id","description":"\n\u003cp\u003eProduct 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":"code","full_name":"code","description":"\n\u003cp\u003eProduct 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":"name","full_name":"name","description":"\n\u003cp\u003eProduct 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":[]},{"name":"status","full_name":"status","description":"\n\u003cp\u003eProduct 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":"response_product_fields","full_name":"response_product_fields","description":"\n\u003cp\u003eVersion 5 only. One of ‘name’, ‘status’, ‘class_type’. The product information to be included in the product data response. Use comma to join multiple fields.\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":"response_associated_fields","full_name":"response_associated_fields","description":"\n\u003cp\u003eVersion 5 only. One of ‘product_class’, ‘brand’, ‘attribute_values’, ‘dimension’, ‘packed_dimension’, ‘product_categories’, ‘catalogs’, ‘shipping_zones’, ‘price_items’, ‘inventories’, ‘media_items’, ‘entity_identifiers’. The information related to the product to be included in the product data response. Use comma to join multiple fields.\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":"root_products_only","full_name":"root_products_only","description":"\n\u003cp\u003eReturn products only at the root level. Defaults to true. Only applicable to CC V3 tenants\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["\nResponse: \n\n{\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 1,\n    \"entries\": [\n        {\n            \"id\": 1775,\n            \"product_type\": null,\n            \"code\": \"shirt-a\",\n            \"status\": \"active\",\n            \"product_attributes\": null,\n            \"name\": \"Shirt A\",\n            \"class_type\": \"sku\",\n            \"discontinued\": false,\n            \"product_class\": {\n                \"id\": 17,\n                \"name\": \"Style\"\n            },\n            \"attribute_values\": [\n                {\n                    \"attribute_definition_id\": 7,\n                    \"attribute_definition_code\": \"country_of_origin\",\n                    \"data\": \"Germany\"\n                },\n                {\n                    \"attribute_definition_id\": 2,\n                    \"attribute_definition_code\": \"short_description\",\n                    \"data\": \"test short description\"\n                },\n                {\n                    \"attribute_definition_id\": 14,\n                    \"attribute_definition_code\": \"season\",\n                    \"data\": \"Spring\"\n                },\n                {\n                    \"attribute_definition_id\": 1,\n                    \"attribute_definition_code\": \"description\",\n                    \"data\": \"test description\"\n                }\n            ]\n        }\n    ]\n}  \n\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/alias_products/create","name":"create","apis":[{"api_url":"/api/v2/alias_products","http_method":"POST","short_description":"Create or update an alias product","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":"alias_product","full_name":"alias_product","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"locale","full_name":"alias_product[locale]","description":"\n\u003cp\u003eLocale for this product. Should be one of the language codes defined on CommerceConnect. Defaults to the default language.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"alias_product[name]","description":"\n\u003cp\u003eProduct or sku name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"code","full_name":"alias_product[code]","description":"\n\u003cp\u003eUnique identifier for product and sku\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_class_name","full_name":"alias_product[product_class_name]","description":"\n\u003cp\u003eClass name that this product is assigned to. This must be created beforehand\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"alias_product[status]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einactive\u003c/code\u003e, \u003ccode\u003eactive\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_attributes","full_name":"alias_product[product_attributes]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"_any_attribute_code_","full_name":"alias_product[product_attributes][_any_attribute_code_]","description":"\n\u003cp\u003eThe key of attribute is attribute code and value is a valid json type that matches the base type of the attribute\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"catalogs","full_name":"alias_product[catalogs]","description":"\n\u003cp\u003eLink these catalogs with the product.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"alias_product[catalogs][id]","description":"\n\u003cp\u003eCatalog ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"alias_product[catalogs][name]","description":"\n\u003cp\u003eCatalog name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}],"returns":[],"examples":["request:\n  {\n    \"alias_product\": {\n      \"code\": \"product_1\",\n      \"name\": \"Product 1\",\n      \"master_product_code\": \"the parent product code of alias product\",\n      \"product_class_name\": \"product class name for alias product\",\n      \"status\": \"active\",\n      \"product_attributes\": {\n        \"description\": \"Product 1 description\"\n      }\n    }\n  }\n  \n  Sample: create an alias product in a one level attribute set with minimal data required\n  \n  {\n    \"alias_product\": {\n      \"code\": \"alias_product_code\",\n      \"name\": \"alias_product_name\",\n      \"master_product_code\": \"the parent product code of alias product\",\n      \"product_class_name\": \"product class name for alias product\",\n      \"product_attributes\": {\n        \"description\": \"content test here\",\n        \"gender\": \"Male\"\n      }\n    }\n  }\n  \n  Sample: update some fields of an existing alias product \n  \n  {\n    \"alias_product\": {\n      \"code\": \"alias_product_code-001\",\n      \"product_attributes\": {\n        \"description\": \"content test here\",\n        \"gender\": \"Male\"\n      }\n    }\n  }\n  \n  Single option, multi option values:\n  \n  {\n    \"alias_product\": {\n      \"code\": \"sku-12\"\n      \"product_attributes\": {\n        \"option1\": 2,\n        \"option2\": [ { \"code\": \"blue\" } ],\n        \"option3\": [4, 5],\n        \"option4\": [ { \"code\": \"A\" }, { \"code\": \"B\" } ]\n      }\n    }\n  }\n        \n\n  Response:\n  \n  \n  { \n    \"id\": 2712,\n    \"product_type\": null,\n    \"code\": \"csv-group-1\",\n    \"master_product_code\": \"the parent product code of alias product\",\n    \"status\": \"active\",\n    \"product_attributes\": null,\n    \"name\": \"csv-group-1\",\n    \"class_type\": \"sku\",\n    \"discontinued\": false,\n    \"attribute_values\": [\n        {\n            \"attribute_definition_id\": 25,\n            \"attribute_definition_code\": \"multi_option_attributes\",\n            \"data\": []\n        },\n        {\n            \"attribute_definition_id\": 2,\n            \"attribute_definition_code\": \"short_description\",\n            \"data\": \"\"\n        }\n      ]\n   }\n    \n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/alias_products/update","name":"update","apis":[{"api_url":"/api/v2/alias_products/:id","http_method":"PUT","short_description":"Update an alias product","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":"alias_product","full_name":"alias_product","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"locale","full_name":"alias_product[locale]","description":"\n\u003cp\u003eLocale for this product. Should be one of the language codes defined on CommerceConnect. Defaults to the default language.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"alias_product[name]","description":"\n\u003cp\u003eProduct or sku name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"code","full_name":"alias_product[code]","description":"\n\u003cp\u003eUnique identifier for product and sku\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_class_name","full_name":"alias_product[product_class_name]","description":"\n\u003cp\u003eClass name that this product is assigned to. This must be created beforehand\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"alias_product[status]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einactive\u003c/code\u003e, \u003ccode\u003eactive\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_attributes","full_name":"alias_product[product_attributes]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"_any_attribute_code_","full_name":"alias_product[product_attributes][_any_attribute_code_]","description":"\n\u003cp\u003eThe key of attribute is attribute code and value is a valid json type that matches the base type of the attribute\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"catalogs","full_name":"alias_product[catalogs]","description":"\n\u003cp\u003eLink these catalogs with the product.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"alias_product[catalogs][id]","description":"\n\u003cp\u003eCatalog ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"alias_product[catalogs][name]","description":"\n\u003cp\u003eCatalog name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}],"returns":[],"examples":["request:\n  Same as product create\n\nresponse: \n  Same as product create\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/alias_products/destroy","name":"destroy","apis":[{"api_url":"/api/v2/alias_product/:id","http_method":"DELETE","short_description":"Delete an alias product","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\": 8\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"association_attribute_values":{"doc_url":"/apidoc/2.0/association_attribute_values","id":"association_attribute_values","api_url":"/api","name":"Association attribute values","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003e{\n  \u0026quot;id\u0026quot;: 1,\n  \u0026quot;attribute_definition_id\u0026quot;: 20,\n  \u0026quot;entity_id\u0026quot;: 34,\n  \u0026quot;entity_type\u0026quot;: \u0026quot;Product\u0026quot;,\n  \u0026quot;associated_id\u0026quot;: 2,\n  \u0026quot;associated_type\u0026quot;: \u0026quot;NpcEntity\u0026quot;,\n  \u0026quot;attribute_definition_code\u0026quot;: \u0026quot;season_npc\u0026quot;,\n  \u0026quot;entity_code\u0026quot;: \u0026quot;Product_ABC\u0026quot;,\n  \u0026quot;associated_code\u0026quot;: \u0026quot;npc_entity_1\u0026quot;\u003c/pre\u003e\n\n\u003cp\u003e}\u003c/p\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/association_attribute_values/index","name":"index","apis":[{"api_url":"/api/v2/association_attribute_values","http_method":"GET","short_description":"List association attribute values","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":"entity_id","full_name":"entity_id","description":"\n\u003cp\u003eEntity 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":"entity_type","full_name":"entity_type","description":"\n\u003cp\u003eEntity Type\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":"associated_id","full_name":"associated_id","description":"\n\u003cp\u003eAssociated 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":"associated_type","full_name":"associated_type","description":"\n\u003cp\u003eAssociated Type\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":"attribute_definition_id","full_name":"attribute_definition_id","description":"\n\u003cp\u003eAttribute Definition 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":[]}],"returns":[],"examples":["Response:\n{\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 3,\n    \"entries\": [\n\n    ]\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/association_attribute_values/create","name":"create","apis":[{"api_url":"/api/v2/association_attribute_values","http_method":"POST","short_description":"Create a association attribute value","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":"association_attribute_value","full_name":"association_attribute_value","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"entity_id","full_name":"association_attribute_value[entity_id]","description":"\n\u003cp\u003eEntity ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"entity_type","full_name":"association_attribute_value[entity_type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eProduct\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"entity_code","full_name":"association_attribute_value[entity_code]","description":"\n\u003cp\u003eEntity code\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"associated_id","full_name":"association_attribute_value[associated_id]","description":"\n\u003cp\u003eAssociated ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"associated_type","full_name":"association_attribute_value[associated_type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNpcEntity\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"associated_code","full_name":"association_attribute_value[associated_code]","description":"\n\u003cp\u003eAssociated code\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribute_definition_id","full_name":"association_attribute_value[attribute_definition_id]","description":"\n\u003cp\u003eAttribute Definition ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attribute_definition_code","full_name":"association_attribute_value[attribute_definition_code]","description":"\n\u003cp\u003eAttribute Definition code\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n\n  {\n    \"association_attribute_value\": {\n      \"entity_code\": \"Product_ABC\",\n      \"entity_type\": \"Product\",\n      \"associated_id\": \"npc_entity_1\",\n      \"associated_type\": \"NpcEntity\",\n      \"attribute_definition_code\": \"season_npc\"\n    }\n  }\n\n  or\n\n  {\n    \"association_attribute_value\": {\n      \"entity_id\": \"34\",\n      \"entity_type\": \"Product\",\n      \"associated_id\": \"2\",\n      \"associated_type\": \"NpcEntity\",\n      \"attribute_definition_code\": \"20\"\n    }\n  }\n\nresponse:\n{\n  \"id\": 8,\n  \"attribute_definition_id\": 20,\n  \"entity_id\": 34,\n  \"entity_type\": \"Product\",\n  \"associated_id\": 2,\n  \"associated_type\": \"NpcEntity\",\n  \"created_at\": \"2019-09-06T14:25:09.236+10:00\",\n  \"updated_at\": \"2019-09-06T14:26:10.492+10:00\"\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/association_attribute_values/destroy","name":"destroy","apis":[{"api_url":"/api/v2/association_attribute_values/:id","http_method":"DELETE","short_description":"Delete an association attribute value","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\": 2\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"attribute_definitions":{"doc_url":"/apidoc/2.0/attribute_definitions","id":"attribute_definitions","api_url":"/api","name":"Attribute definitions","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;id\u0026quot;: 8,\n  \u0026quot;base_type\u0026quot;: \u0026quot;string\u0026quot;,\n  \u0026quot;name\u0026quot;: \u0026quot;Test\u0026quot;,\n  \u0026quot;select_options\u0026quot;: null,\n  \u0026quot;code\u0026quot;: \u0026quot;test\u0026quot;,\n  \u0026quot;product_levels\u0026quot;: []\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/attribute_definitions/index","name":"index","apis":[{"api_url":"/api/v2/attribute_definitions","http_method":"GET","short_description":"List attribute definitions","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":"lang","full_name":"lang","description":"\n\u003cp\u003eLanguage code for translated value\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        \"base_type\": \"html\",\n        \"name\": \"Description\",\n        \"select_options\": null,\n        \"code\": \"description\",\n        \"product_levels\": [\n          {\n            \"id\": 1\n          }\n        ]\n      },\n      {\n        \"id\": 2,\n        \"base_type\": \"html\",\n        \"name\": \"Short Description\",\n        \"select_options\": null,\n        \"code\": \"short_description\",\n        \"product_levels\": [\n          {\n            \"id\": 1\n          }\n        ]\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/attribute_definitions/create","name":"create","apis":[{"api_url":"/api/v2/attribute_definitions","http_method":"POST","short_description":"Create an attribute definition","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":"attribute_definition","full_name":"attribute_definition","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"attribute_definition[name]","description":"\n\u003cp\u003eName of the attribute\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"code","full_name":"attribute_definition[code]","description":"\n\u003cp\u003eUnique identifier for the attribute\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"base_type","full_name":"attribute_definition[base_type]","description":"\n\u003cp\u003eData type of the attribute\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003etext\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003enumber\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e, \u003ccode\u003emap\u003c/code\u003e, \u003ccode\u003esingle_select\u003c/code\u003e, \u003ccode\u003emulti_select\u003c/code\u003e, \u003ccode\u003eurl\u003c/code\u003e, \u003ccode\u003edatetime\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003esingle_option\u003c/code\u003e, \u003ccode\u003emulti_option\u003c/code\u003e, \u003ccode\u003esingle_npc_association\u003c/code\u003e, \u003ccode\u003emulti_npc_association\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"attribute_definition[description]","description":"\n\u003cp\u003eDescription of the attribute\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"min_length","full_name":"attribute_definition[min_length]","description":"\n\u003cp\u003eMinimum length\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"max_length","full_name":"attribute_definition[max_length]","description":"\n\u003cp\u003eMaximum length\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"mandatory","full_name":"attribute_definition[mandatory]","description":"\n\u003cp\u003eIf this field is true, the product must have non-blank value for this attribute\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"completeness","full_name":"attribute_definition[completeness]","description":"\n\u003cp\u003eIf this field is true, the product use the attribute for completeness check\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pattern","full_name":"attribute_definition[pattern]","description":"\n\u003cp\u003eRuby regular expression syntaxed string to enforce the format of the value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"datetime_from","full_name":"attribute_definition[datetime_from]","description":"\n\u003cp\u003eDate range lower bound restriction for datetime attribute\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"datetime_to","full_name":"attribute_definition[datetime_to]","description":"\n\u003cp\u003eDate range upper bound restriction for datetime attribute\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"select_options","full_name":"attribute_definition[select_options]","description":"\n\u003cp\u003eSelect options for ‘single_select’ and ‘multi_select’. Must be provided if ‘base_type’ is ‘single_select’ or ‘multi_select’\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"product_level_ids","full_name":"attribute_definition[product_level_ids]","description":"\n\u003cp\u003eList of product level IDs that the attribute belongs to. Do not provide if ‘product_levels’ is provided\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of Integer","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"product_levels","full_name":"attribute_definition[product_levels]","description":"\n\u003cp\u003eList of product levels that the attribute belongs to. Do not provide if ‘product_level_ids’ is provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"attribute_definition[product_levels][name]","description":"\n\u003cp\u003eName of the product level\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribute_set_name","full_name":"attribute_definition[product_levels][attribute_set_name]","description":"\n\u003cp\u003eName of the attribute set that the product level belongs to\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"option_values","full_name":"attribute_definition[option_values]","description":"\n\u003cp\u003eList of option values that apply to this attribute definition.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"attribute_definition[option_values][name]","description":"\n\u003cp\u003eOption value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"code","full_name":"attribute_definition[option_values][code]","description":"\n\u003cp\u003eOption value code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"position","full_name":"attribute_definition[option_values][position]","description":"\n\u003cp\u003ePosition of the option value. Warning: Drag and drop sorting from UI might change the position you have set.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"npc_product_class_ids","full_name":"attribute_definition[npc_product_class_ids]","description":"\n\u003cp\u003eList of NPC product class IDs that allowed. Only applied for base type single_npc_association and multi_npc_association.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of Integer","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"npc_product_class_names","full_name":"attribute_definition[npc_product_class_names]","description":"\n\u003cp\u003eList of NPC product class Names that allowed. Only applied for base type single_npc_association and multi_npc_association.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"npc_product_class_mode","full_name":"attribute_definition[npc_product_class_mode]","description":"\n\u003cp\u003eUpdate mode for NPC product class. Default is reset.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eadd\u003c/code\u003e, \u003ccode\u003ereset\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"data_quality_calculation","full_name":"attribute_definition[data_quality_calculation]","description":"\n\u003cp\u003eIf this field is true, the product use the attribute for the data quality calculation.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n    \"attribute_definition\": {\n        \"name\": \"Test\",\n        \"code\": \"test\",\n        \"base_type\": \"string\"\n    }\n  }\n\nresponse:\n  {\n    \"id\": 8,\n    \"base_type\": \"string\",\n    \"name\": \"Test\",\n    \"select_options\": null,\n    \"code\": \"test\",\n    \"product_levels\": []\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/attribute_definitions/update","name":"update","apis":[{"api_url":"/api/v2/attribute_definitions/:id","http_method":"PUT","short_description":"Update an attribute definition","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":"attribute_definition","full_name":"attribute_definition","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"attribute_definition[name]","description":"\n\u003cp\u003eName of the attribute\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":"code","full_name":"attribute_definition[code]","description":"\n\u003cp\u003eUnique identifier for the attribute\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":"base_type","full_name":"attribute_definition[base_type]","description":"\n\u003cp\u003eData type of the attribute\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003etext\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003enumber\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e, \u003ccode\u003emap\u003c/code\u003e, \u003ccode\u003esingle_select\u003c/code\u003e, \u003ccode\u003emulti_select\u003c/code\u003e, \u003ccode\u003eurl\u003c/code\u003e, \u003ccode\u003edatetime\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003esingle_option\u003c/code\u003e, \u003ccode\u003emulti_option\u003c/code\u003e, \u003ccode\u003esingle_npc_association\u003c/code\u003e, \u003ccode\u003emulti_npc_association\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"attribute_definition[description]","description":"\n\u003cp\u003eDescription of the attribute\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"min_length","full_name":"attribute_definition[min_length]","description":"\n\u003cp\u003eMinimum length\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"max_length","full_name":"attribute_definition[max_length]","description":"\n\u003cp\u003eMaximum length\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"mandatory","full_name":"attribute_definition[mandatory]","description":"\n\u003cp\u003eIf this field is true, the product must have non-blank value for this attribute\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"completeness","full_name":"attribute_definition[completeness]","description":"\n\u003cp\u003eIf this field is true, the product use the attribute for completeness check\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pattern","full_name":"attribute_definition[pattern]","description":"\n\u003cp\u003eRuby regular expression syntaxed string to enforce the format of the value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"datetime_from","full_name":"attribute_definition[datetime_from]","description":"\n\u003cp\u003eDate range lower bound restriction for datetime attribute\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"datetime_to","full_name":"attribute_definition[datetime_to]","description":"\n\u003cp\u003eDate range upper bound restriction for datetime attribute\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"select_options","full_name":"attribute_definition[select_options]","description":"\n\u003cp\u003eSelect options for ‘single_select’ and ‘multi_select’. Must be provided if ‘base_type’ is ‘single_select’ or ‘multi_select’\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"product_level_ids","full_name":"attribute_definition[product_level_ids]","description":"\n\u003cp\u003eList of product level IDs that the attribute belongs to. Do not provide if ‘product_levels’ is provided\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of Integer","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"product_levels","full_name":"attribute_definition[product_levels]","description":"\n\u003cp\u003eList of product levels that the attribute belongs to. Do not provide if ‘product_level_ids’ is provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"attribute_definition[product_levels][name]","description":"\n\u003cp\u003eName of the product level\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribute_set_name","full_name":"attribute_definition[product_levels][attribute_set_name]","description":"\n\u003cp\u003eName of the attribute set that the product level belongs to\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"option_values","full_name":"attribute_definition[option_values]","description":"\n\u003cp\u003eList of option values that apply to this attribute definition.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"attribute_definition[option_values][name]","description":"\n\u003cp\u003eOption value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"code","full_name":"attribute_definition[option_values][code]","description":"\n\u003cp\u003eOption value code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"position","full_name":"attribute_definition[option_values][position]","description":"\n\u003cp\u003ePosition of the option value. Warning: Drag and drop sorting from UI might change the position you have set.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"npc_product_class_ids","full_name":"attribute_definition[npc_product_class_ids]","description":"\n\u003cp\u003eList of NPC product class IDs that allowed. Only applied for base type single_npc_association and multi_npc_association.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of Integer","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"npc_product_class_names","full_name":"attribute_definition[npc_product_class_names]","description":"\n\u003cp\u003eList of NPC product class Names that allowed. Only applied for base type single_npc_association and multi_npc_association.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"npc_product_class_mode","full_name":"attribute_definition[npc_product_class_mode]","description":"\n\u003cp\u003eUpdate mode for NPC product class. Default is reset.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eadd\u003c/code\u003e, \u003ccode\u003ereset\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"data_quality_calculation","full_name":"attribute_definition[data_quality_calculation]","description":"\n\u003cp\u003eIf this field is true, the product use the attribute for the data quality calculation.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n    \"attribute_definition\": {\n        \"name\": \"Test updated\",\n        \"code\": \"test\",\n        \"base_type\": \"string\"\n    }\n  }\n\nresponse:\n  {\n    \"id\": 8,\n    \"base_type\": \"string\",\n    \"name\": \"Test updated\",\n    \"select_options\": null,\n    \"code\": \"test\",\n    \"product_levels\": []\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/attribute_definitions/destroy","name":"destroy","apis":[{"api_url":"/api/v2/attribute_definitions/:id","http_method":"DELETE","short_description":"Delete an attribute definition","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\": 8\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"attribute_group_assignments":{"doc_url":"/apidoc/2.0/attribute_group_assignments","id":"attribute_group_assignments","api_url":"/api","name":"Attribute group assignments","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003e{\n    \u0026quot;id\u0026quot;: 1,\n    \u0026quot;attribute_group_id\u0026quot;: 1,\n    \u0026quot;assignment_target\u0026quot;: \u0026quot;self\u0026quot;,\n    \u0026quot;assignment_type\u0026quot;: \u0026quot;global\u0026quot;,\n    \u0026quot;assignment_global_type\u0026quot;: \u0026quot;MediaItem\u0026quot;,\n    \u0026quot;attribute_group_code\u0026quot;: \u0026quot;media_item_ag1\u0026quot;\u003c/pre\u003e\n\n\u003cp\u003e}\u003c/p\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/attribute_group_assignments/index","name":"index","apis":[{"api_url":"/api/v2/attribute_group_assignments","http_method":"GET","short_description":"List attribute group assignments","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":"attribute_group_id","full_name":"attribute_group_id","description":"\n\u003cp\u003eAttribute Group 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":"assignment_type","full_name":"assignment_type","description":"\n\u003cp\u003eAssignment Type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eglobal\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"assignment_global_type","full_name":"assignment_global_type","description":"\n\u003cp\u003eAssignment Global Type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eMediaItem\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\": 3,\n    \"entries\": [\n      {\n        \"id\": 1,\n        \"attribute_group_id\": 1,\n        \"assignment_target\": \"self\",\n        \"assignment_type\": \"global\",\n        \"assignment_global_type\": \"MediaItem\",\n        \"attribute_group_code\": \"media_item_ag1\"\n      }\n\n    ]\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/attribute_group_assignments/create","name":"create","apis":[{"api_url":"/api/v2/attribute_group_assignments","http_method":"POST","short_description":"Create an attribute group assignment","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":"attribute_group_assignment","full_name":"attribute_group_assignment","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"attribute_group_id","full_name":"attribute_group_assignment[attribute_group_id]","description":"\n\u003cp\u003eAttribute Group ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"assigned_entity_id","full_name":"attribute_group_assignment[assigned_entity_id]","description":"\n\u003cp\u003eID of Entity to which the attribute group is being assigned. For example; the ID of CategorySet if the attribute group is being assigned to CategorySet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"assigned_entity_type","full_name":"attribute_group_assignment[assigned_entity_type]","description":"\n\u003cp\u003eType of entity to which the attribute group is being assigned\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eCategorySet\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"assignment_target","full_name":"attribute_group_assignment[assignment_target]","description":"\n\u003cp\u003eTarget entity to which the attribute group is being assigned. For example; if the assignment_target is self and provided entity is CategorySet, the attribute group will be assigned to CategorySet itself and if the assignment_target is children, the attribute group will be assigned to the categories under the provided category set\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eself\u003c/code\u003e, \u003ccode\u003echildren\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"assignment_type","full_name":"attribute_group_assignment[assignment_type]","description":"\n\u003cp\u003eIf global, the attribute group will be assigned across all the provided assignment_global_type. If specific, the attribute group will be assigned to specifc entities. For example; assign attribute group to all the categories under specific category set\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eglobal\u003c/code\u003e, \u003ccode\u003especific\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"assignment_global_type","full_name":"attribute_group_assignment[assignment_global_type]","description":"\n\u003cp\u003eType of Entity for assigning attribute group to when the assignment_type is global,\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eMediaItem\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n\n  {\n    \"attribute_group_assignment\": {\n        \"attribute_group_id\": 2,\n        \"assignment_target\": \"self\",\n        \"assignment_type\": \"global\",\n        \"assignment_global_type\": \"MediaItem\"\n    }\n  }\n\n  Sample: Assign attribute group to all categories under specified category set (category set with id 1 in this example)\n\n  {\n    \"attribute_group_assignment\": {\n        \"attribute_group_id\": 2,\n        \"assignment_target\": \"children\",\n        \"assignment_type\": \"specific\",\n        \"assigned_entity_id\": 1,\n        \"assigned_entity_type\": \"CategorySet\"\n    }\n  }\n\n\nresponse:\n{\n  \"id\": 1,\n  \"attribute_group_id\": 2,\n  \"assignment_target\": \"self\",\n  \"assignment_type\": \"global\",\n  \"assignment_global_type\": \"MediaItem\",\n  \"attribute_group_code\": \"media_item_ag1\"\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/attribute_group_assignments/destroy","name":"destroy","apis":[{"api_url":"/api/v2/attribute_group_assignments/:id","http_method":"DELETE","short_description":"Delete an attribute group assignment","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},"attribute_groups":{"doc_url":"/apidoc/2.0/attribute_groups","id":"attribute_groups","api_url":"/api","name":"Attribute groups","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n    \u0026quot;id\u0026quot;: 1,\n    \u0026quot;code\u0026quot;: \u0026quot;Attribute group 1\u0026quot;,\n    \u0026quot;name\u0026quot;: \u0026quot;Attribute group 1\u0026quot;\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/attribute_groups/index","name":"index","apis":[{"api_url":"/api/v2/attribute_groups","http_method":"GET","short_description":"List attribute groups","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":"id","full_name":"id","description":"\n\u003cp\u003eAttribute group 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":[]}],"returns":[],"examples":["Response:\n{\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 1,\n    \"entries\": [\n        {\n            \"id\": 2,\n            \"code\": \"grp1\",\n            \"name\": \"Grp1\",\n            \"attribute_group_attribute_definitions\": [\n                {\n                    \"id\": 25,\n                    \"attribute_group_id\": 11,\n                    \"attribute_definition_id\": 6,\n                    \"created_at\": \"2019-06-22T14:52:53.209+10:00\",\n                    \"updated_at\": \"2019-06-22T14:52:53.209+10:00\",\n                    \"sort_order\": 11,\n                    \"completeness\": false\n                },\n                {\n                    \"id\": 27,\n                    \"attribute_group_id\": 11,\n                    \"attribute_definition_id\": 10,\n                    \"created_at\": \"2019-06-22T14:54:42.488+10:00\",\n                    \"updated_at\": \"2019-06-22T14:54:42.488+10:00\",\n                    \"sort_order\": 33,\n                    \"completeness\": false\n                },\n                {\n                    \"id\": 28,\n                    \"attribute_group_id\": 11,\n                    \"attribute_definition_id\": 3,\n                    \"created_at\": \"2019-06-22T14:57:20.783+10:00\",\n                    \"updated_at\": \"2019-06-22T14:57:20.783+10:00\",\n                    \"sort_order\": 22,\n                    \"completeness\": true\n                }\n            ]\n        }\n    ]\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/attribute_groups/create","name":"create","apis":[{"api_url":"/api/v2/attribute_groups","http_method":"POST","short_description":"Create or update attribute group","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":"attribute_group","full_name":"attribute_group","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"code","full_name":"attribute_group[code]","description":"\n\u003cp\u003eCode of the attribute group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"attribute_group[name]","description":"\n\u003cp\u003eName of the attribute group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribute_definitions","full_name":"attribute_group[attribute_definitions]","description":"\n\u003cp\u003eLink to attribute definitions\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"attribute_definition_code","full_name":"attribute_group[attribute_definitions][attribute_definition_code]","description":"\n\u003cp\u003eAttribute definition code\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"attribute_group[attribute_definitions][sort_order]","description":"\n\u003cp\u003eSort order\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"completeness","full_name":"attribute_group[attribute_definitions][completeness]","description":"\n\u003cp\u003eUse it for completeness\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"attribute_definition_mode","full_name":"attribute_group[attribute_definition_mode]","description":"\n\u003cp\u003eUpdate mode for Attribute Definition. Default is add.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eadd\u003c/code\u003e, \u003ccode\u003ereset\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n    \"attribute_group\": {\n      \"code\": \"attr_grp_1\",\n      \"name\": \"Attribute group 1\",\n      \"attribute_definitions\": [\n        { \"attribute_definition_code\": \"attr_1\", \"sort_order\": 1, \"completeness\": false },\n        { \"attribute_definition_code\": \"attr_2\", \"sort_order\": 2, \"completeness\": true }\n      ]\n    }\n  }\n\nresponse:\n  {\n      \"id\": 11,\n      \"code\": \"attr_grp_1\",\n      \"created_at\": \"2019-06-22T14:52:53.083+10:00\",\n      \"updated_at\": \"2019-06-22T14:52:53.083+10:00\",\n      \"name\": \"Attribute group 1\"\n  }\n\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/attribute_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v2/attribute_groups/:id","http_method":"DELETE","short_description":"Delete an attribute group","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\": 2\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"attribute_sets":{"doc_url":"/apidoc/2.0/attribute_sets","id":"attribute_sets","api_url":"/api","name":"Attribute sets","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;id\u0026quot;: 1,\n  \u0026quot;name\u0026quot;: \u0026quot;Automotive\u0026quot;,\n  \u0026quot;product_level_count\u0026quot;: 1,\n  \u0026quot;product_levels\u0026quot;: [\n    {\n      \u0026quot;id\u0026quot;: 1,\n      \u0026quot;name\u0026quot;: \u0026quot;Products\u0026quot;\n    }\n  ]\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/attribute_sets/index","name":"index","apis":[{"api_url":"/api/v2/attribute_sets","http_method":"GET","short_description":"List attribute sets","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":[]}],"returns":[],"examples":["Response:\n  {\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 1,\n    \"entries\": [\n      {\n        \"id\": 1,\n        \"name\": \"Automotive\",\n        \"product_level_count\": 1,\n        \"product_levels\": [\n          {\n            \"id\": 1,\n            \"name\": \"Products\"\n          }\n        ]\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/attribute_sets/create","name":"create","apis":[{"api_url":"/api/v2/attribute_sets","http_method":"POST","short_description":"Create an attribute set","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":"attribute_set","full_name":"attribute_set","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"attribute_set[name]","description":"\n\u003cp\u003eName of the attribute set (unique)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_levels","full_name":"attribute_set[product_levels]","description":"\n\u003cp\u003eList of product levels that the attribute set has\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"attribute_set[product_levels][name]","description":"\n\u003cp\u003eName of the product level\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include_media","full_name":"attribute_set[product_levels][include_media]","description":"\n\u003cp\u003eAllow images to be included at this level\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include_price","full_name":"attribute_set[product_levels][include_price]","description":"\n\u003cp\u003eAllow prices to be included at this level\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include_category","full_name":"attribute_set[product_levels][include_category]","description":"\n\u003cp\u003eAllow categories to be included at this level\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include_inventory","full_name":"attribute_set[product_levels][include_inventory]","description":"\n\u003cp\u003eAllow inventories to be included at this level\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include_dimension","full_name":"attribute_set[product_levels][include_dimension]","description":"\n\u003cp\u003eAllow dimensions to be included at this level\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"product_level","full_name":"attribute_set[product_levels][product_level]","description":"\n\u003cp\u003eChild product level. It accepts the params of a product level\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"attribute_definition_ids","full_name":"attribute_set[product_levels][attribute_definition_ids]","description":"\n\u003cp\u003eList of attribute definition IDs that the product level has. Do not provide if ‘attribute_definitions’ is provided\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of Integer","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"attribute_definitions","full_name":"attribute_set[product_levels][attribute_definitions]","description":"\n\u003cp\u003eList of attribute definitions that the product level has. Do not provide if ‘attribute_definition_ids’ is provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"code","full_name":"attribute_set[product_levels][attribute_definitions][code]","description":"\n\u003cp\u003eCode of the attribute definition\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}]}],"returns":[],"examples":["request:\n  {\n    \"attribute_set\": {\n        \"name\": \"Apparel\",\n        \"product_levels\": [\n            {\n                \"name\": \"Style\",\n                \"product_level\": {\n                    \"name\": \"Color\"\n                }\n            }\n        ]\n    }\n  }\n\nresponse:\n  {\n    \"id\": 6,\n    \"name\": \"Apparel\",\n    \"product_level_count\": 2,\n    \"product_levels\": [\n      {\n        \"id\": 5,\n        \"name\": \"Style\"\n      },\n      {\n        \"id\": 6,\n        \"name\": \"Color\"\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/attribute_sets/update","name":"update","apis":[{"api_url":"/api/v2/attribute_sets/:id","http_method":"PUT","short_description":"Update an attribute set","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":"attribute_set","full_name":"attribute_set","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"attribute_set[name]","description":"\n\u003cp\u003eName of the attribute set (unique)\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":"product_levels","full_name":"attribute_set[product_levels]","description":"\n\u003cp\u003eList of product levels that the attribute set has\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"attribute_set[product_levels][name]","description":"\n\u003cp\u003eName of the product level\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":"include_media","full_name":"attribute_set[product_levels][include_media]","description":"\n\u003cp\u003eAllow images to be included at this level\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include_price","full_name":"attribute_set[product_levels][include_price]","description":"\n\u003cp\u003eAllow prices to be included at this level\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include_category","full_name":"attribute_set[product_levels][include_category]","description":"\n\u003cp\u003eAllow categories to be included at this level\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include_inventory","full_name":"attribute_set[product_levels][include_inventory]","description":"\n\u003cp\u003eAllow inventories to be included at this level\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include_dimension","full_name":"attribute_set[product_levels][include_dimension]","description":"\n\u003cp\u003eAllow dimensions to be included at this level\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"product_level","full_name":"attribute_set[product_levels][product_level]","description":"\n\u003cp\u003eChild product level. It accepts the params of a product level\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"attribute_definition_ids","full_name":"attribute_set[product_levels][attribute_definition_ids]","description":"\n\u003cp\u003eList of attribute definition IDs that the product level has. Do not provide if ‘attribute_definitions’ is provided\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of Integer","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"attribute_definitions","full_name":"attribute_set[product_levels][attribute_definitions]","description":"\n\u003cp\u003eList of attribute definitions that the product level has. Do not provide if ‘attribute_definition_ids’ is provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"code","full_name":"attribute_set[product_levels][attribute_definitions][code]","description":"\n\u003cp\u003eCode of the attribute definition\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}]}],"returns":[],"examples":["request:\n  {\n    \"attribute_set\": {\n        \"name\": \"Attribute Set Name Updated\"\n    }\n  }\n\nresponse:\n  {\n    \"id\": 2,\n    \"name\": \"Attribute Set Name Updated\",\n    \"product_level_count\": 0,\n    \"product_levels\": []\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/attribute_sets/destroy","name":"destroy","apis":[{"api_url":"/api/v2/attribute_sets/:id","http_method":"DELETE","short_description":"Delete an attribute set","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\": 2\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"attribute_values":{"doc_url":"/apidoc/2.0/attribute_values","id":"attribute_values","api_url":"/api","name":"Attribute values","short_description":null,"full_description":"\n\u003cp\u003eVersion 5 only.\u003c/p\u003e\n\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;id\u0026quot;: 2,\n  \u0026quot;code\u0026quot;: \u0026quot;product-one\u0026quot;,\n  \u0026quot;created_at\u0026quot;: \u0026quot;2019-07-22T14:06:08.285+10:00\u0026quot;,\n  \u0026quot;updated_at\u0026quot;: \u0026quot;2020-01-10T10:47:14.528+11:00\u0026quot;,\n  \u0026quot;entity_type\u0026quot;: \u0026quot;Product\u0026quot;,\n  \u0026quot;attributes\u0026quot;: [\n      {\n          \u0026quot;id\u0026quot;: 1,\n          \u0026quot;created_at\u0026quot;: \u0026quot;2019-07-22T14:06:08.982+10:00\u0026quot;,\n          \u0026quot;updated_at\u0026quot;: \u0026quot;2019-07-22T14:07:03.610+10:00\u0026quot;,\n          \u0026quot;attribute_definition_code\u0026quot;: \u0026quot;colour\u0026quot;,\n          \u0026quot;data\u0026quot;: \u0026quot;Red\u0026quot;\n      }\n  ]\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/attribute_values/changed_entities_by_attribute_values","name":"changed_entities_by_attribute_values","apis":[{"api_url":"/api/v2/attribute_values/changed_entities_by_attribute_values","http_method":"GET","short_description":"List changed entities and attribute values for given attribute definition codes","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":"entity_type","full_name":"entity_type","description":"\n\u003cp\u003eType of entity to query for attribute values changes\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eProduct\u003c/code\u003e, \u003ccode\u003eNpcEntity\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribute_definition_codes","full_name":"attribute_definition_codes","description":"\n\u003cp\u003eArray of attribute definition codes. Should be in the format: attribute_definition_codes[]=attr_def_1\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":"response_attribute_definition_codes","full_name":"response_attribute_definition_codes","description":"\n\u003cp\u003eArray of attribute definition codes to get in response. Should be in the format: response_attribute_definition_codes[]=attr_def_1\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":[]}],"returns":[],"examples":["Request Sample:\n  /api/v2/attribute_values/changed_entities_by_attribute_values?entity_type=Product\u0026attribute_definition_codes[]=attr_def_1\u0026attribute_definition_codes[]=attr_def_2\n\nResponse:\n  {\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 1,\n    \"entries\": [\n      {\n        \"id\": 25,\n        \"code\": \"product-one\",\n        \"created_at\": \"2019-10-03T10:26:47.873+10:00\",\n        \"updated_at\": \"2020-01-16T14:02:14.675+11:00\",\n        \"attributes\": [\n            {\n              \"id\": 161,\n              \"created_at\": \"2019-10-03T10:26:48.991+10:00\",\n              \"updated_at\": \"2020-01-16T13:59:59.564+11:00\",\n              \"attribute_definition_code\": \"description\",\n              \"data\": \"Vibrant colour\"\n            }\n        ]\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"brands":{"doc_url":"/apidoc/2.0/brands","id":"brands","api_url":"/api","name":"Brands","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;id\u0026quot;: 1,\n  \u0026quot;name\u0026quot;: \u0026quot;Brand Name\u0026quot;,\n  \u0026quot;description\u0026quot;: null,\n  \u0026quot;logo_link\u0026quot;: \u0026quot;\u0026quot;\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/brands/index","name":"index","apis":[{"api_url":"/api/v2/brands","http_method":"GET","short_description":"List brands","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":"lang","full_name":"lang","description":"\n\u003cp\u003eLanguage code for translated value\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\": 1,\n    \"entries\": [\n      {\n        \"id\": 1,\n        \"name\": \"Brand Name\",\n        \"description\": null,\n        \"logo_link\": \"\"\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/brands/create","name":"create","apis":[{"api_url":"/api/v2/brands","http_method":"POST","short_description":"Create an brand","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":"brand","full_name":"brand","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"brand[name]","description":"\n\u003cp\u003eName of the brand\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"brand[description]","description":"\n\u003cp\u003eDescription of the brand\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"logo_url","full_name":"brand[logo_url]","description":"\n\u003cp\u003eLogo URL\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n      \"brand\": {\n          \"name\": \"Test\",\n      }\n  }\n\nresponse:\n  {\n    \"id\": 6,\n    \"name\": \"Test\",\n    \"description\": null,\n    \"logo_link\": \"\"\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/brands/update","name":"update","apis":[{"api_url":"/api/v2/brands/:id","http_method":"PUT","short_description":"Update an brand","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":"brand","full_name":"brand","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"brand[name]","description":"\n\u003cp\u003eName of the brand\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":"description","full_name":"brand[description]","description":"\n\u003cp\u003eDescription of the brand\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"logo_url","full_name":"brand[logo_url]","description":"\n\u003cp\u003eLogo URL\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n    \"brand\": {\n        \"name\": \"Test Updated\",\n    }\n  }\n\nresponse:\n  {\n    \"id\": 6,\n    \"name\": \"Test Updated\",\n    \"description\": null,\n    \"logo_link\": \"\"\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/brands/destroy","name":"destroy","apis":[{"api_url":"/api/v2/brands/:id","http_method":"DELETE","short_description":"Delete an brand","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\": 6\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"catalogs":{"doc_url":"/apidoc/2.0/catalogs","id":"catalogs","api_url":"/api","name":"Catalogs","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;id\u0026quot;: 1,\n  \u0026quot;name\u0026quot;: \u0026quot;Catalog Name\u0026quot;,\n  \u0026quot;data_sets\u0026quot;: []\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/catalogs/index","name":"index","apis":[{"api_url":"/api/v2/catalogs","http_method":"GET","short_description":"List catalogs","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":[]}],"returns":[],"examples":["Response:\n  {\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 1,\n    \"entries\": [\n      {\n        \"id\": 1,\n        \"name\": \"Catalog Name\",\n        \"data_sets\": []\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/catalogs/create","name":"create","apis":[{"api_url":"/api/v2/catalogs","http_method":"POST","short_description":"Create an catalog","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":"catalog","full_name":"catalog","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"catalog[name]","description":"\n\u003cp\u003eName of the catalog\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n      \"catalog\": {\n          \"name\": \"Catalog Name\"\n      }\n  }\n\nresponse:\n  {\n    \"id\": 2,\n    \"name\": \"Catalog Name\",\n    \"data_sets\": []\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/catalogs/update","name":"update","apis":[{"api_url":"/api/v2/catalogs/:id","http_method":"PUT","short_description":"Update an catalog","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":"catalog","full_name":"catalog","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"catalog[name]","description":"\n\u003cp\u003eName of the catalog\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":["request:\n  {\n      \"catalog\": {\n          \"name\": \"Catalog Name Updated\"\n      }\n  }\n\nresponse:\n  {\n    \"id\": 2,\n    \"name\": \"Catalog Name Updated\",\n    \"data_sets\": []\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/catalogs/destroy","name":"destroy","apis":[{"api_url":"/api/v2/catalogs/:id","http_method":"DELETE","short_description":"Delete an catalog","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\": 2\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"categories":{"doc_url":"/apidoc/2.0/categories","id":"categories","api_url":"/api","name":"Categories","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;id\u0026quot;: 1,\n  \u0026quot;name\u0026quot;: \u0026quot;Engine Oil\u0026quot;,\n  \u0026quot;description\u0026quot;: null,\n  \u0026quot;parent_id\u0026quot;: null,\n  \u0026quot;category_set_id\u0026quot;: 1,\n  \u0026quot;path\u0026quot;: \u0026quot;default: Engine Oil\u0026quot;,\n  \u0026quot;category_set\u0026quot;: {\n    \u0026quot;id\u0026quot;: 1,\n    \u0026quot;name\u0026quot;: \u0026quot;default\u0026quot;\n  }\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/categories/index","name":"index","apis":[{"api_url":"/api/v2/categories","http_method":"GET","short_description":"List categories","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":"lang","full_name":"lang","description":"\n\u003cp\u003eLanguage code for translated value\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":"response_associated_fields","full_name":"response_associated_fields","description":"\n\u003cp\u003eOne of ‘attribute_values’, ‘association_attribute_values’, ‘media_items’. The information related to the category to be included in the category data response. Use comma to join multiple fields.\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        \"name\": \"Engine Oil\",\n        \"description\": null,\n        \"parent_id\": null,\n        \"category_set_id\": 1,\n        \"path\": \"default: Engine Oil\",\n        \"category_set\": {\n          \"id\": 1,\n          \"name\": \"default\"\n        },\n        \"attribute_values\": [\n          {\n              \"attribute_definition_id\": 25,\n              \"attribute_definition_code\": \"colour_hex\",\n              \"data\": \"#000\"\n          },\n          {\n              \"attribute_definition_id\": 1,\n              \"attribute_definition_code\": \"colour\",\n              \"data\": \"Green\"\n          }\n        ],\n        \"media_items\": [\n          {\n              \"id\": 255,\n              \"media_item_type\": \"ImageMediaItem\",\n              \"url\": \"http://example.com/image-1\",\n              \"description\": \"Sample description\",\n              \"sort_order\": 0,\n              \"is_primary\": false,\n              \"is_uploaded\": null,\n              \"asset_file_name\": \"photo-1513002749550-c59d786b8e6c\",\n              \"public_url\": \"\",\n              \"etag\": \"\",\n              \"position\": 0,\n              \"tag_list\": [\n                  \"beautiful\",\n                  \"t-shirt\"\n              ]\n          }\n        ]\n      },\n      {\n        \"id\": 2,\n        \"name\": \"Transmission Oil\",\n        \"description\": null,\n        \"parent_id\": null,\n        \"category_set_id\": 1,\n        \"path\": \"default: Transmission Oil\",\n        \"category_set\": {\n          \"id\": 1,\n          \"name\": \"default\"\n        },\n        \"attribute_values\": [\n          {\n              \"attribute_definition_id\": 25,\n              \"attribute_definition_code\": \"colour_hex\",\n              \"data\": \"#001\"\n          },\n          {\n              \"attribute_definition_id\": 1,\n              \"attribute_definition_code\": \"colour\",\n              \"data\": \"Red\"\n          }\n        ],\n        \"media_items\": [\n          {\n              \"id\": 255,\n              \"media_item_type\": \"ImageMediaItem\",\n              \"url\": \"http://example.com/image-2\",\n              \"description\": \"Sample description\",\n              \"sort_order\": 0,\n              \"is_primary\": false,\n              \"is_uploaded\": null,\n              \"asset_file_name\": \"photo-1513002433fd4-c59d786b8e6c\",\n              \"public_url\": \"\",\n              \"etag\": \"\",\n              \"position\": 0,\n              \"tag_list\": []\n          }\n        ]\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/categories/create","name":"create","apis":[{"api_url":"/api/v2/categories","http_method":"POST","short_description":"Create an category","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":"category","full_name":"category","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"category_set","full_name":"category[category_set]","description":"\n\u003cp\u003eCategory set name. Default is ‘default’ category set. Ignored if parent_id is provided.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"category[path]","description":"\n\u003cp\u003eFull path of the category including all ancestors. Ignored if name is provided.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"category[name]","description":"\n\u003cp\u003eCategory name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"category[parent_id]","description":"\n\u003cp\u003eParent category id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"category[description]","description":"\n\u003cp\u003eCategory description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"category[sort_order]","description":"\n\u003cp\u003eSort order for category. Must be positive whole number\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attribute_values","full_name":"category[attribute_values]","description":"\n\u003cp\u003eAttribute values assigned to the Category.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"media_items","full_name":"category[media_items]","description":"\n\u003cp\u003eSet media items to the entity (existing media items will be removed).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"media_item_type","full_name":"category[media_items][media_item_type]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eImageMediaItem\u003c/code\u003e, \u003ccode\u003eVideoMediaItem\u003c/code\u003e, \u003ccode\u003eFileMediaItem\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"category[media_items][url]","description":"\n\u003cp\u003eURL that stores the corresponding media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"category[media_items][description]","description":"\n\u003cp\u003eDescription for the media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order_position","full_name":"category[media_items][sort_order_position]","description":"\n\u003cp\u003eThe position of the media item. Non negative integer is supported\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"is_primary","full_name":"category[media_items][is_primary]","description":"\n\u003cp\u003eMake this media item as primary\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag_list","full_name":"category[media_items][tag_list]","description":"\n\u003cp\u003eTags for this media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"processing_options","full_name":"category[media_items][processing_options]","description":"\n\u003cp\u003eOptions to perform extra image processing on the media item. This is applicable only when media_item_type is ‘ImageMediaItem’\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"apply_background","full_name":"category[media_items][processing_options][apply_background]","description":"\n\u003cp\u003eSetting this to true would result in a new media item created against the product with background applied. Removes transparency.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"background_colour","full_name":"category[media_items][processing_options][background_colour]","description":"\n\u003cp\u003eThe colour name or a hex colour code for the background colour for the created media item. Defaults to white.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"processed_tags","full_name":"category[media_items][processing_options][processed_tags]","description":"\n\u003cp\u003eThe tags for the created media item.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]}]}]}]}],"returns":[],"examples":["request:\n  {\n    \"category\": {\n        \"path\": \"Test\"\n    }\n  }\n\n  Sample: create a category with attribute_values\n\n  {\n    \"category\": {\n        \"path\": \"Test\",\n        \"attribute_values\": [\n          {\n            \"attribute_definition_id\": 16,\n            \"attribute_definition_code\": \"description\",\n            \"data\": \"Sample description...\"\n          }\n        ]\n    }\n  }\n\n  Sample: reset multi shared reference association\n  Supported Mode:\n  - upsert: default\n  - reset: Delete all existing association for this attribute, and replace with the current one. Send empty array to remove all existing values.\n\n  {\n    \"category\": {\n        \"path\": \"Test\",\n        \"attribute_values\": [\n          {\n              \"attribute_definition_id\": 16,\n              \"attribute_definition_code\": \"img_desc\",\n              \"data\": {\n                \"associated_code\": [\"code_1\", \"code_2\"]\n              }\n              \"mode\": \"reset\"\n          }\n      ]\n\n    }\n  }\n  Sample: create a category with media items\n\n  {\n    \"category\": {\n      \"category_set\": \"Clothing\",\n      \"path\": \"Shoes\",\n      \"media_items\": [\n        {\n          \"media_item_type\": \"ImageMediaItem\",\n          \"url\": \"https://www.gettyimages.com.au/gi-resources/images/500px/983801190.jpg\",\n          \"description\": \"Description\",\n          \"sort_order\": 0,\n          \"is_primary\": false,\n          \"is_uploaded\": null,\n          \"tag_list\": []\n        }\n      ]\n    }\n  }\n\n  Sample: create a category with entity_identifiers\n\n  {\n    \"category\": {\n        \"path\": \"Test\",\n        \"entity_identifiers\": [\n          {\n            \"key\": \"10000000001\",\n            \"name\": \"Channel Name\"\n          },\n          {\n            \"key\": \"20000000002\",\n            \"name\": \"Channel Name\"\n          }\n        ]\n    }\n  }\n\nresponse:\n  {\n    \"id\": 3,\n    \"name\": \"Test\",\n    \"description\": null,\n    \"parent_id\": null,\n    \"category_set_id\": 1,\n    \"path\": null,\n    \"category_set\": {\n      \"id\": 1,\n      \"name\": \"default\"\n    }\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/categories/update","name":"update","apis":[{"api_url":"/api/v2/categories/:id","http_method":"PUT","short_description":"Update an category","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":"category","full_name":"category","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"category_set","full_name":"category[category_set]","description":"\n\u003cp\u003eCategory set name. Default is ‘default’ category set. Ignored if parent_id is provided.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"category[path]","description":"\n\u003cp\u003eFull path of the category including all ancestors. Ignored if name is provided.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"category[name]","description":"\n\u003cp\u003eCategory name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"category[parent_id]","description":"\n\u003cp\u003eParent category id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"category[description]","description":"\n\u003cp\u003eCategory description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"category[sort_order]","description":"\n\u003cp\u003eSort order for category. Must be positive whole number\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attribute_values","full_name":"category[attribute_values]","description":"\n\u003cp\u003eAttribute values assigned to the Category.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"media_items","full_name":"category[media_items]","description":"\n\u003cp\u003eSet media items to the entity (existing media items will be removed).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"media_item_type","full_name":"category[media_items][media_item_type]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eImageMediaItem\u003c/code\u003e, \u003ccode\u003eVideoMediaItem\u003c/code\u003e, \u003ccode\u003eFileMediaItem\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"category[media_items][url]","description":"\n\u003cp\u003eURL that stores the corresponding media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"category[media_items][description]","description":"\n\u003cp\u003eDescription for the media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order_position","full_name":"category[media_items][sort_order_position]","description":"\n\u003cp\u003eThe position of the media item. Non negative integer is supported\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"is_primary","full_name":"category[media_items][is_primary]","description":"\n\u003cp\u003eMake this media item as primary\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag_list","full_name":"category[media_items][tag_list]","description":"\n\u003cp\u003eTags for this media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"processing_options","full_name":"category[media_items][processing_options]","description":"\n\u003cp\u003eOptions to perform extra image processing on the media item. This is applicable only when media_item_type is ‘ImageMediaItem’\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"apply_background","full_name":"category[media_items][processing_options][apply_background]","description":"\n\u003cp\u003eSetting this to true would result in a new media item created against the product with background applied. Removes transparency.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"background_colour","full_name":"category[media_items][processing_options][background_colour]","description":"\n\u003cp\u003eThe colour name or a hex colour code for the background colour for the created media item. Defaults to white.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"processed_tags","full_name":"category[media_items][processing_options][processed_tags]","description":"\n\u003cp\u003eThe tags for the created media item.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]}]}]}]}],"returns":[],"examples":["request:\n  {\n      \"category\": {\n          \"name\": \"Test Updated\"\n      }\n  }\n\nresponse:\n  {\n    \"id\": 3,\n    \"name\": \"Test Updated\",\n    \"description\": null,\n    \"parent_id\": null,\n    \"category_set_id\": 1,\n    \"path\": \"default: Test\",\n    \"category_set\": {\n      \"id\": 1,\n      \"name\": \"default\"\n    }\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/categories/destroy","name":"destroy","apis":[{"api_url":"/api/v2/categories/:id","http_method":"DELETE","short_description":"Delete an category","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\": 3\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"npc_entities":{"doc_url":"/apidoc/2.0/npc_entities","id":"npc_entities","api_url":"/api","name":"Npc entities","short_description":null,"full_description":"\n\u003cp\u003eVersion 5 only.\u003c/p\u003e\n\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;id\u0026quot;: 1,\n  \u0026quot;code\u0026quot;: \u0026quot;Npc Entity 1\u0026quot;,\n  \u0026quot;name\u0026quot;: \u0026quot;Npc Entity 1\u0026quot;\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/npc_entities/index","name":"index","apis":[{"api_url":"/api/v2/npc_entities","http_method":"GET","short_description":"List npc entities","deprecated":true}],"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":"id","full_name":"id","description":"\n\u003cp\u003eNpc Entity 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":"code","full_name":"code","description":"\n\u003cp\u003eNpc Entity 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":"name","full_name":"name","description":"\n\u003cp\u003eNpc Entity 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":[]},{"name":"response_associated_fields","full_name":"response_associated_fields","description":"\n\u003cp\u003eOne of ‘product_class’, ‘product_family’, ‘attribute_values’. The information related to the npc entity to be included in the npc entity data response. Use comma to join multiple fields.\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\": 1,\n      \"entries\": [\n        {\n            \"id\": 1,\n            \"code\": \"npc_entity_1\",\n            \"name\": \"NPC Entity 1\",\n            \"product_class\": {\n                \"id\": 7,\n                \"name\": \"Season\"\n            },\n            \"product_family\": {\n                \"id\": 1,\n                \"code\": \"family_1\",\n                \"name\": \"Family 1\"\n            },\n            \"attribute_values\": [\n                {\n                    \"attribute_definition_id\": 16,\n                    \"attribute_definition_code\": \"season\",\n                    \"data\": \"Winter\"\n                }\n            ]\n        }\n      ]\n  }\n\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/npc_entities/create","name":"create","apis":[{"api_url":"/api/v2/npc_entities","http_method":"POST","short_description":"Create or update npc entity","deprecated":true}],"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":"npc_entity","full_name":"npc_entity","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"code","full_name":"npc_entity[code]","description":"\n\u003cp\u003eCode of the npc entity\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"npc_entity[name]","description":"\n\u003cp\u003eName of the npc entity\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_class_name","full_name":"npc_entity[product_class_name]","description":"\n\u003cp\u003eClass name that this product is assigned to. This must be created beforehand\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_family_code","full_name":"npc_entity[product_family_code]","description":"\n\u003cp\u003eProduct family code\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribute_values","full_name":"npc_entity[attribute_values]","description":"\n\u003cp\u003eAttribute values assigned to the NPC entity.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"media_items","full_name":"npc_entity[media_items]","description":"\n\u003cp\u003eSet media items to the entity (existing media items will be removed).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"media_item_type","full_name":"npc_entity[media_items][media_item_type]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eImageMediaItem\u003c/code\u003e, \u003ccode\u003eVideoMediaItem\u003c/code\u003e, \u003ccode\u003eFileMediaItem\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"npc_entity[media_items][url]","description":"\n\u003cp\u003eURL that stores the corresponding media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"npc_entity[media_items][description]","description":"\n\u003cp\u003eDescription for the media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order_position","full_name":"npc_entity[media_items][sort_order_position]","description":"\n\u003cp\u003eThe position of the media item. Non negative integer is supported\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"is_primary","full_name":"npc_entity[media_items][is_primary]","description":"\n\u003cp\u003eMake this media item as primary\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag_list","full_name":"npc_entity[media_items][tag_list]","description":"\n\u003cp\u003eTags for this media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"processing_options","full_name":"npc_entity[media_items][processing_options]","description":"\n\u003cp\u003eOptions to perform extra image processing on the media item. This is applicable only when media_item_type is ‘ImageMediaItem’\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"apply_background","full_name":"npc_entity[media_items][processing_options][apply_background]","description":"\n\u003cp\u003eSetting this to true would result in a new media item created against the product with background applied. Removes transparency.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"background_colour","full_name":"npc_entity[media_items][processing_options][background_colour]","description":"\n\u003cp\u003eThe colour name or a hex colour code for the background colour for the created media item. Defaults to white.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"processed_tags","full_name":"npc_entity[media_items][processing_options][processed_tags]","description":"\n\u003cp\u003eThe tags for the created media item.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]}]}]},{"name":"price_items","full_name":"npc_entity[price_items]","description":"\n\u003cp\u003eAdd new prices or update existing prices if they exist.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"price_book_name","full_name":"npc_entity[price_items][price_book_name]","description":"\n\u003cp\u003eName of an existing price book to which this price item is linked\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"npc_entity[price_items][from]","description":"\n\u003cp\u003eValid from\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"npc_entity[price_items][to]","description":"\n\u003cp\u003eValid to\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"amount","full_name":"npc_entity[price_items][amount]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"categories","full_name":"npc_entity[categories]","description":"\n\u003cp\u003eSet the npc entity’s categories to these categories (existing categories will be removed)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"npc_entity[categories][id]","description":"\n\u003cp\u003eCategory ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}]}],"returns":[],"examples":["request:\n  {\n    \"npc_entity\": {\n        \"code\": \"npc_entity_1\",\n        \"name\": \"NPC Entity 1\",\n        \"product_class_name\": \"Season\",\n        \"product_family_code\": \"family_1\",\n        \"attribute_values\": {\n            \"season\": \"Winter\",\n            \"family_attr_1\": \"family1\"\n        },\n        \"media_items\": [\n          {\n            \"media_item_type\": \"ImageMediaItem\",\n            \"url\": \"http://s3.amazonaws.com/cc/image1.jpg\",\n            \"description\": \"\",\n            \"sort_order\": 0,\n            \"is_primary\": false,\n            \"is_uploaded\": null,\n            \"tag_list\": []\n          }\n        ],\n        \"price_items\": [\n          {\n            \"amount\": 45,\n            \"enabled?\": true,\n            \"price_book_name\": \"default\",\n            \"from\": null,\n            \"to\": null\n          }\n        ],\n        \"categories\": [\n          {\n            \"path\": \"Engine Oil\",\n            \"is_primary\": true,\n            \"category_set\": \"default\"\n          }\n        ],\n    }\n  }\n\nresponse:\n  {\n    \"id\": 1,\n    \"code\": \"npc_entity_1\",\n    \"product_class_id\": 7,\n    \"product_family_id\": 1,\n    \"created_at\": \"2019-08-30T16:16:05.302+10:00\",\n    \"updated_at\": \"2019-09-02T15:05:37.613+10:00\",\n    \"name\": \"NPC Entity 1\"\n  }\n\n\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/npc_entities/destroy","name":"destroy","apis":[{"api_url":"/api/v2/npc_entities/:id","http_method":"DELETE","short_description":"Delete a npc entity","deprecated":true}],"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},"category_sets":{"doc_url":"/apidoc/2.0/category_sets","id":"category_sets","api_url":"/api","name":"Category sets","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;id\u0026quot;: 1,\n  \u0026quot;name\u0026quot;: \u0026quot;default\u0026quot;,\n  \u0026quot;data_sets\u0026quot;: []\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/category_sets/index","name":"index","apis":[{"api_url":"/api/v2/category_sets","http_method":"GET","short_description":"List category sets","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":[]}],"returns":[],"examples":["Response:\n  {\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 1,\n    \"entries\": [\n      {\n        \"id\": 1,\n        \"name\": \"default\",\n        \"data_sets\": []\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/category_sets/create","name":"create","apis":[{"api_url":"/api/v2/category_sets","http_method":"POST","short_description":"Create an category set","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":"category_set","full_name":"category_set","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"category_set[name]","description":"\n\u003cp\u003eName of the category set\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n      \"category_set\": {\n          \"name\": \"Test\"\n      }\n  }\n\nresponse:\n  {\n    \"id\": 2,\n    \"name\": \"Test\",\n    \"data_sets\": []\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/category_sets/update","name":"update","apis":[{"api_url":"/api/v2/category_sets/:id","http_method":"PUT","short_description":"Update an category set","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":"category_set","full_name":"category_set","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"category_set[name]","description":"\n\u003cp\u003eName of the category set\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":["request:\n  {\n      \"category_set\": {\n          \"name\": \"Test Updated\"\n      }\n  }\n\nresponse:\n  {\n    \"id\": 2,\n    \"name\": \"Test Updated\",\n    \"data_sets\": []\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/category_sets/destroy","name":"destroy","apis":[{"api_url":"/api/v2/category_sets/:id","http_method":"DELETE","short_description":"Delete an category set","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\": 2\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"entity_identifiers":{"doc_url":"/apidoc/2.0/entity_identifiers","id":"entity_identifiers","api_url":"/api","name":"Entity identifiers","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n \u0026quot;key\u0026quot;: \u0026quot;loc-1\u0026quot;,\n \u0026quot;identifiable_id\u0026quot;: 2,\n \u0026quot;identifiable_type\u0026quot;: \u0026quot;Address\u0026quot;,\n \u0026quot;name\u0026quot;: \u0026quot;Store Name A\u0026quot;\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/entity_identifiers/index","name":"index","apis":[{"api_url":"/api/v2/entity_identifiers","http_method":"GET","short_description":"List Entity identifiers","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":"lang","full_name":"lang","description":"\n\u003cp\u003eLanguage code for translated value\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":"key","full_name":"key","description":"\n\u003cp\u003eThe key (ID) of the entity (object). Unique identifier for the entity\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":"name","full_name":"name","description":"\n\u003cp\u003eDescription for the key\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":"identifiable_id","full_name":"identifiable_id","description":"\n\u003cp\u003eThe entity ID such as Product ID.\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":"identifiable_type","full_name":"identifiable_type","description":"\n\u003cp\u003eThe entity type such as Product\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eProduct\u003c/code\u003e, \u003ccode\u003eAddress\u003c/code\u003e, \u003ccode\u003eCategory\u003c/code\u003e, \u003ccode\u003eMediaItem\u003c/code\u003e, \u003ccode\u003eInventoryLocation\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\": 1,\n    \"entries\": [\n      {\n        \"id\": 1,\n        \"key\": \"value_one\",\n        \"identifiable_id\": 1,\n        \"identifiable_type\": \"Product\",\n        \"name\": \"key_one\"\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/entity_identifiers/create","name":"create","apis":[{"api_url":"/api/v2/entity_identifiers","http_method":"POST","short_description":"Create an additional identifier for an existing entity","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":"entity_identifier","full_name":"entity_identifier","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"key","full_name":"entity_identifier[key]","description":"\n\u003cp\u003eThe key (ID) of the entity (object). Unique identifier for the entity\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"identifiable_id","full_name":"entity_identifier[identifiable_id]","description":"\n\u003cp\u003eThe entity ID such as Product ID. If this is provided, identifiable_code is not required.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifiable_code","full_name":"entity_identifier[identifiable_code]","description":"\n\u003cp\u003eThe entity default code such as Product code. If this is provided, identifiable_id is not required.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"identifiable_type","full_name":"entity_identifier[identifiable_type]","description":"\n\u003cp\u003eThe entity type such Product\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eProduct\u003c/code\u003e, \u003ccode\u003eAddress\u003c/code\u003e, \u003ccode\u003eCategory\u003c/code\u003e, \u003ccode\u003eMediaItem\u003c/code\u003e, \u003ccode\u003eInventoryLocation\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"entity_identifier[name]","description":"\n\u003cp\u003eDescription for the key\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n    \"entity_identifier\": {\n       \"key\": \"m-001\",\n       \"identifiable_id\": 1095,\n       \"identifiable_type\": \"Product\",\n       \"name\": \"MPN\"\n    }\n  }\n\nresponse:\n  {\n      \"id\": 3,\n      \"key\": \"m-001\",\n      \"identifiable_id\": 1095,\n      \"identifiable_type\": \"Product\",\n      \"name\": \"MPN\",\n      \"created_at\": \"2018-01-10T14:28:43.090+11:00\",\n      \"updated_at\": \"2018-01-10T14:28:43.090+11:00\"\n  }\n\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/entity_identifiers/update","name":"update","apis":[{"api_url":"/api/v2/entity_identifiers/:id","http_method":"PUT","short_description":"Update an entity identifier","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":"entity_identifier","full_name":"entity_identifier","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"key","full_name":"entity_identifier[key]","description":"\n\u003cp\u003eThe key (ID) of the entity (object). Unique identifier for the entity\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":"identifiable_id","full_name":"entity_identifier[identifiable_id]","description":"\n\u003cp\u003eThe entity ID such as Product ID. If this is provided, identifiable_code is not required.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifiable_code","full_name":"entity_identifier[identifiable_code]","description":"\n\u003cp\u003eThe entity default code such as Product code. If this is provided, identifiable_id is not required.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"identifiable_type","full_name":"entity_identifier[identifiable_type]","description":"\n\u003cp\u003eThe entity type such Product\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eProduct\u003c/code\u003e, \u003ccode\u003eAddress\u003c/code\u003e, \u003ccode\u003eCategory\u003c/code\u003e, \u003ccode\u003eMediaItem\u003c/code\u003e, \u003ccode\u003eInventoryLocation\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"entity_identifier[name]","description":"\n\u003cp\u003eDescription for the key\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n    \"entity_identifier\": {\n       \"key\": \"m-001\",\n       \"identifiable_id\": 1095,\n       \"identifiable_type\": \"Product\",\n       \"name\": \"MPN-update\"\n    }\n  }\n\nresponse:\n  {\n      \"id\": 3,\n      \"key\": \"m-001\",\n      \"identifiable_id\": 1095,\n      \"identifiable_type\": \"Product\",\n      \"name\": \"MPN-update\",\n      \"created_at\": \"2018-01-10T14:28:43.090+11:00\",\n      \"updated_at\": \"2018-01-10T14:28:43.090+11:00\"\n  }\n\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/entity_identifiers/reset","name":"reset","apis":[{"api_url":"/api/v2/entity_identifiers/reset","http_method":"POST","short_description":"Reset the additional identifiers with the same name for an existing entity","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":"entity_identifier","full_name":"entity_identifier","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"key","full_name":"entity_identifier[key]","description":"\n\u003cp\u003eThe key (ID) of the entity (object). Unique identifier for the entity\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"identifiable_id","full_name":"entity_identifier[identifiable_id]","description":"\n\u003cp\u003eThe entity ID such as Product ID. If this is provided, identifiable_code is not required.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifiable_code","full_name":"entity_identifier[identifiable_code]","description":"\n\u003cp\u003eThe entity default code such as Product code. If this is provided, identifiable_id is not required.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"identifiable_type","full_name":"entity_identifier[identifiable_type]","description":"\n\u003cp\u003eThe entity type such Product\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eProduct\u003c/code\u003e, \u003ccode\u003eAddress\u003c/code\u003e, \u003ccode\u003eCategory\u003c/code\u003e, \u003ccode\u003eMediaItem\u003c/code\u003e, \u003ccode\u003eInventoryLocation\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"entity_identifier[name]","description":"\n\u003cp\u003eDescription for the key\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n    \"entity_identifier\": {\n       \"key\": \"m-001\",\n       \"identifiable_id\": 1095,\n       \"identifiable_type\": \"Product\",\n       \"name\": \"MPN\"\n    }\n  }\n\nresponse:\n  {\n      \"id\": 3,\n      \"key\": \"m-001\",\n      \"identifiable_id\": 1095,\n      \"identifiable_type\": \"Product\",\n      \"name\": \"MPN\",\n      \"created_at\": \"2018-01-10T14:28:43.090+11:00\",\n      \"updated_at\": \"2018-01-10T14:28:43.090+11:00\"\n  }\n\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/entity_identifiers/destroy","name":"destroy","apis":[{"api_url":"/api/v2/entity_identifiers/:id","http_method":"DELETE","short_description":"Delete an entity identifier","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\": 2\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"inventories":{"doc_url":"/apidoc/2.0/inventories","id":"inventories","api_url":"/api","name":"Inventories","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;id\u0026quot;: 2,\n  \u0026quot;qty\u0026quot;: 5,\n  \u0026quot;available_qty\u0026quot;: 7\n  \u0026quot;stock_availability\u0026quot;: null,\n  \u0026quot;out_of_stock_threshold\u0026quot;: null,\n  \u0026quot;dispatch_time\u0026quot;: null,\n  \u0026quot;dispatch_time_unit\u0026quot;: \u0026quot;day\u0026quot;,\n  \u0026quot;unit_cost\u0026quot;: null,\n  \u0026quot;style\u0026quot;: \u0026quot;dynamic\u0026quot;,\n  \u0026quot;sku\u0026quot;: null,\n  \u0026quot;support_shipping\u0026quot;: true,\n  \u0026quot;inventory_source\u0026quot;: {\n    \u0026quot;id\u0026quot;: 1,\n    \u0026quot;name\u0026quot;: \u0026quot;MOTUL\u0026quot;\n  }\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/inventories/index","name":"index","apis":[{"api_url":"/api/v2/inventories","http_method":"GET","short_description":"List inventories","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":"response_inventory_fields","full_name":"response_inventory_fields","description":"\n\u003cp\u003eOne of ‘id’, ‘product_id’, ‘qty’. The inventory information to be included in the inventory data response. Use comma to join multiple fields.\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":"response_associated_fields","full_name":"response_associated_fields","description":"\n\u003cp\u003eUse ‘inventory_source’. The information related to the inventory source to be included in the inventory data response. Use comma to join multiple fields.\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_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":[]}],"returns":[],"examples":["Response:\n  {\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 1,\n    \"entries\": [\n      {\n        \"id\": 2,\n        \"qty\": 5,\n        \"available_qty\": 7,\n        \"product_id\": 7,\n        \"stock_availability\": null,\n        \"out_of_stock_threshold\": null,\n        \"dispatch_time\": null,\n        \"dispatch_time_unit\": \"day\",\n        \"unit_cost\": null,\n        \"style\": \"dynamic\",\n        \"sku\": null,\n        \"lead_time\": 48,\n        \"lead_time_unit\": \"hours\",\n        \"stock_arrival_date\": null,\n        \"back_order_handling\": null,\n        \"back_order_allocation\": null,\n        \"source_system_stock_timestamp\": null,\n        \"support_shipping\": true,\n        \"inventory_source\": {\n          \"id\": 1,\n          \"name\": \"MOTUL\"\n        }\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/inventories/create","name":"create","apis":[{"api_url":"/api/v2/inventories","http_method":"POST","short_description":"Create an inventory","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":"inventory","full_name":"inventory","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"inventory_source","full_name":"inventory[inventory_source]","description":"\n\u003cp\u003eName of the inventory source\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_code","full_name":"inventory[product_code]","description":"\n\u003cp\u003eProduct code. Do not provide if ‘product_id’ is provided\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"inventory[product_id]","description":"\n\u003cp\u003eProduct ID. Do not provide if ‘product_code’ is provided\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"sku","full_name":"inventory[sku]","description":"\n\u003cp\u003eSKU for this inventory source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"qty","full_name":"inventory[qty]","description":"\n\u003cp\u003eQuantity\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":"available_qty","full_name":"inventory[available_qty]","description":"\n\u003cp\u003eAvailable Quantity\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"stock_availability","full_name":"inventory[stock_availability]","description":"\n\u003cp\u003eStock availability\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eout_of_stock\u003c/code\u003e, \u003ccode\u003ein_stock\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"out_of_stock_threshold","full_name":"inventory[out_of_stock_threshold]","description":"\n\u003cp\u003eOut of stock threshold\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dispatch_time","full_name":"inventory[dispatch_time]","description":"\n\u003cp\u003eDispatch time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dispatch_time_unit","full_name":"inventory[dispatch_time_unit]","description":"\n\u003cp\u003eDispatch time unit\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eday\u003c/code\u003e, \u003ccode\u003ehour\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lead_time","full_name":"inventory[lead_time]","description":"\n\u003cp\u003eLead time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lead_time_unit","full_name":"inventory[lead_time_unit]","description":"\n\u003cp\u003eLead time unit\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003emonths\u003c/code\u003e, \u003ccode\u003eweeks\u003c/code\u003e, \u003ccode\u003edays\u003c/code\u003e, \u003ccode\u003ehours\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"stock_arrival_date","full_name":"inventory[stock_arrival_date]","description":"\n\u003cp\u003eValid Stock Arrival Date. ISO_8601 format 2016-05-30T05:13:26Z.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"back_order_handling","full_name":"inventory[back_order_handling]","description":"\n\u003cp\u003eBack order handling\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003epre_orderable\u003c/code\u003e, \u003ccode\u003eback_orderable\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"back_order_allocation","full_name":"inventory[back_order_allocation]","description":"\n\u003cp\u003eBack Order Allocation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"source_system_stock_timestamp","full_name":"inventory[source_system_stock_timestamp]","description":"\n\u003cp\u003eValid Source System Stock Timestamp. ISO_8601 format 2016-05-30T05:13:26Z.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"unit_cost","full_name":"inventory[unit_cost]","description":"\n\u003cp\u003eUnit cost of the product for this inventory source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"style","full_name":"inventory[style]","description":"\n\u003cp\u003eDynamic means Qty changes and Static means Qty stays the same. This is related to inventory decrement for order download\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edynamic\u003c/code\u003e, \u003ccode\u003estatic\u003c/code\u003e, \u003ccode\u003eperpetual\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n      \"inventory\": {\n          \"inventory_source\": \"MOTUL\",\n          \"product_id\": 1,\n          \"qty\": 5\n      }\n  }\n\nresponse:\n  {\n    \"id\": 2,\n    \"qty\": 5,\n    \"available_qty\": 7\n    \"stock_availability\": null,\n    \"out_of_stock_threshold\": null,\n    \"dispatch_time\": null,\n    \"dispatch_time_unit\": \"day\",\n    \"unit_cost\": null,\n    \"style\": \"dynamic\",\n    \"sku\": null,\n    \"lead_time\": 48,\n    \"lead_time_unit\": \"hours\",\n    \"stock_arrival_date\": null,\n    \"back_order_handling\": null,\n    \"back_order_allocation\": null,\n    \"source_system_stock_timestamp\": null,\n    \"support_shipping\": true,\n    \"inventory_source\": {\n      \"id\": 1,\n      \"name\": \"MOTUL\"\n    }\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/inventories/update","name":"update","apis":[{"api_url":"/api/v2/inventories/:id","http_method":"PUT","short_description":"Update an inventory","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":"inventory","full_name":"inventory","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"inventory_source","full_name":"inventory[inventory_source]","description":"\n\u003cp\u003eName of the inventory source\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":"product_code","full_name":"inventory[product_code]","description":"\n\u003cp\u003eProduct code. Do not provide if ‘product_id’ is provided\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"inventory[product_id]","description":"\n\u003cp\u003eProduct ID. Do not provide if ‘product_code’ is provided\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"sku","full_name":"inventory[sku]","description":"\n\u003cp\u003eSKU for this inventory source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"qty","full_name":"inventory[qty]","description":"\n\u003cp\u003eQuantity\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"available_qty","full_name":"inventory[available_qty]","description":"\n\u003cp\u003eAvailable Quantity\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"stock_availability","full_name":"inventory[stock_availability]","description":"\n\u003cp\u003eStock availability\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eout_of_stock\u003c/code\u003e, \u003ccode\u003ein_stock\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"out_of_stock_threshold","full_name":"inventory[out_of_stock_threshold]","description":"\n\u003cp\u003eOut of stock threshold\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dispatch_time","full_name":"inventory[dispatch_time]","description":"\n\u003cp\u003eDispatch time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dispatch_time_unit","full_name":"inventory[dispatch_time_unit]","description":"\n\u003cp\u003eDispatch time unit\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eday\u003c/code\u003e, \u003ccode\u003ehour\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lead_time","full_name":"inventory[lead_time]","description":"\n\u003cp\u003eLead time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lead_time_unit","full_name":"inventory[lead_time_unit]","description":"\n\u003cp\u003eLead time unit\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003emonths\u003c/code\u003e, \u003ccode\u003eweeks\u003c/code\u003e, \u003ccode\u003edays\u003c/code\u003e, \u003ccode\u003ehours\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"stock_arrival_date","full_name":"inventory[stock_arrival_date]","description":"\n\u003cp\u003eValid Stock Arrival Date. ISO_8601 format 2016-05-30T05:13:26Z.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"back_order_handling","full_name":"inventory[back_order_handling]","description":"\n\u003cp\u003eBack order handling\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003epre_orderable\u003c/code\u003e, \u003ccode\u003eback_orderable\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"back_order_allocation","full_name":"inventory[back_order_allocation]","description":"\n\u003cp\u003eBack Order Allocation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"source_system_stock_timestamp","full_name":"inventory[source_system_stock_timestamp]","description":"\n\u003cp\u003eValid Source System Stock Timestamp. ISO_8601 format 2016-05-30T05:13:26Z.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"unit_cost","full_name":"inventory[unit_cost]","description":"\n\u003cp\u003eUnit cost of the product for this inventory source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"style","full_name":"inventory[style]","description":"\n\u003cp\u003eDynamic means Qty changes and Static means Qty stays the same. This is related to inventory decrement for order download\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edynamic\u003c/code\u003e, \u003ccode\u003estatic\u003c/code\u003e, \u003ccode\u003eperpetual\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n      \"inventory\": {\n          \"inventory_source\": \"MOTUL\",\n          \"product_id\": 1,\n          \"qty\": 8\n      }\n  }\n\nresponse:\n  {\n    \"id\": 2,\n    \"qty\": 8,\n    \"available_qty\": 7\n    \"stock_availability\": null,\n    \"out_of_stock_threshold\": null,\n    \"dispatch_time\": null,\n    \"dispatch_time_unit\": \"day\",\n    \"unit_cost\": null,\n    \"style\": \"dynamic\",\n    \"sku\": null,\n    \"lead_time\": 48,\n    \"lead_time_unit\": \"hours\",\n    \"stock_arrival_date\": null,\n    \"back_order_handling\": null,\n    \"back_order_allocation\": null,\n    \"source_system_stock_timestamp\": null,\n    \"support_shipping\": true,\n    \"inventory_source\": {\n      \"id\": 1,\n      \"name\": \"MOTUL\"\n    }\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/inventories/increment","name":"increment","apis":[{"api_url":"/api/v2/inventories/:id/increment","http_method":"PUT","short_description":"Increment or decrement an inventory","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      \"inventory\": {\n          \"inventory_source\": \"MOTUL\",\n          \"product_id\": 1,\n          \"increment\": -8,\n          \"description\": \"From ERP\"\n      }\n  }\n\nresponse:\n  {\n    \"id\": 2,\n    \"qty\": 2,\n    \"available_qty\": 7\n    \"stock_availability\": null,\n    \"out_of_stock_threshold\": null,\n    \"dispatch_time\": null,\n    \"dispatch_time_unit\": \"day\",\n    \"unit_cost\": null,\n    \"style\": \"dynamic\",\n    \"sku\": null,\n    \"stock_arrival_date\": null,\n    \"back_order_handling\": null,\n    \"back_order_allocation\": null,\n    \"source_system_stock_timestamp\": null,\n    \"support_shipping\": true,\n    \"inventory_source\": {\n      \"id\": 1,\n      \"name\": \"MOTUL\"\n    }\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/inventories/destroy","name":"destroy","apis":[{"api_url":"/api/v2/inventories/:id","http_method":"DELETE","short_description":"Delete an inventory","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\": 2\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"inventory_locations":{"doc_url":"/apidoc/2.0/inventory_locations","id":"inventory_locations","api_url":"/api","name":"Inventory locations","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;id\u0026quot;: 1,\n  \u0026quot;street_line_1\u0026quot;: \u0026quot;41 Rawson Street\u0026quot;,\n  \u0026quot;street_line_2\u0026quot;: \u0026quot;\u0026quot;,\n  \u0026quot;city\u0026quot;: \u0026quot;Epping\u0026quot;,\n  \u0026quot;state_or_region\u0026quot;: \u0026quot;NSW\u0026quot;,\n  \u0026quot;country_code\u0026quot;: \u0026quot;AU\u0026quot;,\n  \u0026quot;post_code\u0026quot;: \u0026quot;2121\u0026quot;,\n  \u0026quot;timezone\u0026quot;: \u0026quot;\u0026quot;,\n  \u0026quot;latitude\u0026quot;: null,\n  \u0026quot;longitude\u0026quot;: null,\n  \u0026quot;name\u0026quot;: \u0026quot;Location 1\u0026quot;,\n  \u0026quot;support_pickup\u0026quot;: false,\n  \u0026quot;ship_from_store\u0026quot;: false,\n  \u0026quot;code\u0026quot;: \u0026quot;location_1\u0026quot;,\n  \u0026quot;external_code\u0026quot;:\u0026quot;external_location_1\u0026quot;,\n  \u0026quot;phone\u0026quot;: \u0026quot;+61280266800\u0026quot;,\n  \u0026quot;pickup_instructions\u0026quot;: \u0026quot;\u0026quot;,\n  \u0026quot;website_url\u0026quot;: \u0026quot;\u0026quot;,\n  \u0026quot;utc_offset\u0026quot;: null,\n  \u0026quot;discontinued\u0026quot;: false,\n  \u0026quot;business_hours\u0026quot;: [\n    {\n      \u0026quot;id\u0026quot;: 1,\n      \u0026quot;day\u0026quot;: \u0026quot;monday\u0026quot;,\n      \u0026quot;day_name\u0026quot;: \u0026quot;Monday\u0026quot;,\n      \u0026quot;business_hour_type\u0026quot;: \u0026quot;normal\u0026quot;,\n      \u0026quot;special_date\u0026quot;: null,\n      \u0026quot;closed\u0026quot;: null,\n      \u0026quot;day_value\u0026quot;: 1,\n      \u0026quot;open\u0026quot;: \u0026quot;09:00:00\u0026quot;,\n      \u0026quot;close\u0026quot;: \u0026quot;17:00:00\u0026quot;\n    },\n    {\n      \u0026quot;id\u0026quot;: 2,\n      \u0026quot;day\u0026quot;: \u0026quot;tuesday\u0026quot;,\n      \u0026quot;day_name\u0026quot;: \u0026quot;Tuesday\u0026quot;,\n      \u0026quot;business_hour_type\u0026quot;: \u0026quot;normal\u0026quot;,\n      \u0026quot;special_date\u0026quot;: null,\n      \u0026quot;closed\u0026quot;: null,\n      \u0026quot;day_value\u0026quot;: 2,\n      \u0026quot;open\u0026quot;: \u0026quot;09:00:00\u0026quot;,\n      \u0026quot;close\u0026quot;: \u0026quot;17:00:00\u0026quot;\n    },\n    {\n      \u0026quot;id\u0026quot;: 3,\n      \u0026quot;day\u0026quot;: \u0026quot;wednesday\u0026quot;,\n      \u0026quot;day_name\u0026quot;: \u0026quot;Wednesday\u0026quot;,\n      \u0026quot;business_hour_type\u0026quot;: \u0026quot;normal\u0026quot;,\n      \u0026quot;special_date\u0026quot;: null,\n      \u0026quot;closed\u0026quot;: null,\n      \u0026quot;day_value\u0026quot;: 3,\n      \u0026quot;open\u0026quot;: \u0026quot;09:00:00\u0026quot;,\n      \u0026quot;close\u0026quot;: \u0026quot;17:00:00\u0026quot;\n    },\n    {\n      \u0026quot;id\u0026quot;: 4,\n      \u0026quot;day\u0026quot;: \u0026quot;thursday\u0026quot;,\n      \u0026quot;day_name\u0026quot;: \u0026quot;Thursday\u0026quot;,\n      \u0026quot;business_hour_type\u0026quot;: \u0026quot;normal\u0026quot;,\n      \u0026quot;special_date\u0026quot;: null,\n      \u0026quot;closed\u0026quot;: null,\n      \u0026quot;day_value\u0026quot;: 4,\n      \u0026quot;open\u0026quot;: \u0026quot;09:00:00\u0026quot;,\n      \u0026quot;close\u0026quot;: \u0026quot;17:00:00\u0026quot;\n    },\n    {\n      \u0026quot;id\u0026quot;: 5,\n      \u0026quot;day\u0026quot;: \u0026quot;friday\u0026quot;,\n      \u0026quot;day_name\u0026quot;: \u0026quot;Friday\u0026quot;,\n      \u0026quot;business_hour_type\u0026quot;: \u0026quot;normal\u0026quot;,\n      \u0026quot;special_date\u0026quot;: null,\n      \u0026quot;closed\u0026quot;: null,\n      \u0026quot;day_value\u0026quot;: 5,\n      \u0026quot;open\u0026quot;: \u0026quot;09:00:00\u0026quot;,\n      \u0026quot;close\u0026quot;: \u0026quot;17:00:00\u0026quot;\n    },\n    {\n      \u0026quot;id\u0026quot;: 6,\n      \u0026quot;day\u0026quot;: \u0026quot;saturday\u0026quot;,\n      \u0026quot;day_name\u0026quot;: \u0026quot;Saturday\u0026quot;,\n      \u0026quot;business_hour_type\u0026quot;: \u0026quot;normal\u0026quot;,\n      \u0026quot;special_date\u0026quot;: null,\n      \u0026quot;closed\u0026quot;: null,\n      \u0026quot;day_value\u0026quot;: 6,\n      \u0026quot;open\u0026quot;: \u0026quot;00:00:00\u0026quot;,\n      \u0026quot;close\u0026quot;: \u0026quot;00:00:00\u0026quot;\n    },\n    {\n      \u0026quot;id\u0026quot;: 7,\n      \u0026quot;day\u0026quot;: \u0026quot;sunday\u0026quot;,\n      \u0026quot;day_name\u0026quot;: \u0026quot;Sunday\u0026quot;,\n      \u0026quot;business_hour_type\u0026quot;: \u0026quot;normal\u0026quot;,\n      \u0026quot;special_date\u0026quot;: null,\n      \u0026quot;closed\u0026quot;: null,\n      \u0026quot;day_value\u0026quot;: 7,\n      \u0026quot;open\u0026quot;: \u0026quot;00:00:00\u0026quot;,\n      \u0026quot;close\u0026quot;: \u0026quot;00:00:00\u0026quot;\n    },\n    {\n      \u0026quot;id\u0026quot;: 8,\n      \u0026quot;day\u0026quot;: null,\n      \u0026quot;day_name\u0026quot;: \u0026quot;Christmas Day\u0026quot;,\n      \u0026quot;business_hour_type\u0026quot;: \u0026quot;special\u0026quot;,\n      \u0026quot;special_date\u0026quot;: \u0026quot;2018-12-26T00:00:00.000+11:00\u0026quot;,\n      \u0026quot;closed\u0026quot;: true,\n      \u0026quot;day_value\u0026quot;: null,\n      \u0026quot;open\u0026quot;: \u0026quot;00:00:00\u0026quot;,\n      \u0026quot;close\u0026quot;: \u0026quot;00:00:00\u0026quot;\n    }\n  ],\n  \u0026quot;inventory_sources\u0026quot;: [\n    {\n      \u0026quot;id\u0026quot;: 1,\n      \u0026quot;name\u0026quot;: \u0026quot;MOTUL\u0026quot;\n    }\n  ]\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/inventory_locations/index","name":"index","apis":[{"api_url":"/api/v2/inventory_locations","http_method":"GET","short_description":"List inventory locations","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":"id","full_name":"id","description":"\n\u003cp\u003eEntity 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":"identifier_name","full_name":"identifier_name","description":"\n\u003cp\u003eExtra identifier name added via EntityIdentifier endpoint\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":"entity_key","full_name":"entity_key","description":"\n\u003cp\u003eExtra entity identifier key added via EntityIdentifier endpoint\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":"lang","full_name":"lang","description":"\n\u003cp\u003eLanguage code for translated value\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\": 1,\n    \"entries\": [\n      {\n        \"id\": 1,\n        \"street_line_1\": \"41 Rawson Street\",\n        \"street_line_2\": \"\",\n        \"city\": \"Epping\",\n        \"state_or_region\": \"NSW\",\n        \"country_code\": \"AU\",\n        \"post_code\": \"2121\",\n        \"timezone\": \"\",\n        \"latitude\": null,\n        \"longitude\": null,\n        \"name\": \"Location 1\",\n        \"support_pickup\": false,\n        \"ship_from_store\": false,\n        \"code\": \"location_1\",\n        \"external_code\":\"external_location_1\"\n        \"phone\": \"+61280266800\",\n        \"pickup_instructions\": \"\",\n        \"website_url\": \"\",\n        \"utc_offset\": null,\n        \"discontinued\": false,\n        \"business_hours\": [\n          {\n            \"id\": 1,\n            \"day\": \"monday\",\n            \"day_name\": \"Monday\",\n            \"business_hour_type\": \"normal\",\n            \"special_date\": null,\n            \"closed\": null,\n            \"day_value\": 1,\n            \"open\": \"09:00:00\",\n            \"close\": \"17:00:00\"\n          },\n          {\n            \"id\": 2,\n            \"day\": \"tuesday\",\n            \"day_name\": \"Tuesday\",\n            \"business_hour_type\": \"normal\",\n            \"special_date\": null,\n            \"closed\": null,\n            \"day_value\": 2,\n            \"open\": \"09:00:00\",\n            \"close\": \"17:00:00\"\n          },\n          {\n            \"id\": 3,\n            \"day\": \"wednesday\",\n            \"day_name\": \"Wednesday\",\n            \"business_hour_type\": \"normal\",\n            \"special_date\": null,\n            \"closed\": null,\n            \"day_value\": 3,\n            \"open\": \"09:00:00\",\n            \"close\": \"17:00:00\"\n          },\n          {\n            \"id\": 4,\n            \"day\": \"thursday\",\n            \"day_name\": \"Thursday\",\n            \"business_hour_type\": \"normal\",\n            \"special_date\": null,\n            \"closed\": null,\n            \"day_value\": 4,\n            \"open\": \"09:00:00\",\n            \"close\": \"17:00:00\"\n          },\n          {\n            \"id\": 5,\n            \"day\": \"friday\",\n            \"day_name\": \"Friday\",\n            \"business_hour_type\": \"normal\",\n            \"special_date\": null,\n            \"closed\": null,\n            \"day_value\": 5,\n            \"open\": \"09:00:00\",\n            \"close\": \"17:00:00\"\n          },\n          {\n            \"id\": 6,\n            \"day\": \"saturday\",\n            \"day_name\": \"Saturday\",\n            \"business_hour_type\": \"normal\",\n            \"special_date\": null,\n            \"closed\": null,\n            \"day_value\": 6,\n            \"open\": \"00:00:00\",\n            \"close\": \"00:00:00\"\n          },\n          {\n            \"id\": 7,\n            \"day\": \"sunday\",\n            \"day_name\": \"Sunday\",\n            \"business_hour_type\": \"normal\",\n            \"special_date\": null,\n            \"closed\": null,\n            \"day_value\": 7,\n            \"open\": \"00:00:00\",\n            \"close\": \"00:00:00\"\n          },\n          {\n            \"id\": 8,\n            \"day\": null,\n            \"day_name\": \"Christmas Day\",\n            \"business_hour_type\": \"special\",\n            \"special_date\": \"2018-12-25T00:00:00.000+11:00\",\n            \"closed\": true,\n            \"day_value\": null,\n            \"open\": \"00:00:00\",\n            \"close\": \"00:00:00\"\n          }\n        ],\n        \"inventory_sources\": [\n          {\n            \"id\": 1,\n            \"name\": \"MOTUL\"\n          }\n        ]\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/inventory_locations/create","name":"create","apis":[{"api_url":"/api/v2/inventory_locations","http_method":"POST","short_description":"Create an inventory location","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":"inventory_location","full_name":"inventory_location","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"inventory_location[name]","description":"\n\u003cp\u003eName of the inventory location\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"code","full_name":"inventory_location[code]","description":"\n\u003cp\u003eCode of the inventory location\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_code","full_name":"inventory_location[external_code]","description":"\n\u003cp\u003eExternal code of the inventory location\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"inventory_location[status]","description":"\n\u003cp\u003eStatus of the inventory location\u003c/p\u003e\n","required":false,"allow_nil":true,"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":"street_line_1","full_name":"inventory_location[street_line_1]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"street_line_2","full_name":"inventory_location[street_line_2]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"city","full_name":"inventory_location[city]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"state_or_region","full_name":"inventory_location[state_or_region]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"country_code","full_name":"inventory_location[country_code]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"post_code","full_name":"inventory_location[post_code]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"inventory_location[timezone]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"longitude","full_name":"inventory_location[longitude]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pickup_instructions","full_name":"inventory_location[pickup_instructions]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"website_url","full_name":"inventory_location[website_url]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"support_pickup","full_name":"inventory_location[support_pickup]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ship_from_store","full_name":"inventory_location[ship_from_store]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag_list","full_name":"inventory_location[tag_list]","description":"\n\u003cp\u003eList of tags for this inventory location\u003c/p\u003e\n","required":false,"allow_nil":true,"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_location[inventory_source_ids]","description":"\n\u003cp\u003eList of inventory source IDs that the inventory location belongs to. Do not provide if ‘inventory_sources’ is provided\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of Integer","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"inventory_sources","full_name":"inventory_location[inventory_sources]","description":"\n\u003cp\u003eList of inventory sources that the inventory location belongs to. Do not provide if ‘product_level_ids’ is provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"inventory_location[inventory_sources][name]","description":"\n\u003cp\u003eName of the inventory source\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"delete","full_name":"inventory_location[inventory_sources][delete]","description":"\n\u003cp\u003eRemove this inventory location from the associations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"business_hours","full_name":"inventory_location[business_hours]","description":"\n\u003cp\u003eList of business hours that the inventory location has\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"day","full_name":"inventory_location[business_hours][day]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003emonday\u003c/code\u003e, \u003ccode\u003etuesday\u003c/code\u003e, \u003ccode\u003ewednesday\u003c/code\u003e, \u003ccode\u003ethursday\u003c/code\u003e, \u003ccode\u003efriday\u003c/code\u003e, \u003ccode\u003esaturday\u003c/code\u003e, \u003ccode\u003esunday\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"day_name","full_name":"inventory_location[business_hours][day_name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"business_hour_type","full_name":"inventory_location[business_hours][business_hour_type]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enormal\u003c/code\u003e, \u003ccode\u003especial\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"special_date","full_name":"inventory_location[business_hours][special_date]","description":"\n\u003cp\u003eValid special_date. ISO_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":"closed","full_name":"inventory_location[business_hours][closed]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"open_time","full_name":"inventory_location[business_hours][open_time]","description":"\n\u003cp\u003eDon’t supply value if it is not open on this day. E.g. ‘09:00:00’\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":"close_time","full_name":"inventory_location[business_hours][close_time]","description":"\n\u003cp\u003eDon’t supply value if it is not open on this day. E.g. ‘17:00:00’\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":["request:\n  {\n      \"inventory_location\": {\n          \"name\": \"Location 2\",\n          \"code\": \"location_2\",\n          \"external_code\":\"external_location_2\",\n          \"street_line_1\": \"1 First St\",\n          \"city\": \"Sydney\",\n          \"state_or_region\": \"NSW\",\n          \"country_code\": \"AU\",\n          \"post_code\": \"2000\",\n          \"inventory_sources\": [\n              {\n                  \"name\": \"MOTUL\"\n              }\n          ],\n          \"business_hours\": [\n              {\n                  \"day\": \"monday\",\n                  \"day_name\": \"Monday\",\n                  \"open_time\": \"09:00:00\",\n                  \"close_time\": \"17:00:00\"\n              },\n              {\n                  \"day\": \"tuesday\",\n                  \"day_name\": \"Tuesday\",\n                  \"open_time\": \"09:00:00\",\n                  \"close_time\": \"17:00:00\"\n              },\n              {\n                  \"day\": \"wednesday\",\n                  \"day_name\": \"Wednesday\",\n                  \"open_time\": \"09:00:00\",\n                  \"close_time\": \"17:00:00\"\n              },\n              {\n                  \"day\": \"thursday\",\n                  \"day_name\": \"Thursday\",\n                  \"open_time\": \"09:00:00\",\n                  \"close_time\": \"17:00:00\"\n              },\n              {\n                  \"day\": \"friday\",\n                  \"day_name\": \"Friday\",\n                  \"open_time\": \"09:00:00\",\n                  \"close_time\": \"17:00:00\"\n              },\n              {\n                  \"day\": \"saturday\"\n              },\n              {\n                  \"day\": \"sunday\"\n              },\n              {\n                  \"business_hour_type\": \"special\",\n                  \"special_date\": \"2018-12-25T00:00:00.000+11:00\",\n                  \"day_name\": \"Christmas Day\",\n                  \"closed\": true\n              }\n          ],\n          \"entity_identifiers\": [\n            {\n              \"key\": \"10000000001\",\n              \"name\": \"Channel Name\"\n            },\n            {\n              \"key\": \"20000000002\",\n              \"name\": \"Channel Name\"\n            }\n          ]\n      }\n  }\n\nresponse:\n  {\n    \"id\": 3,\n    \"street_line_1\": \"1 First St\",\n    \"street_line_2\": null,\n    \"city\": \"Sydney\",\n    \"state_or_region\": \"NSW\",\n    \"country_code\": \"AU\",\n    \"post_code\": \"2000\",\n    \"timezone\": null,\n    \"latitude\": null,\n    \"longitude\": null,\n    \"name\": \"Location 2\",\n    \"support_pickup\": null,\n    \"ship_from_store\": null,\n    \"code\": \"location_2\",\n    \"external_code\":\"external_location_2\",\n    \"phone\": null,\n    \"pickup_instructions\": null,\n    \"website_url\": null,\n    \"utc_offset\": null,\n    \"discontinued\": false,\n    \"business_hours\": [\n      {\n        \"id\": 34,\n        \"day\": \"monday\",\n        \"day_name\": \"Monday\",\n        \"business_hour_type\": \"normal\",\n        \"special_date\": null,\n        \"closed\": null,\n        \"day_value\": 1,\n        \"open\": \"09:00:00\",\n        \"close\": \"17:00:00\"\n      },\n      {\n        \"id\": 35,\n        \"day\": \"tuesday\",\n        \"day_name\": \"Tuesday\",\n        \"business_hour_type\": \"normal\",\n        \"special_date\": null,\n        \"closed\": null,\n        \"day_value\": 2,\n        \"open\": \"09:00:00\",\n        \"close\": \"17:00:00\"\n      },\n      {\n        \"id\": 36,\n        \"day\": \"wednesday\",\n        \"day_name\": \"Wednesday\",\n        \"business_hour_type\": \"normal\",\n        \"special_date\": null,\n        \"closed\": null,\n        \"day_value\": 3,\n        \"open\": \"09:00:00\",\n        \"close\": \"17:00:00\"\n      },\n      {\n        \"id\": 37,\n        \"day\": \"thursday\",\n        \"day_name\": \"Thursday\",\n        \"business_hour_type\": \"normal\",\n        \"special_date\": null,\n        \"closed\": null,\n        \"day_value\": 4,\n        \"open\": \"09:00:00\",\n        \"close\": \"17:00:00\"\n      },\n      {\n        \"id\": 38,\n        \"day\": \"friday\",\n        \"day_name\": \"Friday\",\n        \"business_hour_type\": \"normal\",\n        \"special_date\": null,\n        \"closed\": null,\n        \"day_value\": 5,\n        \"open\": \"09:00:00\",\n        \"close\": \"17:00:00\"\n      },\n      {\n        \"id\": 39,\n        \"day\": \"saturday\",\n        \"day_name\": \"Saturday\",\n        \"business_hour_type\": \"normal\",\n        \"special_date\": null,\n        \"closed\": null,\n        \"day_value\": 6,\n        \"open\": \"00:00:00\",\n        \"close\": \"00:00:00\"\n      },\n      {\n        \"id\": 40,\n        \"day\": \"sunday\",\n        \"day_name\": \"Sunday\",\n        \"business_hour_type\": \"normal\",\n        \"special_date\": null,\n        \"closed\": null,\n        \"day_value\": 7,\n        \"open\": \"00:00:00\",\n        \"close\": \"00:00:00\"\n      },\n      {\n        \"id\": 41,\n        \"day\": null,\n        \"day_name\": \"Christmas Day\",\n        \"business_hour_type\": \"special\",\n        \"special_date\": \"2018-12-25T00:00:00.000+11:00\",\n        \"closed\": true,\n        \"day_value\": null,\n        \"open\": \"00:00:00\",\n        \"close\": \"00:00:00\"\n      }\n    ],\n    \"inventory_sources\": [\n      {\n        \"id\": 1,\n        \"name\": \"MOTUL\"\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/inventory_locations/update","name":"update","apis":[{"api_url":"/api/v2/inventory_locations/:id","http_method":"PUT","short_description":"Update an inventory location","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":"inventory_location","full_name":"inventory_location","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"inventory_location[name]","description":"\n\u003cp\u003eName of the inventory location\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":"code","full_name":"inventory_location[code]","description":"\n\u003cp\u003eCode of the inventory location\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":"inventory_location[external_code]","description":"\n\u003cp\u003eExternal code of the inventory location\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"inventory_location[status]","description":"\n\u003cp\u003eStatus of the inventory location\u003c/p\u003e\n","required":false,"allow_nil":true,"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":"street_line_1","full_name":"inventory_location[street_line_1]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"street_line_2","full_name":"inventory_location[street_line_2]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"city","full_name":"inventory_location[city]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"state_or_region","full_name":"inventory_location[state_or_region]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"country_code","full_name":"inventory_location[country_code]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"post_code","full_name":"inventory_location[post_code]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"inventory_location[timezone]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"longitude","full_name":"inventory_location[longitude]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pickup_instructions","full_name":"inventory_location[pickup_instructions]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"website_url","full_name":"inventory_location[website_url]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"support_pickup","full_name":"inventory_location[support_pickup]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ship_from_store","full_name":"inventory_location[ship_from_store]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag_list","full_name":"inventory_location[tag_list]","description":"\n\u003cp\u003eList of tags for this inventory location\u003c/p\u003e\n","required":false,"allow_nil":true,"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_location[inventory_source_ids]","description":"\n\u003cp\u003eList of inventory source IDs that the inventory location belongs to. Do not provide if ‘inventory_sources’ is provided\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of Integer","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"inventory_sources","full_name":"inventory_location[inventory_sources]","description":"\n\u003cp\u003eList of inventory sources that the inventory location belongs to. Do not provide if ‘product_level_ids’ is provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"inventory_location[inventory_sources][name]","description":"\n\u003cp\u003eName of the inventory source\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"delete","full_name":"inventory_location[inventory_sources][delete]","description":"\n\u003cp\u003eRemove this inventory location from the associations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"business_hours","full_name":"inventory_location[business_hours]","description":"\n\u003cp\u003eList of business hours that the inventory location has\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"day","full_name":"inventory_location[business_hours][day]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003emonday\u003c/code\u003e, \u003ccode\u003etuesday\u003c/code\u003e, \u003ccode\u003ewednesday\u003c/code\u003e, \u003ccode\u003ethursday\u003c/code\u003e, \u003ccode\u003efriday\u003c/code\u003e, \u003ccode\u003esaturday\u003c/code\u003e, \u003ccode\u003esunday\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"day_name","full_name":"inventory_location[business_hours][day_name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"business_hour_type","full_name":"inventory_location[business_hours][business_hour_type]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enormal\u003c/code\u003e, \u003ccode\u003especial\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"special_date","full_name":"inventory_location[business_hours][special_date]","description":"\n\u003cp\u003eValid special_date. ISO_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":"closed","full_name":"inventory_location[business_hours][closed]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"open_time","full_name":"inventory_location[business_hours][open_time]","description":"\n\u003cp\u003eDon’t supply value if it is not open on this day. E.g. ‘09:00:00’\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":"close_time","full_name":"inventory_location[business_hours][close_time]","description":"\n\u003cp\u003eDon’t supply value if it is not open on this day. E.g. ‘17:00:00’\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":["request:\n  {\n      \"inventory_location\": {\n          \"name\": \"Location 2 Updated\",\n          \"business_hours\": [\n              {\n                  \"day\": \"monday\",\n                  \"day_name\": \"Monday\",\n                  \"open_time\": \"09:00:00\",\n                  \"close_time\": \"18:00:00\"\n              },\n              {\n                  \"special_date\": \"2018-12-15T00:00:00.000+11:00\",\n                  \"day_name\": \"Christmas Day 1\"\n              }\n          ]\n      }\n  }\n\nresponse:\n  {\n    \"id\": 3,\n    \"street_line_1\": \"1 First St\",\n    \"street_line_2\": null,\n    \"city\": \"Sydney\",\n    \"state_or_region\": \"NSW\",\n    \"country_code\": \"AU\",\n    \"post_code\": \"2000\",\n    \"timezone\": null,\n    \"latitude\": null,\n    \"longitude\": null,\n    \"name\": \"Location 2 Updated\",\n    \"support_pickup\": null,\n    \"ship_from_store\": null,\n    \"code\": \"location_2\",\n    \"external_code\":\"external_location_2\",\n    \"phone\": null,\n    \"pickup_instructions\": null,\n    \"website_url\": null,\n    \"utc_offset\": null,\n    \"discontinued\": false,\n    \"business_hours\": [\n      {\n        \"id\": 34,\n        \"day\": \"monday\",\n        \"day_name\": \"Monday\",\n        \"business_hour_type\": \"normal\",\n        \"special_date\": null,\n        \"closed\": null,\n        \"day_value\": 1,\n        \"open\": \"09:00:00\",\n        \"close\": \"18:00:00\"\n      },\n      {\n        \"id\": 35,\n        \"day\": \"tuesday\",\n        \"day_name\": \"Tuesday\",\n        \"business_hour_type\": \"normal\",\n        \"special_date\": null,\n        \"closed\": null,\n        \"day_value\": 2,\n        \"open\": \"09:00:00\",\n        \"close\": \"17:00:00\"\n      },\n      {\n        \"id\": 36,\n        \"day\": \"wednesday\",\n        \"day_name\": \"Wednesday\",\n        \"business_hour_type\": \"normal\",\n        \"special_date\": null,\n        \"closed\": null,\n        \"day_value\": 3,\n        \"open\": \"09:00:00\",\n        \"close\": \"17:00:00\"\n      },\n      {\n        \"id\": 37,\n        \"day\": \"thursday\",\n        \"day_name\": \"Thursday\",\n        \"business_hour_type\": \"normal\",\n        \"special_date\": null,\n        \"closed\": null,\n        \"day_value\": 4,\n        \"open\": \"09:00:00\",\n        \"close\": \"17:00:00\"\n      },\n      {\n        \"id\": 38,\n        \"day\": \"friday\",\n        \"day_name\": \"Friday\",\n        \"business_hour_type\": \"normal\",\n        \"special_date\": null,\n        \"closed\": null,\n        \"day_value\": 5,\n        \"open\": \"09:00:00\",\n        \"close\": \"17:00:00\"\n      },\n      {\n        \"id\": 39,\n        \"day\": \"saturday\",\n        \"day_name\": \"Saturday\",\n        \"business_hour_type\": \"normal\",\n        \"special_date\": null,\n        \"closed\": null,\n        \"day_value\": 6,\n        \"open\": \"00:00:00\",\n        \"close\": \"00:00:00\"\n      },\n      {\n        \"id\": 40,\n        \"day\": \"sunday\",\n        \"day_name\": \"Sunday\",\n        \"business_hour_type\": \"normal\",\n        \"special_date\": null,\n        \"closed\": null,\n        \"day_value\": 7,\n        \"open\": \"00:00:00\",\n        \"close\": \"00:00:00\"\n      },\n      {\n        \"id\": 41,\n        \"day\": null,\n        \"day_name\": \"Christmas Day 1\",\n        \"business_hour_type\": \"special\",\n        \"special_date\": \"2018-12-25T00:00:00.000+11:00\",\n        \"closed\": true,\n        \"day_value\": null,\n        \"open\": \"00:00:00\",\n        \"close\": \"00:00:00\"\n      }\n    ],\n    \"inventory_sources\": [\n      {\n        \"id\": 1,\n        \"name\": \"MOTUL\"\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/inventory_locations/destroy","name":"destroy","apis":[{"api_url":"/api/v2/inventory_locations/:id","http_method":"DELETE","short_description":"Delete an inventory location","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\": 3\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"inventory_sources":{"doc_url":"/apidoc/2.0/inventory_sources","id":"inventory_sources","api_url":"/api","name":"Inventory sources","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;id\u0026quot;: 1,\n  \u0026quot;name\u0026quot;: \u0026quot;Warehouse 1\u0026quot;,\n  \u0026quot;support_shipping\u0026quot;: true,\n  \u0026quot;inventory_locations\u0026quot;: [\n    {\n      \u0026quot;id\u0026quot;: 1,\n      \u0026quot;name\u0026quot;: \u0026quot;Location 1\u0026quot;\n    }\n  ]\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/inventory_sources/index","name":"index","apis":[{"api_url":"/api/v2/inventory_sources","http_method":"GET","short_description":"List inventory sources","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":[]}],"returns":[],"examples":["Response:\n  {\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 1,\n    \"entries\": [\n      {\n        \"id\": 1,\n        \"name\": \"Warehouse 1\",\n        \"support_shipping\": true,\n        \"inventory_locations\": [\n          {\n            \"id\": 1,\n            \"name\": \"Location 1\"\n          }\n        ]\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/inventory_sources/create","name":"create","apis":[{"api_url":"/api/v2/inventory_sources","http_method":"POST","short_description":"Create an inventory source","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":"inventory_source","full_name":"inventory_source","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"inventory_source[name]","description":"\n\u003cp\u003eName of the inventory source\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"support_shipping","full_name":"inventory_source[support_shipping]","description":"\n\u003cp\u003eIndicate whether this inventory source support online order delivery\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag_list","full_name":"inventory_source[tag_list]","description":"\n\u003cp\u003eList of tags for this inventory source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"inventory_location_ids","full_name":"inventory_source[inventory_location_ids]","description":"\n\u003cp\u003eList of inventory location IDs that the inventory source has. Do not provide if ‘inventory_locations’ is provided\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of Integer","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"inventory_locations","full_name":"inventory_source[inventory_locations]","description":"\n\u003cp\u003eList of inventory locationss that the inventory source has. Do not provide if ‘inventory_location_ids’ is provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"inventory_source[inventory_locations][name]","description":"\n\u003cp\u003eName of the inventory location\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":"code","full_name":"inventory_source[inventory_locations][code]","description":"\n\u003cp\u003eCode of the inventory location\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":"delete","full_name":"inventory_source[inventory_locations][delete]","description":"\n\u003cp\u003eRemove this inventory location from the associations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}]}],"returns":[],"examples":["request:\n  {\n      \"inventory_source\": {\n          \"name\": \"Warehouse 1\",\n          \"support_shipping\": true,\n          \"inventory_locations\": [\n              {\"name\": \"Location 1\"}\n          ]\n      }\n  }\n\nresponse:\n  {\n    \"id\": 2,\n    \"name\": \"Warehouse 1\",\n    \"support_shipping\": true,\n    \"inventory_locations\": [\n      {\n        \"id\": 1,\n        \"name\": \"Location 1\"\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/inventory_sources/update","name":"update","apis":[{"api_url":"/api/v2/inventory_sources/:id","http_method":"PUT","short_description":"Update an inventory source","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":"inventory_source","full_name":"inventory_source","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"inventory_source[name]","description":"\n\u003cp\u003eName of the inventory source\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":"support_shipping","full_name":"inventory_source[support_shipping]","description":"\n\u003cp\u003eIndicate whether this inventory source support online order delivery\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag_list","full_name":"inventory_source[tag_list]","description":"\n\u003cp\u003eList of tags for this inventory source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"inventory_location_ids","full_name":"inventory_source[inventory_location_ids]","description":"\n\u003cp\u003eList of inventory location IDs that the inventory source has. Do not provide if ‘inventory_locations’ is provided\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of Integer","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"inventory_locations","full_name":"inventory_source[inventory_locations]","description":"\n\u003cp\u003eList of inventory locationss that the inventory source has. Do not provide if ‘inventory_location_ids’ is provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"inventory_source[inventory_locations][name]","description":"\n\u003cp\u003eName of the inventory location\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":"code","full_name":"inventory_source[inventory_locations][code]","description":"\n\u003cp\u003eCode of the inventory location\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":"delete","full_name":"inventory_source[inventory_locations][delete]","description":"\n\u003cp\u003eRemove this inventory location from the associations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}]}],"returns":[],"examples":["request:\n  {\n      \"inventory_source\": {\n          \"name\": \"Warehouse 1 Updated\",\n          \"inventory_locations\": [\n              {\"name\": \"Location 1\", \"delete\": true}\n          ]\n      }\n  }\n\nresponse:\n  {\n    \"id\": 2,\n    \"name\": \"Warehouse 1 Updated\",\n    \"support_shipping\": true,\n    \"inventory_locations\": []\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/inventory_sources/destroy","name":"destroy","apis":[{"api_url":"/api/v2/inventory_sources/:id","http_method":"DELETE","short_description":"Delete an inventory source","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\": 2\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"jobs":{"doc_url":"/apidoc/2.0/jobs","id":"jobs","api_url":"/api","name":"Jobs","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;id\u0026quot;: 42,\n  \u0026quot;request_id\u0026quot;: \u0026quot;3ca34bed-13e3-436c-a966-2dce39b88e94\u0026quot;,\n  \u0026quot;entity\u0026quot;: \u0026quot;Product\u0026quot;,\n  \u0026quot;status\u0026quot;: \u0026quot;complete\u0026quot;,\n  \u0026quot;percent_completed\u0026quot;: 1,\n  \u0026quot;operation\u0026quot;: \u0026quot;upsert\u0026quot;,\n  \u0026quot;created_at\u0026quot;: \u0026quot;2016-05-31T10:18:28.752+10:00\u0026quot;,\n  \u0026quot;updated_at\u0026quot;: \u0026quot;2016-05-31T10:18:30.892+10:00\u0026quot;,\n  \u0026quot;created_by\u0026quot;: \u0026quot;test@fusionfactory.com\u0026quot;,\n  \u0026quot;error_count\u0026quot;: 0,\n  \u0026quot;result\u0026quot;: \u0026quot;Success\u0026quot;\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/jobs/create","name":"create","apis":[{"api_url":"/api/v2/jobs","http_method":"POST","short_description":"Create a bulk job","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":"job","full_name":"job","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"entity","full_name":"job[entity]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eAttributeDefinition\u003c/code\u003e, \u003ccode\u003eOptionValue\u003c/code\u003e, \u003ccode\u003eAttributeSet\u003c/code\u003e, \u003ccode\u003eBrand\u003c/code\u003e, \u003ccode\u003eCatalog\u003c/code\u003e, \u003ccode\u003eCategorySet\u003c/code\u003e, \u003ccode\u003eCategory\u003c/code\u003e, \u003ccode\u003eDimension\u003c/code\u003e, \u003ccode\u003eInventoryLocation\u003c/code\u003e, \u003ccode\u003eInventorySource\u003c/code\u003e, \u003ccode\u003eInventory\u003c/code\u003e, \u003ccode\u003eKitSku\u003c/code\u003e, \u003ccode\u003eMediaItem\u003c/code\u003e, \u003ccode\u003ePriceBook\u003c/code\u003e, \u003ccode\u003ePriceItem\u003c/code\u003e, \u003ccode\u003eProductLevel\u003c/code\u003e, \u003ccode\u003eProduct\u003c/code\u003e, \u003ccode\u003eVirtualProduct\u003c/code\u003e, \u003ccode\u003eBusinessHour\u003c/code\u003e, \u003ccode\u003eProductCategory\u003c/code\u003e, \u003ccode\u003eProductCatalog\u003c/code\u003e, \u003ccode\u003eCarrier\u003c/code\u003e, \u003ccode\u003eShippingService\u003c/code\u003e, \u003ccode\u003eFreightRate\u003c/code\u003e, \u003ccode\u003eShippingZone\u003c/code\u003e, \u003ccode\u003eVariant\u003c/code\u003e, \u003ccode\u003eSku\u003c/code\u003e, \u003ccode\u003eProductClass\u003c/code\u003e, \u003ccode\u003eProductVariation\u003c/code\u003e, \u003ccode\u003eProductGroup\u003c/code\u003e, \u003ccode\u003eProductKit\u003c/code\u003e, \u003ccode\u003eEntityIdentifier\u003c/code\u003e, \u003ccode\u003eAliasProduct\u003c/code\u003e, \u003ccode\u003eAttributeGroup\u003c/code\u003e, \u003ccode\u003eProductFamily\u003c/code\u003e, \u003ccode\u003eProductFamilyAttributeGroup\u003c/code\u003e, \u003ccode\u003eNpcEntity\u003c/code\u003e, \u003ccode\u003eSharedReference\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operation","full_name":"job[operation]","description":"\n\u003cp\u003eOperation for the job\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eupsert\u003c/code\u003e, \u003ccode\u003einsert\u003c/code\u003e, \u003ccode\u003eupdate\u003c/code\u003e, \u003ccode\u003edelete\u003c/code\u003e, \u003ccode\u003ereset\u003c/code\u003e, \u003ccode\u003eincrement\u003c/code\u003e, \u003ccode\u003epurge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"options","full_name":"job[options]","description":"\n\u003cp\u003eOptions for the job\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"object_in_response","full_name":"job[options][object_in_response]","description":"\n\u003cp\u003eDefault: true. Set this to false to not include object details in the job response.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"data","full_name":"job[data]","description":"\n\u003cp\u003eArray of hash data. The scheme of the data is the same as the corresponding REST API. _request_data_id (optional) can be included to associate response with the entity data.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"lang","full_name":"lang","description":"\n\u003cp\u003eThe language code to which translatable fields are saved against.\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":["request:\n  {\n    \"job\": {\n      \"entity\": \"Product\",\n      \"operation\": \"upsert\",\n      \"options\": {\n          \"object_in_response\": false\n      },\n      \"data\": [\n        {\n          \"_request_data_id\": \"7y3k9iuye6\",\n          \"product_type\": \"product\",\n          \"code\": \"12345\",\n          \"status\": \"active\",\n          \"name\": \"Product 12345\",\n          \"attribute_set\": \"Automotive\",\n        }\n      ]\n    }\n  }\n\nresponse:\n  {\n    \"id\": 429,\n    \"request_id\": \"2e2b36a6-e6f7-42ae-a388-e53bfa2626be\",\n    \"entity\": \"Product\",\n    \"format\": \"json\",\n    \"status\": \"ready_to_process\",\n    \"percent_completed\": 0,\n    \"file_name\": null,\n    \"operation\": \"insert\",\n    \"created_at\": \"2016-05-30T14:55:57.316+10:00\",\n    \"updated_at\": \"2016-05-30T14:55:57.429+10:00\",\n    \"sidekiq_job_id\": \"2f8717aec0a079b0afcc13fc\",\n    \"created_by\": \"test@fusionfactory.com\",\n    \"error_count\": 0,\n    \"import_method\": \"api\",\n    \"file_upload_id\": null\n  }\n\nSample: Reset price items in the specified price book for the product. (the old price items will be removed)\n  {\n    \"job\": {\n      \"entity\": \"PriceItem\",\n      \"operation\": \"reset\",\n      \"options\": {\n          \"object_in_response\": false\n      },\n      \"data\": [\n        {\n          \"amount\": 12,\n          \"from\": \"2016-07-05T09:00:00.000+10:00\",\n          \"to\": \"2016-07-08T09:00:00.000+10:00\",\n          \"product_id\": 6,\n          \"price_book_id\": 1\n        }\n      ]\n    }\n  }\n  Or\n  {\n    \"job\": {\n      \"entity\": \"PriceBook\",\n      \"operation\": \"reset\",\n      \"options\": {\n          \"object_in_response\": false\n      },\n      \"data\": [\n        {\n          \"id\": 1,\n          \"products\": [\n            {\n              \"id\": 28,\n              \"price_items\": [\n                {\n                  \"amount\": 14,\n                  \"from\": \"2016-07-05T09:00:00.000+10:00\",\n                  \"to\": \"2016-07-08T09:00:00.000+10:00\"\n                },\n                {\n                  \"amount\": 1\n                }\n              ]\n            }\n          ]\n        }\n      ]\n    }\n  }\n  Or we can use PriceBook Name and product code instead of IDs.\n  {\n    \"job\": {\n      \"entity\": \"PriceBook\",\n      \"operation\": \"reset\",\n      \"options\": {\n          \"object_in_response\": false\n      },\n      \"data\": [\n        {\n          \"name\": \"default\",\n          \"products\": [\n            {\n              \"code\": \"product_1\",\n              \"price_items\": [\n                {\n                  \"amount\": 14,\n                  \"from\": \"2016-07-05T09:00:00.000+10:00\",\n                  \"to\": \"2016-07-08T09:00:00.000+10:00\"\n                },\n                {\n                  \"amount\": 1\n                }\n              ]\n            }\n          ]\n        }\n      ]\n    }\n  }\n\n\nSample:\nDelete price items by product and price book. operation=purge is only applicable for PriceItem at this stage.\nAll price items for the given product and price book will be removed.\n{\n  \"job\": {\n    \"entity\": \"PriceItem\",\n    \"operation\": \"purge\",\n    \"options\": {\n        \"object_in_response\": false\n    },\n    \"data\": [\n      {\n      \t\"product_code\": \"1000-INK-SIL\",\n      \t\"price_book_name\": \"AUD Sale\"\n      },\n      {\n      \t\"product_id\": 1367,\n      \t\"price_book_id\": 1\n      }\n    ]\n  }\n}\n\nSample: Reset product variation for the child product.\n  {\n    \"job\": {\n      \"entity\": \"ProductVariation\",\n      \"operation\": \"reset\",\n      \"options\": {\n          \"object_in_response\": false\n      },\n      \"data\": [\n        {\n          \"parent_id\": 8,\n          \"child_id\": 7\n        }\n      ]\n    }\n  }\n  Or\n  {\n    \"job\": {\n      \"entity\": \"ProductVariation\",\n      \"operation\": \"reset\",\n      \"options\": {\n          \"object_in_response\": false\n      },\n      \"data\": [\n        {\n          \"parent_product_code\": \"Product-ABC\",\n          \"child_product_code\": \"Product-ABC-variation-1\"\n        }\n      ]\n    }\n  }\n\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/jobs/index","name":"index","apis":[{"api_url":"/api/v2/jobs","http_method":"GET","short_description":"List 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":"id","full_name":"id","description":"\n\u003cp\u003eID of the job\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":"request_id","full_name":"request_id","description":"\n\u003cp\u003eRequest ID of the job\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_by","full_name":"created_by","description":"\n\u003cp\u003eThe submitter of the job\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_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":[]}],"returns":[],"examples":["response:\n{\n  \"page\": 1,\n  \"per_page\": 50,\n  \"total_pages\": 1,\n  \"total_entries\": 1,\n  \"entries\": [\n    {\n      \"id\": 429,\n      \"request_id\": \"2e2b36a6-e6f7-42ae-a388-e53bfa2626be\",\n      \"entity\": \"Category\",\n      \"status\": \"complete\",\n      \"percent_completed\": 1,\n      \"operation\": \"insert\",\n      \"created_at\": \"2016-05-30T14:55:57.316+10:00\",\n      \"updated_at\": \"2016-05-30T14:55:58.671+10:00\",\n      \"created_by\": \"test@fusionfactory.com\",\n      \"error_count\": 0,\n      \"result\": \"Success\"\n    }\n  ]\n}\n\nstatus:\n\nrequest_received - job request received but not yet scheduled to run\nfail_to_receive - the job payload/format is not acceptable\nready_to_process - job is scheduled to process\nprocessing - job is being processed\nfail_to_process - exception happened during processing the job\ncanceled - job aborted\ncomplete - job processing is completed\n\nresult:\n\nSuccess - job completed without error\nFailure - job completed with error or the job status is fail_to_receive or fail_to_process\nPending - result not yet available (job not completed)\n\n\n\n\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/jobs/show","name":"show","apis":[{"api_url":"/api/v2/jobs/:id","http_method":"GET","short_description":"Get the job details","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":"id","full_name":"id","description":"\n\u003cp\u003eJob ID\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":["response:\n{\n  \"id\": 429,\n  \"request_id\": \"2e2b36a6-e6f7-42ae-a388-e53bfa2626be\",\n  \"entity\": \"Category\",\n  \"status\": \"complete\",\n  \"percent_completed\": 1,\n  \"operation\": \"insert\",\n  \"created_at\": \"2016-05-30T14:55:57.316+10:00\",\n  \"updated_at\": \"2016-05-30T14:55:58.671+10:00\",\n  \"created_by\": \"test@fusionfactory.com\",\n  \"error_count\": 0,\n  \"result\": \"Success\",\n  \"processing_details\": [\n    {\n      \"errors\": [],\n      \"id\": 327,\n      \"category\": {\n        ...\n      }\n    },\n    {\n      \"_request_data_id\": \"7y3k9iuye6\",\n      \"errors\": [],\n      \"id\": 330,\n      \"category\": {\n        ...\n      }\n    },\n    {\n      \"errors\": [],\n      \"id\": 333,\n      \"category\": {\n        ...\n      }\n    }\n  ]\n}\n\nprocessing_details:\n\nid - the object ID generated by CommerceConnect. Save this ID in the client and use it to refer to the object in other APIs.\nerrors - errors during processing the job\n_request_data_id - the same value passed in the payload. Use this value to identify the individual element if needed (for example, in the case of failing to create object)\n%entity% - the hash version of the object. This is similar to the response from GET /api/v2/:entity . If this is not needed, we suggest to set job[options][object_in_response] to false when posting the job.\n\n\n\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"languages":{"doc_url":"/apidoc/2.0/languages","id":"languages","api_url":"/api","name":"Languages","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003e      Example:\n{\n  \u0026quot;id\u0026quot;: 1,\n  \u0026quot;name\u0026quot;: \u0026quot;AU English\u0026quot;\n  \u0026quot;code\u0026quot;: \u0026quot;en\u0026quot;\n  \u0026quot;fallback\u0026quot;: \u0026quot;en\u0026quot;\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/languages/index","name":"index","apis":[{"api_url":"/api/v2/languages","http_method":"GET","short_description":"List languages","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":[]}],"returns":[],"examples":["Response:\n  {\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 1,\n    \"entries\": [\n      {\n\t    \"id\": 1,\n\t    \"name\": \"AU English\"\n\t    \"code\": \"en\"\n\t    \"fallback\": \"en\"\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"lookups":{"doc_url":"/apidoc/2.0/lookups","id":"lookups","api_url":"/api","name":"Lookups","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;id\u0026quot;: 1,\n  \u0026quot;name\u0026quot;: \u0026quot;Colors\u0026quot;,\n  \u0026quot;columns\u0026quot;: [\u0026quot;Color\u0026quot;, \u0026quot;Color Family\u0026quot;]\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/lookups/index","name":"index","apis":[{"api_url":"/api/v2/lookups","http_method":"GET","short_description":"List lookups","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":"lang","full_name":"lang","description":"\n\u003cp\u003eLanguage code for translated value\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\": 1,\n    \"entries\": [\n      {\n        \"id\": 1,\n        \"name\": \"Colors\",\n        \"columns\": [\"Color\", \"Color Family\"]\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/lookups/create","name":"create","apis":[{"api_url":"/api/v2/lookups","http_method":"POST","short_description":"Create an lookup","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":"lookup","full_name":"lookup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"lookup[name]","description":"\n\u003cp\u003eName of the lookup\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"columns","full_name":"lookup[columns]","description":"\n\u003cp\u003eColumn names\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"rows","full_name":"lookup[rows]","description":"\n\u003cp\u003eLookup rows\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"values","full_name":"lookup[rows][values]","description":"\n\u003cp\u003eRow values\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]}]}]}],"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    \"columns\": [\"Color\",\"Color Family\"]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/lookups/update","name":"update","apis":[{"api_url":"/api/v2/lookups/:id","http_method":"PUT","short_description":"Update an lookup","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":"lookup","full_name":"lookup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"lookup[name]","description":"\n\u003cp\u003eName of the lookup\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":"columns","full_name":"lookup[columns]","description":"\n\u003cp\u003eColumn names\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"rows","full_name":"lookup[rows]","description":"\n\u003cp\u003eLookup rows\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"values","full_name":"lookup[rows][values]","description":"\n\u003cp\u003eRow values\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]}]}]}],"returns":[],"examples":["request:\n  {\n    \"lookup\": {\n        \"name\": \"Colors Updated\",\n        \"rows\": [\n            {\"values\": [\"White\", \"white\"]},\n            {\"values\": [\"Black\", \"black\"]}\n        ]\n    }\n  }\n\nresponse:\n  {\n    \"id\": 1,\n    \"name\": \"Colors Updated\",\n    \"columns\": [\"Color\",\"Color Family\"]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/lookups/destroy","name":"destroy","apis":[{"api_url":"/api/v2/lookups/:id","http_method":"DELETE","short_description":"Delete an lookup","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},{"doc_url":"/apidoc/2.0/lookups/search","name":"search","apis":[{"api_url":"/api/v2/lookups/:id/search","http_method":"POST","short_description":"Lookup the rows by given column values","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    \"conditions\": [\n        {\"column\": \"Color\", \"value\": \"Red\"}\n    ]\n  }\n\nresponse:\n  {\n    \"id\": 1,\n    \"name\": \"Colors\",\n    \"rows\": [{\"Color\": \"Red\", \"Color Family\": \"red\"}]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/lookups/show","name":"show","apis":[{"api_url":"/api/v2/lookups/:id","http_method":"GET","short_description":"Lookup by id","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    \"name\": \"Colors\",\n    \"rows\": [{\"Color\": \"Red\", \"Color Family\": \"red\"}]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"media_items":{"doc_url":"/apidoc/2.0/media_items","id":"media_items","api_url":"/api","name":"Media items","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;id\u0026quot;: 14,\n  \u0026quot;media_item_type\u0026quot;: \u0026quot;ImageMediaItem\u0026quot;,\n  \u0026quot;url\u0026quot;: \u0026quot;http://images.asos-media.com/inv/media/0/0/3/2/3882300/white/image2xxl.jpg\u0026quot;,\n  \u0026quot;description\u0026quot;: \u0026quot;image description\u0026quot;,\n  \u0026quot;position\u0026quot;: 1,\n  \u0026quot;is_primary\u0026quot;: true,\n  \u0026quot;is_uploaded\u0026quot;: null,\n  \u0026quot;product_id\u0026quot;: 9,\n  \u0026quot;etag\u0026quot;: \u0026quot;939e4638c1207407f8a2d332eb3fa8e4\u0026quot;,\n  \u0026quot;tag_list\u0026quot;: [\n    \u0026quot;lady\u0026#39;s\u0026quot;\n  ]\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/media_items/index","name":"index","apis":[{"api_url":"/api/v2/media_items","http_method":"GET","short_description":"List media_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":"response_associated_fields","full_name":"response_associated_fields","description":"\n\u003cp\u003eOne of ‘attribute_values, association_attribute_values’. The information related to the media item to be included in the media item data response. Use comma to join multiple fields.\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\": 1,\n    \"entries\": [\n      {\n        \"id\": 14,\n        \"media_item_type\": \"ImageMediaItem\",\n        \"url\": \"http://images.asos-media.com/inv/media/0/0/3/2/3882300/white/image2xxl.jpg\",\n        \"description\": \"image description\",\n        \"sort_order\": 1048576,\n        \"is_primary\": true,\n        \"is_uploaded\": null,\n        \"product_id\": 9,\n        \"position\": 1,\n        \"tag_list\": [\n          \"lady's\"\n        ]\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/media_items/create","name":"create","apis":[{"api_url":"/api/v2/media_items","http_method":"POST","short_description":"Create a media_item","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":"media_item","full_name":"media_item","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"media_item_type","full_name":"media_item[media_item_type]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eImageMediaItem\u003c/code\u003e, \u003ccode\u003eVideoMediaItem\u003c/code\u003e, \u003ccode\u003eFileMediaItem\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"media_item[product_id]","description":"\n\u003cp\u003eProduct ID. Required if assigning media item to product and product_code is not provided\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_code","full_name":"media_item[product_code]","description":"\n\u003cp\u003eProduct Code. Required if assigning media item to product and product_id is not provided\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"associated_type","full_name":"media_item[associated_type]","description":"\n\u003cp\u003eAssociated entity class name. Required if assigning media item to entity other than product like Npc Entity, Category\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNpcEntity\u003c/code\u003e, \u003ccode\u003eCategory\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"associated_id","full_name":"media_item[associated_id]","description":"\n\u003cp\u003eAssociated entity ID.  Required if assigning media item to entity other than product and associated_code is not provided\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"associated_code","full_name":"media_item[associated_code]","description":"\n\u003cp\u003eAssociated entity Code. Required if assigning media item to entity other than product and associated_id is not provided. Not supported for Category\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"media_item[url]","description":"\n\u003cp\u003eURL that stores the corresponding media item\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"media_item[description]","description":"\n\u003cp\u003eDescription for the media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order_position","full_name":"media_item[sort_order_position]","description":"\n\u003cp\u003eThis field is deprecated. Please use position instead\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"is_primary","full_name":"media_item[is_primary]","description":"\n\u003cp\u003eMake this media item as primary\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag_list","full_name":"media_item[tag_list]","description":"\n\u003cp\u003eTags for this media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"etag","full_name":"media_item[etag]","description":"\n\u003cp\u003eETag for the resource on the url\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"processing_options","full_name":"media_item[processing_options]","description":"\n\u003cp\u003eOptions to perform extra image processing on the media item. This is applicable only when media_item_type is ‘ImageMediaItem’\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"apply_background","full_name":"media_item[processing_options][apply_background]","description":"\n\u003cp\u003eSetting this to true would result in a new media item created against the product with background applied. Removes transparency.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"background_colour","full_name":"media_item[processing_options][background_colour]","description":"\n\u003cp\u003eThe colour name or a hex colour code for the background colour for the created media item. Defaults to white.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"processed_tags","full_name":"media_item[processing_options][processed_tags]","description":"\n\u003cp\u003eThe tags for the created media item.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"derived_media_items","full_name":"media_item[derived_media_items]","description":"\n\u003cp\u003eTransformations for this image\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"media_item[derived_media_items][name]","description":"\n\u003cp\u003eName for the transformation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"media_item[derived_media_items][url]","description":"\n\u003cp\u003eURL for the transformation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"position","full_name":"media_item[position]","description":"\n\u003cp\u003eSort order value. Warning: Drag and drop sorting from UI might change the position you have set.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attribute_values","full_name":"media_item[attribute_values]","description":"\n\u003cp\u003eAttribute values assigned to the Media Item.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n      \"media_item\": {\n          \"media_item_type\": \"ImageMediaItem\",\n          \"product_id\": 9,\n          \"url\": \"http://images.asos-media.com/inv/media/0/0/3/2/3882300/white/image.jpg\",\n          \"description\": \"image description\",\n          \"position\": 2,\n          \"is_primary\": true,\n          \"tag_list\": [\"lady's\"],\n          \"derived_media_items\": [\n          \t{\n          \t\t\"name\": \"crop\",\n          \t\t\"url\": \"http://images.asos-media.com/inv/media/0/0/3/2/3882300/white/image-crop.jpg\"\n          \t}\n          ],\n          \"attribute_values\": [\n            {\n                \"attribute_definition_id\": 16,\n                \"attribute_definition_code\": \"img_desc\",\n                \"data\": \"image description\"\n            }\n        ]\n\n      }\n  }\n\nSample: create a media item for Npc Entity with npc entity code\n{\n  \"media_item\": {\n      \"media_item_type\": \"ImageMediaItem\",\n      \"associated_type\": \"NpcEntity\",\n      \"associated_code\": \"cotton\",\n      \"url\": \"http://images.asos-media.com/inv/media/0/0/3/2/3882300/white/image.jpg\",\n      \"description\": \"image description\",\n      \"position\": 2\n      \"is_primary\": true,\n      \"tag_list\": [\"lady's\"],\n      \"derived_media_items\": [\n        {\n          \"name\": \"crop\",\n          \"url\": \"http://images.asos-media.com/inv/media/0/0/3/2/3882300/white/image-crop.jpg\"\n        }\n      ]\n  }\n}\n\nSample: create a media item for Category with category id\n{\n  \"media_item\": {\n      \"media_item_type\": \"ImageMediaItem\",\n      \"associated_type\": \"Category\",\n      \"associated_id\": 1,\n      \"url\": \"http://images.asos-media.com/inv/media/0/0/3/2/3882300/white/image.jpg\",\n      \"description\": \"image description\",\n      \"position\": 2\n      \"is_primary\": true,\n      \"tag_list\": [\"lady's\"]\n  }\n}\n\nSample: reset multi shared reference association\nSupported Mode:\n- upsert: default\n- reset: Delete all existing association for this attribute, and replace with the current one. Send empty array to remove all existing values.\n\n{\n  \"media_item\": {\n      \"media_item_type\": \"ImageMediaItem\",\n      \"product_id\": 9,\n      \"url\": \"http://images.asos-media.com/inv/media/0/0/3/2/3882300/white/image.jpg\",\n      \"attribute_values\": [\n        {\n            \"attribute_definition_id\": 16,\n            \"attribute_definition_code\": \"img_desc\",\n            \"data\": {\n              \"associated_code\": [\"code_1\", \"code_2\"]\n            }\n            \"mode\": \"reset\"\n        }\n    ]\n\n  }\n}\n\nresponse:\n  {\n    \"id\": 14,\n    \"media_item_type\": \"ImageMediaItem\",\n    \"url\": \"http://images.asos-media.com/inv/media/0/0/3/2/3882300/white/image2xxl.jpg\",\n    \"description\": \"image description\",\n    \"sort_order\": 1048576,\n    \"is_primary\": true,\n    \"is_uploaded\": null,\n    \"product_id\": 9,\n    \"tag_list\": [\n      \"lady's\"\n    ],\n    \"position\": 2\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/media_items/upload","name":"upload","apis":[{"api_url":"/api/v2/media_items/upload","http_method":"POST","short_description":"Create a media_item via binary upload. The request is a multipart/form-data and the response is json like other API calls.","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  curl --request POST         --url https://product.commerceconnect.co/api/v2/media_items/upload         --header 'authorization: Token token=YOUR_TOKEN,email=YOUR_EMAIL'         --header 'content-type: multipart/form-data;'         --form 'image_media_item[asset]=@test.png'         --form product_id=257         --form 'image_media_item[description]=Test'         --form 'image_media_item[sort_order_position]=1'         --form 'image_media_item[is_primary]=true'         --form 'image_media_item[tag_list]=test_tag'         --form 'image_media_item[position]=100'\n\nresponse:\n  {\n    \"id\": 968,\n    \"media_item_type\": \"ImageMediaItem\",\n    \"url\": \"http://s3-ap-southeast-2.amazonaws.com/fusionfactory.commerceconnect.localming6.local/pim_media/000/000/968/test.png?1487740669\",\n    \"description\": \"Test\",\n    \"sort_order\": 7340032,\n    \"is_primary\": true,\n    \"is_uploaded\": true,\n    \"product_id\": 257,\n    \"asset_file_name\": \"test.png\",\n    \"position\": 100,\n    \"tag_list\": [\n      \"test_tag\"\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/media_items/update","name":"update","apis":[{"api_url":"/api/v2/media_items/:id","http_method":"PUT","short_description":"Update a media_item","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":"media_item","full_name":"media_item","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"media_item_type","full_name":"media_item[media_item_type]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eImageMediaItem\u003c/code\u003e, \u003ccode\u003eVideoMediaItem\u003c/code\u003e, \u003ccode\u003eFileMediaItem\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"media_item[product_id]","description":"\n\u003cp\u003eProduct ID. Required if assigning media item to product and product_code is not provided\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_code","full_name":"media_item[product_code]","description":"\n\u003cp\u003eProduct Code. Required if assigning media item to product and product_id is not provided\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"associated_type","full_name":"media_item[associated_type]","description":"\n\u003cp\u003eAssociated entity class name. Required if assigning media item to entity other than product like Npc Entity, Category\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNpcEntity\u003c/code\u003e, \u003ccode\u003eCategory\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"associated_id","full_name":"media_item[associated_id]","description":"\n\u003cp\u003eAssociated entity ID.  Required if assigning media item to entity other than product and associated_code is not provided\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"associated_code","full_name":"media_item[associated_code]","description":"\n\u003cp\u003eAssociated entity Code. Required if assigning media item to entity other than product and associated_id is not provided. Not supported for Category\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"media_item[url]","description":"\n\u003cp\u003eURL that stores the corresponding media item\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":"description","full_name":"media_item[description]","description":"\n\u003cp\u003eDescription for the media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order_position","full_name":"media_item[sort_order_position]","description":"\n\u003cp\u003eThis field is deprecated. Please use position instead\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"is_primary","full_name":"media_item[is_primary]","description":"\n\u003cp\u003eMake this media item as primary\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag_list","full_name":"media_item[tag_list]","description":"\n\u003cp\u003eTags for this media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"etag","full_name":"media_item[etag]","description":"\n\u003cp\u003eETag for the resource on the url\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"processing_options","full_name":"media_item[processing_options]","description":"\n\u003cp\u003eOptions to perform extra image processing on the media item. This is applicable only when media_item_type is ‘ImageMediaItem’\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"apply_background","full_name":"media_item[processing_options][apply_background]","description":"\n\u003cp\u003eSetting this to true would result in a new media item created against the product with background applied. Removes transparency.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"background_colour","full_name":"media_item[processing_options][background_colour]","description":"\n\u003cp\u003eThe colour name or a hex colour code for the background colour for the created media item. Defaults to white.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"processed_tags","full_name":"media_item[processing_options][processed_tags]","description":"\n\u003cp\u003eThe tags for the created media item.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"derived_media_items","full_name":"media_item[derived_media_items]","description":"\n\u003cp\u003eTransformations for this image\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"media_item[derived_media_items][name]","description":"\n\u003cp\u003eName for the transformation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"media_item[derived_media_items][url]","description":"\n\u003cp\u003eURL for the transformation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"position","full_name":"media_item[position]","description":"\n\u003cp\u003eSort order value. Warning: Drag and drop sorting from UI might change the position you have set.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attribute_values","full_name":"media_item[attribute_values]","description":"\n\u003cp\u003eAttribute values assigned to the Media Item.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n      \"media_item\": {\n          \"url\": \"http://images.asos-media.com/inv/media/0/0/3/2/3882300/white/image3xxl.jpg\"\n      }\n  }\n\nresponse:\n  {\n    \"id\": 14,\n    \"media_item_type\": \"ImageMediaItem\",\n    \"url\": \"http://images.asos-media.com/inv/media/0/0/3/2/3882300/white/image3xxl.jpg\",\n    \"description\": \"image description\",\n    \"sort_order\": 1048576,\n    \"is_primary\": true,\n    \"is_uploaded\": null,\n    \"product_id\": 9,\n    \"position\": 1,\n    \"tag_list\": [\n      \"lady's\"\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/media_items/destroy","name":"destroy","apis":[{"api_url":"/api/v2/media_items/:id","http_method":"DELETE","short_description":"Delete a media_item","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\": 14\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/media_items/delete_by_filter","name":"delete_by_filter","apis":[{"api_url":"/api/v2/media_items/delete_by_filter","http_method":"POST","short_description":"Delete media_items with specified tags in the given product","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    \"product_id\": 9,\n    \"tag_list\": [\n      \"lady's\"\n    ]\n  }\nresponse:\n  {\n    \"id\": 14\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"npc_entity_categories":{"doc_url":"/apidoc/2.0/npc_entity_categories","id":"npc_entity_categories","api_url":"/api","name":"Npc entity categories","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;npc_entity_id\u0026quot;: 257,\n  \u0026quot;category_id\u0026quot;: 16,\n  \u0026quot;is_primary\u0026quot;: false\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/npc_entity_categories/index","name":"index","apis":[{"api_url":"/api/v2/npc_entity_categories","http_method":"GET","short_description":"List npc entity category links.","deprecated":true}],"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":[]}],"returns":[],"examples":["Response:\n  {\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 1,\n    \"entries\": [\n      {\n        \"id\": 6,\n        \"npc_entity_id\": 257,\n        \"category_id\": 16\n        \"is_primary\": false\n      }\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/npc_entity_categories/create","name":"create","apis":[{"api_url":"/api/v2/npc_entity_categories","http_method":"POST","short_description":"Create a npc entity category.","deprecated":true}],"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":"npc_entity_category","full_name":"npc_entity_category","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"npc_entity_id","full_name":"npc_entity_category[npc_entity_id]","description":"\n\u003cp\u003eNpc entity 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":"category_id","full_name":"npc_entity_category[category_id]","description":"\n\u003cp\u003eCategory 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":"is_primary","full_name":"npc_entity_category[is_primary]","description":"\n\u003cp\u003eSpecify this to be primary category of the Npc entity\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n    \"npc_entity_category\": {\n      \"npc_entity_id\": 257,\n      \"category_id\": 16\n    }\n  }\n\nresponse:\n  {\n    \"id\": 6,\n    \"npc_entity_id\": 257,\n    \"category_id\": 16\n    \"is_primary\": false\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/npc_entity_categories/destroy","name":"destroy","apis":[{"api_url":"/api/v2/npc_entity_categories/:id","http_method":"DELETE","short_description":"Delete a npc entity category.","deprecated":true}],"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\": 6\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"option_values":{"doc_url":"/apidoc/2.0/option_values","id":"option_values","api_url":"/api","name":"Option values","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;id\u0026quot;: 2,\n  \u0026quot;name\u0026quot;: \u0026quot;Blue\u0026quot;,\n  \u0026quot;code\u0026quot;: \u0026quot;blue\u0026quot;,\n  \u0026quot;details\u0026quot;: \u0026quot;{\\\u0026quot;key\\\u0026quot;:\\\u0026quot;value\\\u0026quot;}\u0026quot;\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/option_values/index","name":"index","apis":[{"api_url":"/api/v2/attribute_definitions/:id/option_values","http_method":"GET","short_description":"List option values","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":[]}],"returns":[],"examples":["Response:\n  {\n      \"page\": 1,\n      \"per_page\": 50,\n      \"total_pages\": 1,\n      \"total_entries\": 4,\n      \"entries\": [\n          {\n              \"id\": 6,\n              \"code\": \"35\",\n              \"attribute_definition_id\": 15,\n              \"created_at\": \"2017-09-21T11:10:22.063+10:00\",\n              \"updated_at\": \"2017-09-28T12:18:04.784+10:00\",\n              \"sort_order\": -4194303,\n              \"position\": nil,\n              \"name\": \"35\"\n          },\n          {\n              \"id\": 1,\n              \"code\": \"small\",\n              \"attribute_definition_id\": 15,\n              \"created_at\": \"2017-09-11T10:56:00.623+10:00\",\n              \"updated_at\": \"2017-09-11T10:56:00.623+10:00\",\n              \"sort_order\": 1,\n              \"position\": 1,\n              \"name\": \"Small\"\n          },\n          {\n              \"id\": 2,\n              \"code\": \"large\",\n              \"attribute_definition_id\": 15,\n              \"created_at\": \"2017-09-11T13:31:29.904+10:00\",\n              \"updated_at\": \"2017-09-28T12:19:10.561+10:00\",\n              \"sort_order\": 4194304,\n              \"position\": nil,\n              \"name\": \"Large\"\n          },\n          {\n              \"id\": 7,\n              \"code\": \"36\",\n              \"attribute_definition_id\": 15,\n              \"created_at\": \"2017-09-21T11:10:29.173+10:00\",\n              \"updated_at\": \"2017-09-21T11:10:29.173+10:00\",\n              \"sort_order\": 7340032,\n              \"position\": nil,\n              \"name\": \"36\"\n          }\n      ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/option_values/create","name":"create","apis":[{"api_url":"/api/v2/attribute_definitions/:id/option_values","http_method":"POST","short_description":"Create an option value","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":"option_value","full_name":"option_value","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"option_value[name]","description":"\n\u003cp\u003eOption value name. Multi-lingual supported.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"code","full_name":"option_value[code]","description":"\n\u003cp\u003eOption value code. Unique key.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"details","full_name":"option_value[details]","description":"\n\u003cp\u003eJSON format String. For Bigcommerce Swatch Option support, please use the key bigcommerce_colors or bigcommerce_image_url in JSON.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order_position","full_name":"option_value[sort_order_position]","description":"\n\u003cp\u003e[THIS FIELD IS DEPRECATED]. Please use position instead\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"position","full_name":"option_value[position]","description":"\n\u003cp\u003eSort order value. Warning: Drag and drop sorting from UI might change the position you have set.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n    \"option_value\": {\n      \"name\": \"Blue\",\n      \"code\": \"blue\",\n      \"details\": \"{\\\"key\\\":\\\"value\\\"}\",\n      \"position\": 1\n    }\n  }\n\nresponse:\n  {\n    \"id\": 2,\n    \"name\": \"Blue\",\n    \"code\": \"blue\",\n    \"details\": {\n            \"key\": \"value\"\n        }\n    \"attribute_definition_id\": 20\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/option_values/update","name":"update","apis":[{"api_url":"/api/v2/attribute_definitions/:id/option_values/:id","http_method":"PUT","short_description":"Update an option value","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":"option_value","full_name":"option_value","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"option_value[name]","description":"\n\u003cp\u003eOption value name. Multi-lingual supported.\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":"code","full_name":"option_value[code]","description":"\n\u003cp\u003eOption value code. Unique key.\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":"details","full_name":"option_value[details]","description":"\n\u003cp\u003eJSON format String. For Bigcommerce Swatch Option support, please use the key bigcommerce_colors or bigcommerce_image_url in JSON.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order_position","full_name":"option_value[sort_order_position]","description":"\n\u003cp\u003e[THIS FIELD IS DEPRECATED]. Please use position instead\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"position","full_name":"option_value[position]","description":"\n\u003cp\u003eSort order value. Warning: Drag and drop sorting from UI might change the position you have set.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n    \"option_value\": {\n      \"name\": \"Blue\",\n      \"code\": \"blue\",\n      \"details\": \"{\\\"key\\\":\\\"value\\\"}\",\n      \"position\": 1\n    }\n  }\n\nresponse:\n  {\n    \"id\": 2,\n    \"name\": \"Blue\",\n    \"code\": \"blue\",\n    \"details\": {\n            \"key\": \"value\"\n        }\n    \"attribute_definition_id\": 20\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/option_values/destroy","name":"destroy","apis":[{"api_url":"/api/v2/attribute_definitions/:id/option_values/:id","http_method":"DELETE","short_description":"Delete an option value","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\": 2\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"price_books":{"doc_url":"/apidoc/2.0/price_books","id":"price_books","api_url":"/api","name":"Price books","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;id\u0026quot;: 1,\n  \u0026quot;name\u0026quot;: \u0026quot;default\u0026quot;,\n  \u0026quot;currency\u0026quot;: \u0026quot;AUD\u0026quot;,\n  \u0026quot;price_type\u0026quot;: \u0026quot;normal\u0026quot;,\n  \u0026quot;include_tax\u0026quot;: true,\n  \u0026quot;include_duty\u0026quot;: false,\n  \u0026quot;from\u0026quot;: null,\n  \u0026quot;to\u0026quot;: null,\n  \u0026quot;status\u0026quot;: \u0026quot;active\u0026quot;,\n  \u0026quot;data_sets\u0026quot;: []\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/price_books/index","name":"index","apis":[{"api_url":"/api/v2/price_books","http_method":"GET","short_description":"List price books","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":[]}],"returns":[],"examples":["Response:\n  {\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 1,\n    \"entries\": [\n      {\n        \"id\": 1,\n        \"name\": \"default\",\n        \"currency\": \"AUD\",\n        \"price_type\": \"normal\",\n        \"include_tax\": true,\n        \"include_duty\": true,\n        \"from\": null,\n        \"to\": null,\n        \"status\": \"active\",\n        \"data_sets\": []\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/price_books/create","name":"create","apis":[{"api_url":"/api/v2/price_books","http_method":"POST","short_description":"Create an price book","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":"price_book","full_name":"price_book","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"price_book[name]","description":"\n\u003cp\u003eName of the price book\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"currency","full_name":"price_book[currency]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"price_type","full_name":"price_book[price_type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enormal\u003c/code\u003e, \u003ccode\u003esale\u003c/code\u003e, \u003ccode\u003eretail\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include_tax","full_name":"price_book[include_tax]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include_duty","full_name":"price_book[include_duty]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"price_book[from]","description":"\n\u003cp\u003eValid from\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"price_book[to]","description":"\n\u003cp\u003eValid to\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"price_book[timezone]","description":"\n\u003cp\u003eTimezone of the price book\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"price_book[status]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einactive\u003c/code\u003e, \u003ccode\u003eactive\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n      \"price_book\": {\n          \"name\": \"AU RRP\",\n          \"currency\": \"AUD\",\n          \"price_type\": \"retail\",\n          \"status\": \"active\"\n      }\n  }\n\nresponse:\n  {\n    \"id\": 2,\n    \"name\": \"AU RRP\",\n    \"currency\": \"AUD\",\n    \"price_type\": \"retail\",\n    \"include_tax\": true,\n    \"include_duty\": true,\n    \"from\": null,\n    \"to\": null,\n    \"status\": \"active\",\n    \"data_sets\": []\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/price_books/update","name":"update","apis":[{"api_url":"/api/v2/price_books/:id","http_method":"PUT","short_description":"Update an price book","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":"price_book","full_name":"price_book","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"price_book[name]","description":"\n\u003cp\u003eName of the price book\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":"currency","full_name":"price_book[currency]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"price_type","full_name":"price_book[price_type]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enormal\u003c/code\u003e, \u003ccode\u003esale\u003c/code\u003e, \u003ccode\u003eretail\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include_tax","full_name":"price_book[include_tax]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include_duty","full_name":"price_book[include_duty]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"price_book[from]","description":"\n\u003cp\u003eValid from\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"price_book[to]","description":"\n\u003cp\u003eValid to\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"price_book[timezone]","description":"\n\u003cp\u003eTimezone of the price book\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"price_book[status]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einactive\u003c/code\u003e, \u003ccode\u003eactive\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n      \"price_book\": {\n          \"status\": \"inactive\"\n      }\n  }\n\nresponse:\n  {\n    \"id\": 2,\n    \"name\": \"AU RRP\",\n    \"currency\": \"AUD\",\n    \"price_type\": \"retail\",\n    \"include_tax\": true,\n    \"include_duty\": false,\n    \"from\": null,\n    \"to\": null,\n    \"status\": \"inactive\",\n    \"data_sets\": [],\n    \"timezone\": \"\"\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/price_books/destroy","name":"destroy","apis":[{"api_url":"/api/v2/price_books/:id","http_method":"DELETE","short_description":"Delete an price book","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\": 2\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"price_items":{"doc_url":"/apidoc/2.0/price_items","id":"price_items","api_url":"/api","name":"Price items","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;id\u0026quot;: 28,\n  \u0026quot;amount\u0026quot;: 10,\n  \u0026quot;product_id\u0026quot;: 6,\n  \u0026quot;from\u0026quot;: null,\n  \u0026quot;to\u0026quot;: null,\n  \u0026quot;description\u0026quot;: \u0026quot;promotion ABC\u0026quot;\n  \u0026quot;enabled?\u0026quot;: true,\n  \u0026quot;price_book\u0026quot;: {\n    \u0026quot;id\u0026quot;: 1,\n    \u0026quot;name\u0026quot;: \u0026quot;default\u0026quot;\n  }\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/price_items/index","name":"index","apis":[{"api_url":"/api/v2/price_items","http_method":"GET","short_description":"List price 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":"lang","full_name":"lang","description":"\n\u003cp\u003eLanguage code for translated value\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\": 1,\n    \"entries\": [\n      {\n        \"id\": 28,\n        \"amount\": 10,\n        \"product_id\": 6,\n        \"from\": null,\n        \"to\": null,\n        \"enabled?\": true,\n        \"price_book\": {\n          \"id\": 1,\n          \"name\": \"default\"\n        }\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/price_items/create","name":"create","apis":[{"api_url":"/api/v2/price_items","http_method":"POST","short_description":"Create an price item","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":"price_item","full_name":"price_item","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"amount","full_name":"price_item[amount]","description":"\n\u003cp\u003ePrice amount\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"price_item[from]","description":"\n\u003cp\u003eValid from. ISO_8601 format 2016-05-30T05:13:26Z.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"price_item[to]","description":"\n\u003cp\u003eValid to. ISO_8601 format 2016-05-30T05:13:26Z.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"price_item[product_id]","description":"\n\u003cp\u003eParent product ID. Mandatory if assigning price item to product and produce_code is not provided.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_code","full_name":"price_item[product_code]","description":"\n\u003cp\u003eParent product code. Mandatory if assigning price item to product and product_id is not provided.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"npc_entity_id","full_name":"price_item[npc_entity_id]","description":"\n\u003cp\u003eParent npc entity ID. Mandatory if assigning price item to Npc entity and npc_entity_code is not provided.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"npc_entity_code","full_name":"price_item[npc_entity_code]","description":"\n\u003cp\u003eParent npc entity code. Mandatory if assigning price item to Npc entity and npc_entity_id is not provided.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"price_book_id","full_name":"price_item[price_book_id]","description":"\n\u003cp\u003eParent price book 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":"description","full_name":"price_item[description]","description":"\n\u003cp\u003eDescription for this price item. For example, to record a discount reason or promotion code.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n    \"price_item\": {\n        \"amount\": 12,\n        \"from\": \"2016-07-05T09:00:00.000+10:00\",\n        \"to\": \"2016-07-08T09:00:00.000+10:00\",\n        \"product_id\": 6,\n        \"price_book_id\": 1\n    }\n  }\n\nSample: create a media item for Npc Entity with npc entity id\n  {\n    \"price_item\": {\n        \"amount\": 12,\n        \"from\": \"2016-07-05T09:00:00.000+10:00\",\n        \"to\": \"2016-07-08T09:00:00.000+10:00\",\n        \"npc_entity_id\": 6,\n        \"price_book_id\": 1\n    }\n  }\n\nresponse:\n  {\n    \"id\": 29,\n    \"amount\": 12,\n    \"product_id\": 6,\n    \"from\": \"2016-07-05T09:00:00.000+10:00\",\n    \"to\": \"2016-07-08T09:00:00.000+10:00\",\n    \"enabled?\": true,\n    \"price_book\": {\n      \"id\": 1,\n      \"name\": \"default\"\n    }\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/price_items/update","name":"update","apis":[{"api_url":"/api/v2/price_items/:id","http_method":"PUT","short_description":"Update an price item","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":"price_item","full_name":"price_item","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"amount","full_name":"price_item[amount]","description":"\n\u003cp\u003ePrice amount\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"price_item[from]","description":"\n\u003cp\u003eValid from. ISO_8601 format 2016-05-30T05:13:26Z.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"price_item[to]","description":"\n\u003cp\u003eValid to. ISO_8601 format 2016-05-30T05:13:26Z.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"price_item[product_id]","description":"\n\u003cp\u003eParent product ID. Mandatory if assigning price item to product and produce_code is not provided.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_code","full_name":"price_item[product_code]","description":"\n\u003cp\u003eParent product code. Mandatory if assigning price item to product and product_id is not provided.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"npc_entity_id","full_name":"price_item[npc_entity_id]","description":"\n\u003cp\u003eParent npc entity ID. Mandatory if assigning price item to Npc entity and npc_entity_code is not provided.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"npc_entity_code","full_name":"price_item[npc_entity_code]","description":"\n\u003cp\u003eParent npc entity code. Mandatory if assigning price item to Npc entity and npc_entity_id is not provided.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"price_book_id","full_name":"price_item[price_book_id]","description":"\n\u003cp\u003eParent price book ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"price_item[description]","description":"\n\u003cp\u003eDescription for this price item. For example, to record a discount reason or promotion code.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n    \"price_item\": {\n      \"amount\": 10\n    }\n  }\n\nresponse:\n  {\n    \"id\": 28,\n    \"amount\": 10,\n    \"product_id\": 6,\n    \"from\": null,\n    \"to\": null,\n    \"enabled?\": true,\n    \"price_book\": {\n      \"id\": 1,\n      \"name\": \"default\"\n    }\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/price_items/destroy","name":"destroy","apis":[{"api_url":"/api/v2/price_items/:id","http_method":"DELETE","short_description":"Delete an price item","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\": 28\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"product_catalogs":{"doc_url":"/apidoc/2.0/product_catalogs","id":"product_catalogs","api_url":"/api","name":"Product catalogs","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;product_id\u0026quot;: 257,\n  \u0026quot;catalog_id\u0026quot;: 16\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/product_catalogs/index","name":"index","apis":[{"api_url":"/api/v2/product_catalogs","http_method":"GET","short_description":"List product catalog links","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":[]}],"returns":[],"examples":["Response:\n  {\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 1,\n    \"entries\": [\n      {\n        \"id\": 6,\n        \"product_id\": 257,\n        \"catalog_id\": 16\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/product_catalogs/create","name":"create","apis":[{"api_url":"/api/v2/product_catalogs","http_method":"POST","short_description":"Create a product catalog link","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":"product_catalog","full_name":"product_catalog","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"product_id","full_name":"product_catalog[product_id]","description":"\n\u003cp\u003eProduct ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_code","full_name":"product_catalog[product_code]","description":"\n\u003cp\u003eProduct Code\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"catalog_id","full_name":"product_catalog[catalog_id]","description":"\n\u003cp\u003eCatalog 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":[]}]}],"returns":[],"examples":["  request:\n    {\n      \"product_catalog\": {\n        \"product_id\": 257,\n        \"catalog_id\": 16\n      }\n    }\n\n  response:\n    {\n      \"id\": 6,\n      \"product_id\": 257,\n      \"category_id\": 16\n    }\n\nSample: Insert product catalog with product code.\n  request:\n    {\n      \"product_catalog\": {\n        \"product_code\": \"product_code_1\",\n        \"catalog_id\": 16\n      }\n    }\n\n  response:\n    {\n      \"id\": 6,\n      \"product_id\": 257,\n      \"category_id\": 16\n    }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/product_catalogs/destroy","name":"destroy","apis":[{"api_url":"/api/v2/product_catalogs/:id","http_method":"DELETE","short_description":"Delete a product catalog link","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\": 6\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"product_categories":{"doc_url":"/apidoc/2.0/product_categories","id":"product_categories","api_url":"/api","name":"Product categories","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;product_id\u0026quot;: 257,\n  \u0026quot;category_id\u0026quot;: 16,\n  \u0026quot;is_primary\u0026quot;: false\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/product_categories/index","name":"index","apis":[{"api_url":"/api/v2/product_categories","http_method":"GET","short_description":"List product category links","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":[]}],"returns":[],"examples":["Response:\n  {\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 1,\n    \"entries\": [\n      {\n        \"id\": 6,\n        \"product_id\": 257,\n        \"category_id\": 16\n        \"is_primary\": false\n      }\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/product_categories/create","name":"create","apis":[{"api_url":"/api/v2/product_categories","http_method":"POST","short_description":"Create a product category","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":"product_category","full_name":"product_category","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"product_id","full_name":"product_category[product_id]","description":"\n\u003cp\u003eProduct 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":"category_id","full_name":"product_category[category_id]","description":"\n\u003cp\u003eCategory 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":"is_primary","full_name":"product_category[is_primary]","description":"\n\u003cp\u003eSpecify this to be primary category of the product\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n    \"product_category\": {\n      \"product_id\": 257,\n      \"category_id\": 16\n    }\n  }\n\nresponse:\n  {\n    \"id\": 6,\n    \"product_id\": 257,\n    \"category_id\": 16\n    \"is_primary\": false\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/product_categories/destroy","name":"destroy","apis":[{"api_url":"/api/v2/product_categories/:id","http_method":"DELETE","short_description":"Delete a product category","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\": 6\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"product_classes":{"doc_url":"/apidoc/2.0/product_classes","id":"product_classes","api_url":"/api","name":"Product classes","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\u003c/pre\u003e\n\n\u003cp\u003e{\u003c/p\u003e\n\n\u003cpre\u003e\u0026quot;id\u0026quot;: 1,\n\u0026quot;name\u0026quot;: \u0026quot;SKU\u0026quot;,\n\u0026quot;class_type\u0026quot;: \u0026quot;sku\u0026quot;\u003c/pre\u003e\n\n\u003cp\u003e}\u003c/p\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/product_classes/index","name":"index","apis":[{"api_url":"/api/v2/product_classes","http_method":"GET","short_description":"List product classes","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":"id","full_name":"id","description":"\n\u003cp\u003eProduct Class 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":[]}],"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          \"name\": \"SKU\",\n          \"class_type\": \"sku\"\n          \"include_media\": false,\n          \"include_price\": true,\n          \"include_category\": true,\n          \"include_inventory\": true,\n          \"include_dimension\": true,\n          \"lower_class_id\": null,\n          \"attribute_definitions\": [\n              {\n                  \"id\": 1,\n                  \"base_type\": \"html\",\n                  \"name\": \"Description\",\n                  \"code\": \"description\"\n              },\n              {\n                  \"id\": 2,\n                  \"base_type\": \"html\",\n                  \"name\": \"Short Description\",\n                  \"code\": \"short_description\"\n              },\n          ]\n      },\n      {\n          \"id\": 2,\n          \"name\": \"Product\",\n          \"class_type\": \"variation\"\n          \"include_media\": false,\n          \"include_price\": true,\n          \"include_category\": true,\n          \"include_inventory\": true,\n          \"include_dimension\": true,\n          \"lower_class_id\": 3,\n          \"attribute_definitions\": [\n              {\n                  \"id\": 1,\n                  \"base_type\": \"html\",\n                  \"name\": \"Description\",\n                  \"code\": \"description\"\n              },\n              {\n                  \"id\": 2,\n                  \"base_type\": \"html\",\n                  \"name\": \"Short Description\",\n                  \"code\": \"short_description\"\n              },\n            ]\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/product_classes/create","name":"create","apis":[{"api_url":"/api/v2/product_classes","http_method":"POST","short_description":"Create product class","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":"product_class","full_name":"product_class","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"product_class[name]","description":"\n\u003cp\u003eName of the product class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"class_type","full_name":"product_class[class_type]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003esku\u003c/code\u003e, \u003ccode\u003egrouped\u003c/code\u003e, \u003ccode\u003evariation\u003c/code\u003e, \u003ccode\u003eproduct_kit\u003c/code\u003e, \u003ccode\u003enpc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include_media","full_name":"product_class[include_media]","description":"\n\u003cp\u003eAllow images to be included in this class, not supported in NPC.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include_price","full_name":"product_class[include_price]","description":"\n\u003cp\u003eAllow prices to be included in this class, not supported in NPC.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include_category","full_name":"product_class[include_category]","description":"\n\u003cp\u003eAllow categories to be included in this class, not supported in NPC.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include_inventory","full_name":"product_class[include_inventory]","description":"\n\u003cp\u003eAllow inventories to be included in this class, not supported in NPC.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include_dimension","full_name":"product_class[include_dimension]","description":"\n\u003cp\u003eAllow dimensions to be included in this class, not supported in NPC.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"lower_class_id","full_name":"product_class[lower_class_id]","description":"\n\u003cp\u003eOnly applies to class_type variation. It sets the next level product class.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lower_class_name","full_name":"product_class[lower_class_name]","description":"\n\u003cp\u003eOnly applies to class_type variation. It sets the next level product class.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribute_definition_ids","full_name":"product_class[attribute_definition_ids]","description":"\n\u003cp\u003eList of Attribute Definition IDs to link to this product class\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of Integer","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"attribute_definition_codes","full_name":"product_class[attribute_definition_codes]","description":"\n\u003cp\u003eList of Attribute Definition codes to link to this product class\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"attribute_definition_mode","full_name":"product_class[attribute_definition_mode]","description":"\n\u003cp\u003eUpdate mode for Attribute Definition. Default is reset\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eadd\u003c/code\u003e, \u003ccode\u003ereset\u003c/code\u003e, \u003ccode\u003emerge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n    \"product_class\": {\n        \"name\": \"Shoe Colour\",\n        \"class_type\": \"variation\",\n        \"include_media\": true,\n        \"include_price\": true,\n        \"include_category\": true,\n        \"include_inventory\": false,\n        \"include_dimension\": false,\n        \"lower_class_id\": 12,\n        \"attribute_definition_ids\": [2, 12, 25]\n    }\n  }\n\nresponse:\n  {\n      \"id\": 10,\n      \"name\": \"Shoe Colour\",\n      \"class_type\": \"variation\",\n      \"include_media\": true,\n      \"include_price\": true,\n      \"include_category\": true,\n      \"include_inventory\": false,\n      \"include_dimension\": false,\n      \"created_at\": \"2017-09-08T16:08:59.144+10:00\",\n      \"updated_at\": \"2017-09-08T16:08:59.144+10:00\",\n      \"lower_class_id\": 12\n  }\n\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/product_classes/update","name":"update","apis":[{"api_url":"/api/v2/product_classes/:id","http_method":"PUT","short_description":"Update a product class","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":"product_class","full_name":"product_class","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"product_class[name]","description":"\n\u003cp\u003eName of the product class\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":"class_type","full_name":"product_class[class_type]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003esku\u003c/code\u003e, \u003ccode\u003egrouped\u003c/code\u003e, \u003ccode\u003evariation\u003c/code\u003e, \u003ccode\u003eproduct_kit\u003c/code\u003e, \u003ccode\u003enpc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include_media","full_name":"product_class[include_media]","description":"\n\u003cp\u003eAllow images to be included in this class, not supported in NPC.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include_price","full_name":"product_class[include_price]","description":"\n\u003cp\u003eAllow prices to be included in this class, not supported in NPC.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include_category","full_name":"product_class[include_category]","description":"\n\u003cp\u003eAllow categories to be included in this class, not supported in NPC.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include_inventory","full_name":"product_class[include_inventory]","description":"\n\u003cp\u003eAllow inventories to be included in this class, not supported in NPC.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include_dimension","full_name":"product_class[include_dimension]","description":"\n\u003cp\u003eAllow dimensions to be included in this class, not supported in NPC.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"lower_class_id","full_name":"product_class[lower_class_id]","description":"\n\u003cp\u003eOnly applies to class_type variation. It sets the next level product class.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lower_class_name","full_name":"product_class[lower_class_name]","description":"\n\u003cp\u003eOnly applies to class_type variation. It sets the next level product class.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribute_definition_ids","full_name":"product_class[attribute_definition_ids]","description":"\n\u003cp\u003eList of Attribute Definition IDs to link to this product class\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of Integer","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"attribute_definition_codes","full_name":"product_class[attribute_definition_codes]","description":"\n\u003cp\u003eList of Attribute Definition codes to link to this product class\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"attribute_definition_mode","full_name":"product_class[attribute_definition_mode]","description":"\n\u003cp\u003eUpdate mode for Attribute Definition. Default is reset\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eadd\u003c/code\u003e, \u003ccode\u003ereset\u003c/code\u003e, \u003ccode\u003emerge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n    \"product_class\": {\n      \"name\": \"Shoe Colour\",\n      \"class_type\": \"variation\",\n      \"include_media\": true,\n      \"include_price\": true,\n      \"include_category\": true,\n      \"include_inventory\": false,\n      \"include_dimension\": false,\n      \"lower_class_id\": 12,\n      \"attribute_definition_ids\": [2, 12, 25]\n    }\n  }\n\nresponse:\n  {\n      \"id\": 10,\n      \"name\": \"Shoe Colour\",\n      \"class_type\": \"variation\",\n      \"include_media\": true,\n      \"include_price\": true,\n      \"include_category\": true,\n      \"include_inventory\": false,\n      \"include_dimension\": false,\n      \"created_at\": \"2017-09-08T16:08:59.144+10:00\",\n      \"updated_at\": \"2017-09-08T16:08:59.144+10:00\",\n      \"lower_class_id\": 12\n  }\n\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/product_classes/destroy","name":"destroy","apis":[{"api_url":"/api/v2/product_classes/:id","http_method":"DELETE","short_description":"Delete a product class","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\": 2\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"product_families":{"doc_url":"/apidoc/2.0/product_families","id":"product_families","api_url":"/api","name":"Product families","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;id\u0026quot;: 1,\n  \u0026quot;code\u0026quot;: \u0026quot;Product family 1\u0026quot;,\n  \u0026quot;name\u0026quot;: \u0026quot;Product family 1\u0026quot;\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/product_families/index","name":"index","apis":[{"api_url":"/api/v2/product_families","http_method":"GET","short_description":"List product families","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":"id","full_name":"id","description":"\n\u003cp\u003eAttribute group 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":[]}],"returns":[],"examples":["Response:\n  {\n      \"page\": 1,\n      \"per_page\": 50,\n      \"total_pages\": 1,\n      \"total_entries\": 1,\n      \"entries\": [\n          {\n              \"id\": 1,\n              \"code\": \"fam1\",\n              \"name\": \"fam1\",\n              \"attribute_groups\": [\n                  {\n                      \"product_class_id\": 3,\n                      \"attribute_group_id\": 2,\n                      \"sort_order\": 1\n                  },\n                  {\n                      \"product_class_id\": 7,\n                      \"attribute_group_id\": 6,\n                      \"sort_order\": 2\n                  },\n                  {\n                      \"product_class_id\": 7,\n                      \"attribute_group_id\": 5,\n                      \"sort_order\": 3\n                  }\n              ]\n          }\n      ]\n  }\n\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/product_families/create","name":"create","apis":[{"api_url":"/api/v2/product_families","http_method":"POST","short_description":"Create or update product family","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":"product_family","full_name":"product_family","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"code","full_name":"product_family[code]","description":"\n\u003cp\u003eCode of the product family\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"product_family[name]","description":"\n\u003cp\u003eName of the product family\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribute_groups","full_name":"product_family[attribute_groups]","description":"\n\u003cp\u003eLink family to attribute groups for product classes\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"product_class_name","full_name":"product_family[attribute_groups][product_class_name]","description":"\n\u003cp\u003eProduct class name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribute_group_code","full_name":"product_family[attribute_groups][attribute_group_code]","description":"\n\u003cp\u003eAttribute group code\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"product_family[attribute_groups][sort_order]","description":"\n\u003cp\u003eSort order\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}]}],"returns":[],"examples":["request:\n  {\n    \"product_family\": {\n      \"code\": \"family_1\",\n      \"name\": \"Family 1\",\n      \"attribute_groups\": [\n        {\n          \"product_class_name\": \"class1\",\n          \"attribute_group_code\": \"grp1\",\n          \"sort_order\": 1\n        },\n        {\n          \"product_class_name\": \"class2\",\n          \"attribute_group_code\": \"grp2\",\n          \"sort_order\": 2\n        }\n      ]\n    }\n  }\n\nresponse:\n  {\n      \"id\": 3,\n      \"code\": \"family_2\",\n      \"created_at\": \"2019-06-18T13:31:16.763+10:00\",\n      \"updated_at\": \"2019-06-18T13:31:16.763+10:00\",\n      \"name\": \"Family 2\"\n  }\n\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/product_families/destroy","name":"destroy","apis":[{"api_url":"/api/v2/product_families/:id","http_method":"DELETE","short_description":"Delete a product family","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\": 2\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"product_family_attribute_groups":{"doc_url":"/apidoc/2.0/product_family_attribute_groups","id":"product_family_attribute_groups","api_url":"/api","name":"Product family attribute groups","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n    \u0026quot;id\u0026quot;: 1,\n    \u0026quot;product_family_id\u0026quot;: 1,\n    \u0026quot;attribute_group_id\u0026quot;: 2,\n    \u0026quot;product_class_id\u0026quot;: 3,\n    \u0026quot;sort_order\u0026quot;: 1\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/product_family_attribute_groups/index","name":"index","apis":[{"api_url":"/api/v2/product_family_attribute_groups","http_method":"GET","short_description":"List product family and attribute group links","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":"id","full_name":"id","description":"\n\u003cp\u003eAttribute group 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":[]}],"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            \"product_family_id\": 1,\n            \"attribute_group_id\": 2,\n            \"product_class_id\": 3,\n            \"sort_order\": 1\n            \"created_at\": \"2019-06-13T15:40:54.429+10:00\",\n            \"updated_at\": \"2019-06-14T14:20:50.380+10:00\"\n        },\n        {\n            \"id\": 2,\n            \"product_family_id\": 3,\n            \"attribute_group_id\": 6,\n            \"product_class_id\": 7,\n            \"sort_order\": 2\n            \"created_at\": \"2019-06-18T13:31:16.848+10:00\",\n            \"updated_at\": \"2019-06-18T13:31:16.848+10:00\"\n        }\n    ]\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/product_family_attribute_groups/create","name":"create","apis":[{"api_url":"/api/v2/product_family_attribute_groups","http_method":"POST","short_description":"Create or update product family attribute group link","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":"product_family_attribute_group","full_name":"product_family_attribute_group","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"product_family_code","full_name":"product_family_attribute_group[product_family_code]","description":"\n\u003cp\u003eProduct family code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_class_name","full_name":"product_family_attribute_group[product_class_name]","description":"\n\u003cp\u003eProduct class name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribute_group_code","full_name":"product_family_attribute_group[attribute_group_code]","description":"\n\u003cp\u003eAttribute group code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n    \"product_family_attribute_group\": {\n        \"product_family_code\": \"family1\",\n        \"product_class_name\": \"class1\",\n        \"attribute_group_code\": \"group1\"\n    }\n  }\n\nresponse:\n  {\n      \"id\": 7,\n      \"product_family_id\": 2,\n      \"attribute_group_id\": 5,\n      \"product_class_id\": 4,\n      \"created_at\": \"2019-06-18T15:56:43.997+10:00\",\n      \"updated_at\": \"2019-06-18T15:56:43.997+10:00\"\n  }\n\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/product_family_attribute_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v2/product_family_attribute_groups/:id","http_method":"DELETE","short_description":"Delete a product family attribute group link","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\": 2\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"product_groups":{"doc_url":"/apidoc/2.0/product_groups","id":"product_groups","api_url":"/api","name":"Product groups","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;group_id\u0026quot;: 257,\n  \u0026quot;member_id\u0026quot;: 16,\n  \u0026quot;sort_order\u0026quot;: 5\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/product_groups/index","name":"index","apis":[{"api_url":"/api/v2/product_groups","http_method":"GET","short_description":"List product group associations","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":[]}],"returns":[],"examples":["Response:\n{\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 3,\n    \"entries\": [\n        {\n            \"id\": 2,\n            \"group_id\": 8,\n            \"member_id\": 7,\n            \"sort_order\": null\n        },\n        {\n            \"id\": 3,\n            \"group_id\": 8,\n            \"member_id\": 12,\n            \"sort_order\": null\n        },\n        {\n            \"id\": 4,\n            \"group_id\": 8,\n            \"member_id\": 11,\n            \"sort_order\": null\n        }\n    ]\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/product_groups/create","name":"create","apis":[{"api_url":"/api/v2/product_groups","http_method":"POST","short_description":"Create or update a product group","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":"product_group","full_name":"product_group","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"group_id","full_name":"product_group[group_id]","description":"\n\u003cp\u003eGroup product 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":"member_id","full_name":"product_group[member_id]","description":"\n\u003cp\u003eGroup member product 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":"sort_order","full_name":"product_group[sort_order]","description":"\n\u003cp\u003eGroup member ordering\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n    \"product_group\": {\n      \"group_id\": 8,\n      \"member_id\": 7,\n      \"sort_order\": 5\n    }\n  }\n\nresponse:\n  {\n      \"id\": 2,\n      \"group_id\": 8,\n      \"member_id\": 7,\n      \"sort_order\": 5\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/product_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v2/product_groups/:id","http_method":"DELETE","short_description":"Delete a product group","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\": 2\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"product_kits":{"doc_url":"/apidoc/2.0/product_kits","id":"product_kits","api_url":"/api","name":"Product kits","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;parent_id\u0026quot;: 257,\n  \u0026quot;child_id\u0026quot;: 16,\n  \u0026quot;qty\u0026quot;: 1\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/product_kits/index","name":"index","apis":[{"api_url":"/api/v2/product_kits","http_method":"GET","short_description":"List product kit associations","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":[]}],"returns":[],"examples":["Response:\n{\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 3,\n    \"entries\": [\n        {\n            \"id\": 2,\n            \"parent_id\": 8,\n            \"child_id\": 7,\n            \"qty\": 1\n        },\n        {\n            \"id\": 3,\n            \"parent_id\": 8,\n            \"child_id\": 12,\n            \"qty\": 2\n        },\n        {\n            \"id\": 4,\n            \"parent_id\": 8,\n            \"child_id\": 11,\n            \"qty\": 1\n        }\n    ]\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/product_kits/create","name":"create","apis":[{"api_url":"/api/v2/product_kits","http_method":"POST","short_description":"Create or update a product kit","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":"product_kit","full_name":"product_kit","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"parent_id","full_name":"product_kit[parent_id]","description":"\n\u003cp\u003eKit product parent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"child_id","full_name":"product_kit[child_id]","description":"\n\u003cp\u003eKit product child ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"qty","full_name":"product_kit[qty]","description":"\n\u003cp\u003eKit product child quantity\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":"parent_product_code","full_name":"product_kit[parent_product_code]","description":"\n\u003cp\u003eParent kit product code\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"child_product_code","full_name":"product_kit[child_product_code]","description":"\n\u003cp\u003eChild kit product code\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n    \"product_kit\": {\n      \"parent_id\": 8,\n      \"child_id\": 7,\n      \"qty\": 1\n    }\n  }\n\n  or\n\n  {\n    \"product_variation\": {\n      \"parent_product_code\": \"Product-ABC\",\n      \"child_product_code\": \"Product-ABC-variation-1\",\n      \"qty\": 1\n    }\n  }\n\nresponse:\n  {\n      \"id\": 2,\n      \"parent_id\": 8,\n      \"child_id\": 7,\n      \"qty\": 1\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/product_kits/destroy","name":"destroy","apis":[{"api_url":"/api/v2/product_kits/:id","http_method":"DELETE","short_description":"Delete a product kit","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\": 2\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"product_relationships":{"doc_url":"/apidoc/2.0/product_relationships","id":"product_relationships","api_url":"/api","name":"Product relationships","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;id\u0026quot;: 1,\n  \u0026quot;parent_product_id\u0026quot;: \u0026quot;1\u0026quot;,\n  \u0026quot;child_product_id\u0026quot;: \u0026quot;2 \u0026quot;,\n  \u0026quot;relationship_id\u0026quot;: \u0026quot;1\u0026quot;,\n  \u0026quot;status\u0026quot;: active,\n  \u0026quot;sort_order\u0026quot;: 1\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/product_relationships/index","name":"index","apis":[{"api_url":"/api/v2/product_relationships","http_method":"GET","short_description":"List product relationships","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":"id","full_name":"id","description":"\n\u003cp\u003eProduct Relationship 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":"status","full_name":"status","description":"\n\u003cp\u003eProduct Relationship 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\": 1,\n      \"entries\": [\n        {\n          \"id\": 1,\n          \"sort_order\": 1,\n          \"status\": \"active\",\n          \"relationship\": {\n              \"id\": 2,\n              \"name\": \"My Relationship 1\",\n              \"code\": \"my_relationship_1\"\n          },\n          \"parent_product\": {\n              \"id\": 18,\n              \"code\": \"parent-code\",\n              \"name\": \"Parent Product\"\n          },\n          \"child_product\": {\n              \"id\": 19,\n              \"code\": \"child-code\",\n              \"name\": \"Child Product\"\n          }\n        }\n      ]\n  }\n\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/product_relationships/create","name":"create","apis":[{"api_url":"/api/v2/product_relationships","http_method":"POST","short_description":"Create or update product relationship","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":"product_relationship","full_name":"product_relationship","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"relationship_id","full_name":"product_relationship[relationship_id]","description":"\n\u003cp\u003eID of the relationship\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"relationship_code","full_name":"product_relationship[relationship_code]","description":"\n\u003cp\u003eCode of the relationship\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parent_product_id","full_name":"product_relationship[parent_product_id]","description":"\n\u003cp\u003eID of the parent product\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"parent_product_code","full_name":"product_relationship[parent_product_code]","description":"\n\u003cp\u003eCode of the parent product\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"child_product_id","full_name":"product_relationship[child_product_id]","description":"\n\u003cp\u003eID of the child product\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"child_product_code","full_name":"product_relationship[child_product_code]","description":"\n\u003cp\u003eCode of the child product\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"product_relationship[status]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einactive\u003c/code\u003e, \u003ccode\u003eactive\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"product_relationship[sort_order]","description":"\n\u003cp\u003eProduct Relationship ordering\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n    \"product_relationship\": {\n      \"status\": \"active\",\n      \"sort_order\": 1,\n      \"relationship_id\": 2,\n      \"parent_product_id\": 21,\n      \"child_product_id\": 19\n    }\n  }\n\n  or\n\n  {\n    \"product_relationship\": {\n      \"status\": \"active\",\n      \"sort_order\": 2,\n      \"relationship_code\": \"relationship_1\",\n      \"parent_product_code\": \"product_code_1\",\n      \"child_product_code\": \"product_code_2\"\n    }\n  }\n\n\nresponse:\n  {\n    \"id\": 2,\n    \"sort_order\": 20,\n    \"status\": \"active\",\n    \"relationship\": {\n        \"id\": 2,\n        \"name\": \"My Relationship 1\",\n        \"code\": \"my_relationship_1\"\n    },\n    \"parent_product\": {\n        \"id\": 20,\n        \"code\": \"product_code_1\",\n        \"name\": \"Product 1\"\n    },\n    \"child_product\": {\n        \"id\": 19,\n        \"code\": \"product_code_1\",\n        \"name\": \"Product 2\"\n    }\n  }\n\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/product_relationships/destroy","name":"destroy","apis":[{"api_url":"/api/v2/product_relationships/:id","http_method":"DELETE","short_description":"Delete a relationship","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},"product_variations":{"doc_url":"/apidoc/2.0/product_variations","id":"product_variations","api_url":"/api","name":"Product variations","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;parent_id\u0026quot;: 257,\n  \u0026quot;child_id\u0026quot;: 16\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/product_variations/index","name":"index","apis":[{"api_url":"/api/v2/product_variations","http_method":"GET","short_description":"List product variation associations","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":[]}],"returns":[],"examples":["Response:\n{\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 3,\n    \"entries\": [\n        {\n            \"id\": 2,\n            \"parent_id\": 8,\n            \"child_id\": 7\n        },\n        {\n            \"id\": 3,\n            \"parent_id\": 8,\n            \"child_id\": 12\n        },\n        {\n            \"id\": 4,\n            \"parent_id\": 8,\n            \"child_id\": 11\n        }\n    ]\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/product_variations/create","name":"create","apis":[{"api_url":"/api/v2/product_variations","http_method":"POST","short_description":"Create a product variation","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":"product_variation","full_name":"product_variation","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"parent_id","full_name":"product_variation[parent_id]","description":"\n\u003cp\u003eParent product ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"child_id","full_name":"product_variation[child_id]","description":"\n\u003cp\u003eChild product ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"parent_product_code","full_name":"product_variation[parent_product_code]","description":"\n\u003cp\u003eParent product code\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"child_product_code","full_name":"product_variation[child_product_code]","description":"\n\u003cp\u003eChild product code\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n\n  {\n    \"product_variation\": {\n      \"parent_id\": 8,\n      \"child_id\": 7\n    }\n  }\n\n  or\n\n  {\n    \"product_variation\": {\n      \"parent_product_code\": \"Product-ABC\",\n      \"child_product_code\": \"Product-ABC-variation-1\"\n    }\n  }\n\nresponse:\n  {\n      \"id\": 2,\n      \"parent_id\": 8,\n      \"child_id\": 7\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/product_variations/destroy","name":"destroy","apis":[{"api_url":"/api/v2/product_variations/:id","http_method":"DELETE","short_description":"Delete a product variation","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\": 2\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"products":{"doc_url":"/apidoc/2.0/products","id":"products","api_url":"/api","name":"Products","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;en\u0026quot;: {\n    \u0026quot;id\u0026quot;: 1,\n    \u0026quot;product_type\u0026quot;: \u0026quot;product\u0026quot;,\n    \u0026quot;code\u0026quot;: \u0026quot;12345\u0026quot;,\n    \u0026quot;status\u0026quot;: \u0026quot;active\u0026quot;,\n    \u0026quot;product_attributes\u0026quot;: {\n      \u0026quot;description\u0026quot;: {\n        \u0026quot;base_type\u0026quot;: \u0026quot;html\u0026quot;,\n        \u0026quot;value\u0026quot;: \u0026quot;\u0026lt;p style=\u0026quot;line-height: 18.5714px;\u0026quot;\u0026gt;This is a description.\u0026lt;/p\u0026gt;\u0026quot;\n      },\n      \u0026quot;short_description\u0026quot;: {\n        \u0026quot;base_type\u0026quot;: \u0026quot;html\u0026quot;,\n        \u0026quot;value\u0026quot;: \u0026quot;\u0026lt;span style=\u0026quot;line-height: 18.5714px;\u0026quot;\u0026gt;This is a short description.\u0026lt;/span\u0026gt;\u0026quot;\n      }\n    },\n    \u0026quot;name\u0026quot;: \u0026quot;Product 12345\u0026quot;,\n    \u0026quot;is_complete\u0026quot;: true,\n    \u0026quot;incomplete_fields\u0026quot;: {\n      \u0026quot;missing_image\u0026quot;: false,\n      \u0026quot;missing_category\u0026quot;: false,\n      \u0026quot;missing_price\u0026quot;: false,\n      \u0026quot;missing_attributes\u0026quot;: []\n    },\n    \u0026quot;discontinued\u0026quot;: false,\n    \u0026quot;shipping_options\u0026quot;: [],\n    \u0026quot;attribute_set\u0026quot;: {\n      \u0026quot;id\u0026quot;: 1,\n      \u0026quot;name\u0026quot;: \u0026quot;Automotive\u0026quot;\n    },\n    \u0026quot;product_level\u0026quot;: {\n      \u0026quot;id\u0026quot;: 1,\n      \u0026quot;name\u0026quot;: \u0026quot;Products\u0026quot;\n    },\n    \u0026quot;product_categories\u0026quot;: [\n      {\n        \u0026quot;is_primary\u0026quot;: false,\n        \u0026quot;category_id\u0026quot;: 1,\n        \u0026quot;name\u0026quot;: \u0026quot;Engine Oil\u0026quot;,\n        \u0026quot;path\u0026quot;: \u0026quot;Engine Oil\u0026quot;,\n        \u0026quot;category_set\u0026quot;: {\n          \u0026quot;id\u0026quot;: 1,\n          \u0026quot;name\u0026quot;: \u0026quot;default\u0026quot;\n        }\n      }\n    ],\n    \u0026quot;catalogs\u0026quot;: [\n      {\n        \u0026quot;id\u0026quot;: 1,\n        \u0026quot;name\u0026quot;: \u0026quot;Catalog Name\u0026quot;\n      }\n    ],\n    \u0026quot;shipping_zones\u0026quot;: [\n      {\n        \u0026quot;id\u0026quot;: 1,\n        \u0026quot;name\u0026quot;: \u0026quot;AU_FREE\u0026quot;\n      }\n    ],\n    \u0026quot;media_items\u0026quot;: [\n      {\n        \u0026quot;id\u0026quot;: 1,\n        \u0026quot;media_item_type\u0026quot;: \u0026quot;ImageMediaItem\u0026quot;,\n        \u0026quot;url\u0026quot;: \u0026quot;http://s3.amazonaws.com/cc/image1.jpg\u0026quot;,\n        \u0026quot;description\u0026quot;: \u0026quot;\u0026quot;,\n        \u0026quot;sort_order\u0026quot;: 0,\n        \u0026quot;is_primary\u0026quot;: false,\n        \u0026quot;is_uploaded\u0026quot;: null,\n        \u0026quot;tag_list\u0026quot;: [],\n        \u0026quot;position\u0026quot;: 1,\n        \u0026quot;processing_options\u0026quot;: {\n          \u0026quot;apply_background\u0026quot;: true,\n          \u0026quot;background_colour\u0026quot;: \u0026quot;Gray\u0026quot;,\n          \u0026quot;tags\u0026quot;: [\u0026quot;grey1\u0026quot;,\u0026quot;grey2\u0026quot;]\n        }\n      }\n    ],\n    \u0026quot;inventories\u0026quot;: [\n      {\n        \u0026quot;id\u0026quot;: 1,\n        \u0026quot;qty\u0026quot;: 3,\n        \u0026quot;stock_availability\u0026quot;: \u0026quot;in_stock\u0026quot;,\n        \u0026quot;out_of_stock_threshold\u0026quot;: null,\n        \u0026quot;dispatch_time\u0026quot;: 5,\n        \u0026quot;dispatch_time_unit\u0026quot;: \u0026quot;day\u0026quot;,\n        \u0026quot;unit_cost\u0026quot;: null,\n        \u0026quot;style\u0026quot;: \u0026quot;static\u0026quot;,\n        \u0026quot;sku\u0026quot;: \u0026quot;12345\u0026quot;,\n        \u0026quot;support_shipping\u0026quot;: true,\n        \u0026quot;inventory_source\u0026quot;: {\n          \u0026quot;id\u0026quot;: 1,\n          \u0026quot;name\u0026quot;: \u0026quot;MOTUL\u0026quot;\n        }\n      }\n    ],\n    \u0026quot;price_items\u0026quot;: [\n      {\n        \u0026quot;id\u0026quot;: 1,\n        \u0026quot;amount\u0026quot;: 45,\n        \u0026quot;enabled?\u0026quot;: true,\n        \u0026quot;price_book\u0026quot;: {\n          \u0026quot;id\u0026quot;: 1,\n          \u0026quot;name\u0026quot;: \u0026quot;default\u0026quot;\n        },\n        \u0026quot;from\u0026quot;: null,\n        \u0026quot;to\u0026quot;: null\n      }\n    ],\n    \u0026quot;brand\u0026quot;: {\n      \u0026quot;id\u0026quot;: 1,\n      \u0026quot;name\u0026quot;: \u0026quot;Brand Name\u0026quot;,\n      \u0026quot;description\u0026quot;: null,\n      \u0026quot;logo_link\u0026quot;: \u0026quot;\u0026quot;\n    },\n    \u0026quot;dimension\u0026quot;: {\n      \u0026quot;id\u0026quot;: 1,\n      \u0026quot;length\u0026quot;: null,\n      \u0026quot;width\u0026quot;: null,\n      \u0026quot;height\u0026quot;: null,\n      \u0026quot;weight\u0026quot;: 5\n    },\n    \u0026quot;packed_dimension\u0026quot;: {\n      \u0026quot;id\u0026quot;: 2,\n      \u0026quot;length\u0026quot;: null,\n      \u0026quot;width\u0026quot;: null,\n      \u0026quot;height\u0026quot;: null,\n      \u0026quot;weight\u0026quot;: null\n    }\n  },\n  \u0026quot;created_at\u0026quot;: \u0026quot;2016-04-15T14:25:38.489+10:00\u0026quot;,\n  \u0026quot;updated_at\u0026quot;: \u0026quot;2016-04-27T16:10:51.655+10:00\u0026quot;\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/products/index","name":"index","apis":[{"api_url":"/api/v2/products","http_method":"GET","short_description":"List products","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":"id","full_name":"id","description":"\n\u003cp\u003eProduct 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":"code","full_name":"code","description":"\n\u003cp\u003eProduct 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":"name","full_name":"name","description":"\n\u003cp\u003eProduct 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":[]},{"name":"status","full_name":"status","description":"\n\u003cp\u003eProduct 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":"response_product_fields","full_name":"response_product_fields","description":"\n\u003cp\u003eVersion 5 only. One of ‘name’, ‘status’, ‘class_type’. The product information to be included in the product data response. Use comma to join multiple fields.\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":"response_associated_fields","full_name":"response_associated_fields","description":"\n\u003cp\u003eVersion 5 only. One of ‘product_class’, ‘product_family’, ‘brand’, ‘attribute_values’, ‘association_attribute_values’,‘dimension’, ‘packed_dimension’, ‘product_categories’, ‘catalogs’, ‘shipping_zones’, ‘price_items’, ‘inventories’, ‘media_items’, ‘entity_identifiers’, ‘child_product_variations’, ‘parent_product_kits’, ‘parent_product_groups’, ‘parent_product_variations’, ‘child_kit_members’, ‘child_group_members’. The information related to the product to be included in the product data response. Use comma to join multiple fields.\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":"root_products_only","full_name":"root_products_only","description":"\n\u003cp\u003eReturn products only at the root level. Defaults to true. Only applicable to CC V3 tenants\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"identifier_name","full_name":"identifier_name","description":"\n\u003cp\u003eExtra identifier name added via EntityIdentifier endpoint\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":"entity_key","full_name":"entity_key","description":"\n\u003cp\u003eExtra entity identifier key added via EntityIdentifier endpoint\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 (tenant version 1):\n  {\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 1,\n    \"entries\": [\n      {\n        \"en\": {\n          \"id\": 1,\n          \"product_type\": \"product\",\n          \"code\": \"12345\",\n          \"status\": \"active\",\n          \"product_attributes\": {\n            \"description\": {\n              \"base_type\": \"html\",\n              \"value\": \"\u003cp style=\"line-height: 18.5714px;\"\u003eThis is a description.\u003c/p\u003e\"\n            },\n            \"short_description\": {\n              \"base_type\": \"html\",\n              \"value\": \"\u003cspan style=\"line-height: 18.5714px;\"\u003eThis is a short description.\u003c/span\u003e\"\n            }\n          },\n          \"name\": \"Product 12345\",\n          \"is_complete\": true,\n          \"incomplete_fields\": {\n            \"missing_image\": false,\n            \"missing_category\": false,\n            \"missing_price\": false,\n            \"missing_attributes\": []\n          },\n          \"discontinued\": false,\n          \"shipping_options\": [],\n          \"attribute_set\": {\n            \"id\": 1,\n            \"name\": \"Automotive\"\n          },\n          \"product_level\": {\n            \"id\": 1,\n            \"name\": \"Products\"\n          },\n          \"product_categories\": [\n            {\n              \"is_primary\": false,\n              \"category_id\": 1,\n              \"name\": \"Engine Oil\",\n              \"path\": \"Engine Oil\",\n              \"category_set\": {\n                \"id\": 1,\n                \"name\": \"default\"\n              }\n            }\n          ],\n          \"catalogs\": [\n            {\n              \"id\": 1,\n              \"name\": \"Catalog Name\"\n            }\n          ],\n          \"shipping_zones\": [\n            {\n              \"id\": 1,\n              \"name\": \"AU_FREE\"\n            }\n          ],\n          \"media_items\": [\n            {\n              \"id\": 1,\n              \"media_item_type\": \"ImageMediaItem\",\n              \"url\": \"http://s3.amazonaws.com/cc/image1.jpg\",\n              \"description\": \"\",\n              \"sort_order\": 0,\n              \"is_primary\": false,\n              \"is_uploaded\": null,\n              \"tag_list\": [],\n              \"position\": 1\n            }\n          ],\n          \"inventories\": [\n            {\n              \"id\": 1,\n              \"qty\": 3,\n              \"stock_availability\": \"in_stock\",\n              \"out_of_stock_threshold\": null,\n              \"dispatch_time\": 5,\n              \"dispatch_time_unit\": \"day\",\n              \"unit_cost\": null,\n              \"style\": \"static\",\n              \"sku\": \"12345\",\n              \"support_shipping\": true,\n              \"inventory_source\": {\n                \"id\": 1,\n                \"name\": \"MOTUL\"\n              }\n            }\n          ],\n          \"price_items\": [\n            {\n              \"id\": 1,\n              \"amount\": 45,\n              \"enabled?\": true,\n              \"price_book\": {\n                \"id\": 1,\n                \"name\": \"default\"\n              },\n              \"from\": null,\n              \"to\": null\n            }\n          ],\n          \"brand\": {\n            \"id\": 1,\n            \"name\": \"Brand Name\",\n            \"description\": null,\n            \"logo_link\": \"\"\n          },\n          \"dimension\": {\n            \"id\": 1,\n            \"length\": null,\n            \"width\": null,\n            \"height\": null,\n            \"weight\": 5\n          },\n          \"packed_dimension\": {\n            \"id\": 2,\n            \"length\": null,\n            \"width\": null,\n            \"height\": null,\n            \"weight\": null\n          }\n        },\n        \"created_at\": \"2016-04-15T14:25:38.489+10:00\",\n        \"updated_at\": \"2016-04-27T16:10:51.655+10:00\"\n      }\n    ]\n  }\n\nResponse (tenant version 2. When root_products_only is true. This is the default behaviour):\n  {\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 1,\n    \"entries\": [\n      {\n        \"id\": 1,\n        \"product_type\": \"product\",\n        \"code\": \"shirt-a\",\n        \"status\": \"active\",\n        \"product_attributes\": {\n          \"description\": {\n            \"value\": \"test5\",\n            \"base_type\": \"html\"\n          },\n          \"short_description\": {\n            \"value\": \"test1\",\n            \"base_type\": \"html\"\n          }\n        },\n        \"name\": \"Shirt A updated 4\",\n        \"discontinued\": false,\n        \"children\": [\n          {\n            \"id\": 7,\n            \"product_type\": \"product\",\n            \"code\": \"shirt-a-white\",\n            \"status\": \"active\",\n            \"product_attributes\": {\n              \"colour\": {\n                \"value\": \"White\",\n                \"base_type\": \"string\"\n              }\n            },\n            \"name\": \"shirt-a-white\",\n            \"discontinued\": false,\n            \"children\": [\n              {\n                \"id\": 10,\n                \"product_type\": \"product\",\n                \"code\": \"shirt-a-white-xlarge\",\n                \"status\": \"active\",\n                \"product_attributes\": {\n                  \"ean\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  },\n                  \"gtin\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  },\n                  \"hero\": {\n                    \"value\": false,\n                    \"base_type\": \"boolean\"\n                  },\n                  \"isbn\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  },\n                  \"size\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  },\n                  \"upca\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  }\n                },\n                \"name\": \"shirt-a-white-xlarge\",\n                \"discontinued\": false,\n                \"children\": []\n              },\n              {\n                \"id\": 8,\n                \"product_type\": \"product\",\n                \"code\": \"shirt-a-white-small\",\n                \"status\": \"active\",\n                \"product_attributes\": {\n                  \"ean\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  },\n                  \"gtin\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  },\n                  \"hero\": {\n                    \"value\": false,\n                    \"base_type\": \"boolean\"\n                  },\n                  \"isbn\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  },\n                  \"size\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  },\n                  \"upca\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  }\n                },\n                \"name\": \"shirt-a-white-small\",\n                \"discontinued\": false,\n                \"children\": []\n              },\n              {\n                \"id\": 9,\n                \"product_type\": \"product\",\n                \"code\": \"shirt-a-white-large\",\n                \"status\": \"active\",\n                \"product_attributes\": {\n                  \"ean\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  },\n                  \"gtin\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  },\n                  \"hero\": {\n                    \"value\": false,\n                    \"base_type\": \"boolean\"\n                  },\n                  \"isbn\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  },\n                  \"size\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  },\n                  \"upca\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  }\n                },\n                \"name\": \"shirt-a-white-large\",\n                \"discontinued\": false,\n                \"children\": []\n              }\n            ]\n          },\n          {\n            \"id\": 2,\n            \"product_type\": \"product\",\n            \"code\": \"shirt-a-black\",\n            \"status\": \"active\",\n            \"product_attributes\": {\n              \"colour\": {\n                \"value\": \"black\",\n                \"base_type\": \"string\"\n              }\n            },\n            \"name\": \"Shirt A Black updated 2\",\n            \"discontinued\": false,\n            \"children\": [\n              {\n                \"id\": 11,\n                \"product_type\": \"product\",\n                \"code\": \"shirt-a-black-xlarge\",\n                \"status\": \"active\",\n                \"product_attributes\": {\n                  \"ean\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  },\n                  \"gtin\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  },\n                  \"hero\": {\n                    \"value\": false,\n                    \"base_type\": \"boolean\"\n                  },\n                  \"isbn\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  },\n                  \"size\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  },\n                  \"upca\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  }\n                },\n                \"name\": \"shirt-a-black-xlarge\",\n                \"discontinued\": false,\n                \"children\": []\n              },\n              {\n                \"id\": 3,\n                \"product_type\": \"product\",\n                \"code\": \"shirt-a-black-small\",\n                \"status\": \"active\",\n                \"product_attributes\": {\n                  \"ean\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  },\n                  \"gtin\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  },\n                  \"hero\": {\n                    \"value\": false,\n                    \"base_type\": \"boolean\"\n                  },\n                  \"isbn\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  },\n                  \"size\": {\n                    \"value\": \"Small\",\n                    \"base_type\": \"string\"\n                  },\n                  \"upca\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  }\n                },\n                \"name\": \"Shirt A Black Small updated 1\",\n                \"discontinued\": false,\n                \"children\": []\n              },\n              {\n                \"id\": 6,\n                \"product_type\": \"product\",\n                \"code\": \"shirt-a-black-large\",\n                \"status\": \"inactive\",\n                \"product_attributes\": {\n                  \"ean\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  },\n                  \"gtin\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  },\n                  \"hero\": {\n                    \"value\": false,\n                    \"base_type\": \"boolean\"\n                  },\n                  \"isbn\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  },\n                  \"size\": {\n                    \"value\": \"Large\",\n                    \"base_type\": \"string\"\n                  },\n                  \"upca\": {\n                    \"value\": \"\",\n                    \"base_type\": \"string\"\n                  }\n                },\n                \"name\": \"shirt-a-black-large\",\n                \"discontinued\": false,\n                \"children\": []\n              }\n            ]\n          },\n          {\n            \"id\": 12,\n            \"product_type\": \"product\",\n            \"code\": \"shirt-a-orange\",\n            \"status\": \"active\",\n            \"product_attributes\": {\n              \"colour\": {\n                \"value\": \"Orange\",\n                \"base_type\": \"string\"\n              }\n            },\n            \"name\": \"shirt-a-orange\",\n            \"discontinued\": false,\n            \"children\": []\n          }\n        ]\n      }\n    ]\n  }\n\nResponse (tenant version 2. When root_products_only is false):\n  {\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 1,\n    \"entries\": [\n      {\n        \"id\": 7,\n        \"product_type\": \"product\",\n        \"code\": \"shirt-a-white\",\n        \"status\": \"active\",\n        \"product_attributes\": {\n          \"colour\": {\n            \"value\": \"White\",\n            \"base_type\": \"string\"\n          }\n        },\n        \"name\": \"shirt-a-white\",\n        \"discontinued\": false,\n        \"parent_products\": {\n            \"id\": 1,\n            \"code\": \"shirt-a\",\n            \"parent_products\": {}\n        },\n        \"children\": [\n          {\n            \"id\": 10,\n            \"product_type\": \"product\",\n            \"code\": \"shirt-a-white-xlarge\",\n            \"status\": \"active\",\n            \"product_attributes\": {\n              \"ean\": {\n                \"value\": \"\",\n                \"base_type\": \"string\"\n              },\n              \"gtin\": {\n                \"value\": \"\",\n                \"base_type\": \"string\"\n              },\n              \"hero\": {\n                \"value\": false,\n                \"base_type\": \"boolean\"\n              },\n              \"isbn\": {\n                \"value\": \"\",\n                \"base_type\": \"string\"\n              },\n              \"size\": {\n                \"value\": \"\",\n                \"base_type\": \"string\"\n              },\n              \"upca\": {\n                \"value\": \"\",\n                \"base_type\": \"string\"\n              }\n            },\n            \"name\": \"shirt-a-white-xlarge\",\n            \"discontinued\": false,\n            \"parent_products\": {\n                \"id\": 7,\n                \"code\": \"shirt-a-white\",\n                \"parent_products\": {\n                    \"id\": 1,\n                    \"code\": \"shirt-a\",\n                    \"parent_products\": {}\n                }\n            },\n            \"children\": []\n          }\n        ]\n      },\n      {\n        \"id\": 3,\n        \"product_type\": \"product\",\n        \"code\": \"shirt-a-black-small\",\n        \"status\": \"active\",\n        \"product_attributes\": {\n          \"ean\": {\n            \"value\": \"\",\n            \"base_type\": \"string\"\n          },\n          \"gtin\": {\n            \"value\": \"\",\n            \"base_type\": \"string\"\n          },\n          \"hero\": {\n            \"value\": false,\n            \"base_type\": \"boolean\"\n          },\n          \"isbn\": {\n            \"value\": \"\",\n            \"base_type\": \"string\"\n          },\n          \"size\": {\n            \"value\": \"Small\",\n            \"base_type\": \"string\"\n          },\n          \"upca\": {\n            \"value\": \"\",\n            \"base_type\": \"string\"\n          }\n        },\n        \"name\": \"Shirt A Black Small updated 1\",\n        \"discontinued\": false,\n        \"parent_products\": {\n            \"id\": 2,\n            \"code\": \"shirt-a-black\",\n            \"parent_products\": {\n                \"id\": 1,\n                \"code\": \"shirt-a\",\n                \"parent_products\": {}\n            }\n        },\n        \"children\": []\n      }\n    ]\n  }\n\n  Response (tenant version 5):\n\n  {\n      \"page\": 1,\n      \"per_page\": 50,\n      \"total_pages\": 1,\n      \"total_entries\": 1,\n      \"entries\": [\n          {\n              \"id\": 1775,\n              \"product_type\": null,\n              \"code\": \"shirt-a\",\n              \"status\": \"active\",\n              \"product_attributes\": null,\n              \"name\": \"Shirt A\",\n              \"class_type\": \"variation\",\n              \"discontinued\": false,\n              \"product_class\": {\n                  \"id\": 17,\n                  \"name\": \"Style\"\n              },\n              \"attribute_values\": [\n                  {\n                      \"attribute_definition_id\": 7,\n                      \"attribute_definition_code\": \"country_of_origin\",\n                      \"data\": \"Germany\"\n                  },\n                  {\n                      \"attribute_definition_id\": 2,\n                      \"attribute_definition_code\": \"short_description\",\n                      \"data\": \"test short description\"\n                  },\n                  {\n                      \"attribute_definition_id\": 14,\n                      \"attribute_definition_code\": \"season\",\n                      \"data\": \"Spring\"\n                  },\n                  {\n                      \"attribute_definition_id\": 1,\n                      \"attribute_definition_code\": \"description\",\n                      \"data\": \"test description\"\n                  }\n              ],\n              \"association_attribute_values\": [\n                {\n                    \"attribute_definition_id\": 19,\n                    \"attribute_definition_code\": \"npc_association_1\",\n                    \"associated_code\": \"npc_entity_1\",\n                    \"associated_type\": \"NpcEntity\"\n                }\n              ]\n          }\n      ]\n  }\n\n  Response with product variations (response_associated_fields=child_product_variations,child_kit_members,parent_product_groups):\n\n  {\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 3,\n    \"entries\": [\n        {\n            \"id\": 2,\n            \"code\": \"t-shirt-red\",\n            \"child_product_variations\": [\n                {\n                    \"id\": 4,\n                    \"code\": \"t-shirt-red-small\",\n                    \"created_at\": \"2019-07-22T14:08:52.576+10:00\",\n                    \"updated_at\": \"2020-03-17T16:18:45.192+11:00\"\n                },\n                {\n                    \"id\": 8,\n                    \"code\": \"t-shirt-red-large\",\n                    \"created_at\": \"2019-08-09T11:12:40.425+10:00\",\n                    \"updated_at\": \"2019-10-03T10:27:31.592+10:00\"\n                }\n            ]\n        },\n        {\n          \"id\": 69,\n          \"code\": \"large-kit\",\n          \"child_kit_members\": [\n              {\n                  \"id\": 28,\n                  \"code\": \"t-shirt-blue-large\",\n                  \"created_at\": \"2019-10-31T14:01:19.746+11:00\",\n                  \"updated_at\": \"2020-04-14T14:03:31.769+10:00\",\n                  \"qty\": 10\n              }\n          ]\n      },\n      {\n        \"id\": 2,\n        \"code\": \"t-shirt-red\",\n        \"parent_product_groups\": [\n            {\n                \"id\": 27,\n                \"code\": \"formal-party-french\",\n                \"created_at\": \"2019-10-25T11:35:01.778+11:00\",\n                \"updated_at\": \"2020-02-07T09:44:55.101+11:00\",\n                \"sort_order\": null\n            }\n        ]\n    }\n    ]\n}\n\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/products/create","name":"create","apis":[{"api_url":"/api/v2/products","http_method":"POST","short_description":"Create or update a product","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":"product","full_name":"product","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"locale","full_name":"product[locale]","description":"\n\u003cp\u003eLocale for this product. Should be one of the language codes defined on CommerceConnect. Defaults to the default language.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"product[name]","description":"\n\u003cp\u003eProduct or sku name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"code","full_name":"product[code]","description":"\n\u003cp\u003eUnique identifier for product and sku\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"_new_code","full_name":"product[_new_code]","description":"\n\u003cp\u003eUpdate the code of existing product\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribute_set","full_name":"product[attribute_set]","description":"\n\u003cp\u003eAttribute set name that this product is assigned to. This must be created beforehand\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_class_name","full_name":"product[product_class_name]","description":"\n\u003cp\u003eClass name that this product is assigned to. This must be created beforehand\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_family_code","full_name":"product[product_family_code]","description":"\n\u003cp\u003eProduct family code\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_type","full_name":"product[product_type]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eproduct\u003c/code\u003e, \u003ccode\u003ekit\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"product[status]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einactive\u003c/code\u003e, \u003ccode\u003eactive\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"kit_create_mode","full_name":"product[kit_create_mode]","description":"\n\u003cp\u003eProvide this only for creating new kit. Empty kit - create empty kit in the provided attribute set. Clone from existing SKU - create a kit by copying all data from the product with code in base_sku_code_for_clone field\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eEmpty kit\u003c/code\u003e, \u003ccode\u003eClone from existing SKU\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"base_sku_code_for_clone","full_name":"product[base_sku_code_for_clone]","description":"\n\u003cp\u003eThe product code (must be SKU/bottom level product) to clone for new kit. kit_create_mode must be Clone from existing SKU. Provide this only for creating new kit\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"brand","full_name":"product[brand]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"product[brand][id]","description":"\n\u003cp\u003eBrand ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"product_attributes","full_name":"product[product_attributes]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"_any_attribute_code_","full_name":"product[product_attributes][_any_attribute_code_]","description":"\n\u003cp\u003eThe key of attribute is attribute code and value is a valid json type that matches the base type of the attribute\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"dimension","full_name":"product[dimension]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"length","full_name":"product[dimension][length]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"width","full_name":"product[dimension][width]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"height","full_name":"product[dimension][height]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"weight","full_name":"product[dimension][weight]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"packed_dimension","full_name":"product[packed_dimension]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"length","full_name":"product[packed_dimension][length]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"width","full_name":"product[packed_dimension][width]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"height","full_name":"product[packed_dimension][height]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"weight","full_name":"product[packed_dimension][weight]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"shipping_zones","full_name":"product[shipping_zones]","description":"\n\u003cp\u003eReplace existing shipping zones with these new shipping zones\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"price_items","full_name":"product[price_items]","description":"\n\u003cp\u003eAdd new prices or update existing prices if they exist.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"price_book_name","full_name":"product[price_items][price_book_name]","description":"\n\u003cp\u003eName of an existing price book to which this price item is linked\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"product[price_items][from]","description":"\n\u003cp\u003eValid from\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"product[price_items][to]","description":"\n\u003cp\u003eValid to\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"amount","full_name":"product[price_items][amount]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"categories","full_name":"product[categories]","description":"\n\u003cp\u003eSet the product’s categories to these categories (existing categories will be removed)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"product[categories][id]","description":"\n\u003cp\u003eCategory ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"catalogs","full_name":"product[catalogs]","description":"\n\u003cp\u003eLink these catalogs with the product.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"product[catalogs][id]","description":"\n\u003cp\u003eCatalog ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"product[catalogs][name]","description":"\n\u003cp\u003eCatalog name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"media_items","full_name":"product[media_items]","description":"\n\u003cp\u003eSet the product’s media items to these (existing media items will be removed).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"media_item_type","full_name":"product[media_items][media_item_type]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eImageMediaItem\u003c/code\u003e, \u003ccode\u003eVideoMediaItem\u003c/code\u003e, \u003ccode\u003eFileMediaItem\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"product[media_items][url]","description":"\n\u003cp\u003eURL that stores the corresponding media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"product[media_items][description]","description":"\n\u003cp\u003eDescription for the media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order_position","full_name":"product[media_items][sort_order_position]","description":"\n\u003cp\u003eThe position of the media item. Non negative integer is supported\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"is_primary","full_name":"product[media_items][is_primary]","description":"\n\u003cp\u003eMake this media item as primary\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag_list","full_name":"product[media_items][tag_list]","description":"\n\u003cp\u003eTags for this media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"processing_options","full_name":"product[media_items][processing_options]","description":"\n\u003cp\u003eOptions to perform extra image processing on the media item. This is applicable only when media_item_type is ‘ImageMediaItem’\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"apply_background","full_name":"product[media_items][processing_options][apply_background]","description":"\n\u003cp\u003eSetting this to true would result in a new media item created against the product with background applied. Removes transparency.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"background_colour","full_name":"product[media_items][processing_options][background_colour]","description":"\n\u003cp\u003eThe colour name or a hex colour code for the background colour for the created media item. Defaults to white.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"processed_tags","full_name":"product[media_items][processing_options][processed_tags]","description":"\n\u003cp\u003eThe tags for the created media item.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]}]}]},{"name":"inventories","full_name":"product[inventories]","description":"\n\u003cp\u003eAdd new inventory or update existing inventory data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"inventory_source","full_name":"product[inventories][inventory_source]","description":"\n\u003cp\u003eInventory source name to which this inventory is applied\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sku","full_name":"product[inventories][sku]","description":"\n\u003cp\u003eInventory source related SKU\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"qty","full_name":"product[inventories][qty]","description":"\n\u003cp\u003eQuantity in the inventory source specified\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"available_qty","full_name":"product[inventories][available_qty]","description":"\n\u003cp\u003eAvailable quantity in the inventory source specified\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"stock_availability","full_name":"product[inventories][stock_availability]","description":"\n\u003cp\u003eFlag to indicate the stock level\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eout_of_stock\u003c/code\u003e, \u003ccode\u003ein_stock\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"out_of_stock_threshold","full_name":"product[inventories][out_of_stock_threshold]","description":"\n\u003cp\u003eOut of stock threshold\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dispatch_time","full_name":"product[inventories][dispatch_time]","description":"\n\u003cp\u003eDispatch time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dispatch_time_unit","full_name":"product[inventories][dispatch_time_unit]","description":"\n\u003cp\u003eDispatch time unit\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eday\u003c/code\u003e, \u003ccode\u003ehour\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"unit_cost","full_name":"product[inventories][unit_cost]","description":"\n\u003cp\u003eUnit cost of the product for this inventory source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"style","full_name":"product[inventories][style]","description":"\n\u003cp\u003eDynamic means Qty changes and Static means Qty stays the same. This is related to inventory decrement for order download\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edynamic\u003c/code\u003e, \u003ccode\u003estatic\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"variants","full_name":"product[variants]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"_product_code_","full_name":"product[variants][_product_code_]","description":"\n\u003cp\u003eChild product. It accepts the params of a product\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]},{"name":"virtual_products","full_name":"product[virtual_products]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"_virtual_product_code_","full_name":"product[virtual_products][_virtual_product_code_]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"code","full_name":"product[virtual_products][_virtual_product_code_][code]","description":"\n\u003cp\u003eUnique identifier for virtual product\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"product[virtual_products][_virtual_product_code_][name]","description":"\n\u003cp\u003eVirtual product name. Required for creating new virtual\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"product[virtual_products][_virtual_product_code_][status]","description":"\n\u003cp\u003eRequired for creating new virtual product\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einactive\u003c/code\u003e, \u003ccode\u003eactive\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attributes","full_name":"product[virtual_products][_virtual_product_code_][attributes]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"_any_attribute_code_","full_name":"product[virtual_products][_virtual_product_code_][attributes][_any_attribute_code_]","description":"\n\u003cp\u003eThe key of attribute is attribute code and value is a valid json type that matches the base type of the attribute\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}]},{"name":"kit_skus","full_name":"product[kit_skus]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"product_code","full_name":"product[kit_skus][product_code]","description":"\n\u003cp\u003eProduct code. It must be at bottom level (SKU) and cannot be a Kit\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"qty","full_name":"product[kit_skus][qty]","description":"\n\u003cp\u003eThe qty of the bundled SKU\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":[]}]}]}],"returns":[],"examples":[" request:\n   {\n     \"product\": {\n       \"code\": \"product_1\",\n       \"name\": \"Product 1\",\n       \"attribute_set\": \"Automotive\",\n       \"product_type\": \"product\",\n       \"status\": \"active\",\n       \"brand\": {\n         \"id\": 1\n       },\n       \"product_attributes\": {\n         \"description\": \"Product 1 description\",\n         \"npc_association_1\": {\n           \"associated_id\": 1\n         },\n         \"npc_association_1\": {\n           \"associated_code\": \"npc_entity_1\"\n         }\n       },\n       \"categories\": [\n         {\n           \"path\": \"Engine Oil\",\n           \"is_primary\": true,\n           \"category_set\": \"default\"\n         }\n       ],\n       \"entity_identifiers\": [\n         {\n           \"key\": \"10000000001\",\n           \"name\": \"Channel Name\"\n         },\n         {\n           \"key\": \"20000000002\",\n           \"name\": \"Channel Name\"\n         }\n       ],\n       \"shipping_zones\": [\n         \"AU_FREE\"\n       ]\n     }\n   }\n\n   Sample: create a product in a one level attribute set with minimal data required\n\n   {\n     \"product\": {\n       \"code\": \"code-001\",\n       \"name\": \"Name 001\",\n       \"attribute_set\": \"Automotive\",\n       \"product_type\": \"product\",\n       \"status\": \"active\"\n     }\n   }\n\n   Sample: update some fields of an existing product\n\n   {\n     \"product\": {\n       \"code\": \"code-001\",\n       \"product_attributes\": {\n         \"description\": \"content test here\",\n         \"gender\": \"Male\"\n       }\n     }\n   }\n\n   Sample: update product code of an existing product\n\n   {\n     \"product\": {\n       \"code\": \"code-001\",\n       \"_new_code\": \"code-0001-new\"\n     }\n   }\n\n   or\n\n   {\n     \"product\": {\n       \"id\": 1,\n       \"_new_code\": \"code-0001-new\"\n     }\n   }\n\n\n\n   Sample: full sample of multi-level products. All data associated with a product can be sent together\n\n   {\n     \"product\": {\n       \"code\": \"code-001\",\n       \"name\": \"Name 001\",\n       \"attribute_set\": \"Apparel\",\n       \"product_type\": \"product\",\n       \"status\": \"inactive\",\n       \"brand\": {\n         \"id\": 23\n       },\n       \"categories\": [\n           {\n            \"id\": 5\n           }\n       ],\n       \"price_items\": [\n         {\n           \"price_book_name\": \"Default\",\n           \"amount\": 100\n         }\n       ],\n       \"product_attributes\": {\n         \"description\": \"content test here\",\n         \"gender\": \"Male\"\n       },\n       \"variants\": {\n           \"code-001-blue\": {\n               \"code\": \"code-001-blue1\",\n               \"name\": \"001 blue\",\n               \"status\": \"inactive\",\n                \"media_items\": [\n                 {\n                   \"media_item_type\": \"ImageMediaItem\",\n                   \"url\": \"https://robohash.org/my-own-slug.png?size=50x50\",\n                   \"tag_list\": [\"thumbnail\"]\n                 }\n                ],\n                \"price_items\": [\n                 {\n                   \"price_book_name\": \"Default\",\n                   \"amount\": 100\n                 }\n                ],\n                \"product_attributes\": {\n                  \"colour\": \"Blue\"\n                 },\n                 \"variants\": {\n                     \"code-001-blue-large\": {\n                         \"code\": \"code-001-blue-large\",\n                         \"name\": \"001 blue large\",\n                         \"status\": \"inactive\",\n                         \"product_attributes\": {\n                             \"size\": \"Large\"\n                         },\n                         \"inventories\": [\n                             {\n                               \"inventory_source\": \"DC1\",\n                               \"qty\": 1,\n                               \"available_qty\": 2,\n                               \"stock_availability\": \"in_stock\",\n                               \"dispatch_time\": 3,\n                               \"dispatch_time_unit\": \"day\",\n                               \"style\": \"dynamic\"\n                             }\n                       ]\n                     }\n                 }\n           }\n       }\n     }\n   }\n\n   Sample: update some fields of an existing variant. Note product code of each level must be supplied\n\n   {\n     \"product\": {\n       \"code\": \"code-001\",\n       \"variants\": {\n           \"code-001-blue\": {\n               \"code\": \"code-001-blue1\",\n               \"variants\": {\n                   \"code-001-blue-large\": {\n                       \"code\": \"code-001-blue-large\",\n                       \"product_attributes\": {\n                           \"description\": \"Fancy\"\n                       },\n                       \"inventories\": [\n                         {\n                           \"inventory_source\": \"DC1\",\n                           \"qty\": 20,\n                         }\n                       ]\n                   }\n               }\n           }\n       }\n     }\n   }\n\n   Sample: Use product identifier (instead of code) to update product\n\n   {\n      \"product\": {\n           \"identifier_name\": \"MPN\",\n           \"entity_key\": \"m-001\",\n           \"product_attributes\": {\n             \"description\": \"Product 2 description\"\n           }\n       }\n    }\n\n   Class product\n\n   Differences for class product:\n   - product_class_name is used instead of attribute set.\n   - json type custom attribute needs to be serialised string.\n   - Single option and multi-option type custom attribute needs to be option value ID instead of label. See samples below.\n   - variants element is not supported. See below for new element to link products.\n\n\n   Sample for product creation\n\n   {\n     \"product\": {\n       \"code\": \"sku-12\",\n       \"name\": \"Product ABC\",\n       \"status\": \"inactive\",\n       \"product_class_name\": \"Class ABC\"\n     }\n   }\n\n   Add three level products (Style-Colour-Size) or more along with associations\n\n   {\n     \"product\": {\n       \"name\":\"jacket\",\n       \"code\":\"jacket\",\n       \"status\":\"active\",\n       \"product_type\":\"product\",\n       \"product_class_name\":\"Style\",\n       \"variants\": {\n         \"jacket-red\": {\n           \"name\":\"jacket-red\",\n           \"code\":\"jacket-red\",\n           \"status\":\"active\",\n           \"product_type\":\"product\",\n           \"product_class_name\":\"Colour\",\n           \"parent_variations\": [\n             {\"product_code\": \"jacket\"}\n           ],\n           \"variants\": {\n             \"jacket-red-sm\": {\n               \"name\":\"jacket-red-sm\",\n               \"code\":\"jacket-red-sm\",\n               \"status\":\"active\",\n               \"product_type\":\"product\",\n               \"product_class_name\":\"Size\",\n               \"parent_variations\": [\n                 {\"product_code\": \"jacket-red\"}\n               ]\n             }\n           }\n         },\n         \"jacket-blue\": {\n           \"name\":\"jacket-blue\",\n           \"code\":\"jacket-blue\",\n           \"status\":\"active\",\n           \"product_type\":\"product\",\n           \"product_class_name\":\"Colour\",\n           \"parent_variations\": [\n             {\"product_code\": \"jacket\"}\n           ],\n           \"variants\": {\n             \"jacket-blue-sm\": {\n               \"name\":\"jacket-blue-sm\",\n               \"code\":\"jacket-blue-sm\",\n               \"status\":\"active\",\n               \"product_type\":\"product\",\n               \"product_class_name\":\"Size\",\n               \"parent_variations\": [\n                 {\"product_code\": \"jacket-blue\"}\n               ]\n             }\n           }\n         }\n       }\n     }\n   }\n\n   Add Variations to Parent from Parent Product\n\n   {\n     \"product\": {\n       \"code\": \"ABC\",\n       \"product_variations\": [\n       \t {\n       \t   \"child_id\": 235\n       \t },\n       \t {\n       \t   \"child_product_code\": \"ABC-Black\"\n       \t }\n       \t]\n     }\n   }\n\n   Add Variations to Parent from Child Product\n\n   {\n     \"product\": {\n       \"code\": \"ABC-Black\",\n       \"parent_variations\": [\n       \t {\n       \t   \"parent_id\": 25\n       \t },\n       \t {\n       \t   \"product_code\": \"ABC\"\n       \t }\n       \t]\n     }\n   }\n\n\n   Add Product to Grouped products from Child product:\n\n   {\n     \"product\": {\n       \"code\": \"sku-12\",\n       \"groups\": [\n       \t {\n       \t   \"group_id\": 259\n       \t },\n       \t {\n       \t   \"product_code\": \"group-3\"\n       \t }\n       \t]\n     }\n   }\n\n   Add Product to Grouped products from Grouped Product:\n\n   {\n     \"product\": {\n       \"code\": \"sku-12\",\n       \"group_members\": [\n       \t {\n       \t   \"member_id\": 2583\n       \t },\n          {\n       \t   \"sku_code\": \"sku-6\",\n            \"sort_order\": 100\n       \t }\n     \t]\n     }\n   }\n\n   Add Child Related Products to Product\n   {\n     \"product\": {\n       \"code\": \"sku-12\",\n       \"child_related_products\": [\n       \t {\n            \"relationship_id\": 1,\n            \"child_product_id\": 12,\n            \"sort_order\": 1,\n            \"status\": \"active\"\n       \t },\n          {\n            \"relationship_code\": \"relationship_1\",\n       \t   \"child_product_code\": \"child_product_code_1\",\n            \"sort_order\": 2,\n            \"status\": \"inactive\"\n       \t }\n     \t]\n     }\n   }\n\n   Add Product to Parent Related Products\n   {\n     \"product\": {\n       \"code\": \"sku-12\",\n       \"parent_related_products\": [\n       \t {\n            \"relationship_id\": 1,\n            \"parent_product_id\": 12,\n            \"sort_order\": 1,\n            \"status\": \"active\"\n       \t },\n          {\n            \"relationship_code\": \"relationship_1\",\n       \t   \"parent_product_code\": \"child_product_code_1\",\n            \"sort_order\": 2,\n            \"status\": \"inactive\"\n       \t }\n     \t]\n     }\n   }\n\n   Add Product to Kit Products from Child product:\n\n   {\n     \"product\": {\n       \"code\": \"sku-12\",\n       \"parent_kits\": [\n          {\n            \"parent_id\": 260,\n            \"qty\": 2\n          },\n          {\n            \"parent_product_code\": \"kit-3\",\n            \"qty\": 1\n          }\n         ]\n     }\n   }\n\n   Add Product to Kit products from Parent Product:\n\n   {\n     \"product\": {\n       \"code\": \"kit-3\",\n       \"kit_members\": [\n          {\n            \"child_id\": 2583,\n            \"qty\": 2\n          },\n          {\n            \"child_product_code\": \"sku-6\",\n            \"qty\": 1\n          }\n       ]\n     }\n   }\n\n   Single option, multi option values:\n\n   {\n     \"product\": {\n       \"code\": \"sku-12\"\n       \"product_attributes\": {\n         \"option1\": 2,\n         \"option2\": [ { \"code\": \"blue\" } ],\n         \"option3\": [4, 5],\n         \"option4\": [ { \"code\": \"A\" }, { \"code\": \"B\" } ]\n       }\n     }\n   }\n\n   Multi association values:\n   Supported Mode:\n   - upsert: default\n   - reset: Delete all existing association for this attribute, and replace with the current one. Send empty array to remove all existing values.\n\n   {\n     \"product\": {\n       \"code\": \"sku-12\"\n       \"product_attributes\": {\n         \"npc_association_1\": {\n           \"associated_id\": [1],\n           \"mode\": \"upsert\"\n         },\n         \"npc_association_2\": {\n           \"associated_code\": [\"npc_entity_1\"],\n           \"mode\": \"reset\"\n         }\n       }\n     }\n   }\n\n\n   Create Single option, multi option values if not exists and assign to product:\n\n   {\n     \"product\": {\n       \"code\": \"sku-12\"\n       \"product_attributes\": {\n         \"option2\": [ { \"code\": \"blue\", \"name\": \"Blue\" } ],\n         \"option4\": [ { \"code\": \"A\", \"name\": \"A\" }, { \"code\": \"B\", \"name\": \"B\" } ]\n       }\n     }\n   }\n\n\n\n Response (teannt version 1):\n   {\n     \"en\": {\n       \"id\": 2,\n       \"product_type\": \"product\",\n       \"code\": \"product_1\",\n       \"status\": \"active\",\n       \"product_attributes\": {\n         \"description\": {\n           \"base_type\": \"html\",\n           \"value\": \"Product 1 description\"\n         },\n         \"short_description\": {\n           \"base_type\": \"html\",\n           \"value\": \"\"\n         }\n       },\n       \"name\": \"Product 1\",\n       \"is_complete\": false,\n       \"incomplete_fields\": {\n         \"missing_image\": true,\n         \"missing_category\": false,\n         \"missing_price\": true,\n         \"missing_attributes\": null\n       },\n       \"discontinued\": false,\n       \"shipping_options\": [],\n       \"attribute_set\": {\n         \"id\": 1,\n         \"name\": \"Automotive\"\n       },\n       \"product_level\": {\n         \"id\": 1,\n         \"name\": \"Products\"\n       },\n       \"brand\": {\n         \"id\": 1,\n         \"name\": \"MOTUL\",\n         \"description\": null,\n         \"logo_link\": \"\"\n       },\n       \"product_categories\": [\n         {\n           \"is_primary\": true,\n           \"category_id\": 1,\n           \"name\": \"Engine Oil\",\n           \"path\": \"Engine Oil\",\n           \"category_set\": {\n             \"id\": 1,\n             \"name\": \"default\"\n           }\n         }\n       ],\n       \"catalogs\": [],\n       \"shipping_zones\": [\n         {\n           \"id\": 1,\n           \"name\": \"AU_FREE\"\n         }\n       ],\n       \"media_items\": []\n     },\n     \"created_at\": \"2016-05-11T14:45:58.210+10:00\",\n     \"updated_at\": \"2016-05-11T14:45:58.817+10:00\"\n   }\n\nResponse (teannt version 2):\n   {\n     \"id\": 1,\n     \"product_type\": \"product\",\n     \"code\": \"shirt-a\",\n     \"status\": \"active\",\n     \"product_attributes\": {\n       \"description\": {\n         \"value\": \"test5\",\n         \"base_type\": \"html\"\n       },\n       \"short_description\": {\n         \"value\": \"test1\",\n         \"base_type\": \"html\"\n       }\n     },\n     \"name\": \"Shirt A updated\",\n     \"discontinued\": false,\n     \"children\": [\n       {\n         \"id\": 7,\n         \"product_type\": \"product\",\n         \"code\": \"shirt-a-white\",\n         \"status\": \"active\",\n         \"product_attributes\": {\n           \"colour\": {\n             \"value\": \"White\",\n             \"base_type\": \"string\"\n           }\n         },\n         \"name\": \"shirt-a-white\",\n         \"discontinued\": false,\n         \"children\": [\n           {\n             \"id\": 10,\n             \"product_type\": \"product\",\n             \"code\": \"shirt-a-white-xlarge\",\n             \"status\": \"active\",\n             \"product_attributes\": {\n               \"ean\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               },\n               \"gtin\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               },\n               \"hero\": {\n                 \"value\": false,\n                 \"base_type\": \"boolean\"\n               },\n               \"isbn\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               },\n               \"size\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               },\n               \"upca\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               }\n             },\n             \"name\": \"shirt-a-white-xlarge\",\n             \"discontinued\": false,\n             \"children\": []\n           },\n           {\n             \"id\": 8,\n             \"product_type\": \"product\",\n             \"code\": \"shirt-a-white-small\",\n             \"status\": \"active\",\n             \"product_attributes\": {\n               \"ean\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               },\n               \"gtin\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               },\n               \"hero\": {\n                 \"value\": false,\n                 \"base_type\": \"boolean\"\n               },\n               \"isbn\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               },\n               \"size\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               },\n               \"upca\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               }\n             },\n             \"name\": \"shirt-a-white-small\",\n             \"discontinued\": false,\n             \"children\": []\n           },\n           {\n             \"id\": 9,\n             \"product_type\": \"product\",\n             \"code\": \"shirt-a-white-large\",\n             \"status\": \"active\",\n             \"product_attributes\": {\n               \"ean\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               },\n               \"gtin\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               },\n               \"hero\": {\n                 \"value\": false,\n                 \"base_type\": \"boolean\"\n               },\n               \"isbn\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               },\n               \"size\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               },\n               \"upca\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               }\n             },\n             \"name\": \"shirt-a-white-large\",\n             \"discontinued\": false,\n             \"children\": []\n           }\n         ]\n       },\n       {\n         \"id\": 2,\n         \"product_type\": \"product\",\n         \"code\": \"shirt-a-black\",\n         \"status\": \"active\",\n         \"product_attributes\": {\n           \"colour\": {\n             \"value\": \"black\",\n             \"base_type\": \"string\"\n           }\n         },\n         \"name\": \"Shirt A Black updated 2\",\n         \"discontinued\": false,\n         \"children\": [\n           {\n             \"id\": 11,\n             \"product_type\": \"product\",\n             \"code\": \"shirt-a-black-xlarge\",\n             \"status\": \"active\",\n             \"product_attributes\": {\n               \"ean\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               },\n               \"gtin\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               },\n               \"hero\": {\n                 \"value\": false,\n                 \"base_type\": \"boolean\"\n               },\n               \"isbn\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               },\n               \"size\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               },\n               \"upca\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               }\n             },\n             \"name\": \"shirt-a-black-xlarge\",\n             \"discontinued\": false,\n             \"children\": []\n           },\n           {\n             \"id\": 3,\n             \"product_type\": \"product\",\n             \"code\": \"shirt-a-black-small\",\n             \"status\": \"active\",\n             \"product_attributes\": {\n               \"ean\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               },\n               \"gtin\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               },\n               \"hero\": {\n                 \"value\": false,\n                 \"base_type\": \"boolean\"\n               },\n               \"isbn\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               },\n               \"size\": {\n                 \"value\": \"Small\",\n                 \"base_type\": \"string\"\n               },\n               \"upca\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               }\n             },\n             \"name\": \"Shirt A Black Small updated 1\",\n             \"discontinued\": false,\n             \"children\": []\n           },\n           {\n             \"id\": 6,\n             \"product_type\": \"product\",\n             \"code\": \"shirt-a-black-large\",\n             \"status\": \"inactive\",\n             \"product_attributes\": {\n               \"ean\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               },\n               \"gtin\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               },\n               \"hero\": {\n                 \"value\": false,\n                 \"base_type\": \"boolean\"\n               },\n               \"isbn\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               },\n               \"size\": {\n                 \"value\": \"Large\",\n                 \"base_type\": \"string\"\n               },\n               \"upca\": {\n                 \"value\": \"\",\n                 \"base_type\": \"string\"\n               }\n             },\n             \"name\": \"shirt-a-black-large\",\n             \"discontinued\": false,\n             \"children\": []\n           }\n         ]\n       },\n       {\n         \"id\": 12,\n         \"product_type\": \"product\",\n         \"code\": \"shirt-a-orange\",\n         \"status\": \"active\",\n         \"product_attributes\": {\n           \"colour\": {\n             \"value\": \"Orange\",\n             \"base_type\": \"string\"\n           }\n         },\n         \"name\": \"shirt-a-orange\",\n         \"discontinued\": false,\n         \"children\": []\n       }\n     ]\n   }\n\n   Response for Class product:\n\n   attribute_values is returned instead of product_attributes.\n\n   {\n     \"id\": 2712,\n     \"product_type\": null,\n     \"code\": \"csv-group-1\",\n     \"status\": \"active\",\n     \"product_attributes\": null,\n     \"name\": \"csv-group-1\",\n     \"class_type\": \"grouped\",\n     \"discontinued\": false,\n     \"children\": [],\n     \"attribute_values\": [\n         {\n             \"attribute_definition_id\": 25,\n             \"attribute_definition_code\": \"multi_option_attributes\",\n             \"data\": []\n         },\n         {\n             \"attribute_definition_id\": 2,\n             \"attribute_definition_code\": \"short_description\",\n             \"data\": \"\"\n         }\n       ]\n    }\n\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/products/update","name":"update","apis":[{"api_url":"/api/v2/products/:id","http_method":"PUT","short_description":"Update a product","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":"product","full_name":"product","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"locale","full_name":"product[locale]","description":"\n\u003cp\u003eLocale for this product. Should be one of the language codes defined on CommerceConnect. Defaults to the default language.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"product[name]","description":"\n\u003cp\u003eProduct or sku name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"code","full_name":"product[code]","description":"\n\u003cp\u003eUnique identifier for product and sku\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"_new_code","full_name":"product[_new_code]","description":"\n\u003cp\u003eUpdate the code of existing product\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribute_set","full_name":"product[attribute_set]","description":"\n\u003cp\u003eAttribute set name that this product is assigned to. This must be created beforehand\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_class_name","full_name":"product[product_class_name]","description":"\n\u003cp\u003eClass name that this product is assigned to. This must be created beforehand\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_family_code","full_name":"product[product_family_code]","description":"\n\u003cp\u003eProduct family code\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_type","full_name":"product[product_type]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eproduct\u003c/code\u003e, \u003ccode\u003ekit\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"product[status]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einactive\u003c/code\u003e, \u003ccode\u003eactive\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"kit_create_mode","full_name":"product[kit_create_mode]","description":"\n\u003cp\u003eProvide this only for creating new kit. Empty kit - create empty kit in the provided attribute set. Clone from existing SKU - create a kit by copying all data from the product with code in base_sku_code_for_clone field\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eEmpty kit\u003c/code\u003e, \u003ccode\u003eClone from existing SKU\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"base_sku_code_for_clone","full_name":"product[base_sku_code_for_clone]","description":"\n\u003cp\u003eThe product code (must be SKU/bottom level product) to clone for new kit. kit_create_mode must be Clone from existing SKU. Provide this only for creating new kit\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"brand","full_name":"product[brand]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"product[brand][id]","description":"\n\u003cp\u003eBrand ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"product_attributes","full_name":"product[product_attributes]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"_any_attribute_code_","full_name":"product[product_attributes][_any_attribute_code_]","description":"\n\u003cp\u003eThe key of attribute is attribute code and value is a valid json type that matches the base type of the attribute\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"dimension","full_name":"product[dimension]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"length","full_name":"product[dimension][length]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"width","full_name":"product[dimension][width]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"height","full_name":"product[dimension][height]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"weight","full_name":"product[dimension][weight]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"packed_dimension","full_name":"product[packed_dimension]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"length","full_name":"product[packed_dimension][length]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"width","full_name":"product[packed_dimension][width]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"height","full_name":"product[packed_dimension][height]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"weight","full_name":"product[packed_dimension][weight]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"shipping_zones","full_name":"product[shipping_zones]","description":"\n\u003cp\u003eReplace existing shipping zones with these new shipping zones\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"price_items","full_name":"product[price_items]","description":"\n\u003cp\u003eAdd new prices or update existing prices if they exist.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"price_book_name","full_name":"product[price_items][price_book_name]","description":"\n\u003cp\u003eName of an existing price book to which this price item is linked\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"product[price_items][from]","description":"\n\u003cp\u003eValid from\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"product[price_items][to]","description":"\n\u003cp\u003eValid to\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"amount","full_name":"product[price_items][amount]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"categories","full_name":"product[categories]","description":"\n\u003cp\u003eSet the product’s categories to these categories (existing categories will be removed)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"product[categories][id]","description":"\n\u003cp\u003eCategory ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"catalogs","full_name":"product[catalogs]","description":"\n\u003cp\u003eLink these catalogs with the product.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"product[catalogs][id]","description":"\n\u003cp\u003eCatalog ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"product[catalogs][name]","description":"\n\u003cp\u003eCatalog name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"media_items","full_name":"product[media_items]","description":"\n\u003cp\u003eSet the product’s media items to these (existing media items will be removed).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"media_item_type","full_name":"product[media_items][media_item_type]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eImageMediaItem\u003c/code\u003e, \u003ccode\u003eVideoMediaItem\u003c/code\u003e, \u003ccode\u003eFileMediaItem\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"product[media_items][url]","description":"\n\u003cp\u003eURL that stores the corresponding media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"product[media_items][description]","description":"\n\u003cp\u003eDescription for the media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order_position","full_name":"product[media_items][sort_order_position]","description":"\n\u003cp\u003eThe position of the media item. Non negative integer is supported\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"is_primary","full_name":"product[media_items][is_primary]","description":"\n\u003cp\u003eMake this media item as primary\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag_list","full_name":"product[media_items][tag_list]","description":"\n\u003cp\u003eTags for this media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"processing_options","full_name":"product[media_items][processing_options]","description":"\n\u003cp\u003eOptions to perform extra image processing on the media item. This is applicable only when media_item_type is ‘ImageMediaItem’\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"apply_background","full_name":"product[media_items][processing_options][apply_background]","description":"\n\u003cp\u003eSetting this to true would result in a new media item created against the product with background applied. Removes transparency.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"background_colour","full_name":"product[media_items][processing_options][background_colour]","description":"\n\u003cp\u003eThe colour name or a hex colour code for the background colour for the created media item. Defaults to white.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"processed_tags","full_name":"product[media_items][processing_options][processed_tags]","description":"\n\u003cp\u003eThe tags for the created media item.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]}]}]},{"name":"inventories","full_name":"product[inventories]","description":"\n\u003cp\u003eAdd new inventory or update existing inventory data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"inventory_source","full_name":"product[inventories][inventory_source]","description":"\n\u003cp\u003eInventory source name to which this inventory is applied\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sku","full_name":"product[inventories][sku]","description":"\n\u003cp\u003eInventory source related SKU\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"qty","full_name":"product[inventories][qty]","description":"\n\u003cp\u003eQuantity in the inventory source specified\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"available_qty","full_name":"product[inventories][available_qty]","description":"\n\u003cp\u003eAvailable quantity in the inventory source specified\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"stock_availability","full_name":"product[inventories][stock_availability]","description":"\n\u003cp\u003eFlag to indicate the stock level\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eout_of_stock\u003c/code\u003e, \u003ccode\u003ein_stock\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"out_of_stock_threshold","full_name":"product[inventories][out_of_stock_threshold]","description":"\n\u003cp\u003eOut of stock threshold\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dispatch_time","full_name":"product[inventories][dispatch_time]","description":"\n\u003cp\u003eDispatch time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dispatch_time_unit","full_name":"product[inventories][dispatch_time_unit]","description":"\n\u003cp\u003eDispatch time unit\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eday\u003c/code\u003e, \u003ccode\u003ehour\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"unit_cost","full_name":"product[inventories][unit_cost]","description":"\n\u003cp\u003eUnit cost of the product for this inventory source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"style","full_name":"product[inventories][style]","description":"\n\u003cp\u003eDynamic means Qty changes and Static means Qty stays the same. This is related to inventory decrement for order download\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edynamic\u003c/code\u003e, \u003ccode\u003estatic\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"variants","full_name":"product[variants]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"_product_code_","full_name":"product[variants][_product_code_]","description":"\n\u003cp\u003eChild product. It accepts the params of a product\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]},{"name":"virtual_products","full_name":"product[virtual_products]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"_virtual_product_code_","full_name":"product[virtual_products][_virtual_product_code_]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"code","full_name":"product[virtual_products][_virtual_product_code_][code]","description":"\n\u003cp\u003eUnique identifier for virtual product\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"product[virtual_products][_virtual_product_code_][name]","description":"\n\u003cp\u003eVirtual product name. Required for creating new virtual\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"product[virtual_products][_virtual_product_code_][status]","description":"\n\u003cp\u003eRequired for creating new virtual product\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einactive\u003c/code\u003e, \u003ccode\u003eactive\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attributes","full_name":"product[virtual_products][_virtual_product_code_][attributes]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"_any_attribute_code_","full_name":"product[virtual_products][_virtual_product_code_][attributes][_any_attribute_code_]","description":"\n\u003cp\u003eThe key of attribute is attribute code and value is a valid json type that matches the base type of the attribute\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}]},{"name":"kit_skus","full_name":"product[kit_skus]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"product_code","full_name":"product[kit_skus][product_code]","description":"\n\u003cp\u003eProduct code. It must be at bottom level (SKU) and cannot be a Kit\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":"qty","full_name":"product[kit_skus][qty]","description":"\n\u003cp\u003eThe qty of the bundled SKU\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}]}],"returns":[],"examples":["request:\n  Same as product create\n\nresponse:\n  Same as product create\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/products/destroy","name":"destroy","apis":[{"api_url":"/api/v2/products/:id","http_method":"DELETE","short_description":"Delete a product","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\": 8\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/products/attribute_values","name":"attribute_values","apis":[{"api_url":"/api/v2/products/attribute_values","http_method":"POST","short_description":"List attribute values","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":"attributes","full_name":"attributes","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"attribute_definition_codes","full_name":"attributes[attribute_definition_codes]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"response_attribute_definition_codes","full_name":"attributes[response_attribute_definition_codes]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["Response:\n  {\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 1,\n    \"entries\": [\n      {\n        \"id\": 25,\n        \"code\": \"product-one\",\n        \"created_at\": \"2019-10-03T10:26:47.873+10:00\",\n        \"updated_at\": \"2020-01-16T14:02:14.675+11:00\",\n        \"attributes\": [\n            {\n              \"id\": 161,\n              \"created_at\": \"2019-10-03T10:26:48.991+10:00\",\n              \"updated_at\": \"2020-01-16T13:59:59.564+11:00\",\n              \"attribute_definition_code\": \"description\",\n              \"data\": \"Vibrant colour\"\n            }\n        ]\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"relationships":{"doc_url":"/apidoc/2.0/relationships","id":"relationships","api_url":"/api","name":"Relationships","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;id\u0026quot;: 1,\n  \u0026quot;code\u0026quot;: \u0026quot;relationship_1\u0026quot;,\n  \u0026quot;name\u0026quot;: \u0026quot;Relationship 1\u0026quot;\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/relationships/index","name":"index","apis":[{"api_url":"/api/v2/relationships","http_method":"GET","short_description":"List relationships","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":"id","full_name":"id","description":"\n\u003cp\u003eRelationship 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":[]}],"returns":[],"examples":["Response:\n  {\n      \"page\": 1,\n      \"per_page\": 50,\n      \"total_pages\": 1,\n      \"total_entries\": 1,\n      \"entries\": [\n          {\n              \"id\": 1,\n              \"code\": \"relationship_1\",\n              \"name\": \"Relationship 1\"\n          }\n      ]\n  }\n\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/relationships/create","name":"create","apis":[{"api_url":"/api/v2/relationships","http_method":"POST","short_description":"Create or update relationship","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":"relationship","full_name":"relationship","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"code","full_name":"relationship[code]","description":"\n\u003cp\u003eCode of the relationship\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"relationship[name]","description":"\n\u003cp\u003eName of the relationship\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n    \"relationship\": {\n      \"code\": \"relationship_1\",\n      \"name\": \"Relation new name 1\"\n    }\n  }\n\nresponse:\n  {\n      \"id\": 3,\n      \"code\": \"relationship_1\",\n      \"created_at\": \"2019-06-18T13:31:16.763+10:00\",\n      \"updated_at\": \"2019-06-18T13:31:16.763+10:00\",\n      \"name\": \"Relationship new name 1\"\n  }\n\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/relationships/destroy","name":"destroy","apis":[{"api_url":"/api/v2/relationships/:id","http_method":"DELETE","short_description":"Delete a relationship","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},"shared_reference_categories":{"doc_url":"/apidoc/2.0/shared_reference_categories","id":"shared_reference_categories","api_url":"/api","name":"Shared reference categories","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;shared_reference_id\u0026quot;: 257,\n  \u0026quot;category_id\u0026quot;: 16,\n  \u0026quot;is_primary\u0026quot;: false\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/shared_reference_categories/index","name":"index","apis":[{"api_url":"/api/v2/shared_reference_categories","http_method":"GET","short_description":"List Shared reference category links","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":[]}],"returns":[],"examples":["Response:\n  {\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 1,\n    \"entries\": [\n      {\n        \"id\": 6,\n        \"shared_reference_id\": 257,\n        \"category_id\": 16\n        \"is_primary\": false\n      }\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/shared_reference_categories/create","name":"create","apis":[{"api_url":"/api/v2/shared_reference_categories","http_method":"POST","short_description":"Create a Shared reference category","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":"shared_reference_category","full_name":"shared_reference_category","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"shared_reference_id","full_name":"shared_reference_category[shared_reference_id]","description":"\n\u003cp\u003eShared reference 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":"category_id","full_name":"shared_reference_category[category_id]","description":"\n\u003cp\u003eCategory 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":"is_primary","full_name":"shared_reference_category[is_primary]","description":"\n\u003cp\u003eSpecify this to be primary category of the Shared reference\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n    \"shared_reference_category\": {\n      \"shared_reference_id\": 257,\n      \"category_id\": 16\n    }\n  }\n\nresponse:\n  {\n    \"id\": 6,\n    \"shared_reference_id\": 257,\n    \"category_id\": 16\n    \"is_primary\": false\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/shared_reference_categories/destroy","name":"destroy","apis":[{"api_url":"/api/v2/shared_reference_categories/:id","http_method":"DELETE","short_description":"Delete a Shared reference category","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\": 6\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"shared_references":{"doc_url":"/apidoc/2.0/shared_references","id":"shared_references","api_url":"/api","name":"Shared references","short_description":null,"full_description":"\n\u003cp\u003eVersion 5 only.\u003c/p\u003e\n\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;id\u0026quot;: 1,\n  \u0026quot;code\u0026quot;: \u0026quot;Shared reference 1\u0026quot;,\n  \u0026quot;name\u0026quot;: \u0026quot;Shared reference 1\u0026quot;\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/shared_references/index","name":"index","apis":[{"api_url":"/api/v2/shared_references","http_method":"GET","short_description":"List Shared references","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":"id","full_name":"id","description":"\n\u003cp\u003eShared reference 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":"code","full_name":"code","description":"\n\u003cp\u003eShared reference 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":"name","full_name":"name","description":"\n\u003cp\u003eShared reference 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":[]},{"name":"response_associated_fields","full_name":"response_associated_fields","description":"\n\u003cp\u003eOne of ‘product_class’, ‘product_family’, ‘attribute_values’. The information related to the Shared reference to be included in the Shared reference data response. Use comma to join multiple fields.\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\": 1,\n      \"entries\": [\n        {\n            \"id\": 1,\n            \"code\": \"shared_reference_1\",\n            \"name\": \"Shared reference 1\",\n            \"product_class\": {\n                \"id\": 7,\n                \"name\": \"Season\"\n            },\n            \"product_family\": {\n                \"id\": 1,\n                \"code\": \"family_1\",\n                \"name\": \"Family 1\"\n            },\n            \"attribute_values\": [\n                {\n                    \"attribute_definition_id\": 16,\n                    \"attribute_definition_code\": \"season\",\n                    \"data\": \"Winter\"\n                }\n            ]\n        }\n      ]\n  }\n\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/shared_references/create","name":"create","apis":[{"api_url":"/api/v2/shared_references","http_method":"POST","short_description":"Create or update Shared reference","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":"shared_reference","full_name":"shared_reference","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"code","full_name":"shared_reference[code]","description":"\n\u003cp\u003eCode of the Shared reference\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"shared_reference[name]","description":"\n\u003cp\u003eName of the Shared reference\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_class_name","full_name":"shared_reference[product_class_name]","description":"\n\u003cp\u003eClass name that this product is assigned to. This must be created beforehand\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_family_code","full_name":"shared_reference[product_family_code]","description":"\n\u003cp\u003eProduct family code\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribute_values","full_name":"shared_reference[attribute_values]","description":"\n\u003cp\u003eAttribute values assigned to the Shared reference.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"media_items","full_name":"shared_reference[media_items]","description":"\n\u003cp\u003eSet media items to the entity (existing media items will be removed).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"media_item_type","full_name":"shared_reference[media_items][media_item_type]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eImageMediaItem\u003c/code\u003e, \u003ccode\u003eVideoMediaItem\u003c/code\u003e, \u003ccode\u003eFileMediaItem\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"shared_reference[media_items][url]","description":"\n\u003cp\u003eURL that stores the corresponding media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"shared_reference[media_items][description]","description":"\n\u003cp\u003eDescription for the media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order_position","full_name":"shared_reference[media_items][sort_order_position]","description":"\n\u003cp\u003eThe position of the media item. Non negative integer is supported\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"is_primary","full_name":"shared_reference[media_items][is_primary]","description":"\n\u003cp\u003eMake this media item as primary\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag_list","full_name":"shared_reference[media_items][tag_list]","description":"\n\u003cp\u003eTags for this media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"processing_options","full_name":"shared_reference[media_items][processing_options]","description":"\n\u003cp\u003eOptions to perform extra image processing on the media item. This is applicable only when media_item_type is ‘ImageMediaItem’\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"apply_background","full_name":"shared_reference[media_items][processing_options][apply_background]","description":"\n\u003cp\u003eSetting this to true would result in a new media item created against the product with background applied. Removes transparency.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"background_colour","full_name":"shared_reference[media_items][processing_options][background_colour]","description":"\n\u003cp\u003eThe colour name or a hex colour code for the background colour for the created media item. Defaults to white.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"processed_tags","full_name":"shared_reference[media_items][processing_options][processed_tags]","description":"\n\u003cp\u003eThe tags for the created media item.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]}]}]},{"name":"price_items","full_name":"shared_reference[price_items]","description":"\n\u003cp\u003eAdd new prices or update existing prices if they exist.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"price_book_name","full_name":"shared_reference[price_items][price_book_name]","description":"\n\u003cp\u003eName of an existing price book to which this price item is linked\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"shared_reference[price_items][from]","description":"\n\u003cp\u003eValid from\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"shared_reference[price_items][to]","description":"\n\u003cp\u003eValid to\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"amount","full_name":"shared_reference[price_items][amount]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"categories","full_name":"shared_reference[categories]","description":"\n\u003cp\u003eSet the Shared reference’s categories to these categories (existing categories will be removed)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"shared_reference[categories][id]","description":"\n\u003cp\u003eCategory ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}]}],"returns":[],"examples":["request:\n  {\n    \"shared_reference\": {\n        \"code\": \"shared_reference_1\",\n        \"name\": \"Shared reference 1\",\n        \"product_class_name\": \"Season\",\n        \"product_family_code\": \"family_1\",\n        \"attribute_values\": {\n            \"season\": \"Winter\",\n            \"family_attr_1\": \"family1\"\n        },\n        \"media_items\": [\n          {\n            \"media_item_type\": \"ImageMediaItem\",\n            \"url\": \"http://s3.amazonaws.com/cc/image1.jpg\",\n            \"description\": \"\",\n            \"sort_order\": 0,\n            \"is_primary\": false,\n            \"is_uploaded\": null,\n            \"tag_list\": []\n          }\n        ],\n        \"price_items\": [\n          {\n            \"amount\": 45,\n            \"enabled?\": true,\n            \"price_book_name\": \"default\",\n            \"from\": null,\n            \"to\": null\n          }\n        ],\n        \"categories\": [\n          {\n            \"path\": \"Engine Oil\",\n            \"is_primary\": true,\n            \"category_set\": \"default\"\n          }\n        ],\n    }\n  }\n\nresponse:\n  {\n    \"id\": 1,\n    \"code\": \"shared_reference_1\",\n    \"product_class_id\": 7,\n    \"product_family_id\": 1,\n    \"created_at\": \"2019-08-30T16:16:05.302+10:00\",\n    \"updated_at\": \"2019-09-02T15:05:37.613+10:00\",\n    \"name\": \"Shared reference 1\"\n  }\n\n\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/shared_references/destroy","name":"destroy","apis":[{"api_url":"/api/v2/shared_references/:id","http_method":"DELETE","short_description":"Delete a Shared reference","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},"shipping_zones":{"doc_url":"/apidoc/2.0/shipping_zones","id":"shipping_zones","api_url":"/api","name":"Shipping zones","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n  \u0026quot;id\u0026quot;: 1,\n  \u0026quot;name\u0026quot;: \u0026quot;AU_FREE\u0026quot;\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/shipping_zones/index","name":"index","apis":[{"api_url":"/api/v2/shipping_zones","http_method":"GET","short_description":"List shipping zones","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":[]}],"returns":[],"examples":["Response:\n  {\n    \"page\": 1,\n    \"per_page\": 50,\n    \"total_pages\": 1,\n    \"total_entries\": 1,\n    \"entries\": [\n      {\n        \"id\": 1,\n        \"name\": \"AU_FREE\"\n      }\n    ]\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/shipping_zones/create","name":"create","apis":[{"api_url":"/api/v2/shipping_zones","http_method":"POST","short_description":"Create an shipping zone","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":"shipping_zone","full_name":"shipping_zone","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"shipping_zone[name]","description":"\n\u003cp\u003eName of the shipping zone\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["request:\n  {\n      \"shipping_zone\": {\n          \"name\": \"AU\"\n      }\n  }\n\nresponse:\n  {\n    \"id\": 3,\n    \"name\": \"AU\"\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/shipping_zones/update","name":"update","apis":[{"api_url":"/api/v2/shipping_zones/:id","http_method":"PUT","short_description":"Update an shipping zone","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":"shipping_zone","full_name":"shipping_zone","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"shipping_zone[name]","description":"\n\u003cp\u003eName of the shipping zone\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":["request:\n  {\n      \"shipping_zone\": {\n          \"name\": \"AU Updated\"\n      }\n  }\n\nresponse:\n  {\n    \"id\": 3,\n    \"name\": \"AU Updated\"\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/2.0/shipping_zones/destroy","name":"destroy","apis":[{"api_url":"/api/v2/shipping_zones/:id","http_method":"DELETE","short_description":"Delete an shipping zone","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\": 3\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"tenants":{"doc_url":"/apidoc/2.0/tenants","id":"tenants","api_url":"/api","name":"Tenants","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\n{\n    \u0026quot;id\u0026quot;: 19,\n    \u0026quot;name\u0026quot;: \u0026quot;Seller\u0026quot;,\n    \u0026quot;tid\u0026quot;: 19,\n    \u0026quot;status\u0026quot;: \u0026quot;active\u0026quot;,\n    \u0026quot;indexed_at\u0026quot;: \u0026quot;2017-09-15T15:34:45.264+10:00\u0026quot;,\n    \u0026quot;heartbeat_status\u0026quot;: \u0026quot;heartbeat_enabled\u0026quot;,\n    \u0026quot;heartbeat_interval\u0026quot;: 600,\n    \u0026quot;price_validity_check_at\u0026quot;: \u0026quot;2017-09-15T16:45:50.883+10:00\u0026quot;,\n    \u0026quot;version\u0026quot;: 5,\n    \u0026quot;heartbeat_at\u0026quot;: \u0026quot;2017-09-15T15:34:45.264+10:00\u0026quot;,\n    \u0026quot;use_dedicated_sidekiq\u0026quot;: false\n}\u003c/pre\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/tenants/show","name":"show","apis":[{"api_url":"/api/v2/tenants/1","http_method":"GET","short_description":"Show tenant 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":[],"returns":[],"examples":["Response:\n  {\n      \"id\": 19,\n      \"name\": \"Seller\",\n      \"tid\": 19,\n      \"status\": \"active\",\n      \"indexed_at\": \"2017-09-15T15:34:45.264+10:00\",\n      \"heartbeat_status\": \"heartbeat_enabled\",\n      \"heartbeat_interval\": 600,\n      \"price_validity_check_at\": \"2017-09-15T16:45:50.883+10:00\",\n      \"version\": 5,\n      \"heartbeat_at\": \"2017-09-15T15:34:45.264+10:00\",\n      \"use_dedicated_sidekiq\": false\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"variants":{"doc_url":"/apidoc/2.0/variants","id":"variants","api_url":"/api","name":"Variants","short_description":null,"full_description":"\n\u003ch2 id=\"label-Resource+Representation\"\u003eResource Representation\u003cspan\u003e\u003ca href=\"#label-Resource+Representation\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eExample:\u003c/pre\u003e\n\n\u003cp\u003e{\u003c/p\u003e\n\n\u003cpre\u003e\u0026quot;id\u0026quot;: 1,\n\u0026quot;product_type\u0026quot;: \u0026quot;product\u0026quot;,\n\u0026quot;code\u0026quot;: \u0026quot;12345\u0026quot;,\n\u0026quot;status\u0026quot;: \u0026quot;active\u0026quot;,\n\u0026quot;product_attributes\u0026quot;: {\n  \u0026quot;description\u0026quot;: {\n    \u0026quot;base_type\u0026quot;: \u0026quot;html\u0026quot;,\n    \u0026quot;value\u0026quot;: \u0026quot;\u0026lt;p style=\u0026quot;line-height: 18.5714px;\u0026quot;\u0026gt;This is a description.\u0026lt;/p\u0026gt;\u0026quot;\n  },\n  \u0026quot;short_description\u0026quot;: {\n    \u0026quot;base_type\u0026quot;: \u0026quot;html\u0026quot;,\n    \u0026quot;value\u0026quot;: \u0026quot;\u0026lt;span style=\u0026quot;line-height: 18.5714px;\u0026quot;\u0026gt;This is a short description.\u0026lt;/span\u0026gt;\u0026quot;\n  }\n},\n\u0026quot;name\u0026quot;: \u0026quot;Product 12345\u0026quot;,\n\u0026quot;is_complete\u0026quot;: true,\n\u0026quot;incomplete_fields\u0026quot;: {\n  \u0026quot;missing_image\u0026quot;: false,\n  \u0026quot;missing_category\u0026quot;: false,\n  \u0026quot;missing_price\u0026quot;: false,\n  \u0026quot;missing_attributes\u0026quot;: []\n},\n\u0026quot;discontinued\u0026quot;: false,\n\u0026quot;shipping_options\u0026quot;: [],\n\u0026quot;attribute_set\u0026quot;: {\n  \u0026quot;id\u0026quot;: 1,\n  \u0026quot;name\u0026quot;: \u0026quot;Automotive\u0026quot;\n},\n\u0026quot;product_level\u0026quot;: {\n  \u0026quot;id\u0026quot;: 1,\n  \u0026quot;name\u0026quot;: \u0026quot;Products\u0026quot;\n},\n\u0026quot;product_categories\u0026quot;: [\n  {\n    \u0026quot;is_primary\u0026quot;: false,\n    \u0026quot;category_id\u0026quot;: 1,\n    \u0026quot;name\u0026quot;: \u0026quot;Engine Oil\u0026quot;,\n    \u0026quot;path\u0026quot;: \u0026quot;Engine Oil\u0026quot;,\n    \u0026quot;category_set\u0026quot;: {\n      \u0026quot;id\u0026quot;: 1,\n      \u0026quot;name\u0026quot;: \u0026quot;default\u0026quot;\n    }\n  }\n],\n\u0026quot;catalogs\u0026quot;: [\n  {\n    \u0026quot;id\u0026quot;: 1,\n    \u0026quot;name\u0026quot;: \u0026quot;Catalog Name\u0026quot;\n  }\n],\n\u0026quot;shipping_zones\u0026quot;: [\n  {\n    \u0026quot;id\u0026quot;: 1,\n    \u0026quot;name\u0026quot;: \u0026quot;AU_FREE\u0026quot;\n  }\n],\n\u0026quot;media_items\u0026quot;: [\n  {\n    \u0026quot;id\u0026quot;: 1,\n    \u0026quot;media_item_type\u0026quot;: \u0026quot;ImageMediaItem\u0026quot;,\n    \u0026quot;url\u0026quot;: \u0026quot;http://s3.amazonaws.com/cc/image1.jpg\u0026quot;,\n    \u0026quot;description\u0026quot;: \u0026quot;\u0026quot;,\n    \u0026quot;sort_order\u0026quot;: 0,\n    \u0026quot;is_primary\u0026quot;: false,\n    \u0026quot;is_uploaded\u0026quot;: null,\n    \u0026quot;tag_list\u0026quot;: [],\n    \u0026quot;processing_options\u0026quot;: {\n      \u0026quot;apply_background\u0026quot;: true,\n      \u0026quot;background_colour\u0026quot;: \u0026quot;Gray\u0026quot;,\n      \u0026quot;tags\u0026quot;: [\u0026quot;grey1\u0026quot;,\u0026quot;grey2\u0026quot;]\n    }\n  }\n],\n\u0026quot;inventories\u0026quot;: [\n  {\n    \u0026quot;id\u0026quot;: 1,\n    \u0026quot;qty\u0026quot;: 3,\n    \u0026quot;stock_availability\u0026quot;: \u0026quot;in_stock\u0026quot;,\n    \u0026quot;out_of_stock_threshold\u0026quot;: null,\n    \u0026quot;dispatch_time\u0026quot;: 5,\n    \u0026quot;dispatch_time_unit\u0026quot;: \u0026quot;day\u0026quot;,\n    \u0026quot;unit_cost\u0026quot;: null,\n    \u0026quot;style\u0026quot;: \u0026quot;static\u0026quot;,\n    \u0026quot;sku\u0026quot;: \u0026quot;12345\u0026quot;,\n    \u0026quot;support_shipping\u0026quot;: true,\n    \u0026quot;inventory_source\u0026quot;: {\n      \u0026quot;id\u0026quot;: 1,\n      \u0026quot;name\u0026quot;: \u0026quot;MOTUL\u0026quot;\n    }\n  }\n],\n\u0026quot;price_items\u0026quot;: [\n  {\n    \u0026quot;id\u0026quot;: 1,\n    \u0026quot;amount\u0026quot;: 45,\n    \u0026quot;enabled?\u0026quot;: true,\n    \u0026quot;price_book\u0026quot;: {\n      \u0026quot;id\u0026quot;: 1,\n      \u0026quot;name\u0026quot;: \u0026quot;default\u0026quot;\n    },\n    \u0026quot;from\u0026quot;: null,\n    \u0026quot;to\u0026quot;: null\n  }\n],\n\u0026quot;brand\u0026quot;: {\n  \u0026quot;id\u0026quot;: 1,\n  \u0026quot;name\u0026quot;: \u0026quot;Brand Name\u0026quot;,\n  \u0026quot;description\u0026quot;: null,\n  \u0026quot;logo_link\u0026quot;: \u0026quot;\u0026quot;\n},\n\u0026quot;dimension\u0026quot;: {\n  \u0026quot;id\u0026quot;: 1,\n  \u0026quot;length\u0026quot;: null,\n  \u0026quot;width\u0026quot;: null,\n  \u0026quot;height\u0026quot;: null,\n  \u0026quot;weight\u0026quot;: 5\n},\n\u0026quot;packed_dimension\u0026quot;: {\n  \u0026quot;id\u0026quot;: 2,\n  \u0026quot;length\u0026quot;: null,\n  \u0026quot;width\u0026quot;: null,\n  \u0026quot;height\u0026quot;: null,\n  \u0026quot;weight\u0026quot;: null\n}\u003c/pre\u003e\n\n\u003cp\u003e}\u003c/p\u003e\n","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/2.0/variants/update","name":"update","apis":[{"api_url":"/api/v2/variants/:id","http_method":"PUT","short_description":"Update a variant","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":"variant","full_name":"variant","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"locale","full_name":"variant[locale]","description":"\n\u003cp\u003eLocale for this product. Should be one of the language codes defined on CommerceConnect. Defaults to the default language.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"variant[name]","description":"\n\u003cp\u003eVariant or sku name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"code","full_name":"variant[code]","description":"\n\u003cp\u003eUnique identifier for variant and sku\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":"variant[status]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einactive\u003c/code\u003e, \u003ccode\u003eactive\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_attributes","full_name":"variant[product_attributes]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"_any_attribute_code_","full_name":"variant[product_attributes][_any_attribute_code_]","description":"\n\u003cp\u003eThe key of attribute is attribute code and value is a valid json type that matches the base type of the attribute\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"dimension","full_name":"variant[dimension]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"length","full_name":"variant[dimension][length]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"width","full_name":"variant[dimension][width]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"height","full_name":"variant[dimension][height]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"weight","full_name":"variant[dimension][weight]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"packed_dimension","full_name":"variant[packed_dimension]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"length","full_name":"variant[packed_dimension][length]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"width","full_name":"variant[packed_dimension][width]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"height","full_name":"variant[packed_dimension][height]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"weight","full_name":"variant[packed_dimension][weight]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"price_items","full_name":"variant[price_items]","description":"\n\u003cp\u003eAdd new prices or update existing prices if they exist.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"price_book_name","full_name":"variant[price_items][price_book_name]","description":"\n\u003cp\u003eName of an existing price book to which this price item is linked\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"variant[price_items][from]","description":"\n\u003cp\u003eValid from\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"variant[price_items][to]","description":"\n\u003cp\u003eValid to\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"amount","full_name":"variant[price_items][amount]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"categories","full_name":"variant[categories]","description":"\n\u003cp\u003eSet the product’s categories to these categories (existing categories will be removed)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"variant[categories][id]","description":"\n\u003cp\u003eCategory ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"catalogs","full_name":"variant[catalogs]","description":"\n\u003cp\u003eLink these catalogs with the product.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"variant[catalogs][id]","description":"\n\u003cp\u003eCatalog ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"variant[catalogs][name]","description":"\n\u003cp\u003eCatalog name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"media_items","full_name":"variant[media_items]","description":"\n\u003cp\u003eSet the product’s media items to these (existing media items will be removed).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"media_item_type","full_name":"variant[media_items][media_item_type]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eImageMediaItem\u003c/code\u003e, \u003ccode\u003eVideoMediaItem\u003c/code\u003e, \u003ccode\u003eFileMediaItem\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"variant[media_items][url]","description":"\n\u003cp\u003eURL that stores the corresponding media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"variant[media_items][description]","description":"\n\u003cp\u003eDescription for the media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order_position","full_name":"variant[media_items][sort_order_position]","description":"\n\u003cp\u003eThe position of the media item. Non negative integer is supported\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"is_primary","full_name":"variant[media_items][is_primary]","description":"\n\u003cp\u003eMake this media item as primary\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag_list","full_name":"variant[media_items][tag_list]","description":"\n\u003cp\u003eTags for this media item\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"processing_options","full_name":"variant[media_items][processing_options]","description":"\n\u003cp\u003eOptions to perform extra image processing on the media item. This is applicable only when media_item_type is ‘ImageMediaItem’\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"apply_background","full_name":"variant[media_items][processing_options][apply_background]","description":"\n\u003cp\u003eSetting this to true would result in a new media item created against the product with background applied. Removes transparency.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"background_colour","full_name":"variant[media_items][processing_options][background_colour]","description":"\n\u003cp\u003eThe colour name or a hex colour code for the background colour for the created media item. Defaults to white.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tags","full_name":"variant[media_items][processing_options][tags]","description":"\n\u003cp\u003eThe tags for the created media item.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]}]}]},{"name":"inventories","full_name":"variant[inventories]","description":"\n\u003cp\u003eAdd new inventory or update existing inventory data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"inventory_source","full_name":"variant[inventories][inventory_source]","description":"\n\u003cp\u003eInventory source name to which this inventory is applied\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sku","full_name":"variant[inventories][sku]","description":"\n\u003cp\u003eInventory source related SKU\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"qty","full_name":"variant[inventories][qty]","description":"\n\u003cp\u003eQuantity in the inventory source specified\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"stock_availability","full_name":"variant[inventories][stock_availability]","description":"\n\u003cp\u003eFlag to indicate the stock level\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eout_of_stock\u003c/code\u003e, \u003ccode\u003ein_stock\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"out_of_stock_threshold","full_name":"variant[inventories][out_of_stock_threshold]","description":"\n\u003cp\u003eOut of stock threshold\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dispatch_time","full_name":"variant[inventories][dispatch_time]","description":"\n\u003cp\u003eDispatch time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dispatch_time_unit","full_name":"variant[inventories][dispatch_time_unit]","description":"\n\u003cp\u003eDispatch time unit\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eday\u003c/code\u003e, \u003ccode\u003ehour\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"unit_cost","full_name":"variant[inventories][unit_cost]","description":"\n\u003cp\u003eUnit cost of the product for this inventory source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Numeric","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lead_time","full_name":"variant[inventories][lead_time]","description":"\n\u003cp\u003eLead time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lead_time_unit","full_name":"variant[inventories][lead_time_unit]","description":"\n\u003cp\u003eLead time unit\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003emonths\u003c/code\u003e, \u003ccode\u003eweeks\u003c/code\u003e, \u003ccode\u003edays\u003c/code\u003e, \u003ccode\u003ehours\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"style","full_name":"variant[inventories][style]","description":"\n\u003cp\u003eDynamic means Qty changes and Static means Qty stays the same. This is related to inventory decrement for order download\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edynamic\u003c/code\u003e, \u003ccode\u003estatic\u003c/code\u003e, \u003ccode\u003eperpetual\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}],"returns":[],"examples":["request:\n  {\n    \"variant\": {\n      \"code\": \"variant_1\",\n      \"name\": \"Variant 1 Updated\"\n    }\n  }\n\nresponse:\n  {\n    \"id\": 2,\n    \"product_type\": \"product\",\n    \"code\": \"variant_1\",\n    \"status\": \"active\",\n    \"product_attributes\": {\n      \"description\": {\n        \"base_type\": \"html\",\n        \"value\": \"Variant 1 description\"\n      },\n      \"short_description\": {\n        \"base_type\": \"html\",\n        \"value\": \"\"\n      }\n    },\n    \"name\": \"Variant 1 Updated\",\n    \"is_complete\": false,\n    \"incomplete_fields\": {\n      \"missing_image\": true,\n      \"missing_category\": false,\n      \"missing_price\": true,\n      \"missing_attributes\": null\n    },\n    \"discontinued\": false,\n    \"shipping_options\": [],\n    \"attribute_set\": {\n      \"id\": 1,\n      \"name\": \"Automotive\"\n    },\n    \"product_level\": {\n      \"id\": 1,\n      \"name\": \"Products\"\n    },\n    \"brand\": {\n      \"id\": 1,\n      \"name\": \"MOTUL\",\n      \"description\": null,\n      \"logo_link\": \"\"\n    },\n    \"product_categories\": [\n      {\n        \"is_primary\": true,\n        \"category_id\": 1,\n        \"name\": \"Engine Oil\",\n        \"path\": \"Engine Oil\",\n        \"category_set\": {\n          \"id\": 1,\n          \"name\": \"default\"\n        }\n      }\n    ],\n    \"catalogs\": [],\n    \"shipping_zones\": [\n      {\n        \"id\": 1,\n        \"name\": \"AU_FREE\"\n      }\n    ],\n    \"media_items\": []\n  }\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}}}}