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