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.2.0, at version 1.0.0.
Requests are made against a single base URL, https://www.zohoapis.com/inventory/v1.
The identity and technical contract details declared by the specification.
updating-a-package-request
object
5 properties
2 required
batches-response
array
Batches tracked for the line item. Returned for items with batch tracking enabled.
is_invoiced
boolean
Sales order item is invoiced to the customer or not
placeholder
string
Placeholder for the custom field
package-response
object
23 properties
notes
string
Notes for package
delivery_method_id
string
Unique ID generated by the server for delivery method
delivery_days
integer
Number of days taken by the courier for delivering in package
salesorder_number
string
Name of the sales order for which package is created
is_combo_product
boolean
Indicates whether the line item is a composite product.
is_emailed
boolean
Package is emailed to the customer or not
address
string
Name of the street of the customer address
sku
string
Stock keeping unit of the item in package
service
string
Type of service selected for shipment
deleting-a-package-response
object
2 properties
delivery_guarantee
boolean
guarantee assured by the courier. For guaranteed on-time deliveries, it is true else it is false
description
string
Description of the item in package
storages-response
array
Bin/storage locations tracked for the line item. Returned for items with bin tracking enabled.
line_item_id
string
Unique value generated by the server for an item of sales order in package
name
string
Name of the packaged item
so_line_item_id
string
Unique ID generated by the server for items in sales order
bulk-print-packages-response
object
2 properties
shipment_order
object
Shipment details of the package
14 properties
mobile
string
Mobile number of the customer
billing_address
object
Customer billing address
7 properties
quantity
number
Number of quantity of line items in sales order
carrier
string
Carrier used for shipment of package
template_name
string
Name of the template
creating-a-package-response
object
3 properties
shipment_rate
number
Costs involved for shipment
template_id
string
Unique ID generated by the server for the template used for package
total_quantity
string
Total quantity in the package
custom_fields
array
Custom fields for a package.
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.
fax
string
Fax number of the customer address
list-all-packages-response
object
3 properties
state
string
Name of the state of the customer address
salesorder_id
string
Unique ID generated by the server for sales order
item_custom_fields
array
Custom field of the item in package
shipping_date
string
Date on which package is shipped
combo_type
string
Type of the composite item. Allowed values are assembly and kit .
shipment_number
string
shipment number for the package
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.
status
string
status of the shipment order
label
string
Label of the Custom Field
batches-update
array
Batch details for the line item. Reference an existing batch using batchid . Applicable only for items with batch tracking enabled.
line_items
array
Details of the items in this package
country
string
Name of the country of the customer address
date
string
Date on which package is prepared
email
string
Email of contact person
last_modified_time
string
Time at which the package details were last modified.
city
string
Name of the city of the customer address
retrieving-a-package-response
object
3 properties
contact_person_id
string
Unique ID generated by the server for contact person
shipment_id
string
Unique ID generated by the server for the shipment
created_time
string
Time at which the package was created
tracking_number
string
Tracking number of the shipment
package_id
string
Unique ID generated by the server for the package
template_type
string
Type of template
contact_persons
array
Array of contact persons for the customers
serial_numbers
array
Serial numbers for the line item. Applicable only for items with serial tracking enabled.
delivery_method
string
Custom delivery option created for the manual shipment
customer_id
string
Unique ID generated by the for the customer
item_id
string
Unique ID generated by the server of the item in package
customer_name
string
Name of the customer
updating-a-package-response
object
3 properties
batches
array
Batch details for the line item. Reference an existing batch using batchid . Applicable only for items with batch tracking enabled.
shipping_address
object
Customer shipping address
7 properties
phone
string
Phone number of the customer
storages-update
array
Bin/storage locations allocated (or consumed, for assemblies) for the line item. Applicable only for items with bin tracking enabled.
data_type
string
Data type of the custom field
value
string
Value of the custom field
customfield_id
string
Unique ID of the custom field.
zip
string
Zipcode of the customer address
unit
string
Unit of the item in package
package_number
string
Name of 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.
creating-a-package-request
object
5 properties
2 required
storages
array
Bin/storage locations allocated (or consumed, for assemblies) for the line item. Applicable only for items with bin tracking enabled.
detailed_status
string
Detailed shipment details received from the courier
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Zoho Inventory publishes across the network.
