haravan API - Developer Resources Product

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 /admin/products.json Receive a list of all Products
GET /admin/products/count.json Receive a count of all Products
GET /admin/products/#{id}.json Receive a single Product
POST /admin/products.json Create a new Product
PUT /admin/products/#{id}.json Modify an existing Product
DELETE /admin/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" : "2012-02-15T15:12:21-05:00" }` 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" : "2007-12-31T19:00:00-05:00" }` 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" : "2012-08-24T14:01:47-04:00" }` 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. barcode: The barcode, UPC or ISBN number for the product. compare_at_price: The competitors price for the same item. created_at: The date and time when the product variant was created. The API returns this value in ISO 8601 format. fulfillment_service: Service who is doing the fulfillment. Valid values are: manual, grams: The weight of the product variant in grams. weight: The weight of the product variant in the unit system specified with weight_unit. weight_unit: The unit system that the product variant's weight is measure in. The weight_unit can be either "g", "kg, "oz", or "lb". id: The unique numeric identifier for the product variant. inventory_management: Specifies whether or not haravan tracks the number of items in stock for this product variant. inventory_policy: Specifies whether or not customers are allowed to place an order for a product variant when it's out of stock. inventory_quantity: The number of items in stock for this product variant. metafield: Attaches additional information to a shop's resources. option: Custom properties that a shop owner can use to define product variants. Multiple options can exist. Options are represented as: option1, option2, option3 etc. position: The order of the product variant in the list of product variants. 1 is the first position. To reorder variants, update the product with the variants in the desired order. The position attribute on the variant will be ignored. price: The price of the product variant. product_id: The unique numeric identifier for the product. requires_shipping: Specifies whether or not a customer needs to provide a shipping address when placing an order for this product variant. sku: A unique identifier for the product in the shop. taxable: Specifies whether or not a tax is charged when the product variant is sole. title: The title of the product variant. updated_at: The date and time when the product variant was last modified. The API returns this value in ISO 8601 format.
vendor	`{ "vendor" : "Apple" }` The name of the vendor of the product.

Endpoints

GET/admin/products.json

Get a list of products

ids	A comma-separated list of product ids
limit	Amount of results (default: 50) (maximum: 250)
page	Page to show (default: 1)
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-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	published - Show only published products unpublished - Show only unpublished products any - Show all products (default)
fields	comma-separated list of fields to include in the response

Get all products

GET /admin/products.json

Product

What can you do with Product?

Product Properties

Endpoints

Get all products

Get a specific list of products

Get all products, showing only some attributes

Fetches all products that belong to a certain collection

Get all products after the specified ID

Count all products

Counts all products that belong to a certain collection

Get a single product by ID

Get only particular fields

Create a new, but unpublished product

Create a new product with multiple product variants

Create a new product with the default variant and base64 encoded image

Create a new product with the default variant and a product image which will be downloaded by haravan

Trying to create a product without a title will return an error

Create a product with a metafield

Create a new product with the default product variant

Update a product's title

Update a product's tags

Update a product, clearing product images

Update a product, adding a new product image

Update a product, reordering product image

Update a product, reordering the product variants

Update a product and one of it's variants

Show a hidden product by changing the published attribute to true

Hide a published product by changing the published attribute to false

Add a metafield to an existing product

Delete a product along with all its variants and images

Haravan.com

Học viện Haravan

Hỗ trợ

Thông tin liên hệ

Kết nối với Haravan trên mạng xã hội