Zoho Inventory Shipment Orders 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 Shipment Orders. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.
This API exposes
5 operations
across 3 paths,
and defines 79 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.
carrier
string
Carrier used for shipment.
tax_percentage
number
Percentage of the tax.
item_order
integer
The order of the line items, starts from 0 by default.
unit
string
Unit of line item.
item_id
string
Unique ID generated by the server for the item. This is used as an identifier.
name
string
Name of the line item.
customer_name
string
Name of the customer
contact_person_id
string
Unique ID generated by the server for the contact person
retrieve-a-shipment-order-response
object
3 properties
fax
string
Fax number of the customer's billing address.
shipment_number
string
Shipment number of the package.
line_items
array
List of items in a package. Each line item contains lineitemid , itemid , name , description , itemorder , bcyrate , rate , quantity , unit , taxid , taxname ,…
rate
number
Rate / Selling Price of the line item.
customer_id
string
Unique ID generated by the for the customer
package_id
string
Unique ID generated by the server for packages
item_total
number
Total of line item.
delivery_method_id
string
Unique ID generated by the server for the delivery method. This is used as an identifier.
sub_total
number
Sub total of the Sales Order.
template_type
string
Type of the template.
discount_amount
number
Discount to be applied on the Sales Order.
taxes
array
Number of taxes applied on sales order. Each tax contains: taxname and taxamount .
label
string
Label of the Custom Field
shipment_order-response
object
45 properties
contact_persons
array
Array of contact person IDs.
shipping_charge
number
Shipping charges that are applied to the Shipment.
mark-as-delivered-response
object
2 properties
salesorder_id
string
Unique ID generated by the server for the Sales Order. This is used as identifier.
create-a-shipment-order-response
object
3 properties
custom_fields
array
Custom fields for a shipmentorder.
exchange_rate
number
Exchange rate of the currency, with respect to the base currency.
billing_address
array
Customer's billing address. It contains - address , city , state , zip , country and fax .
description
string
Description of the line item.
status
string
Status of the Shipment Order
city
string
Name of the city of the customer's billing address.
delivery_guarantee
boolean
guarantee assured by the courier. For guaranteed on-time deliveries, it is true else it is false
status_message
string
Status message of the shipment.
template_id
string
Unique ID generated by the server for the Template. This is used as an identifier.
service
string
Type of service selected for shipment
delete-a-shipment-order-response
object
2 properties
estimate_id
string
Unique ID generated by the server from the Estimate created in Zoho Books. This is used as an identifier.
reference_number
string
Tracking number for the Shipment.
is_emailed
boolean
Checks whether the Package has been emailed to the customer or not.
total
number
Total amount of the Sales Order.
discount
number
Discount applied to the shipment order, which can be either a percentage or a flat amount. For percentage discounts, the value should include the % symbol (e.g…
tax_name
string
Name of the tax applied on the line item.
notes
string
Notes for package
template_name
string
Name of the template used for the Shipment.
country
string
Name of the country of the customer's billing address.
delivery_days
integer
Number of days taken by the courier for delivering in package
create-a-shipment-order-request
object
11 properties
4 required
tax_type
string
Denotes the type of the tax. This can either be a single tax or a tax group.
shipping_address
array
Customer's shipping address. It contains - address , city , state , zip , country and fax .
created_time
string
Time at which the Shipment Details was created.
detailed_status
string
Detailed shipment details received from the courier
discount_type
string
Type of discount
currency_code
string
Currency code.
bcy_rate
number
Item rate in the organization's base currency.
address
string
Name of the street of the customer's billing address.
line_item_id
string
Unique ID generated by the server for each line item. This is used as an identifier.
update-a-shipment-order-request
object
11 properties
3 required
delivery_method
string
Delivery method of the shipment.
is_discount_before_tax
boolean
Used to check whether the discount is applied before tax or after tax.
price_precision
integer
The precision level for the price's decimal point in a Shipment.
shipment_id
string
Unique ID generated by the server for the shipment. This is used as an identifier.
salesorder_number
string
The Sales Order number. This is unique for each sales order.
tax_id
string
Unique ID generated by the server for the tax. This is used as an identifier.
zip
string
Zip code of the customer's billing address.
tracking_number
string
Tracking number of shipment.
tax_amount
number
Amount of the tax.
tax_total
number
Tax total of the Sales Order.
value
string
Value of the Custom Field
last_modified_time
string
Time at which the Shipment Details details were last modified.
state
string
Name of the state of the customer's billing address.
update-a-shipment-order-response
object
3 properties
currency_symbol
string
The symbol for the selected currency.
currency_id
string
Unique ID generated by the server for the currency. This is used as an identifier.
customfield_id
string
Unique ID of the custom field.
date
string
Date on which package is prepared
is_invoiced
boolean
Checks whether the Sales Order has been invoiced or not.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Zoho Inventory publishes across the network.
