Zoho Inventory purchasereceives 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 purchasereceives. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.
This API exposes
8 operations
across 6 paths,
and defines 49 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.
8 operations6 paths49 schemas1 DELETE1 GET5 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 purchasereceives API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (Zoho_Auth) using the implicit flow, exposing 4 scopes.
Paths & Operations 8
Across 6 paths, the API surfaces 8 operations — 1 DELETE, 1 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are purchase_receive-response (15 properties), update-a-purchase-receive-request (5 properties), create-a-purchase-receive-request (5 properties), retrieve-a-purchase-receive-response (3 properties). Each schema is shown below with its type and property counts.
country
string
Name of the country of the customer's billing address.
notes
string
Purchase Receive notes.
item_custom_fields
array
List of custom fields associated with the line item
create-a-purchase-receive-response
object
3 properties
last_modified_time
string
Time at which the Purchase Order details were last modified.
reject-request
object
1 property
storages-update
array
Bin/storage locations allocated for the line item. Applicable only for items with bin tracking enabled.
address
string
Name of the street of the customer's billing address.
label
string
Label of the Custom Field
retrieve-a-purchase-receive-response
object
3 properties
create-a-purchase-receive-request
object
5 properties2 required
shipping_address
array
Customer's shipping address. It contains - address , city , state , zip , country and fax .
vendor_name
string
Name of the vendor.
batches
array
Batches for the line item. Create a new batch using batchnumber or reference an existing batch using batchid . Applicable only for items with batch tracking en…
quantity
number
Quantity of the line item.
zip
string
Zip code of the customer's billing address.
storages-response
array
Bin/storage locations tracked for the line item. Returned for items with bin tracking enabled.
item_id
string
Unique ID generated by the server for the item. This is used as an identifier.
update-a-purchase-receive-response
object
3 properties
billing_address
array
Customer's billing address. It contains - address , city , state , zip , country and fax .
approval-action-response
object
2 properties
name
string
Name of the line item.
serial_numbers
array
Serial numbers for the line item. Applicable only for items with serial tracking enabled.
city
string
Name of the city of the customer's billing address.
date
string
Date of Purchase Receive
receive_id
string
Unique ID generated by the server for the Purchase Receive. This is used as identifier.
purchaseorder_id
string
Unique ID generated by the server for the Purchase Order.
contact_persons
array
Array of contact person IDs.
custom_fields
array
Custom fields for a purchasereceive.
customfield_id
string
Unique identifier of the custom field
batches-update
array
Batches for the line item. Create a new batch using batchnumber or reference an existing batch using batchid . Applicable only for items with batch tracking en…
value
string
Value of the Custom Field
line_item_id
string
Unique ID generated by the server for each line item. This is used as an identifier.
fax
string
Fax number of the customer's billing address.
line_items
array
Number of line items for purchase receive. Each line item contains lineitemid , itemid , name , description , itemorder , quantity and unit .
batches-response
array
Batches tracked for the line item. Returned for items with batch tracking enabled.
receive_number
string
Number of the Purchase Receive.
unit
string
Unit of line item.
delete-a-purchase-receive-response
object
2 properties
created_time
string
Time at which the Purchase Receive was created.
update-a-purchase-receive-request
object
5 properties2 required
item_order
integer
The order of the line items, starts from 0 by default.
state
string
Name of the state of the customer's billing address.
purchase_receive-response
object
15 properties
description
string
Description of the line item.
purchaseorder_number
string
Purchase Order number.
storages
array
Bin/storage locations allocated for the line item. Applicable only for items with bin tracking enabled.
contact_person_id
string
Unique ID generated by the server for the contact person
vendor_id
string
Unique ID generated by the server for the vendor.
Specification
The full machine-readable OpenAPI contract behind this narrative.
