API Reference

Product Image

Product Image

haravan API - Developer Resources Product ImageProduct ImageProducts are easier to sell if customers can see pictures of them, which is why there are product images.Any product may have up to 250 images, and images can be in .png, .gif or .jpg format.What can you do with Product Image?The haravan...

Province

Province

haravan API - Developer Resources ProvinceProvinceShop owners can specify which country or countries they will ship to and these countries are made available through the API using the country resource. Shop owners can do this by navigating to the "Preferences" tab under "Regions & Taxes." If any of those countries...

Comment

Comment

haravan API - Developer Resources CommentCommentA comment is a reader's response to an article in a blog. They appear on the article page in chronological order, typically after the article body.Just as a blog can have any number of articles, an article can have any number of comments. Blog comments...

Redirect

Redirect

haravan API - Developer Resources RedirectRedirectA redirect causes a visitor on a specific path on the shop's site to be automatically sent to a target (different location). The target can be a new location on the shop's site, or a full URL, even one on a completely different domain. Redirect...

Policy

Policy

haravan API - Developer Resources PolicyPolicyThe list of policies that a merchant has configured for their store, such as their refund or privacy policies.Only the shop owner can edit this information from inside their shop admin dashboard by navigating to the "Settings" tab and selecting the "General" tab. The API...

CustomCollection

CustomCollection

haravan API - Developer Resources CustomCollectionCustomCollectionA custom collection is a grouping of products that a shop owner can create to make their shops easier to browse. A shop owner creates a custom collection and then selects the products that will go into it.Custom collections are typically displayed to customers so...

FulfillmentService

FulfillmentService

haravan API - Developer Resources FulfillmentServiceFulfillmentServiceA Fulfillment Service is a third party warehouse that prepares and ships orders on behalf of the store owner. Fulfillment services charge a fee to package and ship items and update product inventory levels. Some well known fulfillment services with haravan integrations include: Amazon, Shipwire,...

Location

Location

haravan API - Developer Resources LocationLocationA Location represents a geographical location where your stores, headquarters, and/or pop-up shops exist. These locations can be used to track sales and to help haravan configure the tax rates to charge when selling products.What can you do with Location?The haravan API lets you do...

Product

Product

haravan API - Developer Resources ProductProductA 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...

RecurringApplicationCharge

RecurringApplicationCharge

haravan API - Developer Resources RecurringApplicationChargeRecurringApplicationChargeRequest to charge a shop a recurring fee (every 30 days) by issuing this call with the name the charge should appear under (on the shop owner’s invoice), the price your application is charging, and a return_url to where haravan will redirect the shop owner...

SmartCollection

SmartCollection

haravan API - Developer Resources SmartCollectionSmartCollectionA smart collection is a grouping of products defined by simple rules set by shop owners. A shop owner creates a smart collection and then sets the rules that determine which products go in them. haravan automatically changes the contents of smart collections based on...

SmartCollection

SmartCollection

haravan API - Developer Resources SmartCollectionSmartCollectionA smart collection is a grouping of products defined by simple rules set by shop owners. A shop owner creates a smart collection and then sets the rules that determine which products go in them. haravan automatically changes the contents of smart collections based on...

Fulfillment

Fulfillment

haravan API - Developer Resources FulfillmentFulfillmentA fulfillment represents a shipment of one or more items in an order. When we say that an order has been completely fulfilled, we mean that all the items that make up that order have been sent to the customer.Ideally, a shop owner would want...

Transaction

Transaction

haravan API - Developer Resources TransactionTransactionTransactions are created for every order that results in an exchange of money.There are five types of transactions:Authorization: represents an amount reserved against the cardholder's funding source. Money does not change hands until an authorization is captured.Sale: an authorization and capture performed together in a...

Product Variant

Product Variant

haravan API - Developer Resources Product VariantProduct VariantA product variant is a different version of a product, such as differing sizes or differing colours.Without product variants, you would have to treat the small, medium and large versions of a t-shirt as three separate products; product variants let you treat the...

Metafield

Metafield

haravan API - Developer Resources MetafieldMetafieldMetafields allow you to attach metadata, which is additional information, to a store's resources.Metafields can be added to:BlogsCustom CollectionsCustomersOrdersPagesProductsProduct VariantsMetafields have four required properties: a key, a namespace, a value and a value_type. The key is the identifier for a metafield. The namespace functions a...

Order

Order

haravan API - Developer Resources OrderOrderAn order is a customer's completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time s/he provides an email address, billing address and payment information.You should note that orders can...

Blog

Blog

haravan API - Developer Resources BlogBlogIn addition to an online storefront, haravan shops come with a built-in blogging engine, allowing a shop to have one or more blogs.Shop owners are encouraged to use blogs to:Make announcementsTalk about their products in more detailShow off their expertiseConnect with their customers andBoost their...

Collect

Collect

haravan API - Developer Resources CollectCollectA collect is an object that connects a product to a custom collection.For every product in a custom collection there exists a collect that tracks the ids of both the product and the custom collection it's a member of. A product can be a member...

Country

Country

haravan API - Developer Resources CountryCountryShop owners can specify the country or countries they will ship their products to. Shop owners are able to do this through their shop admin dashboard in the "Settings" tab, under the "Taxes" tab.These countries are made available through the API using the country resource....

Customer

Customer

haravan API - Developer Resources CustomerCustomerA customer resource instance represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. For security reasons, the customer resoruce instance does not store credit card information....

CustomerAddress

CustomerAddress

haravan API - Developer Resources CustomerAddressCustomerAddressA customer address resource instance represents one of the many addresses a customer may haveFor more information about Customers, see the Customer API DocumentationWhat can you do with CustomerAddress?The haravan API lets you do the following with the CustomerAddress resource. More detailed versions of these...

Order Risks

Order Risks

haravan API - Developer Resources Order RisksOrder RisksThe Order risk assessment is used to indicate to a merchant the fraud checks that have been done on an order.What can you do with Order Risks?The haravan API lets you do the following with the Order Risks resource. More detailed versions of...

Event

Event

haravan API - Developer Resources EventEventEvents are generated by specific haravan resources when specific things happen, such as the creation of an article, the placement or fulfillment of an order, the addition or deletion of a product, and so on. By requesting events, your app can get a "log" of...

CustomerSavedSearch

CustomerSavedSearch

haravan API - Developer Resources CustomerSavedSearchCustomerSavedSearchA customer saved search is a search query representing a group of customers as defined by the shop owner.In the admin, the shop owner searches for customers by applying one or more filters. As soon as the first filter is applied, the shop owner has...

Theme

Theme

haravan API - Developer Resources ThemeThemeA theme is the look and feel template for your haravan shop.A shop can have multiple themes which take the role of either "published" or "unpublished". Each shop can have 20 themes total, including one main theme, and a max of 19 unpublished themes. The...

Checkout

Checkout

haravan API - Developer Resources CheckoutCheckoutThis is used to return abandoned checkouts. A checkout is considered abandoned when a customer has entered their billing & shipping info, but has yet to complete the purchase.What can you do with Checkout?The haravan API lets you do the following with the Checkout resource....

Shop

Shop

haravan API - Developer Resources ShopShopThe haravan API's shop object is a collection of the general settings and information about the shop.Only the shop owner can edit this information from inside their shop admin dashboard by navigating to the "Settings" tab and selecting the "General" tab. The API doesn't let...

Asset

Asset

haravan API - Developer Resources AssetAssetAssets are individual files that make up a shop's theme.Assets can be any additional file; from images and stylesheets to extra snippets of code. Assets can be easily added, changed or removed from a shop's theme.What can you do with Asset?The haravan API lets you...

CarrierService

CarrierService

haravan API - Developer Resources CarrierServiceCarrierServiceA Carrier Service (also known as a Carrier Calculated Service or Shipping Service) provides real-time shipping rates to haravan. Some common carrier services include: FedEx, USPS and UPS.ReminderAccess to the Carrier Services API requires the store be on the Unlimited Plan or higher. The term...

User

User

haravan API - Developer Resources UserUserInformationThe User resource is currently only available to haravan Plus Customers.What can you do with User?The haravan API lets you do the following with the User resource. More detailed versions of these general actions may be available: GET /admin/users.json Receive a list of all...

Refund

Refund

haravan API - Developer Resources RefundRefundA refund is a record of the money returned to the customer, and/or the return of any items on an order which may or may not have been restocked.What can you do with Refund?The haravan API lets you do the following with the Refund resource....

Webhook

Webhook

haravan API - Developer Resources WebhookWebhookA Webhook is a tool for retrieving and storing data from a certain event. It allows you to register an http:// or https:// URL where the event data can be stored in JSON or XML formats. Webhooks can be registered for the following events:AppuninstalledCartscreate/updateCheckoutscreate/delete/updateCollectionscreate/update/deleteCustomer groupscreate/update/deleteCustomerscreate/delete/disable/enable/updateDisputescreate/updateFulfillmentscreate/updateOrderscreate/delete/updated/paid/cancelled/fulfilled/partially_fulfilledOrder...

Metafield

Metafield

haravan API - Developer Resources MetafieldMetafieldMetafields allow you to attach metadata, which is additional information, to a store's resources.Metafields can be added to:BlogsCustom CollectionsCustomersOrdersPagesProductsProduct VariantsMetafields have four required properties: a key, a namespace, a value and a value_type. The key is the identifier for a metafield. The namespace functions a...

Policy

Policy

haravan API - Developer Resources PolicyPolicyThe list of policies that a merchant has configured for their store, such as their refund or privacy policies.Only the shop owner can edit this information from inside their shop admin dashboard by navigating to the "Settings" tab and selecting the "General" tab. The API...