Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zoho Inventory pricelists API

PriceLists Module

Zoho Inventory pricelists API is one of 37 APIs that Zoho Inventory publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include pricelists. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 6 operations across 4 paths, and defines 31 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://www.zohoapis.com/inventory/v1.

6 operations 4 paths 31 schemas 1 DELETE1 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://www.zohoapis.com/inventory/v1
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Zoho Inventory pricelists API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (Zoho_Auth) using the implicit flow, exposing 4 scopes.

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 1 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

pricelists 6

PriceLists Module

POST
/pricebooks
Create a pricebook
create_pricebook 1 param body → 201
GET
/pricebooks
List all pricebooks
list_pricebooks 5 params → 200
PUT
/pricebooks/{pricebook_id}
Update pricebook
update_pricebook 2 params body → 200
DELETE
/pricebooks/{pricebook_id}
Delete the pricebook
delete_pricebook 2 params → 200
POST
/pricebooks/{pricebook_id}/active
Mark as Active
mark_pricebook_active 2 params → 200
POST
/pricebooks/{pricebook_id}/inactive
Mark as Inactive
mark_pricebook_inactive 2 params → 200

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are pricebook (16 properties), update-pricebook-request (12 properties), create-a-pricebook-request (12 properties), price_bracket (5 properties). Each schema is shown below with its type and property counts.

pricebook_type
string
Type of the pricebook.Allowed values: peritem , fixedpercentage
currency_code
string
Code based on currency
is_increase
boolean
Mark up or Mark down to discounts.Allowed values: true , false
price_bracket
object
Represents a single tier in pricebrackets for volume pricing. Includes: startquantity, endquantity, pricebookrate, and optional pricebookdiscount.
5 properties
pricebook_item_id
string
Unique ID generated by the server for each pricebook line item
status
string
Status of the price book
list-all-pricebooks-response
object
3 properties
delete-the-pricebook-response
object
2 properties
end_quantity
number
Upper bound of the quantity range for a volume bracket.
mark-as-active-response
object
2 properties
item_id
string
Unique ID generated by server for Item
start_quantity
number
Lower bound of the quantity range for a volume bracket.
sales_or_purchase_type
string
Whether its sales or purchase type.Allowed values: sales , purchases
pricing_scheme
string
Applicable only when the price book type is peritem. Allowed values: unit, volume. unit: Uses pricebookrate. volume: Uses pricebrackets. Not applicable for fix…
pricebook_rate
number
Rate of the price book for the Items
pricebook
object
List all the pricebook details
16 properties
name
string
Name of the pricebook
update-pricebook-request
object
12 properties 3 required
pricebook_id
string
Unique ID generated by server for the price book
create-a-pricebook-response
object
3 properties
is_default
boolean
To check the default pricebook.Allowed values: true , false
create-a-pricebook-request
object
12 properties 3 required
decimal_place
integer
Decimal place for pricebook.
pricebook_discount
string
Discount percentage for the line item or volume bracket. The value must include a percent sign. Examples: 5%, 10.5%, 0%.
percentage
number
About percentage of discounts
currency_id
string
The currenct id of the currency
rounding_type
string
Type of the rounding.Allowed values: norounding , roundtodollor , roundtodollarminus01 , roundtohalfdollar , roundtohalfdollarminus01
pricebook_items
array
Items included in the price book. Applicable when the price book type is set to peritem.
description
string
Description about the pricebook
update-pricebook-response
object
3 properties
mark-as-inactive-response
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-inventory-pricelists-api-openapi.yml Raw ↑

Other APIs Zoho Inventory publishes across the network.

Zoho Inventory batches API
Zoho Inventory bills API
Zoho Inventory compositeitems API
Zoho Inventory contact-persons API
Zoho Inventory contacts API
Zoho Inventory credit-notes API
Zoho Inventory currency API
Zoho Inventory customer-payments API
Zoho Inventory delivery-challans API
Zoho Inventory inventoryadjustments API
Zoho Inventory invoices API
Zoho Inventory itemgroups API