{"_id":"5632a5ea49e16d0d00122494","__v":0,"user":"55b932ba8fd1a02b00f496c8","githubsync":"","project":"55b933b3146ef121002158d3","version":{"_id":"5632a5e549e16d0d00122443","__v":6,"project":"55b933b3146ef121002158d3","createdAt":"2015-10-29T23:04:05.701Z","releaseDate":"2015-10-29T23:04:05.701Z","categories":["5632a5e749e16d0d00122444","5632a5e749e16d0d00122445","5632a5e749e16d0d00122446","5632a5e749e16d0d00122447","5632a5e749e16d0d00122448","5632a5e749e16d0d00122449","5632a5e749e16d0d0012244a","5632a5e749e16d0d0012244b","5632a5e749e16d0d0012244c","5632a5e749e16d0d0012244d","5632a5e749e16d0d0012244e","5632a5e749e16d0d0012244f","5632a5e749e16d0d00122450","5632b179df556c0d00cd095b","564e13053b2b4a19000cd69b","59caa9df65accc001a489c95","59cab50965accc001a489d28","59cadd464ab7b70024378e74"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"category":{"_id":"5632a5e749e16d0d0012244d","__v":1,"pages":["5632a5ea49e16d0d00122481","5632a5ea49e16d0d00122482","5632a5ea49e16d0d00122483","5632a5ea49e16d0d00122484","5632a5ea49e16d0d00122485","5632a5ea49e16d0d00122486","5632a5ea49e16d0d00122487","5632a5ea49e16d0d00122488","5632a5ea49e16d0d00122489","5632a5ea49e16d0d0012248a","5632a5ea49e16d0d0012248b","5632a5ea49e16d0d0012248c","5632a5ea49e16d0d0012248d","5632a5ea49e16d0d0012248e","5632a5ea49e16d0d0012248f","5632a5ea49e16d0d00122490","5632a5ea49e16d0d00122491","5632a5ea49e16d0d00122492","5632a5ea49e16d0d00122493","5632a5ea49e16d0d00122494","5632a5ea49e16d0d00122495","5632a5ea49e16d0d00122496","5632a5ea49e16d0d00122497","5632a5ea49e16d0d00122498","5632a5ea49e16d0d00122499","5632a5ea49e16d0d0012249a","5632a5ea49e16d0d0012249b","5632a5ea49e16d0d0012249c","5632a5ea49e16d0d0012249d","5632a5ea49e16d0d0012249e","5632a5ea49e16d0d0012249f","5632a5ea49e16d0d001224a0","5632a5ea49e16d0d001224a1","5632a5ea49e16d0d001224a2","5632a5ea49e16d0d001224a3","5632a5ea49e16d0d001224a4","5632a5ea49e16d0d001224a5","5632a5ea49e16d0d001224a6","5632a5ea49e16d0d001224a7"],"project":"55b933b3146ef121002158d3","version":"5632a5e549e16d0d00122443","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-04T17:34:02.800Z","from_sync":false,"order":12,"slug":"objects","title":"Objects"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-04T17:56:32.609Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":18,"body":"Object describing a product.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis object contains all of the data needed for adding, updating, and deleting a product on the gateway.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Properties\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Type\",\n    \"h-1\": \"Name\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"integer\",\n    \"0-1\": \"ProductRefNum\",\n    \"0-2\": \"Gateway assigned ID of product\",\n    \"1-0\": \"string\",\n    \"1-1\": \"ProductID\",\n    \"1-2\": \"Merchant assigned product ID\",\n    \"2-0\": \"string\",\n    \"2-1\": \"Category\",\n    \"2-2\": \"Product category\",\n    \"3-0\": \"string\",\n    \"3-1\": \"SKU\",\n    \"3-2\": \"Stock-Keeping Unit\",\n    \"4-0\": \"string\",\n    \"4-1\": \"UPC\",\n    \"4-2\": \"Universal Product Code\",\n    \"5-0\": \"boolean\",\n    \"5-1\": \"Enabled\",\n    \"5-2\": \"Enables the ability to store products\",\n    \"6-0\": \"string\",\n    \"6-1\": \"Name\",\n    \"6-2\": \"Name of the product\",\n    \"7-0\": \"string\",\n    \"7-1\": \"Description\",\n    \"7-2\": \"Product description\",\n    \"8-0\": \"string\",\n    \"8-1\": \"Model\",\n    \"8-2\": \"Model of the product\",\n    \"9-0\": \"double\",\n    \"9-1\": \"Weight\",\n    \"9-2\": \"Weight of the product\",\n    \"10-0\": \"double\",\n    \"10-1\": \"ShipWeight\",\n    \"10-2\": \"Shipping weight of the product\",\n    \"11-0\": \"double\",\n    \"11-1\": \"Price\",\n    \"11-2\": \"Price of the product\",\n    \"12-0\": \"double\",\n    \"12-1\": \"WholesalePrice\",\n    \"12-2\": \"Wholesale price of the product\",\n    \"13-0\": \"double\",\n    \"13-1\": \"ListPrice\",\n    \"13-2\": \"List price of the product\",\n    \"14-0\": \"[PriceTier](/docs/pricetier)[]\",\n    \"14-1\": \"PriceTiers\",\n    \"14-2\": \"Qty and Customer based variable pricing tiers\",\n    \"15-0\": \"string\",\n    \"16-0\": \"string\",\n    \"15-1\": \"TaxClass\",\n    \"15-2\": \"Product's Tax Class\",\n    \"16-1\": \"DateAvailable\",\n    \"16-2\": \"Date the product is available for sale\",\n    \"17-0\": \"string\",\n    \"17-1\": \"Manufacturer\",\n    \"17-2\": \"Maker of the product\",\n    \"18-0\": \"boolean\",\n    \"18-1\": \"PhysicalGood\",\n    \"18-2\": \"Tangible/Shippable good.\",\n    \"19-0\": \"integer\",\n    \"19-1\": \"MinQuantity\",\n    \"19-2\": \"Minimum quantity allowed\",\n    \"20-0\": \"string\",\n    \"20-1\": \"ImageURL\",\n    \"20-2\": \"URL address of the product image\",\n    \"21-0\": \"string\",\n    \"21-1\": \"URL\",\n    \"21-2\": \"URL of the product\",\n    \"22-0\": \"[ProductInventory](/docs/productinventory)[]\",\n    \"22-1\": \"Inventory\",\n    \"22-2\": \"Product inventory levels\",\n    \"23-0\": \"string\",\n    \"23-1\": \"Modified\",\n    \"23-2\": \"Date/time the product was last changed\",\n    \"24-0\": \"string\",\n    \"24-1\": \"Created\",\n    \"24-2\": \"Date/time the product was created\"\n  },\n  \"cols\": 3,\n  \"rows\": 25\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples\"\n}\n[/block]","excerpt":"","slug":"product","type":"basic","title":"Product"}
Object describing a product. [block:api-header] { "type": "basic", "title": "Description" } [/block] This object contains all of the data needed for adding, updating, and deleting a product on the gateway. [block:api-header] { "type": "basic", "title": "Properties" } [/block] [block:parameters] { "data": { "h-0": "Type", "h-1": "Name", "h-2": "Description", "0-0": "integer", "0-1": "ProductRefNum", "0-2": "Gateway assigned ID of product", "1-0": "string", "1-1": "ProductID", "1-2": "Merchant assigned product ID", "2-0": "string", "2-1": "Category", "2-2": "Product category", "3-0": "string", "3-1": "SKU", "3-2": "Stock-Keeping Unit", "4-0": "string", "4-1": "UPC", "4-2": "Universal Product Code", "5-0": "boolean", "5-1": "Enabled", "5-2": "Enables the ability to store products", "6-0": "string", "6-1": "Name", "6-2": "Name of the product", "7-0": "string", "7-1": "Description", "7-2": "Product description", "8-0": "string", "8-1": "Model", "8-2": "Model of the product", "9-0": "double", "9-1": "Weight", "9-2": "Weight of the product", "10-0": "double", "10-1": "ShipWeight", "10-2": "Shipping weight of the product", "11-0": "double", "11-1": "Price", "11-2": "Price of the product", "12-0": "double", "12-1": "WholesalePrice", "12-2": "Wholesale price of the product", "13-0": "double", "13-1": "ListPrice", "13-2": "List price of the product", "14-0": "[PriceTier](/docs/pricetier)[]", "14-1": "PriceTiers", "14-2": "Qty and Customer based variable pricing tiers", "15-0": "string", "16-0": "string", "15-1": "TaxClass", "15-2": "Product's Tax Class", "16-1": "DateAvailable", "16-2": "Date the product is available for sale", "17-0": "string", "17-1": "Manufacturer", "17-2": "Maker of the product", "18-0": "boolean", "18-1": "PhysicalGood", "18-2": "Tangible/Shippable good.", "19-0": "integer", "19-1": "MinQuantity", "19-2": "Minimum quantity allowed", "20-0": "string", "20-1": "ImageURL", "20-2": "URL address of the product image", "21-0": "string", "21-1": "URL", "21-2": "URL of the product", "22-0": "[ProductInventory](/docs/productinventory)[]", "22-1": "Inventory", "22-2": "Product inventory levels", "23-0": "string", "23-1": "Modified", "23-2": "Date/time the product was last changed", "24-0": "string", "24-1": "Created", "24-2": "Date/time the product was created" }, "cols": 3, "rows": 25 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block]