Toll free - 1800 102 9944Mon - Sat 9am to 6pm IST+91 7305654908Contact Us

Introduction

Zakya API allows you to perform all the operations that you do with our web client.

Zakya API is built using REST principles which ensures predictable URLs that makes writing applications easy. This API follows HTTP rules, enabling a wide range of HTTP clients which can be used to interact with the API.

Every resource is exposed as a URL. The URL of each resource can be obtained by accessing the API Root Endpoint.

API Root DomainCopy
https://api.zakya.com/

Organization ID

In Zakya, your business is termed as an organization. If you have multiple businesses, you simply set each of those up as an individual organization. Each organization is an independent Zakya Organization with it’s own organization ID, base currency, time zone, language, contacts, reports, etc.

The parameter organization_id along with the organization ID should be sent in with every API request to identify the organization.

The organization_id can be obtained from the GET /organizations API’s JSON response. Alternatively, it can be obtained from the Manage Organizations page in the admin console:

Login to the Zakya admin console. Click the drop down with organization’s name as the label and click Manage Organizations.

Request ExampleCopy
$ curl https://api.zakya.com/v1/organizations
Response ExampleCopy
{
  "code": 0,
  "message": "success",
  "organizations": [
    {
      "organization_id": "10229182",
      "name": "Zillium Inc",
      "contact_name": "John Smith",
      "email": "johndavid@zilliuminc.com",
      "is_default_org": false,
      "plan_type": 130,
      "tax_group_enabled": true,
      "zi_migration_status": 0,
      "plan_name": "Trial",
      "plan_period": "Monthly",
      "language_code": "en",
      "fiscal_year_start_month": 0,
      "account_created_date": "2012-02-15",
      "account_created_date_formatted": "15 Feb 2012",
      "time_zone": "PST",
      "is_org_active": true,
      "currency_id": "982000000000190",
      "currency_code": "USD",
      "currency_symbol": "$",
      "currency_format": "###,##0.00",
      "price_precision": 2,
      "gst_registartion_type": "Regular",
      "gst_no": "22AAAAA0000A1Z5",
      "business_type": "Apparel, Footwear & Accessories",
      "is_orgDeletion_allowed": false
    },
    {...},
    {...}
  ]
}

Multiple Data Centers

Zakya is hosted at multiple data centers, and therefore available on different domains.

There are 2 different domains for Zakya's APIs, and you will have to use the one that is applicable to you.

Data Center

Domain

Base API URI

United States

.com

https://api.zakya.com

India

.in

https://api.zakya.in

The APIs on this page are for organizations in Zakya that are hosted on the .com domain. If your organization is on a different domain, then you must replace .com with the appropriate domain for API endpoints on this page before using them.

Note

  • To find out which domain you're accessing Zakya from, visit the Zakya web app and check its URL. If the URL contains app.zakya.com, then you're accessing it from the .com domain. If the URL contains app.zakya.in, you're accessing it from the .in domain.

For example, here's how you would modify the domain in an API endpoint for the .in domain:

API endpoint for the .com domain, as available on this page:

https://api.zakya.com/inventory/v1/invoices

API endpoint after replacing the .com domain with .in:

https://api.zakya.in/inventory/v1/invoices

API Call Limit

API calls are limited to provide better quality of service and availability to all the users. The limits on total requests per day are listed below for each plan:

  • Free/Trial Plan - 1500 API requests/day
  • Standard Plan- 2500 requests/day

A threshold of 100 API requests per minute applies for all the APIs