Zoho Inventory shipmentorders API
ShipmentOrders Module
Zoho Inventory shipmentorders 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 shipmentorders. 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.0.0, at version 1.0.0.
Requests are made against a single base URL, https://www.zohoapis.com/inventory/v1.
5 operations
3 paths
79 schemas
1 DELETE1 GET2 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zoho Inventory shipmentorders API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (Zoho_Auth) using the implicit flow, exposing 4 scopes.
Paths & Operations 5
Across 3 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
shipmentorders 5
ShipmentOrders Module
POST
/shipmentorders
Create a Shipment Order
GET
/shipmentorders/{shipmentorder_id}
Retrieve a Shipment Order
PUT
/shipmentorders/{shipmentorder_id}
Update a Shipment Order
DELETE
/shipmentorders/{shipmentorder_id}
Delete a Shipment Order
POST
/shipmentorders/{shipmentorder_id}/status/delivered
Mark as Delivered
Schemas 79
The contract defines 79 schemas that model the data the API accepts and returns. The most detailed are shipment_order-response (45 properties), update-a-shipment-order-request (11 properties), create-a-shipment-order-request (11 properties), create-a-shipment-order-response (3 properties). Each schema is shown below with its type and property counts.
carrier
string
Carrier used for shipment.
is_invoiced
boolean
Checks whether the Sales Order has been invoiced or not.
taxes
array
Number of taxes applied on sales order. Each tax contains: taxname and taxamount .
zip
string
Zip code of the customer's billing address.
item_id
string
Unique ID generated by the server for the item. This is used as an identifier.
sub_total
number
Sub total of the Sales Order.
create-a-shipment-order-request
object
11 properties
4 required
create-a-shipment-order-response
object
3 properties
date
string
Date on which package is prepared
item_total
number
Total of line item.
custom_fields
array
Custom fields for a shipmentorder.
shipment_id
string
Unique ID generated by the server for the shipment. This is used as an identifier.
value
string
Value of the Custom Field
currency_symbol
string
The symbol for the selected currency.
delete-a-shipment-order-response
object
2 properties
shipment_number
string
Shipment number of the package.
tracking_number
string
Tracking number of shipment.
country
string
Name of the country of the customer's billing address.
retrieve-a-shipment-order-response
object
3 properties
mark-as-delivered-response
object
2 properties
status
string
Status of the Shipment Order
detailed_status
string
Detailed shipment details received from the courier
label
string
Label of the Custom Field
discount_type
string
Type of discount
shipment_order-response
object
45 properties
package_id
string
Unique ID generated by the server for packages
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…
billing_address
array
Customer's billing address. It contains - address , city , state , zip , country and fax .
delivery_method_id
string
Unique ID generated by the server for the delivery method. This is used as an identifier.
tax_percentage
number
Percentage of the tax.
name
string
Name of the line item.
customer_name
string
Name of the customer
line_item_id
string
Unique ID generated by the server for each line item. This is used as an identifier.
currency_id
string
Unique ID generated by the server for the currency. This is used as an identifier.
tax_total
number
Tax total of the Sales Order.
reference_number
string
Tracking number for the Shipment.
service
string
Type of service selected for shipment
shipping_charge
number
Shipping charges that are applied to the Shipment.
description
string
Description of the line item.
discount_amount
number
Discount to be applied on the Sales Order.
line_items
array
List of items in a package. Each line item contains lineitemid , itemid , name , description , itemorder , bcyrate , rate , quantity , unit , taxid , taxname ,…
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
currency_code
string
Currency code.
last_modified_time
string
Time at which the Shipment Details details were last modified.
address
string
Name of the street of the customer's billing address.
shipping_address
array
Customer's shipping address. It contains - address , city , state , zip , country and fax .
customer_id
string
Unique ID generated by the for the customer
contact_persons
array
Array of contact person IDs.
is_discount_before_tax
boolean
Used to check whether the discount is applied before tax or after tax.
exchange_rate
number
Exchange rate of the currency, with respect to the base currency.
fax
string
Fax number of the customer's billing address.
unit
string
Unit of line item.
delivery_method
string
Delivery method of the shipment.
created_time
string
Time at which the Shipment Details was created.
item_order
integer
The order of the line items, starts from 0 by default.
template_name
string
Name of the template used for the Shipment.
salesorder_number
string
The Sales Order number. This is unique for each sales order.
rate
number
Rate / Selling Price of the line item.
estimate_id
string
Unique ID generated by the server from the Estimate created in Zoho Books. This is used as an identifier.
tax_id
string
Unique ID generated by the server for the tax. This is used as an identifier.
template_id
string
Unique ID generated by the server for the Template. This is used as an identifier.
template_type
string
Type of the template.
update-a-shipment-order-response
object
3 properties
city
string
Name of the city of the customer's billing address.
price_precision
integer
The precision level for the price's decimal point in a Shipment.
status_message
string
Status message of the shipment.
customfield_id
string
Unique ID of the custom field.
total
number
Total amount of the Sales Order.
is_emailed
boolean
Checks whether the Package has been emailed to the customer or not.
bcy_rate
number
Item rate in the organization's base currency.
salesorder_id
string
Unique ID generated by the server for the Sales Order. This is used as identifier.
tax_amount
number
Amount of the tax.
update-a-shipment-order-request
object
11 properties
3 required
tax_type
string
Denotes the type of the tax. This can either be a single tax or a tax group.
state
string
Name of the state of the customer's billing address.
contact_person_id
string
Unique ID generated by the server for the contact person
tax_name
string
Name of the tax applied on the line item.
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
#shipmentorders