{"__v":35,"_id":"5730ef826b55e93400b32ac5","api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"body":"The Amber Engine API follows a [RESTful :fa-external-link:](https://en.wikipedia.org/wiki/Representational_state_transfer) structure for allowing API clients to interact with resources in an organized, defined manner. Resources such as product data and product images, manufacturer data, retailer information, and so on.\n\n\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"1. Supported Client Languages\"\n}\n[/block]\nInteracting with the API takes place over HTTP, using one of our various libraries. \n\nAt preset, this API supports only the following clients:\n\n1. Manual HTTP Requests (using `cURL`, for example)\n2. Our [:fa-github: Python Library](https://github.com/AmberEngine/amber-lib)\n3. Examples in PHP are scattered throughout the documentation\n4. ... more to come in the future!\n\nInteracting the with the Amber Engine API is as simple as choosing your language, installing your tools, and getting started.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"2. Library Installation Instructions\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Upcoming Libraries\",\n  \"body\": \"Don't see install instructions for your favorite language? No worries, we have more libraries on the way!\\n\\nQuestions? Feel free to [contact us](mailto:aric@amberengine.com)\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"pip install -e https://github.com/AmberEngine/amber_lib.git\",\n      \"language\": \"shell\",\n      \"name\": \"For Python\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"3. Connection Configuration\"\n}\n[/block]\nIn order to connect to the API, you must setup a proper connection to the API. The following attributes for the connection are available. Those required are marked.\n\n## 3.1 Connection Options\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`private`\",\n    \"1-0\": \"`public`\\n*Required*\",\n    \"2-0\": \"`token`\",\n    \"0-1\": \"Your private API client key. This key will not be shared over the network. It is used to sign HTTP requests\",\n    \"1-1\": \"Your public API client key. This key is sent along with all your requests.\",\n    \"2-1\": \"An optional token key, used in place of signing HTTP requests with the `private` client key.\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n## 3.2 Required Headers\n\nEach request to the API must have the following headers, in the specified order.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Accept\",\n    \"0-1\": \"application/hal+json\",\n    \"1-0\": \"Content-Type\",\n    \"1-1\": \"application/json\",\n    \"2-0\": \"Public-Key\",\n    \"2-1\": \"[your API public key] (see below)\",\n    \"3-0\": \"Timestamp\",\n    \"3-1\": \"i.e. `2017-01-05T17:58:43.000000`\",\n    \"h-0\": \"Header\",\n    \"h-1\": \"Value\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Additional Library Configuration\",\n  \"body\": \"API client libraries may have additional configurable settings.\"\n}\n[/block]\n## 3.2 Example\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"from amber_lib import client, connection\\n\\n# Create a context for our requests\\nctx = client.Context(\\n\\tpublic=\\\"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890\\\",\\n  private=\\\"1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\\\",\\n)\\n\\n# Generate a new connection\\nconn = connection.Connection(ctx)\",\n      \"language\": \"python\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"4. Manipulating Data\"\n}\n[/block]\nOnce you have a connection to the API, you can begin creating, retrieving, updating, and deleting data.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"from amber_lib import client, connection\\n\\n# Create a context for our requests\\nctx = client.Context(\\n\\tpublic=\\\"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890\\\",\\n  private=\\\"1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\\\",\\n)\\n\\n# Generate a new connection\\nconn = connection.Connection(ctx)\\n\\n# Let's create a wooden chair...\\n# First, we need an empty Product resource\\nchair = conn.Product\\n\\n# Now we update it\\nchair.update({\\n\\t\\\"category\\\": {\\n\\t\\t\\\"primary\\\": \\\"casegood\\\",\\n    \\\"secondary\\\": \\\"casegood_chair\\\"\\n\\t},\\n  \\\"identity\\\": {\\n  \\t\\\"sku\\\": \\\"l337\\\",\\n    \\\"name\\\": \\\"A wooden chair\\\"\\n  }\\n})\\n\\n# Save to create a new product\\nchair.save()\\n\\n\\n# Oops, forgot to add the material\\nchair.construction_information.material = \\\"wood\\\"\\n\\n# Saving again now updates the product, since it now exists\\nchair.save()\",\n      \"language\": \"python\"\n    }\n  ]\n}\n[/block]","category":"571e47385536c12000f51b38","createdAt":"2016-05-09T20:13:54.230Z","excerpt":"A quick introduction to getting started with the API","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","next":{"description":"","pages":[]},"order":0,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"getting-started","sync_unique":"","title":"Getting Started","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Getting Started

A quick introduction to getting started with the API

The Amber Engine API follows a [RESTful :fa-external-link:](https://en.wikipedia.org/wiki/Representational_state_transfer) structure for allowing API clients to interact with resources in an organized, defined manner. Resources such as product data and product images, manufacturer data, retailer information, and so on. [block:api-header] { "type": "basic", "title": "1. Supported Client Languages" } [/block] Interacting with the API takes place over HTTP, using one of our various libraries. At preset, this API supports only the following clients: 1. Manual HTTP Requests (using `cURL`, for example) 2. Our [:fa-github: Python Library](https://github.com/AmberEngine/amber-lib) 3. Examples in PHP are scattered throughout the documentation 4. ... more to come in the future! Interacting the with the Amber Engine API is as simple as choosing your language, installing your tools, and getting started. [block:api-header] { "type": "basic", "title": "2. Library Installation Instructions" } [/block] [block:callout] { "type": "info", "title": "Upcoming Libraries", "body": "Don't see install instructions for your favorite language? No worries, we have more libraries on the way!\n\nQuestions? Feel free to [contact us](mailto:aric@amberengine.com)" } [/block] [block:code] { "codes": [ { "code": "pip install -e https://github.com/AmberEngine/amber_lib.git", "language": "shell", "name": "For Python" } ] } [/block] [block:api-header] { "type": "basic", "title": "3. Connection Configuration" } [/block] In order to connect to the API, you must setup a proper connection to the API. The following attributes for the connection are available. Those required are marked. ## 3.1 Connection Options [block:parameters] { "data": { "h-0": "Attribute Name", "h-1": "Description", "0-0": "`private`", "1-0": "`public`\n*Required*", "2-0": "`token`", "0-1": "Your private API client key. This key will not be shared over the network. It is used to sign HTTP requests", "1-1": "Your public API client key. This key is sent along with all your requests.", "2-1": "An optional token key, used in place of signing HTTP requests with the `private` client key." }, "cols": 2, "rows": 3 } [/block] ## 3.2 Required Headers Each request to the API must have the following headers, in the specified order. [block:parameters] { "data": { "0-0": "Accept", "0-1": "application/hal+json", "1-0": "Content-Type", "1-1": "application/json", "2-0": "Public-Key", "2-1": "[your API public key] (see below)", "3-0": "Timestamp", "3-1": "i.e. `2017-01-05T17:58:43.000000`", "h-0": "Header", "h-1": "Value" }, "cols": 2, "rows": 4 } [/block] [block:callout] { "type": "warning", "title": "Additional Library Configuration", "body": "API client libraries may have additional configurable settings." } [/block] ## 3.2 Example [block:code] { "codes": [ { "code": "from amber_lib import client, connection\n\n# Create a context for our requests\nctx = client.Context(\n\tpublic=\"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890\",\n private=\"1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\",\n)\n\n# Generate a new connection\nconn = connection.Connection(ctx)", "language": "python" } ] } [/block] [block:api-header] { "type": "basic", "title": "4. Manipulating Data" } [/block] Once you have a connection to the API, you can begin creating, retrieving, updating, and deleting data. [block:code] { "codes": [ { "code": "from amber_lib import client, connection\n\n# Create a context for our requests\nctx = client.Context(\n\tpublic=\"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890\",\n private=\"1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\",\n)\n\n# Generate a new connection\nconn = connection.Connection(ctx)\n\n# Let's create a wooden chair...\n# First, we need an empty Product resource\nchair = conn.Product\n\n# Now we update it\nchair.update({\n\t\"category\": {\n\t\t\"primary\": \"casegood\",\n \"secondary\": \"casegood_chair\"\n\t},\n \"identity\": {\n \t\"sku\": \"l337\",\n \"name\": \"A wooden chair\"\n }\n})\n\n# Save to create a new product\nchair.save()\n\n\n# Oops, forgot to add the material\nchair.construction_information.material = \"wood\"\n\n# Saving again now updates the product, since it now exists\nchair.save()", "language": "python" } ] } [/block]
The Amber Engine API follows a [RESTful :fa-external-link:](https://en.wikipedia.org/wiki/Representational_state_transfer) structure for allowing API clients to interact with resources in an organized, defined manner. Resources such as product data and product images, manufacturer data, retailer information, and so on. [block:api-header] { "type": "basic", "title": "1. Supported Client Languages" } [/block] Interacting with the API takes place over HTTP, using one of our various libraries. At preset, this API supports only the following clients: 1. Manual HTTP Requests (using `cURL`, for example) 2. Our [:fa-github: Python Library](https://github.com/AmberEngine/amber-lib) 3. Examples in PHP are scattered throughout the documentation 4. ... more to come in the future! Interacting the with the Amber Engine API is as simple as choosing your language, installing your tools, and getting started. [block:api-header] { "type": "basic", "title": "2. Library Installation Instructions" } [/block] [block:callout] { "type": "info", "title": "Upcoming Libraries", "body": "Don't see install instructions for your favorite language? No worries, we have more libraries on the way!\n\nQuestions? Feel free to [contact us](mailto:aric@amberengine.com)" } [/block] [block:code] { "codes": [ { "code": "pip install -e https://github.com/AmberEngine/amber_lib.git", "language": "shell", "name": "For Python" } ] } [/block] [block:api-header] { "type": "basic", "title": "3. Connection Configuration" } [/block] In order to connect to the API, you must setup a proper connection to the API. The following attributes for the connection are available. Those required are marked. ## 3.1 Connection Options [block:parameters] { "data": { "h-0": "Attribute Name", "h-1": "Description", "0-0": "`private`", "1-0": "`public`\n*Required*", "2-0": "`token`", "0-1": "Your private API client key. This key will not be shared over the network. It is used to sign HTTP requests", "1-1": "Your public API client key. This key is sent along with all your requests.", "2-1": "An optional token key, used in place of signing HTTP requests with the `private` client key." }, "cols": 2, "rows": 3 } [/block] ## 3.2 Required Headers Each request to the API must have the following headers, in the specified order. [block:parameters] { "data": { "0-0": "Accept", "0-1": "application/hal+json", "1-0": "Content-Type", "1-1": "application/json", "2-0": "Public-Key", "2-1": "[your API public key] (see below)", "3-0": "Timestamp", "3-1": "i.e. `2017-01-05T17:58:43.000000`", "h-0": "Header", "h-1": "Value" }, "cols": 2, "rows": 4 } [/block] [block:callout] { "type": "warning", "title": "Additional Library Configuration", "body": "API client libraries may have additional configurable settings." } [/block] ## 3.2 Example [block:code] { "codes": [ { "code": "from amber_lib import client, connection\n\n# Create a context for our requests\nctx = client.Context(\n\tpublic=\"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890\",\n private=\"1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\",\n)\n\n# Generate a new connection\nconn = connection.Connection(ctx)", "language": "python" } ] } [/block] [block:api-header] { "type": "basic", "title": "4. Manipulating Data" } [/block] Once you have a connection to the API, you can begin creating, retrieving, updating, and deleting data. [block:code] { "codes": [ { "code": "from amber_lib import client, connection\n\n# Create a context for our requests\nctx = client.Context(\n\tpublic=\"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890\",\n private=\"1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\",\n)\n\n# Generate a new connection\nconn = connection.Connection(ctx)\n\n# Let's create a wooden chair...\n# First, we need an empty Product resource\nchair = conn.Product\n\n# Now we update it\nchair.update({\n\t\"category\": {\n\t\t\"primary\": \"casegood\",\n \"secondary\": \"casegood_chair\"\n\t},\n \"identity\": {\n \t\"sku\": \"l337\",\n \"name\": \"A wooden chair\"\n }\n})\n\n# Save to create a new product\nchair.save()\n\n\n# Oops, forgot to add the material\nchair.construction_information.material = \"wood\"\n\n# Saving again now updates the product, since it now exists\nchair.save()", "language": "python" } ] } [/block]
{"__v":9,"_id":"573b3c0a37fcf72000a2e62d","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"The API follows a hypermedia architecture, and includes *affordances* specifying actions that can be performed on or with a given resource. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Product Composition\"\n}\n[/block]\nThe API follows a [component-based architecture :fa-external-link:](https://en.wikipedia.org/wiki/Component-based_software_engineering), where a [Product Resource](doc:product-resource) is composed from a variety of [Components](doc:components).\n\nComponents provide the structure for storing data relating to products. \n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Categories and Components\",\n  \"body\": \"Which components are part of a Product depends on the Product's Category.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Manufacturers and Products\"\n}\n[/block]\nAll products must be associated with a [Manufacturer Resource](doc:manufacturer-resource). This association is specified via a Product's [Manufacturer Component](doc:manufacturer-component) data.\n\nIt is not possible to create a product with associating it with a manufacturer.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Sales Channels, Manufacturers, and Products\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Not Implemented\",\n  \"body\": \"Sales Channels have yet to be fully updated. So don't worry about 'em.\"\n}\n[/block]","category":"571e47385536c12000f51b38","createdAt":"2016-05-17T15:43:06.386Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","next":{"description":"","pages":[]},"order":1,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"archetecture","sync_unique":"","title":"Architecture","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Architecture


The API follows a hypermedia architecture, and includes *affordances* specifying actions that can be performed on or with a given resource. [block:api-header] { "type": "basic", "title": "Product Composition" } [/block] The API follows a [component-based architecture :fa-external-link:](https://en.wikipedia.org/wiki/Component-based_software_engineering), where a [Product Resource](doc:product-resource) is composed from a variety of [Components](doc:components). Components provide the structure for storing data relating to products. [block:callout] { "type": "info", "title": "Categories and Components", "body": "Which components are part of a Product depends on the Product's Category." } [/block] [block:api-header] { "type": "basic", "title": "Manufacturers and Products" } [/block] All products must be associated with a [Manufacturer Resource](doc:manufacturer-resource). This association is specified via a Product's [Manufacturer Component](doc:manufacturer-component) data. It is not possible to create a product with associating it with a manufacturer. [block:api-header] { "type": "basic", "title": "Sales Channels, Manufacturers, and Products" } [/block] [block:callout] { "type": "danger", "title": "Not Implemented", "body": "Sales Channels have yet to be fully updated. So don't worry about 'em." } [/block]
The API follows a hypermedia architecture, and includes *affordances* specifying actions that can be performed on or with a given resource. [block:api-header] { "type": "basic", "title": "Product Composition" } [/block] The API follows a [component-based architecture :fa-external-link:](https://en.wikipedia.org/wiki/Component-based_software_engineering), where a [Product Resource](doc:product-resource) is composed from a variety of [Components](doc:components). Components provide the structure for storing data relating to products. [block:callout] { "type": "info", "title": "Categories and Components", "body": "Which components are part of a Product depends on the Product's Category." } [/block] [block:api-header] { "type": "basic", "title": "Manufacturers and Products" } [/block] All products must be associated with a [Manufacturer Resource](doc:manufacturer-resource). This association is specified via a Product's [Manufacturer Component](doc:manufacturer-component) data. It is not possible to create a product with associating it with a manufacturer. [block:api-header] { "type": "basic", "title": "Sales Channels, Manufacturers, and Products" } [/block] [block:callout] { "type": "danger", "title": "Not Implemented", "body": "Sales Channels have yet to be fully updated. So don't worry about 'em." } [/block]
{"__v":16,"_id":"573b382eef164e2900a2b81c","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Code\",\n    \"h-1\": \"Name\",\n    \"0-0\": \"400\",\n    \"0-1\": \"Bad Request\",\n    \"1-0\": \"400\",\n    \"1-1\": \"Bad JSON\",\n    \"2-0\": \"401\",\n    \"2-1\": \"Unauthorized\",\n    \"3-0\": \"403\",\n    \"3-1\": \"Access Forbidden\",\n    \"4-0\": \"404\",\n    \"4-1\": \"Not Found\",\n    \"5-0\": \"405\",\n    \"5-1\": \"Method Not Allowed\",\n    \"6-0\": \"406\",\n    \"6-1\": \"Not Acceptable\",\n    \"7-0\": \"410\",\n    \"7-1\": \"Gone\",\n    \"8-0\": \"415\",\n    \"8-1\": \"Unsupported Media Type\",\n    \"9-0\": \"440\",\n    \"9-1\": \"Authentication Timeout\",\n    \"10-0\": \"500\",\n    \"10-1\": \"API malfunction\",\n    \"11-0\": \"500\",\n    \"11-1\": \"Not Implemented\"\n  },\n  \"cols\": 2,\n  \"rows\": 12,\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"API Status Codes\"\n}\n[/block]\nThis API uses conventional HTTP status codes to indicate the success or failure of an API call. Although the individual libraries may handle the errors through different mechanisms, the error codes, titles, and messages will remain the same between the client libraries.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example Error Handling\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"from amber_lib import client, connection, errors\\n\\n# Create a context for our requests\\nctx = client.Context(\\n  token=\\\"JGb87fC46c0nM0Smmvr41CAB9dnsNCc4670MN9ij8\\\",\\n)\\n\\n\\n# Generate a new connection\\nconn = connection.Connection(ctx)\\n\\n# Let's create a wooden chair...\\n# First, we need an empty Product resource\\ntry:\\n\\tchair = conn.Product.retrieve(1337)\\nexcept errors.NotFound as e:\\n\\tprint(\\\"Product not found!\\\") \",\n      \"language\": \"python\"\n    }\n  ]\n}\n[/block]","category":"571e47385536c12000f51b38","createdAt":"2016-05-17T15:26:38.848Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"errors","sync_unique":"","title":"Errors","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Errors


[block:parameters] { "data": { "h-0": "Code", "h-1": "Name", "0-0": "400", "0-1": "Bad Request", "1-0": "400", "1-1": "Bad JSON", "2-0": "401", "2-1": "Unauthorized", "3-0": "403", "3-1": "Access Forbidden", "4-0": "404", "4-1": "Not Found", "5-0": "405", "5-1": "Method Not Allowed", "6-0": "406", "6-1": "Not Acceptable", "7-0": "410", "7-1": "Gone", "8-0": "415", "8-1": "Unsupported Media Type", "9-0": "440", "9-1": "Authentication Timeout", "10-0": "500", "10-1": "API malfunction", "11-0": "500", "11-1": "Not Implemented" }, "cols": 2, "rows": 12, "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "API Status Codes" } [/block] This API uses conventional HTTP status codes to indicate the success or failure of an API call. Although the individual libraries may handle the errors through different mechanisms, the error codes, titles, and messages will remain the same between the client libraries. [block:api-header] { "type": "basic", "title": "Example Error Handling" } [/block] [block:code] { "codes": [ { "code": "from amber_lib import client, connection, errors\n\n# Create a context for our requests\nctx = client.Context(\n token=\"JGb87fC46c0nM0Smmvr41CAB9dnsNCc4670MN9ij8\",\n)\n\n\n# Generate a new connection\nconn = connection.Connection(ctx)\n\n# Let's create a wooden chair...\n# First, we need an empty Product resource\ntry:\n\tchair = conn.Product.retrieve(1337)\nexcept errors.NotFound as e:\n\tprint(\"Product not found!\") ", "language": "python" } ] } [/block]
[block:parameters] { "data": { "h-0": "Code", "h-1": "Name", "0-0": "400", "0-1": "Bad Request", "1-0": "400", "1-1": "Bad JSON", "2-0": "401", "2-1": "Unauthorized", "3-0": "403", "3-1": "Access Forbidden", "4-0": "404", "4-1": "Not Found", "5-0": "405", "5-1": "Method Not Allowed", "6-0": "406", "6-1": "Not Acceptable", "7-0": "410", "7-1": "Gone", "8-0": "415", "8-1": "Unsupported Media Type", "9-0": "440", "9-1": "Authentication Timeout", "10-0": "500", "10-1": "API malfunction", "11-0": "500", "11-1": "Not Implemented" }, "cols": 2, "rows": 12, "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "API Status Codes" } [/block] This API uses conventional HTTP status codes to indicate the success or failure of an API call. Although the individual libraries may handle the errors through different mechanisms, the error codes, titles, and messages will remain the same between the client libraries. [block:api-header] { "type": "basic", "title": "Example Error Handling" } [/block] [block:code] { "codes": [ { "code": "from amber_lib import client, connection, errors\n\n# Create a context for our requests\nctx = client.Context(\n token=\"JGb87fC46c0nM0Smmvr41CAB9dnsNCc4670MN9ij8\",\n)\n\n\n# Generate a new connection\nconn = connection.Connection(ctx)\n\n# Let's create a wooden chair...\n# First, we need an empty Product resource\ntry:\n\tchair = conn.Product.retrieve(1337)\nexcept errors.NotFound as e:\n\tprint(\"Product not found!\") ", "language": "python" } ] } [/block]
{"__v":11,"_id":"573244bc8b55962900f063d8","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Advanced Content\",\n  \"body\": \"The following information is required only for performing manual HTTP requests or developing on the client libraries.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"What is HAL+JSON\"\n}\n[/block]\nHAL is a simple format that gives a consistent and easy way to hyperlink between resources in your API.\n\nHAL provides its linking capability with a convention which says that a resource object has a reserved property called “`_links`”. This property, surprisingly enough, is an object that contains links. These links are key'ed by their link relation, e.g. self, next, product, customer, etc:\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Want to know more?\",\n  \"body\": \"For a more in-depth summary of HAL+JSON, check out [Mike Kelly's blurb](http://stateless.co/hal_specification.html) about it\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"_links\\\": {\\n    \\\"self\\\": { \\\"href\\\": \\\"/product/987\\\" },\\n    \\\"upsell\\\": [\\n      { \\\"href\\\": \\\"/product/452\\\", \\\"title\\\": \\\"Flower pot\\\" },\\n      { \\\"href\\\": \\\"/product/832\\\", \\\"title\\\": \\\"Hover donkey\\\" }\\n    ]\\n  },\\n  \\\"name\\\": \\\"A product\\\",\\n  \\\"weight\\\": 400,\\n  .. *snip* ..\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","category":"571e47385536c12000f51b38","createdAt":"2016-05-10T20:29:48.391Z","excerpt":"Why we use HAL+JSON and how you can too","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"haljson-content","sync_unique":"","title":"HAL + JSON Content","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

HAL + JSON Content

Why we use HAL+JSON and how you can too

[block:callout] { "type": "warning", "title": "Advanced Content", "body": "The following information is required only for performing manual HTTP requests or developing on the client libraries." } [/block] [block:api-header] { "type": "basic", "title": "What is HAL+JSON" } [/block] HAL is a simple format that gives a consistent and easy way to hyperlink between resources in your API. HAL provides its linking capability with a convention which says that a resource object has a reserved property called “`_links`”. This property, surprisingly enough, is an object that contains links. These links are key'ed by their link relation, e.g. self, next, product, customer, etc: [block:callout] { "type": "info", "title": "Want to know more?", "body": "For a more in-depth summary of HAL+JSON, check out [Mike Kelly's blurb](http://stateless.co/hal_specification.html) about it", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"_links\": {\n \"self\": { \"href\": \"/product/987\" },\n \"upsell\": [\n { \"href\": \"/product/452\", \"title\": \"Flower pot\" },\n { \"href\": \"/product/832\", \"title\": \"Hover donkey\" }\n ]\n },\n \"name\": \"A product\",\n \"weight\": 400,\n .. *snip* ..\n}", "language": "json" } ] } [/block]
[block:callout] { "type": "warning", "title": "Advanced Content", "body": "The following information is required only for performing manual HTTP requests or developing on the client libraries." } [/block] [block:api-header] { "type": "basic", "title": "What is HAL+JSON" } [/block] HAL is a simple format that gives a consistent and easy way to hyperlink between resources in your API. HAL provides its linking capability with a convention which says that a resource object has a reserved property called “`_links`”. This property, surprisingly enough, is an object that contains links. These links are key'ed by their link relation, e.g. self, next, product, customer, etc: [block:callout] { "type": "info", "title": "Want to know more?", "body": "For a more in-depth summary of HAL+JSON, check out [Mike Kelly's blurb](http://stateless.co/hal_specification.html) about it", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"_links\": {\n \"self\": { \"href\": \"/product/987\" },\n \"upsell\": [\n { \"href\": \"/product/452\", \"title\": \"Flower pot\" },\n { \"href\": \"/product/832\", \"title\": \"Hover donkey\" }\n ]\n },\n \"name\": \"A product\",\n \"weight\": 400,\n .. *snip* ..\n}", "language": "json" } ] } [/block]
{"project":"571e47385536c12000f51b34","version":"571e47385536c12000f51b37","category":"571e47385536c12000f51b38","_id":"58af08adebd7370f0078b9c8","user":"583490237144843b00926645","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-02-23T16:07:09.000Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":999,"body":"Amber Engine will provide a sandboxed testbed environment including fake sample data and test API keys upon request. \n\nTo request access, complete the form [here](http://www.amberengine.com/developers) and we'll be in touch!","excerpt":"","slug":"api-sandbox","type":"basic","title":"API Sandbox","__v":0,"childrenPages":[]}

API Sandbox


Amber Engine will provide a sandboxed testbed environment including fake sample data and test API keys upon request. To request access, complete the form [here](http://www.amberengine.com/developers) and we'll be in touch!
Amber Engine will provide a sandboxed testbed environment including fake sample data and test API keys upon request. To request access, complete the form [here](http://www.amberengine.com/developers) and we'll be in touch!
{"__v":2,"_id":"5732449518fca21900f9ca99","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"All requests must be authenticated, either by signing the request using a private key, or by including a valid token.\n\nYour **public key** can be distributed anywhere. Toss it all over the place. As long your **private key** is never compromised, it doesn’t matter where your public key is living. Toss it everywhere. Just like a real life key system, you wouldn’t care if there were hundreds of the same padlock locking your things, as long as you never lost possession of the key. This holds true for public/private key models as well.\n\n“Keys” are just numbers -big, long numbers with many digits. You can keep your private key, which is a number, in a text file or in a special app. You can put your public key, which is also a very long number, in your email signature, your website, etc. And there is no need for special boxes, you just “lock” and “unlock” files (or data) using an app and your keys.","category":"5732447418fca21900f9ca98","createdAt":"2016-05-10T20:29:09.977Z","excerpt":"How to use Public-Private key pairings for authentication","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","next":{"description":"","pages":[]},"order":0,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"public-private-keys","sync_unique":"","title":"Public-Private Keys","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Public-Private Keys

How to use Public-Private key pairings for authentication

All requests must be authenticated, either by signing the request using a private key, or by including a valid token. Your **public key** can be distributed anywhere. Toss it all over the place. As long your **private key** is never compromised, it doesn’t matter where your public key is living. Toss it everywhere. Just like a real life key system, you wouldn’t care if there were hundreds of the same padlock locking your things, as long as you never lost possession of the key. This holds true for public/private key models as well. “Keys” are just numbers -big, long numbers with many digits. You can keep your private key, which is a number, in a text file or in a special app. You can put your public key, which is also a very long number, in your email signature, your website, etc. And there is no need for special boxes, you just “lock” and “unlock” files (or data) using an app and your keys.
All requests must be authenticated, either by signing the request using a private key, or by including a valid token. Your **public key** can be distributed anywhere. Toss it all over the place. As long your **private key** is never compromised, it doesn’t matter where your public key is living. Toss it everywhere. Just like a real life key system, you wouldn’t care if there were hundreds of the same padlock locking your things, as long as you never lost possession of the key. This holds true for public/private key models as well. “Keys” are just numbers -big, long numbers with many digits. You can keep your private key, which is a number, in a text file or in a special app. You can put your public key, which is also a very long number, in your email signature, your website, etc. And there is no need for special boxes, you just “lock” and “unlock” files (or data) using an app and your keys.
{"__v":6,"_id":"573244a6a825f30e00b51bd2","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"A JSON Web Token, or [JWT](https://jwt.io/), is used to send information that can be verified and trusted by means of a digital signature. It comprises a compact and URL-safe JSON object, which is cryptographically signed to verify its authenticity, and which can also be encrypted if the payload contains sensitive information.\n\nBecause of it’s compact structure, JWT is usually used in HTTP Authorization headers or URL query parameters.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Requesting Token\"\n}\n[/block]\nA token can be requested with a signed, properly formatted POST to the `/tokens` endpoint.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"from amber_lib import client, connection\\n\\n# Create a context for our requests\\nctx = client.Context(\\n\\tpublic=\\\"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890\\\",\\n  private=\\\"1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\\\",\\n)\\n\\n# Create a new token string\\ntoken = ctx.create_token()\\nprint(token) # Prints: JGb87fC46c0nM0Smmvr41CAB9dnsNCc4670MN9ij8\",\n      \"language\": \"python\"\n    },\n    {\n      \"code\": \"<?php\\nuse \\\\Curl\\\\Curl; // use the curl library to make requests\\n\\n$pub = [your public key];\\n$priv = [your private key];\\n$token = '';\\n\\n# API url will vary, depending on if you are accessing the \\n# sandbox or the live API\\n$url = 'http://[api url]/tokens';\\n\\ndate_default_timezone_set(\\\"UTC\\\");\\n$timestamp = date('Y-m-d\\\\TH:i:s.u');\\n\\n$curl = new Curl();\\n$curl->setHeader('Accept', 'application/hal+json');\\n$curl->setHeader('Content-Type', 'application/json');\\n$curl->setHeader('Public-Key', $pub);\\n$curl->setHeader('Timestamp', $timestamp);\\n$curl->setheader('URL', $url);\\n\\n$data = array(\\n        'Accept' => 'application/hal+json',\\n        'Content-Type' => 'application/json',\\n        'Public-Key' => $pub,\\n        'Timestamp' => $timestamp,\\n        'URL' => $url\\n);\\n\\n$payload = '{}';\\n\\n# generate the signature\\n$sig = json_encode($data, JSON_UNESCAPED_SLASHES);\\n$sig .= $payload . $priv;\\n$sig = hash('sha256', $sig);\\n$sig = base64_encode($sig);\\n\\n$curl->setHeader('Authorization', 'Bearer ' . $sig);\\n$curl->post($url, $payload);\\n\\n# token returned by the API\\n$token = $curl->response->key;\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Using a Token\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"from amber_lib import client, connection\\n\\n# Create a context for our requests\\nctx = client.Context(\\n  token=\\\"JGb87fC46c0nM0Smmvr41CAB9dnsNCc4670MN9ij8\\\",\\n)\\n\\n\\n# Generate a new connection\\nconn = connection.Connection(ctx)\\n\\n# Let's create a wooden chair...\\n# First, we need an empty Product resource\\nchair = conn.Product\\n\\n# Now we update it\\nchair.update({\\n\\t\\\"category\\\": {\\n\\t\\t\\\"primary\\\": \\\"casegood\\\",\\n    \\\"secondary\\\": \\\"casegood_chair\\\"\\n\\t},\\n  \\\"identity\\\": {\\n  \\t\\\"sku\\\": \\\"l337\\\",\\n    \\\"name\\\": \\\"A wooden chair\\\"\\n  }\\n})\\n\\n# Save to create a new product\\nchair.save()\\n\",\n      \"language\": \"python\"\n    }\n  ]\n}\n[/block]","category":"5732447418fca21900f9ca98","createdAt":"2016-05-10T20:29:26.769Z","excerpt":"How to use JWTs for authentication","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","next":{"description":"","pages":[]},"order":1,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"json-web-tokens","sync_unique":"","title":"JSON Web Tokens","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

JSON Web Tokens

How to use JWTs for authentication

A JSON Web Token, or [JWT](https://jwt.io/), is used to send information that can be verified and trusted by means of a digital signature. It comprises a compact and URL-safe JSON object, which is cryptographically signed to verify its authenticity, and which can also be encrypted if the payload contains sensitive information. Because of it’s compact structure, JWT is usually used in HTTP Authorization headers or URL query parameters. [block:api-header] { "type": "basic", "title": "Requesting Token" } [/block] A token can be requested with a signed, properly formatted POST to the `/tokens` endpoint. [block:code] { "codes": [ { "code": "from amber_lib import client, connection\n\n# Create a context for our requests\nctx = client.Context(\n\tpublic=\"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890\",\n private=\"1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\",\n)\n\n# Create a new token string\ntoken = ctx.create_token()\nprint(token) # Prints: JGb87fC46c0nM0Smmvr41CAB9dnsNCc4670MN9ij8", "language": "python" }, { "code": "<?php\nuse \\Curl\\Curl; // use the curl library to make requests\n\n$pub = [your public key];\n$priv = [your private key];\n$token = '';\n\n# API url will vary, depending on if you are accessing the \n# sandbox or the live API\n$url = 'http://[api url]/tokens';\n\ndate_default_timezone_set(\"UTC\");\n$timestamp = date('Y-m-d\\TH:i:s.u');\n\n$curl = new Curl();\n$curl->setHeader('Accept', 'application/hal+json');\n$curl->setHeader('Content-Type', 'application/json');\n$curl->setHeader('Public-Key', $pub);\n$curl->setHeader('Timestamp', $timestamp);\n$curl->setheader('URL', $url);\n\n$data = array(\n 'Accept' => 'application/hal+json',\n 'Content-Type' => 'application/json',\n 'Public-Key' => $pub,\n 'Timestamp' => $timestamp,\n 'URL' => $url\n);\n\n$payload = '{}';\n\n# generate the signature\n$sig = json_encode($data, JSON_UNESCAPED_SLASHES);\n$sig .= $payload . $priv;\n$sig = hash('sha256', $sig);\n$sig = base64_encode($sig);\n\n$curl->setHeader('Authorization', 'Bearer ' . $sig);\n$curl->post($url, $payload);\n\n# token returned by the API\n$token = $curl->response->key;", "language": "php" } ] } [/block] [block:api-header] { "type": "basic", "title": "Using a Token" } [/block] [block:code] { "codes": [ { "code": "from amber_lib import client, connection\n\n# Create a context for our requests\nctx = client.Context(\n token=\"JGb87fC46c0nM0Smmvr41CAB9dnsNCc4670MN9ij8\",\n)\n\n\n# Generate a new connection\nconn = connection.Connection(ctx)\n\n# Let's create a wooden chair...\n# First, we need an empty Product resource\nchair = conn.Product\n\n# Now we update it\nchair.update({\n\t\"category\": {\n\t\t\"primary\": \"casegood\",\n \"secondary\": \"casegood_chair\"\n\t},\n \"identity\": {\n \t\"sku\": \"l337\",\n \"name\": \"A wooden chair\"\n }\n})\n\n# Save to create a new product\nchair.save()\n", "language": "python" } ] } [/block]
A JSON Web Token, or [JWT](https://jwt.io/), is used to send information that can be verified and trusted by means of a digital signature. It comprises a compact and URL-safe JSON object, which is cryptographically signed to verify its authenticity, and which can also be encrypted if the payload contains sensitive information. Because of it’s compact structure, JWT is usually used in HTTP Authorization headers or URL query parameters. [block:api-header] { "type": "basic", "title": "Requesting Token" } [/block] A token can be requested with a signed, properly formatted POST to the `/tokens` endpoint. [block:code] { "codes": [ { "code": "from amber_lib import client, connection\n\n# Create a context for our requests\nctx = client.Context(\n\tpublic=\"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890\",\n private=\"1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\",\n)\n\n# Create a new token string\ntoken = ctx.create_token()\nprint(token) # Prints: JGb87fC46c0nM0Smmvr41CAB9dnsNCc4670MN9ij8", "language": "python" }, { "code": "<?php\nuse \\Curl\\Curl; // use the curl library to make requests\n\n$pub = [your public key];\n$priv = [your private key];\n$token = '';\n\n# API url will vary, depending on if you are accessing the \n# sandbox or the live API\n$url = 'http://[api url]/tokens';\n\ndate_default_timezone_set(\"UTC\");\n$timestamp = date('Y-m-d\\TH:i:s.u');\n\n$curl = new Curl();\n$curl->setHeader('Accept', 'application/hal+json');\n$curl->setHeader('Content-Type', 'application/json');\n$curl->setHeader('Public-Key', $pub);\n$curl->setHeader('Timestamp', $timestamp);\n$curl->setheader('URL', $url);\n\n$data = array(\n 'Accept' => 'application/hal+json',\n 'Content-Type' => 'application/json',\n 'Public-Key' => $pub,\n 'Timestamp' => $timestamp,\n 'URL' => $url\n);\n\n$payload = '{}';\n\n# generate the signature\n$sig = json_encode($data, JSON_UNESCAPED_SLASHES);\n$sig .= $payload . $priv;\n$sig = hash('sha256', $sig);\n$sig = base64_encode($sig);\n\n$curl->setHeader('Authorization', 'Bearer ' . $sig);\n$curl->post($url, $payload);\n\n# token returned by the API\n$token = $curl->response->key;", "language": "php" } ] } [/block] [block:api-header] { "type": "basic", "title": "Using a Token" } [/block] [block:code] { "codes": [ { "code": "from amber_lib import client, connection\n\n# Create a context for our requests\nctx = client.Context(\n token=\"JGb87fC46c0nM0Smmvr41CAB9dnsNCc4670MN9ij8\",\n)\n\n\n# Generate a new connection\nconn = connection.Connection(ctx)\n\n# Let's create a wooden chair...\n# First, we need an empty Product resource\nchair = conn.Product\n\n# Now we update it\nchair.update({\n\t\"category\": {\n\t\t\"primary\": \"casegood\",\n \"secondary\": \"casegood_chair\"\n\t},\n \"identity\": {\n \t\"sku\": \"l337\",\n \"name\": \"A wooden chair\"\n }\n})\n\n# Save to create a new product\nchair.save()\n", "language": "python" } ] } [/block]
{"__v":1,"_id":"573b79c037fcf72000a2e6f6","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Documentation in Progress\"\n}\n[/block]","category":"5732447418fca21900f9ca98","createdAt":"2016-05-17T20:06:24.911Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":999,"project":"571e47385536c12000f51b34","slug":"permissions","sync_unique":"","title":"Permissions","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Permissions


[block:callout] { "type": "danger", "title": "Documentation in Progress" } [/block]
[block:callout] { "type": "danger", "title": "Documentation in Progress" } [/block]
{"__v":0,"_id":"586e86409d4a1d370076369d","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"body":"As mentioned above, all requests must either be signed with a private key, or have a valid authentication token included.\n\nTo sign a request, first concatenate the following strings:\n\n* a JSON-encoded array of the headers in the request. \n* the payload of the request\n* your private API key\n\nNext, generate the SHA-256 hash of the resulting string. Then, base 64 encode the hash.\n\n**NOTE** - even if the payload of the request is empty (i.e., for a `GET` request) - an empty JSON object (`{}`) must still be included in the payload.\n\nThis header can then be added to subsequent requests using the the Authorization header:\n``Authorization: Bearer [token]``\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$signature = json_encode($headers, JSON_UNESCAPED_SLASHES);\\n$signature .= $payload . $private_key;\\n$signature = hash('sha256', $signature);\\n$signature = base64_encode($signature);\",\n      \"language\": \"php\",\n      \"name\": \"Generating a signature in PHP\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5732447418fca21900f9ca98","createdAt":"2017-01-05T17:45:36.043Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","next":{"pages":[],"description":""},"order":999,"project":"571e47385536c12000f51b34","slug":"signing-requests","sync_unique":"","title":"Signing Requests","type":"basic","updates":[],"user":"583490237144843b00926645","version":"571e47385536c12000f51b37","childrenPages":[]}

Signing Requests


As mentioned above, all requests must either be signed with a private key, or have a valid authentication token included. To sign a request, first concatenate the following strings: * a JSON-encoded array of the headers in the request. * the payload of the request * your private API key Next, generate the SHA-256 hash of the resulting string. Then, base 64 encode the hash. **NOTE** - even if the payload of the request is empty (i.e., for a `GET` request) - an empty JSON object (`{}`) must still be included in the payload. This header can then be added to subsequent requests using the the Authorization header: ``Authorization: Bearer [token]`` [block:code] { "codes": [ { "code": "$signature = json_encode($headers, JSON_UNESCAPED_SLASHES);\n$signature .= $payload . $private_key;\n$signature = hash('sha256', $signature);\n$signature = base64_encode($signature);", "language": "php", "name": "Generating a signature in PHP" } ], "sidebar": true } [/block]
As mentioned above, all requests must either be signed with a private key, or have a valid authentication token included. To sign a request, first concatenate the following strings: * a JSON-encoded array of the headers in the request. * the payload of the request * your private API key Next, generate the SHA-256 hash of the resulting string. Then, base 64 encode the hash. **NOTE** - even if the payload of the request is empty (i.e., for a `GET` request) - an empty JSON object (`{}`) must still be included in the payload. This header can then be added to subsequent requests using the the Authorization header: ``Authorization: Bearer [token]`` [block:code] { "codes": [ { "code": "$signature = json_encode($headers, JSON_UNESCAPED_SLASHES);\n$signature .= $payload . $private_key;\n$signature = hash('sha256', $signature);\n$signature = base64_encode($signature);", "language": "php", "name": "Generating a signature in PHP" } ], "sidebar": true } [/block]
{"__v":15,"_id":"5730f926b16ed73200ddd29e","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"API Keys are resources used to represent API clients, and are distinguished by public / private key pairings. These public / private key pairs are used to sign API requests for authentication or for creating authentication tokens.\n\nAPI Keys also indicate the relationship between an API client and/or a manufacturer or sales channels.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier. This is populated by the API when a new API Key is created.\",\n    \"0-2\": \"\",\n    \"1-0\": \"`kind`\\n*String*\",\n    \"1-1\": \"Key-type. Must be \\\"client_key\\\". Other key types will be available in the future.\",\n    \"1-2\": \"\",\n    \"2-0\": \"`manufacturer_id`\\n*Integer, optional*\",\n    \"2-1\": \"Unique identifier for corresponding [Manufacturer Resource](doc:manufacturer-resource).\",\n    \"2-2\": \"\",\n    \"3-0\": \"`name`\\n*String*\",\n    \"3-1\": \"A user-provided identifier for the API Key. Usually an email address.\",\n    \"3-2\": \"\",\n    \"4-0\": \"`private`\\n*String*\",\n    \"4-1\": \"Private key, used for signing API requests. Keep this key a secret.\\nIt is populated by the API when a new API Key is created.\",\n    \"4-2\": \"\",\n    \"5-0\": \"`public`\\n*String*\",\n    \"5-1\": \"Public key, used to identify clients. This is populated by the API when a new API Key is created.\",\n    \"5-2\": \"\",\n    \"6-0\": \"`role_name`\\n*String*\",\n    \"6-1\": \"Name of permission role for Key.\",\n    \"6-2\": \"\",\n    \"7-0\": \"`sales_channel_id`\\n*Integer, optional*\",\n    \"7-1\": \"Unique identifier for corresponding [Sales Channel Resource](doc:sales-channel-resource).\",\n    \"7-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": 1,\\n  \\\"kind\\\": \\\"client_key\\\",\\n  \\\"manufacturer_id\\\": null,\\n  \\\"name\\\": \\\"channel-manager\\\",\\n  \\\"private\\\": \\\"0c9aunptbr8ovpnl98bay3lyl98vb3ltabvwl3cvbauhbl43vba83ry8lab3853a\\\",\\n  \\\"public\\\": \\\"awegawerf353g45h5gbdnubd5yd5nd5yd5ryb6n5un67iscuntp092sa3ntruc90v\\\",\\n  \\\"role_name\\\": \\\"ChannelManagerAdmin\\\",\\n  \\\"sales_channel_id\\\": null\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5730e1d66b55e93400b32a98","createdAt":"2016-05-09T20:55:02.005Z","excerpt":"Explaining the API Key resource","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"api-key-resource","sync_unique":"","title":"API Key Resource","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

API Key Resource

Explaining the API Key resource

API Keys are resources used to represent API clients, and are distinguished by public / private key pairings. These public / private key pairs are used to sign API requests for authentication or for creating authentication tokens. API Keys also indicate the relationship between an API client and/or a manufacturer or sales channels. [block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`id`\n*Integer*", "0-1": "Unique resource identifier. This is populated by the API when a new API Key is created.", "0-2": "", "1-0": "`kind`\n*String*", "1-1": "Key-type. Must be \"client_key\". Other key types will be available in the future.", "1-2": "", "2-0": "`manufacturer_id`\n*Integer, optional*", "2-1": "Unique identifier for corresponding [Manufacturer Resource](doc:manufacturer-resource).", "2-2": "", "3-0": "`name`\n*String*", "3-1": "A user-provided identifier for the API Key. Usually an email address.", "3-2": "", "4-0": "`private`\n*String*", "4-1": "Private key, used for signing API requests. Keep this key a secret.\nIt is populated by the API when a new API Key is created.", "4-2": "", "5-0": "`public`\n*String*", "5-1": "Public key, used to identify clients. This is populated by the API when a new API Key is created.", "5-2": "", "6-0": "`role_name`\n*String*", "6-1": "Name of permission role for Key.", "6-2": "", "7-0": "`sales_channel_id`\n*Integer, optional*", "7-1": "Unique identifier for corresponding [Sales Channel Resource](doc:sales-channel-resource).", "7-2": "" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": 1,\n \"kind\": \"client_key\",\n \"manufacturer_id\": null,\n \"name\": \"channel-manager\",\n \"private\": \"0c9aunptbr8ovpnl98bay3lyl98vb3ltabvwl3cvbauhbl43vba83ry8lab3853a\",\n \"public\": \"awegawerf353g45h5gbdnubd5yd5nd5yd5ryb6n5un67iscuntp092sa3ntruc90v\",\n \"role_name\": \"ChannelManagerAdmin\",\n \"sales_channel_id\": null\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
API Keys are resources used to represent API clients, and are distinguished by public / private key pairings. These public / private key pairs are used to sign API requests for authentication or for creating authentication tokens. API Keys also indicate the relationship between an API client and/or a manufacturer or sales channels. [block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`id`\n*Integer*", "0-1": "Unique resource identifier. This is populated by the API when a new API Key is created.", "0-2": "", "1-0": "`kind`\n*String*", "1-1": "Key-type. Must be \"client_key\". Other key types will be available in the future.", "1-2": "", "2-0": "`manufacturer_id`\n*Integer, optional*", "2-1": "Unique identifier for corresponding [Manufacturer Resource](doc:manufacturer-resource).", "2-2": "", "3-0": "`name`\n*String*", "3-1": "A user-provided identifier for the API Key. Usually an email address.", "3-2": "", "4-0": "`private`\n*String*", "4-1": "Private key, used for signing API requests. Keep this key a secret.\nIt is populated by the API when a new API Key is created.", "4-2": "", "5-0": "`public`\n*String*", "5-1": "Public key, used to identify clients. This is populated by the API when a new API Key is created.", "5-2": "", "6-0": "`role_name`\n*String*", "6-1": "Name of permission role for Key.", "6-2": "", "7-0": "`sales_channel_id`\n*Integer, optional*", "7-1": "Unique identifier for corresponding [Sales Channel Resource](doc:sales-channel-resource).", "7-2": "" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": 1,\n \"kind\": \"client_key\",\n \"manufacturer_id\": null,\n \"name\": \"channel-manager\",\n \"private\": \"0c9aunptbr8ovpnl98bay3lyl98vb3ltabvwl3cvbauhbl43vba83ry8lab3853a\",\n \"public\": \"awegawerf353g45h5gbdnubd5yd5nd5yd5ryb6n5un67iscuntp092sa3ntruc90v\",\n \"role_name\": \"ChannelManagerAdmin\",\n \"sales_channel_id\": null\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":12,"_id":"5730ebb80f929f3600841d11","api":{"auth":"required","examples":{"codes":[{"code":"# Setup\nkey = conn.APIKey\ndata = {\"name\": \"New Name\", \"kind\": \"client_key\"}\nkey.update(data)\n\n# Create new API Key\nkey.save()","language":"python"}]},"method":"post","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 1,\n  \"kind\": \"client_key\",\n  \"manufacturer_id\": null,\n  \"name\": \"channel-manager\",\n  \"private\": \"0c9aunptbr8ovpnl98bay3lyl98vb3ltabvwl3cvbauhbl43vba83ry8lab3853a\",\n  \"public\": \"awegawerf353g45h5gbdnubd5yd5nd5yd5ryb6n5un67iscuntp092sa3ntruc90v\",\n  \"role_name\": \"ChannelManagerAdmin\",\n  \"sales_channel_id\": null\n}","name":""}]},"settings":"","url":"/api_keys"},"body":"Create a new API Key entry, signifying a new API client. All data is provided as JSON parameters in the `POST` request.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Required information\",\n  \"body\": \"You must provide a `kind` and `name`. \\nThe fields `manufacturer_id` and `sales_channel_id` are optional.\\nAll other fields are populated by the API\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Returned Result\"\n}\n[/block]\nReturns a populated [API Key Resource](doc:api-key-resource) object.","category":"5730e1d66b55e93400b32a98","createdAt":"2016-05-09T19:57:44.027Z","excerpt":"Create a new API Key","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"api_keys","sync_unique":"","title":"Create API Key","type":"post","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

postCreate API Key

Create a new API Key

Create a new API Key entry, signifying a new API client. All data is provided as JSON parameters in the `POST` request. [block:callout] { "type": "info", "title": "Required information", "body": "You must provide a `kind` and `name`. \nThe fields `manufacturer_id` and `sales_channel_id` are optional.\nAll other fields are populated by the API" } [/block] [block:api-header] { "type": "basic", "title": "Returned Result" } [/block] Returns a populated [API Key Resource](doc:api-key-resource) object.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Create a new API Key entry, signifying a new API client. All data is provided as JSON parameters in the `POST` request. [block:callout] { "type": "info", "title": "Required information", "body": "You must provide a `kind` and `name`. \nThe fields `manufacturer_id` and `sales_channel_id` are optional.\nAll other fields are populated by the API" } [/block] [block:api-header] { "type": "basic", "title": "Returned Result" } [/block] Returns a populated [API Key Resource](doc:api-key-resource) object.
{"__v":3,"_id":"5730e203b16ed73200ddd26f","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"conn.APIKey.retrieve(1)"},{"language":"shell","code":"curl -H \"Content-Type: application/json\" -X GET -d '{\"data\":{},\"headers\":{\"Content-Type\":\"application/json\"},\"public_key\":\"gerhsre45kjh345k2jh34g5kjhb2345hs5e4653\",\"signature\":\"gargaergahrHSRE4Ga4g$H45hsh%^hseh$heshse==\",\"timestamp\":\"2016-05-09T15:20:40.174834\",\"url\":\"http://127.0.0.1:8080/api_keys/1\"}' http://127.0.0.1:8080/api_keys/1"}]},"method":"get","params":[{"_id":"5730e98f0f929f3600841d0c","default":"Endpoint Param","desc":"Unique identifier representing desired resource","name":"ID","ref":"","required":true,"type":"int","in":"query"}],"results":{"codes":[{"name":"","code":"{\n  \"id\": 1,\n  \"kind\": \"client_key\",\n  \"manufacturer_id\": null,\n  \"name\": \"channel-manager\",\n  \"private\": \"RkdaMTlWUCtxRCtDOGdjNG1HVU0wOTNTdFhjUktiZWxXbjFlNGtNRlJ2eGtqUlp\",\n  \"public\": \"JlZ21hczR0cDttZyBwb3RoaiByZHRoanJHWjE5VlArcUQrQzhnYzRtR1VNMDkzU3\",\n  \"role_name\": \"ChannelManagerAdmin\",\n  \"sales_channel_id\": null\n}","language":"json","status":200}]},"settings":"","url":"/api_keys/:id"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Result\"\n}\n[/block]\nReturns a populated [API Key Resource](doc:api-key-resource) object.","category":"5730e1d66b55e93400b32a98","createdAt":"2016-05-09T19:16:19.921Z","editedParams":true,"editedParams2":true,"excerpt":"Retrieve a specified API Key","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"testinput","sync_unique":"","title":"Retrieve API Key","type":"get","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

getRetrieve API Key

Retrieve a specified API Key

Query Params

ID:
required
integerEndpoint Param
Unique identifier representing desired resource
[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Returns a populated [API Key Resource](doc:api-key-resource) object.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Returns a populated [API Key Resource](doc:api-key-resource) object.
{"__v":2,"_id":"5731fee508cf4f0e00ee52bf","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"# Setup\nkey = conn.APIKey.retrieve(id)\nchanges = {\"name\": \"New Name\", \"kind\": \"client_key\"}\nkey.update(changes)\n\n# Save the existing API Key\nkey.save()"}]},"method":"put","params":[{"_id":"5731fee508cf4f0e00ee52c0","ref":"","required":true,"desc":"Unique identifier representing desired resource","default":"Endpoint Param","type":"string","name":"id","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 1,\n  \"kind\": \"client_key\",\n  \"manufacturer_id\": null,\n  \"name\": \"New Name\",\n  \"private\": \"RkdaMTlWUCtxRCtDOGdjNG1HVU0wOTNTdFhjUktiZWxXbjFlNGtNRlJ2eGtqUlp\",\n  \"public\": \"JlZ21hczR0cDttZyBwb3RoaiByZHRoanJHWjE5VlArcUQrQzhnYzRtR1VNMDkzU3\",\n  \"role_name\": \"ChannelManagerAdmin\",\n  \"sales_channel_id\": null\n}\n","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/api_key/:id"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Result\"\n}\n[/block]\nReturns a populated [API Key Resource](doc:api-key-resource) object.","category":"5730e1d66b55e93400b32a98","createdAt":"2016-05-10T15:31:49.533Z","editedParams":true,"editedParams2":true,"excerpt":"Update a specified API Key","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"update-api-key","sync_unique":"","title":"Update API Key","type":"put","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

putUpdate API Key

Update a specified API Key

Path Params

id:
required
stringEndpoint Param
Unique identifier representing desired resource
[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Returns a populated [API Key Resource](doc:api-key-resource) object.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Returns a populated [API Key Resource](doc:api-key-resource) object.
{"__v":0,"_id":"5732001ad720220e008ea1ba","api":{"auth":"required","examples":{"codes":[{"name":"Python","language":"python","code":"# Setup\nkey = conn.APIKey.retrieve(id)\n\n# Delete the existing API Key\nkey.delete()"}]},"method":"delete","params":[{"_id":"5732001ad720220e008ea1bb","default":"Endpoint Param","desc":"Unique identifier representing desired resource","name":"ID","ref":"","required":true,"type":"string","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/api_keys/:id"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Result\"\n}\n[/block]\nNothing is returned on a successful deletion.","category":"5730e1d66b55e93400b32a98","createdAt":"2016-05-10T15:36:58.049Z","editedParams":true,"editedParams2":true,"excerpt":"Delete a specified API Key","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"delete-api-key","sync_unique":"","title":"Delete API Key","type":"delete","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

deleteDelete API Key

Delete a specified API Key

Body Params

ID:
required
stringEndpoint Param
Unique identifier representing desired resource
[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Nothing is returned on a successful deletion.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Nothing is returned on a successful deletion.
{"__v":6,"_id":"573235b1a825f30e00b51baf","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Limited Resource\",\n  \"body\": \"This resource limits the operations available upon it.\"\n}\n[/block]\nThe category resource is used to retrieve a list of primary, secondary, and tertiary categories. \nCategories cannot be created, modified or deleted.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`count`\\n*Object*\",\n    \"0-1\": \"Specified the total primary, secondary, and tertiary categories available.\",\n    \"1-0\": \"`primary`\\n*Array*\",\n    \"1-1\": \"A sting array of all the available primary category names.\",\n    \"2-0\": \"`secondary`\\n*Array*\",\n    \"2-1\": \"A string array of all the available secondary category names.\",\n    \"3-0\": \"`tertiary`\\n*Array*\",\n    \"3-1\": \"A string array of all the available tertiary category names.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"_links\\\": {\\n    \\\"self\\\": {\\n      \\\"href\\\": \\\"/categories\\\"\\n    }\\n  },\\n  \\\"count\\\": {\\n    \\\"primary_categories\\\": 7,\\n    \\\"secondary_categories\\\": 81,\\n    \\\"tertiary_categories\\\": 111\\n  },\\n  \\\"primary\\\": [\\n    \\\"youth\\\",\\n    \\\"accessory\\\",\\n    \\\"casegood\\\",\\n    \\\"lighting\\\",\\n    \\\"outdoor\\\",\\n    \\\"textiles\\\",\\n    \\\"upholstery\\\",\\n    \\\"\\\"\\n  ],\\n  \\\"secondary\\\": [\\n    \\\"youth_armoire\\\",\\n    \\\"youth_bed\\\",\\n    \\\"youth_bench\\\",\\n    \\\"youth_changing_table\\\",\\n    \\\"youth_dresser\\\",\\n    \\\"youth_linens\\\",\\n    \\\"...\\\",\\n    \\\"upholstery_sofa\\\",\\n    \\\"\\\"\\n  ],\\n  \\\"tertiary\\\": [\\n    \\\"youth_table_side_table\\\",\\n    \\\"youth_chair_arm_chair\\\",\\n    \\\"youth_chair_lounge_chair\\\",\\n    \\\"...\\\",\\n    \\\"upholstery_chair_side_chair\\\",\\n    \\\"upholstery_chair_wing_chair\\\",\\n    \\\"\\\"\\n  ],\\n  \\\"total\\\": 199\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ]\n}\n[/block]","category":"573232cb1be99f2200a528fe","createdAt":"2016-05-10T19:25:37.186Z","excerpt":"Access to API categories","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"category-resource","sync_unique":"","title":"Category Resource","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Category Resource

Access to API categories

[block:callout] { "type": "warning", "title": "Limited Resource", "body": "This resource limits the operations available upon it." } [/block] The category resource is used to retrieve a list of primary, secondary, and tertiary categories. Categories cannot be created, modified or deleted. [block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "0-0": "`count`\n*Object*", "0-1": "Specified the total primary, secondary, and tertiary categories available.", "1-0": "`primary`\n*Array*", "1-1": "A sting array of all the available primary category names.", "2-0": "`secondary`\n*Array*", "2-1": "A string array of all the available secondary category names.", "3-0": "`tertiary`\n*Array*", "3-1": "A string array of all the available tertiary category names." }, "cols": 2, "rows": 4 } [/block] [block:code] { "codes": [ { "code": "{\n \"_links\": {\n \"self\": {\n \"href\": \"/categories\"\n }\n },\n \"count\": {\n \"primary_categories\": 7,\n \"secondary_categories\": 81,\n \"tertiary_categories\": 111\n },\n \"primary\": [\n \"youth\",\n \"accessory\",\n \"casegood\",\n \"lighting\",\n \"outdoor\",\n \"textiles\",\n \"upholstery\",\n \"\"\n ],\n \"secondary\": [\n \"youth_armoire\",\n \"youth_bed\",\n \"youth_bench\",\n \"youth_changing_table\",\n \"youth_dresser\",\n \"youth_linens\",\n \"...\",\n \"upholstery_sofa\",\n \"\"\n ],\n \"tertiary\": [\n \"youth_table_side_table\",\n \"youth_chair_arm_chair\",\n \"youth_chair_lounge_chair\",\n \"...\",\n \"upholstery_chair_side_chair\",\n \"upholstery_chair_wing_chair\",\n \"\"\n ],\n \"total\": 199\n}", "language": "json", "name": "Example JSON" } ] } [/block]
[block:callout] { "type": "warning", "title": "Limited Resource", "body": "This resource limits the operations available upon it." } [/block] The category resource is used to retrieve a list of primary, secondary, and tertiary categories. Categories cannot be created, modified or deleted. [block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "0-0": "`count`\n*Object*", "0-1": "Specified the total primary, secondary, and tertiary categories available.", "1-0": "`primary`\n*Array*", "1-1": "A sting array of all the available primary category names.", "2-0": "`secondary`\n*Array*", "2-1": "A string array of all the available secondary category names.", "3-0": "`tertiary`\n*Array*", "3-1": "A string array of all the available tertiary category names." }, "cols": 2, "rows": 4 } [/block] [block:code] { "codes": [ { "code": "{\n \"_links\": {\n \"self\": {\n \"href\": \"/categories\"\n }\n },\n \"count\": {\n \"primary_categories\": 7,\n \"secondary_categories\": 81,\n \"tertiary_categories\": 111\n },\n \"primary\": [\n \"youth\",\n \"accessory\",\n \"casegood\",\n \"lighting\",\n \"outdoor\",\n \"textiles\",\n \"upholstery\",\n \"\"\n ],\n \"secondary\": [\n \"youth_armoire\",\n \"youth_bed\",\n \"youth_bench\",\n \"youth_changing_table\",\n \"youth_dresser\",\n \"youth_linens\",\n \"...\",\n \"upholstery_sofa\",\n \"\"\n ],\n \"tertiary\": [\n \"youth_table_side_table\",\n \"youth_chair_arm_chair\",\n \"youth_chair_lounge_chair\",\n \"...\",\n \"upholstery_chair_side_chair\",\n \"upholstery_chair_wing_chair\",\n \"\"\n ],\n \"total\": 199\n}", "language": "json", "name": "Example JSON" } ] } [/block]
{"__v":3,"_id":"5732407a1be99f2200a52920","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"Products can be assigned to categories, which will determine what components will be attached to that product. A product can also be left unassigned, in which case only a few default components will be associated with it.\n[block:parameters]\n{\n  \"data\": {\n    \"78-2\": \"\",\n    \"78-0\": \"outdoor\",\n    \"78-1\": \"loveseat\",\n    \"80-0\": \"outdoor\",\n    \"80-1\": \"sofa\",\n    \"80-2\": \"\",\n    \"29-2\": \"clocks\",\n    \"29-1\": \"wall\",\n    \"29-0\": \"accessory\",\n    \"127-2\": \"\",\n    \"127-0\": \"youth\",\n    \"127-1\": \"table\",\n    \"25-2\": \"\",\n    \"25-1\": \"umbrella\",\n    \"25-0\": \"accessory\",\n    \"28-0\": \"accessory\",\n    \"28-1\": \"wall\",\n    \"28-2\": \"art\",\n    \"57-1\": \"table\",\n    \"57-0\": \"casegood\",\n    \"57-2\": \"\",\n    \"58-2\": \"cocktail\",\n    \"58-0\": \"casegood\",\n    \"58-1\": \"table\",\n    \"87-2\": \"dining\",\n    \"87-1\": \"table\",\n    \"87-0\": \"outdoor\",\n    \"85-1\": \"table\",\n    \"85-0\": \"outdoor\",\n    \"85-2\": \"bistro\",\n    \"82-2\": \"bar\",\n    \"82-0\": \"outdoor\",\n    \"82-1\": \"stool\",\n    \"24-0\": \"accessory\",\n    \"24-1\": \"trunk\",\n    \"24-2\": \"\",\n    \"108-0\": \"upholstery\",\n    \"108-1\": \"sofa\",\n    \"108-2\": \"\",\n    \"124-2\": \"\",\n    \"124-1\": \"linens\",\n    \"124-0\": \"youth\",\n    \"122-1\": \"crib\",\n    \"122-0\": \"youth\",\n    \"122-2\": \"\",\n    \"6-2\": \"\",\n    \"6-0\": \"accessory\",\n    \"6-1\": \"clock\",\n    \"32-0\": \"base entity\",\n    \"32-1\": \"\",\n    \"32-2\": \"\",\n    \"27-2\": \"\",\n    \"30-2\": \"mirrors\",\n    \"30-0\": \"accessory\",\n    \"30-1\": \"wall\",\n    \"125-0\": \"youth\",\n    \"125-1\": \"nightstand\",\n    \"125-2\": \"\",\n    \"128-2\": \"side table\",\n    \"128-1\": \"table\",\n    \"128-0\": \"youth\",\n    \"26-2\": \"\",\n    \"26-0\": \"accessory\",\n    \"26-1\": \"vase\",\n    \"86-2\": \"cocktail\",\n    \"86-0\": \"outdoor\",\n    \"86-1\": \"table\",\n    \"9-1\": \"fire\",\n    \"9-0\": \"accessory\",\n    \"9-2\": \"\",\n    \"23-1\": \"tray\",\n    \"23-0\": \"accessory\",\n    \"23-2\": \"\",\n    \"81-1\": \"stool\",\n    \"81-0\": \"outdoor\",\n    \"81-2\": \"\",\n    \"50-2\": \"\",\n    \"50-1\": \"media\",\n    \"50-0\": \"casegood\",\n    \"101-2\": \"side chair\",\n    \"101-1\": \"chair\",\n    \"101-0\": \"upholstery\",\n    \"54-2\": \"bar\",\n    \"54-1\": \"stool\",\n    \"54-0\": \"casegood\",\n    \"98-0\": \"upholstery\",\n    \"98-1\": \"chair\",\n    \"98-2\": \"chaise lounge\",\n    \"107-2\": \"\",\n    \"107-1\": \"sectional\",\n    \"107-0\": \"upholstery\",\n    \"110-1\": \"upholstered bed\",\n    \"110-0\": \"upholstery\",\n    \"103-2\": \"wing chair\",\n    \"110-2\": \"\",\n    \"31-1\": \"\",\n    \"31-0\": \"accessory\",\n    \"31-2\": \"\",\n    \"129-0\": \"youth\",\n    \"129-1\": \"\",\n    \"129-2\": \"\",\n    \"12-2\": \"\",\n    \"121-0\": \"youth\",\n    \"121-1\": \"chest drawer\",\n    \"121-2\": \"\",\n    \"12-1\": \"miscellaneous\",\n    \"74-2\": \"\",\n    \"74-1\": \"chair\",\n    \"74-0\": \"outdoor\",\n    \"69-0\": \"lighting\",\n    \"69-1\": \"ceiling\",\n    \"69-2\": \"pendant\",\n    \"100-2\": \"lounge chair\",\n    \"100-0\": \"upholstery\",\n    \"100-1\": \"chair\",\n    \"52-1\": \"sideboard\",\n    \"46-2\": \"\",\n    \"46-1\": \"desk\",\n    \"46-0\": \"casegood\",\n    \"49-0\": \"casegood\",\n    \"49-1\": \"headboard\",\n    \"49-2\": \"\",\n    \"99-1\": \"chair\",\n    \"99-0\": \"upholstery\",\n    \"99-2\": \"desk chair\",\n    \"70-2\": \"\",\n    \"70-1\": \"floor\",\n    \"70-0\": \"lighting\",\n    \"55-2\": \"counter\",\n    \"55-0\": \"casegood\",\n    \"55-1\": \"stool\",\n    \"39-0\": \"casegood\",\n    \"104-1\": \"loveseat\",\n    \"104-0\": \"upholstery\",\n    \"104-2\": \"\",\n    \"106-2\": \"\",\n    \"106-0\": \"upholstery\",\n    \"106-1\": \"ottoman\",\n    \"53-0\": \"casegood\",\n    \"53-1\": \"stool\",\n    \"53-2\": \"\",\n    \"51-2\": \"\",\n    \"51-0\": \"casegood\",\n    \"51-1\": \"nightstand\",\n    \"8-0\": \"accessory\",\n    \"8-1\": \"easel\",\n    \"8-2\": \"\",\n    \"44-2\": \"side chair\",\n    \"44-1\": \"chair\",\n    \"75-2\": \"dining chair\",\n    \"2-0\": \"accessory\",\n    \"2-1\": \"bookends\",\n    \"73-0\": \"lighting\",\n    \"73-1\": \"\",\n    \"73-2\": \"\",\n    \"14-2\": \"\",\n    \"14-1\": \"picture frame\",\n    \"14-0\": \"accessory\",\n    \"103-0\": \"upholstery\",\n    \"103-1\": \"chair\",\n    \"18-2\": \"\",\n    \"18-1\": \"sculpture\",\n    \"18-0\": \"accessory\",\n    \"10-0\": \"accessory\",\n    \"10-1\": \"fire\",\n    \"10-2\": \"elements\",\n    \"77-0\": \"outdoor\",\n    \"77-1\": \"fire pit\",\n    \"77-2\": \"\",\n    \"48-2\": \"\",\n    \"47-2\": \"\",\n    \"47-0\": \"casegood\",\n    \"47-1\": \"dresser\",\n    \"75-0\": \"outdoor\",\n    \"75-1\": \"chair\",\n    \"68-1\": \"ceiling\",\n    \"68-0\": \"lighting\",\n    \"68-2\": \"flush mount\",\n    \"71-2\": \"\",\n    \"71-0\": \"lighting\",\n    \"71-1\": \"table\",\n    \"15-0\": \"accessory\",\n    \"15-1\": \"pillow\",\n    \"15-2\": \"\",\n    \"59-2\": \"dining\",\n    \"59-0\": \"casegood\",\n    \"5-1\": \"candleholder\",\n    \"5-0\": \"accessory\",\n    \"5-2\": \"\",\n    \"96-2\": \"\",\n    \"96-1\": \"chair\",\n    \"96-0\": \"upholstery\",\n    \"22-1\": \"throw\",\n    \"22-0\": \"accessory\",\n    \"22-2\": \"\",\n    \"11-1\": \"fire\",\n    \"11-0\": \"accessory\",\n    \"11-2\": \"indoor\",\n    \"76-1\": \"chair\",\n    \"76-0\": \"outdoor\",\n    \"12-0\": \"accessory\",\n    \"76-2\": \"lounge chair\",\n    \"120-2\": \"\",\n    \"120-0\": \"youth\",\n    \"120-1\": \"changing table\",\n    \"17-2\": \"\",\n    \"17-0\": \"accessory\",\n    \"17-1\": \"screen\",\n    \"16-1\": \"planter\",\n    \"16-0\": \"accessory\",\n    \"16-2\": \"\",\n    \"19-0\": \"accessory\",\n    \"19-1\": \"slipcover\",\n    \"19-2\": \"\",\n    \"72-1\": \"wall\",\n    \"72-0\": \"lighting\",\n    \"72-2\": \"\",\n    \"37-2\": \"\",\n    \"37-1\": \"armoire\",\n    \"37-0\": \"casegood\",\n    \"45-2\": \"\",\n    \"45-1\": \"chest of drawers\",\n    \"45-0\": \"casegood\",\n    \"88-2\": \"side\",\n    \"88-1\": \"table\",\n    \"88-0\": \"outdoor\",\n    \"91-0\": \"textiles\",\n    \"91-1\": \"leather\",\n    \"91-2\": \"\",\n    \"48-1\": \"etagere\",\n    \"48-0\": \"casegood\",\n    \"112-2\": \"\",\n    \"112-0\": \"upholstery\",\n    \"112-1\": \"\",\n    \"92-2\": \"\",\n    \"92-1\": \"rug\",\n    \"92-0\": \"textiles\",\n    \"95-0\": \"upholstery\",\n    \"95-1\": \"bench\",\n    \"95-2\": \"\",\n    \"97-2\": \"arm chair\",\n    \"97-0\": \"upholstery\",\n    \"97-1\": \"chair\",\n    \"113-1\": \"armoire\",\n    \"113-0\": \"youth\",\n    \"113-2\": \"\",\n    \"116-2\": \"\",\n    \"116-0\": \"youth\",\n    \"116-1\": \"chair\",\n    \"4-0\": \"accessory\",\n    \"4-1\": \"box\",\n    \"4-2\": \"\",\n    \"117-1\": \"chair\",\n    \"117-0\": \"youth\",\n    \"117-2\": \"arm chair\",\n    \"7-2\": \"\",\n    \"7-1\": \"coatrack\",\n    \"7-0\": \"accessory\",\n    \"119-2\": \"side chair\",\n    \"119-1\": \"chair\",\n    \"119-0\": \"youth\",\n    \"89-2\": \"\",\n    \"89-0\": \"outdoor\",\n    \"89-1\": \"\",\n    \"1-1\": \"bookcase\",\n    \"1-0\": \"accessory\",\n    \"1-2\": \"\",\n    \"39-1\": \"bench\",\n    \"41-2\": \"\",\n    \"41-1\": \"chair\",\n    \"41-0\": \"casegood\",\n    \"42-0\": \"casegood\",\n    \"42-1\": \"chair\",\n    \"42-2\": \"arm chair\",\n    \"90-1\": \"fabric\",\n    \"90-0\": \"textiles\",\n    \"44-0\": \"casegood\",\n    \"90-2\": \"\",\n    \"39-2\": \"\",\n    \"111-2\": \"\",\n    \"111-1\": \"upholstered headboard\",\n    \"111-0\": \"upholstery\",\n    \"94-1\": \"\",\n    \"94-0\": \"textiles\",\n    \"94-2\": \"\",\n    \"93-2\": \"\",\n    \"93-0\": \"textiles\",\n    \"93-1\": \"wall covering\",\n    \"114-0\": \"youth\",\n    \"114-1\": \"bed\",\n    \"114-2\": \"\",\n    \"38-0\": \"casegood\",\n    \"38-1\": \"bed\",\n    \"38-2\": \"\",\n    \"36-2\": \"\",\n    \"36-0\": \"casegood\",\n    \"36-1\": \"accent chest\",\n    \"63-2\": \"\",\n    \"63-1\": \"china cabinet\",\n    \"63-0\": \"casegood\",\n    \"118-0\": \"youth\",\n    \"118-1\": \"chair\",\n    \"118-2\": \"lounge chair\",\n    \"115-2\": \"\",\n    \"115-1\": \"bench\",\n    \"115-0\": \"youth\",\n    \"27-1\": \"wall\",\n    \"27-0\": \"accessory\",\n    \"66-0\": \"lighting\",\n    \"66-1\": \"ceiling\",\n    \"66-2\": \"\",\n    \"43-1\": \"chair\",\n    \"43-0\": \"casegood\",\n    \"43-2\": \"desk chair\",\n    \"40-2\": \"\",\n    \"40-0\": \"casegood\",\n    \"40-1\": \"buffet\",\n    \"79-2\": \"\",\n    \"79-1\": \"sectional\",\n    \"79-0\": \"outdoor\",\n    \"84-0\": \"outdoor\",\n    \"84-1\": \"table\",\n    \"84-2\": \"\",\n    \"52-0\": \"casegood\",\n    \"0-0\": \"accessory\",\n    \"0-1\": \"bedding\",\n    \"0-2\": \"\",\n    \"61-1\": \"table\",\n    \"61-0\": \"casegood\",\n    \"59-1\": \"table\",\n    \"61-2\": \"side\",\n    \"56-0\": \"casegood\",\n    \"56-1\": \"stool\",\n    \"56-2\": \"other\",\n    \"52-2\": \"\",\n    \"2-2\": \"\",\n    \"83-2\": \"counter\",\n    \"83-1\": \"stool\",\n    \"83-0\": \"outdoor\",\n    \"67-1\": \"ceiling\",\n    \"67-0\": \"lighting\",\n    \"67-2\": \"chandelier\",\n    \"60-0\": \"casegood\",\n    \"60-1\": \"table\",\n    \"60-2\": \"game\",\n    \"62-2\": \"sofa\",\n    \"62-0\": \"casegood\",\n    \"62-1\": \"table\",\n    \"123-2\": \"\",\n    \"123-0\": \"youth\",\n    \"123-1\": \"dresser\",\n    \"126-1\": \"sideboard\",\n    \"126-0\": \"youth\",\n    \"126-2\": \"\",\n    \"3-2\": \"\",\n    \"3-1\": \"bowl\",\n    \"3-0\": \"accessory\",\n    \"h-0\": \"Primary Category\",\n    \"h-1\": \"Secondary Category\",\n    \"h-2\": \"Tertiary Category\",\n    \"65-0\": \"casegood\",\n    \"64-0\": \"casegood\",\n    \"64-1\": \"hutch\",\n    \"109-0\": \"upholstery\",\n    \"109-1\": \"sofa\",\n    \"109-2\": \"sleeper\",\n    \"105-0\": \"upholstery\",\n    \"105-1\": \"loveseat\",\n    \"105-2\": \"sleeper\",\n    \"102-0\": \"upholstery\",\n    \"102-1\": \"chair\",\n    \"102-2\": \"sleeper\",\n    \"13-0\": \"accessory\",\n    \"13-1\": \"mirror\",\n    \"21-0\": \"accessory\",\n    \"21-1\": \"tabletop\",\n    \"20-0\": \"accessory\",\n    \"20-1\": \"storage\",\n    \"33-0\": \"bedding\",\n    \"35-0\": \"bedding\",\n    \"33-1\": \"mattress\",\n    \"34-0\": \"bedding\",\n    \"34-1\": \"foundation\"\n  },\n  \"cols\": 3,\n  \"rows\": 130\n}\n[/block]","category":"573232cb1be99f2200a528fe","createdAt":"2016-05-10T20:11:38.658Z","excerpt":"A listing of all available categories for products.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","next":{"description":"","pages":[]},"order":1,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"available-categories","sync_unique":"","title":"Available Categories","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Available Categories

A listing of all available categories for products.

Products can be assigned to categories, which will determine what components will be attached to that product. A product can also be left unassigned, in which case only a few default components will be associated with it. [block:parameters] { "data": { "78-2": "", "78-0": "outdoor", "78-1": "loveseat", "80-0": "outdoor", "80-1": "sofa", "80-2": "", "29-2": "clocks", "29-1": "wall", "29-0": "accessory", "127-2": "", "127-0": "youth", "127-1": "table", "25-2": "", "25-1": "umbrella", "25-0": "accessory", "28-0": "accessory", "28-1": "wall", "28-2": "art", "57-1": "table", "57-0": "casegood", "57-2": "", "58-2": "cocktail", "58-0": "casegood", "58-1": "table", "87-2": "dining", "87-1": "table", "87-0": "outdoor", "85-1": "table", "85-0": "outdoor", "85-2": "bistro", "82-2": "bar", "82-0": "outdoor", "82-1": "stool", "24-0": "accessory", "24-1": "trunk", "24-2": "", "108-0": "upholstery", "108-1": "sofa", "108-2": "", "124-2": "", "124-1": "linens", "124-0": "youth", "122-1": "crib", "122-0": "youth", "122-2": "", "6-2": "", "6-0": "accessory", "6-1": "clock", "32-0": "base entity", "32-1": "", "32-2": "", "27-2": "", "30-2": "mirrors", "30-0": "accessory", "30-1": "wall", "125-0": "youth", "125-1": "nightstand", "125-2": "", "128-2": "side table", "128-1": "table", "128-0": "youth", "26-2": "", "26-0": "accessory", "26-1": "vase", "86-2": "cocktail", "86-0": "outdoor", "86-1": "table", "9-1": "fire", "9-0": "accessory", "9-2": "", "23-1": "tray", "23-0": "accessory", "23-2": "", "81-1": "stool", "81-0": "outdoor", "81-2": "", "50-2": "", "50-1": "media", "50-0": "casegood", "101-2": "side chair", "101-1": "chair", "101-0": "upholstery", "54-2": "bar", "54-1": "stool", "54-0": "casegood", "98-0": "upholstery", "98-1": "chair", "98-2": "chaise lounge", "107-2": "", "107-1": "sectional", "107-0": "upholstery", "110-1": "upholstered bed", "110-0": "upholstery", "103-2": "wing chair", "110-2": "", "31-1": "", "31-0": "accessory", "31-2": "", "129-0": "youth", "129-1": "", "129-2": "", "12-2": "", "121-0": "youth", "121-1": "chest drawer", "121-2": "", "12-1": "miscellaneous", "74-2": "", "74-1": "chair", "74-0": "outdoor", "69-0": "lighting", "69-1": "ceiling", "69-2": "pendant", "100-2": "lounge chair", "100-0": "upholstery", "100-1": "chair", "52-1": "sideboard", "46-2": "", "46-1": "desk", "46-0": "casegood", "49-0": "casegood", "49-1": "headboard", "49-2": "", "99-1": "chair", "99-0": "upholstery", "99-2": "desk chair", "70-2": "", "70-1": "floor", "70-0": "lighting", "55-2": "counter", "55-0": "casegood", "55-1": "stool", "39-0": "casegood", "104-1": "loveseat", "104-0": "upholstery", "104-2": "", "106-2": "", "106-0": "upholstery", "106-1": "ottoman", "53-0": "casegood", "53-1": "stool", "53-2": "", "51-2": "", "51-0": "casegood", "51-1": "nightstand", "8-0": "accessory", "8-1": "easel", "8-2": "", "44-2": "side chair", "44-1": "chair", "75-2": "dining chair", "2-0": "accessory", "2-1": "bookends", "73-0": "lighting", "73-1": "", "73-2": "", "14-2": "", "14-1": "picture frame", "14-0": "accessory", "103-0": "upholstery", "103-1": "chair", "18-2": "", "18-1": "sculpture", "18-0": "accessory", "10-0": "accessory", "10-1": "fire", "10-2": "elements", "77-0": "outdoor", "77-1": "fire pit", "77-2": "", "48-2": "", "47-2": "", "47-0": "casegood", "47-1": "dresser", "75-0": "outdoor", "75-1": "chair", "68-1": "ceiling", "68-0": "lighting", "68-2": "flush mount", "71-2": "", "71-0": "lighting", "71-1": "table", "15-0": "accessory", "15-1": "pillow", "15-2": "", "59-2": "dining", "59-0": "casegood", "5-1": "candleholder", "5-0": "accessory", "5-2": "", "96-2": "", "96-1": "chair", "96-0": "upholstery", "22-1": "throw", "22-0": "accessory", "22-2": "", "11-1": "fire", "11-0": "accessory", "11-2": "indoor", "76-1": "chair", "76-0": "outdoor", "12-0": "accessory", "76-2": "lounge chair", "120-2": "", "120-0": "youth", "120-1": "changing table", "17-2": "", "17-0": "accessory", "17-1": "screen", "16-1": "planter", "16-0": "accessory", "16-2": "", "19-0": "accessory", "19-1": "slipcover", "19-2": "", "72-1": "wall", "72-0": "lighting", "72-2": "", "37-2": "", "37-1": "armoire", "37-0": "casegood", "45-2": "", "45-1": "chest of drawers", "45-0": "casegood", "88-2": "side", "88-1": "table", "88-0": "outdoor", "91-0": "textiles", "91-1": "leather", "91-2": "", "48-1": "etagere", "48-0": "casegood", "112-2": "", "112-0": "upholstery", "112-1": "", "92-2": "", "92-1": "rug", "92-0": "textiles", "95-0": "upholstery", "95-1": "bench", "95-2": "", "97-2": "arm chair", "97-0": "upholstery", "97-1": "chair", "113-1": "armoire", "113-0": "youth", "113-2": "", "116-2": "", "116-0": "youth", "116-1": "chair", "4-0": "accessory", "4-1": "box", "4-2": "", "117-1": "chair", "117-0": "youth", "117-2": "arm chair", "7-2": "", "7-1": "coatrack", "7-0": "accessory", "119-2": "side chair", "119-1": "chair", "119-0": "youth", "89-2": "", "89-0": "outdoor", "89-1": "", "1-1": "bookcase", "1-0": "accessory", "1-2": "", "39-1": "bench", "41-2": "", "41-1": "chair", "41-0": "casegood", "42-0": "casegood", "42-1": "chair", "42-2": "arm chair", "90-1": "fabric", "90-0": "textiles", "44-0": "casegood", "90-2": "", "39-2": "", "111-2": "", "111-1": "upholstered headboard", "111-0": "upholstery", "94-1": "", "94-0": "textiles", "94-2": "", "93-2": "", "93-0": "textiles", "93-1": "wall covering", "114-0": "youth", "114-1": "bed", "114-2": "", "38-0": "casegood", "38-1": "bed", "38-2": "", "36-2": "", "36-0": "casegood", "36-1": "accent chest", "63-2": "", "63-1": "china cabinet", "63-0": "casegood", "118-0": "youth", "118-1": "chair", "118-2": "lounge chair", "115-2": "", "115-1": "bench", "115-0": "youth", "27-1": "wall", "27-0": "accessory", "66-0": "lighting", "66-1": "ceiling", "66-2": "", "43-1": "chair", "43-0": "casegood", "43-2": "desk chair", "40-2": "", "40-0": "casegood", "40-1": "buffet", "79-2": "", "79-1": "sectional", "79-0": "outdoor", "84-0": "outdoor", "84-1": "table", "84-2": "", "52-0": "casegood", "0-0": "accessory", "0-1": "bedding", "0-2": "", "61-1": "table", "61-0": "casegood", "59-1": "table", "61-2": "side", "56-0": "casegood", "56-1": "stool", "56-2": "other", "52-2": "", "2-2": "", "83-2": "counter", "83-1": "stool", "83-0": "outdoor", "67-1": "ceiling", "67-0": "lighting", "67-2": "chandelier", "60-0": "casegood", "60-1": "table", "60-2": "game", "62-2": "sofa", "62-0": "casegood", "62-1": "table", "123-2": "", "123-0": "youth", "123-1": "dresser", "126-1": "sideboard", "126-0": "youth", "126-2": "", "3-2": "", "3-1": "bowl", "3-0": "accessory", "h-0": "Primary Category", "h-1": "Secondary Category", "h-2": "Tertiary Category", "65-0": "casegood", "64-0": "casegood", "64-1": "hutch", "109-0": "upholstery", "109-1": "sofa", "109-2": "sleeper", "105-0": "upholstery", "105-1": "loveseat", "105-2": "sleeper", "102-0": "upholstery", "102-1": "chair", "102-2": "sleeper", "13-0": "accessory", "13-1": "mirror", "21-0": "accessory", "21-1": "tabletop", "20-0": "accessory", "20-1": "storage", "33-0": "bedding", "35-0": "bedding", "33-1": "mattress", "34-0": "bedding", "34-1": "foundation" }, "cols": 3, "rows": 130 } [/block]
Products can be assigned to categories, which will determine what components will be attached to that product. A product can also be left unassigned, in which case only a few default components will be associated with it. [block:parameters] { "data": { "78-2": "", "78-0": "outdoor", "78-1": "loveseat", "80-0": "outdoor", "80-1": "sofa", "80-2": "", "29-2": "clocks", "29-1": "wall", "29-0": "accessory", "127-2": "", "127-0": "youth", "127-1": "table", "25-2": "", "25-1": "umbrella", "25-0": "accessory", "28-0": "accessory", "28-1": "wall", "28-2": "art", "57-1": "table", "57-0": "casegood", "57-2": "", "58-2": "cocktail", "58-0": "casegood", "58-1": "table", "87-2": "dining", "87-1": "table", "87-0": "outdoor", "85-1": "table", "85-0": "outdoor", "85-2": "bistro", "82-2": "bar", "82-0": "outdoor", "82-1": "stool", "24-0": "accessory", "24-1": "trunk", "24-2": "", "108-0": "upholstery", "108-1": "sofa", "108-2": "", "124-2": "", "124-1": "linens", "124-0": "youth", "122-1": "crib", "122-0": "youth", "122-2": "", "6-2": "", "6-0": "accessory", "6-1": "clock", "32-0": "base entity", "32-1": "", "32-2": "", "27-2": "", "30-2": "mirrors", "30-0": "accessory", "30-1": "wall", "125-0": "youth", "125-1": "nightstand", "125-2": "", "128-2": "side table", "128-1": "table", "128-0": "youth", "26-2": "", "26-0": "accessory", "26-1": "vase", "86-2": "cocktail", "86-0": "outdoor", "86-1": "table", "9-1": "fire", "9-0": "accessory", "9-2": "", "23-1": "tray", "23-0": "accessory", "23-2": "", "81-1": "stool", "81-0": "outdoor", "81-2": "", "50-2": "", "50-1": "media", "50-0": "casegood", "101-2": "side chair", "101-1": "chair", "101-0": "upholstery", "54-2": "bar", "54-1": "stool", "54-0": "casegood", "98-0": "upholstery", "98-1": "chair", "98-2": "chaise lounge", "107-2": "", "107-1": "sectional", "107-0": "upholstery", "110-1": "upholstered bed", "110-0": "upholstery", "103-2": "wing chair", "110-2": "", "31-1": "", "31-0": "accessory", "31-2": "", "129-0": "youth", "129-1": "", "129-2": "", "12-2": "", "121-0": "youth", "121-1": "chest drawer", "121-2": "", "12-1": "miscellaneous", "74-2": "", "74-1": "chair", "74-0": "outdoor", "69-0": "lighting", "69-1": "ceiling", "69-2": "pendant", "100-2": "lounge chair", "100-0": "upholstery", "100-1": "chair", "52-1": "sideboard", "46-2": "", "46-1": "desk", "46-0": "casegood", "49-0": "casegood", "49-1": "headboard", "49-2": "", "99-1": "chair", "99-0": "upholstery", "99-2": "desk chair", "70-2": "", "70-1": "floor", "70-0": "lighting", "55-2": "counter", "55-0": "casegood", "55-1": "stool", "39-0": "casegood", "104-1": "loveseat", "104-0": "upholstery", "104-2": "", "106-2": "", "106-0": "upholstery", "106-1": "ottoman", "53-0": "casegood", "53-1": "stool", "53-2": "", "51-2": "", "51-0": "casegood", "51-1": "nightstand", "8-0": "accessory", "8-1": "easel", "8-2": "", "44-2": "side chair", "44-1": "chair", "75-2": "dining chair", "2-0": "accessory", "2-1": "bookends", "73-0": "lighting", "73-1": "", "73-2": "", "14-2": "", "14-1": "picture frame", "14-0": "accessory", "103-0": "upholstery", "103-1": "chair", "18-2": "", "18-1": "sculpture", "18-0": "accessory", "10-0": "accessory", "10-1": "fire", "10-2": "elements", "77-0": "outdoor", "77-1": "fire pit", "77-2": "", "48-2": "", "47-2": "", "47-0": "casegood", "47-1": "dresser", "75-0": "outdoor", "75-1": "chair", "68-1": "ceiling", "68-0": "lighting", "68-2": "flush mount", "71-2": "", "71-0": "lighting", "71-1": "table", "15-0": "accessory", "15-1": "pillow", "15-2": "", "59-2": "dining", "59-0": "casegood", "5-1": "candleholder", "5-0": "accessory", "5-2": "", "96-2": "", "96-1": "chair", "96-0": "upholstery", "22-1": "throw", "22-0": "accessory", "22-2": "", "11-1": "fire", "11-0": "accessory", "11-2": "indoor", "76-1": "chair", "76-0": "outdoor", "12-0": "accessory", "76-2": "lounge chair", "120-2": "", "120-0": "youth", "120-1": "changing table", "17-2": "", "17-0": "accessory", "17-1": "screen", "16-1": "planter", "16-0": "accessory", "16-2": "", "19-0": "accessory", "19-1": "slipcover", "19-2": "", "72-1": "wall", "72-0": "lighting", "72-2": "", "37-2": "", "37-1": "armoire", "37-0": "casegood", "45-2": "", "45-1": "chest of drawers", "45-0": "casegood", "88-2": "side", "88-1": "table", "88-0": "outdoor", "91-0": "textiles", "91-1": "leather", "91-2": "", "48-1": "etagere", "48-0": "casegood", "112-2": "", "112-0": "upholstery", "112-1": "", "92-2": "", "92-1": "rug", "92-0": "textiles", "95-0": "upholstery", "95-1": "bench", "95-2": "", "97-2": "arm chair", "97-0": "upholstery", "97-1": "chair", "113-1": "armoire", "113-0": "youth", "113-2": "", "116-2": "", "116-0": "youth", "116-1": "chair", "4-0": "accessory", "4-1": "box", "4-2": "", "117-1": "chair", "117-0": "youth", "117-2": "arm chair", "7-2": "", "7-1": "coatrack", "7-0": "accessory", "119-2": "side chair", "119-1": "chair", "119-0": "youth", "89-2": "", "89-0": "outdoor", "89-1": "", "1-1": "bookcase", "1-0": "accessory", "1-2": "", "39-1": "bench", "41-2": "", "41-1": "chair", "41-0": "casegood", "42-0": "casegood", "42-1": "chair", "42-2": "arm chair", "90-1": "fabric", "90-0": "textiles", "44-0": "casegood", "90-2": "", "39-2": "", "111-2": "", "111-1": "upholstered headboard", "111-0": "upholstery", "94-1": "", "94-0": "textiles", "94-2": "", "93-2": "", "93-0": "textiles", "93-1": "wall covering", "114-0": "youth", "114-1": "bed", "114-2": "", "38-0": "casegood", "38-1": "bed", "38-2": "", "36-2": "", "36-0": "casegood", "36-1": "accent chest", "63-2": "", "63-1": "china cabinet", "63-0": "casegood", "118-0": "youth", "118-1": "chair", "118-2": "lounge chair", "115-2": "", "115-1": "bench", "115-0": "youth", "27-1": "wall", "27-0": "accessory", "66-0": "lighting", "66-1": "ceiling", "66-2": "", "43-1": "chair", "43-0": "casegood", "43-2": "desk chair", "40-2": "", "40-0": "casegood", "40-1": "buffet", "79-2": "", "79-1": "sectional", "79-0": "outdoor", "84-0": "outdoor", "84-1": "table", "84-2": "", "52-0": "casegood", "0-0": "accessory", "0-1": "bedding", "0-2": "", "61-1": "table", "61-0": "casegood", "59-1": "table", "61-2": "side", "56-0": "casegood", "56-1": "stool", "56-2": "other", "52-2": "", "2-2": "", "83-2": "counter", "83-1": "stool", "83-0": "outdoor", "67-1": "ceiling", "67-0": "lighting", "67-2": "chandelier", "60-0": "casegood", "60-1": "table", "60-2": "game", "62-2": "sofa", "62-0": "casegood", "62-1": "table", "123-2": "", "123-0": "youth", "123-1": "dresser", "126-1": "sideboard", "126-0": "youth", "126-2": "", "3-2": "", "3-1": "bowl", "3-0": "accessory", "h-0": "Primary Category", "h-1": "Secondary Category", "h-2": "Tertiary Category", "65-0": "casegood", "64-0": "casegood", "64-1": "hutch", "109-0": "upholstery", "109-1": "sofa", "109-2": "sleeper", "105-0": "upholstery", "105-1": "loveseat", "105-2": "sleeper", "102-0": "upholstery", "102-1": "chair", "102-2": "sleeper", "13-0": "accessory", "13-1": "mirror", "21-0": "accessory", "21-1": "tabletop", "20-0": "accessory", "20-1": "storage", "33-0": "bedding", "35-0": "bedding", "33-1": "mattress", "34-0": "bedding", "34-1": "foundation" }, "cols": 3, "rows": 130 } [/block]
{"__v":3,"_id":"57323cdd0ef9be17002c71b1","api":{"auth":"required","examples":{"codes":[{"code":"conn.Categories.retrieve()","language":"python"},{"language":"php","code":"$url = 'http://api.amberengine.dev/categories?primary=accessory';\n// filter - only subcategories of 'accessory'\n$curl = new Curl();\n$curl->setHeader('Accept', 'application/hal+json');\n$curl->setHeader('Content-Type', 'application/json');\n\n$curl->setHeader('Authorization', 'Bearer ' . $token);\n$curl->get($url);\nvar_dump($curl->response);"}]},"method":"get","params":[{"_id":"57323efe8b55962900f063b9","ref":"","in":"query","required":false,"desc":"Comma-delimited manufacturer IDs to filter upon","default":"Query Param","type":"string","name":"manufacturers"},{"_id":"57323efe8b55962900f063b8","ref":"","in":"query","required":false,"desc":"Comma-delimited product IDs to filter upon","default":"Query Param","type":"string","name":"products"},{"_id":"57323efe8b55962900f063b7","ref":"","in":"query","required":false,"desc":"Filtering primary category name","default":"Query Param","type":"string","name":"primary"},{"_id":"57323efe8b55962900f063b6","ref":"","in":"query","required":false,"desc":"Filtering secondary category name","default":"Query Param","type":"string","name":"secondary"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"_links\": {\n    \"self\": {\n      \"href\": \"/categories\"\n    }\n  },\n  \"count\": {\n    \"primary_categories\": 7,\n    \"secondary_categories\": 81,\n    \"tertiary_categories\": 111\n  },\n  \"primary\": [\n    \"youth\",\n    \"accessory\",\n    \"casegood\",\n    \"lighting\",\n    \"outdoor\",\n    \"textiles\",\n    \"upholstery\",\n    \"\"\n  ],\n  \"secondary\": [\n    \"youth_armoire\",\n    \"youth_bed\",\n    \"youth_bench\",\n    \"youth_changing_table\",\n    \"youth_dresser\",\n    \"youth_linens\",\n    \"...\",\n    \"upholstery_sofa\",\n    \"\"\n  ],\n  \"tertiary\": [\n    \"youth_table_side_table\",\n    \"youth_chair_arm_chair\",\n    \"youth_chair_lounge_chair\",\n    \"...\",\n    \"upholstery_chair_side_chair\",\n    \"upholstery_chair_wing_chair\",\n    \"\"\n  ],\n  \"total\": 199\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/categories"},"body":"You can view a full list of all the primary, secondary, and tertiary categories possible on the [Available Categories](doc:available-categories) page.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Filtering\"\n}\n[/block]\nYou can filter on the categories returned in multiple ways.\n\n## 1. Filtering by Name\nYou can filter primary, secondary, and tertiary categories by supplying a URI query parameter specifying the desired names to filter on. Filtering is possible on a primary and secondary category names only.\n\n## 2. Filtering by Products\nYou can filter on categories which are in use by products, as specified by a comma-delimited list of product IDs.\n\n## 3. Filtering by Manufacturer (products)\nFinally, it is possible to filter on the categories which are used in conjunction with products belonging to a manufacturer(s). A list of specified manufacturer IDs, comma-delimited, can be used to filtering on which manufacturer's products to pull from.","category":"573232cb1be99f2200a528fe","createdAt":"2016-05-10T19:56:13.696Z","editedParams":true,"editedParams2":true,"excerpt":"List all available primary, secondary, and tertiary categories.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","next":{"description":"","pages":[]},"order":2,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"list-categories","sync_unique":"","title":"List Categories","type":"get","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

getList Categories

List all available primary, secondary, and tertiary categories.

Query Params

manufacturers:
stringQuery Param
Comma-delimited manufacturer IDs to filter upon
products:
stringQuery Param
Comma-delimited product IDs to filter upon
primary:
stringQuery Param
Filtering primary category name
secondary:
stringQuery Param
Filtering secondary category name
You can view a full list of all the primary, secondary, and tertiary categories possible on the [Available Categories](doc:available-categories) page. [block:api-header] { "type": "basic", "title": "Filtering" } [/block] You can filter on the categories returned in multiple ways. ## 1. Filtering by Name You can filter primary, secondary, and tertiary categories by supplying a URI query parameter specifying the desired names to filter on. Filtering is possible on a primary and secondary category names only. ## 2. Filtering by Products You can filter on categories which are in use by products, as specified by a comma-delimited list of product IDs. ## 3. Filtering by Manufacturer (products) Finally, it is possible to filter on the categories which are used in conjunction with products belonging to a manufacturer(s). A list of specified manufacturer IDs, comma-delimited, can be used to filtering on which manufacturer's products to pull from.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



You can view a full list of all the primary, secondary, and tertiary categories possible on the [Available Categories](doc:available-categories) page. [block:api-header] { "type": "basic", "title": "Filtering" } [/block] You can filter on the categories returned in multiple ways. ## 1. Filtering by Name You can filter primary, secondary, and tertiary categories by supplying a URI query parameter specifying the desired names to filter on. Filtering is possible on a primary and secondary category names only. ## 2. Filtering by Products You can filter on categories which are in use by products, as specified by a comma-delimited list of product IDs. ## 3. Filtering by Manufacturer (products) Finally, it is possible to filter on the categories which are used in conjunction with products belonging to a manufacturer(s). A list of specified manufacturer IDs, comma-delimited, can be used to filtering on which manufacturer's products to pull from.
{"__v":7,"_id":"57324462752a1f190012ebb0","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"A Collection is a unit of organization for similar products to be tied together under a single batch. Usually used to group products designed by a particular designer or brand.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"One Collection per Product\",\n  \"body\": \"A product may only belong to a **single** collection.\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier. This is populated by the API when a new API Key is created.\",\n    \"1-0\": \"`manufacturer_id`\\n*Integer*\",\n    \"1-1\": \"Unique identifier for corresponding [Manufacturer Resource](doc:manufacturer-resource).\",\n    \"2-0\": \"`name`\\n*String*\",\n    \"2-1\": \"Name for the Collection.\",\n    \"3-0\": \"`description`\\n*String*\",\n    \"3-1\": \"Briefly describes the entire Collection.\",\n    \"4-0\": \"`designed_by`\\n*String*\",\n    \"4-1\": \"The name of the brand, designer, person, etc., which designed the Collection.\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]","category":"5732444118fca21900f9ca97","createdAt":"2016-05-10T20:28:18.963Z","excerpt":"Explaining the Collection resource","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"collection-resource","sync_unique":"","title":"Collection Resource","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Collection Resource

Explaining the Collection resource

A Collection is a unit of organization for similar products to be tied together under a single batch. Usually used to group products designed by a particular designer or brand. [block:callout] { "type": "warning", "title": "One Collection per Product", "body": "A product may only belong to a **single** collection.", "sidebar": true } [/block] [block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "0-0": "`id`\n*Integer*", "0-1": "Unique resource identifier. This is populated by the API when a new API Key is created.", "1-0": "`manufacturer_id`\n*Integer*", "1-1": "Unique identifier for corresponding [Manufacturer Resource](doc:manufacturer-resource).", "2-0": "`name`\n*String*", "2-1": "Name for the Collection.", "3-0": "`description`\n*String*", "3-1": "Briefly describes the entire Collection.", "4-0": "`designed_by`\n*String*", "4-1": "The name of the brand, designer, person, etc., which designed the Collection." }, "cols": 2, "rows": 5 } [/block]
A Collection is a unit of organization for similar products to be tied together under a single batch. Usually used to group products designed by a particular designer or brand. [block:callout] { "type": "warning", "title": "One Collection per Product", "body": "A product may only belong to a **single** collection.", "sidebar": true } [/block] [block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "0-0": "`id`\n*Integer*", "0-1": "Unique resource identifier. This is populated by the API when a new API Key is created.", "1-0": "`manufacturer_id`\n*Integer*", "1-1": "Unique identifier for corresponding [Manufacturer Resource](doc:manufacturer-resource).", "2-0": "`name`\n*String*", "2-1": "Name for the Collection.", "3-0": "`description`\n*String*", "3-1": "Briefly describes the entire Collection.", "4-0": "`designed_by`\n*String*", "4-1": "The name of the brand, designer, person, etc., which designed the Collection." }, "cols": 2, "rows": 5 } [/block]
{"__v":2,"_id":"573248be8b55962900f063e4","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"# Setup\ncol = conn.Collection\ndata = {\n  \"name\": \"Fall Collection\",\n  \"designed_by\": \"Seasonal Sensations\",\n\t\"description\": \"A collection of beautiful fall-inspired furniture\"\n}\ncol.update(data)\n\n# Create new Collection\ncol.save()"}]},"method":"post","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"_links\": {\n    \"self\": {\n      \"href\": \"collections/551\"\n    }\n  },\n  \"description\": \"A collection of beautiful fall-inspired furniture\",\n  \"designed_by\": \"Seasonal Sensations\",\n  \"id\": 551,\n  \"manufacturer_id\": 413,\n  \"name\": \"Fall Collection\"\n}","name":""}]},"settings":"","url":"/collections"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Result\"\n}\n[/block]\nReturns a populated [Collection Resource](doc:collection-resource) object.","category":"5732444118fca21900f9ca97","createdAt":"2016-05-10T20:46:54.295Z","excerpt":"Create a new Collection of Products","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"create-collection","sync_unique":"","title":"Create Collection","type":"post","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

postCreate Collection

Create a new Collection of Products

[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Returns a populated [Collection Resource](doc:collection-resource) object.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Returns a populated [Collection Resource](doc:collection-resource) object.
{"__v":0,"_id":"5732493f1be99f2200a5294b","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"# Setup\ncol = conn.Collection.retrieve(413)"}]},"method":"get","params":[{"_id":"5732493f1be99f2200a5294c","ref":"","required":false,"desc":"Unique resource identifier","default":"Endpoint Param","type":"string","name":"ID","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"_links\": {\n    \"self\": {\n      \"href\": \"collections/551\"\n    }\n  },\n  \"description\": \"A collection of beautiful fall-inspired furniture\",\n  \"designed_by\": \"Seasonal Sensations\",\n  \"id\": 551,\n  \"manufacturer_id\": 413,\n  \"name\": \"Fall Collection\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/collections/:id"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Result\"\n}\n[/block]\nReturns a populated [Collection Resource](doc:collection-resource) object.","category":"5732444118fca21900f9ca97","createdAt":"2016-05-10T20:49:03.386Z","editedParams":true,"editedParams2":true,"excerpt":"Retrieve a specific Collection","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"retrieve-collection","sync_unique":"","title":"Retrieve Collection","type":"get","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

getRetrieve Collection

Retrieve a specific Collection

Query Params

ID:
stringEndpoint Param
Unique resource identifier
[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Returns a populated [Collection Resource](doc:collection-resource) object.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Returns a populated [Collection Resource](doc:collection-resource) object.
{"__v":0,"_id":"573249a50ef9be17002c71eb","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"# Setup\ncol = conn.Collection.retrieve(412)\ndata = {\n  \"name\": \"Spring Collection\",\n  \"description\": \"A collection of beautiful spring-inspired furniture\"\n}\ncol.update(data)\n\n# Update the existing Collection.\ncol.save()\n"}]},"method":"put","params":[{"_id":"573249a50ef9be17002c71ec","ref":"","required":false,"desc":"Unique resource identifier","default":"Endpoint Param","type":"string","name":"ID","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"_links\": {\n    \"self\": {\n      \"href\": \"collections/551\"\n    }\n  },\n  \"description\": \"A collection of beautiful spring-inspired furniture\",\n  \"designed_by\": \"Seasonal Sensations\",\n  \"id\": 551,\n  \"manufacturer_id\": 413,\n  \"name\": \"Spring Collection\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/collections/:id"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Result\"\n}\n[/block]\nReturns a populated [Collection Resource](doc:collection-resource) object.","category":"5732444118fca21900f9ca97","createdAt":"2016-05-10T20:50:45.094Z","editedParams":true,"editedParams2":true,"excerpt":"Update a Collection","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"update-collection","sync_unique":"","title":"Update Collection","type":"put","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

putUpdate Collection

Update a Collection

Body Params

ID:
stringEndpoint Param
Unique resource identifier
[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Returns a populated [Collection Resource](doc:collection-resource) object.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Returns a populated [Collection Resource](doc:collection-resource) object.
{"__v":0,"_id":"57333de2af2a7419009402ef","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"# Setup\ncol = conn.Collection.retrieve(id)\n\n# Delete the existing Collection\ncol.delete()"}]},"method":"delete","params":[{"_id":"57333de2af2a7419009402f0","ref":"","required":true,"desc":"Unique resource identifier","default":"Endpoint Param","type":"string","name":"ID","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/collections/:id"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Result\"\n}\n[/block]\nNothing is returned on a successful deletion.","category":"5732444118fca21900f9ca97","createdAt":"2016-05-11T14:12:50.101Z","editedParams":true,"editedParams2":true,"excerpt":"Delete an existing collection","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"delete-collection","sync_unique":"","title":"Delete Collection","type":"delete","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

deleteDelete Collection

Delete an existing collection

Body Params

ID:
required
stringEndpoint Param
Unique resource identifier
[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Nothing is returned on a successful deletion.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Nothing is returned on a successful deletion.
{"__v":2,"_id":"57334824b26eb71900f89b84","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"# Setup\ncol = conn.Collection.query()"}]},"method":"get","params":[{"_id":"5734deef4227712b008b8d8b","ref":"","required":false,"desc":"How many results to skip","default":"","type":"int","name":"offset","in":"query"},{"_id":"5734deef4227712b008b8d8a","ref":"","required":false,"desc":"Max results to return (Max: 500)","default":"","type":"int","name":"limit","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n   \"_links\":{\n      \"first\":{\n         \"href\":\"/collections?offset=0\"\n      },\n      \"next\":{\n         \"href\":\"/collections?offset=0\"\n      },\n      \"last\":{\n         \"href\":\"/collections?offset=2\"\n      },\n      \"self\":{\n         \"href\":\"/collections?offset=0&limit=500\"\n      }\n   },\n   \"total\":2,\n   \"_embedded\":{\n      \"collections\":[\n         {\n            \"name\":\"Example 1\",\n            \"_links\":{\n               \"self\":{\n                  \"href\":\"collections/875\"\n               }\n            },\n            \"designed_by\":\"\",\n            \"description\":\"\",\n            \"id\":875,\n            \"manufacturer_id\":66\n         },\n         {\n            \"name\":\"Example 2 \",\n            \"_links\":{\n               \"self\":{\n                  \"href\":\"collections/48\"\n               }\n            },\n            \"designed_by\":\"\",\n            \"description\":\"\",\n            \"id\":48,\n            \"manufacturer_id\":357\n         }\n      ]\n   },\n   \"count\":2\n}","name":""}]},"settings":"","url":"/collections"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Result\"\n}\n[/block]\nReturns a populated [Collection Resource](doc:collection-resource) object.","category":"5732444118fca21900f9ca97","createdAt":"2016-05-11T14:56:36.951Z","editedParams":true,"editedParams2":true,"excerpt":"List all available collections","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"list-collections","sync_unique":"","title":"List Collections","type":"get","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

getList Collections

List all available collections

Query Params

offset:
integer
How many results to skip
limit:
integer
Max results to return (Max: 500)
[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Returns a populated [Collection Resource](doc:collection-resource) object.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Returns a populated [Collection Resource](doc:collection-resource) object.
{"__v":6,"_id":"57333e1545fc0c0e00c154b5","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[Core Components](doc:core-components), [Optional Components](doc:optional-components), and [Child Components](doc:child-components) make up the variety of components which can be associated with a product.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Updating Products vs Updating Components\",\n  \"body\": \"While you can use the following endpoints to work with Component resources, you can also update a product to update its corresponding component data.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Product Association\",\n  \"body\": \"Components must be associated with a product at all times.\"\n}\n[/block]","category":"57333df845fc0c0e00c154b4","createdAt":"2016-05-11T14:13:41.609Z","excerpt":"How Products are constructed from various Components","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"components","sync_unique":"","title":"Components","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Components

How Products are constructed from various Components

[Core Components](doc:core-components), [Optional Components](doc:optional-components), and [Child Components](doc:child-components) make up the variety of components which can be associated with a product. [block:callout] { "type": "info", "title": "Updating Products vs Updating Components", "body": "While you can use the following endpoints to work with Component resources, you can also update a product to update its corresponding component data." } [/block] [block:callout] { "type": "warning", "title": "Product Association", "body": "Components must be associated with a product at all times." } [/block]
[Core Components](doc:core-components), [Optional Components](doc:optional-components), and [Child Components](doc:child-components) make up the variety of components which can be associated with a product. [block:callout] { "type": "info", "title": "Updating Products vs Updating Components", "body": "While you can use the following endpoints to work with Component resources, you can also update a product to update its corresponding component data." } [/block] [block:callout] { "type": "warning", "title": "Product Association", "body": "Components must be associated with a product at all times." } [/block]
{"__v":0,"_id":"5733418ab26eb71900f89b57","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"# Example Setup for Headboard Component\ncomp = conn.components.Headboard\ndata = {\"height\": 12.3, \"width\": 14.00, \"product_id\": 412}\ncomp.update(data)\n\n# Create new Headboard Component\ncomp.save()"}]},"method":"post","params":[{"_id":"5733418ab26eb71900f89b58","ref":"","required":true,"desc":"The official name of the component to create","default":"Endpoint Param","type":"string","name":"Component Name","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/components/:component_name"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Result\"\n}\n[/block]\nReturns a populated corresponding component object.","category":"57333df845fc0c0e00c154b4","createdAt":"2016-05-11T14:28:26.313Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"create-component","sync_unique":"","title":"Create Component","type":"post","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

postCreate Component


Body Params

Component:
required
stringEndpoint Param
The official name of the component to create
[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Returns a populated corresponding component object.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Returns a populated corresponding component object.
{"__v":0,"_id":"57334378af2a74190094030e","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"# Example for Headboard Component\ncomp = conn.components.Headboard.retrieve(1337)"}]},"method":"get","params":[{"_id":"57334378af2a741900940310","ref":"","required":true,"desc":"Name of the component","default":"Endpoint Param","type":"string","name":"Component Name","in":"query"},{"_id":"57334378af2a74190094030f","ref":"","required":true,"desc":"Unique resource identifier","default":"Endpoint Param","type":"string","name":"ID","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/components/:component_name/:id"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Result\"\n}\n[/block]\nReturns a populated corresponding component object.","category":"57333df845fc0c0e00c154b4","createdAt":"2016-05-11T14:36:40.069Z","editedParams":true,"editedParams2":true,"excerpt":"Retrieve a component","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"retrieve-component","sync_unique":"","title":"Retrieve Component","type":"get","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

getRetrieve Component

Retrieve a component

Query Params

Component:
required
stringEndpoint Param
Name of the component
ID:
required
stringEndpoint Param
Unique resource identifier
[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Returns a populated corresponding component object.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Returns a populated corresponding component object.
{"__v":0,"_id":"573343ea5bf1bb0e00e4038f","api":{"auth":"required","examples":{"codes":[{"language":"python","code":""}]},"method":"put","params":[{"_id":"573343ea5bf1bb0e00e40391","ref":"","required":true,"desc":"Name of component type","default":"Endpoint Param","type":"string","name":"Component Name","in":"body"},{"_id":"573343ea5bf1bb0e00e40390","ref":"","required":true,"desc":"Unique resource identifier","default":"Endpoint Param","type":"string","name":"ID","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/components/:component_name/:id"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Result\"\n}\n[/block]\nReturns a populated corresponding component object.","category":"57333df845fc0c0e00c154b4","createdAt":"2016-05-11T14:38:34.748Z","editedParams":true,"editedParams2":true,"excerpt":"Update an existing Component","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"update-component","sync_unique":"","title":"Update Component","type":"put","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

putUpdate Component

Update an existing Component

Body Params

Component:
required
stringEndpoint Param
Name of component type
ID:
required
stringEndpoint Param
Unique resource identifier
[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Returns a populated corresponding component object.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Returns a populated corresponding component object.
{"__v":0,"_id":"5733442ab26eb71900f89b65","api":{"auth":"required","examples":{"codes":[{"language":"python","code":""}]},"method":"delete","params":[{"_id":"5733442ab26eb71900f89b67","ref":"","required":true,"desc":"Name of the component type","default":"Endpoint Param","type":"string","name":"Component Name","in":"body"},{"_id":"5733442ab26eb71900f89b66","ref":"","required":true,"desc":"Unique resource identifier","default":"Endpoint Param","type":"string","name":"ID","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/components/:component_name/:id"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Result\"\n}\n[/block]\nNothing is returned on a successful deletion.","category":"57333df845fc0c0e00c154b4","createdAt":"2016-05-11T14:39:38.736Z","editedParams":true,"editedParams2":true,"excerpt":"Delete an existing component","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"delete-component","sync_unique":"","title":"Delete Component","type":"delete","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

deleteDelete Component

Delete an existing component

Body Params

Component:
required
stringEndpoint Param
Name of the component type
ID:
required
stringEndpoint Param
Unique resource identifier
[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Nothing is returned on a successful deletion.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Nothing is returned on a successful deletion.
{"__v":4,"_id":"57334460b90dba1900b3d905","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"Exports are resources used to represent digital conversions of API data to 3rd-party data formats.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`mapping_id`\\n*Integer*\",\n    \"1-1\": \"ID of desired export mapping\",\n    \"1-2\": \"\",\n    \"2-0\": \"`mapping_name`\\n*String*\",\n    \"2-1\": \"Name of the desired export mapping\",\n    \"2-2\": \"\",\n    \"3-0\": \"`user_email`\\n*String*\",\n    \"3-1\": \"Email to notify when export is complete\",\n    \"3-2\": \"\",\n    \"4-0\": \"`user_manufacturer_id`\\n*Integer*\",\n    \"4-1\": \"Manufacturer ID of the user who initiated the export\",\n    \"4-2\": \"\",\n    \"5-0\": \"`product_ids`\\n*String*\",\n    \"5-1\": \"A delimited string of Product IDs to export\",\n    \"5-2\": \"\",\n    \"6-0\": \"`url`\\n*String*\",\n    \"6-1\": \"URL of the finished export file\",\n    \"6-2\": \"\",\n    \"7-0\": \"`date_created`\\n*String*\",\n    \"7-1\": \"Date-time that the export was initiated\",\n    \"7-2\": \"\",\n    \"8-0\": \"`date_exported`\\n*String*\",\n    \"8-1\": \"Date-time that the export was completed\",\n    \"9-0\": \"`message`\\n*String*\",\n    \"9-1\": \"Error message for failed exports\",\n    \"10-0\": \"`status`\\n*String, Enum*\",\n    \"10-1\": \"String-based ENUM field for the current status of an export\"\n  },\n  \"cols\": 2,\n  \"rows\": 11\n}\n[/block]","category":"57334454b26eb71900f89b6a","createdAt":"2016-05-11T14:40:32.731Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"export-resource","sync_unique":"","title":"Export Resource","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Export Resource


Exports are resources used to represent digital conversions of API data to 3rd-party data formats. [block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`mapping_id`\n*Integer*", "1-1": "ID of desired export mapping", "1-2": "", "2-0": "`mapping_name`\n*String*", "2-1": "Name of the desired export mapping", "2-2": "", "3-0": "`user_email`\n*String*", "3-1": "Email to notify when export is complete", "3-2": "", "4-0": "`user_manufacturer_id`\n*Integer*", "4-1": "Manufacturer ID of the user who initiated the export", "4-2": "", "5-0": "`product_ids`\n*String*", "5-1": "A delimited string of Product IDs to export", "5-2": "", "6-0": "`url`\n*String*", "6-1": "URL of the finished export file", "6-2": "", "7-0": "`date_created`\n*String*", "7-1": "Date-time that the export was initiated", "7-2": "", "8-0": "`date_exported`\n*String*", "8-1": "Date-time that the export was completed", "9-0": "`message`\n*String*", "9-1": "Error message for failed exports", "10-0": "`status`\n*String, Enum*", "10-1": "String-based ENUM field for the current status of an export" }, "cols": 2, "rows": 11 } [/block]
Exports are resources used to represent digital conversions of API data to 3rd-party data formats. [block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`mapping_id`\n*Integer*", "1-1": "ID of desired export mapping", "1-2": "", "2-0": "`mapping_name`\n*String*", "2-1": "Name of the desired export mapping", "2-2": "", "3-0": "`user_email`\n*String*", "3-1": "Email to notify when export is complete", "3-2": "", "4-0": "`user_manufacturer_id`\n*Integer*", "4-1": "Manufacturer ID of the user who initiated the export", "4-2": "", "5-0": "`product_ids`\n*String*", "5-1": "A delimited string of Product IDs to export", "5-2": "", "6-0": "`url`\n*String*", "6-1": "URL of the finished export file", "6-2": "", "7-0": "`date_created`\n*String*", "7-1": "Date-time that the export was initiated", "7-2": "", "8-0": "`date_exported`\n*String*", "8-1": "Date-time that the export was completed", "9-0": "`message`\n*String*", "9-1": "Error message for failed exports", "10-0": "`status`\n*String, Enum*", "10-1": "String-based ENUM field for the current status of an export" }, "cols": 2, "rows": 11 } [/block]
{"__v":2,"_id":"573346fdaf2a741900940321","api":{"auth":"required","examples":{"codes":[{"language":"python","code":""}]},"method":"post","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/exports"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Result\"\n}\n[/block]\nReturns a populated [Export Resource](doc:export-resource) object.","category":"57334454b26eb71900f89b6a","createdAt":"2016-05-11T14:51:41.890Z","excerpt":"Create a new Export","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"create-export","sync_unique":"","title":"Create Export","type":"post","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

postCreate Export

Create a new Export

[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Returns a populated [Export Resource](doc:export-resource) object.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Returns a populated [Export Resource](doc:export-resource) object.
{"__v":0,"_id":"57334752af2a741900940326","api":{"auth":"required","examples":{"codes":[{"language":"text","code":"export = conn.Export.retrieve(id)"}]},"method":"get","params":[{"_id":"57334752af2a741900940327","ref":"","required":true,"desc":"Unique resource identifier","default":"Endpoint Param","type":"string","name":"ID","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/exports/:id"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Result\"\n}\n[/block]\nReturns a populated [Export Resource](doc:export-resource) object.","category":"57334454b26eb71900f89b6a","createdAt":"2016-05-11T14:53:06.216Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"retrieve-export","sync_unique":"","title":"Retrieve Export","type":"get","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

getRetrieve Export


Query Params

ID:
required
stringEndpoint Param
Unique resource identifier
[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Returns a populated [Export Resource](doc:export-resource) object.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Returns a populated [Export Resource](doc:export-resource) object.
{"__v":0,"_id":"573347b945fc0c0e00c154de","api":{"auth":"required","examples":{"codes":[]},"method":"put","params":[{"_id":"573347b945fc0c0e00c154df","ref":"","required":true,"desc":"Unique resource identifier","default":"Endpoint Param","type":"string","name":"ID","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/exports/:id"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Result\"\n}\n[/block]\nReturns a populated [Export Resource](doc:export-resource) object.","category":"57334454b26eb71900f89b6a","createdAt":"2016-05-11T14:54:49.898Z","editedParams":true,"editedParams2":true,"excerpt":"Update an existing Export","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"update-export","sync_unique":"","title":"Update Export","type":"put","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

putUpdate Export

Update an existing Export

Body Params

ID:
required
stringEndpoint Param
Unique resource identifier
[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Returns a populated [Export Resource](doc:export-resource) object.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Return Result" } [/block] Returns a populated [Export Resource](doc:export-resource) object.
{"__v":2,"_id":"573347e25bf1bb0e00e403a9","api":{"auth":"required","examples":{"codes":[{"language":"python","code":""}]},"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/exports"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Result\"\n}\n[/block]","category":"57334454b26eb71900f89b6a","createdAt":"2016-05-11T14:55:30.618Z","excerpt":"List all available exports","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","next":{"description":"","pages":[]},"order":4,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"list-exports","sync_unique":"","title":"List Exports","type":"get","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

getList Exports

List all available exports

[block:api-header] { "type": "basic", "title": "Return Result" } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Return Result" } [/block]
{"__v":1,"_id":"573348dfb90dba1900b3d921","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"Forma Schemas are JSON objects representing how the API resources should be represented via forms.","category":"573348c35bf1bb0e00e403af","createdAt":"2016-05-11T14:59:43.832Z","excerpt":"Form descriptors for API resources","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"form-schema-resource","sync_unique":"","title":"Form Schema Resource","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Form Schema Resource

Form descriptors for API resources

Forma Schemas are JSON objects representing how the API resources should be represented via forms.
Forma Schemas are JSON objects representing how the API resources should be represented via forms.
{"__v":0,"_id":"57334a7f45fc0c0e00c15687","api":{"auth":"required","examples":{"codes":[{"language":"python","code":""}]},"method":"get","params":[{"_id":"57334a7f45fc0c0e00c1568c","ref":"","required":true,"desc":"The name of the resource to retrieve form schema for","default":"Endpoint Param","type":"string","name":"Object","in":"query"},{"_id":"57334a7f45fc0c0e00c1568b","ref":"","required":false,"desc":"Name of the component to retrieve","default":"Query Param","type":"string","name":"Component","in":"query"},{"_id":"57334a7f45fc0c0e00c1568a","ref":"","required":false,"desc":"Name of Primary Category name","default":"Query Param","type":"string","name":"Primary","in":"query"},{"_id":"57334a7f45fc0c0e00c15689","ref":"","required":false,"desc":"Name of Secondary Category name","default":"Query Param","type":"string","name":"Secondary","in":"query"},{"_id":"57334a7f45fc0c0e00c15688","ref":"","required":false,"desc":"Name of Tertiary Category name","default":"Query Param","type":"string","name":"Tertiary","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/form_schemas/:object"},"body":"","category":"573348c35bf1bb0e00e403af","createdAt":"2016-05-11T15:06:39.848Z","editedParams":true,"editedParams2":true,"excerpt":"Retrieve the Form Schema for a resource","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"retrieve-form-schema","sync_unique":"","title":"Retrieve Form Schema","type":"get","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

getRetrieve Form Schema

Retrieve the Form Schema for a resource

Query Params

Object:
required
stringEndpoint Param
The name of the resource to retrieve form schema for
Component:
stringQuery Param
Name of the component to retrieve
Primary:
stringQuery Param
Name of Primary Category name
Secondary:
stringQuery Param
Name of Secondary Category name
Tertiary:
stringQuery Param
Name of Tertiary Category name

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":6,"_id":"57334abfa6a9c40e00e139a9","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"A Manufacturer Resource is an entity representing a furniture/fabric manufacturer.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`name`\\n*String*\",\n    \"1-1\": \"Name of the Manufacturer/Brand\",\n    \"1-2\": \"\",\n    \"2-0\": \"`bio`\\n*String, optional*\",\n    \"2-1\": \"Optional background information about the manufacturer\",\n    \"2-2\": \"\",\n    \"3-0\": \"`url`\\n*String, optional*\",\n    \"3-1\": \"An optional URL to the manufacturer's homepage\",\n    \"3-2\": \"\",\n    \"4-0\": \"`logo_url`\\n*String, optional*\",\n    \"4-1\": \"URL to a hotlinked logo image representing the manufacturer\",\n    \"4-2\": \"\",\n    \"5-0\": \"`date_added`\\n*String*\",\n    \"5-1\": \"Date the manufacturer was added to the AE API\",\n    \"5-2\": \"\",\n    \"6-0\": \"`date_updated`\\n*String*\",\n    \"6-1\": \"Date the manufacturer was last updated to the AE API\",\n    \"6-2\": \"\",\n    \"7-0\": \"`date_profile_complete`\\n*String*\",\n    \"7-1\": \"Date the manufacturer's profile was fully completed\",\n    \"7-2\": \"\",\n    \"8-0\": \"`updated_by_api_key`\\n*Integer*\",\n    \"8-1\": \"API Key ID number for the API Key which last updated the manufacturer\",\n    \"9-0\": \"`active`\\n*Boolean*\",\n    \"9-1\": \"\",\n    \"10-0\": \"`city`\\n*String*\",\n    \"10-1\": \"Name of the city in the manufacturer's shipping address\",\n    \"11-0\": \"`email`\\n*String*\",\n    \"11-1\": \"Contact email\",\n    \"12-0\": \"`facebook_url`\\n*String, optional*\",\n    \"12-1\": \"URL to the manufacturer's Facebook page\",\n    \"13-0\": \"`google_plus_url`\\n*String, optional*\",\n    \"13-1\": \"URL to the manufacturer's Google Plus page\",\n    \"14-0\": \"`legal`\\n*String, optional*\",\n    \"14-1\": \"Legal statement from the manufacturer\",\n    \"15-0\": \"`linkedin_url`\\n*String, optional*\",\n    \"15-1\": \"URL to the manufacturer's LinkedIn page\",\n    \"16-0\": \"`phone`\\n*String*\",\n    \"16-1\": \"Contact phone number\",\n    \"17-0\": \"`phone_extension`\\n*String, optional*\",\n    \"17-1\": \"An optional phone extension number for when contacting the manufacturer\",\n    \"18-0\": \"`pinterest_url`\\n*String, optional*\",\n    \"18-1\": \"URL to the manufacturer's Pinterest page\",\n    \"19-0\": \"`restock_fee`\\n*Float*\",\n    \"19-1\": \"Standard fee charged due to restocking of products\",\n    \"20-0\": \"`return_period`\\n*Integer*\",\n    \"20-1\": \"Number of days allowed for a product to be returned after purchase\",\n    \"21-0\": \"`returnable`\\n*Boolean*\",\n    \"21-1\": \"Indicate whether products from the manufacturer are returnable\",\n    \"22-0\": \"`state`\\n*String, optional*\",\n    \"22-1\": \"Name of the state (if applicable) in the manufacturer's shipping address\",\n    \"23-0\": \"`street_address_1`\\n*String*\",\n    \"23-1\": \"Primary shipping address for the manufacturer\",\n    \"24-0\": \"`street_address_2`\\n*String, optional*\",\n    \"24-1\": \"An optional, secondary shipping address for the manufacturer\",\n    \"25-0\": \"`province`\\n*String, optional*\",\n    \"25-1\": \"Name of the province (if applicable) in the manufacturer's shipping address\",\n    \"26-0\": \"`country`\\n*String*\",\n    \"26-1\": \"Country of the manufacturer's shipping address\",\n    \"27-0\": \"`twitter_url`\\n*String, optional*\",\n    \"27-1\": \"URL to the manufacturer's Twitter page\",\n    \"28-0\": \"`featured`\\n*Boolean*\",\n    \"28-1\": \"\",\n    \"29-0\": \"`internal`\\n*Boolean*\",\n    \"30-0\": \"`zipcode`\\n*string*\",\n    \"30-1\": \"Zip code in manufacturer's shipping address\"\n  },\n  \"cols\": 2,\n  \"rows\": 31\n}\n[/block]","category":"57334aacaf2a741900940348","createdAt":"2016-05-11T15:07:43.333Z","excerpt":"A resource for representing manufacturers","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","next":{"description":"","pages":[]},"order":0,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"manufacturer-resource","sync_unique":"","title":"Manufacturer Resource","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Manufacturer Resource

A resource for representing manufacturers

A Manufacturer Resource is an entity representing a furniture/fabric manufacturer. [block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`name`\n*String*", "1-1": "Name of the Manufacturer/Brand", "1-2": "", "2-0": "`bio`\n*String, optional*", "2-1": "Optional background information about the manufacturer", "2-2": "", "3-0": "`url`\n*String, optional*", "3-1": "An optional URL to the manufacturer's homepage", "3-2": "", "4-0": "`logo_url`\n*String, optional*", "4-1": "URL to a hotlinked logo image representing the manufacturer", "4-2": "", "5-0": "`date_added`\n*String*", "5-1": "Date the manufacturer was added to the AE API", "5-2": "", "6-0": "`date_updated`\n*String*", "6-1": "Date the manufacturer was last updated to the AE API", "6-2": "", "7-0": "`date_profile_complete`\n*String*", "7-1": "Date the manufacturer's profile was fully completed", "7-2": "", "8-0": "`updated_by_api_key`\n*Integer*", "8-1": "API Key ID number for the API Key which last updated the manufacturer", "9-0": "`active`\n*Boolean*", "9-1": "", "10-0": "`city`\n*String*", "10-1": "Name of the city in the manufacturer's shipping address", "11-0": "`email`\n*String*", "11-1": "Contact email", "12-0": "`facebook_url`\n*String, optional*", "12-1": "URL to the manufacturer's Facebook page", "13-0": "`google_plus_url`\n*String, optional*", "13-1": "URL to the manufacturer's Google Plus page", "14-0": "`legal`\n*String, optional*", "14-1": "Legal statement from the manufacturer", "15-0": "`linkedin_url`\n*String, optional*", "15-1": "URL to the manufacturer's LinkedIn page", "16-0": "`phone`\n*String*", "16-1": "Contact phone number", "17-0": "`phone_extension`\n*String, optional*", "17-1": "An optional phone extension number for when contacting the manufacturer", "18-0": "`pinterest_url`\n*String, optional*", "18-1": "URL to the manufacturer's Pinterest page", "19-0": "`restock_fee`\n*Float*", "19-1": "Standard fee charged due to restocking of products", "20-0": "`return_period`\n*Integer*", "20-1": "Number of days allowed for a product to be returned after purchase", "21-0": "`returnable`\n*Boolean*", "21-1": "Indicate whether products from the manufacturer are returnable", "22-0": "`state`\n*String, optional*", "22-1": "Name of the state (if applicable) in the manufacturer's shipping address", "23-0": "`street_address_1`\n*String*", "23-1": "Primary shipping address for the manufacturer", "24-0": "`street_address_2`\n*String, optional*", "24-1": "An optional, secondary shipping address for the manufacturer", "25-0": "`province`\n*String, optional*", "25-1": "Name of the province (if applicable) in the manufacturer's shipping address", "26-0": "`country`\n*String*", "26-1": "Country of the manufacturer's shipping address", "27-0": "`twitter_url`\n*String, optional*", "27-1": "URL to the manufacturer's Twitter page", "28-0": "`featured`\n*Boolean*", "28-1": "", "29-0": "`internal`\n*Boolean*", "30-0": "`zipcode`\n*string*", "30-1": "Zip code in manufacturer's shipping address" }, "cols": 2, "rows": 31 } [/block]
A Manufacturer Resource is an entity representing a furniture/fabric manufacturer. [block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`name`\n*String*", "1-1": "Name of the Manufacturer/Brand", "1-2": "", "2-0": "`bio`\n*String, optional*", "2-1": "Optional background information about the manufacturer", "2-2": "", "3-0": "`url`\n*String, optional*", "3-1": "An optional URL to the manufacturer's homepage", "3-2": "", "4-0": "`logo_url`\n*String, optional*", "4-1": "URL to a hotlinked logo image representing the manufacturer", "4-2": "", "5-0": "`date_added`\n*String*", "5-1": "Date the manufacturer was added to the AE API", "5-2": "", "6-0": "`date_updated`\n*String*", "6-1": "Date the manufacturer was last updated to the AE API", "6-2": "", "7-0": "`date_profile_complete`\n*String*", "7-1": "Date the manufacturer's profile was fully completed", "7-2": "", "8-0": "`updated_by_api_key`\n*Integer*", "8-1": "API Key ID number for the API Key which last updated the manufacturer", "9-0": "`active`\n*Boolean*", "9-1": "", "10-0": "`city`\n*String*", "10-1": "Name of the city in the manufacturer's shipping address", "11-0": "`email`\n*String*", "11-1": "Contact email", "12-0": "`facebook_url`\n*String, optional*", "12-1": "URL to the manufacturer's Facebook page", "13-0": "`google_plus_url`\n*String, optional*", "13-1": "URL to the manufacturer's Google Plus page", "14-0": "`legal`\n*String, optional*", "14-1": "Legal statement from the manufacturer", "15-0": "`linkedin_url`\n*String, optional*", "15-1": "URL to the manufacturer's LinkedIn page", "16-0": "`phone`\n*String*", "16-1": "Contact phone number", "17-0": "`phone_extension`\n*String, optional*", "17-1": "An optional phone extension number for when contacting the manufacturer", "18-0": "`pinterest_url`\n*String, optional*", "18-1": "URL to the manufacturer's Pinterest page", "19-0": "`restock_fee`\n*Float*", "19-1": "Standard fee charged due to restocking of products", "20-0": "`return_period`\n*Integer*", "20-1": "Number of days allowed for a product to be returned after purchase", "21-0": "`returnable`\n*Boolean*", "21-1": "Indicate whether products from the manufacturer are returnable", "22-0": "`state`\n*String, optional*", "22-1": "Name of the state (if applicable) in the manufacturer's shipping address", "23-0": "`street_address_1`\n*String*", "23-1": "Primary shipping address for the manufacturer", "24-0": "`street_address_2`\n*String, optional*", "24-1": "An optional, secondary shipping address for the manufacturer", "25-0": "`province`\n*String, optional*", "25-1": "Name of the province (if applicable) in the manufacturer's shipping address", "26-0": "`country`\n*String*", "26-1": "Country of the manufacturer's shipping address", "27-0": "`twitter_url`\n*String, optional*", "27-1": "URL to the manufacturer's Twitter page", "28-0": "`featured`\n*Boolean*", "28-1": "", "29-0": "`internal`\n*Boolean*", "30-0": "`zipcode`\n*string*", "30-1": "Zip code in manufacturer's shipping address" }, "cols": 2, "rows": 31 } [/block]
{"__v":4,"_id":"57338535d9c7d10e00c69fb8","api":{"auth":"required","examples":{"codes":[{"language":"text","code":"conn = api_con(Context())\nmfr = conn.Manufacturer\ndata = {\n'active': True,\n'name': 'test'\n}\nmfr.update(data)\nmfr.save()"}]},"method":"post","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"province\":null,\n   \"street_address_1\":null,\n   \"updated_by_api_key\":null,\n   \"featured\":null,\n   \"id\":713,\n   \"zipcode\":null,\n   \"facebook_url\":null,\n   \"internal\":true,\n   \"logo_url\":null,\n   \"name\":\"test\",\n   \"phone_extension\":null,\n   \"linkedin_url\":null,\n   \"_links\":{  \n      \"self\":{  \n         \"href\":\"/manufacturers\"\n      }\n   },\n   \"street_address_2\":null,\n   \"email\":null,\n   \"date_added\":\"2016-05-12T21:10:30.286788Z\",\n   \"country\":null,\n   \"date_updated\":\"2016-05-12T21:10:30.286788Z\",\n   \"legal\":null,\n   \"twitter_url\":null,\n   \"active\":true,\n   \"google_plus_url\":null,\n   \"pinterest_url\":null,\n   \"restock_fee\":null,\n   \"bio\":null,\n   \"url\":null,\n   \"phone\":null,\n   \"return_period\":null,\n   \"state\":null,\n   \"returnable\":null,\n   \"city\":null,\n   \"date_profile_complete\":null\n}","name":null}]},"settings":"","url":"/manufacturer"},"body":"","category":"57334aacaf2a741900940348","createdAt":"2016-05-11T19:17:09.619Z","excerpt":"Create a new Manufacturer instance","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"create-manufacturer","sync_unique":"","title":"Create Manufacturer","type":"post","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

postCreate Manufacturer

Create a new Manufacturer instance

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"573385efd9c7d10e00c69fbb","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"mfr = conn.Manufacturer.retrieve(18)"}]},"method":"get","params":[{"_id":"573385efd9c7d10e00c69fbc","ref":"","required":true,"desc":"Unique resource identifier","default":"Endpoint Param","type":"string","name":"ID","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"updated_by_api_key\":\"98waefh23ofas82309090asd7fh32alasdiofuawehskdfhgawef7238\",\n   \"url\":\"\",\n   \"city\":null,\n   \"google_plus_url\":null,\n   \"zipcode\":null,\n   \"state\":null,\n   \"bio\":\"Bio copy.\",\n   \"street_address_1\":null,\n   \"date_profile_complete\":null,\n   \"id\":18,\n   \"date_updated\":\"2014-12-08T14:38:16.723939-05:00\",\n   \"legal\":null,\n   \"restock_fee\":null,\n   \"country\":null,\n   \"_links\":{  \n      \"self\":{  \n         \"href\":\"/manufacturers/18\"\n      }\n   },\n   \"email\":null,\n   \"active\":true,\n   \"date_added\":\"2015-10-05T18:07:57.539019-04:00\",\n   \"street_address_2\":null,\n   \"facebook_url\":null,\n   \"internal\":false,\n   \"returnable\":false,\n   \"phone\":null,\n   \"twitter_url\":null,\n   \"logo_url\":\"\",\n   \"return_period\":null,\n   \"pinterest_url\":null,\n   \"name\":\"Test Company\",\n   \"linkedin_url\":null,\n   \"province\":null,\n   \"featured\":null,\n   \"phone_extension\":null\n}","name":""}]},"settings":"","url":"/manufacturers/:id"},"body":"","category":"57334aacaf2a741900940348","createdAt":"2016-05-11T19:20:15.558Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"retrieve-manufacturer","sync_unique":"","title":"Retrieve Manufacturer","type":"get","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

getRetrieve Manufacturer


Query Params

ID:
required
stringEndpoint Param
Unique resource identifier

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"57338668b5442e0e009a0172","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"mfr = conn.Manufacturer.retrieve(300)\ndata = {\n  'street_address_1': 'test'\n}\nmfr.update(data)\nmfr.save()"}]},"method":"put","params":[{"_id":"57338668b5442e0e009a0173","ref":"","required":true,"desc":"Unique resource identifier","default":"Endpoint Param","type":"string","name":"ID","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"date_updated\":   \"2016-05-13T15:33:30.929936   Z\",\n   \"featured\":null,\n  \"updated_by_api_key\":\"8abebf3699d76c1707cc192a1627a100888b873e567c85765c0ce52d51129523\",\n   \"id\":300,\n   \"city\":null,\n   \"zipcode\":null,\n   \"legal\":null,\n   \"google_plus_url\":null,\n   \"state\":null,\n   \"internal\":false,\n   \"_links\":{  \n      \"self\":{  \n         \"href\":\"/manufacturers/300\"\n      }\n   },\n   \"logo_url\":\"https://website.net/image.jpg\",\n   \"email\":null,\n   \"province\":null,\n   \"bio\":\"Bio\",\n   \"twitter_url\":null,\n   \"date_profile_complete\":null,\n   \"facebook_url\":null,\n   \"street_address_1\":\"test\",\n   \"phone_extension\":null,\n   \"restock_fee\":null,\n   \"phone\":null,\n   \"returnable\":false,\n   \"active\":true,\n   \"date_added\":\"2014-10-05T06:07:57.539019-04:00\",\n   \"return_period\":null,\n   \"street_address_2\":null,\n   \"pinterest_url\":null,\n   \"name\":\"Company\",\n   \"url\":\"http://company.com/\",\n   \"country\":null,\n   \"linkedin_url\":null\n}","name":""}]},"settings":"","url":"/manufacturers/:id"},"body":"","category":"57334aacaf2a741900940348","createdAt":"2016-05-11T19:22:16.308Z","editedParams":true,"editedParams2":true,"excerpt":"Update an existing Manufacturer","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"update-manufacturer","sync_unique":"","title":"Update Manufacturer","type":"put","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

putUpdate Manufacturer

Update an existing Manufacturer

Body Params

ID:
required
stringEndpoint Param
Unique resource identifier

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"5733869f19a71a0e0020a678","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"mfr = conn.Manufacturer.retrieve(22)\nmfr.delete()"}]},"method":"delete","params":[{"_id":"5733869f19a71a0e0020a679","ref":"","required":true,"desc":"Unique resource identifier","default":"Endpoint Param","type":"string","name":"ID","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/manufacturers/:id"},"body":"","category":"57334aacaf2a741900940348","createdAt":"2016-05-11T19:23:11.329Z","editedParams":true,"editedParams2":true,"excerpt":"Delete an existing manufacturer","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"delete-manufacturer","sync_unique":"","title":"Delete Manufacturer","type":"delete","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

deleteDelete Manufacturer

Delete an existing manufacturer

Body Params

ID:
required
stringEndpoint Param
Unique resource identifier

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":2,"_id":"573386c21487170e0019bba8","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"mfr = conn.Manufacturer.retrieve()"}]},"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"count\":2,\n   \"_links\":{  \n      \"self\":{  \n         \"href\":\"/manufacturers\"\n      }\n   },\n   \"total\":2,\n   \"_embedded\":{  \n      \"manufacturers\":[  \n         {  \n            \"date_updated\":\"2016-05-13T11:33:30.929936-04:00\",\n               \"featured\":null,\n   \"updated_by_api_key\":\"o8waefhwaohfsdahsai2iofjo2jfsdofijlieajfaoiwf8\",\n            \"id\":18,\n            \"city\":null,\n            \"zipcode\":null,\n            \"legal\":null,\n            \"google_plus_url\":null,\n            \"state\":null,\n            \"internal\":false,\n            \"_links\":{  \n               \"self\":{  \n                  \"href\":\"/manufacturers/18\"\n               }\n            },\n            \"logo_url\":\"\",\n            \"email\":null,\n            \"province\":null,\n            \"bio\":\"bio\",\n            \"twitter_url\":null,\n            \"date_profile_complete\":null,\n            \"facebook_url\":null,\n            \"street_address_1\":\"test\",\n            \"phone_extension\":null,\n            \"restock_fee\":null,\n            \"phone\":null,\n            \"returnable\":false,\n            \"active\":true,\n            \"date_added\":\"2014-10-05T06:07:57.539019-04:00\",\n                  \"return_period\":null,\n            \"street_address_2\":null,\n            \"pinterest_url\":null,\n            \"name\":\"Company\",\n            \"url\":\"http://company.com/\",\n            \"country\":null,\n            \"linkedin_url\":null\n         },\n         {  \n            \"date_updated\":\"2014-12-15T09:32:35.479843-05:00\",\n            \"featured\":null,\n            \"updated_by_api_key\":\"98234y98sfy99273rfsdshkfwow976329469238\",\n            \"id\":980,\n            \"city\":null,\n            \"zipcode\":null,\n            \"legal\":null,\n            \"google_plus_url\":null,\n            \"state\":null,\n            \"internal\":false,\n            \"_links\":{  \n               \"self\":{  \n                  \"href\":\"/manufacturers/980\"\n               }\n            },\n            \"logo_url\":\"https://website.com/s/logo.png\",\n            \"email\":null,\n            \"province\":null,\n            \"bio\":\"bio\",\n            \"twitter_url\":null,\n            \"date_profile_complete\":null,\n            \"facebook_url\":null,\n            \"street_address_1\":null,\n            \"phone_extension\":null,\n            \"restock_fee\":null,\n            \"phone\":null,\n            \"returnable\":false,\n            \"active\":true,\n            \"date_added\":\"2014-10-05T06:07:57.539019-04:00\",\n            \"return_period\":null,\n            \"street_address_2\":null,\n            \"pinterest_url\":null,\n            \"name\":\"Company Name\",\n            \"url\":\"http://www.website.com/\",\n            \"country\":null,\n            \"linkedin_url\":null\n         }\n      ]\n   }\n}","name":""}]},"settings":"","url":"/manufacturers"},"body":"","category":"57334aacaf2a741900940348","createdAt":"2016-05-11T19:23:46.349Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"list-manufacturers","sync_unique":"","title":"List Manufacturers","type":"get","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

getList Manufacturers


Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"573386e9b85b130e00661a97","api":{"auth":"required","examples":{"codes":[{"language":"python","code":""}]},"method":"post","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/manufacturers/search"},"body":"","category":"57334aacaf2a741900940348","createdAt":"2016-05-11T19:24:25.659Z","excerpt":"Search for manufacturers","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":6,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"search-manufacturers","sync_unique":"","title":"Search Manufacturers","type":"post","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

postSearch Manufacturers

Search for manufacturers

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":3,"_id":"573387a2b85b130e00661a9b","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"Manufacturer Images are images used by a manufacturer to represent their branding.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`manufacturer_id`\\n*Integer*\",\n    \"1-1\": \"Manufacturer ID of the user who initiated the export\",\n    \"1-2\": \"\",\n    \"2-0\": \"`default`\\n*Boolean*\",\n    \"2-1\": \"Indicate if the current image is used as the default image for the manufacturer.\\n\\n*Only one image can be the default image*\",\n    \"2-2\": \"\",\n    \"3-0\": \"`caption`\\n*String, optional*\",\n    \"3-1\": \"A caption for describing the current image\",\n    \"3-2\": \"\",\n    \"4-0\": \"`url`\\n*String*\",\n    \"4-1\": \"URL to the image resource\",\n    \"4-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]","category":"57338799b85b130e00661a9a","createdAt":"2016-05-11T19:27:30.797Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","next":{"description":"","pages":[]},"order":0,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"manufacturer-image-resource","sync_unique":"","title":"Manufacturer Image Resource","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Manufacturer Image Resource


Manufacturer Images are images used by a manufacturer to represent their branding. [block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`manufacturer_id`\n*Integer*", "1-1": "Manufacturer ID of the user who initiated the export", "1-2": "", "2-0": "`default`\n*Boolean*", "2-1": "Indicate if the current image is used as the default image for the manufacturer.\n\n*Only one image can be the default image*", "2-2": "", "3-0": "`caption`\n*String, optional*", "3-1": "A caption for describing the current image", "3-2": "", "4-0": "`url`\n*String*", "4-1": "URL to the image resource", "4-2": "" }, "cols": 2, "rows": 5 } [/block]
Manufacturer Images are images used by a manufacturer to represent their branding. [block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`manufacturer_id`\n*Integer*", "1-1": "Manufacturer ID of the user who initiated the export", "1-2": "", "2-0": "`default`\n*Boolean*", "2-1": "Indicate if the current image is used as the default image for the manufacturer.\n\n*Only one image can be the default image*", "2-2": "", "3-0": "`caption`\n*String, optional*", "3-1": "A caption for describing the current image", "3-2": "", "4-0": "`url`\n*String*", "4-1": "URL to the image resource", "4-2": "" }, "cols": 2, "rows": 5 } [/block]
{"__v":3,"_id":"57338c9c1487170e0019bbbe","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"mfrImg = conn.ManufacturerImage\ndata = {\n  'url': 'http://www.website.com/image.jpg',\n  'manufacturer_id': 706\n}\nmfrImg.update(data)\nmfrImg.save()"}]},"method":"post","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"default\":null,\n   \"caption\":null,\n   \"_links\":{  \n      \"self\":{  \n         \"href\":\"/manufacturer_images\"\n      }\n   },\n   \"url\":\"http://www.website.com/image.jpg\",\n   \"manufacturer_id\":8794,\n   \"id\":208\n}","name":""}]},"settings":"","url":"/manufacturer_images"},"body":"","category":"57338799b85b130e00661a9a","createdAt":"2016-05-11T19:48:44.572Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"create-manufacturer-image","sync_unique":"","title":"Create Manufacturer Image","type":"post","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

postCreate Manufacturer Image


Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"57338d31adebd50e0057209f","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"mfrImg = conn.ManufacturerImage.retrieve(842)"}]},"method":"get","params":[{"_id":"57338d31adebd50e005720a0","ref":"","required":true,"desc":"Unique resource identifier","default":"Endpoint Param","type":"int","name":"ID","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"default\":null,\n   \"caption\":null,\n   \"_links\":{  \n      \"self\":{  \n         \"href\":\"/manufacturer_images/842\"\n      }\n   },\n   \"url\":\"http://www.website.com/image.jpg\",\n   \"manufacturer_id\":8452,\n   \"id\":842\n}","name":""}]},"settings":"","url":"/manufacturer_image/:id"},"body":"","category":"57338799b85b130e00661a9a","createdAt":"2016-05-11T19:51:13.060Z","editedParams":true,"editedParams2":true,"excerpt":"Retrieve an existing Manufacturer Image","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"retrieve-manufacturer-image","sync_unique":"","title":"Retrieve Manufacturer Image","type":"get","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

getRetrieve Manufacturer Image

Retrieve an existing Manufacturer Image

Query Params

ID:
required
integerEndpoint Param
Unique resource identifier

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"57338d08b85b130e00661aac","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"mfrImg = conn.ManufacturerImage.retrieve(107)\ndata = {\n  'url': 'http://www.new-website.com/image.jpg',\n}\nmfrImg.update(data)\nmfrImg.save()"}]},"method":"put","params":[{"_id":"57338d08b85b130e00661aad","ref":"","required":true,"desc":"Unique resource identifier","default":"Endpoint Param","type":"int","name":"ID","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"default\":null,\n   \"caption\":null,\n   \"_links\":{  \n      \"self\":{  \n         \"href\":\"/manufacturer_images/200\"\n      }\n   },\n   \"url\":\"http://www.new-website.com/image.jpg\",\n   \"manufacturer_id\":8423,\n   \"id\":200\n}","name":""}]},"settings":"","url":"/manufacturer_images/:id"},"body":"","category":"57338799b85b130e00661a9a","createdAt":"2016-05-11T19:50:32.729Z","editedParams":true,"editedParams2":true,"excerpt":"Update an existing Manufacturer Image resource","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"update-manufacturer-image","sync_unique":"","title":"Update Manufacturer Image","type":"put","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

putUpdate Manufacturer Image

Update an existing Manufacturer Image resource

Body Params

ID:
required
integerEndpoint Param
Unique resource identifier

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"57338f6cd9c7d10e00c69fd9","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"mfrImg = conn.ManufacturerImage.retrieve(387)\nmfrImg.remove()"}]},"method":"delete","params":[{"_id":"57338f6cd9c7d10e00c69fda","ref":"","required":true,"desc":"Unique resource identifier","default":"Endpoint Params","type":"int","name":"ID","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/manufacturer_images/:id"},"body":"","category":"57338799b85b130e00661a9a","createdAt":"2016-05-11T20:00:44.117Z","editedParams":true,"editedParams2":true,"excerpt":"Delete an existing manufacturer image","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"delete-manufacturer-image","sync_unique":"","title":"Delete Manufacturer Image","type":"delete","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

deleteDelete Manufacturer Image

Delete an existing manufacturer image

Body Params

ID:
required
integerEndpoint Params
Unique resource identifier

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":2,"_id":"5733938ad9c7d10e00c69fe7","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"mfrImg = conn.ManufacturerImage.retrieve()"}]},"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"count\":2,\n   \"_links\":{  \n      \"self\":{  \n         \"href\":\"/manufacturer_images\"\n      }\n   },\n   \"total\":2,\n   \"_embedded\":{  \n      \"manufacturer_images\":[  \n         {  \n            \"default\":true,\n            \"caption\":\"\",\n            \"_links\":{  \n               \"self\":{  \n                  \"href\":\"/manufacturer_images/8\"\n               }\n            },\n            \"url\":\"http://amazon.com/images/image2.jpeg\",\n            \"manufacturer_id\":253,\n            \"id\":8\n         },\n         {  \n            \"default\":false,\n            \"caption\":\"\",\n            \"_links\":{  \n               \"self\":{  \n                  \"href\":\"/manufacturer_images/18\"\n               }\n            },\n            \"url\":\"http://amazon.com/image.jpeg\",\n            \"manufacturer_id\":250,\n            \"id\":18\n         }\n      ]\n   }\n}","name":""}]},"settings":"","url":"/manufacturer_images"},"body":"","category":"57338799b85b130e00661a9a","createdAt":"2016-05-11T20:18:18.812Z","excerpt":"List all available manufacturer images","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"list-manufacturer-images","sync_unique":"","title":"List Manufacturer Images","type":"get","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

getList Manufacturer Images

List all available manufacturer images

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":4,"_id":"57339628d9c7d10e00c69fef","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"Moments are Events, just named badly. Don't ask why.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`option_set_id`\\n*Integer*\",\n    \"1-1\": \"ID for the [Option Set](doc:getting-started-1) the Option belongs to\",\n    \"1-2\": \"\",\n    \"2-0\": \"`name`\\n*String*\",\n    \"2-1\": \"Name of the Option\",\n    \"2-2\": \"\",\n    \"3-0\": \"`number`\\n*String*\",\n    \"3-1\": \"Number for representing the Option\",\n    \"3-2\": \"\",\n    \"4-0\": \"`description`\\n*String*\",\n    \"4-1\": \"Describes the Option in detail\",\n    \"4-2\": \"\",\n    \"5-0\": \"`image`\\n*String*\",\n    \"5-1\": \"URL to a hosted image\",\n    \"6-0\": \"`surcharge`\\n*Integer*\",\n    \"6-1\": \"Additional charge (in cents) for the option\",\n    \"7-0\": \"`kind`\\n*String*\",\n    \"7-1\": \"The type that the option is\",\n    \"8-0\": \"`extended_data`\\n*Object*\",\n    \"8-1\": \"An embedded option which stored type-specific data.\"\n  },\n  \"cols\": 2,\n  \"rows\": 9\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Surcharge\",\n  \"body\": \"Surcharge is in the form of USD cents\"\n}\n[/block]","category":"57339610d9c7d10e00c69fee","createdAt":"2016-05-11T20:29:28.956Z","excerpt":"What are options","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"option-resource","sync_unique":"","title":"Option Resource","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Option Resource

What are options

Moments are Events, just named badly. Don't ask why. [block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`option_set_id`\n*Integer*", "1-1": "ID for the [Option Set](doc:getting-started-1) the Option belongs to", "1-2": "", "2-0": "`name`\n*String*", "2-1": "Name of the Option", "2-2": "", "3-0": "`number`\n*String*", "3-1": "Number for representing the Option", "3-2": "", "4-0": "`description`\n*String*", "4-1": "Describes the Option in detail", "4-2": "", "5-0": "`image`\n*String*", "5-1": "URL to a hosted image", "6-0": "`surcharge`\n*Integer*", "6-1": "Additional charge (in cents) for the option", "7-0": "`kind`\n*String*", "7-1": "The type that the option is", "8-0": "`extended_data`\n*Object*", "8-1": "An embedded option which stored type-specific data." }, "cols": 2, "rows": 9 } [/block] [block:callout] { "type": "warning", "title": "Surcharge", "body": "Surcharge is in the form of USD cents" } [/block]
Moments are Events, just named badly. Don't ask why. [block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`option_set_id`\n*Integer*", "1-1": "ID for the [Option Set](doc:getting-started-1) the Option belongs to", "1-2": "", "2-0": "`name`\n*String*", "2-1": "Name of the Option", "2-2": "", "3-0": "`number`\n*String*", "3-1": "Number for representing the Option", "3-2": "", "4-0": "`description`\n*String*", "4-1": "Describes the Option in detail", "4-2": "", "5-0": "`image`\n*String*", "5-1": "URL to a hosted image", "6-0": "`surcharge`\n*Integer*", "6-1": "Additional charge (in cents) for the option", "7-0": "`kind`\n*String*", "7-1": "The type that the option is", "8-0": "`extended_data`\n*Object*", "8-1": "An embedded option which stored type-specific data." }, "cols": 2, "rows": 9 } [/block] [block:callout] { "type": "warning", "title": "Surcharge", "body": "Surcharge is in the form of USD cents" } [/block]
{"__v":1,"_id":"573398a0b85b130e00661acd","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"body":"","category":"57339610d9c7d10e00c69fee","createdAt":"2016-05-11T20:40:00.077Z","excerpt":"A listing of the available Option Types","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","next":{"description":"","pages":[]},"order":1,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"option-types","sync_unique":"","title":"Option Types","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Option Types

A listing of the available Option Types

{"__v":3,"_id":"573398ec1487170e0019bbdb","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"option = conn.Option\ndata = {\n  'description': 'this is a test option',\n  'name': 'test option',\n  'number': 1,\n  'option_set_id': 129,\n  'kind': 'leather',\n  'extended_data': {},\n}\noption.update(data)\noption.save()"}]},"method":"post","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"kind\":\"leather\",\n   \"extended_data\":{  \n      \"flammability\":null,\n      \"finish\":null,\n      \"option_id\":92,\n      \"leather_type\":null,\n      \"pattern_number\":null,\n      \"hide_size\":null,\n      \"performance\":null,\n      \"id\":3,\n      \"cleaning_instructions\":null,\n      \"average_thickness\":null\n   },\n   \"description\":\"this is a test option\",\n   \"default\":null,\n   \"image\":null,\n   \"number\":\"1\",\n   \"option_set_id\":129,\n   \"_links\":{  \n      \"self\":{  \n         \"href\":\"/options\"\n      }\n   },\n   \"surcharge\":null,\n   \"id\":92,\n   \"name\":\"test option\"\n}","name":""}]},"settings":"","url":"/options"},"body":"","category":"57339610d9c7d10e00c69fee","createdAt":"2016-05-11T20:41:16.941Z","excerpt":"Create a new Option","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"create-option","sync_unique":"","title":"Create Option","type":"post","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

postCreate Option

Create a new Option

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"573399171487170e0019bbde","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"option = conn.Option.retrieve(92)"}]},"method":"get","params":[{"_id":"573399171487170e0019bbdf","ref":"","required":true,"desc":"Unique resource identifier","default":"Endpoint Param","type":"int","name":"ID","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"kind\":\"leather\",\n   \"extended_data\":{  \n      \"flammability\":null,\n      \"finish\":null,\n      \"option_id\":92,\n      \"leather_type\":null,\n      \"pattern_number\":null,\n      \"hide_size\":null,\n      \"performance\":null,\n      \"id\":3,\n      \"cleaning_instructions\":null,\n      \"average_thickness\":null\n   },\n   \"description\":\"this is a test option\",\n   \"default\":null,\n   \"image\":null,\n   \"number\":\"1\",\n   \"option_set_id\":129,\n   \"_links\":{  \n      \"self\":{  \n         \"href\":\"/options/92\"\n      }\n   },\n   \"surcharge\":null,\n   \"id\":92,\n   \"name\":\"test option\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/options/:id"},"body":"","category":"57339610d9c7d10e00c69fee","createdAt":"2016-05-11T20:41:59.600Z","editedParams":true,"editedParams2":true,"excerpt":"Retrieve an existing Option","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"retrieve-option","sync_unique":"","title":"Retrieve Option","type":"get","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

getRetrieve Option

Retrieve an existing Option

Query Params

ID:
required
integerEndpoint Param
Unique resource identifier

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"5733993c19a71a0e0020a6f0","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"option = conn.Option.retrieve(92)\ndata = {\n  'image': 'http://whatever.com/image.png'\n}\noption.update(data)\noption.save()"}]},"method":"put","params":[{"_id":"5733993c19a71a0e0020a6f1","ref":"","required":true,"desc":"Unique resource identifier","default":"Endpoint Param","type":"int","name":"ID","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"kind\":\"leather\",\n   \"extended_data\":{  \n      \"flammability\":null,\n      \"finish\":null,\n      \"option_id\":92,\n      \"leather_type\":null,\n      \"pattern_number\":null,\n      \"hide_size\":null,\n      \"performance\":null,\n      \"id\":3,\n      \"cleaning_instructions\":null,\n      \"average_thickness\":null\n   },\n   \"description\":\"this is a test option\",\n   \"default\":null,\n   \"image\":\"http://whatever.com/image.png\",\n   \"number\":\"1\",\n   \"option_set_id\":129,\n   \"_links\":{  \n      \"self\":{  \n         \"href\":\"/options/92\"\n      }\n   },\n   \"surcharge\":null,\n   \"id\":92,\n   \"name\":\"test option\"\n}","name":""}]},"settings":"","url":"/options/:id"},"body":"","category":"57339610d9c7d10e00c69fee","createdAt":"2016-05-11T20:42:36.951Z","editedParams":true,"editedParams2":true,"excerpt":"Update an existing Option","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"update-option","sync_unique":"","title":"Update Option","type":"put","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

putUpdate Option

Update an existing Option

Body Params

ID:
required
integerEndpoint Param
Unique resource identifier

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"573399661487170e0019bbe1","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"option = conn.Option.retrieve(92)\noption.remove()"}]},"method":"delete","params":[{"_id":"573399661487170e0019bbe2","ref":"","required":true,"desc":"Unique resource identifier","default":"Endpoint Param","type":"int","name":"ID","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/options/:id"},"body":"","category":"57339610d9c7d10e00c69fee","createdAt":"2016-05-11T20:43:18.083Z","editedParams":true,"editedParams2":true,"excerpt":"Delete an existing Option","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"delete-option","sync_unique":"","title":"Delete Option","type":"delete","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

deleteDelete Option

Delete an existing Option

Body Params

ID:
required
integerEndpoint Param
Unique resource identifier

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":1,"_id":"57339a5019a71a0e0020a6fb","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"Option Sets are collections of Options.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`manufacturer_id`\\n*Integer*\",\n    \"1-1\": \"ID of the [Manufacturer Resource](doc:manufacturer-resource) which created the Option Set\",\n    \"1-2\": \"\",\n    \"2-0\": \"`name`\\n*String*\",\n    \"2-1\": \"Name of the Option Set\",\n    \"2-2\": \"\",\n    \"3-0\": \"`kind`\\n*String*\",\n    \"3-1\": \"The type that the option is\",\n    \"3-2\": \"\",\n    \"4-0\": \"`option_list`\\n*Object*\",\n    \"4-1\": \"An array of [Option Resources](doc:option-resource) that are associated with the current Option Set.\",\n    \"4-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]","category":"573399bfb85b130e00661ad4","createdAt":"2016-05-11T20:47:12.835Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"option-set-resource","sync_unique":"","title":"Option Set Resource","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Option Set Resource


Option Sets are collections of Options. [block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`manufacturer_id`\n*Integer*", "1-1": "ID of the [Manufacturer Resource](doc:manufacturer-resource) which created the Option Set", "1-2": "", "2-0": "`name`\n*String*", "2-1": "Name of the Option Set", "2-2": "", "3-0": "`kind`\n*String*", "3-1": "The type that the option is", "3-2": "", "4-0": "`option_list`\n*Object*", "4-1": "An array of [Option Resources](doc:option-resource) that are associated with the current Option Set.", "4-2": "" }, "cols": 2, "rows": 5 } [/block]
Option Sets are collections of Options. [block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`manufacturer_id`\n*Integer*", "1-1": "ID of the [Manufacturer Resource](doc:manufacturer-resource) which created the Option Set", "1-2": "", "2-0": "`name`\n*String*", "2-1": "Name of the Option Set", "2-2": "", "3-0": "`kind`\n*String*", "3-1": "The type that the option is", "3-2": "", "4-0": "`option_list`\n*Object*", "4-1": "An array of [Option Resources](doc:option-resource) that are associated with the current Option Set.", "4-2": "" }, "cols": 2, "rows": 5 } [/block]
{"__v":3,"_id":"57339aa5d9c7d10e00c69ffb","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"optionSet = conn.OptionSet\ndata = {\n  'name': 'test option set',\n  'kind': 'Finish',\n  'manufacturer_id': 875\n}\noptionSet.update(data)\noptionSet.save()"}]},"method":"post","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"kind\":\"Finish\",\n   \"name\":\"test option set\",\n   \"option_list\":[],\n   \"_links\":{  \n      \"self\":{  \n         \"href\":\"/option_sets\"\n      }\n   },\n   \"manufacturer_id\":875,\n   \"id\":129\n}","name":""}]},"settings":"","url":"/option_sets"},"body":"","category":"573399bfb85b130e00661ad4","createdAt":"2016-05-11T20:48:37.621Z","excerpt":"Create a new Option Set","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"create-option-set","sync_unique":"","title":"Create Option Set","type":"post","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

postCreate Option Set

Create a new Option Set

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"57339acb19a71a0e0020a6fd","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"optionSet = conn.OptionSet.retrieve(129)"}]},"method":"get","params":[{"_id":"57339acb19a71a0e0020a6fe","ref":"","required":true,"desc":"Unique resource identifier","default":"Endpoint Param","type":"int","name":"ID","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"kind\":\"Finish\",\n   \"name\":\"test option set\",\n   \"option_list\":[],\n   \"_links\":{  \n      \"self\":{  \n         \"href\":\"/option_sets\"\n      }\n   },\n   \"manufacturer_id\":875,\n   \"id\":129\n}","name":""}]},"settings":"","url":"/option_sets/:id"},"body":"","category":"573399bfb85b130e00661ad4","createdAt":"2016-05-11T20:49:15.227Z","editedParams":true,"editedParams2":true,"excerpt":"Retrieve an existing Option Set","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"retrieve-option-set","sync_unique":"","title":"Retrieve Option Set","type":"get","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

getRetrieve Option Set

Retrieve an existing Option Set

Query Params

ID:
required
integerEndpoint Param
Unique resource identifier

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"57339beeadebd50e005720bf","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"optionSet = conn.OptionSet.retrieve(129)\ndata = {\n  'kind': 'leather'\n}\noptionSet.update(data)\noptionSet.save()"}]},"method":"put","params":[{"_id":"57339beeadebd50e005720c0","ref":"","required":true,"desc":"Unique resource identifier","default":"Endpoint Param","type":"int","name":"ID","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"kind\":\"leather\",\n   \"name\":\"test option set\",\n   \"option_list\":[],\n   \"_links\":{  \n      \"self\":{  \n         \"href\":\"/option_sets\"\n      }\n   },\n   \"manufacturer_id\":875,\n   \"id\":129\n}","name":""}]},"settings":"","url":"/option_sets/:id"},"body":"","category":"573399bfb85b130e00661ad4","createdAt":"2016-05-11T20:54:06.726Z","editedParams":true,"editedParams2":true,"excerpt":"Update an existing Option Set","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"update-option-set","sync_unique":"","title":"Update Option Set","type":"put","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

putUpdate Option Set

Update an existing Option Set

Body Params

ID:
required
integerEndpoint Param
Unique resource identifier

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"57339c5719a71a0e0020a704","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"optionSet = conn.OptionSet.retrieve(129)\noptionSet.remove()"}]},"method":"delete","params":[{"_id":"57339c5719a71a0e0020a705","ref":"","required":true,"desc":"Unique resource identifier","default":"Endpoint Param","type":"int","name":"ID","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/option_sets/:id"},"body":"","category":"573399bfb85b130e00661ad4","createdAt":"2016-05-11T20:55:51.168Z","editedParams":true,"editedParams2":true,"excerpt":"Delete an existing Option Set","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"delete-option-set","sync_unique":"","title":"Delete Option Set","type":"delete","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

deleteDelete Option Set

Delete an existing Option Set

Body Params

ID:
required
integerEndpoint Param
Unique resource identifier

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":3,"_id":"57339e741487170e0019bbf3","api":{"auth":"required","examples":{"codes":[{"language":"python","code":"optionSet = conn.OptionSet.retrieve()"}]},"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"count\":1,\n   \"_links\":{  \n      \"self\":{  \n         \"href\":\"/option_sets\"\n      },\n      \"next\":{  \n         \"href\":\"/option_sets?offset=0\"\n      },\n      \"last\":{  \n         \"href\":\"/option_sets?offset=1\"\n      },\n      \"first\":{  \n         \"href\":\"/option_sets?offset=0\"\n      }\n   },\n   \"total\":1,\n   \"_embedded\":{  \n      \"option_sets\":[  \n         {  \n            \"kind\":\"leather\",\n            \"name\":\"test option set\",\n            \"option_list\":[],\n            \"_links\":{  \n               \"self\":{  \n                  \"href\":\"/option_sets/129\"\n               }\n            },\n            \"manufacturer_id\":875,\n            \"id\":129\n         }\n      ]\n   }\n}","name":""}]},"settings":"","url":"/option_sets"},"body":"","category":"573399bfb85b130e00661ad4","createdAt":"2016-05-11T21:04:52.006Z","excerpt":"List all available Option Sets","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"list-option-sets","sync_unique":"","title":"List Option Sets","type":"get","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

getList Option Sets

List all available Option Sets

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":3,"_id":"57339e9d1487170e0019bbf5","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"Products are entities that represent products.\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Update Required\",\n  \"body\": \"If you are an AE API developer, please update this page.\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`assemblage_id`\\n*Integer*\",\n    \"1-1\": \"\",\n    \"1-2\": \"\",\n    \"2-0\": \"`assemblage*\\n*Object*\",\n    \"2-1\": \"\",\n    \"2-2\": \"\",\n    \"3-0\": \"`components`\\n*Object*\",\n    \"3-1\": \"\",\n    \"3-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","category":"57339e90b85b130e00661ae7","createdAt":"2016-05-11T21:05:33.089Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","next":{"description":"","pages":[]},"order":0,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"product-resource","sync_unique":"","title":"Product Resource","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Product Resource


Products are entities that represent products. [block:callout] { "type": "danger", "title": "Update Required", "body": "If you are an AE API developer, please update this page." } [/block] [block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`assemblage_id`\n*Integer*", "1-1": "", "1-2": "", "2-0": "`assemblage*\n*Object*", "2-1": "", "2-2": "", "3-0": "`components`\n*Object*", "3-1": "", "3-2": "" }, "cols": 2, "rows": 4 } [/block]
Products are entities that represent products. [block:callout] { "type": "danger", "title": "Update Required", "body": "If you are an AE API developer, please update this page." } [/block] [block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`assemblage_id`\n*Integer*", "1-1": "", "1-2": "", "2-0": "`assemblage*\n*Object*", "2-1": "", "2-2": "", "3-0": "`components`\n*Object*", "3-1": "", "3-2": "" }, "cols": 2, "rows": 4 } [/block]
{"__v":0,"_id":"5733a026adebd50e005720c9","api":{"auth":"required","examples":{"codes":[{"language":"python","code":""}]},"method":"post","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/products"},"body":"","category":"57339e90b85b130e00661ae7","createdAt":"2016-05-11T21:12:06.566Z","excerpt":"Create a new product","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"create-product","sync_unique":"","title":"Create Product","type":"post","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

postCreate Product

Create a new product

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"5733a049d9c7d10e00c6a01e","api":{"auth":"required","examples":{"codes":[{"language":"python","code":""}]},"method":"get","params":[{"_id":"5733a049d9c7d10e00c6a01f","ref":"","required":true,"desc":"Unique resource identifier","default":"Endpoint Param","type":"int","name":"ID","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/products/:id"},"body":"","category":"57339e90b85b130e00661ae7","createdAt":"2016-05-11T21:12:41.262Z","editedParams":true,"editedParams2":true,"excerpt":"Retrieve an existing product","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"retrieve-product","sync_unique":"","title":"Retrieve Product","type":"get","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

getRetrieve Product

Retrieve an existing product

Query Params

ID:
required
integerEndpoint Param
Unique resource identifier

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"5733a079b5442e0e009a01b1","api":{"auth":"required","examples":{"codes":[{"language":"python","code":""}]},"method":"put","params":[{"_id":"5733a079b5442e0e009a01b2","ref":"","required":true,"desc":"Unique resource identifier","default":"Endpoint Param","type":"int","name":"ID","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/products/:id"},"body":"","category":"57339e90b85b130e00661ae7","createdAt":"2016-05-11T21:13:29.067Z","editedParams":true,"editedParams2":true,"excerpt":"Update an existing Product","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"update-product","sync_unique":"","title":"Update Product","type":"put","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

putUpdate Product

Update an existing Product

Body Params

ID:
required
integerEndpoint Param
Unique resource identifier

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"5733a0a2d9c7d10e00c6a021","api":{"auth":"required","examples":{"codes":[{"language":"python","code":""}]},"method":"delete","params":[{"_id":"5733a0a2d9c7d10e00c6a022","ref":"","required":true,"desc":"Unique resource identifier","default":"Endpoint Param","type":"int","name":"ID","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/products/:id"},"body":"","category":"57339e90b85b130e00661ae7","createdAt":"2016-05-11T21:14:10.971Z","editedParams":true,"editedParams2":true,"excerpt":"Delete an existing Product","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"delete-product","sync_unique":"","title":"Delete Product","type":"delete","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

deleteDelete Product

Delete an existing Product

Body Params

ID:
required
integerEndpoint Param
Unique resource identifier

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"5733a0cb1487170e0019bbf8","api":{"auth":"required","examples":{"codes":[{"language":"python","code":""}]},"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/products"},"body":"","category":"57339e90b85b130e00661ae7","createdAt":"2016-05-11T21:14:51.889Z","excerpt":"List all available products","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"list-products","sync_unique":"","title":"List Products","type":"get","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

getList Products

List all available products

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"5733a1251487170e0019bbfa","api":{"auth":"required","examples":{"codes":[{"language":"python","code":""}]},"method":"post","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/product_search"},"body":"","category":"57339e90b85b130e00661ae7","createdAt":"2016-05-11T21:16:21.890Z","excerpt":"Search for Products","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":6,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"search-products","sync_unique":"","title":"Search Products","type":"post","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

postSearch Products

Search for Products

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"5733a180b85b130e00661af3","api":{"auth":"required","examples":{"codes":[{"language":"python","code":""}]},"method":"delete","params":[{"_id":"5733a180b85b130e00661af4","ref":"","required":true,"desc":"A comma-delimited list of integer Product ID numbers","default":"Query Param","type":"string","name":"product_ids","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/products"},"body":"","category":"57339e90b85b130e00661ae7","createdAt":"2016-05-11T21:17:52.436Z","editedParams":true,"editedParams2":true,"excerpt":"Delete multiple Products","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":7,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"delete-products","sync_unique":"","title":"Delete Products","type":"delete","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

deleteDelete Products

Delete multiple Products

Body Params

product_ids:
required
stringQuery Param
A comma-delimited list of integer Product ID numbers

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"5733a308b5442e0e009a01b9","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"body":"","category":"5733a1a3b5442e0e009a01b5","createdAt":"2016-05-11T21:24:24.334Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"product-relation-resource","sync_unique":"","title":"Product Relation Resource","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Product Relation Resource


{"__v":0,"_id":"5733a292d9c7d10e00c6a025","api":{"auth":"required","examples":{"codes":[{"language":"python","code":""}]},"method":"post","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/relations"},"body":"","category":"5733a1a3b5442e0e009a01b5","createdAt":"2016-05-11T21:22:26.773Z","excerpt":"Create a new product relation","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"create-product-relation","sync_unique":"","title":"Create Product Relation","type":"post","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

postCreate Product Relation

Create a new product relation

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":1,"_id":"5733a2afd9c7d10e00c6a027","api":{"auth":"required","examples":{"codes":[{"language":"python","code":""}]},"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/relations"},"body":"","category":"5733a1a3b5442e0e009a01b5","createdAt":"2016-05-11T21:22:55.220Z","excerpt":"Retrieve an existing Product Relation","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"retrieve-relation","sync_unique":"","title":"Retrieve Product Relation","type":"get","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

getRetrieve Product Relation

Retrieve an existing Product Relation

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"5733a2d619a71a0e0020a718","api":{"auth":"required","examples":{"codes":[{"language":"python","code":""}]},"method":"put","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/relations"},"body":"","category":"5733a1a3b5442e0e009a01b5","createdAt":"2016-05-11T21:23:34.496Z","excerpt":"Update an existing Product Relation","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"update-product-relation","sync_unique":"","title":"Update Product Relation","type":"put","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

putUpdate Product Relation

Update an existing Product Relation

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"5733a2f3adebd50e005720d0","api":{"auth":"required","examples":{"codes":[{"language":"python","code":""}]},"method":"delete","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/relations"},"body":"","category":"5733a1a3b5442e0e009a01b5","createdAt":"2016-05-11T21:24:03.400Z","excerpt":"Delete an existing Product Relation","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"delete-product-relation","sync_unique":"","title":"Delete Product Relation","type":"delete","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

deleteDelete Product Relation

Delete an existing Product Relation

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":1,"_id":"5733a3e61487170e0019bc00","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"A Manufacturer Resource is an entity representing a furniture/fabric manufacturer.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"2-0\": \"`name`\\n*String*\",\n    \"2-1\": \"Name of the Manufacturer/Brand\",\n    \"2-2\": \"\",\n    \"3-0\": \"`bio`\\n*String, optional*\",\n    \"3-1\": \"Optional background information about the manufacturer\",\n    \"3-2\": \"\",\n    \"4-0\": \"`url`\\n*String, optional*\",\n    \"4-1\": \"An optional URL to the manufacturer's homepage\",\n    \"4-2\": \"\",\n    \"5-0\": \"`logo_url`\\n*String, optional*\",\n    \"5-1\": \"URL to a hotlinked logo image representing the manufacturer\",\n    \"5-2\": \"\",\n    \"6-0\": \"`city`\\n*String*\",\n    \"6-1\": \"Name of the city the manufacturer's shipping address\",\n    \"7-0\": \"`email`\\n*String*\",\n    \"7-1\": \"Contact email\",\n    \"8-0\": \"`facebook_url`\\n*String, optional*\",\n    \"8-1\": \"URL to the manufacturer's Facebook page\",\n    \"9-0\": \"`google_plus_url`\\n*String, optional*\",\n    \"9-1\": \"URL to the manufacturer's Google Plus page\",\n    \"10-0\": \"`legal`\\n*String, optional*\",\n    \"10-1\": \"Legal statement from the manufacturer\",\n    \"11-0\": \"`linkedIn_url`\\n*String, optional*\",\n    \"11-1\": \"URL to the manufacturer's LinkedIn page\",\n    \"12-0\": \"`phone`\\n*String*\",\n    \"12-1\": \"Contact phone number\",\n    \"13-0\": \"`extension`\\n*String, optional*\",\n    \"13-1\": \"An optional phone extension number for when contacting the manufacturer\",\n    \"14-0\": \"`pinterest_url`\\n*String, optional*\",\n    \"14-1\": \"URL to the manufacturer's Pinterest page\",\n    \"15-0\": \"`state`\\n*String, optional*\",\n    \"15-1\": \"Name of the state (if applicable) the manufacturer's shipping address\",\n    \"16-0\": \"`street_address_1`\\n*String*\",\n    \"16-1\": \"Primary shipping address for the manufacturer\",\n    \"17-0\": \"`street_address_2`\\n*String, optional*\",\n    \"17-1\": \"An optional, secondary shipping address for the manufacturer\",\n    \"18-0\": \"`country`\\n*String*\",\n    \"18-1\": \"Country of the manufacturer's shipping address\",\n    \"19-0\": \"`twitter_url`\\n*String, optional*\",\n    \"19-1\": \"URL to the manufacturer's Twitter page\",\n    \"20-0\": \"`setting_image`\\n*Boolean*\",\n    \"20-1\": \"\",\n    \"21-0\": \"`isolated Image`\\n*Boolean*\",\n    \"1-0\": \"`api_key_id`\\n*Integer*\",\n    \"1-1\": \"API Key ID number for the API Key which last updated the manufacturer\",\n    \"22-0\": \"`other_image`\\n*Boolean*\",\n    \"23-0\": \"`visible`\\n*Boolean*\"\n  },\n  \"cols\": 2,\n  \"rows\": 24\n}\n[/block]","category":"5733a327b5442e0e009a01bb","createdAt":"2016-05-11T21:28:06.409Z","excerpt":"What are Sales Channels?","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"sales-channel-resource","sync_unique":"","title":"Sales Channel Resource","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Sales Channel Resource

What are Sales Channels?

A Manufacturer Resource is an entity representing a furniture/fabric manufacturer. [block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "2-0": "`name`\n*String*", "2-1": "Name of the Manufacturer/Brand", "2-2": "", "3-0": "`bio`\n*String, optional*", "3-1": "Optional background information about the manufacturer", "3-2": "", "4-0": "`url`\n*String, optional*", "4-1": "An optional URL to the manufacturer's homepage", "4-2": "", "5-0": "`logo_url`\n*String, optional*", "5-1": "URL to a hotlinked logo image representing the manufacturer", "5-2": "", "6-0": "`city`\n*String*", "6-1": "Name of the city the manufacturer's shipping address", "7-0": "`email`\n*String*", "7-1": "Contact email", "8-0": "`facebook_url`\n*String, optional*", "8-1": "URL to the manufacturer's Facebook page", "9-0": "`google_plus_url`\n*String, optional*", "9-1": "URL to the manufacturer's Google Plus page", "10-0": "`legal`\n*String, optional*", "10-1": "Legal statement from the manufacturer", "11-0": "`linkedIn_url`\n*String, optional*", "11-1": "URL to the manufacturer's LinkedIn page", "12-0": "`phone`\n*String*", "12-1": "Contact phone number", "13-0": "`extension`\n*String, optional*", "13-1": "An optional phone extension number for when contacting the manufacturer", "14-0": "`pinterest_url`\n*String, optional*", "14-1": "URL to the manufacturer's Pinterest page", "15-0": "`state`\n*String, optional*", "15-1": "Name of the state (if applicable) the manufacturer's shipping address", "16-0": "`street_address_1`\n*String*", "16-1": "Primary shipping address for the manufacturer", "17-0": "`street_address_2`\n*String, optional*", "17-1": "An optional, secondary shipping address for the manufacturer", "18-0": "`country`\n*String*", "18-1": "Country of the manufacturer's shipping address", "19-0": "`twitter_url`\n*String, optional*", "19-1": "URL to the manufacturer's Twitter page", "20-0": "`setting_image`\n*Boolean*", "20-1": "", "21-0": "`isolated Image`\n*Boolean*", "1-0": "`api_key_id`\n*Integer*", "1-1": "API Key ID number for the API Key which last updated the manufacturer", "22-0": "`other_image`\n*Boolean*", "23-0": "`visible`\n*Boolean*" }, "cols": 2, "rows": 24 } [/block]
A Manufacturer Resource is an entity representing a furniture/fabric manufacturer. [block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "2-0": "`name`\n*String*", "2-1": "Name of the Manufacturer/Brand", "2-2": "", "3-0": "`bio`\n*String, optional*", "3-1": "Optional background information about the manufacturer", "3-2": "", "4-0": "`url`\n*String, optional*", "4-1": "An optional URL to the manufacturer's homepage", "4-2": "", "5-0": "`logo_url`\n*String, optional*", "5-1": "URL to a hotlinked logo image representing the manufacturer", "5-2": "", "6-0": "`city`\n*String*", "6-1": "Name of the city the manufacturer's shipping address", "7-0": "`email`\n*String*", "7-1": "Contact email", "8-0": "`facebook_url`\n*String, optional*", "8-1": "URL to the manufacturer's Facebook page", "9-0": "`google_plus_url`\n*String, optional*", "9-1": "URL to the manufacturer's Google Plus page", "10-0": "`legal`\n*String, optional*", "10-1": "Legal statement from the manufacturer", "11-0": "`linkedIn_url`\n*String, optional*", "11-1": "URL to the manufacturer's LinkedIn page", "12-0": "`phone`\n*String*", "12-1": "Contact phone number", "13-0": "`extension`\n*String, optional*", "13-1": "An optional phone extension number for when contacting the manufacturer", "14-0": "`pinterest_url`\n*String, optional*", "14-1": "URL to the manufacturer's Pinterest page", "15-0": "`state`\n*String, optional*", "15-1": "Name of the state (if applicable) the manufacturer's shipping address", "16-0": "`street_address_1`\n*String*", "16-1": "Primary shipping address for the manufacturer", "17-0": "`street_address_2`\n*String, optional*", "17-1": "An optional, secondary shipping address for the manufacturer", "18-0": "`country`\n*String*", "18-1": "Country of the manufacturer's shipping address", "19-0": "`twitter_url`\n*String, optional*", "19-1": "URL to the manufacturer's Twitter page", "20-0": "`setting_image`\n*Boolean*", "20-1": "", "21-0": "`isolated Image`\n*Boolean*", "1-0": "`api_key_id`\n*Integer*", "1-1": "API Key ID number for the API Key which last updated the manufacturer", "22-0": "`other_image`\n*Boolean*", "23-0": "`visible`\n*Boolean*" }, "cols": 2, "rows": 24 } [/block]
{"__v":1,"_id":"5733a513d9c7d10e00c6a02a","api":{"auth":"required","examples":{"codes":[{"language":"python","code":""}]},"method":"post","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/sales_channels"},"body":"","category":"5733a327b5442e0e009a01bb","createdAt":"2016-05-11T21:33:07.114Z","excerpt":"Create a new Sales Channel","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"create-sales-channel","sync_unique":"","title":"Create Sales Channel","type":"post","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

postCreate Sales Channel

Create a new Sales Channel

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"5733a54019a71a0e0020a71f","api":{"auth":"required","examples":{"codes":[{"language":"python","code":""}]},"method":"get","params":[{"_id":"5733a54019a71a0e0020a720","ref":"","required":true,"desc":"Unique resource identifier","default":"Endpoint Param","type":"int","name":"ID","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/sales_channels/:id"},"body":"","category":"5733a327b5442e0e009a01bb","createdAt":"2016-05-11T21:33:52.402Z","editedParams":true,"editedParams2":true,"excerpt":"Retrieve an existing Sales Channel","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"retrieve-sales-channel","sync_unique":"","title":"Retrieve Sales Channel","type":"get","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

getRetrieve Sales Channel

Retrieve an existing Sales Channel

Query Params

ID:
required
integerEndpoint Param
Unique resource identifier

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"5733a5791487170e0019bc03","api":{"auth":"required","examples":{"codes":[{"language":"python","code":""}]},"method":"put","params":[{"_id":"5733a5791487170e0019bc04","ref":"","required":true,"desc":"Unique resource identifier","default":"Endpoint Param","type":"int","name":"ID","in":"body"}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/sales_channels/:id"},"body":"","category":"5733a327b5442e0e009a01bb","createdAt":"2016-05-11T21:34:49.978Z","editedParams":true,"editedParams2":true,"excerpt":"Update an existing Sales Channel","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"update-sales-channel","sync_unique":"","title":"Update Sales Channel","type":"put","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

putUpdate Sales Channel

Update an existing Sales Channel

Body Params

ID:
required
integerEndpoint Param
Unique resource identifier

Definition

{{ api_url }}{{ page_api_url }}


{"__v":0,"_id":"5733a5b01487170e0019bc05","api":{"auth":"required","examples":{"codes":[{"language":"python","code":""}]},"method":"delete","params":[{"_id":"5733a5b01487170e0019bc06","ref":"","required":true,"desc":"Unique resource identifier","default":"Endpoint Param","type":"int","name":"ID","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/sales_channels/:id"},"body":"","category":"5733a327b5442e0e009a01bb","createdAt":"2016-05-11T21:35:44.349Z","editedParams":true,"editedParams2":true,"excerpt":"Delete an existing Sales Channel","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"delete-sales-channel","sync_unique":"","title":"Delete Sales Channel","type":"delete","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

deleteDelete Sales Channel

Delete an existing Sales Channel

Body Params

ID:
required
integerEndpoint Param
Unique resource identifier

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"5733a5ed19a71a0e0020a724","api":{"auth":"required","examples":{"codes":[{"language":"python","code":""}]},"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/sales_channels"},"body":"","category":"5733a327b5442e0e009a01bb","createdAt":"2016-05-11T21:36:45.343Z","excerpt":"List all available Sales Channels","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"list-sales-channels","sync_unique":"","title":"List Sales Channels","type":"get","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

getList Sales Channels

List all available Sales Channels

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":3,"_id":"5733a6571487170e0019bc09","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`public`\\n*String*\",\n    \"0-1\": \"Public token string\",\n    \"0-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]","category":"5733a6061487170e0019bc07","createdAt":"2016-05-11T21:38:31.791Z","excerpt":"Access tokens are a required parameter for API operations.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","next":{"description":"","pages":[]},"order":0,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"token-resource","sync_unique":"","title":"Token Resource","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Token Resource

Access tokens are a required parameter for API operations.

[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`public`\n*String*", "0-1": "Public token string", "0-2": "" }, "cols": 2, "rows": 1 } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`public`\n*String*", "0-1": "Public token string", "0-2": "" }, "cols": 2, "rows": 1 } [/block]
{"__v":0,"_id":"5733a688b5442e0e009a01c3","api":{"auth":"required","examples":{"codes":[{"language":"python","code":""}]},"method":"post","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/tokens"},"body":"","category":"5733a6061487170e0019bc07","createdAt":"2016-05-11T21:39:20.559Z","excerpt":"Create a new token","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"create-token","sync_unique":"","title":"Create Token","type":"post","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

postCreate Token

Create a new token

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"5733a70e19a71a0e0020a729","api":{"auth":"required","examples":{"codes":[{"language":"python","code":""}]},"method":"delete","params":[{"_id":"5733a70e19a71a0e0020a72a","ref":"","required":true,"desc":"Unique token public string","default":"Endpoint","type":"string","name":"ID","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/tokens/:id"},"body":"","category":"5733a6061487170e0019bc07","createdAt":"2016-05-11T21:41:34.092Z","editedParams":true,"editedParams2":true,"excerpt":"Delete an existing token","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"delete-token","sync_unique":"","title":"Delete Token","type":"delete","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

deleteDelete Token

Delete an existing token

Body Params

ID:
required
stringEndpoint
Unique token public string

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"5735ecc04577c320008f2d28","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent nec massa tristique arcu ferme.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"1. First Step\"\n}\n[/block]\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent nec massa tristique arcu fermentum dapibus. Integer orci turpis, mollis vel augue eget, placerat rhoncus orci. Mauris metus libero, rutrum eu ornare ut, molestie vel nunc. Morbi sed iaculis metus.","category":"5735e3a085ab0e29002e76d5","createdAt":"2016-05-13T15:03:28.534Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"core-components","sync_unique":"","title":"Core Components","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Core Components


Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent nec massa tristique arcu ferme. [block:api-header] { "type": "basic", "title": "1. First Step" } [/block] Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent nec massa tristique arcu fermentum dapibus. Integer orci turpis, mollis vel augue eget, placerat rhoncus orci. Mauris metus libero, rutrum eu ornare ut, molestie vel nunc. Morbi sed iaculis metus.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent nec massa tristique arcu ferme. [block:api-header] { "type": "basic", "title": "1. First Step" } [/block] Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent nec massa tristique arcu fermentum dapibus. Integer orci turpis, mollis vel augue eget, placerat rhoncus orci. Mauris metus libero, rutrum eu ornare ut, molestie vel nunc. Morbi sed iaculis metus.
{"__v":0,"_id":"57363862cacfa619004f6d01","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent nec massa tristique arcu ferme.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"1. First Step\"\n}\n[/block]\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent nec massa tristique arcu fermentum dapibus. Integer orci turpis, mollis vel augue eget, placerat rhoncus orci. Mauris metus libero, rutrum eu ornare ut, molestie vel nunc. Morbi sed iaculis metus.","category":"5735e3a085ab0e29002e76d5","createdAt":"2016-05-13T20:26:10.891Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"optional-components","sync_unique":"","title":"Optional Components","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Optional Components


Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent nec massa tristique arcu ferme. [block:api-header] { "type": "basic", "title": "1. First Step" } [/block] Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent nec massa tristique arcu fermentum dapibus. Integer orci turpis, mollis vel augue eget, placerat rhoncus orci. Mauris metus libero, rutrum eu ornare ut, molestie vel nunc. Morbi sed iaculis metus.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent nec massa tristique arcu ferme. [block:api-header] { "type": "basic", "title": "1. First Step" } [/block] Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent nec massa tristique arcu fermentum dapibus. Integer orci turpis, mollis vel augue eget, placerat rhoncus orci. Mauris metus libero, rutrum eu ornare ut, molestie vel nunc. Morbi sed iaculis metus.
{"__v":0,"_id":"57363898be10a92000307308","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent nec massa tristique arcu ferme.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"1. First Step\"\n}\n[/block]\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent nec massa tristique arcu fermentum dapibus. Integer orci turpis, mollis vel augue eget, placerat rhoncus orci. Mauris metus libero, rutrum eu ornare ut, molestie vel nunc. Morbi sed iaculis metus.","category":"5735e3a085ab0e29002e76d5","createdAt":"2016-05-13T20:27:04.458Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"child-components","sync_unique":"","title":"Child Components","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Child Components


Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent nec massa tristique arcu ferme. [block:api-header] { "type": "basic", "title": "1. First Step" } [/block] Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent nec massa tristique arcu fermentum dapibus. Integer orci turpis, mollis vel augue eget, placerat rhoncus orci. Mauris metus libero, rutrum eu ornare ut, molestie vel nunc. Morbi sed iaculis metus.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent nec massa tristique arcu ferme. [block:api-header] { "type": "basic", "title": "1. First Step" } [/block] Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent nec massa tristique arcu fermentum dapibus. Integer orci turpis, mollis vel augue eget, placerat rhoncus orci. Mauris metus libero, rutrum eu ornare ut, molestie vel nunc. Morbi sed iaculis metus.
{"__v":6,"_id":"5735e3c085ab0e29002e76d6","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id `\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`date_added`\\n*String*\",\n    \"4-1\": \"Date-time that the component's associated product was created.\",\n    \"4-2\": \"\",\n    \"5-0\": \"`date_updated`\\n*String*\",\n    \"5-1\": \"Date-time that the component's associated product was last updated.\",\n    \"5-2\": \"\",\n    \"6-0\": \"`updated_by_api_key`\\n*String*\",\n    \"6-1\": \"Public-key of the API client which last updated the component's associated product.\",\n    \"6-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 7\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"date_added\\\": \\\"01032016T0213.00+3:00\\\",\\n  \\\"date_updated\\\": \\\"02042016T1342+3:00\\\",\\n  \\\"updated_by_api_key\\\": \\\"f8Fmk3MOl872m1Lfa3H813fajno9NOIUY889OH9hOHhohiu87v4YD46h9\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef284e3f892b00767ede","createdAt":"2016-05-13T14:25:04.043Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"audit-component","sync_unique":"","title":"Audit Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Audit Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`date_added`\n*String*", "4-1": "Date-time that the component's associated product was created.", "4-2": "", "5-0": "`date_updated`\n*String*", "5-1": "Date-time that the component's associated product was last updated.", "5-2": "", "6-0": "`updated_by_api_key`\n*String*", "6-1": "Public-key of the API client which last updated the component's associated product.", "6-2": "" }, "cols": 2, "rows": 7 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"date_added\": \"01032016T0213.00+3:00\",\n \"date_updated\": \"02042016T1342+3:00\",\n \"updated_by_api_key\": \"f8Fmk3MOl872m1Lfa3H813fajno9NOIUY889OH9hOHhohiu87v4YD46h9\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`date_added`\n*String*", "4-1": "Date-time that the component's associated product was created.", "4-2": "", "5-0": "`date_updated`\n*String*", "5-1": "Date-time that the component's associated product was last updated.", "5-2": "", "6-0": "`updated_by_api_key`\n*String*", "6-1": "Public-key of the API client which last updated the component's associated product.", "6-2": "" }, "cols": 2, "rows": 7 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"date_added\": \"01032016T0213.00+3:00\",\n \"date_updated\": \"02042016T1342+3:00\",\n \"updated_by_api_key\": \"f8Fmk3MOl872m1Lfa3H813fajno9NOIUY889OH9hOHhohiu87v4YD46h9\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":5,"_id":"5735e6b96806490e0044e346","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id `\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`primary`\\n*String, optional*\",\n    \"4-1\": \"Primary category the component's associated product resides within\",\n    \"4-2\": \"\",\n    \"5-0\": \"`secondary`\\n*String, optional*\",\n    \"5-1\": \"Secondary category the component's associated product resides within\",\n    \"5-2\": \"\",\n    \"6-0\": \"`tertiary`\\n*String, optional*\",\n    \"6-1\": \"Tertiary category the component's associated product resides within\",\n    \"6-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 7\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"primary\\\": \\\"casegood\\\",\\n  \\\"secondary\\\": \\\"casegood_table\\\",\\n  \\\"tertiary\\\": \\\"casegood_table_dining\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef284e3f892b00767ede","createdAt":"2016-05-13T14:37:45.088Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"category-component","sync_unique":"","title":"Category Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Category Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`primary`\n*String, optional*", "4-1": "Primary category the component's associated product resides within", "4-2": "", "5-0": "`secondary`\n*String, optional*", "5-1": "Secondary category the component's associated product resides within", "5-2": "", "6-0": "`tertiary`\n*String, optional*", "6-1": "Tertiary category the component's associated product resides within", "6-2": "" }, "cols": 2, "rows": 7 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"primary\": \"casegood\",\n \"secondary\": \"casegood_table\",\n \"tertiary\": \"casegood_table_dining\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`primary`\n*String, optional*", "4-1": "Primary category the component's associated product resides within", "4-2": "", "5-0": "`secondary`\n*String, optional*", "5-1": "Secondary category the component's associated product resides within", "5-2": "", "6-0": "`tertiary`\n*String, optional*", "6-1": "Tertiary category the component's associated product resides within", "6-2": "" }, "cols": 2, "rows": 7 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"primary\": \"casegood\",\n \"secondary\": \"casegood_table\",\n \"tertiary\": \"casegood_table_dining\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":4,"_id":"5735e785d39886340082ec40","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id `\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`collection_id`\\n*Integer, optional*\",\n    \"4-1\": \"ID of the collection the component's associated product belongs to\",\n    \"4-2\": \"\",\n    \"5-0\": \"`collection`\\n*Object, optional*\",\n    \"5-1\": \"The [Collection Resource](doc:collection-resource) object for the component's associated product\",\n    \"5-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"collection_id\\\": 413,\\n  \\\"collection\\\": {\\n    \\\"description\\\": \\\"A collection of beautiful fall-inspired furniture\\\",\\n    \\\"designed_by\\\": \\\"Seasonal Sensations\\\",\\n    \\\"id\\\": 551,\\n    \\\"manufacturer_id\\\": 413,\\n    \\\"name\\\": \\\"Fall Collection\\\" \\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef284e3f892b00767ede","createdAt":"2016-05-13T14:41:09.426Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"collection-component","sync_unique":"","title":"Collection Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Collection Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`collection_id`\n*Integer, optional*", "4-1": "ID of the collection the component's associated product belongs to", "4-2": "", "5-0": "`collection`\n*Object, optional*", "5-1": "The [Collection Resource](doc:collection-resource) object for the component's associated product", "5-2": "" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"collection_id\": 413,\n \"collection\": {\n \"description\": \"A collection of beautiful fall-inspired furniture\",\n \"designed_by\": \"Seasonal Sensations\",\n \"id\": 551,\n \"manufacturer_id\": 413,\n \"name\": \"Fall Collection\" \n }\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`collection_id`\n*Integer, optional*", "4-1": "ID of the collection the component's associated product belongs to", "4-2": "", "5-0": "`collection`\n*Object, optional*", "5-1": "The [Collection Resource](doc:collection-resource) object for the component's associated product", "5-2": "" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"collection_id\": 413,\n \"collection\": {\n \"description\": \"A collection of beautiful fall-inspired furniture\",\n \"designed_by\": \"Seasonal Sensations\",\n \"id\": 551,\n \"manufacturer_id\": 413,\n \"name\": \"Fall Collection\" \n }\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":6,"_id":"5735e94ed39886340082ec47","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id `\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`name`\\n*String*\",\n    \"4-1\": \"The name of the product associated with the component\",\n    \"4-2\": \"\",\n    \"5-0\": \"`sku`\\n*String*\",\n    \"5-1\": \"The [Stock Keeping Unit (SKU) :fa-external-link:](https://en.wikipedia.org/wiki/Stock_keeping_unit) of the product associated with the component\",\n    \"5-2\": \"\",\n    \"6-0\": \"`source_url`\\n*String, optional*\",\n    \"6-1\": \"URL to the original source for information on the product associated with the component\",\n    \"7-0\": \"`alternate_name`\\n*String*\",\n    \"7-1\": \"The alternative, often romanticized, name for the product associated with the component.\",\n    \"8-0\": \"`upc`\\n*String*\",\n    \"8-1\": \"The [Universal Product Code (UPC) :fa-external-link:](https://en.wikipedia.org/wiki/Universal_Product_Code) of the product associated with the component\"\n  },\n  \"cols\": 2,\n  \"rows\": 9\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"name\\\": \\\"Wooden Chair\\\",\\n  \\\"sku\\\": \\\"lFl7amd2ofmA6mIe423l7\\\",\\n  \\\"source_url\\\": null,\\n  \\\"alternate_name\\\": \\\"Chestnut Wooden Heart Chair\\\",\\n  \\\"upc\\\": \\\"41235-1230-34120-flamingo\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef284e3f892b00767ede","createdAt":"2016-05-13T14:48:46.407Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"identity-component","sync_unique":"","title":"Identity Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Identity Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`name`\n*String*", "4-1": "The name of the product associated with the component", "4-2": "", "5-0": "`sku`\n*String*", "5-1": "The [Stock Keeping Unit (SKU) :fa-external-link:](https://en.wikipedia.org/wiki/Stock_keeping_unit) of the product associated with the component", "5-2": "", "6-0": "`source_url`\n*String, optional*", "6-1": "URL to the original source for information on the product associated with the component", "7-0": "`alternate_name`\n*String*", "7-1": "The alternative, often romanticized, name for the product associated with the component.", "8-0": "`upc`\n*String*", "8-1": "The [Universal Product Code (UPC) :fa-external-link:](https://en.wikipedia.org/wiki/Universal_Product_Code) of the product associated with the component" }, "cols": 2, "rows": 9 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"name\": \"Wooden Chair\",\n \"sku\": \"lFl7amd2ofmA6mIe423l7\",\n \"source_url\": null,\n \"alternate_name\": \"Chestnut Wooden Heart Chair\",\n \"upc\": \"41235-1230-34120-flamingo\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`name`\n*String*", "4-1": "The name of the product associated with the component", "4-2": "", "5-0": "`sku`\n*String*", "5-1": "The [Stock Keeping Unit (SKU) :fa-external-link:](https://en.wikipedia.org/wiki/Stock_keeping_unit) of the product associated with the component", "5-2": "", "6-0": "`source_url`\n*String, optional*", "6-1": "URL to the original source for information on the product associated with the component", "7-0": "`alternate_name`\n*String*", "7-1": "The alternative, often romanticized, name for the product associated with the component.", "8-0": "`upc`\n*String*", "8-1": "The [Universal Product Code (UPC) :fa-external-link:](https://en.wikipedia.org/wiki/Universal_Product_Code) of the product associated with the component" }, "cols": 2, "rows": 9 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"name\": \"Wooden Chair\",\n \"sku\": \"lFl7amd2ofmA6mIe423l7\",\n \"source_url\": null,\n \"alternate_name\": \"Chestnut Wooden Heart Chair\",\n \"upc\": \"41235-1230-34120-flamingo\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":5,"_id":"5735e9bfe004e80e00efd3bf","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id `\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`images`\\n*Object, optional*\",\n    \"4-1\": \"A list of Image child-components\",\n    \"4-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"image_list\\\": []\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef284e3f892b00767ede","createdAt":"2016-05-13T14:50:39.730Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"images-component","sync_unique":"","title":"Images Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Images Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`images`\n*Object, optional*", "4-1": "A list of Image child-components", "4-2": "" }, "cols": 2, "rows": 5 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"image_list\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`images`\n*Object, optional*", "4-1": "A list of Image child-components", "4-2": "" }, "cols": 2, "rows": 5 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"image_list\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":4,"_id":"5735eb89dc3e010e00827b91","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id `\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`manufacturer_id`\\n*Integer*\",\n    \"4-1\": \"The required ID of the manufacturer which created the component's associated product\",\n    \"4-2\": \"\",\n    \"5-0\": \"`manufacturer`\\n*Object*\",\n    \"5-1\": \"The [Manufacturer Resource](doc:manufacturer-resource) object for the component's associated product\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"manufacturer_id\\\": 123,\\n  \\\"manufacturer\\\": {\\n    'province': null,\\n    'street_address_1': null,\\n    'updated_by_api_key': null,\\n    'featured': null,\\n    'id': 713,\\n    'zipcode': null,\\n    'facebook_url': null,\\n    'internal': True,\\n    'logo_url': null,\\n    'name': 'test',\\n    'phone_extension': null,\\n    'linkedin_url': null,\\n    'street_address_2': null,\\n    'email': null,\\n    'date_added': '2016-05-12T21:10:30.286788Z',\\n    'country': null,\\n    'date_updated': '2016-05-12T21:10:30.286788Z',\\n    'legal': null,\\n    'twitter_url': null,\\n    'active': True,\\n    'google_plus_url': null,\\n    'pinterest_url': null,\\n    'restock_fee': null,\\n    'bio': null,\\n    'url': null,\\n    'phone': null,\\n    'return_period': null,\\n    'state': null,\\n    'returnable': null,\\n    'city': null,\\n    'date_profile_complete': null\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef284e3f892b00767ede","createdAt":"2016-05-13T14:58:17.114Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"manufacturer-component","sync_unique":"","title":"Manufacturer Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Manufacturer Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`manufacturer_id`\n*Integer*", "4-1": "The required ID of the manufacturer which created the component's associated product", "4-2": "", "5-0": "`manufacturer`\n*Object*", "5-1": "The [Manufacturer Resource](doc:manufacturer-resource) object for the component's associated product" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"manufacturer_id\": 123,\n \"manufacturer\": {\n 'province': null,\n 'street_address_1': null,\n 'updated_by_api_key': null,\n 'featured': null,\n 'id': 713,\n 'zipcode': null,\n 'facebook_url': null,\n 'internal': True,\n 'logo_url': null,\n 'name': 'test',\n 'phone_extension': null,\n 'linkedin_url': null,\n 'street_address_2': null,\n 'email': null,\n 'date_added': '2016-05-12T21:10:30.286788Z',\n 'country': null,\n 'date_updated': '2016-05-12T21:10:30.286788Z',\n 'legal': null,\n 'twitter_url': null,\n 'active': True,\n 'google_plus_url': null,\n 'pinterest_url': null,\n 'restock_fee': null,\n 'bio': null,\n 'url': null,\n 'phone': null,\n 'return_period': null,\n 'state': null,\n 'returnable': null,\n 'city': null,\n 'date_profile_complete': null\n }\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`manufacturer_id`\n*Integer*", "4-1": "The required ID of the manufacturer which created the component's associated product", "4-2": "", "5-0": "`manufacturer`\n*Object*", "5-1": "The [Manufacturer Resource](doc:manufacturer-resource) object for the component's associated product" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"manufacturer_id\": 123,\n \"manufacturer\": {\n 'province': null,\n 'street_address_1': null,\n 'updated_by_api_key': null,\n 'featured': null,\n 'id': 713,\n 'zipcode': null,\n 'facebook_url': null,\n 'internal': True,\n 'logo_url': null,\n 'name': 'test',\n 'phone_extension': null,\n 'linkedin_url': null,\n 'street_address_2': null,\n 'email': null,\n 'date_added': '2016-05-12T21:10:30.286788Z',\n 'country': null,\n 'date_updated': '2016-05-12T21:10:30.286788Z',\n 'legal': null,\n 'twitter_url': null,\n 'active': True,\n 'google_plus_url': null,\n 'pinterest_url': null,\n 'restock_fee': null,\n 'bio': null,\n 'url': null,\n 'phone': null,\n 'return_period': null,\n 'state': null,\n 'returnable': null,\n 'city': null,\n 'date_profile_complete': null\n }\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":4,"_id":"5735ebd2e004e80e00efd3c9","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id `\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`active`\\n*Boolean*\",\n    \"4-1\": \"\",\n    \"4-2\": \"\",\n    \"5-0\": \"`meets_posting_requirements`\\n*Boolean*\",\n    \"5-1\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"active\\\": true,\\n  \\\"meets_posting_requirements\\\": false\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef284e3f892b00767ede","createdAt":"2016-05-13T14:59:30.561Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":6,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"visibility-component","sync_unique":"","title":"Visibility Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Visibility Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`active`\n*Boolean*", "4-1": "", "4-2": "", "5-0": "`meets_posting_requirements`\n*Boolean*", "5-1": "" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"active\": true,\n \"meets_posting_requirements\": false\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`active`\n*Boolean*", "4-1": "", "4-2": "", "5-0": "`meets_posting_requirements`\n*Boolean*", "5-1": "" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"active\": true,\n \"meets_posting_requirements\": false\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":2,"_id":"5735ede6dc3e010e00827b99","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id `\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`material`\\n*String, optional*\",\n    \"4-1\": \"Type of material the component's associated product is constructed from\",\n    \"4-2\": \"\",\n    \"5-0\": \"`joinery_type`\\n*String, optional*\",\n    \"5-1\": \"\",\n    \"6-0\": \"`finish`\\n*String*\",\n    \"6-1\": \"The type of finish applied to the component's associated product\",\n    \"7-0\": \"`assembly_required`\\n*Boolean, optional*\",\n    \"7-1\": \"Indicates whether the component's associated product requires assembly\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"material\\\": \\\"Walnut wood\\\",\\n  \\\"joinery_type\\\": \\\"\\\",\\n  \\\"finish\\\": \\\"Vermex Covering Finish\\\",\\n  \\\"assembly_required\\\": false\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"573a1655dd007d1700cf285f","createdAt":"2016-05-13T15:08:22.667Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"construction-information-component","sync_unique":"","title":"Construction Information Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Construction Information Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`material`\n*String, optional*", "4-1": "Type of material the component's associated product is constructed from", "4-2": "", "5-0": "`joinery_type`\n*String, optional*", "5-1": "", "6-0": "`finish`\n*String*", "6-1": "The type of finish applied to the component's associated product", "7-0": "`assembly_required`\n*Boolean, optional*", "7-1": "Indicates whether the component's associated product requires assembly" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"material\": \"Walnut wood\",\n \"joinery_type\": \"\",\n \"finish\": \"Vermex Covering Finish\",\n \"assembly_required\": false\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`material`\n*String, optional*", "4-1": "Type of material the component's associated product is constructed from", "4-2": "", "5-0": "`joinery_type`\n*String, optional*", "5-1": "", "6-0": "`finish`\n*String*", "6-1": "The type of finish applied to the component's associated product", "7-0": "`assembly_required`\n*Boolean, optional*", "7-1": "Indicates whether the component's associated product requires assembly" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"material\": \"Walnut wood\",\n \"joinery_type\": \"\",\n \"finish\": \"Vermex Covering Finish\",\n \"assembly_required\": false\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":2,"_id":"5735ef3c6806490e0044e371","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id `\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`primary`\\n*String, optional*\",\n    \"4-1\": \"The primary description of the product associated with the component\",\n    \"4-2\": \"\",\n    \"5-0\": \"`retail`\\n*String, optional*\",\n    \"5-1\": \"\",\n    \"6-0\": \"`designer`\\n*String, optional*\",\n    \"6-1\": \"The designer for the product associated with the component\",\n    \"7-0\": \"`alternate`\\n*String, optional*\",\n    \"7-1\": \"An alternate description of the product associated with the component\",\n    \"8-0\": \"`feature_list`\\n*Object, optional*\",\n    \"8-1\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 9\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"primary\\\": \\\"This is a description for a product\\\",\\n  \\\"retail\\\": null,\\n  \\\"designer\\\": null,\\n  \\\"alternate\\\": \\\"This is an alternate description for a product\\\",\\n  \\\"feature_list\\\": []\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"573a1655dd007d1700cf285f","createdAt":"2016-05-13T15:14:04.902Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"description-component","sync_unique":"","title":"Description Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Description Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`primary`\n*String, optional*", "4-1": "The primary description of the product associated with the component", "4-2": "", "5-0": "`retail`\n*String, optional*", "5-1": "", "6-0": "`designer`\n*String, optional*", "6-1": "The designer for the product associated with the component", "7-0": "`alternate`\n*String, optional*", "7-1": "An alternate description of the product associated with the component", "8-0": "`feature_list`\n*Object, optional*", "8-1": "" }, "cols": 2, "rows": 9 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"primary\": \"This is a description for a product\",\n \"retail\": null,\n \"designer\": null,\n \"alternate\": \"This is an alternate description for a product\",\n \"feature_list\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`primary`\n*String, optional*", "4-1": "The primary description of the product associated with the component", "4-2": "", "5-0": "`retail`\n*String, optional*", "5-1": "", "6-0": "`designer`\n*String, optional*", "6-1": "The designer for the product associated with the component", "7-0": "`alternate`\n*String, optional*", "7-1": "An alternate description of the product associated with the component", "8-0": "`feature_list`\n*Object, optional*", "8-1": "" }, "cols": 2, "rows": 9 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"primary\": \"This is a description for a product\",\n \"retail\": null,\n \"designer\": null,\n \"alternate\": \"This is an alternate description for a product\",\n \"feature_list\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":2,"_id":"5735f196ceca3f1700cc054e","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id `\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`cleaning_directions`\\n*String, optional*\",\n    \"4-1\": \"Instructions for how to clean the product associated with the component\",\n    \"4-2\": \"\",\n    \"5-0\": \"`installation_directions`\\n*String, optional*\",\n    \"5-1\": \"Instructions for how to install the product associated with the component\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"cleaning_directions\\\": \\\"Clean it with water, but not at night\\\",\\n  \\\"installation_directions\\\": \\\"Install product with care\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"573a1655dd007d1700cf285f","createdAt":"2016-05-13T15:24:06.098Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"instruction-component","sync_unique":"","title":"Instruction Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Instruction Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`cleaning_directions`\n*String, optional*", "4-1": "Instructions for how to clean the product associated with the component", "4-2": "", "5-0": "`installation_directions`\n*String, optional*", "5-1": "Instructions for how to install the product associated with the component" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"cleaning_directions\": \"Clean it with water, but not at night\",\n \"installation_directions\": \"Install product with care\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`cleaning_directions`\n*String, optional*", "4-1": "Instructions for how to clean the product associated with the component", "4-2": "", "5-0": "`installation_directions`\n*String, optional*", "5-1": "Instructions for how to install the product associated with the component" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"cleaning_directions\": \"Clean it with water, but not at night\",\n \"installation_directions\": \"Install product with care\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"5735f291ceca3f1700cc0555","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id `\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`keywords`\\n*Object, optional*\",\n    \"4-1\": \"\",\n    \"4-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"keywords\\\": []\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"573a1655dd007d1700cf285f","createdAt":"2016-05-13T15:28:17.373Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"keyword-component","sync_unique":"","title":"Keyword Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Keyword Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`keywords`\n*Object, optional*", "4-1": "", "4-2": "" }, "cols": 2, "rows": 5 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"keywords\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`keywords`\n*Object, optional*", "4-1": "", "4-2": "" }, "cols": 2, "rows": 5 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"keywords\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"573607612ab52e1700c8e7b0","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id `\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`option_set_list`\\n*Object, optional*\",\n    \"4-1\": \"\",\n    \"4-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"option_set_list\\\": []\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"573a1655dd007d1700cf285f","createdAt":"2016-05-13T16:57:05.157Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"option-sets-component","sync_unique":"","title":"Option Sets Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Option Sets Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`option_set_list`\n*Object, optional*", "4-1": "", "4-2": "" }, "cols": 2, "rows": 5 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"option_set_list\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`option_set_list`\n*Object, optional*", "4-1": "", "4-2": "" }, "cols": 2, "rows": 5 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"option_set_list\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":2,"_id":"5736094e1d2b0032000a5d53","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`unit`\\n*String, optional*\",\n    \"4-1\": \"The unit in which the component's associated product is shipped in\\nE.g.: By the *foot*, *yard*, *set*, *roll*, *pair*, etc.\",\n    \"4-2\": \"\",\n    \"5-0\": \"`discontinued`\\n*Boolean, optional*\",\n    \"5-1\": \"Indicates if the component's associated product has been discontinued\",\n    \"6-0\": \"`lead_time`\\n*Integer, optional*\",\n    \"6-1\": \"The amount of lead time expected for the component's associated product\",\n    \"7-0\": \"`lead_time_unit`\\n*String, optional*\",\n    \"7-1\": \"The unit of measure for the lead time\",\n    \"8-0\": \"`quick_ship`\\n*Boolean, optional*\",\n    \"8-1\": \"Indicate if the component's associated product can be shipped quickly\",\n    \"9-0\": \"`minimum_quantity`\\n*Integer, optional*\",\n    \"9-1\": \"The minimum quantity which can be ordered\",\n    \"10-0\": \"`force_multiples`\\n*Integer, optional*\",\n    \"11-0\": \"`stock`\\n*Integer, optional*\",\n    \"11-1\": \"The amount of units currently in stock\",\n    \"12-0\": \"`warranty`\\n*String, optional*\",\n    \"12-1\": \"Product-specific warranty information\"\n  },\n  \"cols\": 2,\n  \"rows\": 13\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"unit\\\": \\\"yard\\\",\\n  \\\"discontinued\\\": false,\\n  \\\"lead_time\\\": 3,\\n  \\\"lead_time_unit\\\": \\\"days\\\",\\n  \\\"quick_ship\\\": false,\\n  \\\"minimum_quantity\\\": 1,\\n  \\\"force_multiples\\\": null,\\n  \\\"stock\\\": 13547,\\n  \\\"warranty\\\": null\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"573a1655dd007d1700cf285f","createdAt":"2016-05-13T17:05:18.043Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"ordering-information-component","sync_unique":"","title":"Ordering Information Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Ordering Information Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`unit`\n*String, optional*", "4-1": "The unit in which the component's associated product is shipped in\nE.g.: By the *foot*, *yard*, *set*, *roll*, *pair*, etc.", "4-2": "", "5-0": "`discontinued`\n*Boolean, optional*", "5-1": "Indicates if the component's associated product has been discontinued", "6-0": "`lead_time`\n*Integer, optional*", "6-1": "The amount of lead time expected for the component's associated product", "7-0": "`lead_time_unit`\n*String, optional*", "7-1": "The unit of measure for the lead time", "8-0": "`quick_ship`\n*Boolean, optional*", "8-1": "Indicate if the component's associated product can be shipped quickly", "9-0": "`minimum_quantity`\n*Integer, optional*", "9-1": "The minimum quantity which can be ordered", "10-0": "`force_multiples`\n*Integer, optional*", "11-0": "`stock`\n*Integer, optional*", "11-1": "The amount of units currently in stock", "12-0": "`warranty`\n*String, optional*", "12-1": "Product-specific warranty information" }, "cols": 2, "rows": 13 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"unit\": \"yard\",\n \"discontinued\": false,\n \"lead_time\": 3,\n \"lead_time_unit\": \"days\",\n \"quick_ship\": false,\n \"minimum_quantity\": 1,\n \"force_multiples\": null,\n \"stock\": 13547,\n \"warranty\": null\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`unit`\n*String, optional*", "4-1": "The unit in which the component's associated product is shipped in\nE.g.: By the *foot*, *yard*, *set*, *roll*, *pair*, etc.", "4-2": "", "5-0": "`discontinued`\n*Boolean, optional*", "5-1": "Indicates if the component's associated product has been discontinued", "6-0": "`lead_time`\n*Integer, optional*", "6-1": "The amount of lead time expected for the component's associated product", "7-0": "`lead_time_unit`\n*String, optional*", "7-1": "The unit of measure for the lead time", "8-0": "`quick_ship`\n*Boolean, optional*", "8-1": "Indicate if the component's associated product can be shipped quickly", "9-0": "`minimum_quantity`\n*Integer, optional*", "9-1": "The minimum quantity which can be ordered", "10-0": "`force_multiples`\n*Integer, optional*", "11-0": "`stock`\n*Integer, optional*", "11-1": "The amount of units currently in stock", "12-0": "`warranty`\n*String, optional*", "12-1": "Product-specific warranty information" }, "cols": 2, "rows": 13 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"unit\": \"yard\",\n \"discontinued\": false,\n \"lead_time\": 3,\n \"lead_time_unit\": \"days\",\n \"quick_ship\": false,\n \"minimum_quantity\": 1,\n \"force_multiples\": null,\n \"stock\": 13547,\n \"warranty\": null\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":2,"_id":"57360cb32c4996320097f180","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`width`\\n*Decimal, optional*\",\n    \"4-1\": \"The overall width of the component's associated product\",\n    \"4-2\": \"\",\n    \"5-0\": \"`height`\\n*Decimal, optional*\",\n    \"5-1\": \"The overall height of the component's associated product\",\n    \"6-0\": \"`depth`\\n*Decimal, optional*\",\n    \"6-1\": \"The overall depth of the component's associated product\",\n    \"7-0\": \"`diameter`\\n*Decimal, optional*\",\n    \"7-1\": \"The overall diameter of the component's associated product\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"width\\\": 314159,\\n  \\\"height\\\": 628496,\\n  \\\"depth\\\": 14,\\n  \\\"diameter\\\": null\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"573a1655dd007d1700cf285f","createdAt":"2016-05-13T17:19:47.191Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":6,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"overall-dimension-component","sync_unique":"","title":"Overall Dimension Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Overall Dimension Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`width`\n*Decimal, optional*", "4-1": "The overall width of the component's associated product", "4-2": "", "5-0": "`height`\n*Decimal, optional*", "5-1": "The overall height of the component's associated product", "6-0": "`depth`\n*Decimal, optional*", "6-1": "The overall depth of the component's associated product", "7-0": "`diameter`\n*Decimal, optional*", "7-1": "The overall diameter of the component's associated product" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"width\": 314159,\n \"height\": 628496,\n \"depth\": 14,\n \"diameter\": null\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`width`\n*Decimal, optional*", "4-1": "The overall width of the component's associated product", "4-2": "", "5-0": "`height`\n*Decimal, optional*", "5-1": "The overall height of the component's associated product", "6-0": "`depth`\n*Decimal, optional*", "6-1": "The overall depth of the component's associated product", "7-0": "`diameter`\n*Decimal, optional*", "7-1": "The overall diameter of the component's associated product" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"width\": 314159,\n \"height\": 628496,\n \"depth\": 14,\n \"diameter\": null\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"573610dc1d2b0032000a5d63","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`wholesale`\\n*Decimal, optional*\",\n    \"4-1\": \"The wholesale price for the component's associate product\",\n    \"4-2\": \"\",\n    \"5-0\": \"`trade_price`\\n*Decimal, optional*\",\n    \"5-1\": \"The trade price for the component's associated product\",\n    \"6-0\": \"`minimum_internet_price`\\n*Decimal, optional*\",\n    \"6-1\": \"The minimum internet price for the component's associated product\",\n    \"7-0\": \"`msrp`\\n*Decimal, optional*\",\n    \"7-1\": \"The [MSRP :fa-external-link:](https://en.wikipedia.org/wiki/List_price) price for the component's associated product\",\n    \"8-0\": \"`dealer_price`\\n*Decimal, optional*\",\n    \"8-1\": \"The dealer price for the component's associated product\"\n  },\n  \"cols\": 2,\n  \"rows\": 9\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"wholesale\\\": 153,\\n  \\\"trade_price\\\": 150.23,\\n  \\\"minimum_internet_price\\\": 166.41,\\n  \\\"msrp\\\": 166.41,\\n  \\\"dealer_price\\\": 112.00\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"573a1655dd007d1700cf285f","createdAt":"2016-05-13T17:37:32.294Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":7,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"pricing-component","sync_unique":"","title":"Pricing Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Pricing Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`wholesale`\n*Decimal, optional*", "4-1": "The wholesale price for the component's associate product", "4-2": "", "5-0": "`trade_price`\n*Decimal, optional*", "5-1": "The trade price for the component's associated product", "6-0": "`minimum_internet_price`\n*Decimal, optional*", "6-1": "The minimum internet price for the component's associated product", "7-0": "`msrp`\n*Decimal, optional*", "7-1": "The [MSRP :fa-external-link:](https://en.wikipedia.org/wiki/List_price) price for the component's associated product", "8-0": "`dealer_price`\n*Decimal, optional*", "8-1": "The dealer price for the component's associated product" }, "cols": 2, "rows": 9 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"wholesale\": 153,\n \"trade_price\": 150.23,\n \"minimum_internet_price\": 166.41,\n \"msrp\": 166.41,\n \"dealer_price\": 112.00\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`wholesale`\n*Decimal, optional*", "4-1": "The wholesale price for the component's associate product", "4-2": "", "5-0": "`trade_price`\n*Decimal, optional*", "5-1": "The trade price for the component's associated product", "6-0": "`minimum_internet_price`\n*Decimal, optional*", "6-1": "The minimum internet price for the component's associated product", "7-0": "`msrp`\n*Decimal, optional*", "7-1": "The [MSRP :fa-external-link:](https://en.wikipedia.org/wiki/List_price) price for the component's associated product", "8-0": "`dealer_price`\n*Decimal, optional*", "8-1": "The dealer price for the component's associated product" }, "cols": 2, "rows": 9 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"wholesale\": 153,\n \"trade_price\": 150.23,\n \"minimum_internet_price\": 166.41,\n \"msrp\": 166.41,\n \"dealer_price\": 112.00\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"573611af652bd80e00a90023","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`new_product`\\n*Boolean, optional*\",\n    \"4-1\": \"Indicate if the product is new\",\n    \"4-2\": \"\",\n    \"5-0\": \"`best_seller`\\n*Boolean, optional*\",\n    \"5-1\": \"Indicate if the product is a best seller\",\n    \"6-0\": \"`limited_stock`\\n*Boolean, optional*\",\n    \"6-1\": \"Indicate if the product is often offered only with limited stock\",\n    \"7-0\": \"`discontinued`\\n*Boolean, optional*\",\n    \"7-1\": \"Indicate if the product has been discontinued\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"new_product\\\": false,\\n  \\\"best_seller\\\": true,\\n  \\\"limited_stock\\\": false,\\n  \\\"discontinued\\\": false\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"573a1655dd007d1700cf285f","createdAt":"2016-05-13T17:41:03.371Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":8,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"promotional-tag-component","sync_unique":"","title":"Promotional Tag Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Promotional Tag Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`new_product`\n*Boolean, optional*", "4-1": "Indicate if the product is new", "4-2": "", "5-0": "`best_seller`\n*Boolean, optional*", "5-1": "Indicate if the product is a best seller", "6-0": "`limited_stock`\n*Boolean, optional*", "6-1": "Indicate if the product is often offered only with limited stock", "7-0": "`discontinued`\n*Boolean, optional*", "7-1": "Indicate if the product has been discontinued" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"new_product\": false,\n \"best_seller\": true,\n \"limited_stock\": false,\n \"discontinued\": false\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`new_product`\n*Boolean, optional*", "4-1": "Indicate if the product is new", "4-2": "", "5-0": "`best_seller`\n*Boolean, optional*", "5-1": "Indicate if the product is a best seller", "6-0": "`limited_stock`\n*Boolean, optional*", "6-1": "Indicate if the product is often offered only with limited stock", "7-0": "`discontinued`\n*Boolean, optional*", "7-1": "Indicate if the product has been discontinued" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"new_product\": false,\n \"best_seller\": true,\n \"limited_stock\": false,\n \"discontinued\": false\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"573614b11d2b0032000a5d6c","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`ships_from`\\n*String, optional*\",\n    \"4-1\": \"The location the product will be shipped from\",\n    \"4-2\": \"\",\n    \"5-0\": \"`volume`\\n*Decimal, optional*\",\n    \"5-1\": \"The volume (in cubic feet) of the packaged product\",\n    \"6-0\": \"`standard`\\n*Boolean, optional*\",\n    \"6-1\": \"Indicates standard shipping method\",\n    \"7-0\": \"`freight`\\n*Boolean, optional*\",\n    \"7-1\": \"Indicates freight shipping method\",\n    \"8-0\": \"`white_glove`\\n*Boolean, optional*\",\n    \"8-1\": \"Indicates white glove shipping method\",\n    \"9-0\": \"`drop_ship`\\n*Boolean, optional*\",\n    \"9-1\": \"Indicates drop ship shipping method\",\n    \"10-0\": \"`notes`\\n*String, optional*\",\n    \"10-1\": \"Include any product-specific shipping notes\",\n    \"11-0\": \"`country_of_origin`\\n*String, optional*\",\n    \"11-1\": \"The country of origin for shipping the product\",\n    \"12-0\": \"`box_list`\\n*Object, optional*\",\n    \"12-1\": \"A list of the boxes necessary to ship the product\"\n  },\n  \"cols\": 2,\n  \"rows\": 13\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"ships_from\\\": \\\"United States\\\",\\n  \\\"volume\\\": 5.7,\\n  \\\"standard\\\": true,\\n  \\\"freight\\\": false,\\n  \\\"white_glove\\\": true,\\n  \\\"driop_ship\\\": false,\\n  \\\"notes\\\": \\\"\\\",\\n  \\\"country_of_origin\\\": \\\"China\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"573a1655dd007d1700cf285f","createdAt":"2016-05-13T17:53:53.138Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":9,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"shipping-information-component","sync_unique":"","title":"Shipping Information Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Shipping Information Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`ships_from`\n*String, optional*", "4-1": "The location the product will be shipped from", "4-2": "", "5-0": "`volume`\n*Decimal, optional*", "5-1": "The volume (in cubic feet) of the packaged product", "6-0": "`standard`\n*Boolean, optional*", "6-1": "Indicates standard shipping method", "7-0": "`freight`\n*Boolean, optional*", "7-1": "Indicates freight shipping method", "8-0": "`white_glove`\n*Boolean, optional*", "8-1": "Indicates white glove shipping method", "9-0": "`drop_ship`\n*Boolean, optional*", "9-1": "Indicates drop ship shipping method", "10-0": "`notes`\n*String, optional*", "10-1": "Include any product-specific shipping notes", "11-0": "`country_of_origin`\n*String, optional*", "11-1": "The country of origin for shipping the product", "12-0": "`box_list`\n*Object, optional*", "12-1": "A list of the boxes necessary to ship the product" }, "cols": 2, "rows": 13 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"ships_from\": \"United States\",\n \"volume\": 5.7,\n \"standard\": true,\n \"freight\": false,\n \"white_glove\": true,\n \"driop_ship\": false,\n \"notes\": \"\",\n \"country_of_origin\": \"China\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`ships_from`\n*String, optional*", "4-1": "The location the product will be shipped from", "4-2": "", "5-0": "`volume`\n*Decimal, optional*", "5-1": "The volume (in cubic feet) of the packaged product", "6-0": "`standard`\n*Boolean, optional*", "6-1": "Indicates standard shipping method", "7-0": "`freight`\n*Boolean, optional*", "7-1": "Indicates freight shipping method", "8-0": "`white_glove`\n*Boolean, optional*", "8-1": "Indicates white glove shipping method", "9-0": "`drop_ship`\n*Boolean, optional*", "9-1": "Indicates drop ship shipping method", "10-0": "`notes`\n*String, optional*", "10-1": "Include any product-specific shipping notes", "11-0": "`country_of_origin`\n*String, optional*", "11-1": "The country of origin for shipping the product", "12-0": "`box_list`\n*Object, optional*", "12-1": "A list of the boxes necessary to ship the product" }, "cols": 2, "rows": 13 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"ships_from\": \"United States\",\n \"volume\": 5.7,\n \"standard\": true,\n \"freight\": false,\n \"white_glove\": true,\n \"driop_ship\": false,\n \"notes\": \"\",\n \"country_of_origin\": \"China\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"5736150b1d2b0032000a5d6e","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`weight`\\n*Decimal, optional*\",\n    \"4-1\": \"The weight of the component's associated product\",\n    \"4-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"weight\\\": 13.45\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"573a1655dd007d1700cf285f","createdAt":"2016-05-13T17:55:23.111Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":10,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"weight-component","sync_unique":"","title":"Weight Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Weight Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`weight`\n*Decimal, optional*", "4-1": "The weight of the component's associated product", "4-2": "" }, "cols": 2, "rows": 5 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"weight\": 13.45\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`weight`\n*Decimal, optional*", "4-1": "The weight of the component's associated product", "4-2": "" }, "cols": 2, "rows": 5 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"weight\": 13.45\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"573616021d2b0032000a5d71","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id `\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`height`\\n*Decimal, optional*\",\n    \"4-1\": \"The height of the arm of the product\",\n    \"4-2\": \"\",\n    \"5-0\": \"`style`\\n*String, optional*\",\n    \"5-1\": \"The style of the arm of the product\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"height\\\": 3.2,\\n  \\\"style\\\": \\\"wooden\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T17:59:30.822Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"arm-component","sync_unique":"","title":"Arm Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Arm Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The height of the arm of the product", "4-2": "", "5-0": "`style`\n*String, optional*", "5-1": "The style of the arm of the product" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"height\": 3.2,\n \"style\": \"wooden\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The height of the arm of the product", "4-2": "", "5-0": "`style`\n*String, optional*", "5-1": "The style of the arm of the product" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"height\": 3.2,\n \"style\": \"wooden\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"57361685a194a817001c3f4f","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`height`\\n*Decimal, optional*\",\n    \"4-1\": \"The height of the base of the product\",\n    \"4-2\": \"\",\n    \"5-0\": \"`width`\\n*Decimal, optional*\",\n    \"5-1\": \"The width of the base of the product\",\n    \"6-0\": \"`depth`\\n*Decimal, optional*\",\n    \"6-1\": \"The depth of the base of the product\",\n    \"7-0\": \"`diameter`\\n*Decimal, optional*\",\n    \"7-1\": \"The diameter of the base of the product\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"height\\\": 3.2,\\n  \\\"width\\\": 2.3,\\n  \\\"depth\\\": 19.39,\\n  \\\"diameter\\\": 19.45\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T18:01:41.879Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"base-component","sync_unique":"","title":"Base Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Base Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The height of the base of the product", "4-2": "", "5-0": "`width`\n*Decimal, optional*", "5-1": "The width of the base of the product", "6-0": "`depth`\n*Decimal, optional*", "6-1": "The depth of the base of the product", "7-0": "`diameter`\n*Decimal, optional*", "7-1": "The diameter of the base of the product" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"height\": 3.2,\n \"width\": 2.3,\n \"depth\": 19.39,\n \"diameter\": 19.45\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The height of the base of the product", "4-2": "", "5-0": "`width`\n*Decimal, optional*", "5-1": "The width of the base of the product", "6-0": "`depth`\n*Decimal, optional*", "6-1": "The depth of the base of the product", "7-0": "`diameter`\n*Decimal, optional*", "7-1": "The diameter of the base of the product" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"height\": 3.2,\n \"width\": 2.3,\n \"depth\": 19.39,\n \"diameter\": 19.45\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"573617562ab52e1700c8e856","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`kind`\\n*String, optional*\",\n    \"4-1\": \"The kind of bulb used\",\n    \"4-2\": \"\",\n    \"5-0\": \"`base`\\n*String, optional*\",\n    \"5-1\": \"A description of the base for the bulb\",\n    \"6-0\": \"`quantity`\\n*Integer, optional*\",\n    \"6-1\": \"\",\n    \"7-0\": \"`wattage`\\n*Integer, optional*\",\n    \"7-1\": \"The wattage of the bulb\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"kind\\\": \\\"LED\\\",\\n  \\\"base\\\": \\\"standard\\\",\\n  \\\"quantity\\\": 3,\\n  \\\"wattage\\\": 45\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T18:05:10.344Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"bulb-component","sync_unique":"","title":"Bulb Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Bulb Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`kind`\n*String, optional*", "4-1": "The kind of bulb used", "4-2": "", "5-0": "`base`\n*String, optional*", "5-1": "A description of the base for the bulb", "6-0": "`quantity`\n*Integer, optional*", "6-1": "", "7-0": "`wattage`\n*Integer, optional*", "7-1": "The wattage of the bulb" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"kind\": \"LED\",\n \"base\": \"standard\",\n \"quantity\": 3,\n \"wattage\": 45\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`kind`\n*String, optional*", "4-1": "The kind of bulb used", "4-2": "", "5-0": "`base`\n*String, optional*", "5-1": "A description of the base for the bulb", "6-0": "`quantity`\n*Integer, optional*", "6-1": "", "7-0": "`wattage`\n*Integer, optional*", "7-1": "The wattage of the bulb" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"kind\": \"LED\",\n \"base\": \"standard\",\n \"quantity\": 3,\n \"wattage\": 45\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"573617b0652bd80e00a90036","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`com`\\n*Decimal, optional*\",\n    \"4-1\": \"\",\n    \"4-2\": \"\",\n    \"5-0\": \"`col`\\n*Decimal, optional*\",\n    \"5-1\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"com\\\": 23,\\n  \\\"col\\\": 24\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T18:06:40.456Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"com-col-component","sync_unique":"","title":"COM / COL Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

COM / COL Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`com`\n*Decimal, optional*", "4-1": "", "4-2": "", "5-0": "`col`\n*Decimal, optional*", "5-1": "" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"com\": 23,\n \"col\": 24\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`com`\n*Decimal, optional*", "4-1": "", "4-2": "", "5-0": "`col`\n*Decimal, optional*", "5-1": "" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"com\": 23,\n \"col\": 24\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"573618e0dd646129007024d6","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`quantity`\\n*Integer, optional*\",\n    \"4-1\": \"The number of cushions included with the product\",\n    \"4-2\": \"\",\n    \"5-0\": \"`cushion_list`\\n*Objects, optional*\",\n    \"5-1\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"quantity\\\": 3,\\n  \\\"cushion_list\\\": []\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T18:11:44.315Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"cushions-component","sync_unique":"","title":"Cushions Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Cushions Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`quantity`\n*Integer, optional*", "4-1": "The number of cushions included with the product", "4-2": "", "5-0": "`cushion_list`\n*Objects, optional*", "5-1": "" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"quantity\": 3,\n \"cushion_list\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`quantity`\n*Integer, optional*", "4-1": "The number of cushions included with the product", "4-2": "", "5-0": "`cushion_list`\n*Objects, optional*", "5-1": "" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"quantity\": 3,\n \"cushion_list\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"57361905a194a817001c3f53","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`quantity`\\n*Integer, optional*\",\n    \"4-1\": \"The number of doors included with the product\",\n    \"4-2\": \"\",\n    \"5-0\": \"`door_list`\\n*Objects, optional*\",\n    \"5-1\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"quantity\\\": 3,\\n  \\\"door_list\\\": []\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T18:12:21.733Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"doors-component","sync_unique":"","title":"Doors Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Doors Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`quantity`\n*Integer, optional*", "4-1": "The number of doors included with the product", "4-2": "", "5-0": "`door_list`\n*Objects, optional*", "5-1": "" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"quantity\": 3,\n \"door_list\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`quantity`\n*Integer, optional*", "4-1": "The number of doors included with the product", "4-2": "", "5-0": "`door_list`\n*Objects, optional*", "5-1": "" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"quantity\": 3,\n \"door_list\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"573619fd2ab52e1700c8e85a","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`quantity`\\n*Integer, optional*\",\n    \"4-1\": \"The number of drawers included with the product\",\n    \"4-2\": \"\",\n    \"5-0\": \"`drawer_list`\\n*Objects, optional*\",\n    \"5-1\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"quantity\\\": 3,\\n  \\\"drawer_list\\\": []\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T18:16:29.201Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":6,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"drawers-component","sync_unique":"","title":"Drawers Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Drawers Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`quantity`\n*Integer, optional*", "4-1": "The number of drawers included with the product", "4-2": "", "5-0": "`drawer_list`\n*Objects, optional*", "5-1": "" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"quantity\": 3,\n \"drawer_list\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`quantity`\n*Integer, optional*", "4-1": "The number of drawers included with the product", "4-2": "", "5-0": "`drawer_list`\n*Objects, optional*", "5-1": "" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"quantity\": 3,\n \"drawer_list\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"57361bbea194a817001c3f5b","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`martindale`\\n*String, optional*\",\n    \"4-1\": \"The Martindale durability of a product\",\n    \"4-2\": \"\",\n    \"5-0\": \"`wyzenbeek`\\n*String, optional*\",\n    \"5-1\": \"The Wyzenbeek durability of a product\",\n    \"6-0\": \"`flammability`\\n*String, optional*\",\n    \"6-1\": \"The flammability durability of a product\"\n  },\n  \"cols\": 2,\n  \"rows\": 7\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"martindale\\\": \\\"\\\",\\n  \\\"wyzenbeek\\\": \\\"\\\",\\n  \\\"flammability\\\": \\\"\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T18:23:58.195Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":7,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"durability-component","sync_unique":"","title":"Durability Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Durability Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`martindale`\n*String, optional*", "4-1": "The Martindale durability of a product", "4-2": "", "5-0": "`wyzenbeek`\n*String, optional*", "5-1": "The Wyzenbeek durability of a product", "6-0": "`flammability`\n*String, optional*", "6-1": "The flammability durability of a product" }, "cols": 2, "rows": 7 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"martindale\": \"\",\n \"wyzenbeek\": \"\",\n \"flammability\": \"\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`martindale`\n*String, optional*", "4-1": "The Martindale durability of a product", "4-2": "", "5-0": "`wyzenbeek`\n*String, optional*", "5-1": "The Wyzenbeek durability of a product", "6-0": "`flammability`\n*String, optional*", "6-1": "The flammability durability of a product" }, "cols": 2, "rows": 7 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"martindale\": \"\",\n \"wyzenbeek\": \"\",\n \"flammability\": \"\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"5736203072002a20004271c6","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`switch_type`\\n*String, optional*\",\n    \"4-1\": \"The type of electrical switch in use\",\n    \"4-2\": \"\",\n    \"5-0\": \"`voltage`\\n*Decimal, optional*\",\n    \"5-1\": \"The voltage rating of the component\",\n    \"6-0\": \"`exterior_use`\\n*Boolean, optional*\",\n    \"6-1\": \"Indicate if this product can be used in exterior conditions\"\n  },\n  \"cols\": 2,\n  \"rows\": 7\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"switch_type\\\": \\\"standard\\\",\\n  \\\"voltage\\\": 120.00,\\n  \\\"exterior_use\\\": false\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T18:42:56.700Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":8,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"electrical-component","sync_unique":"","title":"Electrical Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Electrical Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`switch_type`\n*String, optional*", "4-1": "The type of electrical switch in use", "4-2": "", "5-0": "`voltage`\n*Decimal, optional*", "5-1": "The voltage rating of the component", "6-0": "`exterior_use`\n*Boolean, optional*", "6-1": "Indicate if this product can be used in exterior conditions" }, "cols": 2, "rows": 7 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"switch_type\": \"standard\",\n \"voltage\": 120.00,\n \"exterior_use\": false\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`switch_type`\n*String, optional*", "4-1": "The type of electrical switch in use", "4-2": "", "5-0": "`voltage`\n*Decimal, optional*", "5-1": "The voltage rating of the component", "6-0": "`exterior_use`\n*Boolean, optional*", "6-1": "Indicate if this product can be used in exterior conditions" }, "cols": 2, "rows": 7 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"switch_type\": \"standard\",\n \"voltage\": 120.00,\n \"exterior_use\": false\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"573620c8b2b4cf1700a58f6e","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`pile`\\n*String, optional*\",\n    \"4-1\": \"\",\n    \"4-2\": \"\",\n    \"5-0\": \"`construction`\\n*String, optional*\",\n    \"5-1\": \"The construction of the fiber used on the product\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"switch_type\\\": \\\"standard\\\",\\n  \\\"pile\\\": null,\\n  \\\"construction\\\": \\\"\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T18:45:28.307Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":9,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"fiber-component","sync_unique":"","title":"Fiber Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Fiber Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`pile`\n*String, optional*", "4-1": "", "4-2": "", "5-0": "`construction`\n*String, optional*", "5-1": "The construction of the fiber used on the product" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"switch_type\": \"standard\",\n \"pile\": null,\n \"construction\": \"\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`pile`\n*String, optional*", "4-1": "", "4-2": "", "5-0": "`construction`\n*String, optional*", "5-1": "The construction of the fiber used on the product" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"switch_type\": \"standard\",\n \"pile\": null,\n \"construction\": \"\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"57362300c891380e002f2030","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`fuel_type`\\n*String, optional*\",\n    \"4-1\": \"The type of fuel used for the flames from the product\",\n    \"4-2\": \"\",\n    \"5-0\": \"`burner_capacity`\\n*Decimal, optional*\",\n    \"5-1\": \"The amount of fuel the burner can contain\",\n    \"6-0\": \"`burning_time`\\n*Decimal, optional*\",\n    \"6-1\": \"How long the burner can remain ignited before require refilling\",\n    \"7-0\": \"`heat_output`\\n*Decimal, optional*\",\n    \"7-1\": \"The amount of heat dissipated by the product\",\n    \"8-0\": \"`minimum_room_size`\\n*Decimal, optional*\",\n    \"8-1\": \"The minimum required room size to safely operate the product\"\n  },\n  \"cols\": 2,\n  \"rows\": 9\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"fuel_type\\\": \\\"wood\\\",\\n  \\\"burner_capacity\\\": null,\\n  \\\"burning_time\\\": 13,\\n  \\\"heat_output\\\": null,\\n  \\\"minimum_room_size\\\": 132\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T18:54:56.193Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":10,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"flame-component","sync_unique":"","title":"Flame Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Flame Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`fuel_type`\n*String, optional*", "4-1": "The type of fuel used for the flames from the product", "4-2": "", "5-0": "`burner_capacity`\n*Decimal, optional*", "5-1": "The amount of fuel the burner can contain", "6-0": "`burning_time`\n*Decimal, optional*", "6-1": "How long the burner can remain ignited before require refilling", "7-0": "`heat_output`\n*Decimal, optional*", "7-1": "The amount of heat dissipated by the product", "8-0": "`minimum_room_size`\n*Decimal, optional*", "8-1": "The minimum required room size to safely operate the product" }, "cols": 2, "rows": 9 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"fuel_type\": \"wood\",\n \"burner_capacity\": null,\n \"burning_time\": 13,\n \"heat_output\": null,\n \"minimum_room_size\": 132\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`fuel_type`\n*String, optional*", "4-1": "The type of fuel used for the flames from the product", "4-2": "", "5-0": "`burner_capacity`\n*Decimal, optional*", "5-1": "The amount of fuel the burner can contain", "6-0": "`burning_time`\n*Decimal, optional*", "6-1": "How long the burner can remain ignited before require refilling", "7-0": "`heat_output`\n*Decimal, optional*", "7-1": "The amount of heat dissipated by the product", "8-0": "`minimum_room_size`\n*Decimal, optional*", "8-1": "The minimum required room size to safely operate the product" }, "cols": 2, "rows": 9 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"fuel_type\": \"wood\",\n \"burner_capacity\": null,\n \"burning_time\": 13,\n \"heat_output\": null,\n \"minimum_room_size\": 132\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"573623a724cf7f2000ac3f59","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id `\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`height`\\n*Decimal, optional*\",\n    \"4-1\": \"The height of the footboard of the product\",\n    \"4-2\": \"\",\n    \"5-0\": \"`width`\\n*Decimal, optional*\",\n    \"5-1\": \"The width of the footboard of the product\",\n    \"6-0\": \"`depth`\\n*Decimal, optional*\",\n    \"6-1\": \"The depth of the footboard or the product\",\n    \"7-0\": \"`floor_clearance`\\n*Decimal, optional*\",\n    \"7-1\": \"The necessary floor clearance required for the footboard of the product\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"height\\\": 123.32,\\n  \\\"width\\\": 456.789,\\n  \\\"depth\\\": 13.37,\\n  \\\"floor_clearance\\\": 12.23\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T18:57:43.229Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":11,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"footboard-component","sync_unique":"","title":"Footboard Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Footboard Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The height of the footboard of the product", "4-2": "", "5-0": "`width`\n*Decimal, optional*", "5-1": "The width of the footboard of the product", "6-0": "`depth`\n*Decimal, optional*", "6-1": "The depth of the footboard or the product", "7-0": "`floor_clearance`\n*Decimal, optional*", "7-1": "The necessary floor clearance required for the footboard of the product" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"height\": 123.32,\n \"width\": 456.789,\n \"depth\": 13.37,\n \"floor_clearance\": 12.23\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id `\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The height of the footboard of the product", "4-2": "", "5-0": "`width`\n*Decimal, optional*", "5-1": "The width of the footboard of the product", "6-0": "`depth`\n*Decimal, optional*", "6-1": "The depth of the footboard or the product", "7-0": "`floor_clearance`\n*Decimal, optional*", "7-1": "The necessary floor clearance required for the footboard of the product" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"height\": 123.32,\n \"width\": 456.789,\n \"depth\": 13.37,\n \"floor_clearance\": 12.23\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"573623edccff861700d0958f","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`height`\\n*Decimal, optional*\",\n    \"4-1\": \"The height of the footrest of the product\",\n    \"4-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"height\\\": 123.32\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T18:58:53.930Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":12,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"footrest-component","sync_unique":"","title":"Footrest Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Footrest Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The height of the footrest of the product", "4-2": "" }, "cols": 2, "rows": 5 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"height\": 123.32\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The height of the footrest of the product", "4-2": "" }, "cols": 2, "rows": 5 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"height\": 123.32\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"5736246b72002a20004271d5","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`height`\\n*Decimal, optional*\",\n    \"4-1\": \"The height of the footrest of the product\",\n    \"4-2\": \"\",\n    \"5-0\": \"`back_rail_height`\\n*Decimal, optional*\",\n    \"5-1\": \"The height of the back rail for the frame of the product\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"height\\\": 123.32,\\n  \\\"back_rail_height\\\": 12.44\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T19:00:59.649Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":13,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"frame-component","sync_unique":"","title":"Frame Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Frame Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The height of the footrest of the product", "4-2": "", "5-0": "`back_rail_height`\n*Decimal, optional*", "5-1": "The height of the back rail for the frame of the product" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"height\": 123.32,\n \"back_rail_height\": 12.44\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The height of the footrest of the product", "4-2": "", "5-0": "`back_rail_height`\n*Decimal, optional*", "5-1": "The height of the back rail for the frame of the product" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"height\": 123.32,\n \"back_rail_height\": 12.44\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"573624b52604fb0e000bd065","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`kind`\\n*String, optional*\",\n    \"4-1\": \"The kind of glass used for the product\",\n    \"4-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"kind\\\": \\\"blue-stained\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T19:02:13.907Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":14,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"glass-component","sync_unique":"","title":"Glass Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Glass Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`kind`\n*String, optional*", "4-1": "The kind of glass used for the product", "4-2": "" }, "cols": 2, "rows": 5 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"kind\": \"blue-stained\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`kind`\n*String, optional*", "4-1": "The kind of glass used for the product", "4-2": "" }, "cols": 2, "rows": 5 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"kind\": \"blue-stained\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"5736250dc5389729004dfbcc","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`height`\\n*Decimal, optional*\",\n    \"4-1\": \"The height of the headboard of the product\",\n    \"4-2\": \"\",\n    \"5-0\": \"`width`\\n*Decimal, optional*\",\n    \"5-1\": \"The width of the headboard of the product\",\n    \"6-0\": \"`depth`\\n*Decimal, optional*\",\n    \"6-1\": \"The depth of the headboard or the product\",\n    \"7-0\": \"`floor_clearance`\\n*Decimal, optional*\",\n    \"7-1\": \"The necessary floor clearance required for the headboard of the product\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"height\\\": 123.32,\\n  \\\"width\\\": 456.789,\\n  \\\"depth\\\": 13.37,\\n  \\\"floor_clearance\\\": 12.23\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T19:03:41.911Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":15,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"headboard-component","sync_unique":"","title":"Headboard Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Headboard Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The height of the headboard of the product", "4-2": "", "5-0": "`width`\n*Decimal, optional*", "5-1": "The width of the headboard of the product", "6-0": "`depth`\n*Decimal, optional*", "6-1": "The depth of the headboard or the product", "7-0": "`floor_clearance`\n*Decimal, optional*", "7-1": "The necessary floor clearance required for the headboard of the product" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"height\": 123.32,\n \"width\": 456.789,\n \"depth\": 13.37,\n \"floor_clearance\": 12.23\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The height of the headboard of the product", "4-2": "", "5-0": "`width`\n*Decimal, optional*", "5-1": "The width of the headboard of the product", "6-0": "`depth`\n*Decimal, optional*", "6-1": "The depth of the headboard or the product", "7-0": "`floor_clearance`\n*Decimal, optional*", "7-1": "The necessary floor clearance required for the headboard of the product" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"height\": 123.32,\n \"width\": 456.789,\n \"depth\": 13.37,\n \"floor_clearance\": 12.23\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"57362559ccff861700d09596","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`height`\\n*Decimal, optional*\",\n    \"4-1\": \"The interior height of the product\",\n    \"4-2\": \"\",\n    \"5-0\": \"`width`\\n*Decimal, optional*\",\n    \"5-1\": \"The interior width of the product\",\n    \"6-0\": \"`depth`\\n*Decimal, optional*\",\n    \"6-1\": \"The interior depth of the product\"\n  },\n  \"cols\": 2,\n  \"rows\": 7\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"height\\\": 123.32,\\n  \\\"width\\\": 456.789,\\n  \\\"depth\\\": 13.37\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T19:04:57.171Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":16,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"interior-dimension-component","sync_unique":"","title":"Interior Dimension Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Interior Dimension Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The interior height of the product", "4-2": "", "5-0": "`width`\n*Decimal, optional*", "5-1": "The interior width of the product", "6-0": "`depth`\n*Decimal, optional*", "6-1": "The interior depth of the product" }, "cols": 2, "rows": 7 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"height\": 123.32,\n \"width\": 456.789,\n \"depth\": 13.37\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The interior height of the product", "4-2": "", "5-0": "`width`\n*Decimal, optional*", "5-1": "The interior width of the product", "6-0": "`depth`\n*Decimal, optional*", "6-1": "The interior depth of the product" }, "cols": 2, "rows": 7 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"height\": 123.32,\n \"width\": 456.789,\n \"depth\": 13.37\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"57362754b1175a17002c747b","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`kind`\\n*String, optional*\",\n    \"4-1\": \"The kind of leather used for the product\",\n    \"4-2\": \"\",\n    \"5-0\": \"`pattern_number`\\n*String, optional*\",\n    \"5-1\": \"The pattern number for the leather used for the product\",\n    \"6-0\": \"`hide_size`\\n*Decimal, optional*\",\n    \"6-1\": \"The size of the leather hide used\",\n    \"7-0\": \"`finish`\\n*String, optional*\",\n    \"7-1\": \"The finish applied to the leather on the product\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"kind\\\": \\\"\\\",\\n  \\\"pattern_number\\\": \\\"14-DA3P3\\\",\\n  \\\"hide_size\\\": 12.33,\\n  \\\"finish\\\": null\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T19:13:24.072Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":17,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"leather-component","sync_unique":"","title":"Leather Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Leather Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`kind`\n*String, optional*", "4-1": "The kind of leather used for the product", "4-2": "", "5-0": "`pattern_number`\n*String, optional*", "5-1": "The pattern number for the leather used for the product", "6-0": "`hide_size`\n*Decimal, optional*", "6-1": "The size of the leather hide used", "7-0": "`finish`\n*String, optional*", "7-1": "The finish applied to the leather on the product" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"kind\": \"\",\n \"pattern_number\": \"14-DA3P3\",\n \"hide_size\": 12.33,\n \"finish\": null\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`kind`\n*String, optional*", "4-1": "The kind of leather used for the product", "4-2": "", "5-0": "`pattern_number`\n*String, optional*", "5-1": "The pattern number for the leather used for the product", "6-0": "`hide_size`\n*Decimal, optional*", "6-1": "The size of the leather hide used", "7-0": "`finish`\n*String, optional*", "7-1": "The finish applied to the leather on the product" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"kind\": \"\",\n \"pattern_number\": \"14-DA3P3\",\n \"hide_size\": 12.33,\n \"finish\": null\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"57362858aa119f290007d0ce","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`custom_size`\\n*Boolean, optional*\",\n    \"4-1\": \"Indicate if a custom size is used\",\n    \"4-2\": \"\",\n    \"5-0\": \"`scale`\\n*String, optional*\",\n    \"5-1\": \"The scale of the rug pattern\",\n    \"6-0\": \"`shape`\\n*Multivalue, optional*\",\n    \"6-1\": \"The shape of the rug pattern in use\",\n    \"7-0\": \"`color`\\n*Multivalue, optional*\",\n    \"7-1\": \"The color of the rug pattern\",\n    \"8-0\": \"`style`\\n*Multivalue, optional*\",\n    \"8-1\": \"The style of the rug pattern\"\n  },\n  \"cols\": 2,\n  \"rows\": 9\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"custom_size\\\": false,\\n  \\\"scale\\\": \\\"x2\\\",\\n  \\\"shape\\\": [],\\n  \\\"color\\\": [],\\n  \\\"style\\\": []\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T19:17:44.008Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":18,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"rug-pattern-component","sync_unique":"","title":"Rug Pattern Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Rug Pattern Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`custom_size`\n*Boolean, optional*", "4-1": "Indicate if a custom size is used", "4-2": "", "5-0": "`scale`\n*String, optional*", "5-1": "The scale of the rug pattern", "6-0": "`shape`\n*Multivalue, optional*", "6-1": "The shape of the rug pattern in use", "7-0": "`color`\n*Multivalue, optional*", "7-1": "The color of the rug pattern", "8-0": "`style`\n*Multivalue, optional*", "8-1": "The style of the rug pattern" }, "cols": 2, "rows": 9 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"custom_size\": false,\n \"scale\": \"x2\",\n \"shape\": [],\n \"color\": [],\n \"style\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`custom_size`\n*Boolean, optional*", "4-1": "Indicate if a custom size is used", "4-2": "", "5-0": "`scale`\n*String, optional*", "5-1": "The scale of the rug pattern", "6-0": "`shape`\n*Multivalue, optional*", "6-1": "The shape of the rug pattern in use", "7-0": "`color`\n*Multivalue, optional*", "7-1": "The color of the rug pattern", "8-0": "`style`\n*Multivalue, optional*", "8-1": "The style of the rug pattern" }, "cols": 2, "rows": 9 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"custom_size\": false,\n \"scale\": \"x2\",\n \"shape\": [],\n \"color\": [],\n \"style\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"573628cc5ede292900c8e289","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`content`\\n*String, optional*\",\n    \"4-1\": \"\",\n    \"4-2\": \"\",\n    \"5-0\": \"`backing`\\n*String, optional*\",\n    \"5-1\": \"\",\n    \"6-0\": \"`construction`\\n*Multivalue, optional*\",\n    \"6-1\": \"\",\n    \"7-0\": \"`material`\\n*Multivalue, optional*\",\n    \"7-1\": \"The material used to construct the rug of the product\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"content\\\": \\\"\\\",\\n  \\\"backing\\\": \\\"\\\",\\n  \\\"construction\\\": [],\\n  \\\"material\\\": []\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T19:19:40.643Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":19,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"rug-construction-component","sync_unique":"","title":"Rug Construction Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Rug Construction Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`content`\n*String, optional*", "4-1": "", "4-2": "", "5-0": "`backing`\n*String, optional*", "5-1": "", "6-0": "`construction`\n*Multivalue, optional*", "6-1": "", "7-0": "`material`\n*Multivalue, optional*", "7-1": "The material used to construct the rug of the product" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"content\": \"\",\n \"backing\": \"\",\n \"construction\": [],\n \"material\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`content`\n*String, optional*", "4-1": "", "4-2": "", "5-0": "`backing`\n*String, optional*", "5-1": "", "6-0": "`construction`\n*Multivalue, optional*", "6-1": "", "7-0": "`material`\n*Multivalue, optional*", "7-1": "The material used to construct the rug of the product" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"content\": \"\",\n \"backing\": \"\",\n \"construction\": [],\n \"material\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"573630dfda06991700865d32","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`pattern_number`\\n*String, optional*\",\n    \"4-1\": \"Number used for representing/identifying the pattern\",\n    \"4-2\": \"\",\n    \"5-0\": \"`vertical_repeat`\\n*Decimal, optional*\",\n    \"5-1\": \"\",\n    \"6-0\": \"`horizontal_repeat`\\n*Decimal, optional*\",\n    \"6-1\": \"\",\n    \"7-0\": \"`direction`\\n*String, optional*\",\n    \"7-1\": \"The direction the pattern flows\",\n    \"8-0\": \"`color`\\n*Multivalue, optional*\",\n    \"8-1\": \"The colors used in the pattern\",\n    \"9-0\": \"`scale`\\n*String, optional*\",\n    \"10-0\": \"`design_type`\\n*Multivalue, optional*\",\n    \"10-1\": \"The type of design used in the pattern\"\n  },\n  \"cols\": 2,\n  \"rows\": 11\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"pattern_number\\\": \\\"3m5o1LA9d\\\",\\n  \\\"vertical_repeat\\\": 1.23,\\n  \\\"horizontal_repeat\\\": 9.87,\\n  \\\"direction\\\": \\\"left to bottom-right\\\",\\n  \\\"color\\\": [],\\n  \\\"scale\\\": null,\\n  \\\"design_type\\\": []\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T19:54:07.313Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":20,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"pattern-component","sync_unique":"","title":"Pattern Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Pattern Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`pattern_number`\n*String, optional*", "4-1": "Number used for representing/identifying the pattern", "4-2": "", "5-0": "`vertical_repeat`\n*Decimal, optional*", "5-1": "", "6-0": "`horizontal_repeat`\n*Decimal, optional*", "6-1": "", "7-0": "`direction`\n*String, optional*", "7-1": "The direction the pattern flows", "8-0": "`color`\n*Multivalue, optional*", "8-1": "The colors used in the pattern", "9-0": "`scale`\n*String, optional*", "10-0": "`design_type`\n*Multivalue, optional*", "10-1": "The type of design used in the pattern" }, "cols": 2, "rows": 11 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"pattern_number\": \"3m5o1LA9d\",\n \"vertical_repeat\": 1.23,\n \"horizontal_repeat\": 9.87,\n \"direction\": \"left to bottom-right\",\n \"color\": [],\n \"scale\": null,\n \"design_type\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`pattern_number`\n*String, optional*", "4-1": "Number used for representing/identifying the pattern", "4-2": "", "5-0": "`vertical_repeat`\n*Decimal, optional*", "5-1": "", "6-0": "`horizontal_repeat`\n*Decimal, optional*", "6-1": "", "7-0": "`direction`\n*String, optional*", "7-1": "The direction the pattern flows", "8-0": "`color`\n*Multivalue, optional*", "8-1": "The colors used in the pattern", "9-0": "`scale`\n*String, optional*", "10-0": "`design_type`\n*Multivalue, optional*", "10-1": "The type of design used in the pattern" }, "cols": 2, "rows": 11 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"pattern_number\": \"3m5o1LA9d\",\n \"vertical_repeat\": 1.23,\n \"horizontal_repeat\": 9.87,\n \"direction\": \"left to bottom-right\",\n \"color\": [],\n \"scale\": null,\n \"design_type\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"5736318dcacfa619004f6ce6","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`height`\\n*Decimal, optional*\",\n    \"4-1\": \"The height of the pedestal used in the product\",\n    \"4-2\": \"\",\n    \"5-0\": \"`width`\\n*Decimal, optional*\",\n    \"5-1\": \"The width of the pedestal used in the product\",\n    \"6-0\": \"`depth`\\n*Decimal, optional*\",\n    \"6-1\": \"The depth of the pedestal used in the product\",\n    \"7-0\": \"`diameter`\\n*Decimal, optional*\",\n    \"7-1\": \"The diameter of the pedestal used in the product\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"pattern_number\\\": \\\"3m5o1LA9d\\\",\\n  \\\"height\\\": 12.32,\\n  \\\"width\\\": 13.00,\\n  \\\"depth\\\": 1.87,\\n  \\\"diameter\\\": 3.00\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T19:57:01.540Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":21,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"pedestal-component","sync_unique":"","title":"Pedestal Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Pedestal Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The height of the pedestal used in the product", "4-2": "", "5-0": "`width`\n*Decimal, optional*", "5-1": "The width of the pedestal used in the product", "6-0": "`depth`\n*Decimal, optional*", "6-1": "The depth of the pedestal used in the product", "7-0": "`diameter`\n*Decimal, optional*", "7-1": "The diameter of the pedestal used in the product" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"pattern_number\": \"3m5o1LA9d\",\n \"height\": 12.32,\n \"width\": 13.00,\n \"depth\": 1.87,\n \"diameter\": 3.00\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The height of the pedestal used in the product", "4-2": "", "5-0": "`width`\n*Decimal, optional*", "5-1": "The width of the pedestal used in the product", "6-0": "`depth`\n*Decimal, optional*", "6-1": "The depth of the pedestal used in the product", "7-0": "`diameter`\n*Decimal, optional*", "7-1": "The diameter of the pedestal used in the product" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"pattern_number\": \"3m5o1LA9d\",\n \"height\": 12.32,\n \"width\": 13.00,\n \"depth\": 1.87,\n \"diameter\": 3.00\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"573631becacfa619004f6cea","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`quantity`\\n*Integer, optional*\",\n    \"4-1\": \"The number of pillows included with the product\",\n    \"4-2\": \"\",\n    \"5-0\": \"`pillow_list`\\n*Objects, optional*\",\n    \"5-1\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"quantity\\\": 3,\\n  \\\"pillow_list\\\": []\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T19:57:50.149Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":22,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"pillows-component","sync_unique":"","title":"Pillows Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Pillows Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`quantity`\n*Integer, optional*", "4-1": "The number of pillows included with the product", "4-2": "", "5-0": "`pillow_list`\n*Objects, optional*", "5-1": "" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"quantity\": 3,\n \"pillow_list\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`quantity`\n*Integer, optional*", "4-1": "The number of pillows included with the product", "4-2": "", "5-0": "`pillow_list`\n*Objects, optional*", "5-1": "" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"quantity\": 3,\n \"pillow_list\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"57363202f8ebd31700769ee0","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`height`\\n*Decimal, optional*\",\n    \"4-1\": \"The height of the seat used in the product\",\n    \"4-2\": \"\",\n    \"5-0\": \"`width`\\n*Decimal, optional*\",\n    \"5-1\": \"The width of the seat used in the product\",\n    \"6-0\": \"`depth`\\n*Decimal, optional*\",\n    \"6-1\": \"The depth of the seat used in the product\",\n    \"7-0\": \"`construction`\\n*String, optional*\",\n    \"7-1\": \"The construction of the seat used in the product\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"pattern_number\\\": \\\"3m5o1LA9d\\\",\\n  \\\"height\\\": 12.32,\\n  \\\"width\\\": 13.00,\\n  \\\"depth\\\": 1.87,\\n  \\\"construction\\\": \\\"Wooden frame, metal screws\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T19:58:58.590Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":23,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"seat-component","sync_unique":"","title":"Seat Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Seat Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The height of the seat used in the product", "4-2": "", "5-0": "`width`\n*Decimal, optional*", "5-1": "The width of the seat used in the product", "6-0": "`depth`\n*Decimal, optional*", "6-1": "The depth of the seat used in the product", "7-0": "`construction`\n*String, optional*", "7-1": "The construction of the seat used in the product" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"pattern_number\": \"3m5o1LA9d\",\n \"height\": 12.32,\n \"width\": 13.00,\n \"depth\": 1.87,\n \"construction\": \"Wooden frame, metal screws\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The height of the seat used in the product", "4-2": "", "5-0": "`width`\n*Decimal, optional*", "5-1": "The width of the seat used in the product", "6-0": "`depth`\n*Decimal, optional*", "6-1": "The depth of the seat used in the product", "7-0": "`construction`\n*String, optional*", "7-1": "The construction of the seat used in the product" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"pattern_number\": \"3m5o1LA9d\",\n \"height\": 12.32,\n \"width\": 13.00,\n \"depth\": 1.87,\n \"construction\": \"Wooden frame, metal screws\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"573634b1a12ae12000774f7d","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`height`\\n*Decimal, optional*\",\n    \"4-1\": \"The height of the shade used in the product\",\n    \"4-2\": \"\",\n    \"5-0\": \"`width`\\n*Decimal, optional*\",\n    \"5-1\": \"The width of the shade used in the product\",\n    \"6-0\": \"`depth`\\n*Decimal, optional*\",\n    \"6-1\": \"The depth of the shade used in the product\",\n    \"7-0\": \"`diameter`\\n*Decimal, optional*\",\n    \"7-1\": \"The diameter of the shade used in the product\",\n    \"8-0\": \"`material`\\n*String, optional*\",\n    \"8-1\": \"The material used to construct the shade\",\n    \"9-0\": \"`quantity`\\n*Integer, optional*\",\n    \"9-1\": \"The quantity of shades included with the product\"\n  },\n  \"cols\": 2,\n  \"rows\": 10\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"pattern_number\\\": \\\"3m5o1LA9d\\\",\\n  \\\"height\\\": 12.32,\\n  \\\"width\\\": 13.00,\\n  \\\"depth\\\": 1.87,\\n  \\\"diameter\\\": 3.00,\\n  \\\"material\\\": \\\"cloth\\\",\\n  \\\"quantity\\\": 1\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T20:10:25.988Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":24,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"shade-component","sync_unique":"","title":"Shade Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Shade Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The height of the shade used in the product", "4-2": "", "5-0": "`width`\n*Decimal, optional*", "5-1": "The width of the shade used in the product", "6-0": "`depth`\n*Decimal, optional*", "6-1": "The depth of the shade used in the product", "7-0": "`diameter`\n*Decimal, optional*", "7-1": "The diameter of the shade used in the product", "8-0": "`material`\n*String, optional*", "8-1": "The material used to construct the shade", "9-0": "`quantity`\n*Integer, optional*", "9-1": "The quantity of shades included with the product" }, "cols": 2, "rows": 10 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"pattern_number\": \"3m5o1LA9d\",\n \"height\": 12.32,\n \"width\": 13.00,\n \"depth\": 1.87,\n \"diameter\": 3.00,\n \"material\": \"cloth\",\n \"quantity\": 1\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The height of the shade used in the product", "4-2": "", "5-0": "`width`\n*Decimal, optional*", "5-1": "The width of the shade used in the product", "6-0": "`depth`\n*Decimal, optional*", "6-1": "The depth of the shade used in the product", "7-0": "`diameter`\n*Decimal, optional*", "7-1": "The diameter of the shade used in the product", "8-0": "`material`\n*String, optional*", "8-1": "The material used to construct the shade", "9-0": "`quantity`\n*Integer, optional*", "9-1": "The quantity of shades included with the product" }, "cols": 2, "rows": 10 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"pattern_number\": \"3m5o1LA9d\",\n \"height\": 12.32,\n \"width\": 13.00,\n \"depth\": 1.87,\n \"diameter\": 3.00,\n \"material\": \"cloth\",\n \"quantity\": 1\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"573635993d00df0e00ef10a1","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`quantity`\\n*Integer, optional*\",\n    \"4-1\": \"The number of shelves included with the product\",\n    \"4-2\": \"\",\n    \"5-0\": \"`shelf_list`\\n*Objects, optional*\",\n    \"5-1\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"quantity\\\": 3,\\n  \\\"shelf_list\\\": []\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T20:14:17.045Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":25,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"shelves-component","sync_unique":"","title":"Shelves Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Shelves Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`quantity`\n*Integer, optional*", "4-1": "The number of shelves included with the product", "4-2": "", "5-0": "`shelf_list`\n*Objects, optional*", "5-1": "" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"quantity\": 3,\n \"shelf_list\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`quantity`\n*Integer, optional*", "4-1": "The number of shelves included with the product", "4-2": "", "5-0": "`shelf_list`\n*Objects, optional*", "5-1": "" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"quantity\": 3,\n \"shelf_list\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"573635f1be10a920003072ea","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`length`\\n*Decimal, optional*\",\n    \"4-1\": \"The length of the side rail\",\n    \"4-2\": \"\",\n    \"5-0\": \"`floor_clearance`\\n*Decimal, optional*\",\n    \"5-1\": \"The clearance between the floor and the side rail\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"length\\\": 2.12,\\n  \\\"floor_clearance\\\": 4.45\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T20:15:45.714Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":26,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"side-rail-component","sync_unique":"","title":"Side Rail Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Side Rail Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`length`\n*Decimal, optional*", "4-1": "The length of the side rail", "4-2": "", "5-0": "`floor_clearance`\n*Decimal, optional*", "5-1": "The clearance between the floor and the side rail" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"length\": 2.12,\n \"floor_clearance\": 4.45\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`length`\n*Decimal, optional*", "4-1": "The length of the side rail", "4-2": "", "5-0": "`floor_clearance`\n*Decimal, optional*", "5-1": "The clearance between the floor and the side rail" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"length\": 2.12,\n \"floor_clearance\": 4.45\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":2,"_id":"57363620be10a920003072ed","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`support_type`\\n*String, optional*\",\n    \"4-1\": \"The type of support used\",\n    \"4-2\": \"\",\n    \"5-0\": \"`canopy_height`\\n*Decimal, optional*\",\n    \"5-1\": \"The height of the canopy of the suspension point\",\n    \"6-0\": \"`canopy_width`\\n*Decimal, optional*\",\n    \"6-1\": \"The width of the canopy of the suspension point\",\n    \"7-0\": \"`canopy_depth`\\n*Decimal, optional*\",\n    \"7-1\": \"The depth of the canopy of the suspension point\",\n    \"8-0\": \"`canopy_diameter`\\n*Decimal, optional*\",\n    \"8-1\": \"The diameter of the canopy of the suspension point\",\n    \"9-0\": \"`wire_length`\\n*Decimal, optional*\",\n    \"9-1\": \"\",\n    \"10-0\": \"`minimum_hanging_length`\\n*Decimal, optional*\",\n    \"10-1\": \"The minimum length the for hanging possible\",\n    \"11-0\": \"`maximum_hanging_length`\\n*Decimal, optional*\",\n    \"11-1\": \"The maximum length the for hanging possible\",\n    \"12-0\": \"`chain_length`\\n*Decimal, optional*\",\n    \"12-1\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 13\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"support_type\\\": \\\"chain\\\",\\n  \\\"canopy_height\\\": 12.22,\\n  \\\"canopy_width\\\": 12.00,\\n  \\\"canopy_depth\\\": 2.00,\\n  \\\"canopy_diameter\\\": 3.14,\\n  \\\"wire_length\\\": 1.11,\\n  \\\"minimum_hanging_length\\\": 5.34,\\n  \\\"maximum_hanging_length\\\": 8.23,\\n  \\\"chain_length\\\": 1.15\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T20:16:32.241Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":27,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"suspension-point-component","sync_unique":"","title":"Suspension Point Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Suspension Point Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`support_type`\n*String, optional*", "4-1": "The type of support used", "4-2": "", "5-0": "`canopy_height`\n*Decimal, optional*", "5-1": "The height of the canopy of the suspension point", "6-0": "`canopy_width`\n*Decimal, optional*", "6-1": "The width of the canopy of the suspension point", "7-0": "`canopy_depth`\n*Decimal, optional*", "7-1": "The depth of the canopy of the suspension point", "8-0": "`canopy_diameter`\n*Decimal, optional*", "8-1": "The diameter of the canopy of the suspension point", "9-0": "`wire_length`\n*Decimal, optional*", "9-1": "", "10-0": "`minimum_hanging_length`\n*Decimal, optional*", "10-1": "The minimum length the for hanging possible", "11-0": "`maximum_hanging_length`\n*Decimal, optional*", "11-1": "The maximum length the for hanging possible", "12-0": "`chain_length`\n*Decimal, optional*", "12-1": "" }, "cols": 2, "rows": 13 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"support_type\": \"chain\",\n \"canopy_height\": 12.22,\n \"canopy_width\": 12.00,\n \"canopy_depth\": 2.00,\n \"canopy_diameter\": 3.14,\n \"wire_length\": 1.11,\n \"minimum_hanging_length\": 5.34,\n \"maximum_hanging_length\": 8.23,\n \"chain_length\": 1.15\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`support_type`\n*String, optional*", "4-1": "The type of support used", "4-2": "", "5-0": "`canopy_height`\n*Decimal, optional*", "5-1": "The height of the canopy of the suspension point", "6-0": "`canopy_width`\n*Decimal, optional*", "6-1": "The width of the canopy of the suspension point", "7-0": "`canopy_depth`\n*Decimal, optional*", "7-1": "The depth of the canopy of the suspension point", "8-0": "`canopy_diameter`\n*Decimal, optional*", "8-1": "The diameter of the canopy of the suspension point", "9-0": "`wire_length`\n*Decimal, optional*", "9-1": "", "10-0": "`minimum_hanging_length`\n*Decimal, optional*", "10-1": "The minimum length the for hanging possible", "11-0": "`maximum_hanging_length`\n*Decimal, optional*", "11-1": "The maximum length the for hanging possible", "12-0": "`chain_length`\n*Decimal, optional*", "12-1": "" }, "cols": 2, "rows": 13 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"support_type\": \"chain\",\n \"canopy_height\": 12.22,\n \"canopy_width\": 12.00,\n \"canopy_depth\": 2.00,\n \"canopy_diameter\": 3.14,\n \"wire_length\": 1.11,\n \"minimum_hanging_length\": 5.34,\n \"maximum_hanging_length\": 8.23,\n \"chain_length\": 1.15\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"57363785be10a920003072f5","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`quantity`\\n*Integer, optional*\",\n    \"4-1\": \"The number of doors included with the product\",\n    \"4-2\": \"\",\n    \"5-0\": \"`table_leaf_list`\\n*Objects, optional*\",\n    \"5-1\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"quantity\\\": 3,\\n  \\\"table_leaf_list\\\": []\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T20:22:29.455Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":28,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"table-leaves-component","sync_unique":"","title":"Table Leaves Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Table Leaves Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`quantity`\n*Integer, optional*", "4-1": "The number of doors included with the product", "4-2": "", "5-0": "`table_leaf_list`\n*Objects, optional*", "5-1": "" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"quantity\": 3,\n \"table_leaf_list\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`quantity`\n*Integer, optional*", "4-1": "The number of doors included with the product", "4-2": "", "5-0": "`table_leaf_list`\n*Objects, optional*", "5-1": "" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"quantity\": 3,\n \"table_leaf_list\": []\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":1,"_id":"573638283d00df0e00ef10a6","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \":fa-ban: Not applicable\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`content`\\n*String, optional*\",\n    \"4-1\": \"\",\n    \"4-2\": \"\",\n    \"5-0\": \"`weave_type`\\n*Multivalue, optional*\",\n    \"5-1\": \"The type of weave used for the textile\",\n    \"6-0\": \"`width`\\n*Decimal, optional*\",\n    \"6-1\": \"The width of the textile\",\n    \"7-0\": \"`treatment`\\n*String, optional*\",\n    \"7-1\": \"The teatment type used on the textile\",\n    \"8-0\": \"`usage`\\n*String, optional*\",\n    \"8-1\": \"\",\n    \"9-0\": \"`grade`\\n*String, optional*\"\n  },\n  \"cols\": 2,\n  \"rows\": 10\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": null,\\n  \\\"parent_name\\\": null,\\n  \\\"content\\\": null,\\n  \\\"weave_type\\\": [],\\n  \\\"width\\\": 3.4,\\n  \\\"treatment\\\": \\\"\\\",\\n  \\\"usage\\\": \\\"blah blah blah\\\",\\n  \\\"grade\\\": \\\"Grade A+\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef2f4e3f892b00767edf","createdAt":"2016-05-13T20:25:12.902Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":29,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"textile-component","sync_unique":"","title":"Textile Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Textile Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`content`\n*String, optional*", "4-1": "", "4-2": "", "5-0": "`weave_type`\n*Multivalue, optional*", "5-1": "The type of weave used for the textile", "6-0": "`width`\n*Decimal, optional*", "6-1": "The width of the textile", "7-0": "`treatment`\n*String, optional*", "7-1": "The teatment type used on the textile", "8-0": "`usage`\n*String, optional*", "8-1": "", "9-0": "`grade`\n*String, optional*" }, "cols": 2, "rows": 10 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"content\": null,\n \"weave_type\": [],\n \"width\": 3.4,\n \"treatment\": \"\",\n \"usage\": \"blah blah blah\",\n \"grade\": \"Grade A+\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": ":fa-ban: Not applicable", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`content`\n*String, optional*", "4-1": "", "4-2": "", "5-0": "`weave_type`\n*Multivalue, optional*", "5-1": "The type of weave used for the textile", "6-0": "`width`\n*Decimal, optional*", "6-1": "The width of the textile", "7-0": "`treatment`\n*String, optional*", "7-1": "The teatment type used on the textile", "8-0": "`usage`\n*String, optional*", "8-1": "", "9-0": "`grade`\n*String, optional*" }, "cols": 2, "rows": 10 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": null,\n \"parent_name\": null,\n \"content\": null,\n \"weave_type\": [],\n \"width\": 3.4,\n \"treatment\": \"\",\n \"usage\": \"blah blah blah\",\n \"grade\": \"Grade A+\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":4,"_id":"5739d4e62886c632003591b4","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \"ID of the [Shipping Information Component](doc:shipping-information-component) parent\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`weight`\\n*Decimal, optional*\",\n    \"4-1\": \"The weight of the packaged box\",\n    \"4-2\": \"\",\n    \"5-0\": \"`width`\\n*Decimal, optional*\",\n    \"5-1\": \"The width of the packaged box\",\n    \"6-0\": \"`height`\\n*Decimal, optional*\",\n    \"6-1\": \"The height of the packaged box\",\n    \"7-0\": \"`depth`\\n*Decimal, optional*\",\n    \"7-1\": \"The depth of the packaged box\",\n    \"8-0\": \"`quantity`\\n*Integer, optional*\",\n    \"8-1\": \"\",\n    \"9-0\": \"`volume`\\n*Decimal, optional*\",\n    \"9-1\": \"The volume of the packaged box\"\n  },\n  \"cols\": 2,\n  \"rows\": 10\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": 704,\\n  \\\"parent_name\\\": null,\\n  \\\"weight\\\": 312.12,\\n  \\\"width\\\": 3.43,\\n  \\\"height\\\": 31.213,\\n  \\\"depth\\\": 1.3,\\n  \\\"quantity\\\": 2,\\n  \\\"volume\\\": 21.21\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef404e3f892b00767ee1","createdAt":"2016-05-16T14:10:46.274Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"box-component","sync_unique":"","title":"Box Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Box Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": "ID of the [Shipping Information Component](doc:shipping-information-component) parent", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`weight`\n*Decimal, optional*", "4-1": "The weight of the packaged box", "4-2": "", "5-0": "`width`\n*Decimal, optional*", "5-1": "The width of the packaged box", "6-0": "`height`\n*Decimal, optional*", "6-1": "The height of the packaged box", "7-0": "`depth`\n*Decimal, optional*", "7-1": "The depth of the packaged box", "8-0": "`quantity`\n*Integer, optional*", "8-1": "", "9-0": "`volume`\n*Decimal, optional*", "9-1": "The volume of the packaged box" }, "cols": 2, "rows": 10 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": 704,\n \"parent_name\": null,\n \"weight\": 312.12,\n \"width\": 3.43,\n \"height\": 31.213,\n \"depth\": 1.3,\n \"quantity\": 2,\n \"volume\": 21.21\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": "ID of the [Shipping Information Component](doc:shipping-information-component) parent", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`weight`\n*Decimal, optional*", "4-1": "The weight of the packaged box", "4-2": "", "5-0": "`width`\n*Decimal, optional*", "5-1": "The width of the packaged box", "6-0": "`height`\n*Decimal, optional*", "6-1": "The height of the packaged box", "7-0": "`depth`\n*Decimal, optional*", "7-1": "The depth of the packaged box", "8-0": "`quantity`\n*Integer, optional*", "8-1": "", "9-0": "`volume`\n*Decimal, optional*", "9-1": "The volume of the packaged box" }, "cols": 2, "rows": 10 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": 704,\n \"parent_name\": null,\n \"weight\": 312.12,\n \"width\": 3.43,\n \"height\": 31.213,\n \"depth\": 1.3,\n \"quantity\": 2,\n \"volume\": 21.21\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":5,"_id":"5739d74604e7b4200007c003","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"This component is a child of the [Cushions Component](doc:cushions-component)\",\n  \"title\": \"Child Component\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \"ID of the [Cushions Component](doc:cushions-component) parent\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`fill`\\n*String, optional*\",\n    \"4-1\": \"The filler of the cushion\",\n    \"4-2\": \"\",\n    \"6-0\": \"`height`\\n*Decimal, optional*\",\n    \"6-1\": \"The height of the packaged cushion\",\n    \"7-0\": \"`width`\\n*Decimal, optional*\",\n    \"7-1\": \"The width of the packaged cushion\",\n    \"8-0\": \"`depth`\\n*Decimal, optional*\",\n    \"8-1\": \"The depth of the packaged cushion\",\n    \"9-0\": \"`quantity`\\n*Integer, optional*\",\n    \"9-1\": \"\",\n    \"5-0\": \"`style`\\n*String, optional*\",\n    \"5-1\": \"The style of the cushion\"\n  },\n  \"cols\": 2,\n  \"rows\": 10\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": 658,\\n  \\\"parent_name\\\": null,\\n  \\\"fill\\\": \\\"Feathers\\\",\\n  \\\"style\\\": null,\\n  \\\"height\\\": 31.213,\\n  \\\"width\\\": 3.43,\\n  \\\"quantity\\\": 2,\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef404e3f892b00767ee1","createdAt":"2016-05-16T14:20:54.560Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"cushion-component","sync_unique":"","title":"Cushion Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Cushion Component


[block:callout] { "type": "info", "body": "This component is a child of the [Cushions Component](doc:cushions-component)", "title": "Child Component" } [/block] [block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": "ID of the [Cushions Component](doc:cushions-component) parent", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`fill`\n*String, optional*", "4-1": "The filler of the cushion", "4-2": "", "6-0": "`height`\n*Decimal, optional*", "6-1": "The height of the packaged cushion", "7-0": "`width`\n*Decimal, optional*", "7-1": "The width of the packaged cushion", "8-0": "`depth`\n*Decimal, optional*", "8-1": "The depth of the packaged cushion", "9-0": "`quantity`\n*Integer, optional*", "9-1": "", "5-0": "`style`\n*String, optional*", "5-1": "The style of the cushion" }, "cols": 2, "rows": 10 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": 658,\n \"parent_name\": null,\n \"fill\": \"Feathers\",\n \"style\": null,\n \"height\": 31.213,\n \"width\": 3.43,\n \"quantity\": 2,\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:callout] { "type": "info", "body": "This component is a child of the [Cushions Component](doc:cushions-component)", "title": "Child Component" } [/block] [block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": "ID of the [Cushions Component](doc:cushions-component) parent", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`fill`\n*String, optional*", "4-1": "The filler of the cushion", "4-2": "", "6-0": "`height`\n*Decimal, optional*", "6-1": "The height of the packaged cushion", "7-0": "`width`\n*Decimal, optional*", "7-1": "The width of the packaged cushion", "8-0": "`depth`\n*Decimal, optional*", "8-1": "The depth of the packaged cushion", "9-0": "`quantity`\n*Integer, optional*", "9-1": "", "5-0": "`style`\n*String, optional*", "5-1": "The style of the cushion" }, "cols": 2, "rows": 10 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": 658,\n \"parent_name\": null,\n \"fill\": \"Feathers\",\n \"style\": null,\n \"height\": 31.213,\n \"width\": 3.43,\n \"quantity\": 2,\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":4,"_id":"5739d7a4115124290001ef28","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"This component is a child of the [Doors Component](doc:doors-component)\",\n  \"title\": \"Child Component\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \"ID of the [Doors Component](doc:doors-component) parent\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`height`\\n*Decimal, optional*\",\n    \"4-1\": \"The height of the door\",\n    \"5-0\": \"`width`\\n*Decimal, optional*\",\n    \"5-1\": \"The width of the door\",\n    \"7-0\": \"`depth`\\n*Decimal, optional*\",\n    \"7-1\": \"The depth of the door\",\n    \"8-0\": \"`quantity`\\n*Integer, optional*\",\n    \"8-1\": \"\",\n    \"6-0\": \"`opening`\\n*Decimal, optional*\",\n    \"6-1\": \"The length of opening for the door\"\n  },\n  \"cols\": 2,\n  \"rows\": 9\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": 302,\\n  \\\"parent_name\\\": null,\\n  \\\"height\\\": 31.213,\\n  \\\"width\\\": 3.43,\\n  \\\"opening\\\":  8.77,\\n  \\\"depth\\\": 123.32,\\n  \\\"quantity\\\": 2,\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef404e3f892b00767ee1","createdAt":"2016-05-16T14:22:28.969Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"door-component","sync_unique":"","title":"Door Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Door Component


[block:callout] { "type": "info", "body": "This component is a child of the [Doors Component](doc:doors-component)", "title": "Child Component" } [/block] [block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": "ID of the [Doors Component](doc:doors-component) parent", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The height of the door", "5-0": "`width`\n*Decimal, optional*", "5-1": "The width of the door", "7-0": "`depth`\n*Decimal, optional*", "7-1": "The depth of the door", "8-0": "`quantity`\n*Integer, optional*", "8-1": "", "6-0": "`opening`\n*Decimal, optional*", "6-1": "The length of opening for the door" }, "cols": 2, "rows": 9 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": 302,\n \"parent_name\": null,\n \"height\": 31.213,\n \"width\": 3.43,\n \"opening\": 8.77,\n \"depth\": 123.32,\n \"quantity\": 2,\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:callout] { "type": "info", "body": "This component is a child of the [Doors Component](doc:doors-component)", "title": "Child Component" } [/block] [block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": "ID of the [Doors Component](doc:doors-component) parent", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The height of the door", "5-0": "`width`\n*Decimal, optional*", "5-1": "The width of the door", "7-0": "`depth`\n*Decimal, optional*", "7-1": "The depth of the door", "8-0": "`quantity`\n*Integer, optional*", "8-1": "", "6-0": "`opening`\n*Decimal, optional*", "6-1": "The length of opening for the door" }, "cols": 2, "rows": 9 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": 302,\n \"parent_name\": null,\n \"height\": 31.213,\n \"width\": 3.43,\n \"opening\": 8.77,\n \"depth\": 123.32,\n \"quantity\": 2,\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":3,"_id":"5739d800f764d12b005efdc3","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \"ID of the [Drawers Component](doc:drawers-component) parent\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`height`\\n*Decimal, optional*\",\n    \"4-1\": \"The height of the packaged drawer\",\n    \"5-0\": \"`width`\\n*Decimal, optional*\",\n    \"5-1\": \"The width of the packaged drawer\",\n    \"6-0\": \"`depth`\\n*Decimal, optional*\",\n    \"6-1\": \"The depth of the packaged drawer\",\n    \"7-0\": \"`quantity`\\n*Integer, optional*\",\n    \"7-1\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": 9870,\\n  \\\"parent_name\\\": null,\\n  \\\"height\\\": 31.213,\\n  \\\"width\\\": 3.43,\\n  \\\"depth\\\": 123.32,\\n  \\\"quantity\\\": 2,\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef404e3f892b00767ee1","createdAt":"2016-05-16T14:24:00.421Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"drawer-component","sync_unique":"","title":"Drawer Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Drawer Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": "ID of the [Drawers Component](doc:drawers-component) parent", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The height of the packaged drawer", "5-0": "`width`\n*Decimal, optional*", "5-1": "The width of the packaged drawer", "6-0": "`depth`\n*Decimal, optional*", "6-1": "The depth of the packaged drawer", "7-0": "`quantity`\n*Integer, optional*", "7-1": "" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": 9870,\n \"parent_name\": null,\n \"height\": 31.213,\n \"width\": 3.43,\n \"depth\": 123.32,\n \"quantity\": 2,\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": "ID of the [Drawers Component](doc:drawers-component) parent", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The height of the packaged drawer", "5-0": "`width`\n*Decimal, optional*", "5-1": "The width of the packaged drawer", "6-0": "`depth`\n*Decimal, optional*", "6-1": "The depth of the packaged drawer", "7-0": "`quantity`\n*Integer, optional*", "7-1": "" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": 9870,\n \"parent_name\": null,\n \"height\": 31.213,\n \"width\": 3.43,\n \"depth\": 123.32,\n \"quantity\": 2,\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":3,"_id":"5739d8d99a02111700e05c56","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \"ID of the [Description Component](doc:description-component) parent\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`description`\\n*String, optional*\",\n    \"4-1\": \"A description describing the feature\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": 6767,\\n  \\\"parent_name\\\": null,\\n  \\\"description\\\": \\\"No assembly required\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef404e3f892b00767ee1","createdAt":"2016-05-16T14:27:37.578Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"feature-component","sync_unique":"","title":"Feature Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Feature Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": "ID of the [Description Component](doc:description-component) parent", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`description`\n*String, optional*", "4-1": "A description describing the feature" }, "cols": 2, "rows": 5 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": 6767,\n \"parent_name\": null,\n \"description\": \"No assembly required\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": "ID of the [Description Component](doc:description-component) parent", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`description`\n*String, optional*", "4-1": "A description describing the feature" }, "cols": 2, "rows": 5 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": 6767,\n \"parent_name\": null,\n \"description\": \"No assembly required\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":3,"_id":"5739dab7c02ea60e002276e7","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \"ID of the [Images Component](doc:images-component) parent\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`default`\\n*Boolean, optional*\",\n    \"4-1\": \"Indicates if the image is the default image out of all available product images\",\n    \"5-0\": \"`category`\\n*String Enum, optional*\",\n    \"5-1\": \"The category for the type of image\",\n    \"6-0\": \"`caption`\\n*String, optional*\",\n    \"6-1\": \"The caption for the image\",\n    \"7-0\": \"`description`\\n*String, optional*\",\n    \"7-1\": \"A description for the image\",\n    \"8-0\": \"`full_size`\\n*String*\",\n    \"8-1\": \"The URL to the full-size version of the image\",\n    \"9-0\": \"`large_size`\\n*String, optional*\",\n    \"9-1\": \"The URL to the largest-sized version of the image\",\n    \"10-0\": \"`medium_size`\\n*String, optional*\",\n    \"10-1\": \"The URL to the medium-sized version of the image\",\n    \"11-0\": \"`thumbnail_size`\\n*String, optional*\",\n    \"11-1\": \"The URL to the thumbnail-sized version of the image\"\n  },\n  \"cols\": 2,\n  \"rows\": 12\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": 3243,\\n  \\\"parent_name\\\": null,\\n  \\\"default\\\": true,\\n  \\\"category\\\": \\\"other\\\",\\n  \\\"caption\\\": \\\"Wooden Chair\\\",\\n  \\\"description\\\": \\\"A simple, wooden chair\\\",\\n  \\\"full_size\\\": \\\"http://example.com/image.jpg\\\",\\n  \\\"large_size\\\": \\\"http://example.com/image-l.jpg\\\",\\n  \\\"medium_size\\\": \\\"http://example.com/image-m.jpg\\\",\\n  \\\"thumbnail_size\\\": \\\"http://example.com/image-th.jpg\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef404e3f892b00767ee1","createdAt":"2016-05-16T14:35:35.508Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"image-component","sync_unique":"","title":"Image Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Image Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": "ID of the [Images Component](doc:images-component) parent", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`default`\n*Boolean, optional*", "4-1": "Indicates if the image is the default image out of all available product images", "5-0": "`category`\n*String Enum, optional*", "5-1": "The category for the type of image", "6-0": "`caption`\n*String, optional*", "6-1": "The caption for the image", "7-0": "`description`\n*String, optional*", "7-1": "A description for the image", "8-0": "`full_size`\n*String*", "8-1": "The URL to the full-size version of the image", "9-0": "`large_size`\n*String, optional*", "9-1": "The URL to the largest-sized version of the image", "10-0": "`medium_size`\n*String, optional*", "10-1": "The URL to the medium-sized version of the image", "11-0": "`thumbnail_size`\n*String, optional*", "11-1": "The URL to the thumbnail-sized version of the image" }, "cols": 2, "rows": 12 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": 3243,\n \"parent_name\": null,\n \"default\": true,\n \"category\": \"other\",\n \"caption\": \"Wooden Chair\",\n \"description\": \"A simple, wooden chair\",\n \"full_size\": \"http://example.com/image.jpg\",\n \"large_size\": \"http://example.com/image-l.jpg\",\n \"medium_size\": \"http://example.com/image-m.jpg\",\n \"thumbnail_size\": \"http://example.com/image-th.jpg\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": "ID of the [Images Component](doc:images-component) parent", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`default`\n*Boolean, optional*", "4-1": "Indicates if the image is the default image out of all available product images", "5-0": "`category`\n*String Enum, optional*", "5-1": "The category for the type of image", "6-0": "`caption`\n*String, optional*", "6-1": "The caption for the image", "7-0": "`description`\n*String, optional*", "7-1": "A description for the image", "8-0": "`full_size`\n*String*", "8-1": "The URL to the full-size version of the image", "9-0": "`large_size`\n*String, optional*", "9-1": "The URL to the largest-sized version of the image", "10-0": "`medium_size`\n*String, optional*", "10-1": "The URL to the medium-sized version of the image", "11-0": "`thumbnail_size`\n*String, optional*", "11-1": "The URL to the thumbnail-sized version of the image" }, "cols": 2, "rows": 12 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": 3243,\n \"parent_name\": null,\n \"default\": true,\n \"category\": \"other\",\n \"caption\": \"Wooden Chair\",\n \"description\": \"A simple, wooden chair\",\n \"full_size\": \"http://example.com/image.jpg\",\n \"large_size\": \"http://example.com/image-l.jpg\",\n \"medium_size\": \"http://example.com/image-m.jpg\",\n \"thumbnail_size\": \"http://example.com/image-th.jpg\"\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":3,"_id":"5739e0d2195a232900f6b008","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \"ID of the [Option Sets Component](doc:option-sets-component) parent\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`option_set_id`\\n*Integer*\",\n    \"4-1\": \"ID of the [Option Sets Component](doc:option-sets-component) parent\",\n    \"5-0\": \"`option_set`\\n*Object*\",\n    \"5-1\": \"An [Option Set Resource](doc:option-set-resource) object\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": 83,\\n  \\\"parent_name\\\": null,\\n  \\\"option_set_id\\\": 23,\\n  \\\"option_set\\\": {\\n    \\\"kind\\\": \\\"Finish\\\",\\n    \\\"name\\\": \\\"test option set\\\",\\n    \\\"option_list\\\": [],\\n    \\\"manufacturer_id\\\": 875,\\n    \\\"id\\\": 129\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef404e3f892b00767ee1","createdAt":"2016-05-16T15:01:38.513Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":6,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"option-set-component","sync_unique":"","title":"Option Set Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Option Set Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": "ID of the [Option Sets Component](doc:option-sets-component) parent", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`option_set_id`\n*Integer*", "4-1": "ID of the [Option Sets Component](doc:option-sets-component) parent", "5-0": "`option_set`\n*Object*", "5-1": "An [Option Set Resource](doc:option-set-resource) object" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": 83,\n \"parent_name\": null,\n \"option_set_id\": 23,\n \"option_set\": {\n \"kind\": \"Finish\",\n \"name\": \"test option set\",\n \"option_list\": [],\n \"manufacturer_id\": 875,\n \"id\": 129\n }\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": "ID of the [Option Sets Component](doc:option-sets-component) parent", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`option_set_id`\n*Integer*", "4-1": "ID of the [Option Sets Component](doc:option-sets-component) parent", "5-0": "`option_set`\n*Object*", "5-1": "An [Option Set Resource](doc:option-set-resource) object" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": 83,\n \"parent_name\": null,\n \"option_set_id\": 23,\n \"option_set\": {\n \"kind\": \"Finish\",\n \"name\": \"test option set\",\n \"option_list\": [],\n \"manufacturer_id\": 875,\n \"id\": 129\n }\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":3,"_id":"5739e201195a232900f6b011","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \"ID of the [Pillows Component](doc:pillows-component) parent\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`height`\\n*Decimal, optional*\",\n    \"4-1\": \"The height of the pillow\",\n    \"5-0\": \"`width`\\n*Decimal, optional*\",\n    \"5-1\": \"The width of the pillow\",\n    \"6-0\": \"`thickness`\\n*Decimal, optional*\",\n    \"6-1\": \"The thickness of the pillow\",\n    \"7-0\": \"`quantity`\\n*Integer, optional*\",\n    \"7-1\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": 565,\\n  \\\"parent_name\\\": null,\\n  \\\"height\\\": 312.32,\\n  \\\"width\\\": 68.90,\\n  \\\"thickness\\\": 0.34,\\n  \\\"quantity\\\": 3\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef404e3f892b00767ee1","createdAt":"2016-05-16T15:06:41.731Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":7,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"pillow-component","sync_unique":"","title":"Pillow Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Pillow Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": "ID of the [Pillows Component](doc:pillows-component) parent", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The height of the pillow", "5-0": "`width`\n*Decimal, optional*", "5-1": "The width of the pillow", "6-0": "`thickness`\n*Decimal, optional*", "6-1": "The thickness of the pillow", "7-0": "`quantity`\n*Integer, optional*", "7-1": "" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": 565,\n \"parent_name\": null,\n \"height\": 312.32,\n \"width\": 68.90,\n \"thickness\": 0.34,\n \"quantity\": 3\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": "ID of the [Pillows Component](doc:pillows-component) parent", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`height`\n*Decimal, optional*", "4-1": "The height of the pillow", "5-0": "`width`\n*Decimal, optional*", "5-1": "The width of the pillow", "6-0": "`thickness`\n*Decimal, optional*", "6-1": "The thickness of the pillow", "7-0": "`quantity`\n*Integer, optional*", "7-1": "" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": 565,\n \"parent_name\": null,\n \"height\": 312.32,\n \"width\": 68.90,\n \"thickness\": 0.34,\n \"quantity\": 3\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":4,"_id":"5739e35ca88e0522007c818d","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \"ID of the [Shelves Component](doc:shelves-component) parent\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`width`\\n*Decimal, optional*\",\n    \"4-1\": \"The width of the shelf\",\n    \"5-0\": \"`depth`\\n*Decimal, optional*\",\n    \"5-1\": \"The depth of the shelf\",\n    \"7-0\": \"`quantity`\\n*Integer, optional*\",\n    \"7-1\": \"\",\n    \"6-0\": \"`thickness`\\n*Decimal, optional*\",\n    \"6-1\": \"The thickness of the shelf\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": 167,\\n  \\\"parent_name\\\": null,\\n  \\\"width\\\": 68.90,\\n  \\\"depth\\\": 312.32,\\n  \\\"thickness\\\": 0.34,\\n  \\\"quantity\\\": 3\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef404e3f892b00767ee1","createdAt":"2016-05-16T15:12:28.650Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":8,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"shelf-component","sync_unique":"","title":"Shelf Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Shelf Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": "ID of the [Shelves Component](doc:shelves-component) parent", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`width`\n*Decimal, optional*", "4-1": "The width of the shelf", "5-0": "`depth`\n*Decimal, optional*", "5-1": "The depth of the shelf", "7-0": "`quantity`\n*Integer, optional*", "7-1": "", "6-0": "`thickness`\n*Decimal, optional*", "6-1": "The thickness of the shelf" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": 167,\n \"parent_name\": null,\n \"width\": 68.90,\n \"depth\": 312.32,\n \"thickness\": 0.34,\n \"quantity\": 3\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": "ID of the [Shelves Component](doc:shelves-component) parent", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`width`\n*Decimal, optional*", "4-1": "The width of the shelf", "5-0": "`depth`\n*Decimal, optional*", "5-1": "The depth of the shelf", "7-0": "`quantity`\n*Integer, optional*", "7-1": "", "6-0": "`thickness`\n*Decimal, optional*", "6-1": "The thickness of the shelf" }, "cols": 2, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": 167,\n \"parent_name\": null,\n \"width\": 68.90,\n \"depth\": 312.32,\n \"thickness\": 0.34,\n \"quantity\": 3\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
{"__v":3,"_id":"5739e414a88e0522007c8190","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"`component_data_id`\\n*Integer*\",\n    \"0-1\": \"Unique resource identifier\",\n    \"0-2\": \"\",\n    \"1-0\": \"`product_id`\\n*Integer*\",\n    \"1-1\": \"ID of the product the component is associated with\",\n    \"1-2\": \"\",\n    \"2-0\": \"`parent_id`\\n*Integer*\",\n    \"2-1\": \"ID of the [Table Leaves Component](doc:table-leaves-component) parent\",\n    \"2-2\": \"\",\n    \"3-0\": \"`parent_name`\\n*String*\",\n    \"3-1\": \":fa-ban: Not applicable\",\n    \"3-2\": \"\",\n    \"4-0\": \"`width`\\n*Decimal, optional*\",\n    \"4-1\": \"The width of the table leaf\",\n    \"5-0\": \"`depth`\\n*Decimal, optional*\",\n    \"5-1\": \"The depth of the table leaf\",\n    \"6-0\": \"`quantity`\\n*Integer, optional*\",\n    \"6-1\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 7\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"component_data_id\\\": 42,\\n  \\\"product_id\\\": 1337,\\n  \\\"parent_id\\\": 5243,\\n  \\\"parent_name\\\": null,\\n  \\\"width\\\": 68.90,\\n  \\\"depth\\\": 312.32,\\n  \\\"quantity\\\": 3\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5739ef404e3f892b00767ee1","createdAt":"2016-05-16T15:15:32.877Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":9,"parentDoc":null,"project":"571e47385536c12000f51b34","slug":"table-leaf-component","sync_unique":"","title":"Table Leaf Component","type":"basic","updates":[],"user":"5730dae3b16ed73200ddd25c","version":"571e47385536c12000f51b37","childrenPages":[]}

Table Leaf Component


[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": "ID of the [Table Leaves Component](doc:table-leaves-component) parent", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`width`\n*Decimal, optional*", "4-1": "The width of the table leaf", "5-0": "`depth`\n*Decimal, optional*", "5-1": "The depth of the table leaf", "6-0": "`quantity`\n*Integer, optional*", "6-1": "" }, "cols": 2, "rows": 7 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": 5243,\n \"parent_name\": null,\n \"width\": 68.90,\n \"depth\": 312.32,\n \"quantity\": 3\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "h-0": "Title", "h-1": "Description", "h-2": "Type", "0-0": "`component_data_id`\n*Integer*", "0-1": "Unique resource identifier", "0-2": "", "1-0": "`product_id`\n*Integer*", "1-1": "ID of the product the component is associated with", "1-2": "", "2-0": "`parent_id`\n*Integer*", "2-1": "ID of the [Table Leaves Component](doc:table-leaves-component) parent", "2-2": "", "3-0": "`parent_name`\n*String*", "3-1": ":fa-ban: Not applicable", "3-2": "", "4-0": "`width`\n*Decimal, optional*", "4-1": "The width of the table leaf", "5-0": "`depth`\n*Decimal, optional*", "5-1": "The depth of the table leaf", "6-0": "`quantity`\n*Integer, optional*", "6-1": "" }, "cols": 2, "rows": 7 } [/block] [block:code] { "codes": [ { "code": "{\n \"component_data_id\": 42,\n \"product_id\": 1337,\n \"parent_id\": 5243,\n \"parent_name\": null,\n \"width\": 68.90,\n \"depth\": 312.32,\n \"quantity\": 3\n}", "language": "json", "name": "Example JSON" } ], "sidebar": true } [/block]