Zoho Inventory packages API
Packages Module
Zoho Inventory packages 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 packages. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.
This API exposes 6 operations across 3 paths, and defines 85 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
3 paths
85 schemas
1 DELETE3 GET1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zoho Inventory packages 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 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
packages 6
Packages Module
POST
/packages
Creating a package
GET
/packages
List all packages
GET
/packages/{package_id}
Retrieving a package
PUT
/packages/{package_id}
Updating a package
DELETE
/packages/{package_id}
Deleting a package
GET
/packages/print
Bulk print packages
Schemas 85
The contract defines 85 schemas that model the data the API accepts and returns. The most detailed are package-response (23 properties), shipment_order (14 properties), shipping_address (7 properties), billing_address (7 properties). Each schema is shown below with its type and property counts.
carrier
string
Carrier used for shipment of package
retrieving-a-package-response
object
3 properties
item_custom_fields
array
Custom field of the item in package
is_invoiced
boolean
Sales order item is invoiced to the customer or not
creating-a-package-request
object
5 properties
2 required
batches
array
Batch details for the line item. Reference an existing batch using batchid . Applicable only for items with batch tracking enabled.
zip
string
Zipcode of the customer address
item_id
string
Unique ID generated by the server of the item in package
shipping_date
string
Date on which package is shipped
package_number
string
Name of the package
serial_numbers
array
Serial numbers for the line item. Applicable only for items with serial tracking enabled.
package-response
object
23 properties
date
string
Date on which package is prepared
creating-a-package-response
object
3 properties
custom_fields
array
Custom fields for a package.
shipment_id
string
Unique ID generated by the server for the shipment
batches-update
array
Batch details for the line item. Reference an existing batch using batchid . Applicable only for items with batch tracking enabled.
value
string
Value of the custom field
show_on_pdf
updating-a-package-response
object
3 properties
mapped_items_update
array
Items that are associated with the composite item (kit) in the line item. Applicable only when the line item is a kit type composite item.
shipment_number
string
shipment number for the package
tracking_number
string
Tracking number of the shipment
country
string
Name of the country of the customer address
status
string
status of the shipment order
detailed_status
string
Detailed shipment details received from the courier
label
string
Label of the Custom Field
phone
string
Phone number of the customer
total_quantity
string
Total quantity in the package
quantity
number
Number of quantity of line items in sales order
storages-response
array
Bin/storage locations tracked for the line item. Returned for items with bin tracking enabled.
package_id
string
Unique ID generated by the server for the package
mapped_items_create
array
Items that are associated with the composite item (kit) in the line item. Applicable only when the line item is a kit type composite item.
billing_address
object
Customer billing address
7 properties
delivery_method_id
string
Unique ID generated by the server for delivery method
name
string
Name of the packaged item
customer_name
string
Name of the customer
line_item_id
string
Unique value generated by the server for an item of sales order in package
package
array
service
string
Type of service selected for shipment
description
string
Description of the item in package
mobile
string
Mobile number of the customer
storages
array
Bin/storage locations allocated (or consumed, for assemblies) for the line item. Applicable only for items with bin tracking enabled.
line_items
array
Details of the items in this package
delivery_guarantee
boolean
guarantee assured by the courier. For guaranteed on-time deliveries, it is true else it is false
notes
string
Notes for package
last_modified_time
string
Time at which the package details were last modified.
storages-update
array
Bin/storage locations allocated (or consumed, for assemblies) for the line item. Applicable only for items with bin tracking enabled.
address
string
Name of the street of the customer address
bulk-print-packages-response
object
2 properties
shipping_address
object
Customer shipping address
7 properties
sku
string
Stock keeping unit of the item in package
list-all-packages-response
object
3 properties
customer_id
string
Unique ID generated by the for the customer
email
string
Email of contact person
contact_persons
array
Array of contact persons for the customers
so_line_item_id
string
Unique ID generated by the server for items in sales order
shipment_order
object
Shipment details of the package
14 properties
fax
string
Fax number of the customer address
batches-response
array
Batches tracked for the line item. Returned for items with batch tracking enabled.
unit
string
Unit of the item in package
delivery_method
string
Custom delivery option created for the manual shipment
created_time
string
Time at which the package was created
item_order
template_name
string
Name of the template
updating-a-package-request
object
5 properties
2 required
shipment_rate
number
Costs involved for shipment
salesorder_number
string
Name of the sales order for which package is created
deleting-a-package-response
object
2 properties
is_active
template_id
string
Unique ID generated by the server for the template used for package
data_type
string
Data type of the custom field
combo_type
string
Type of the composite item. Allowed values are assembly and kit .
template_type
string
Type of template
city
string
Name of the city of the customer address
is_combo_product
boolean
Indicates whether the line item is a composite product.
customfield_id
string
Unique ID of the custom field.
is_emailed
boolean
Package is emailed to the customer or not
salesorder_id
string
Unique ID generated by the server for sales order
show_in_all_pdf
mapped_items
array
Items that are associated with the composite item (kit) in the line item. Applicable only when the line item is a kit type composite item.
state
string
Name of the state of the customer address
contact_person_id
string
Unique ID generated by the server for contact person
placeholder
string
Placeholder for the custom field
delivery_days
integer
Number of days taken by the courier for delivering in package
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zoho Inventory 12
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
#packages