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