Product
A product is an individual item for sale in a haravan shop. Products are often physical, but don't have to be; a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). Simply put: if it's something for sale in a shop, it's a Product.
A product may have up to 100 product variants and from 0 to 250 product images. A product may also be a part of a custom collection and/or a smart collection.
What can you do with Product?
The haravan API lets you do the following with the Product resource. More detailed versions of these general actions may be available:
- GET /com/products.json Receive a list of all Products
- GET /com/products/count.json Receive a count of all Products
- GET /com/products/#{id}.json Receive a single Product
- POST /com/products.json Create a new Product
- PUT /com/products/#{id}.json Modify an existing Product
- DELETE /com/products/#{id}.json Remove a Product from the database
Product Properties
body_html | { "body_html" : "It's the small iPod with a big idea: Video." }
The description of the product, complete with HTML formatting. |
created_at | { "created_at" : "2008-12-31T02:01:27.483Z" }
The date and time when the product was created. The API returns this value in ISO 8601 format. |
handle | { "handle" : "ipod-nano" } A human-friendly unique string for the Product automatically generated from its title. They are used by the Liquid templating language to refer to objects. |
id | { "id" : 632910392 } The unique numeric identifier for the product. Product ids are unique across the entire haravan system; no two products will have the same id, even if they're from different shops. |
images | { "images" : "[ { "src": "http://example.com/burton.jpg" } ]" } A list of image objects, each one representing an image associated with the product. |
options | { "options" : " [ { "name": "Title" } ]" } Custom product property names like "Size", "Color", and "Material". Products are based on permutations of these options. A product may have a maximum of 3 options. 255 characters limit each. |
product_type | { "product_type" : "Cult Products" } A categorization that a product can be tagged with, commonly used for filtering and searching. |
published_at | { "published_at" : "2008-12-31T02:01:27.483Z" } The date and time when the product was published. The API returns this value in ISO 8601 format. |
published_scope | { "published_scope" : "global" } The sales channels in which the product is visible. |
tags | { "tags" : "Emotive, Flash Memory, MP3, Music" } A categorization that a product can be tagged with, commonly used for filtering and searching. |
template_suffix | { "template_suffix" : "null" } The suffix of the liquid template being used. By default, the original template is called product.liquid, without any suffix. Any additional templates will be: product.suffix.liquid. |
title | { "title" : "IPod Nano - 8GB" } The name of the product. In a shop's catalog, clicking on a product's title takes you to that product's page. On a product's page, the product's title typically appears in a large font. |
updated_at | { "updated_at" : "2008-12-31T02:01:27.483Z" } The date and time when the product was last modified. The API returns this value in ISO 8601 format. |
variants | { "barcode" : "1234_pink" } { "compare_at_price" : "null" } { "created_at" : "2012-08-24T14:01:47-04:00" } { "fulfillment_service" : "manual" } { "grams" : 200 } { "weight" : 0.2 } { "weight_unit" : "kg" } { "id" : 808950810 } { "inventory_management" : "haravan" } { "inventory_policy" : "continue" } { "inventory_quantity" : 10 } { "option1" : "Pink" } { "position" : "1" } { "price" : 199.99 } { "product_id" : 632910392 } { "requires_shipping" : true } { "sku" : "IPOD2008PINK" } { "taxable" : true } { "title" : "Pink" } { "updated_at" : "2012-08-24T14:01:47-04:00" } A list of variant objects, each one representing a slightly different version of the product. For example, if a product comes in different sizes and colors, each size and color permutation (such as "small black", "medium black", "large blue"), would be a variant. To reorder variants, update the product with the variants in the desired order. The position attribute on the variant will be ignored.
|
vendor | { "vendor" : "Apple" } The name of the vendor of the product. |
Endpoints
GET/com/products.json
Get a list of products
ids | A comma-separated list of product ids |
limit | Amount of results |
page | Page to show |
since_id | Restrict results to after the specified ID |
vendor | Filter by product vendor |
handle | Filter by product handle |
product_type | Filter by product type |
collection_id | Filter by collection id |
created_at_min | Show products created after date (format: 2008-12-31T02:01:27.483Z) |
created_at_max | Show products created before date (format: 2008-12-31T02:01:27.483Z) |
updated_at_min | Show products last updated after date (format: 2008-12-31T02:01:27.483Z) |
updated_at_max | Show products last updated before date (format: 2008-12-31T02:01:27.483Z) |
published_at_min | Show products published after date (format: 2008-12-31T02:01:27.483Z) |
published_at_max | Show products published before date (format: 2008-12-31T02:01:27.483Z) |
published_status | |
fields | comma-separated list of fields to include in the response |
Get all products
GET /com/products.json
View ResponseHTTP/1.1 200 OK { "products": [ { "body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.<\/p>", "created_at": "2015-03-28T13:31:19-04:00", "handle": "ipod-nano", "id": 632910392, "product_type": "Cult Products", "published_at": "2007-12-31T19:00:00-05:00", "published_scope": "web", "template_suffix": null, "title": "IPod Nano - 8GB", "updated_at": "2015-03-28T13:31:19-04:00", "vendor": "Apple", "tags": "Emotive, Flash Memory, MP3, Music", "variants": [ { "barcode": "1234_pink", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 808950810, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Pink", "option2": null, "option3": null, "position": 1, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008PINK", "taxable": true, "title": "Pink", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 10, "old_inventory_quantity": 10, "image_id": 562641783, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_red", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 49148385, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Red", "option2": null, "option3": null, "position": 2, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008RED", "taxable": true, "title": "Red", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 20, "old_inventory_quantity": 20, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_green", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 39072856, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Green", "option2": null, "option3": null, "position": 3, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008GREEN", "taxable": true, "title": "Green", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 30, "old_inventory_quantity": 30, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_black", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 457924702, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Black", "option2": null, "option3": null, "position": 4, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008BLACK", "taxable": true, "title": "Black", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 40, "old_inventory_quantity": 40, "image_id": null, "weight": 0.2, "weight_unit": "kg" } ], "options": [ { "id": 594680422, "name": "Title", "position": 1, "product_id": 632910392 } ], "images": [ { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] }, { "created_at": "2015-03-28T13:31:19-04:00", "id": 562641783, "position": 2, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano-2.png?v=1427563879", "variant_ids": [ 808950810 ] } ], "image": { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] } }, { "body_html": "<p>The iPod Touch has the iPhone's multi-touch interface, with a physical home button off the touch screen. The home screen has a list of buttons for the available applications.<\/p>", "created_at": "2015-03-28T13:31:19-04:00", "handle": "ipod-touch", "id": 921728736, "product_type": "Cult Products", "published_at": "2008-09-25T20:00:00-04:00", "published_scope": "global", "template_suffix": null, "title": "IPod Touch 8GB", "updated_at": "2015-03-28T13:31:19-04:00", "vendor": "Apple", "tags": "", "variants": [ { "barcode": "1234_black", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 447654529, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Black", "option2": null, "option3": null, "position": 1, "price": "199.00", "product_id": 921728736, "requires_shipping": true, "sku": "IPOD2009BLACK", "taxable": true, "title": "Black", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 13, "old_inventory_quantity": 13, "image_id": null, "weight": 0.2, "weight_unit": "kg" } ], "options": [ { "id": 891236591, "name": "Title", "position": 1, "product_id": 921728736 } ], "images": [ ] } ] }
Get a specific list of products
GET /com/products.json?ids=632910392,921728736
View ResponseHTTP/1.1 200 OK { "products": [ { "body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.<\/p>", "created_at": "2015-03-28T13:31:19-04:00", "handle": "ipod-nano", "id": 632910392, "product_type": "Cult Products", "published_at": "2007-12-31T19:00:00-05:00", "published_scope": "web", "template_suffix": null, "title": "IPod Nano - 8GB", "updated_at": "2015-03-28T13:31:19-04:00", "vendor": "Apple", "tags": "Emotive, Flash Memory, MP3, Music", "variants": [ { "barcode": "1234_pink", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 808950810, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Pink", "option2": null, "option3": null, "position": 1, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008PINK", "taxable": true, "title": "Pink", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 10, "old_inventory_quantity": 10, "image_id": 562641783, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_red", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 49148385, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Red", "option2": null, "option3": null, "position": 2, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008RED", "taxable": true, "title": "Red", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 20, "old_inventory_quantity": 20, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_green", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 39072856, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Green", "option2": null, "option3": null, "position": 3, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008GREEN", "taxable": true, "title": "Green", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 30, "old_inventory_quantity": 30, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_black", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 457924702, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Black", "option2": null, "option3": null, "position": 4, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008BLACK", "taxable": true, "title": "Black", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 40, "old_inventory_quantity": 40, "image_id": null, "weight": 0.2, "weight_unit": "kg" } ], "options": [ { "id": 594680422, "name": "Title", "position": 1, "product_id": 632910392 } ], "images": [ { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] }, { "created_at": "2015-03-28T13:31:19-04:00", "id": 562641783, "position": 2, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano-2.png?v=1427563879", "variant_ids": [ 808950810 ] } ], "image": { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] } }, { "body_html": "<p>The iPod Touch has the iPhone's multi-touch interface, with a physical home button off the touch screen. The home screen has a list of buttons for the available applications.<\/p>", "created_at": "2015-03-28T13:31:19-04:00", "handle": "ipod-touch", "id": 921728736, "product_type": "Cult Products", "published_at": "2008-09-25T20:00:00-04:00", "published_scope": "global", "template_suffix": null, "title": "IPod Touch 8GB", "updated_at": "2015-03-28T13:31:19-04:00", "vendor": "Apple", "tags": "", "variants": [ { "barcode": "1234_black", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 447654529, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Black", "option2": null, "option3": null, "position": 1, "price": "199.00", "product_id": 921728736, "requires_shipping": true, "sku": "IPOD2009BLACK", "taxable": true, "title": "Black", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 13, "old_inventory_quantity": 13, "image_id": null, "weight": 0.2, "weight_unit": "kg" } ], "options": [ { "id": 891236591, "name": "Title", "position": 1, "product_id": 921728736 } ], "images": [ ] } ] }
Get all products, showing only some attributes
GET /com/products.json?fields=id,images,title
View ResponseHTTP/1.1 200 OK { "products": [ { "id": 632910392, "title": "IPod Nano - 8GB", "images": [ { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] }, { "created_at": "2015-03-28T13:31:19-04:00", "id": 562641783, "position": 2, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano-2.png?v=1427563879", "variant_ids": [ 808950810 ] } ] }, { "id": 921728736, "title": "IPod Touch 8GB", "images": [ ] } ] }
Fetches all products that belong to a certain collection
GET /com/products.json?collection_id=841564295
View ResponseHTTP/1.1 200 OK { "products": [ { "body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.<\/p>", "created_at": "2015-03-28T13:31:19-04:00", "handle": "ipod-nano", "id": 632910392, "product_type": "Cult Products", "published_at": "2007-12-31T19:00:00-05:00", "published_scope": "web", "template_suffix": null, "title": "IPod Nano - 8GB", "updated_at": "2015-03-28T13:31:19-04:00", "vendor": "Apple", "tags": "Emotive, Flash Memory, MP3, Music", "variants": [ { "barcode": "1234_pink", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 808950810, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Pink", "option2": null, "option3": null, "position": 1, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008PINK", "taxable": true, "title": "Pink", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 10, "old_inventory_quantity": 10, "image_id": 562641783, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_red", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 49148385, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Red", "option2": null, "option3": null, "position": 2, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008RED", "taxable": true, "title": "Red", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 20, "old_inventory_quantity": 20, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_green", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 39072856, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Green", "option2": null, "option3": null, "position": 3, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008GREEN", "taxable": true, "title": "Green", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 30, "old_inventory_quantity": 30, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_black", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 457924702, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Black", "option2": null, "option3": null, "position": 4, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008BLACK", "taxable": true, "title": "Black", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 40, "old_inventory_quantity": 40, "image_id": null, "weight": 0.2, "weight_unit": "kg" } ], "options": [ { "id": 594680422, "name": "Title", "position": 1, "product_id": 632910392 } ], "images": [ { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] }, { "created_at": "2015-03-28T13:31:19-04:00", "id": 562641783, "position": 2, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano-2.png?v=1427563879", "variant_ids": [ 808950810 ] } ], "image": { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] } } ] }
Get all products after the specified ID
GET /com/products.json?since_id=632910392
View ResponseHTTP/1.1 200 OK { "products": [ { "body_html": "<p>The iPod Touch has the iPhone's multi-touch interface, with a physical home button off the touch screen. The home screen has a list of buttons for the available applications.<\/p>", "created_at": "2015-03-28T13:31:19-04:00", "handle": "ipod-touch", "id": 921728736, "product_type": "Cult Products", "published_at": "2008-09-25T20:00:00-04:00", "published_scope": "global", "template_suffix": null, "title": "IPod Touch 8GB", "updated_at": "2015-03-28T13:31:19-04:00", "vendor": "Apple", "tags": "", "variants": [ { "barcode": "1234_black", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 447654529, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Black", "option2": null, "option3": null, "position": 1, "price": "199.00", "product_id": 921728736, "requires_shipping": true, "sku": "IPOD2009BLACK", "taxable": true, "title": "Black", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 13, "old_inventory_quantity": 13, "image_id": null, "weight": 0.2, "weight_unit": "kg" } ], "options": [ { "id": 891236591, "name": "Title", "position": 1, "product_id": 921728736 } ], "images": [ ] } ] }
GET/com/products/count.json
Get a count of all products of a given collection
vendor | Filter by product vendor |
product_type | Filter by product type |
collection_id | Filter by collection id |
created_at_min | Show products created after date (format: 2008-12-31 03:00) |
created_at_max | Show products created before date (format: 2008-12-31 03:00) |
updated_at_min | Show products last updated after date (format: 2008-12-31 03:00) |
updated_at_max | Show products last updated before date (format: 2008-12-31 03:00) |
published_at_min | Show products published after date (format: 2008-12-31 03:00) |
published_at_max | Show products published before date (format: 2008-12-31 03:00) |
published_status |
Counts all products that belong to a certain collection
GET /com/products/count.json?collection_id=841564295
View ResponseHTTP/1.1 200 OK { "count": 1 }
GET/com/products/632910392.json
Get a single product
fields | comma-separated list of fields to include in the response |
Get a single product by ID
GET /com/products/#{id}.json
View ResponseHTTP/1.1 200 OK { "product": { "body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.<\/p>", "created_at": "2015-03-28T13:31:19-04:00", "handle": "ipod-nano", "id": 632910392, "product_type": "Cult Products", "published_at": "2007-12-31T19:00:00-05:00", "published_scope": "web", "template_suffix": null, "title": "IPod Nano - 8GB", "updated_at": "2015-03-28T13:31:19-04:00", "vendor": "Apple", "tags": "Emotive, Flash Memory, MP3, Music", "variants": [ { "barcode": "1234_pink", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 808950810, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Pink", "option2": null, "option3": null, "position": 1, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008PINK", "taxable": true, "title": "Pink", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 10, "old_inventory_quantity": 10, "image_id": 562641783, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_red", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 49148385, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Red", "option2": null, "option3": null, "position": 2, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008RED", "taxable": true, "title": "Red", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 20, "old_inventory_quantity": 20, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_green", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 39072856, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Green", "option2": null, "option3": null, "position": 3, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008GREEN", "taxable": true, "title": "Green", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 30, "old_inventory_quantity": 30, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_black", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 457924702, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Black", "option2": null, "option3": null, "position": 4, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008BLACK", "taxable": true, "title": "Black", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 40, "old_inventory_quantity": 40, "image_id": null, "weight": 0.2, "weight_unit": "kg" } ], "options": [ { "id": 594680422, "name": "Title", "position": 1, "product_id": 632910392 } ], "images": [ { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] }, { "created_at": "2015-03-28T13:31:19-04:00", "id": 562641783, "position": 2, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano-2.png?v=1427563879", "variant_ids": [ 808950810 ] } ], "image": { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] } } }
Get only particular fields
GET /com/products/#{id}.json?fields=id,images,title
View ResponseHTTP/1.1 200 OK { "product": { "id": 632910392, "title": "IPod Nano - 8GB", "images": [ { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] }, { "created_at": "2015-03-28T13:31:19-04:00", "id": 562641783, "position": 2, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano-2.png?v=1427563879", "variant_ids": [ 808950810 ] } ] } }
POST/com/products.json
Create a new product
Create a new, but unpublished product
POST /com/products.json
{ "product": { "title": "Burton Custom Freestlye 151", "body_html": "<strong>Good snowboard!<\/strong>", "vendor": "Burton", "product_type": "Snowboard", "published": false } }View Response
HTTP/1.1 201 Created { "product": { "body_html": "<strong>Good snowboard!<\/strong>", "created_at": "2015-03-28T13:31:35-04:00", "handle": "burton-custom-freestlye-151", "id": 1071559576, "product_type": "Snowboard", "published_at": null, "published_scope": "global", "template_suffix": null, "title": "Burton Custom Freestlye 151", "updated_at": "2015-03-28T13:31:35-04:00", "vendor": "Burton", "tags": "", "variants": [ { "barcode": null, "compare_at_price": null, "created_at": "2015-03-28T13:31:35-04:00", "fulfillment_service": "manual", "grams": 0, "id": 1044399219, "inventory_management": null, "inventory_policy": "deny", "option1": "Default Title", "option2": null, "option3": null, "position": 1, "price": "0.00", "product_id": 1071559576, "requires_shipping": true, "sku": "", "taxable": true, "title": "Default Title", "updated_at": "2015-03-28T13:31:35-04:00", "inventory_quantity": 1, "old_inventory_quantity": 1, "image_id": null, "weight": 0.0, "weight_unit": "kg" } ], "options": [ { "id": 1020890286, "name": "Title", "position": 1, "product_id": 1071559576 } ], "images": [ ] } }
Create a new product with multiple product variants
POST /com/products.json
{ "product": { "title": "Burton Custom Freestlye 151", "body_html": "<strong>Good snowboard!<\/strong>", "vendor": "Burton", "product_type": "Snowboard", "variants": [ { "option1": "First", "price": "10.00", "sku": 123 }, { "option1": "Second", "price": "20.00", "sku": "123" } ] } }View Response
HTTP/1.1 201 Created { "product": { "body_html": "<strong>Good snowboard!<\/strong>", "created_at": "2015-03-28T13:31:35-04:00", "handle": "burton-custom-freestlye-151", "id": 1071559577, "product_type": "Snowboard", "published_at": "2015-03-28T13:31:35-04:00", "published_scope": "global", "template_suffix": null, "title": "Burton Custom Freestlye 151", "updated_at": "2015-03-28T13:31:35-04:00", "vendor": "Burton", "tags": "", "variants": [ { "barcode": null, "compare_at_price": null, "created_at": "2015-03-28T13:31:35-04:00", "fulfillment_service": "manual", "grams": 0, "id": 1044399220, "inventory_management": null, "inventory_policy": "deny", "option1": "First", "option2": null, "option3": null, "position": 1, "price": "10.00", "product_id": 1071559577, "requires_shipping": true, "sku": "123", "taxable": true, "title": "First", "updated_at": "2015-03-28T13:31:35-04:00", "inventory_quantity": 1, "old_inventory_quantity": 1, "image_id": null, "weight": 0.0, "weight_unit": "kg" }, { "barcode": null, "compare_at_price": null, "created_at": "2015-03-28T13:31:35-04:00", "fulfillment_service": "manual", "grams": 0, "id": 1044399221, "inventory_management": null, "inventory_policy": "deny", "option1": "Second", "option2": null, "option3": null, "position": 2, "price": "20.00", "product_id": 1071559577, "requires_shipping": true, "sku": "123", "taxable": true, "title": "Second", "updated_at": "2015-03-28T13:31:35-04:00", "inventory_quantity": 1, "old_inventory_quantity": 1, "image_id": null, "weight": 0.0, "weight_unit": "kg" } ], "options": [ { "id": 1020890287, "name": "Title", "position": 1, "product_id": 1071559577 } ], "images": [ ] } }
Create a new product with the default variant and base64 encoded image
POST /com/products.json
{ "product": { "title": "Burton Custom Freestlye 151", "body_html": "<strong>Good snowboard!<\/strong>", "vendor": "Burton", "product_type": "Snowboard", "images": [ { "attachment": "R0lGODlhAQABAIAAAAAAAAAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==\n" } ] } }View Response
HTTP/1.1 201 Created { "product": { "body_html": "<strong>Good snowboard!<\/strong>", "created_at": "2015-03-28T13:31:36-04:00", "handle": "burton-custom-freestlye-151", "id": 1071559578, "product_type": "Snowboard", "published_at": "2015-03-28T13:31:36-04:00", "published_scope": "global", "template_suffix": null, "title": "Burton Custom Freestlye 151", "updated_at": "2015-03-28T13:31:36-04:00", "vendor": "Burton", "tags": "", "variants": [ { "barcode": null, "compare_at_price": null, "created_at": "2015-03-28T13:31:36-04:00", "fulfillment_service": "manual", "grams": 0, "id": 1044399222, "inventory_management": null, "inventory_policy": "deny", "option1": "Default Title", "option2": null, "option3": null, "position": 1, "price": "0.00", "product_id": 1071559578, "requires_shipping": true, "sku": "", "taxable": true, "title": "Default Title", "updated_at": "2015-03-28T13:31:36-04:00", "inventory_quantity": 1, "old_inventory_quantity": 1, "image_id": null, "weight": 0.0, "weight_unit": "kg" } ], "options": [ { "id": 1020890288, "name": "Title", "position": 1, "product_id": 1071559578 } ], "images": [ { "created_at": "2015-03-28T13:31:36-04:00", "id": 1003141237, "position": 1, "product_id": 1071559578, "updated_at": "2015-03-28T13:31:36-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/df3e567d6f16d040326c7a0ea29a4f41.gif?v=1427563896", "variant_ids": [ ] } ], "image": { "created_at": "2015-03-28T13:31:36-04:00", "id": 1003141237, "position": 1, "product_id": 1071559578, "updated_at": "2015-03-28T13:31:36-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/df3e567d6f16d040326c7a0ea29a4f41.gif?v=1427563896", "variant_ids": [ ] } } }
Create a new product with the default variant and a product image which will be downloaded by haravan
POST /com/products.json
{ "product": { "title": "Burton Custom Freestlye 151", "body_html": "<strong>Good snowboard!<\/strong>", "vendor": "Burton", "product_type": "Snowboard", "images": [ { "src": "http:\/\/example.com\/rails_logo.gif" } ] } }View Response
HTTP/1.1 201 Created { "product": { "body_html": "<strong>Good snowboard!<\/strong>", "created_at": "2015-03-28T13:31:36-04:00", "handle": "burton-custom-freestlye-151", "id": 1071559579, "product_type": "Snowboard", "published_at": "2015-03-28T13:31:36-04:00", "published_scope": "global", "template_suffix": null, "title": "Burton Custom Freestlye 151", "updated_at": "2015-03-28T13:31:36-04:00", "vendor": "Burton", "tags": "", "variants": [ { "barcode": null, "compare_at_price": null, "created_at": "2015-03-28T13:31:36-04:00", "fulfillment_service": "manual", "grams": 0, "id": 1044399223, "inventory_management": null, "inventory_policy": "deny", "option1": "Default Title", "option2": null, "option3": null, "position": 1, "price": "0.00", "product_id": 1071559579, "requires_shipping": true, "sku": "", "taxable": true, "title": "Default Title", "updated_at": "2015-03-28T13:31:36-04:00", "inventory_quantity": 1, "old_inventory_quantity": 1, "image_id": null, "weight": 0.0, "weight_unit": "kg" } ], "options": [ { "id": 1020890289, "name": "Title", "position": 1, "product_id": 1071559579 } ], "images": [ { "created_at": "2015-03-28T13:31:36-04:00", "id": 1003141238, "position": 1, "product_id": 1071559579, "updated_at": "2015-03-28T13:31:36-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/rails_logo.gif?v=1427563896", "variant_ids": [ ] } ], "image": { "created_at": "2015-03-28T13:31:36-04:00", "id": 1003141238, "position": 1, "product_id": 1071559579, "updated_at": "2015-03-28T13:31:36-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/rails_logo.gif?v=1427563896", "variant_ids": [ ] } } }
Trying to create a product without a title will return an error
HTTP/1.1 422 Unprocessable Entity { "errors": { "title": [ "can't be blank" ] } }
Create a new product with the default product variant
POST /com/products.json
{ "product": { "title": "Burton Custom Freestlye 151", "body_html": "<strong>Good snowboard!<\/strong>", "vendor": "Burton", "product_type": "Snowboard", "tags": "Barnes & Noble, John's Fav, \"Big Air\"" } }View Response
HTTP/1.1 201 Created { "product": { "body_html": "<strong>Good snowboard!<\/strong>", "created_at": "2015-03-28T13:31:37-04:00", "handle": "burton-custom-freestlye-151", "id": 1071559581, "product_type": "Snowboard", "published_at": "2015-03-28T13:31:37-04:00", "published_scope": "global", "template_suffix": null, "title": "Burton Custom Freestlye 151", "updated_at": "2015-03-28T13:31:37-04:00", "vendor": "Burton", "tags": "\"Big Air\", Barnes & Noble, John's Fav", "variants": [ { "barcode": null, "compare_at_price": null, "created_at": "2015-03-28T13:31:37-04:00", "fulfillment_service": "manual", "grams": 0, "id": 1044399225, "inventory_management": null, "inventory_policy": "deny", "option1": "Default Title", "option2": null, "option3": null, "position": 1, "price": "0.00", "product_id": 1071559581, "requires_shipping": true, "sku": "", "taxable": true, "title": "Default Title", "updated_at": "2015-03-28T13:31:37-04:00", "inventory_quantity": 1, "old_inventory_quantity": 1, "image_id": null, "weight": 0.0, "weight_unit": "kg" } ], "options": [ { "id": 1020890291, "name": "Title", "position": 1, "product_id": 1071559581 } ], "images": [ ] } }
PUT/com/products/632910392.json
Update a product and associated variants and images
Update a product's title
PUT /com/products/#{id}.json
{ "product": { "id": 632910392, "title": "New product title" } }View Response
HTTP/1.1 200 OK { "product": { "body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.<\/p>", "created_at": "2015-03-28T13:31:19-04:00", "handle": "ipod-nano", "id": 632910392, "product_type": "Cult Products", "published_at": "2007-12-31T19:00:00-05:00", "published_scope": "web", "template_suffix": null, "title": "New product title", "updated_at": "2015-03-28T13:31:40-04:00", "vendor": "Apple", "tags": "Emotive, Flash Memory, MP3, Music", "variants": [ { "barcode": "1234_pink", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 808950810, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Pink", "option2": null, "option3": null, "position": 1, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008PINK", "taxable": true, "title": "Pink", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 10, "old_inventory_quantity": 10, "image_id": 562641783, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_red", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 49148385, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Red", "option2": null, "option3": null, "position": 2, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008RED", "taxable": true, "title": "Red", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 20, "old_inventory_quantity": 20, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_green", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 39072856, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Green", "option2": null, "option3": null, "position": 3, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008GREEN", "taxable": true, "title": "Green", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 30, "old_inventory_quantity": 30, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_black", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 457924702, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Black", "option2": null, "option3": null, "position": 4, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008BLACK", "taxable": true, "title": "Black", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 40, "old_inventory_quantity": 40, "image_id": null, "weight": 0.2, "weight_unit": "kg" } ], "options": [ { "id": 594680422, "name": "Title", "position": 1, "product_id": 632910392 } ], "images": [ { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] }, { "created_at": "2015-03-28T13:31:19-04:00", "id": 562641783, "position": 2, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano-2.png?v=1427563879", "variant_ids": [ 808950810 ] } ], "image": { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] } } }
Update a product's tags
PUT /com/products/#{id}.json
{ "product": { "id": 632910392, "tags": "Barnes & Noble, John's Fav" } }View Response
HTTP/1.1 200 OK { "product": { "body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.<\/p>", "created_at": "2015-03-28T13:31:19-04:00", "handle": "ipod-nano", "id": 632910392, "product_type": "Cult Products", "published_at": "2007-12-31T19:00:00-05:00", "published_scope": "web", "template_suffix": null, "title": "IPod Nano - 8GB", "updated_at": "2015-03-28T13:31:40-04:00", "vendor": "Apple", "tags": "Barnes & Noble, John's Fav", "variants": [ { "barcode": "1234_pink", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 808950810, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Pink", "option2": null, "option3": null, "position": 1, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008PINK", "taxable": true, "title": "Pink", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 10, "old_inventory_quantity": 10, "image_id": 562641783, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_red", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 49148385, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Red", "option2": null, "option3": null, "position": 2, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008RED", "taxable": true, "title": "Red", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 20, "old_inventory_quantity": 20, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_green", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 39072856, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Green", "option2": null, "option3": null, "position": 3, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008GREEN", "taxable": true, "title": "Green", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 30, "old_inventory_quantity": 30, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_black", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 457924702, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Black", "option2": null, "option3": null, "position": 4, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008BLACK", "taxable": true, "title": "Black", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 40, "old_inventory_quantity": 40, "image_id": null, "weight": 0.2, "weight_unit": "kg" } ], "options": [ { "id": 594680422, "name": "Title", "position": 1, "product_id": 632910392 } ], "images": [ { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] }, { "created_at": "2015-03-28T13:31:19-04:00", "id": 562641783, "position": 2, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano-2.png?v=1427563879", "variant_ids": [ 808950810 ] } ], "image": { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] } } }
Update a product, clearing product images
HTTP/1.1 200 OK { "product": { "body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.<\/p>", "created_at": "2015-03-28T13:31:19-04:00", "handle": "ipod-nano", "id": 632910392, "product_type": "Cult Products", "published_at": "2007-12-31T19:00:00-05:00", "published_scope": "web", "template_suffix": null, "title": "IPod Nano - 8GB", "updated_at": "2015-03-28T13:31:41-04:00", "vendor": "Apple", "tags": "Emotive, Flash Memory, MP3, Music", "variants": [ { "barcode": "1234_pink", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 808950810, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Pink", "option2": null, "option3": null, "position": 1, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008PINK", "taxable": true, "title": "Pink", "updated_at": "2015-03-28T13:31:41-04:00", "inventory_quantity": 10, "old_inventory_quantity": 10, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_red", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 49148385, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Red", "option2": null, "option3": null, "position": 2, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008RED", "taxable": true, "title": "Red", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 20, "old_inventory_quantity": 20, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_green", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 39072856, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Green", "option2": null, "option3": null, "position": 3, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008GREEN", "taxable": true, "title": "Green", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 30, "old_inventory_quantity": 30, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_black", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 457924702, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Black", "option2": null, "option3": null, "position": 4, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008BLACK", "taxable": true, "title": "Black", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 40, "old_inventory_quantity": 40, "image_id": null, "weight": 0.2, "weight_unit": "kg" } ], "options": [ { "id": 594680422, "name": "Title", "position": 1, "product_id": 632910392 } ], "images": [ ] } }
Update a product, adding a new product image
PUT /com/products/#{id}.json
{ "product": { "id": 632910392, "images": [ { "id": 850703190 }, { "id": 562641783 }, { "src": "http:\/\/example.com\/rails_logo.gif" } ] } }View Response
HTTP/1.1 200 OK { "product": { "body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.<\/p>", "created_at": "2015-03-28T13:31:19-04:00", "handle": "ipod-nano", "id": 632910392, "product_type": "Cult Products", "published_at": "2007-12-31T19:00:00-05:00", "published_scope": "web", "template_suffix": null, "title": "IPod Nano - 8GB", "updated_at": "2015-03-28T13:31:41-04:00", "vendor": "Apple", "tags": "Emotive, Flash Memory, MP3, Music", "variants": [ { "barcode": "1234_pink", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 808950810, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Pink", "option2": null, "option3": null, "position": 1, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008PINK", "taxable": true, "title": "Pink", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 10, "old_inventory_quantity": 10, "image_id": 562641783, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_red", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 49148385, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Red", "option2": null, "option3": null, "position": 2, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008RED", "taxable": true, "title": "Red", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 20, "old_inventory_quantity": 20, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_green", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 39072856, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Green", "option2": null, "option3": null, "position": 3, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008GREEN", "taxable": true, "title": "Green", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 30, "old_inventory_quantity": 30, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_black", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 457924702, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Black", "option2": null, "option3": null, "position": 4, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008BLACK", "taxable": true, "title": "Black", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 40, "old_inventory_quantity": 40, "image_id": null, "weight": 0.2, "weight_unit": "kg" } ], "options": [ { "id": 594680422, "name": "Title", "position": 1, "product_id": 632910392 } ], "images": [ { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] }, { "created_at": "2015-03-28T13:31:19-04:00", "id": 562641783, "position": 2, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano-2.png?v=1427563879", "variant_ids": [ 808950810 ] }, { "created_at": "2015-03-28T13:31:41-04:00", "id": 1003141239, "position": 3, "product_id": 632910392, "updated_at": "2015-03-28T13:31:41-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/rails_logo.gif?v=1427563901", "variant_ids": [ ] } ], "image": { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] } } }
Update a product, reordering product image
PUT /com/products/#{id}.json
{ "product": { "id": 632910392, "images": [ { "id": 850703190, "position": 2 }, { "id": 562641783, "position": 1 } ] } }View Response
HTTP/1.1 200 OK { "product": { "body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.<\/p>", "created_at": "2015-03-28T13:31:19-04:00", "handle": "ipod-nano", "id": 632910392, "product_type": "Cult Products", "published_at": "2007-12-31T19:00:00-05:00", "published_scope": "web", "template_suffix": null, "title": "IPod Nano - 8GB", "updated_at": "2015-03-28T13:31:42-04:00", "vendor": "Apple", "tags": "Emotive, Flash Memory, MP3, Music", "variants": [ { "barcode": "1234_pink", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 808950810, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Pink", "option2": null, "option3": null, "position": 1, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008PINK", "taxable": true, "title": "Pink", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 10, "old_inventory_quantity": 10, "image_id": 562641783, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_red", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 49148385, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Red", "option2": null, "option3": null, "position": 2, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008RED", "taxable": true, "title": "Red", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 20, "old_inventory_quantity": 20, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_green", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 39072856, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Green", "option2": null, "option3": null, "position": 3, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008GREEN", "taxable": true, "title": "Green", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 30, "old_inventory_quantity": 30, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_black", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 457924702, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Black", "option2": null, "option3": null, "position": 4, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008BLACK", "taxable": true, "title": "Black", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 40, "old_inventory_quantity": 40, "image_id": null, "weight": 0.2, "weight_unit": "kg" } ], "options": [ { "id": 594680422, "name": "Title", "position": 1, "product_id": 632910392 } ], "images": [ { "created_at": "2015-03-28T13:31:19-04:00", "id": 562641783, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:42-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano-2.png?v=1427563902", "variant_ids": [ 808950810 ] }, { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 2, "product_id": 632910392, "updated_at": "2015-03-28T13:31:42-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563902", "variant_ids": [ ] } ], "image": { "created_at": "2015-03-28T13:31:19-04:00", "id": 562641783, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:42-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano-2.png?v=1427563902", "variant_ids": [ 808950810 ] } } }
Update a product, reordering the product variants
PUT /com/products/#{id}.json
{ "product": { "id": 632910392, "variants": [ { "id": 457924702 }, { "id": 39072856 }, { "id": 49148385 }, { "id": 808950810 } ] } }View Response
HTTP/1.1 200 OK { "product": { "body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.<\/p>", "created_at": "2015-03-28T13:31:19-04:00", "handle": "ipod-nano", "id": 632910392, "product_type": "Cult Products", "published_at": "2007-12-31T19:00:00-05:00", "published_scope": "web", "template_suffix": null, "title": "IPod Nano - 8GB", "updated_at": "2015-03-28T13:31:43-04:00", "vendor": "Apple", "tags": "Emotive, Flash Memory, MP3, Music", "variants": [ { "barcode": "1234_black", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 457924702, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Black", "option2": null, "option3": null, "position": 1, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008BLACK", "taxable": true, "title": "Black", "updated_at": "2015-03-28T13:31:43-04:00", "inventory_quantity": 40, "old_inventory_quantity": 40, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_green", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 39072856, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Green", "option2": null, "option3": null, "position": 2, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008GREEN", "taxable": true, "title": "Green", "updated_at": "2015-03-28T13:31:43-04:00", "inventory_quantity": 30, "old_inventory_quantity": 30, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_red", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 49148385, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Red", "option2": null, "option3": null, "position": 3, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008RED", "taxable": true, "title": "Red", "updated_at": "2015-03-28T13:31:43-04:00", "inventory_quantity": 20, "old_inventory_quantity": 20, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_pink", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 808950810, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Pink", "option2": null, "option3": null, "position": 4, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008PINK", "taxable": true, "title": "Pink", "updated_at": "2015-03-28T13:31:43-04:00", "inventory_quantity": 10, "old_inventory_quantity": 10, "image_id": 562641783, "weight": 0.2, "weight_unit": "kg" } ], "options": [ { "id": 594680422, "name": "Title", "position": 1, "product_id": 632910392 } ], "images": [ { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] }, { "created_at": "2015-03-28T13:31:19-04:00", "id": 562641783, "position": 2, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano-2.png?v=1427563879", "variant_ids": [ 808950810 ] } ], "image": { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] } } }
Update a product and one of it's variants
PUT /com/products/#{id}.json
{ "product": { "body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.<\/p>", "created_at": "2015-03-28T13:31:19-04:00", "handle": "ipod-nano", "id": 632910392, "product_type": "Cult Products", "published_at": "2007-12-31T19:00:00-05:00", "published_scope": "web", "template_suffix": null, "title": "Updated Product Title", "updated_at": "2015-03-28T13:31:19-04:00", "vendor": "Apple", "tags": "Emotive, Flash Memory, MP3, Music", "variants": [ { "barcode": "1234_pink", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 808950810, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Pink", "option2": null, "option3": null, "position": 1, "price": "2000.00", "requires_shipping": true, "sku": "Updating the Product SKU", "taxable": true, "title": "Pink", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 10, "old_inventory_quantity": 10, "image_id": 562641783, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_red", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 49148385, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Red", "option2": null, "option3": null, "position": 2, "price": "199.00", "requires_shipping": true, "sku": "IPOD2008RED", "taxable": true, "title": "Red", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 20, "old_inventory_quantity": 20, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_green", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 39072856, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Green", "option2": null, "option3": null, "position": 3, "price": "199.00", "requires_shipping": true, "sku": "IPOD2008GREEN", "taxable": true, "title": "Green", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 30, "old_inventory_quantity": 30, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_black", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 457924702, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Black", "option2": null, "option3": null, "position": 4, "price": "199.00", "requires_shipping": true, "sku": "IPOD2008BLACK", "taxable": true, "title": "Black", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 40, "old_inventory_quantity": 40, "image_id": null, "weight": 0.2, "weight_unit": "kg" } ], "options": [ { "id": 594680422, "name": "Title", "position": 1, "product_id": 632910392 } ], "images": [ { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] }, { "created_at": "2015-03-28T13:31:19-04:00", "id": 562641783, "position": 2, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano-2.png?v=1427563879", "variant_ids": [ 808950810 ] } ], "image": { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] } } }View Response
HTTP/1.1 200 OK { "product": { "body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.<\/p>", "created_at": "2015-03-28T13:31:19-04:00", "handle": "ipod-nano", "id": 632910392, "product_type": "Cult Products", "published_at": "2007-12-31T19:00:00-05:00", "published_scope": "web", "template_suffix": null, "title": "Updated Product Title", "updated_at": "2015-03-28T13:31:43-04:00", "vendor": "Apple", "tags": "Emotive, Flash Memory, MP3, Music", "variants": [ { "barcode": "1234_pink", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 808950810, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Pink", "option2": null, "option3": null, "position": 1, "price": "2000.00", "product_id": 632910392, "requires_shipping": true, "sku": "Updating the Product SKU", "taxable": true, "title": "Pink", "updated_at": "2015-03-28T13:31:43-04:00", "inventory_quantity": 10, "old_inventory_quantity": 10, "image_id": 562641783, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_red", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 49148385, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Red", "option2": null, "option3": null, "position": 2, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008RED", "taxable": true, "title": "Red", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 20, "old_inventory_quantity": 20, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_green", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 39072856, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Green", "option2": null, "option3": null, "position": 3, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008GREEN", "taxable": true, "title": "Green", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 30, "old_inventory_quantity": 30, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_black", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 457924702, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Black", "option2": null, "option3": null, "position": 4, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008BLACK", "taxable": true, "title": "Black", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 40, "old_inventory_quantity": 40, "image_id": null, "weight": 0.2, "weight_unit": "kg" } ], "options": [ { "id": 594680422, "name": "Title", "position": 1, "product_id": 632910392 } ], "images": [ { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] }, { "created_at": "2015-03-28T13:31:19-04:00", "id": 562641783, "position": 2, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano-2.png?v=1427563879", "variant_ids": [ 808950810 ] } ], "image": { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] } } }
Show a hidden product by changing the published attribute to true
HTTP/1.1 200 OK { "product": { "body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.<\/p>", "created_at": "2015-03-28T13:31:19-04:00", "handle": "ipod-nano", "id": 632910392, "product_type": "Cult Products", "published_at": "2015-03-28T13:31:44-04:00", "published_scope": "web", "template_suffix": null, "title": "IPod Nano - 8GB", "updated_at": "2015-03-28T13:31:44-04:00", "vendor": "Apple", "tags": "Emotive, Flash Memory, MP3, Music", "variants": [ { "barcode": "1234_pink", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 808950810, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Pink", "option2": null, "option3": null, "position": 1, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008PINK", "taxable": true, "title": "Pink", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 10, "old_inventory_quantity": 10, "image_id": 562641783, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_red", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 49148385, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Red", "option2": null, "option3": null, "position": 2, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008RED", "taxable": true, "title": "Red", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 20, "old_inventory_quantity": 20, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_green", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 39072856, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Green", "option2": null, "option3": null, "position": 3, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008GREEN", "taxable": true, "title": "Green", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 30, "old_inventory_quantity": 30, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_black", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 457924702, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Black", "option2": null, "option3": null, "position": 4, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008BLACK", "taxable": true, "title": "Black", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 40, "old_inventory_quantity": 40, "image_id": null, "weight": 0.2, "weight_unit": "kg" } ], "options": [ { "id": 594680422, "name": "Title", "position": 1, "product_id": 632910392 } ], "images": [ { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] }, { "created_at": "2015-03-28T13:31:19-04:00", "id": 562641783, "position": 2, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano-2.png?v=1427563879", "variant_ids": [ 808950810 ] } ], "image": { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] } } }
Hide a published product by changing the published attribute to false
HTTP/1.1 200 OK { "product": { "body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.<\/p>", "created_at": "2015-03-28T13:31:19-04:00", "handle": "ipod-nano", "id": 632910392, "product_type": "Cult Products", "published_at": null, "published_scope": "web", "template_suffix": null, "title": "IPod Nano - 8GB", "updated_at": "2015-03-28T13:31:44-04:00", "vendor": "Apple", "tags": "Emotive, Flash Memory, MP3, Music", "variants": [ { "barcode": "1234_pink", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 808950810, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Pink", "option2": null, "option3": null, "position": 1, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008PINK", "taxable": true, "title": "Pink", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 10, "old_inventory_quantity": 10, "image_id": 562641783, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_red", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 49148385, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Red", "option2": null, "option3": null, "position": 2, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008RED", "taxable": true, "title": "Red", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 20, "old_inventory_quantity": 20, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_green", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 39072856, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Green", "option2": null, "option3": null, "position": 3, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008GREEN", "taxable": true, "title": "Green", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 30, "old_inventory_quantity": 30, "image_id": null, "weight": 0.2, "weight_unit": "kg" }, { "barcode": "1234_black", "compare_at_price": null, "created_at": "2015-03-28T13:31:19-04:00", "fulfillment_service": "manual", "grams": 200, "id": 457924702, "inventory_management": "haravan", "inventory_policy": "continue", "option1": "Black", "option2": null, "option3": null, "position": 4, "price": "199.00", "product_id": 632910392, "requires_shipping": true, "sku": "IPOD2008BLACK", "taxable": true, "title": "Black", "updated_at": "2015-03-28T13:31:19-04:00", "inventory_quantity": 40, "old_inventory_quantity": 40, "image_id": null, "weight": 0.2, "weight_unit": "kg" } ], "options": [ { "id": 594680422, "name": "Title", "position": 1, "product_id": 632910392 } ], "images": [ { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] }, { "created_at": "2015-03-28T13:31:19-04:00", "id": 562641783, "position": 2, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano-2.png?v=1427563879", "variant_ids": [ 808950810 ] } ], "image": { "created_at": "2015-03-28T13:31:19-04:00", "id": 850703190, "position": 1, "product_id": 632910392, "updated_at": "2015-03-28T13:31:19-04:00", "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/products\/ipod-nano.png?v=1427563879", "variant_ids": [ ] } } }
DELETE/com/products/632910392.json
Remove a product from the shop
Delete a product along with all its variants and images
DELETE /com/products/#{id}.json
View ResponseHTTP/1.1 200 OK {}