{"_id":"58112e72ded0340f0085d055","__v":0,"category":{"_id":"58112e72ded0340f0085d033","project":"551e85be610f400d00837db7","version":"58112e71ded0340f0085d02a","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-25T13:57:54.835Z","from_sync":false,"order":8,"slug":"api-resources","title":"Merchant API Resources"},"version":{"_id":"58112e71ded0340f0085d02a","project":"551e85be610f400d00837db7","__v":4,"createdAt":"2016-10-26T22:30:09.862Z","releaseDate":"2016-10-26T22:30:09.862Z","categories":["58112e72ded0340f0085d02b","58112e72ded0340f0085d02c","58112e72ded0340f0085d02d","58112e72ded0340f0085d02e","58112e72ded0340f0085d02f","58112e72ded0340f0085d030","58112e72ded0340f0085d031","58112e72ded0340f0085d032","58112e72ded0340f0085d033","58112e72ded0340f0085d034","581137cc604d3c230048b7e4","58dc367221742d0f00a73f98","590768e54669da0f00db5c0b"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"new designer","version_clean":"2.0.0","version":"2.0"},"parentDoc":null,"project":"551e85be610f400d00837db7","user":"55f2fd49b5b25021002b7dfd","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-14T04:35:17.642Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"#Properties\n[block:html]\n{\n  \"html\": \"<div class=\\\"property-table-wrap\\\">\\n    <table class=\\\"property-table\\\">\\n        <thead>\\n            <tr>\\n                <th class=\\\"prop-col\\\">Property</th>\\n                <th class=\\\"filter-col\\\">Filter</th>\\n                <th class=\\\"editable-col\\\">Edit</th>\\n                <th class=\\\"type-col\\\">Type</th>\\n                <th class=\\\"description-col\\\">Description</th>\\n            </tr>\\n        </thead>\\n\\n        <tbody class=\\\"properties\\\">\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">id</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\">Unique identifier</td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">deleted</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">BOOLEAN</td>\\n                <td class=\\\"description-col\\\">Whether this product has been deleted</td>\\n            </tr>\\n\\n            <tr class=\\\"fil rw\\\">\\n                <td class=\\\"prop-col\\\">description</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">STRING</td>\\n                <td class=\\\"description-col\\\">Text describing the product</td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">flat_ship_price</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n              <td class=\\\"description-col\\\">If ship_option is <code>flat</code>, price for shipping</td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">gift_shipping</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">giftable</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">BOOLEAN</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>\\n\\n            <tr class=\\\"ro\\\">\\n                <td class=\\\"prop-col\\\">has_subscribers</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">BOOLEAN</td>\\n                <td class=\\\"description-col\\\">Whether this product current has any subscribers</td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">listed</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">BOOLEAN</td>\\n                <td class=\\\"description-col\\\">Whether this product has been listed on the Cratejoy Marketplace or not.</td>\\n            </tr>\\n\\n            <tr class=\\\"fil rw\\\">\\n                <td class=\\\"prop-col\\\">name</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">STRING</td>\\n                <td class=\\\"description-col\\\">Product Name</td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">product_billing_id</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>\\n          \\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">product_type</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n              <td class=\\\"description-col\\\">Subscription (0), One-time product (1), or gift card (2). When filtering, use the enum, e.g. <code>product_type=0</code>.</td>\\n            </tr>\\n          \\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">reviewable</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">BOOLEAN</td>\\n                <td class=\\\"description-col\\\">Whether this product can be reviewed on the Cratejoy Marketplace or not.</td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">ship_option</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">STRING</td>\\n                <td class=\\\"description-col\\\">One of flat, calculate, pricedin</td>\\n            </tr>\\n\\n            <tr class=\\\"fil rw\\\">\\n                <td class=\\\"prop-col\\\">ship_weight</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">FLOAT</td>\\n                <td class=\\\"description-col\\\">Shipping weight of product in lbs.</td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">single_purchasable</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">BOOLEAN</td>\\n                <td class=\\\"description-col\\\">Whether this product can be purchased without a subscription</td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">sku</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">STRING</td>\\n                <td class=\\\"description-col\\\">SKU of Product</td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">slug</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">STRING</td>\\n                <td class=\\\"description-col\\\">URL-friendly version of product name</td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">store_id</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>\\n\\n            <tr class=\\\"fil rw\\\">\\n                <td class=\\\"prop-col\\\">visible</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">BOOLEAN</td>\\n                <td class=\\\"description-col\\\">Whether the product should be displayed in store</td>\\n            </tr>\\n\\n             <tr class=\\\"ro\\\">\\n                <td class=\\\"prop-col\\\">type</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">STRING</td>\\n               <td class=\\\"description-col\\\">Always <code>product</code></td>\\n            </tr>\\n         \\n            <tr class=\\\"ro\\\">\\n                <td class=\\\"prop-col\\\">url</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">STRING</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>\\n\\n            </tbody>\\n    </table>\\n</div>\"\n}\n[/block]\n## Relation Properties\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Resource\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"base_term_prices\",\n    \"0-1\": \"TermPrices\",\n    \"0-2\": \"A collection of TermPrices\",\n    \"1-0\": \"billing\",\n    \"1-1\": \"[Product Billing](doc:product-billing)\",\n    \"1-2\": \"Product Billing object.\",\n    \"2-0\": \"gift_term_prices\",\n    \"2-1\": \"Term Prices\",\n    \"3-0\": \"gift_terms\",\n    \"4-0\": \"gift_instances\",\n    \"5-0\": \"instances\",\n    \"8-0\": \"rule_types\",\n    \"6-0\": \"meta\",\n    \"7-0\": \"metadata\",\n    \"9-0\": \"subscription_types\",\n    \"10-0\": \"variants\",\n    \"3-1\": \"Gift Terms\",\n    \"2-2\": \"[Deprecated] Gifting 1.0 prices associated with `gift_terms`\",\n    \"3-2\": \"[Deprecated] Gifting 1.0 terms.\",\n    \"4-1\": \"Gift Instances\",\n    \"4-2\": \"[Deprecated] Gifting 1.0 product instance IDs.\",\n    \"5-1\": \"Product Instances\",\n    \"10-1\": \"Product Variants\",\n    \"h-3\": \"Filter?\",\n    \"0-3\": \"No\",\n    \"1-3\": \"No\",\n    \"2-3\": \"No\",\n    \"3-3\": \"No\",\n    \"4-3\": \"No\",\n    \"5-3\": \"No\",\n    \"6-3\": \"No\",\n    \"5-2\": \"\",\n    \"7-3\": \"No\",\n    \"8-3\": \"No\",\n    \"9-3\": \"No\",\n    \"10-3\": \"No\",\n    \"8-1\": \"\",\n    \"8-2\": \"Shipping Rule types\",\n    \"7-2\": \"Product metadata\"\n  },\n  \"cols\": 4,\n  \"rows\": 11\n}\n[/block]\nThe above properties are references to another Cratejoy resource or another collection of Cratejoy resources. The properties can either be a url to fetch the related resources OR contain the resources themselves","excerpt":"Product data object specification for the Cratejoy Merchant API","slug":"product","type":"basic","title":"Product"}

Product

Product data object specification for the Cratejoy Merchant API

#Properties [block:html] { "html": "<div class=\"property-table-wrap\">\n <table class=\"property-table\">\n <thead>\n <tr>\n <th class=\"prop-col\">Property</th>\n <th class=\"filter-col\">Filter</th>\n <th class=\"editable-col\">Edit</th>\n <th class=\"type-col\">Type</th>\n <th class=\"description-col\">Description</th>\n </tr>\n </thead>\n\n <tbody class=\"properties\">\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">id</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\">Unique identifier</td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">deleted</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">BOOLEAN</td>\n <td class=\"description-col\">Whether this product has been deleted</td>\n </tr>\n\n <tr class=\"fil rw\">\n <td class=\"prop-col\">description</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">STRING</td>\n <td class=\"description-col\">Text describing the product</td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">flat_ship_price</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\">If ship_option is <code>flat</code>, price for shipping</td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">gift_shipping</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\"></td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">giftable</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">BOOLEAN</td>\n <td class=\"description-col\"></td>\n </tr>\n\n <tr class=\"ro\">\n <td class=\"prop-col\">has_subscribers</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">BOOLEAN</td>\n <td class=\"description-col\">Whether this product current has any subscribers</td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">listed</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">BOOLEAN</td>\n <td class=\"description-col\">Whether this product has been listed on the Cratejoy Marketplace or not.</td>\n </tr>\n\n <tr class=\"fil rw\">\n <td class=\"prop-col\">name</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">STRING</td>\n <td class=\"description-col\">Product Name</td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">product_billing_id</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\"></td>\n </tr>\n \n <tr class=\"fil ro\">\n <td class=\"prop-col\">product_type</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\">Subscription (0), One-time product (1), or gift card (2). When filtering, use the enum, e.g. <code>product_type=0</code>.</td>\n </tr>\n \n <tr class=\"fil ro\">\n <td class=\"prop-col\">reviewable</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">BOOLEAN</td>\n <td class=\"description-col\">Whether this product can be reviewed on the Cratejoy Marketplace or not.</td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">ship_option</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">STRING</td>\n <td class=\"description-col\">One of flat, calculate, pricedin</td>\n </tr>\n\n <tr class=\"fil rw\">\n <td class=\"prop-col\">ship_weight</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">FLOAT</td>\n <td class=\"description-col\">Shipping weight of product in lbs.</td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">single_purchasable</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">BOOLEAN</td>\n <td class=\"description-col\">Whether this product can be purchased without a subscription</td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">sku</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">STRING</td>\n <td class=\"description-col\">SKU of Product</td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">slug</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">STRING</td>\n <td class=\"description-col\">URL-friendly version of product name</td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">store_id</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\"></td>\n </tr>\n\n <tr class=\"fil rw\">\n <td class=\"prop-col\">visible</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">BOOLEAN</td>\n <td class=\"description-col\">Whether the product should be displayed in store</td>\n </tr>\n\n <tr class=\"ro\">\n <td class=\"prop-col\">type</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">STRING</td>\n <td class=\"description-col\">Always <code>product</code></td>\n </tr>\n \n <tr class=\"ro\">\n <td class=\"prop-col\">url</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">STRING</td>\n <td class=\"description-col\"></td>\n </tr>\n\n </tbody>\n </table>\n</div>" } [/block] ## Relation Properties [block:parameters] { "data": { "h-0": "Property", "h-1": "Resource", "h-2": "Description", "0-0": "base_term_prices", "0-1": "TermPrices", "0-2": "A collection of TermPrices", "1-0": "billing", "1-1": "[Product Billing](doc:product-billing)", "1-2": "Product Billing object.", "2-0": "gift_term_prices", "2-1": "Term Prices", "3-0": "gift_terms", "4-0": "gift_instances", "5-0": "instances", "8-0": "rule_types", "6-0": "meta", "7-0": "metadata", "9-0": "subscription_types", "10-0": "variants", "3-1": "Gift Terms", "2-2": "[Deprecated] Gifting 1.0 prices associated with `gift_terms`", "3-2": "[Deprecated] Gifting 1.0 terms.", "4-1": "Gift Instances", "4-2": "[Deprecated] Gifting 1.0 product instance IDs.", "5-1": "Product Instances", "10-1": "Product Variants", "h-3": "Filter?", "0-3": "No", "1-3": "No", "2-3": "No", "3-3": "No", "4-3": "No", "5-3": "No", "6-3": "No", "5-2": "", "7-3": "No", "8-3": "No", "9-3": "No", "10-3": "No", "8-1": "", "8-2": "Shipping Rule types", "7-2": "Product metadata" }, "cols": 4, "rows": 11 } [/block] The above properties are references to another Cratejoy resource or another collection of Cratejoy resources. The properties can either be a url to fetch the related resources OR contain the resources themselves